Azure Kubernetes Service · Example Payload
Microsoft Azure Kubernetes Service Agentpools Createorupdate Example
AzureCloudContainersDevOpsKubernetesOrchestration
Microsoft Azure Kubernetes Service Agentpools Createorupdate Example is an example object payload from Azure Kubernetes Service, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.
Top-level fields
operationIdmethodpathsummaryrequestExamplesresponseExamples
Example Payload
{
"operationId": "AgentPools_CreateOrUpdate",
"method": "PUT",
"path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}",
"summary": "Azure Kubernetes Service Create or Update an Agent Pool",
"requestExamples": [
{
"contentType": "application/json",
"name": "AgentpoolsCreateorupdateRequestExample",
"example": {
"id": "abc123",
"name": "Example Title",
"type": "example_value",
"properties": {
"provisioningState": "example_value",
"count": 10,
"vmSize": "example_value",
"osDiskSizeGB": 10,
"osDiskType": "Managed",
"kubeletDiskType": "OS",
"maxPods": 10,
"osType": "Linux",
"osSKU": "Ubuntu",
"type": "VirtualMachineScaleSets",
"mode": "System",
"orchestratorVersion": "example_value",
"currentOrchestratorVersion": "example_value",
"nodeImageVersion": "example_value",
"enableAutoScaling": true,
"minCount": 10,
"maxCount": 10,
"scaleSetPriority": "Spot",
"scaleSetEvictionPolicy": "Delete",
"spotMaxPrice": 42.5,
"scaleDownMode": "Delete",
"vnetSubnetID": "500123",
"podSubnetID": "500123",
"enableNodePublicIP": true,
"nodePublicIPPrefixID": "500123",
"enableEncryptionAtHost": true,
"enableFIPS": true,
"enableUltraSSD": true,
"nodeLabels": "example_value",
"nodeTaints": [
{}
],
"tags": "example_value",
"proximityPlacementGroupID": "500123",
"availabilityZones": [
{}
],
"workloadRuntime": "OCIContainer",
"messageOfTheDay": "example_value"
}
}
}
],
"responseExamples": [
{
"status": "200",
"contentType": "application/json",
"name": "AgentpoolsCreateorupdate200Example",
"example": {
"id": "abc123",
"name": "Example Title",
"type": "example_value",
"properties": {
"provisioningState": "example_value",
"count": 10,
"vmSize": "example_value",
"osDiskSizeGB": 10,
"osDiskType": "Managed",
"kubeletDiskType": "OS",
"maxPods": 10,
"osType": "Linux",
"osSKU": "Ubuntu",
"type": "VirtualMachineScaleSets",
"mode": "System",
"orchestratorVersion": "example_value",
"currentOrchestratorVersion": "example_value",
"nodeImageVersion": "example_value",
"enableAutoScaling": true,
"minCount": 10,
"maxCount": 10,
"scaleSetPriority": "Spot",
"scaleSetEvictionPolicy": "Delete",
"spotMaxPrice": 42.5,
"scaleDownMode": "Delete",
"vnetSubnetID": "500123",
"podSubnetID": "500123",
"enableNodePublicIP": true,
"nodePublicIPPrefixID": "500123",
"enableEncryptionAtHost": true,
"enableFIPS": true,
"enableUltraSSD": true,
"nodeLabels": "example_value",
"nodeTaints": [
{}
],
"tags": "example_value",
"proximityPlacementGroupID": "500123",
"availabilityZones": [
{}
],
"workloadRuntime": "OCIContainer",
"messageOfTheDay": "example_value"
}
}
},
{
"status": "201",
"contentType": "application/json",
"name": "AgentpoolsCreateorupdate201Example",
"example": {
"id": "abc123",
"name": "Example Title",
"type": "example_value",
"properties": {
"provisioningState": "example_value",
"count": 10,
"vmSize": "example_value",
"osDiskSizeGB": 10,
"osDiskType": "Managed",
"kubeletDiskType": "OS",
"maxPods": 10,
"osType": "Linux",
"osSKU": "Ubuntu",
"type": "VirtualMachineScaleSets",
"mode": "System",
"orchestratorVersion": "example_value",
"currentOrchestratorVersion": "example_value",
"nodeImageVersion": "example_value",
"enableAutoScaling": true,
"minCount": 10,
"maxCount": 10,
"scaleSetPriority": "Spot",
"scaleSetEvictionPolicy": "Delete",
"spotMaxPrice": 42.5,
"scaleDownMode": "Delete",
"vnetSubnetID": "500123",
"podSubnetID": "500123",
"enableNodePublicIP": true,
"nodePublicIPPrefixID": "500123",
"enableEncryptionAtHost": true,
"enableFIPS": true,
"enableUltraSSD": true,
"nodeLabels": "example_value",
"nodeTaints": [
{}
],
"tags": "example_value",
"proximityPlacementGroupID": "500123",
"availabilityZones": [
{}
],
"workloadRuntime": "OCIContainer",
"messageOfTheDay": "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"
}
]
}
}
}
]
}