Microsoft Azure · Example Payload

Microsoft Azure Agentpools Createorupdate Example

API ManagementCloudCloud ComputingEnterpriseInfrastructure as a ServicePlatform as a ServiceT1

Microsoft Azure Agentpools Createorupdate Example is an example object payload from Microsoft Azure, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummaryrequestExamplesresponseExamples

Example Payload

Raw ↑ 
{
  "operationId": "AgentPools_CreateOrUpdate",
  "method": "PUT",
  "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}",
  "summary": "Microsoft Azure Create or Update an Agent Pool",
  "requestExamples": [
    {
      "contentType": "application/json",
      "name": "AgentpoolsCreateorupdateRequestExample",
      "example": {
        "id": "abc123",
        "name": "Example Title",
        "type": "example_value",
        "properties": {
          "name": "Example Title",
          "count": 10,
          "vmSize": "example_value",
          "osDiskSizeGB": 10,
          "osDiskType": "Managed",
          "osType": "Linux",
          "osSKU": "Ubuntu",
          "maxPods": 10,
          "mode": "System",
          "type": "VirtualMachineScaleSets",
          "availabilityZones": [
            {}
          ],
          "enableAutoScaling": true,
          "minCount": 10,
          "maxCount": 10,
          "nodeLabels": "example_value",
          "nodeTaints": [
            {}
          ],
          "upgradeSettings": {
            "maxSurge": "example_value"
          }
        }
      }
    }
  ],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "name": "AgentpoolsCreateorupdate200Example",
      "example": {
        "id": "abc123",
        "name": "Example Title",
        "type": "example_value",
        "properties": {
          "name": "Example Title",
          "count": 10,
          "vmSize": "example_value",
          "osDiskSizeGB": 10,
          "osDiskType": "Managed",
          "osType": "Linux",
          "osSKU": "Ubuntu",
          "maxPods": 10,
          "mode": "System",
          "type": "VirtualMachineScaleSets",
          "availabilityZones": [
            {}
          ],
          "enableAutoScaling": true,
          "minCount": 10,
          "maxCount": 10,
          "nodeLabels": "example_value",
          "nodeTaints": [
            {}
          ],
          "upgradeSettings": {
            "maxSurge": "example_value"
          }
        }
      }
    },
    {
      "status": "201",
      "contentType": "application/json",
      "name": "AgentpoolsCreateorupdate201Example",
      "example": {
        "id": "abc123",
        "name": "Example Title",
        "type": "example_value",
        "properties": {
          "name": "Example Title",
          "count": 10,
          "vmSize": "example_value",
          "osDiskSizeGB": 10,
          "osDiskType": "Managed",
          "osType": "Linux",
          "osSKU": "Ubuntu",
          "maxPods": 10,
          "mode": "System",
          "type": "VirtualMachineScaleSets",
          "availabilityZones": [
            {}
          ],
          "enableAutoScaling": true,
          "minCount": 10,
          "maxCount": 10,
          "nodeLabels": "example_value",
          "nodeTaints": [
            {}
          ],
          "upgradeSettings": {
            "maxSurge": "example_value"
          }
        }
      }
    },
    {
      "status": "default",
      "contentType": "application/json",
      "name": "AgentpoolsCreateorupdatedefaultExample",
      "example": {
        "error": {
          "code": "example_value",
          "message": "example_value",
          "target": "example_value",
          "details": [
            {
              "code": "example_value",
              "message": "example_value",
              "target": "example_value"
            }
          ]
        }
      }
    }
  ]
}