protection_containers

Creates, updates, deletes, gets or lists a protection_containers resource.

Overview

Name	protection_containers
Type	Resource
Id	azure.recovery_services_backup.protection_containers

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
backupManagementType	string	Type of backup management for the container. Known values are: "Invalid", "AzureIaasVM", "MAB", "DPM", "AzureBackupServer", "AzureSql", "AzureStorage", "AzureWorkload", and "DefaultBackup". (Invalid, AzureIaasVM, MAB, DPM, AzureBackupServer, AzureSql, AzureStorage, AzureWorkload, DefaultBackup)
containerType	string	Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload Backup is VMAppContainer. Required. Known values are: "Invalid", "Unknown", "IaasVMContainer", "IaasVMServiceContainer", "DPMContainer", "AzureBackupServerContainer", "MABContainer", "Cluster", "AzureSqlContainer", "Windows", "VCenter", "VMAppContainer", "SQLAGWorkLoadContainer", "StorageContainer", "GenericContainer", "Microsoft.ClassicCompute/virtualMachines", "Microsoft.Compute/virtualMachines", and "AzureWorkloadContainer".
eTag	string	Optional ETag.
friendlyName	string	Friendly name of the container.
healthStatus	string	Status of health of the container.
location	string	The geo-location where the resource lives.
protectableObjectType	string	Type of the protectable object associated with this container.
registrationStatus	string	Status of registration of the container with the Recovery Services Vault.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	vault_name, resource_group_name, fabric_name, container_name, subscription_id		Gets details of the specific container registered to your Recovery Services Vault.
unregister	delete	vault_name, resource_group_name, fabric_name, container_name, subscription_id		Unregisters the given container from your Recovery Services Vault. This is an asynchronous operation. To determine whether the backend service has finished processing the request, call Get Container Operation Result API.
register	exec	vault_name, resource_group_name, fabric_name, container_name, subscription_id		Registers the container with Recovery Services vault. This is an asynchronous operation. To track the operation status, use location header to call get latest status of the operation.
inquire	exec	vault_name, resource_group_name, fabric_name, container_name, subscription_id	$filter	This is an async operation and the results should be tracked using location header or Azure-async-url.
refresh	exec	vault_name, resource_group_name, fabric_name, subscription_id	$filter	Discovers all the containers in the subscription that can be backed up to Recovery Services Vault. This is an asynchronous operation. To know the status of the operation, call GetRefreshOperationResult API.

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
container_name	string	Name of the container whose details need to be fetched. Required.
fabric_name	string	Fabric name associated the container. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
vault_name	string	The name of the recovery services vault. Required.
$filter	string	OData filter options. Default value is None.

SELECT examples

get

Gets details of the specific container registered to your Recovery Services Vault.

SELECT
id,
name,
backupManagementType,
containerType,
eTag,
friendlyName,
healthStatus,
location,
protectableObjectType,
registrationStatus,
systemData,
tags,
type
FROM azure.recovery_services_backup.protection_containers
WHERE vault_name = '{{ vault_name }}' -- required
AND resource_group_name = '{{ resource_group_name }}' -- required
AND fabric_name = '{{ fabric_name }}' -- required
AND container_name = '{{ container_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

DELETE examples

unregister

Unregisters the given container from your Recovery Services Vault. This is an asynchronous operation. To determine whether the backend service has finished processing the request, call Get Container Operation Result API.

DELETE FROM azure.recovery_services_backup.protection_containers
WHERE vault_name = '{{ vault_name }}' --required
AND resource_group_name = '{{ resource_group_name }}' --required
AND fabric_name = '{{ fabric_name }}' --required
AND container_name = '{{ container_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

register

Registers the container with Recovery Services vault. This is an asynchronous operation. To track the operation status, use location header to call get latest status of the operation.

EXEC azure.recovery_services_backup.protection_containers.register 
@vault_name='{{ vault_name }}' --required, 
@resource_group_name='{{ resource_group_name }}' --required, 
@fabric_name='{{ fabric_name }}' --required, 
@container_name='{{ container_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}", 
"tags": "{{ tags }}", 
"location": "{{ location }}", 
"eTag": "{{ eTag }}"
}'
;

inquire

This is an async operation and the results should be tracked using location header or Azure-async-url.

EXEC azure.recovery_services_backup.protection_containers.inquire 
@vault_name='{{ vault_name }}' --required, 
@resource_group_name='{{ resource_group_name }}' --required, 
@fabric_name='{{ fabric_name }}' --required, 
@container_name='{{ container_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required, 
@$filter='{{ $filter }}'
;

refresh

Discovers all the containers in the subscription that can be backed up to Recovery Services Vault. This is an asynchronous operation. To know the status of the operation, call GetRefreshOperationResult API.

EXEC azure.recovery_services_backup.protection_containers.refresh 
@vault_name='{{ vault_name }}' --required, 
@resource_group_name='{{ resource_group_name }}' --required, 
@fabric_name='{{ fabric_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required, 
@$filter='{{ $filter }}'
;