replication_network_mappings

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

Overview

Name	replication_network_mappings
Type	Resource
Id	azure.recovery_services_site_recovery.replication_network_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.
fabricSpecificSettings	object	The fabric specific settings.
location	string	Resource Location.
primaryFabricFriendlyName	string	The primary fabric friendly name.
primaryNetworkFriendlyName	string	The primary network friendly name.
primaryNetworkId	string	The primary network id for network mapping.
recoveryFabricArmId	string	The recovery fabric ARM id.
recoveryFabricFriendlyName	string	The recovery fabric friendly name.
recoveryNetworkFriendlyName	string	The recovery network friendly name.
recoveryNetworkId	string	The recovery network id for network mapping.
state	string	The pairing state for network mapping.
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_networks

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.
fabricSpecificSettings	object	The fabric specific settings.
location	string	Resource Location.
primaryFabricFriendlyName	string	The primary fabric friendly name.
primaryNetworkFriendlyName	string	The primary network friendly name.
primaryNetworkId	string	The primary network id for network mapping.
recoveryFabricArmId	string	The recovery fabric ARM id.
recoveryFabricFriendlyName	string	The recovery fabric friendly name.
recoveryNetworkFriendlyName	string	The recovery network friendly name.
recoveryNetworkId	string	The recovery network id for network mapping.
state	string	The pairing state for network mapping.
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.
fabricSpecificSettings	object	The fabric specific settings.
location	string	Resource Location.
primaryFabricFriendlyName	string	The primary fabric friendly name.
primaryNetworkFriendlyName	string	The primary network friendly name.
primaryNetworkId	string	The primary network id for network mapping.
recoveryFabricArmId	string	The recovery fabric ARM id.
recoveryFabricFriendlyName	string	The recovery fabric friendly name.
recoveryNetworkFriendlyName	string	The recovery network friendly name.
recoveryNetworkId	string	The recovery network id for network mapping.
state	string	The pairing state for network mapping.
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, network_name, network_mapping_name, subscription_id		Gets network mapping by name. Gets the details of an ASR network mapping.
list_by_replication_networks	select	resource_group_name, resource_name, fabric_name, network_name, subscription_id		Gets all the network mappings under a network. Lists all ASR network mappings for the specified network.
list	select	resource_group_name, resource_name, subscription_id		Gets all the network mappings under a vault. Lists all ASR network mappings in the vault.
create	insert	resource_group_name, resource_name, fabric_name, network_name, network_mapping_name, subscription_id, properties		Creates network mapping. The operation to create an ASR network mapping.
update	update	resource_group_name, resource_name, fabric_name, network_name, network_mapping_name, subscription_id		Updates network mapping. The operation to update an ASR network mapping.
delete	delete	resource_group_name, resource_name, fabric_name, network_name, network_mapping_name, subscription_id		Delete network mapping. The operation to delete a network 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.
network_mapping_name	string	Network mapping name. Required.
network_name	string	Primary network 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 network mapping by name. Gets the details of an ASR network mapping.

SELECT
id,
name,
fabricSpecificSettings,
location,
primaryFabricFriendlyName,
primaryNetworkFriendlyName,
primaryNetworkId,
recoveryFabricArmId,
recoveryFabricFriendlyName,
recoveryNetworkFriendlyName,
recoveryNetworkId,
state,
systemData,
type
FROM azure.recovery_services_site_recovery.replication_network_mappings
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND fabric_name = '{{ fabric_name }}' -- required
AND network_name = '{{ network_name }}' -- required
AND network_mapping_name = '{{ network_mapping_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_replication_networks

Gets all the network mappings under a network. Lists all ASR network mappings for the specified network.

SELECT
id,
name,
fabricSpecificSettings,
location,
primaryFabricFriendlyName,
primaryNetworkFriendlyName,
primaryNetworkId,
recoveryFabricArmId,
recoveryFabricFriendlyName,
recoveryNetworkFriendlyName,
recoveryNetworkId,
state,
systemData,
type
FROM azure.recovery_services_site_recovery.replication_network_mappings
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND fabric_name = '{{ fabric_name }}' -- required
AND network_name = '{{ network_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Gets all the network mappings under a vault. Lists all ASR network mappings in the vault.

SELECT
id,
name,
fabricSpecificSettings,
location,
primaryFabricFriendlyName,
primaryNetworkFriendlyName,
primaryNetworkId,
recoveryFabricArmId,
recoveryFabricFriendlyName,
recoveryNetworkFriendlyName,
recoveryNetworkId,
state,
systemData,
type
FROM azure.recovery_services_site_recovery.replication_network_mappings
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Creates network mapping. The operation to create an ASR network mapping.

INSERT INTO azure.recovery_services_site_recovery.replication_network_mappings (
properties,
resource_group_name,
resource_name,
fabric_name,
network_name,
network_mapping_name,
subscription_id
)
SELECT 
'{{ properties }}' /* required */,
'{{ resource_group_name }}',
'{{ resource_name }}',
'{{ fabric_name }}',
'{{ network_name }}',
'{{ network_mapping_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: replication_network_mappings
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the replication_network_mappings resource.
  - name: resource_name
    value: "{{ resource_name }}"
    description: Required parameter for the replication_network_mappings resource.
  - name: fabric_name
    value: "{{ fabric_name }}"
    description: Required parameter for the replication_network_mappings resource.
  - name: network_name
    value: "{{ network_name }}"
    description: Required parameter for the replication_network_mappings resource.
  - name: network_mapping_name
    value: "{{ network_mapping_name }}"
    description: Required parameter for the replication_network_mappings resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the replication_network_mappings resource.
  - name: properties
    description: |
      Input properties for creating network mapping. Required.
    value:
      recoveryFabricName: "{{ recoveryFabricName }}"
      recoveryNetworkId: "{{ recoveryNetworkId }}"
      fabricSpecificDetails:
        instanceType: "{{ instanceType }}"

UPDATE examples

update

Updates network mapping. The operation to update an ASR network mapping.

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

DELETE examples

delete

Delete network mapping. The operation to delete a network mapping.

DELETE FROM azure.recovery_services_site_recovery.replication_network_mappings
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND resource_name = '{{ resource_name }}' --required
AND fabric_name = '{{ fabric_name }}' --required
AND network_name = '{{ network_name }}' --required
AND network_mapping_name = '{{ network_mapping_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;