Microsoft.RecoveryServices vaults/replicationFabrics 2023-06-01

Bicep resource definition

The vaults/replicationFabrics resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.RecoveryServices/vaults/replicationFabrics resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.RecoveryServices/vaults/replicationFabrics@2023-06-01' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    customDetails: {
      instanceType: 'string'
      // For remaining properties, see FabricSpecificCreationInputOrFabricSpecificDetails objects
    }
  }
}

FabricSpecificCreationInputOrFabricSpecificDetails objects

Set the instanceType property to specify the type of object.

For Azure, use:

  instanceType: 'Azure'
  location: 'string'

For HyperVSite, use:

  instanceType: 'HyperVSite'

For InMageRcm, use:

  instanceType: 'InMageRcm'
  physicalSiteId: 'string'
  sourceAgentIdentity: {
    aadAuthority: 'string'
    applicationId: 'string'
    audience: 'string'
    objectId: 'string'
    tenantId: 'string'
  }
  vmwareSiteId: 'string'

For VMM, use:

  instanceType: 'VMM'

For VMware, use:

  instanceType: 'VMware'

For VMwareV2, use:

  instanceType: 'VMwareV2'
  migrationSolutionId: 'string'
  physicalSiteId: 'string'
  vmwareSiteId: 'string'

Property values

vaults/replicationFabrics

Name Description Value
name The resource name

See how to set names and types for child resources in Bicep.
string (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.
Symbolic name for resource of type: vaults
properties Fabric creation input. FabricCreationInputPropertiesOrFabricProperties

FabricCreationInputPropertiesOrFabricProperties

Name Description Value
customDetails Fabric provider specific creation input. FabricSpecificCreationInputOrFabricSpecificDetails

FabricSpecificCreationInputOrFabricSpecificDetails

Name Description Value
instanceType Set the object type Azure
HyperVSite
InMageRcm
VMM
VMware
VMwareV2 (required)

AzureFabricCreationInputOrAzureFabricSpecificDetails

Name Description Value
instanceType Gets the class type. 'Azure' (required)
location The Location. string

HyperVSiteDetails

Name Description Value
instanceType Gets the class type. 'HyperVSite' (required)

InMageRcmFabricCreationInputOrInMageRcmFabricSpecifi...

Name Description Value
instanceType Gets the class type. 'InMageRcm' (required)
physicalSiteId The ARM Id of the physical site. string (required)
sourceAgentIdentity The identity provider input for source agent authentication. IdentityProviderInput (required)
vmwareSiteId The ARM Id of the VMware site. string (required)

IdentityProviderInput

Name Description Value
aadAuthority The base authority for Azure Active Directory authentication. string (required)
applicationId The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. string (required)
audience The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services. string (required)
objectId The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. string (required)
tenantId The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. string (required)

VmmDetails

Name Description Value
instanceType Gets the class type. 'VMM' (required)

VMwareDetails

Name Description Value
instanceType Gets the class type. 'VMware' (required)

VMwareV2FabricCreationInputOrVMwareV2FabricSpecificD...

Name Description Value
instanceType Gets the class type. 'VMwareV2' (required)
migrationSolutionId The ARM Id of the migration solution. string (required)
physicalSiteId The ARM Id of the physical site. string
vmwareSiteId The ARM Id of the VMware site. string

ARM template resource definition

The vaults/replicationFabrics resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.RecoveryServices/vaults/replicationFabrics resource, add the following JSON to your template.

{
  "type": "Microsoft.RecoveryServices/vaults/replicationFabrics",
  "apiVersion": "2023-06-01",
  "name": "string",
  "properties": {
    "customDetails": {
      "instanceType": "string"
      // For remaining properties, see FabricSpecificCreationInputOrFabricSpecificDetails objects
    }
  }
}

FabricSpecificCreationInputOrFabricSpecificDetails objects

Set the instanceType property to specify the type of object.

For Azure, use:

  "instanceType": "Azure",
  "location": "string"

For HyperVSite, use:

  "instanceType": "HyperVSite"

For InMageRcm, use:

  "instanceType": "InMageRcm",
  "physicalSiteId": "string",
  "sourceAgentIdentity": {
    "aadAuthority": "string",
    "applicationId": "string",
    "audience": "string",
    "objectId": "string",
    "tenantId": "string"
  },
  "vmwareSiteId": "string"

For VMM, use:

  "instanceType": "VMM"

For VMware, use:

  "instanceType": "VMware"

For VMwareV2, use:

  "instanceType": "VMwareV2",
  "migrationSolutionId": "string",
  "physicalSiteId": "string",
  "vmwareSiteId": "string"

Property values

vaults/replicationFabrics

Name Description Value
type The resource type 'Microsoft.RecoveryServices/vaults/replicationFabrics'
apiVersion The resource api version '2023-06-01'
name The resource name

See how to set names and types for child resources in JSON ARM templates.
string (required)
properties Fabric creation input. FabricCreationInputPropertiesOrFabricProperties

FabricCreationInputPropertiesOrFabricProperties

Name Description Value
customDetails Fabric provider specific creation input. FabricSpecificCreationInputOrFabricSpecificDetails

FabricSpecificCreationInputOrFabricSpecificDetails

Name Description Value
instanceType Set the object type Azure
HyperVSite
InMageRcm
VMM
VMware
VMwareV2 (required)

AzureFabricCreationInputOrAzureFabricSpecificDetails

Name Description Value
instanceType Gets the class type. 'Azure' (required)
location The Location. string

HyperVSiteDetails

Name Description Value
instanceType Gets the class type. 'HyperVSite' (required)

InMageRcmFabricCreationInputOrInMageRcmFabricSpecifi...

Name Description Value
instanceType Gets the class type. 'InMageRcm' (required)
physicalSiteId The ARM Id of the physical site. string (required)
sourceAgentIdentity The identity provider input for source agent authentication. IdentityProviderInput (required)
vmwareSiteId The ARM Id of the VMware site. string (required)

IdentityProviderInput

Name Description Value
aadAuthority The base authority for Azure Active Directory authentication. string (required)
applicationId The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. string (required)
audience The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services. string (required)
objectId The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. string (required)
tenantId The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. string (required)

VmmDetails

Name Description Value
instanceType Gets the class type. 'VMM' (required)

VMwareDetails

Name Description Value
instanceType Gets the class type. 'VMware' (required)

VMwareV2FabricCreationInputOrVMwareV2FabricSpecificD...

Name Description Value
instanceType Gets the class type. 'VMwareV2' (required)
migrationSolutionId The ARM Id of the migration solution. string (required)
physicalSiteId The ARM Id of the physical site. string
vmwareSiteId The ARM Id of the VMware site. string

Terraform (AzAPI provider) resource definition

The vaults/replicationFabrics resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.RecoveryServices/vaults/replicationFabrics resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.RecoveryServices/vaults/replicationFabrics@2023-06-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      customDetails = {
        instanceType = "string"
        // For remaining properties, see FabricSpecificCreationInputOrFabricSpecificDetails objects
      }
    }
  })
}

FabricSpecificCreationInputOrFabricSpecificDetails objects

Set the instanceType property to specify the type of object.

For Azure, use:

  instanceType = "Azure"
  location = "string"

For HyperVSite, use:

  instanceType = "HyperVSite"

For InMageRcm, use:

  instanceType = "InMageRcm"
  physicalSiteId = "string"
  sourceAgentIdentity = {
    aadAuthority = "string"
    applicationId = "string"
    audience = "string"
    objectId = "string"
    tenantId = "string"
  }
  vmwareSiteId = "string"

For VMM, use:

  instanceType = "VMM"

For VMware, use:

  instanceType = "VMware"

For VMwareV2, use:

  instanceType = "VMwareV2"
  migrationSolutionId = "string"
  physicalSiteId = "string"
  vmwareSiteId = "string"

Property values

vaults/replicationFabrics

Name Description Value
type The resource type "Microsoft.RecoveryServices/vaults/replicationFabrics@2023-06-01"
name The resource name string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: vaults
properties Fabric creation input. FabricCreationInputPropertiesOrFabricProperties

FabricCreationInputPropertiesOrFabricProperties

Name Description Value
customDetails Fabric provider specific creation input. FabricSpecificCreationInputOrFabricSpecificDetails

FabricSpecificCreationInputOrFabricSpecificDetails

Name Description Value
instanceType Set the object type Azure
HyperVSite
InMageRcm
VMM
VMware
VMwareV2 (required)

AzureFabricCreationInputOrAzureFabricSpecificDetails

Name Description Value
instanceType Gets the class type. "Azure" (required)
location The Location. string

HyperVSiteDetails

Name Description Value
instanceType Gets the class type. "HyperVSite" (required)

InMageRcmFabricCreationInputOrInMageRcmFabricSpecifi...

Name Description Value
instanceType Gets the class type. "InMageRcm" (required)
physicalSiteId The ARM Id of the physical site. string (required)
sourceAgentIdentity The identity provider input for source agent authentication. IdentityProviderInput (required)
vmwareSiteId The ARM Id of the VMware site. string (required)

IdentityProviderInput

Name Description Value
aadAuthority The base authority for Azure Active Directory authentication. string (required)
applicationId The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. string (required)
audience The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services. string (required)
objectId The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. string (required)
tenantId The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. string (required)

VmmDetails

Name Description Value
instanceType Gets the class type. "VMM" (required)

VMwareDetails

Name Description Value
instanceType Gets the class type. "VMware" (required)

VMwareV2FabricCreationInputOrVMwareV2FabricSpecificD...

Name Description Value
instanceType Gets the class type. "VMwareV2" (required)
migrationSolutionId The ARM Id of the migration solution. string (required)
physicalSiteId The ARM Id of the physical site. string
vmwareSiteId The ARM Id of the VMware site. string