backup_status
Creates, updates, deletes, gets or lists a backup_status
resource.
Overview
Name | backup_status |
Type | Resource |
Id | azure.recovery_services_backup.backup_status |
Fields
The following fields are returned by SELECT
queries:
- get
Name | Datatype | Description |
---|---|---|
acquireStorageAccountLock | string | Specifies whether the storage account lock has been acquired or not |
containerName | string | Specifies the product specific container name. E.g. iaasvmcontainer;iaasvmcontainer;csname;vmname. |
errorCode | string | ErrorCode in case of intent failed |
errorMessage | string | ErrorMessage in case of intent failed. |
fabricName | string | Specifies the fabric name - Azure or AD |
policyName | string | Specifies the policy name which is used for protection |
protectedItemName | string | Specifies the product specific ds name. E.g. vm;iaasvmcontainer;csname;vmname. |
protectedItemsCount | integer (int32) | Number of protected items |
protectionStatus | string | Specifies whether the container is registered or not |
registrationStatus | string | Container registration status |
vaultId | string | Specifies the arm resource id of the vault |
Methods
The following methods are available for this resource:
Name | Accessible by | Required Params | Optional Params | Description |
---|---|---|---|---|
get | select | azureRegion , subscriptionId | api-version |
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 |
---|---|---|
azureRegion | string | Azure region to hit Api |
subscriptionId | string | The subscription Id. |
api-version | string | Client Api Version. |
SELECT
examples
- get
OK
SELECT
acquireStorageAccountLock,
containerName,
errorCode,
errorMessage,
fabricName,
policyName,
protectedItemName,
protectedItemsCount,
protectionStatus,
registrationStatus,
vaultId
FROM azure.recovery_services_backup.backup_status
WHERE azureRegion = '{{ azureRegion }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND api-version = '{{ api-version }}'
;