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
properties	object	ProtectionContainerResource properties
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	vaultName, resourceGroupName, subscriptionId, fabricName, containerName	api-version	Gets details of the specific container registered to your Recovery Services Vault.
register	exec	vaultName, resourceGroupName, subscriptionId, fabricName, containerName	api-version	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.
unregister	exec	vaultName, resourceGroupName, subscriptionId, fabricName, containerName	api-version	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.
inquire	exec	vaultName, resourceGroupName, subscriptionId, fabricName, containerName	api-version, $filter	This is an async operation and the results should be tracked using location header or Azure-async-url.
refresh	exec	vaultName, resourceGroupName, subscriptionId, fabricName	api-version, $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
containerName	string	Name of the container in which inquiry needs to be triggered.
fabricName	string	Fabric name associated the container.
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.
$filter	string	OData filter options.
api-version	string	Client Api Version.

SELECT examples

get

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

SELECT
id,
name,
properties,
type
FROM azure.recovery_services_backup.protection_containers
WHERE vaultName = '{{ vaultName }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND fabricName = '{{ fabricName }}' -- required
AND containerName = '{{ containerName }}' -- required
AND api-version = '{{ api-version }}'
;

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 
@vaultName='{{ vaultName }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@fabricName='{{ fabricName }}' --required, 
@containerName='{{ containerName }}' --required, 
@api-version='{{ api-version }}' 
@@json=
'{
"properties": "{{ properties }}"
}'
;

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.

EXEC azure.recovery_services_backup.protection_containers.unregister 
@vaultName='{{ vaultName }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@fabricName='{{ fabricName }}' --required, 
@containerName='{{ containerName }}' --required, 
@api-version='{{ api-version }}'
;

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 
@vaultName='{{ vaultName }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@fabricName='{{ fabricName }}' --required, 
@containerName='{{ containerName }}' --required, 
@api-version='{{ api-version }}', 
@$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 
@vaultName='{{ vaultName }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@fabricName='{{ fabricName }}' --required, 
@api-version='{{ api-version }}', 
@$filter='{{ $filter }}'
;