replication_fabrics

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

Overview

Name	replication_fabrics
Type	Resource
Id	azure.recovery_services_site_recovery.replication_fabrics

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.
bcdrState	string	BCDR state of the fabric.
customDetails	object	Fabric specific settings.
encryptionDetails	object	Encryption details for the fabric.
friendlyName	string	Friendly name of the fabric.
health	string	Health of fabric.
healthErrorDetails	array	Fabric health error details.
internalIdentifier	string	Dra Registration Id.
location	string	Resource Location.
rolloverEncryptionDetails	object	Rollover encryption details for the fabric.
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.
bcdrState	string	BCDR state of the fabric.
customDetails	object	Fabric specific settings.
encryptionDetails	object	Encryption details for the fabric.
friendlyName	string	Friendly name of the fabric.
health	string	Health of fabric.
healthErrorDetails	array	Fabric health error details.
internalIdentifier	string	Dra Registration Id.
location	string	Resource Location.
rolloverEncryptionDetails	object	Rollover encryption details for the fabric.
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, subscription_id	$filter	Gets the details of an ASR fabric. Gets the details of an Azure Site Recovery fabric.
list	select	resource_group_name, resource_name, subscription_id		Gets the list of ASR fabrics. Gets a list of the Azure Site Recovery fabrics in the vault.
create	insert	resource_group_name, resource_name, fabric_name, subscription_id		Creates an Azure Site Recovery fabric. The operation to create an Azure Site Recovery fabric (for e.g. Hyper-V site).
delete	delete	resource_group_name, resource_name, fabric_name, subscription_id		Deletes the site. The operation to delete or remove an Azure Site Recovery fabric.
purge	exec	resource_group_name, resource_name, fabric_name, subscription_id		Purges the site. The operation to purge(force delete) an Azure Site Recovery fabric.
check_consistency	exec	resource_group_name, resource_name, fabric_name, subscription_id		Checks the consistency of the ASR fabric. The operation to perform a consistency check on the fabric.
migrate_to_aad	exec	resource_group_name, resource_name, fabric_name, subscription_id		Migrates the site to AAD. The operation to migrate an Azure Site Recovery fabric to AAD.
reassociate_gateway	exec	resource_group_name, resource_name, fabric_name, subscription_id		Perform failover of the process server. The operation to move replications from a process server to another process server.
renew_certificate	exec	resource_group_name, resource_name, fabric_name, subscription_id		Renews certificate for the fabric. Renews the connection certificate for the ASR replication fabric.
remove_infra	exec	resource_group_name, resource_name, fabric_name, subscription_id		Removes the appliance's infrastructure under the fabric. Removes the appliance's infrastructure under the fabric.

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.
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
$filter	string	OData filter options. Default value is None.

SELECT examples

get

Gets the details of an ASR fabric. Gets the details of an Azure Site Recovery fabric.

SELECT
id,
name,
bcdrState,
customDetails,
encryptionDetails,
friendlyName,
health,
healthErrorDetails,
internalIdentifier,
location,
rolloverEncryptionDetails,
systemData,
type
FROM azure.recovery_services_site_recovery.replication_fabrics
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
AND $filter = '{{ $filter }}'
;

list

Gets the list of ASR fabrics. Gets a list of the Azure Site Recovery fabrics in the vault.

SELECT
id,
name,
bcdrState,
customDetails,
encryptionDetails,
friendlyName,
health,
healthErrorDetails,
internalIdentifier,
location,
rolloverEncryptionDetails,
systemData,
type
FROM azure.recovery_services_site_recovery.replication_fabrics
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Creates an Azure Site Recovery fabric. The operation to create an Azure Site Recovery fabric (for e.g. Hyper-V site).

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

Manifest

# Description fields are for documentation purposes
- name: replication_fabrics
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the replication_fabrics resource.
  - name: resource_name
    value: "{{ resource_name }}"
    description: Required parameter for the replication_fabrics resource.
  - name: fabric_name
    value: "{{ fabric_name }}"
    description: Required parameter for the replication_fabrics resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the replication_fabrics resource.
  - name: properties
    description: |
      Fabric creation input.
    value:
      customDetails:
        instanceType: "{{ instanceType }}"

DELETE examples

delete

Deletes the site. The operation to delete or remove an Azure Site Recovery fabric.

DELETE FROM azure.recovery_services_site_recovery.replication_fabrics
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
;

Lifecycle Methods

purge

Purges the site. The operation to purge(force delete) an Azure Site Recovery fabric.

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

check_consistency

Checks the consistency of the ASR fabric. The operation to perform a consistency check on the fabric.

EXEC azure.recovery_services_site_recovery.replication_fabrics.check_consistency 
@resource_group_name='{{ resource_group_name }}' --required, 
@resource_name='{{ resource_name }}' --required, 
@fabric_name='{{ fabric_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

migrate_to_aad

Migrates the site to AAD. The operation to migrate an Azure Site Recovery fabric to AAD.

EXEC azure.recovery_services_site_recovery.replication_fabrics.migrate_to_aad 
@resource_group_name='{{ resource_group_name }}' --required, 
@resource_name='{{ resource_name }}' --required, 
@fabric_name='{{ fabric_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

reassociate_gateway

Perform failover of the process server. The operation to move replications from a process server to another process server.

EXEC azure.recovery_services_site_recovery.replication_fabrics.reassociate_gateway 
@resource_group_name='{{ resource_group_name }}' --required, 
@resource_name='{{ resource_name }}' --required, 
@fabric_name='{{ fabric_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

renew_certificate

Renews certificate for the fabric. Renews the connection certificate for the ASR replication fabric.

EXEC azure.recovery_services_site_recovery.replication_fabrics.renew_certificate 
@resource_group_name='{{ resource_group_name }}' --required, 
@resource_name='{{ resource_name }}' --required, 
@fabric_name='{{ fabric_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

remove_infra

Removes the appliance's infrastructure under the fabric. Removes the appliance's infrastructure under the fabric.

EXEC azure.recovery_services_site_recovery.replication_fabrics.remove_infra 
@resource_group_name='{{ resource_group_name }}' --required, 
@resource_name='{{ resource_name }}' --required, 
@fabric_name='{{ fabric_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;