Share via

Operation Status - Get

  • Reference
Service:
API Management
API Version:
2024-05-01

Returns the current status of an async operation.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.ApiManagement/locations/{location}/operationStatuses/{operationId}?api-version=2024-05-01

URI Parameters

Name In Required Type Description
location
 path True

string

The name of the Azure region.
operationId
 path True

string

The ID of an ongoing async operation.
subscriptionId
 path True

string

uuid

The ID of the target subscription. The value must be an UUID.
api-version
 query True

string

The API version to use for this operation.

Responses

Name Type Description
200 OK

OperationStatusResult

Requested operation status
Other Status Codes

ErrorResponse

Error response describing why the operation failed.

Examples

Get operation status

Sample request

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ApiManagement/locations/testLocation/operationStatuses/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx?api-version=2024-05-01

Sample response

Status code:
200 
{
  "status": "InProgress"
}

Definitions

Name Description
ErrorAdditionalInfo

The resource management error additional info.
ErrorDetail

The error detail.
ErrorResponse

Error response
OperationStatusResult

The current status of an async operation.

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info

object

The additional info.
type

string

The additional info type.

ErrorDetail

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.

ErrorResponse

Error response

Name Type Description
error

ErrorDetail

The error object.

OperationStatusResult

The current status of an async operation.

Name Type Description
endTime

string

The end time of the operation.
error

ErrorDetail

If present, details of the operation error.
id

string

Fully qualified ID for the async operation.
name

string

Name of the async operation.
operations

OperationStatusResult[]

The operations list.
percentComplete

number

Percent of the operation that is complete.
resourceId

string

Fully qualified ID of the resource against which the original async operation was started.
startTime

string

The start time of the operation.
status

string

Operation status.