operation_status
Creates, updates, deletes, gets or lists an operation_status
resource.
Overview
Name | operation_status |
Type | Resource |
Id | azure.api_management.operation_status |
Fields
The following fields are returned by SELECT
queries:
- get
Requested operation status
Name | Datatype | Description |
---|---|---|
id | string | Fully qualified ID for the async operation. |
name | string | Name of the async operation. |
endTime | string (date-time) | The end time of the operation. |
error | object | If present, details of the operation error. |
operations | array | The operations list. |
percentComplete | number | Percent of the operation that is complete. |
startTime | string (date-time) | The start time of the operation. |
status | string | Operation status. |
Methods
The following methods are available for this resource:
Name | Accessible by | Required Params | Optional Params | Description |
---|---|---|---|---|
get | select | subscriptionId , location , operationId | Returns the current status of an async operation. |
Parameters
Parameters can be passed in the WHERE
clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
Name | Datatype | Description |
---|---|---|
location | string | The name of Azure region. |
operationId | string | The ID of an ongoing async operation. |
subscriptionId | string | The ID of the target subscription. |
SELECT
examples
- get
Returns the current status of an async operation.
SELECT
id,
name,
endTime,
error,
operations,
percentComplete,
startTime,
status
FROM azure.api_management.operation_status
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND location = '{{ location }}' -- required
AND operationId = '{{ operationId }}' -- required
;