protection_policy_operation_status
Creates, updates, deletes, gets or lists a protection_policy_operation_status
resource.
Overview
Name | protection_policy_operation_status |
Type | Resource |
Id | azure.recovery_services_backup.protection_policy_operation_status |
Fields
The following fields are returned by SELECT
queries:
- get
Name | Datatype | Description |
---|---|---|
id | string | ID of the operation. |
name | string | Name of the operation. |
endTime | string (date-time) | Operation end time. Format: ISO-8601. |
error | object | Error information related to this operation. |
properties | object | Additional information associated with this operation. |
startTime | string (date-time) | Operation start time. Format: ISO-8601. |
status | string | Operation status. |
Methods
The following methods are available for this resource:
Name | Accessible by | Required Params | Optional Params | Description |
---|---|---|---|---|
get | select | vaultName , resourceGroupName , subscriptionId , policyName , operationId | api-version | Provides the status of the asynchronous operations like backup, restore. The status can be in progress, completed or failed. You can refer to the Operation Status enum for all the possible states of an operation. Some operations create jobs. This method returns the list of jobs associated with 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 |
---|---|---|
operationId | string | Operation ID which represents an operation whose status needs to be fetched. |
policyName | string | Backup policy name whose operation's status needs to be fetched. |
resourceGroupName | string | The name of the resource group where the recovery services vault is present. |
subscriptionId | string | The subscription Id. |
vaultName | string | The name of the recovery services vault. |
api-version | string | Client Api Version. |
SELECT
examples
- get
Provides the status of the asynchronous operations like backup, restore. The status can be in progress, completed
or failed. You can refer to the Operation Status enum for all the possible states of an operation. Some operations
create jobs. This method returns the list of jobs associated with operation.
SELECT
id,
name,
endTime,
error,
properties,
startTime,
status
FROM azure.recovery_services_backup.protection_policy_operation_status
WHERE vaultName = '{{ vaultName }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND policyName = '{{ policyName }}' -- required
AND operationId = '{{ operationId }}' -- required
AND api-version = '{{ api-version }}'
;