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	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
fabricFriendlyName	string	Fabric friendly name.
fabricSpecificDetails	object	Fabric specific details.
fabricType	string	The fabric type.
friendlyName	string	The name.
location	string	Resource Location.
pairingStatus	string	The pairing status of this cloud.
protectedItemCount	integer	Number of protected PEs.
role	string	The role of this cloud.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_replication_fabrics

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.
fabricFriendlyName	string	Fabric friendly name.
fabricSpecificDetails	object	Fabric specific details.
fabricType	string	The fabric type.
friendlyName	string	The name.
location	string	Resource Location.
pairingStatus	string	The pairing status of this cloud.
protectedItemCount	integer	Number of protected PEs.
role	string	The role of this cloud.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

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.
fabricFriendlyName	string	Fabric friendly name.
fabricSpecificDetails	object	Fabric specific details.
fabricType	string	The fabric type.
friendlyName	string	The name.
location	string	Resource Location.
pairingStatus	string	The pairing status of this cloud.
protectedItemCount	integer	Number of protected PEs.
role	string	The role of this cloud.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
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	resource_group_name, resource_name, fabric_name, protection_container_name, subscription_id		Gets the protection container details. Gets the details of a protection container.
list_by_replication_fabrics	select	resource_group_name, resource_name, fabric_name, subscription_id		Gets the list of protection container for a fabric. Lists the protection containers in the specified fabric.
list	select	resource_group_name, resource_name, subscription_id		Gets the list of all protection containers in a vault. Lists the protection containers in a vault.
create	insert	resource_group_name, resource_name, fabric_name, protection_container_name, subscription_id		Create a protection container. Operation to create a protection container.
delete	delete	resource_group_name, resource_name, fabric_name, protection_container_name, subscription_id		Removes a protection container. Operation to remove a protection container.
discover_protectable_item	exec	resource_group_name, resource_name, fabric_name, protection_container_name, subscription_id		Adds a protectable item to the replication protection container. The operation to a add a protectable item to a protection container(Add physical server).
switch_cluster_protection	exec	resource_group_name, resource_name, fabric_name, protection_container_name, subscription_id		Switches protection from one container to another. Operation to switch protection from one container to another.
switch_protection	exec	resource_group_name, resource_name, fabric_name, protection_container_name, subscription_id		Switches protection from one container to another or one replication provider to another. 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
fabric_name	string	Fabric name. Required.
protection_container_name	string	Protection container name. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
resource_name	string	The name of the Vault. Required.
subscription_id	string

SELECT examples

get

Gets the protection container details. Gets the details of a protection container.

SELECT
id,
name,
fabricFriendlyName,
fabricSpecificDetails,
fabricType,
friendlyName,
location,
pairingStatus,
protectedItemCount,
role,
systemData,
type
FROM azure.recovery_services_site_recovery.replication_protection_containers
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND fabric_name = '{{ fabric_name }}' -- required
AND protection_container_name = '{{ protection_container_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_replication_fabrics

Gets the list of protection container for a fabric. Lists the protection containers in the specified fabric.

SELECT
id,
name,
fabricFriendlyName,
fabricSpecificDetails,
fabricType,
friendlyName,
location,
pairingStatus,
protectedItemCount,
role,
systemData,
type
FROM azure.recovery_services_site_recovery.replication_protection_containers
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND fabric_name = '{{ fabric_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Gets the list of all protection containers in a vault. Lists the protection containers in a vault.

SELECT
id,
name,
fabricFriendlyName,
fabricSpecificDetails,
fabricType,
friendlyName,
location,
pairingStatus,
protectedItemCount,
role,
systemData,
type
FROM azure.recovery_services_site_recovery.replication_protection_containers
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Create a protection container. Operation to create a protection container.

INSERT INTO azure.recovery_services_site_recovery.replication_protection_containers (
properties,
resource_group_name,
resource_name,
fabric_name,
protection_container_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ resource_name }}',
'{{ fabric_name }}',
'{{ protection_container_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: replication_protection_containers
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the replication_protection_containers resource.
  - name: resource_name
    value: "{{ resource_name }}"
    description: Required parameter for the replication_protection_containers resource.
  - name: fabric_name
    value: "{{ fabric_name }}"
    description: Required parameter for the replication_protection_containers resource.
  - name: protection_container_name
    value: "{{ protection_container_name }}"
    description: Required parameter for the replication_protection_containers resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the replication_protection_containers resource.
  - name: properties
    description: |
      Create protection container input properties.
    value:
      providerSpecificInput:
        - instanceType: "{{ instanceType }}"

DELETE examples

delete

Removes a protection container. Operation to remove a protection container.

DELETE FROM azure.recovery_services_site_recovery.replication_protection_containers
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND resource_name = '{{ resource_name }}' --required
AND fabric_name = '{{ fabric_name }}' --required
AND protection_container_name = '{{ protection_container_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

discover_protectable_item

Adds a protectable item to the replication protection container. 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 
@resource_group_name='{{ resource_group_name }}' --required, 
@resource_name='{{ resource_name }}' --required, 
@fabric_name='{{ fabric_name }}' --required, 
@protection_container_name='{{ protection_container_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

switch_cluster_protection

Switches protection from one container to another. Operation to switch protection from one container to another.

EXEC azure.recovery_services_site_recovery.replication_protection_containers.switch_cluster_protection 
@resource_group_name='{{ resource_group_name }}' --required, 
@resource_name='{{ resource_name }}' --required, 
@fabric_name='{{ fabric_name }}' --required, 
@protection_container_name='{{ protection_container_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

switch_protection

Switches protection from one container to another or one replication provider to another. 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 
@resource_group_name='{{ resource_group_name }}' --required, 
@resource_name='{{ resource_name }}' --required, 
@fabric_name='{{ fabric_name }}' --required, 
@protection_container_name='{{ protection_container_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;