replication_protection_container_mappings

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

Overview

Name	replication_protection_container_mappings
Type	Resource
Id	azure.recovery_services_site_recovery.replication_protection_container_mappings

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.
health	string	Health of pairing.
healthErrorDetails	array	Health error.
location	string	Resource Location.
policyFriendlyName	string	Friendly name of replication policy.
policyId	string	Policy ARM Id.
providerSpecificDetails	object	Provider specific provider details.
sourceFabricFriendlyName	string	Friendly name of source fabric.
sourceProtectionContainerFriendlyName	string	Friendly name of source protection container.
state	string	Association Status.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
targetFabricFriendlyName	string	Friendly name of target fabric.
targetProtectionContainerFriendlyName	string	Friendly name of paired container.
targetProtectionContainerId	string	Paired protection container ARM ID.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_replication_protection_containers

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.
health	string	Health of pairing.
healthErrorDetails	array	Health error.
location	string	Resource Location.
policyFriendlyName	string	Friendly name of replication policy.
policyId	string	Policy ARM Id.
providerSpecificDetails	object	Provider specific provider details.
sourceFabricFriendlyName	string	Friendly name of source fabric.
sourceProtectionContainerFriendlyName	string	Friendly name of source protection container.
state	string	Association Status.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
targetFabricFriendlyName	string	Friendly name of target fabric.
targetProtectionContainerFriendlyName	string	Friendly name of paired container.
targetProtectionContainerId	string	Paired protection container ARM ID.
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.
health	string	Health of pairing.
healthErrorDetails	array	Health error.
location	string	Resource Location.
policyFriendlyName	string	Friendly name of replication policy.
policyId	string	Policy ARM Id.
providerSpecificDetails	object	Provider specific provider details.
sourceFabricFriendlyName	string	Friendly name of source fabric.
sourceProtectionContainerFriendlyName	string	Friendly name of source protection container.
state	string	Association Status.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
targetFabricFriendlyName	string	Friendly name of target fabric.
targetProtectionContainerFriendlyName	string	Friendly name of paired container.
targetProtectionContainerId	string	Paired protection container ARM ID.
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, mapping_name, subscription_id		Gets a protection container mapping. Gets the details of a protection container mapping.
list_by_replication_protection_containers	select	resource_group_name, resource_name, fabric_name, protection_container_name, subscription_id		Gets the list of protection container mappings for a protection container. Lists the protection container mappings for a protection container.
list	select	resource_group_name, resource_name, subscription_id		Gets the list of all protection container mappings in a vault. Lists the protection container mappings in the vault.
create	insert	resource_group_name, resource_name, fabric_name, protection_container_name, mapping_name, subscription_id		Create protection container mapping. The operation to create a protection container mapping.
update	update	resource_group_name, resource_name, fabric_name, protection_container_name, mapping_name, subscription_id		Update protection container mapping. The operation to update protection container mapping.
delete	delete	resource_group_name, resource_name, fabric_name, protection_container_name, mapping_name, subscription_id		Remove protection container mapping. The operation to delete or remove a protection container mapping.
purge	exec	resource_group_name, resource_name, fabric_name, protection_container_name, mapping_name, subscription_id		Purge protection container mapping. The operation to purge(force delete) a protection container mapping.

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.
mapping_name	string	Protection Container mapping 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 a protection container mapping. Gets the details of a protection container mapping.

SELECT
id,
name,
health,
healthErrorDetails,
location,
policyFriendlyName,
policyId,
providerSpecificDetails,
sourceFabricFriendlyName,
sourceProtectionContainerFriendlyName,
state,
systemData,
targetFabricFriendlyName,
targetProtectionContainerFriendlyName,
targetProtectionContainerId,
type
FROM azure.recovery_services_site_recovery.replication_protection_container_mappings
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 mapping_name = '{{ mapping_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_replication_protection_containers

Gets the list of protection container mappings for a protection container. Lists the protection container mappings for a protection container.

SELECT
id,
name,
health,
healthErrorDetails,
location,
policyFriendlyName,
policyId,
providerSpecificDetails,
sourceFabricFriendlyName,
sourceProtectionContainerFriendlyName,
state,
systemData,
targetFabricFriendlyName,
targetProtectionContainerFriendlyName,
targetProtectionContainerId,
type
FROM azure.recovery_services_site_recovery.replication_protection_container_mappings
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

Gets the list of all protection container mappings in a vault. Lists the protection container mappings in the vault.

SELECT
id,
name,
health,
healthErrorDetails,
location,
policyFriendlyName,
policyId,
providerSpecificDetails,
sourceFabricFriendlyName,
sourceProtectionContainerFriendlyName,
state,
systemData,
targetFabricFriendlyName,
targetProtectionContainerFriendlyName,
targetProtectionContainerId,
type
FROM azure.recovery_services_site_recovery.replication_protection_container_mappings
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Create protection container mapping. The operation to create a protection container mapping.

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

Manifest

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

UPDATE examples

update

Update protection container mapping. The operation to update protection container mapping.

UPDATE azure.recovery_services_site_recovery.replication_protection_container_mappings
SET 
properties = '{{ properties }}'
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 mapping_name = '{{ mapping_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
type;

DELETE examples

delete

Remove protection container mapping. The operation to delete or remove a protection container mapping.

DELETE FROM azure.recovery_services_site_recovery.replication_protection_container_mappings
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 mapping_name = '{{ mapping_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

purge

Purge protection container mapping. The operation to purge(force delete) a protection container mapping.

EXEC azure.recovery_services_site_recovery.replication_protection_container_mappings.purge 
@resource_group_name='{{ resource_group_name }}' --required, 
@resource_name='{{ resource_name }}' --required, 
@fabric_name='{{ fabric_name }}' --required, 
@protection_container_name='{{ protection_container_name }}' --required, 
@mapping_name='{{ mapping_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;