replication_networks

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

Overview

Name	replication_networks
Type	Resource
Id	azure.recovery_services_site_recovery.replication_networks

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.
fabricType	string	The Fabric Type.
friendlyName	string	The Friendly Name.
location	string	Resource Location.
networkType	string	The Network Type.
subnets	array	The List of subnets.
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.
fabricType	string	The Fabric Type.
friendlyName	string	The Friendly Name.
location	string	Resource Location.
networkType	string	The Network Type.
subnets	array	The List of subnets.
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.
fabricType	string	The Fabric Type.
friendlyName	string	The Friendly Name.
location	string	Resource Location.
networkType	string	The Network Type.
subnets	array	The List of subnets.
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, subscription_id		Gets a network with specified server id and network name. Gets the details of a network.
list_by_replication_fabrics	select	resource_group_name, resource_name, fabric_name, subscription_id		Gets the list of networks under a fabric. Lists the networks available for a fabric.
list	select	resource_group_name, resource_name, subscription_id		Gets the list of networks. View-only API. Lists the networks available in a vault.

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_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 recovery services vault. Required.
subscription_id	string

SELECT examples

get

Gets a network with specified server id and network name. Gets the details of a network.

SELECT
id,
name,
fabricType,
friendlyName,
location,
networkType,
subnets,
systemData,
type
FROM azure.recovery_services_site_recovery.replication_networks
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_by_replication_fabrics

Gets the list of networks under a fabric. Lists the networks available for a fabric.

SELECT
id,
name,
fabricType,
friendlyName,
location,
networkType,
subnets,
systemData,
type
FROM azure.recovery_services_site_recovery.replication_networks
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 networks. View-only API. Lists the networks available in a vault.

SELECT
id,
name,
fabricType,
friendlyName,
location,
networkType,
subnets,
systemData,
type
FROM azure.recovery_services_site_recovery.replication_networks
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;