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

list_by_replication_networks

Name	Datatype	Description
id	string	Resource Id
name	string	Resource Name
location	string	Resource Location
properties	object	The Network Mapping Properties.
type	string	Resource Type

list

Name	Datatype	Description
id	string	Resource Id
name	string	Resource Name
location	string	Resource Location
properties	object	The Network Mapping Properties.
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, networkName, networkMappingName	api-version	Gets the details of an ASR network mapping.
list_by_replication_networks	select	resourceName, resourceGroupName, subscriptionId, fabricName, networkName	api-version	Lists all ASR network mappings for the specified network.
list	select	resourceName, resourceGroupName, subscriptionId	api-version	Lists all ASR network mappings in the vault.
create	insert	resourceName, resourceGroupName, subscriptionId, fabricName, networkName, networkMappingName, data__properties	api-version	The operation to create an ASR network mapping.
update	update	resourceName, resourceGroupName, subscriptionId, fabricName, networkName, networkMappingName	api-version	The operation to update an ASR network mapping.
delete	delete	resourceName, resourceGroupName, subscriptionId, fabricName, networkName, networkMappingName	api-version	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
fabricName	string	Primary fabric name.
networkMappingName	string	ARM Resource Name for network mapping.
networkName	string	Primary network 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 an ASR network mapping.

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

list_by_replication_networks

Lists all ASR network mappings for the specified network.

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

list

Lists all ASR network mappings in the vault.

SELECT
id,
name,
location,
properties,
type
FROM azure.recovery_services_site_recovery.replication_network_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 an ASR network mapping.

INSERT INTO azure.recovery_services_site_recovery.replication_network_mappings (
data__properties,
resourceName,
resourceGroupName,
subscriptionId,
fabricName,
networkName,
networkMappingName,
api-version
)
SELECT 
'{{ properties }}' /* required */,
'{{ resourceName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ fabricName }}',
'{{ networkName }}',
'{{ networkMappingName }}',
'{{ api-version }}'
RETURNING
id,
name,
location,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: replication_network_mappings
  props:
    - name: resourceName
      value: string
      description: Required parameter for the replication_network_mappings resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the replication_network_mappings resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the replication_network_mappings resource.
    - name: fabricName
      value: string
      description: Required parameter for the replication_network_mappings resource.
    - name: networkName
      value: string
      description: Required parameter for the replication_network_mappings resource.
    - name: networkMappingName
      value: string
      description: Required parameter for the replication_network_mappings resource.
    - name: properties
      value: object
      description: |
        Input properties for creating network mapping.
    - name: api-version
      value: string
      description: Client Api Version.

UPDATE examples

update

The operation to update an ASR network mapping.

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

DELETE examples

delete

The operation to delete a network mapping.

DELETE FROM azure.recovery_services_site_recovery.replication_network_mappings
WHERE resourceName = '{{ resourceName }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND fabricName = '{{ fabricName }}' --required
AND networkName = '{{ networkName }}' --required
AND networkMappingName = '{{ networkMappingName }}' --required
AND api-version = '{{ api-version }}'
;