Operation Status Result - Get By Agent Pool

Service:

AKS

API Version:

2025-05-02-preview

Get the status of a specific operation in the specified agent pool.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}/operations/{operationId}?api-version=2025-05-02-preview

URI Parameters

Name	In	Required	Type	Description
agentPoolName	path	True	string minLength: 1 maxLength: 12 pattern: ^[a-z][a-z0-9]{0,11}$	The name of the agent pool.
operationId	path	True	string minLength: 1	The ID of an ongoing async operation.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
resourceName	path	True	string minLength: 1 maxLength: 63 pattern: ^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$	The name of the managed cluster resource.
subscriptionId	path	True	string (uuid)	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	OperationStatusResult	OK
Other Status Codes	CloudError	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Get OperationStatusResult

Sample request

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1/operations/00000000-0000-0000-0000-000000000001?api-version=2025-05-02-preview

Sample response

Status code:

200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1/operations/00000000-0000-0000-0000-000000000001",
  "name": "00000000-0000-0000-0000-000000000001",
  "status": "InProgress",
  "percentComplete": 40,
  "startTime": "2023-07-26T12:14:26.3179428Z"
}

Definitions

Name	Description
CloudError	An error response from the Container service.
CloudErrorBody	An error response from the Container service.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
OperationStatusResult	The current status of an async operation.

CloudError

Object

An error response from the Container service.

Name	Type	Description
error	CloudErrorBody	Details about the error.

CloudErrorBody

Object

An error response from the Container service.

Name	Type	Description
code	string	An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
details	CloudErrorBody[]	A list of additional details about the error.
message	string	A message describing the error, intended to be suitable for display in a user interface.
target	string	The target of the particular error. For example, the name of the property in error.

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

OperationStatusResult

Object

The current status of an async operation.

Name	Type	Description
endTime	string (date-time)	The end time of the operation.
error	ErrorDetail	If present, details of the operation error.
id	string (arm-id)	Fully qualified ID for the async operation.
name	string	Name of the async operation.
operations	OperationStatusResult[]	The operations list.
percentComplete	number minimum: 0 maximum: 100	Percent of the operation that is complete.
resourceId	string (arm-id)	Fully qualified ID of the resource against which the original async operation was started.
startTime	string (date-time)	The start time of the operation.
status	string	Operation status.