Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The replicationFabrics resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.DataReplication/replicationFabrics resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.DataReplication/replicationFabrics@2026-05-01' = {
location: 'string'
name: 'string'
properties: {
customProperties: {
instanceType: 'string'
// For remaining properties, see FabricModelCustomProperties objects
}
}
tags: {
{customized property}: 'string'
}
}
FabricModelCustomProperties objects
Set the instanceType property to specify the type of object.
For AzStackHCI, use:
{
azStackHciSiteId: 'string'
cluster: {
clusterName: 'string'
resourceName: 'string'
storageAccountName: 'string'
storageContainers: [
{
clusterSharedVolumePath: 'string'
name: 'string'
}
]
}
instanceType: 'AzStackHCI'
migrationSolutionId: 'string'
}
For HyperVMigrate, use:
{
hyperVSiteId: 'string'
instanceType: 'HyperVMigrate'
migrationSolutionId: 'string'
}
For VMwareMigrate, use:
{
instanceType: 'VMwareMigrate'
migrationSolutionId: 'string'
vmwareSiteId: 'string'
}
Property Values
Microsoft.DataReplication/replicationFabrics
| Name | Description | Value |
|---|---|---|
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Pattern = ^[a-zA-Z0-9]*$ (required) |
| properties | The resource-specific properties for this resource. | FabricModelProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
AzStackHCIClusterProperties
| Name | Description | Value |
|---|---|---|
| clusterName | Gets or sets the AzStackHCICluster FQDN name. | string Constraints: Min length = 1 (required) |
| resourceName | Gets or sets the AzStackHCICluster resource name. | string Constraints: Min length = 1 (required) |
| storageAccountName | Gets or sets the Storage account name. | string Constraints: Min length = 1 (required) |
| storageContainers | Gets or sets the list of AzStackHCICluster Storage Container. | StorageContainerProperties[] (required) |
AzStackHCIFabricModelCustomProperties
| Name | Description | Value |
|---|---|---|
| azStackHciSiteId | Gets or sets the ARM Id of the AzStackHCI site. | string (required) |
| cluster | AzStackHCI cluster properties. | AzStackHCIClusterProperties (required) |
| instanceType | Discriminator property for FabricModelCustomProperties. | 'AzStackHCI' (required) |
| migrationSolutionId | Gets or sets the Migration solution ARM Id. | string (required) |
FabricModelCustomProperties
| Name | Description | Value |
|---|---|---|
| instanceType | Set to 'AzStackHCI' for type AzStackHCIFabricModelCustomProperties. Set to 'HyperVMigrate' for type HyperVMigrateFabricModelCustomProperties. Set to 'VMwareMigrate' for type VMwareMigrateFabricModelCustomProperties. | 'AzStackHCI' 'HyperVMigrate' 'VMwareMigrate' (required) |
FabricModelProperties
| Name | Description | Value |
|---|---|---|
| customProperties | Fabric model custom properties. | FabricModelCustomProperties (required) |
HyperVMigrateFabricModelCustomProperties
| Name | Description | Value |
|---|---|---|
| hyperVSiteId | Gets or sets the ARM Id of the HyperV site. | string (required) |
| instanceType | Discriminator property for FabricModelCustomProperties. | 'HyperVMigrate' (required) |
| migrationSolutionId | Gets or sets the migration solution ARM Id. | string (required) |
StorageContainerProperties
| Name | Description | Value |
|---|---|---|
| clusterSharedVolumePath | Gets or sets the ClusterSharedVolumePath. | string Constraints: Min length = 1 (required) |
| name | Gets or sets the Name. | string Constraints: Min length = 1 (required) |
TrackedResourceTags
| Name | Description | Value |
|---|
VMwareMigrateFabricModelCustomProperties
| Name | Description | Value |
|---|---|---|
| instanceType | Discriminator property for FabricModelCustomProperties. | 'VMwareMigrate' (required) |
| migrationSolutionId | Gets or sets the ARM Id of the migration solution. | string (required) |
| vmwareSiteId | Gets or sets the ARM Id of the VMware site. | string (required) |
ARM template resource definition
The replicationFabrics resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands For a list of changed properties in each API version, see change log.
Usage Examples
Resource format
To create a Microsoft.DataReplication/replicationFabrics resource, add the following JSON to your template.
{
"type": "Microsoft.DataReplication/replicationFabrics",
"apiVersion": "2026-05-01",
"name": "string",
"location": "string",
"properties": {
"customProperties": {
"instanceType": "string"
// For remaining properties, see FabricModelCustomProperties objects
}
},
"tags": {
"{customized property}": "string"
}
}
FabricModelCustomProperties objects
Set the instanceType property to specify the type of object.
For AzStackHCI, use:
{
"azStackHciSiteId": "string",
"cluster": {
"clusterName": "string",
"resourceName": "string",
"storageAccountName": "string",
"storageContainers": [
{
"clusterSharedVolumePath": "string",
"name": "string"
}
]
},
"instanceType": "AzStackHCI",
"migrationSolutionId": "string"
}
For HyperVMigrate, use:
{
"hyperVSiteId": "string",
"instanceType": "HyperVMigrate",
"migrationSolutionId": "string"
}
For VMwareMigrate, use:
{
"instanceType": "VMwareMigrate",
"migrationSolutionId": "string",
"vmwareSiteId": "string"
}
Property Values
Microsoft.DataReplication/replicationFabrics
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2026-05-01' |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Pattern = ^[a-zA-Z0-9]*$ (required) |
| properties | The resource-specific properties for this resource. | FabricModelProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.DataReplication/replicationFabrics' |
AzStackHCIClusterProperties
| Name | Description | Value |
|---|---|---|
| clusterName | Gets or sets the AzStackHCICluster FQDN name. | string Constraints: Min length = 1 (required) |
| resourceName | Gets or sets the AzStackHCICluster resource name. | string Constraints: Min length = 1 (required) |
| storageAccountName | Gets or sets the Storage account name. | string Constraints: Min length = 1 (required) |
| storageContainers | Gets or sets the list of AzStackHCICluster Storage Container. | StorageContainerProperties[] (required) |
AzStackHCIFabricModelCustomProperties
| Name | Description | Value |
|---|---|---|
| azStackHciSiteId | Gets or sets the ARM Id of the AzStackHCI site. | string (required) |
| cluster | AzStackHCI cluster properties. | AzStackHCIClusterProperties (required) |
| instanceType | Discriminator property for FabricModelCustomProperties. | 'AzStackHCI' (required) |
| migrationSolutionId | Gets or sets the Migration solution ARM Id. | string (required) |
FabricModelCustomProperties
| Name | Description | Value |
|---|---|---|
| instanceType | Set to 'AzStackHCI' for type AzStackHCIFabricModelCustomProperties. Set to 'HyperVMigrate' for type HyperVMigrateFabricModelCustomProperties. Set to 'VMwareMigrate' for type VMwareMigrateFabricModelCustomProperties. | 'AzStackHCI' 'HyperVMigrate' 'VMwareMigrate' (required) |
FabricModelProperties
| Name | Description | Value |
|---|---|---|
| customProperties | Fabric model custom properties. | FabricModelCustomProperties (required) |
HyperVMigrateFabricModelCustomProperties
| Name | Description | Value |
|---|---|---|
| hyperVSiteId | Gets or sets the ARM Id of the HyperV site. | string (required) |
| instanceType | Discriminator property for FabricModelCustomProperties. | 'HyperVMigrate' (required) |
| migrationSolutionId | Gets or sets the migration solution ARM Id. | string (required) |
StorageContainerProperties
| Name | Description | Value |
|---|---|---|
| clusterSharedVolumePath | Gets or sets the ClusterSharedVolumePath. | string Constraints: Min length = 1 (required) |
| name | Gets or sets the Name. | string Constraints: Min length = 1 (required) |
TrackedResourceTags
| Name | Description | Value |
|---|
VMwareMigrateFabricModelCustomProperties
| Name | Description | Value |
|---|---|---|
| instanceType | Discriminator property for FabricModelCustomProperties. | 'VMwareMigrate' (required) |
| migrationSolutionId | Gets or sets the ARM Id of the migration solution. | string (required) |
| vmwareSiteId | Gets or sets the ARM Id of the VMware site. | string (required) |
Terraform (AzAPI provider) resource definition
The 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.DataReplication/replicationFabrics resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DataReplication/replicationFabrics@2026-05-01"
name = "string"
parent_id = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
customProperties = {
instanceType = "string"
// For remaining properties, see FabricModelCustomProperties objects
}
}
}
}
FabricModelCustomProperties objects
Set the instanceType property to specify the type of object.
For AzStackHCI, use:
{
azStackHciSiteId = "string"
cluster = {
clusterName = "string"
resourceName = "string"
storageAccountName = "string"
storageContainers = [
{
clusterSharedVolumePath = "string"
name = "string"
}
]
}
instanceType = "AzStackHCI"
migrationSolutionId = "string"
}
For HyperVMigrate, use:
{
hyperVSiteId = "string"
instanceType = "HyperVMigrate"
migrationSolutionId = "string"
}
For VMwareMigrate, use:
{
instanceType = "VMwareMigrate"
migrationSolutionId = "string"
vmwareSiteId = "string"
}
Property Values
Microsoft.DataReplication/replicationFabrics
| Name | Description | Value |
|---|---|---|
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Pattern = ^[a-zA-Z0-9]*$ (required) |
| properties | The resource-specific properties for this resource. | FabricModelProperties |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.DataReplication/replicationFabrics@2026-05-01" |
AzStackHCIClusterProperties
| Name | Description | Value |
|---|---|---|
| clusterName | Gets or sets the AzStackHCICluster FQDN name. | string Constraints: Min length = 1 (required) |
| resourceName | Gets or sets the AzStackHCICluster resource name. | string Constraints: Min length = 1 (required) |
| storageAccountName | Gets or sets the Storage account name. | string Constraints: Min length = 1 (required) |
| storageContainers | Gets or sets the list of AzStackHCICluster Storage Container. | StorageContainerProperties[] (required) |
AzStackHCIFabricModelCustomProperties
| Name | Description | Value |
|---|---|---|
| azStackHciSiteId | Gets or sets the ARM Id of the AzStackHCI site. | string (required) |
| cluster | AzStackHCI cluster properties. | AzStackHCIClusterProperties (required) |
| instanceType | Discriminator property for FabricModelCustomProperties. | 'AzStackHCI' (required) |
| migrationSolutionId | Gets or sets the Migration solution ARM Id. | string (required) |
FabricModelCustomProperties
| Name | Description | Value |
|---|---|---|
| instanceType | Set to 'AzStackHCI' for type AzStackHCIFabricModelCustomProperties. Set to 'HyperVMigrate' for type HyperVMigrateFabricModelCustomProperties. Set to 'VMwareMigrate' for type VMwareMigrateFabricModelCustomProperties. | 'AzStackHCI' 'HyperVMigrate' 'VMwareMigrate' (required) |
FabricModelProperties
| Name | Description | Value |
|---|---|---|
| customProperties | Fabric model custom properties. | FabricModelCustomProperties (required) |
HyperVMigrateFabricModelCustomProperties
| Name | Description | Value |
|---|---|---|
| hyperVSiteId | Gets or sets the ARM Id of the HyperV site. | string (required) |
| instanceType | Discriminator property for FabricModelCustomProperties. | 'HyperVMigrate' (required) |
| migrationSolutionId | Gets or sets the migration solution ARM Id. | string (required) |
StorageContainerProperties
| Name | Description | Value |
|---|---|---|
| clusterSharedVolumePath | Gets or sets the ClusterSharedVolumePath. | string Constraints: Min length = 1 (required) |
| name | Gets or sets the Name. | string Constraints: Min length = 1 (required) |
TrackedResourceTags
| Name | Description | Value |
|---|
VMwareMigrateFabricModelCustomProperties
| Name | Description | Value |
|---|---|---|
| instanceType | Discriminator property for FabricModelCustomProperties. | 'VMwareMigrate' (required) |
| migrationSolutionId | Gets or sets the ARM Id of the migration solution. | string (required) |
| vmwareSiteId | Gets or sets the ARM Id of the VMware site. | string (required) |