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

list

Name	Datatype	Description
id	string	Resource Id
name	string	Resource Name
location	string	Resource Location
properties	object	Fabric related 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	api-version, $filter	Gets the details of an Azure Site Recovery fabric.
list	select	resourceName, resourceGroupName, subscriptionId	api-version	Gets a list of the Azure Site Recovery fabrics in the vault.
create	insert	resourceName, resourceGroupName, subscriptionId, fabricName	api-version	The operation to create an Azure Site Recovery fabric (for e.g. Hyper-V site).
purge	exec	resourceName, resourceGroupName, subscriptionId, fabricName	api-version	The operation to purge(force delete) an Azure Site Recovery fabric.
check_consistency	exec	resourceName, resourceGroupName, subscriptionId, fabricName	api-version	The operation to perform a consistency check on the fabric.
migrate_to_aad	exec	resourceName, resourceGroupName, subscriptionId, fabricName	api-version	The operation to migrate an Azure Site Recovery fabric to AAD.
reassociate_gateway	exec	resourceName, resourceGroupName, subscriptionId, fabricName	api-version	The operation to move replications from a process server to another process server.
delete	exec	resourceName, resourceGroupName, subscriptionId, fabricName	api-version	The operation to delete or remove an Azure Site Recovery fabric.
renew_certificate	exec	resourceName, resourceGroupName, subscriptionId, fabricName	api-version	Renews the connection certificate for the ASR replication fabric.
remove_infra	exec	resourceGroupName, subscriptionId, resourceName, fabricName	api-version

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.
resourceGroupName	string	The name of the resource group where the recovery services vault is present.
resourceName	string	Resource name.
subscriptionId	string	The subscription Id.
$filter	string	OData filter options.
api-version	string	Client Api Version.

SELECT examples

get

Gets the details of an Azure Site Recovery fabric.

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

list

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

SELECT
id,
name,
location,
properties,
type
FROM azure.recovery_services_site_recovery.replication_fabrics
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 Azure Site Recovery fabric (for e.g. Hyper-V site).

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

Manifest

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

Lifecycle Methods

purge

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

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

check_consistency

The operation to perform a consistency check on the fabric.

EXEC azure.recovery_services_site_recovery.replication_fabrics.check_consistency 
@resourceName='{{ resourceName }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@fabricName='{{ fabricName }}' --required, 
@api-version='{{ api-version }}'
;

migrate_to_aad

The operation to migrate an Azure Site Recovery fabric to AAD.

EXEC azure.recovery_services_site_recovery.replication_fabrics.migrate_to_aad 
@resourceName='{{ resourceName }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@fabricName='{{ fabricName }}' --required, 
@api-version='{{ api-version }}'
;

reassociate_gateway

The operation to move replications from a process server to another process server.

EXEC azure.recovery_services_site_recovery.replication_fabrics.reassociate_gateway 
@resourceName='{{ resourceName }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@fabricName='{{ fabricName }}' --required, 
@api-version='{{ api-version }}' 
@@json=
'{
"properties": "{{ properties }}"
}'
;

delete

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

EXEC azure.recovery_services_site_recovery.replication_fabrics.delete 
@resourceName='{{ resourceName }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@fabricName='{{ fabricName }}' --required, 
@api-version='{{ api-version }}'
;

renew_certificate

Renews the connection certificate for the ASR replication fabric.

EXEC azure.recovery_services_site_recovery.replication_fabrics.renew_certificate 
@resourceName='{{ resourceName }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@fabricName='{{ fabricName }}' --required, 
@api-version='{{ api-version }}' 
@@json=
'{
"properties": "{{ properties }}"
}'
;

remove_infra

Accepted

EXEC azure.recovery_services_site_recovery.replication_fabrics.remove_infra 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceName='{{ resourceName }}' --required, 
@fabricName='{{ fabricName }}' --required, 
@api-version='{{ api-version }}'
;