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. Known values are: "Acquire" and "NotAcquire". (Acquire, NotAcquire)
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. Known values are: "Invalid" and "Azure". (Invalid, Azure)
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	Number of protected items.
protectionStatus	string	Specifies whether the container is registered or not. Known values are: "Invalid", "NotProtected", "Protecting", "Protected", and "ProtectionFailed". (Invalid, NotProtected, Protecting, Protected, ProtectionFailed)
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	azure_region, subscription_id		Get the container backup status. Get the container backup status.

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
azure_region	string	Azure region to hit Api. Required.
subscription_id	string

SELECT examples

get

Get the container backup status. Get the container backup status.

SELECT
acquireStorageAccountLock,
containerName,
errorCode,
errorMessage,
fabricName,
policyName,
protectedItemName,
protectedItemsCount,
protectionStatus,
registrationStatus,
vaultId
FROM azure.recovery_services_backup.backup_status
WHERE azure_region = '{{ azure_region }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;