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	Resource Id
name	string	Resource Name
location	string	Resource Location
properties	object	The custom data.
type	string	Resource Type

list_by_replication_protection_containers

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, mappingName	api-version	Gets the details of a protection container mapping.
list_by_replication_protection_containers	select	resourceName, resourceGroupName, subscriptionId, fabricName, protectionContainerName	api-version	Lists the protection container mappings for a protection container.
list	select	resourceName, resourceGroupName, subscriptionId	api-version	Lists the protection container mappings in the vault.
create	insert	resourceName, resourceGroupName, subscriptionId, fabricName, protectionContainerName, mappingName	api-version	The operation to create a protection container mapping.
update	update	resourceName, resourceGroupName, subscriptionId, fabricName, protectionContainerName, mappingName	api-version	The operation to update protection container mapping.
purge	exec	resourceName, resourceGroupName, subscriptionId, fabricName, protectionContainerName, mappingName	api-version	The operation to purge(force delete) a protection container mapping.
delete	exec	resourceName, resourceGroupName, subscriptionId, fabricName, protectionContainerName, mappingName	api-version	The operation to delete or remove 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
fabricName	string	Fabric name.
mappingName	string	Protection container mapping 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 mapping.

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

list_by_replication_protection_containers

Lists the protection container mappings for a protection container.

SELECT
id,
name,
location,
properties,
type
FROM azure.recovery_services_site_recovery.replication_protection_container_mappings
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

Lists the protection container mappings in the vault.

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

INSERT examples

create

The operation to create a protection container mapping.

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

Manifest

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

UPDATE examples

update

The operation to update protection container mapping.

UPDATE azure.recovery_services_site_recovery.replication_protection_container_mappings
SET 
data__properties = '{{ properties }}'
WHERE 
resourceName = '{{ resourceName }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND fabricName = '{{ fabricName }}' --required
AND protectionContainerName = '{{ protectionContainerName }}' --required
AND mappingName = '{{ mappingName }}' --required
AND api-version = '{{ api-version}}'
RETURNING
id,
name,
location,
properties,
type;

Lifecycle Methods

purge

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

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

delete

The operation to delete or remove a protection container mapping.

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