replication_protection_containers

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

Overview

Name	replication_protection_containers
Type	Resource
Id	azure.recovery_services_site_recovery.replication_protection_containers

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Resource Id
name	string	Resource Name
location	string	Resource Location
properties	object	The custom data.
type	string	Resource Type

list_by_replication_fabrics

Name	Datatype	Description
id	string	Resource Id
name	string	Resource Name
location	string	Resource Location
properties	object	The custom data.
type	string	Resource Type

list

Name	Datatype	Description
id	string	Resource Id
name	string	Resource Name
location	string	Resource Location
properties	object	The custom data.
type	string	Resource Type

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceName, resourceGroupName, subscriptionId, fabricName, protectionContainerName	api-version	Gets the details of a protection container.
list_by_replication_fabrics	select	resourceName, resourceGroupName, subscriptionId, fabricName	api-version	Lists the protection containers in the specified fabric.
list	select	resourceName, resourceGroupName, subscriptionId	api-version	Lists the protection containers in a vault.
create	insert	resourceName, resourceGroupName, subscriptionId, fabricName, protectionContainerName	api-version	Operation to create a protection container.
discover_protectable_item	exec	resourceName, resourceGroupName, subscriptionId, fabricName, protectionContainerName	api-version	The operation to a add a protectable item to a protection container(Add physical server).
delete	exec	resourceName, resourceGroupName, subscriptionId, fabricName, protectionContainerName	api-version	Operation to remove a protection container.
switch_cluster_protection	exec	resourceName, resourceGroupName, subscriptionId, fabricName, protectionContainerName	api-version	Operation to switch protection from one container to another.
switch_protection	exec	resourceName, resourceGroupName, subscriptionId, fabricName, protectionContainerName	api-version	Operation to switch protection from one container to another or one replication provider to another.

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
fabricName	string	Unique fabric name.
protectionContainerName	string	Protection container name.
resourceGroupName	string	The name of the resource group where the recovery services vault is present.
resourceName	string	The name of the recovery services vault.
subscriptionId	string	The subscription Id.
api-version	string	Client Api Version.

SELECT examples

get

Gets the details of a protection container.

SELECT
id,
name,
location,
properties,
type
FROM azure.recovery_services_site_recovery.replication_protection_containers
WHERE resourceName = '{{ resourceName }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND fabricName = '{{ fabricName }}' -- required
AND protectionContainerName = '{{ protectionContainerName }}' -- required
AND api-version = '{{ api-version }}'
;

list_by_replication_fabrics

Lists the protection containers in the specified fabric.

SELECT
id,
name,
location,
properties,
type
FROM azure.recovery_services_site_recovery.replication_protection_containers
WHERE resourceName = '{{ resourceName }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND fabricName = '{{ fabricName }}' -- required
AND api-version = '{{ api-version }}'
;

list

Lists the protection containers in a vault.

SELECT
id,
name,
location,
properties,
type
FROM azure.recovery_services_site_recovery.replication_protection_containers
WHERE resourceName = '{{ resourceName }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND api-version = '{{ api-version }}'
;

INSERT examples

create

Operation to create a protection container.

INSERT INTO azure.recovery_services_site_recovery.replication_protection_containers (
data__properties,
resourceName,
resourceGroupName,
subscriptionId,
fabricName,
protectionContainerName,
api-version
)
SELECT 
'{{ properties }}',
'{{ resourceName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ fabricName }}',
'{{ protectionContainerName }}',
'{{ api-version }}'
RETURNING
id,
name,
location,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: replication_protection_containers
  props:
    - name: resourceName
      value: string
      description: Required parameter for the replication_protection_containers resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the replication_protection_containers resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the replication_protection_containers resource.
    - name: fabricName
      value: string
      description: Required parameter for the replication_protection_containers resource.
    - name: protectionContainerName
      value: string
      description: Required parameter for the replication_protection_containers resource.
    - name: properties
      value: object
      description: |
        Create protection container input properties.
    - name: api-version
      value: string
      description: Client Api Version.

Lifecycle Methods

discover_protectable_item

The operation to a add a protectable item to a protection container(Add physical server).

EXEC azure.recovery_services_site_recovery.replication_protection_containers.discover_protectable_item 
@resourceName='{{ resourceName }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@fabricName='{{ fabricName }}' --required, 
@protectionContainerName='{{ protectionContainerName }}' --required, 
@api-version='{{ api-version }}' 
@@json=
'{
"properties": "{{ properties }}"
}'
;

delete

Operation to remove a protection container.

EXEC azure.recovery_services_site_recovery.replication_protection_containers.delete 
@resourceName='{{ resourceName }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@fabricName='{{ fabricName }}' --required, 
@protectionContainerName='{{ protectionContainerName }}' --required, 
@api-version='{{ api-version }}'
;

switch_cluster_protection

Operation to switch protection from one container to another.

EXEC azure.recovery_services_site_recovery.replication_protection_containers.switch_cluster_protection 
@resourceName='{{ resourceName }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@fabricName='{{ fabricName }}' --required, 
@protectionContainerName='{{ protectionContainerName }}' --required, 
@api-version='{{ api-version }}' 
@@json=
'{
"properties": "{{ properties }}"
}'
;

switch_protection

Operation to switch protection from one container to another or one replication provider to another.

EXEC azure.recovery_services_site_recovery.replication_protection_containers.switch_protection 
@resourceName='{{ resourceName }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@fabricName='{{ fabricName }}' --required, 
@protectionContainerName='{{ protectionContainerName }}' --required, 
@api-version='{{ api-version }}' 
@@json=
'{
"properties": "{{ properties }}"
}'
;