Microsoft.DataReplication replicationVaults/protectedItems 2024-09-01

Article
2025-04-14

Bicep resource definition

The replicationVaults/protectedItems 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/replicationVaults/protectedItems resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.DataReplication/replicationVaults/protectedItems@2024-09-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    customProperties: {
      instanceType: 'string'
      // For remaining properties, see ProtectedItemModelCustomProperties objects
    }
    policyName: 'string'
    replicationExtensionName: 'string'
  }
}

ProtectedItemModelCustomProperties objects

Set the instanceType property to specify the type of object.

For HyperVToAzStackHCI, use:

{
  customLocationRegion: 'string'
  disksToInclude: [
    {
      diskBlockSize: int
      diskController: {
        controllerId: int
        controllerLocation: int
        controllerName: 'string'
      }
      diskFileFormat: 'string'
      diskId: 'string'
      diskIdentifier: 'string'
      diskLogicalSectorSize: int
      diskPhysicalSectorSize: int
      diskSizeGB: int
      isDynamic: bool
      isOsDisk: bool
      storageContainerId: 'string'
    }
  ]
  dynamicMemoryConfig: {
    maximumMemoryInMegaBytes: int
    minimumMemoryInMegaBytes: int
    targetMemoryBufferPercentage: int
  }
  fabricDiscoveryMachineId: 'string'
  hyperVGeneration: 'string'
  instanceType: 'HyperVToAzStackHCI'
  isDynamicRam: bool
  nicsToInclude: [
    {
      isMacMigrationEnabled: bool
      isStaticIpMigrationEnabled: bool
      nicId: 'string'
      selectionTypeForFailover: 'string'
      targetNetworkId: 'string'
      testNetworkId: 'string'
    }
  ]
  runAsAccountId: 'string'
  sourceFabricAgentName: 'string'
  storageContainerId: 'string'
  targetArcClusterCustomLocationId: 'string'
  targetCpuCores: int
  targetFabricAgentName: 'string'
  targetHciClusterId: 'string'
  targetMemoryInMegaBytes: int
  targetNetworkId: 'string'
  targetResourceGroupId: 'string'
  targetVmName: 'string'
  testNetworkId: 'string'
}

For VMwareToAzStackHCI, use:

{
  customLocationRegion: 'string'
  disksToInclude: [
    {
      diskBlockSize: int
      diskController: {
        controllerId: int
        controllerLocation: int
        controllerName: 'string'
      }
      diskFileFormat: 'string'
      diskId: 'string'
      diskIdentifier: 'string'
      diskLogicalSectorSize: int
      diskPhysicalSectorSize: int
      diskSizeGB: int
      isDynamic: bool
      isOsDisk: bool
      storageContainerId: 'string'
    }
  ]
  dynamicMemoryConfig: {
    maximumMemoryInMegaBytes: int
    minimumMemoryInMegaBytes: int
    targetMemoryBufferPercentage: int
  }
  fabricDiscoveryMachineId: 'string'
  hyperVGeneration: 'string'
  instanceType: 'VMwareToAzStackHCI'
  isDynamicRam: bool
  nicsToInclude: [
    {
      isMacMigrationEnabled: bool
      isStaticIpMigrationEnabled: bool
      label: 'string'
      nicId: 'string'
      selectionTypeForFailover: 'string'
      targetNetworkId: 'string'
      testNetworkId: 'string'
    }
  ]
  performAutoResync: bool
  runAsAccountId: 'string'
  sourceFabricAgentName: 'string'
  storageContainerId: 'string'
  targetArcClusterCustomLocationId: 'string'
  targetCpuCores: int
  targetFabricAgentName: 'string'
  targetHciClusterId: 'string'
  targetMemoryInMegaBytes: int
  targetNetworkId: 'string'
  targetResourceGroupId: 'string'
  targetVmName: 'string'
  testNetworkId: 'string'
}

Property Values

DiskControllerInputs

Nom	Description	Valeur
controllerId	Gets or sets the controller ID.	int (required)
controllerLocation	Gets or sets the controller Location.	int (required)
controllerName	Gets or sets the controller name (IDE,SCSI).	string Constraints: Min length = 1 (required)

HyperVToAzStackHCIDiskInput

Nom	Description	Valeur
diskBlockSize	Gets or sets a value of disk block size.	int
diskController	Disk controller.	DiskControllerInputs
diskFileFormat	Gets or sets the type of the virtual hard disk, vhd or vhdx.	string Constraints: Min length = 1 (required)
diskId	Gets or sets the disk Id.	string Constraints: Min length = 1 (required)
diskIdentifier	Gets or sets a value of disk identifier.	ficelle
diskLogicalSectorSize	Gets or sets a value of disk logical sector size.	int
diskPhysicalSectorSize	Gets or sets a value of disk physical sector size.	int
diskSizeGB	Gets or sets the disk size in GB.	int (required)
isDynamic	Gets or sets a value indicating whether dynamic sizing is enabled on the virtual hard disk.	bool
isOsDisk	Gets or sets a value indicating whether disk is os disk.	bool (required)
storageContainerId	Gets or sets the target storage account ARM Id.	ficelle

HyperVToAzStackHCINicInput

Nom	Description	Valeur
isMacMigrationEnabled	Gets or sets a value indicating whether mac address migration is enabled.	bool
isStaticIpMigrationEnabled	Gets or sets a value indicating whether static ip migration is enabled.	bool
nicId	Gets or sets the NIC Id.	string Constraints: Min length = 1 (required)
selectionTypeForFailover	Gets or sets the selection type of the NIC.	'NotSelected' 'SelectedByDefault' 'SelectedByUser' 'SelectedByUserOverride' (required)
targetNetworkId	Gets or sets the target network Id within AzStackHCI Cluster.	ficelle
testNetworkId	Gets or sets the target test network Id within AzStackHCI Cluster.	ficelle

HyperVToAzStackHCIProtectedItemModelCustomProperties

Nom	Description	Valeur
customLocationRegion	Gets or sets the location of Azure Arc HCI custom location resource.	string Constraints: Min length = 1 (required)
disksToInclude	Gets or sets the list of disks to replicate.	HyperVToAzStackHCIDiskInput[] (required)
dynamicMemoryConfig	Protected item dynamic memory config.	ProtectedItemDynamicMemoryConfig
fabricDiscoveryMachineId	Gets or sets the ARM Id of the discovered machine.	string (required)
hyperVGeneration	Gets or sets the hypervisor generation of the virtual machine.	string Constraints: Min length = 1 (required)
instanceType	Discriminator property for ProtectedItemModelCustomProperties.	'HyperVToAzStackHCI' (required)
isDynamicRam	Gets or sets a value indicating whether memory is dynamical.	bool
nicsToInclude	Gets or sets the list of VM NIC to replicate.	HyperVToAzStackHCINicInput[] (required)
runAsAccountId	Gets or sets the Run As account Id.	string Constraints: Min length = 1 (required)
sourceFabricAgentName	Gets or sets the source fabric agent name.	string Constraints: Min length = 1 (required)
storageContainerId	Gets or sets the target storage container ARM Id.	string (required)
targetArcClusterCustomLocationId	Gets or sets the Target Arc Cluster Custom Location ARM Id.	string (required)
targetCpuCores	Gets or sets the target CPU cores.	int
targetFabricAgentName	Gets or sets the target fabric agent name.	string Constraints: Min length = 1 (required)
targetHciClusterId	Gets or sets the Target HCI Cluster ARM Id.	string (required)
targetMemoryInMegaBytes	Gets or sets the target memory in mega-bytes.	int
targetNetworkId	Gets or sets the target network Id within AzStackHCI Cluster.	ficelle
targetResourceGroupId	Gets or sets the target resource group ARM Id.	string (required)
targetVmName	Gets or sets the target VM display name.	ficelle
testNetworkId	Gets or sets the target test network Id within AzStackHCI Cluster.	ficelle

Microsoft.DataReplication/replicationVaults/protectedItems

Nom	Description	Valeur
nom	The resource name	string Constraints: Pattern = `^[a-zA-Z0-9]*$` (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: replicationVaults
Propriétés	The resource-specific properties for this resource.	ProtectedItemModelProperties

ProtectedItemDynamicMemoryConfig

Nom	Description	Valeur
maximumMemoryInMegaBytes	Gets or sets maximum memory in MB.	int (required)
minimumMemoryInMegaBytes	Gets or sets minimum memory in MB.	int (required)
targetMemoryBufferPercentage	Gets or sets target memory buffer in %.	int (required)

ProtectedItemModelCustomProperties

Nom	Description	Valeur
instanceType	Set to 'HyperVToAzStackHCI' for type HyperVToAzStackHCIProtectedItemModelCustomProperties. Set to 'VMwareToAzStackHCI' for type VMwareToAzStackHCIProtectedItemModelCustomProperties.	'HyperVToAzStackHCI' 'VMwareToAzStackHCI' (required)

ProtectedItemModelProperties

Nom	Description	Valeur
customProperties	Protected item model custom properties.	ProtectedItemModelCustomProperties (required)
policyName	Gets or sets the policy name.	string Constraints: Min length = 1 (required)
replicationExtensionName	Gets or sets the replication extension name.	string Constraints: Min length = 1 (required)

VMwareToAzStackHCIDiskInput

Nom	Description	Valeur
diskBlockSize	Gets or sets a value of disk block size.	int
diskController	Disk controller.	DiskControllerInputs
diskFileFormat	Gets or sets the type of the virtual hard disk, vhd or vhdx.	string Constraints: Min length = 1 (required)
diskId	Gets or sets the disk Id.	string Constraints: Min length = 1 (required)
diskIdentifier	Gets or sets a value of disk identifier.	ficelle
diskLogicalSectorSize	Gets or sets a value of disk logical sector size.	int
diskPhysicalSectorSize	Gets or sets a value of disk physical sector size.	int
diskSizeGB	Gets or sets the disk size in GB.	int (required)
isDynamic	Gets or sets a value indicating whether dynamic sizing is enabled on the virtual hard disk.	bool
isOsDisk	Gets or sets a value indicating whether disk is os disk.	bool (required)
storageContainerId	Gets or sets the target storage account ARM Id.	ficelle

VMwareToAzStackHCINicInput

Nom	Description	Valeur
isMacMigrationEnabled	Gets or sets a value indicating whether mac address migration is enabled.	bool
isStaticIpMigrationEnabled	Gets or sets a value indicating whether static ip migration is enabled.	bool
étiquette	Gets or sets the NIC label.	string Constraints: Min length = 1 (required)
nicId	Gets or sets the NIC Id.	string Constraints: Min length = 1 (required)
selectionTypeForFailover	Gets or sets the selection type of the NIC.	'NotSelected' 'SelectedByDefault' 'SelectedByUser' 'SelectedByUserOverride' (required)
targetNetworkId	Gets or sets the target network Id within AzStackHCI Cluster.	ficelle
testNetworkId	Gets or sets the target test network Id within AzStackHCI Cluster.	ficelle

VMwareToAzStackHCIProtectedItemModelCustomProperties

Nom	Description	Valeur
customLocationRegion	Gets or sets the location of Azure Arc HCI custom location resource.	string Constraints: Min length = 1 (required)
disksToInclude	Gets or sets the list of disks to replicate.	VMwareToAzStackHCIDiskInput[] (required)
dynamicMemoryConfig	Protected item dynamic memory config.	ProtectedItemDynamicMemoryConfig
fabricDiscoveryMachineId	Gets or sets the ARM Id of the discovered machine.	string (required)
hyperVGeneration	Gets or sets the hypervisor generation of the virtual machine possible values are 1,2.	string Constraints: Min length = 1 (required)
instanceType	Discriminator property for ProtectedItemModelCustomProperties.	'VMwareToAzStackHCI' (required)
isDynamicRam	Gets or sets a value indicating whether memory is dynamical.	bool
nicsToInclude	Gets or sets the list of VM NIC to replicate.	VMwareToAzStackHCINicInput[] (required)
performAutoResync	Gets or sets a value indicating whether auto resync is to be done.	bool
runAsAccountId	Gets or sets the run as account Id.	string Constraints: Min length = 1 (required)
sourceFabricAgentName	Gets or sets the source fabric agent name.	string Constraints: Min length = 1 (required)
storageContainerId	Gets or sets the target storage container ARM Id.	string (required)
targetArcClusterCustomLocationId	Gets or sets the Target Arc Cluster Custom Location ARM Id.	string (required)
targetCpuCores	Gets or sets the target CPU cores.	int
targetFabricAgentName	Gets or sets the target fabric agent name.	string Constraints: Min length = 1 (required)
targetHciClusterId	Gets or sets the Target HCI Cluster ARM Id.	string (required)
targetMemoryInMegaBytes	Gets or sets the target memory in mega-bytes.	int
targetNetworkId	Gets or sets the target network Id within AzStackHCI Cluster.	ficelle
targetResourceGroupId	Gets or sets the target resource group ARM Id.	string (required)
targetVmName	Gets or sets the target VM display name.	ficelle
testNetworkId	Gets or sets the target test network Id within AzStackHCI Cluster.	ficelle

ARM template resource definition

The replicationVaults/protectedItems 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/replicationVaults/protectedItems resource, add the following JSON to your template.

{
  "type": "Microsoft.DataReplication/replicationVaults/protectedItems",
  "apiVersion": "2024-09-01",
  "name": "string",
  "properties": {
    "customProperties": {
      "instanceType": "string"
      // For remaining properties, see ProtectedItemModelCustomProperties objects
    },
    "policyName": "string",
    "replicationExtensionName": "string"
  }
}

ProtectedItemModelCustomProperties objects

Set the instanceType property to specify the type of object.

For HyperVToAzStackHCI, use:

{
  "customLocationRegion": "string",
  "disksToInclude": [
    {
      "diskBlockSize": "int",
      "diskController": {
        "controllerId": "int",
        "controllerLocation": "int",
        "controllerName": "string"
      },
      "diskFileFormat": "string",
      "diskId": "string",
      "diskIdentifier": "string",
      "diskLogicalSectorSize": "int",
      "diskPhysicalSectorSize": "int",
      "diskSizeGB": "int",
      "isDynamic": "bool",
      "isOsDisk": "bool",
      "storageContainerId": "string"
    }
  ],
  "dynamicMemoryConfig": {
    "maximumMemoryInMegaBytes": "int",
    "minimumMemoryInMegaBytes": "int",
    "targetMemoryBufferPercentage": "int"
  },
  "fabricDiscoveryMachineId": "string",
  "hyperVGeneration": "string",
  "instanceType": "HyperVToAzStackHCI",
  "isDynamicRam": "bool",
  "nicsToInclude": [
    {
      "isMacMigrationEnabled": "bool",
      "isStaticIpMigrationEnabled": "bool",
      "nicId": "string",
      "selectionTypeForFailover": "string",
      "targetNetworkId": "string",
      "testNetworkId": "string"
    }
  ],
  "runAsAccountId": "string",
  "sourceFabricAgentName": "string",
  "storageContainerId": "string",
  "targetArcClusterCustomLocationId": "string",
  "targetCpuCores": "int",
  "targetFabricAgentName": "string",
  "targetHciClusterId": "string",
  "targetMemoryInMegaBytes": "int",
  "targetNetworkId": "string",
  "targetResourceGroupId": "string",
  "targetVmName": "string",
  "testNetworkId": "string"
}

For VMwareToAzStackHCI, use:

{
  "customLocationRegion": "string",
  "disksToInclude": [
    {
      "diskBlockSize": "int",
      "diskController": {
        "controllerId": "int",
        "controllerLocation": "int",
        "controllerName": "string"
      },
      "diskFileFormat": "string",
      "diskId": "string",
      "diskIdentifier": "string",
      "diskLogicalSectorSize": "int",
      "diskPhysicalSectorSize": "int",
      "diskSizeGB": "int",
      "isDynamic": "bool",
      "isOsDisk": "bool",
      "storageContainerId": "string"
    }
  ],
  "dynamicMemoryConfig": {
    "maximumMemoryInMegaBytes": "int",
    "minimumMemoryInMegaBytes": "int",
    "targetMemoryBufferPercentage": "int"
  },
  "fabricDiscoveryMachineId": "string",
  "hyperVGeneration": "string",
  "instanceType": "VMwareToAzStackHCI",
  "isDynamicRam": "bool",
  "nicsToInclude": [
    {
      "isMacMigrationEnabled": "bool",
      "isStaticIpMigrationEnabled": "bool",
      "label": "string",
      "nicId": "string",
      "selectionTypeForFailover": "string",
      "targetNetworkId": "string",
      "testNetworkId": "string"
    }
  ],
  "performAutoResync": "bool",
  "runAsAccountId": "string",
  "sourceFabricAgentName": "string",
  "storageContainerId": "string",
  "targetArcClusterCustomLocationId": "string",
  "targetCpuCores": "int",
  "targetFabricAgentName": "string",
  "targetHciClusterId": "string",
  "targetMemoryInMegaBytes": "int",
  "targetNetworkId": "string",
  "targetResourceGroupId": "string",
  "targetVmName": "string",
  "testNetworkId": "string"
}

Property Values

DiskControllerInputs

Nom	Description	Valeur
controllerId	Gets or sets the controller ID.	int (required)
controllerLocation	Gets or sets the controller Location.	int (required)
controllerName	Gets or sets the controller name (IDE,SCSI).	string Constraints: Min length = 1 (required)

HyperVToAzStackHCIDiskInput

Nom	Description	Valeur
diskBlockSize	Gets or sets a value of disk block size.	int
diskController	Disk controller.	DiskControllerInputs
diskFileFormat	Gets or sets the type of the virtual hard disk, vhd or vhdx.	string Constraints: Min length = 1 (required)
diskId	Gets or sets the disk Id.	string Constraints: Min length = 1 (required)
diskIdentifier	Gets or sets a value of disk identifier.	ficelle
diskLogicalSectorSize	Gets or sets a value of disk logical sector size.	int
diskPhysicalSectorSize	Gets or sets a value of disk physical sector size.	int
diskSizeGB	Gets or sets the disk size in GB.	int (required)
isDynamic	Gets or sets a value indicating whether dynamic sizing is enabled on the virtual hard disk.	bool
isOsDisk	Gets or sets a value indicating whether disk is os disk.	bool (required)
storageContainerId	Gets or sets the target storage account ARM Id.	ficelle

HyperVToAzStackHCINicInput

Nom	Description	Valeur
isMacMigrationEnabled	Gets or sets a value indicating whether mac address migration is enabled.	bool
isStaticIpMigrationEnabled	Gets or sets a value indicating whether static ip migration is enabled.	bool
nicId	Gets or sets the NIC Id.	string Constraints: Min length = 1 (required)
selectionTypeForFailover	Gets or sets the selection type of the NIC.	'NotSelected' 'SelectedByDefault' 'SelectedByUser' 'SelectedByUserOverride' (required)
targetNetworkId	Gets or sets the target network Id within AzStackHCI Cluster.	ficelle
testNetworkId	Gets or sets the target test network Id within AzStackHCI Cluster.	ficelle

HyperVToAzStackHCIProtectedItemModelCustomProperties

Nom	Description	Valeur
customLocationRegion	Gets or sets the location of Azure Arc HCI custom location resource.	string Constraints: Min length = 1 (required)
disksToInclude	Gets or sets the list of disks to replicate.	HyperVToAzStackHCIDiskInput[] (required)
dynamicMemoryConfig	Protected item dynamic memory config.	ProtectedItemDynamicMemoryConfig
fabricDiscoveryMachineId	Gets or sets the ARM Id of the discovered machine.	string (required)
hyperVGeneration	Gets or sets the hypervisor generation of the virtual machine.	string Constraints: Min length = 1 (required)
instanceType	Discriminator property for ProtectedItemModelCustomProperties.	'HyperVToAzStackHCI' (required)
isDynamicRam	Gets or sets a value indicating whether memory is dynamical.	bool
nicsToInclude	Gets or sets the list of VM NIC to replicate.	HyperVToAzStackHCINicInput[] (required)
runAsAccountId	Gets or sets the Run As account Id.	string Constraints: Min length = 1 (required)
sourceFabricAgentName	Gets or sets the source fabric agent name.	string Constraints: Min length = 1 (required)
storageContainerId	Gets or sets the target storage container ARM Id.	string (required)
targetArcClusterCustomLocationId	Gets or sets the Target Arc Cluster Custom Location ARM Id.	string (required)
targetCpuCores	Gets or sets the target CPU cores.	int
targetFabricAgentName	Gets or sets the target fabric agent name.	string Constraints: Min length = 1 (required)
targetHciClusterId	Gets or sets the Target HCI Cluster ARM Id.	string (required)
targetMemoryInMegaBytes	Gets or sets the target memory in mega-bytes.	int
targetNetworkId	Gets or sets the target network Id within AzStackHCI Cluster.	ficelle
targetResourceGroupId	Gets or sets the target resource group ARM Id.	string (required)
targetVmName	Gets or sets the target VM display name.	ficelle
testNetworkId	Gets or sets the target test network Id within AzStackHCI Cluster.	ficelle

Microsoft.DataReplication/replicationVaults/protectedItems

Nom	Description	Valeur
apiVersion	The api version	'2024-09-01'
nom	The resource name	string Constraints: Pattern = `^[a-zA-Z0-9]*$` (required)
Propriétés	The resource-specific properties for this resource.	ProtectedItemModelProperties
type	The resource type	'Microsoft.DataReplication/replicationVaults/protectedItems'

ProtectedItemDynamicMemoryConfig

Nom	Description	Valeur
maximumMemoryInMegaBytes	Gets or sets maximum memory in MB.	int (required)
minimumMemoryInMegaBytes	Gets or sets minimum memory in MB.	int (required)
targetMemoryBufferPercentage	Gets or sets target memory buffer in %.	int (required)

ProtectedItemModelCustomProperties

Nom	Description	Valeur
instanceType	Set to 'HyperVToAzStackHCI' for type HyperVToAzStackHCIProtectedItemModelCustomProperties. Set to 'VMwareToAzStackHCI' for type VMwareToAzStackHCIProtectedItemModelCustomProperties.	'HyperVToAzStackHCI' 'VMwareToAzStackHCI' (required)

ProtectedItemModelProperties

Nom	Description	Valeur
customProperties	Protected item model custom properties.	ProtectedItemModelCustomProperties (required)
policyName	Gets or sets the policy name.	string Constraints: Min length = 1 (required)
replicationExtensionName	Gets or sets the replication extension name.	string Constraints: Min length = 1 (required)

VMwareToAzStackHCIDiskInput

Nom	Description	Valeur
diskBlockSize	Gets or sets a value of disk block size.	int
diskController	Disk controller.	DiskControllerInputs
diskFileFormat	Gets or sets the type of the virtual hard disk, vhd or vhdx.	string Constraints: Min length = 1 (required)
diskId	Gets or sets the disk Id.	string Constraints: Min length = 1 (required)
diskIdentifier	Gets or sets a value of disk identifier.	ficelle
diskLogicalSectorSize	Gets or sets a value of disk logical sector size.	int
diskPhysicalSectorSize	Gets or sets a value of disk physical sector size.	int
diskSizeGB	Gets or sets the disk size in GB.	int (required)
isDynamic	Gets or sets a value indicating whether dynamic sizing is enabled on the virtual hard disk.	bool
isOsDisk	Gets or sets a value indicating whether disk is os disk.	bool (required)
storageContainerId	Gets or sets the target storage account ARM Id.	ficelle

VMwareToAzStackHCINicInput

Nom	Description	Valeur
isMacMigrationEnabled	Gets or sets a value indicating whether mac address migration is enabled.	bool
isStaticIpMigrationEnabled	Gets or sets a value indicating whether static ip migration is enabled.	bool
étiquette	Gets or sets the NIC label.	string Constraints: Min length = 1 (required)
nicId	Gets or sets the NIC Id.	string Constraints: Min length = 1 (required)
selectionTypeForFailover	Gets or sets the selection type of the NIC.	'NotSelected' 'SelectedByDefault' 'SelectedByUser' 'SelectedByUserOverride' (required)
targetNetworkId	Gets or sets the target network Id within AzStackHCI Cluster.	ficelle
testNetworkId	Gets or sets the target test network Id within AzStackHCI Cluster.	ficelle

VMwareToAzStackHCIProtectedItemModelCustomProperties

Nom	Description	Valeur
customLocationRegion	Gets or sets the location of Azure Arc HCI custom location resource.	string Constraints: Min length = 1 (required)
disksToInclude	Gets or sets the list of disks to replicate.	VMwareToAzStackHCIDiskInput[] (required)
dynamicMemoryConfig	Protected item dynamic memory config.	ProtectedItemDynamicMemoryConfig
fabricDiscoveryMachineId	Gets or sets the ARM Id of the discovered machine.	string (required)
hyperVGeneration	Gets or sets the hypervisor generation of the virtual machine possible values are 1,2.	string Constraints: Min length = 1 (required)
instanceType	Discriminator property for ProtectedItemModelCustomProperties.	'VMwareToAzStackHCI' (required)
isDynamicRam	Gets or sets a value indicating whether memory is dynamical.	bool
nicsToInclude	Gets or sets the list of VM NIC to replicate.	VMwareToAzStackHCINicInput[] (required)
performAutoResync	Gets or sets a value indicating whether auto resync is to be done.	bool
runAsAccountId	Gets or sets the run as account Id.	string Constraints: Min length = 1 (required)
sourceFabricAgentName	Gets or sets the source fabric agent name.	string Constraints: Min length = 1 (required)
storageContainerId	Gets or sets the target storage container ARM Id.	string (required)
targetArcClusterCustomLocationId	Gets or sets the Target Arc Cluster Custom Location ARM Id.	string (required)
targetCpuCores	Gets or sets the target CPU cores.	int
targetFabricAgentName	Gets or sets the target fabric agent name.	string Constraints: Min length = 1 (required)
targetHciClusterId	Gets or sets the Target HCI Cluster ARM Id.	string (required)
targetMemoryInMegaBytes	Gets or sets the target memory in mega-bytes.	int
targetNetworkId	Gets or sets the target network Id within AzStackHCI Cluster.	ficelle
targetResourceGroupId	Gets or sets the target resource group ARM Id.	string (required)
targetVmName	Gets or sets the target VM display name.	ficelle
testNetworkId	Gets or sets the target test network Id within AzStackHCI Cluster.	ficelle

Exemples d’utilisation

Terraform (AzAPI provider) resource definition

The replicationVaults/protectedItems 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/replicationVaults/protectedItems resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DataReplication/replicationVaults/protectedItems@2024-09-01"
  name = "string"
  body = {
    properties = {
      customProperties = {
        instanceType = "string"
        // For remaining properties, see ProtectedItemModelCustomProperties objects
      }
      policyName = "string"
      replicationExtensionName = "string"
    }
  }
}

ProtectedItemModelCustomProperties objects

Set the instanceType property to specify the type of object.

For HyperVToAzStackHCI, use:

{
  customLocationRegion = "string"
  disksToInclude = [
    {
      diskBlockSize = int
      diskController = {
        controllerId = int
        controllerLocation = int
        controllerName = "string"
      }
      diskFileFormat = "string"
      diskId = "string"
      diskIdentifier = "string"
      diskLogicalSectorSize = int
      diskPhysicalSectorSize = int
      diskSizeGB = int
      isDynamic = bool
      isOsDisk = bool
      storageContainerId = "string"
    }
  ]
  dynamicMemoryConfig = {
    maximumMemoryInMegaBytes = int
    minimumMemoryInMegaBytes = int
    targetMemoryBufferPercentage = int
  }
  fabricDiscoveryMachineId = "string"
  hyperVGeneration = "string"
  instanceType = "HyperVToAzStackHCI"
  isDynamicRam = bool
  nicsToInclude = [
    {
      isMacMigrationEnabled = bool
      isStaticIpMigrationEnabled = bool
      nicId = "string"
      selectionTypeForFailover = "string"
      targetNetworkId = "string"
      testNetworkId = "string"
    }
  ]
  runAsAccountId = "string"
  sourceFabricAgentName = "string"
  storageContainerId = "string"
  targetArcClusterCustomLocationId = "string"
  targetCpuCores = int
  targetFabricAgentName = "string"
  targetHciClusterId = "string"
  targetMemoryInMegaBytes = int
  targetNetworkId = "string"
  targetResourceGroupId = "string"
  targetVmName = "string"
  testNetworkId = "string"
}

For VMwareToAzStackHCI, use:

{
  customLocationRegion = "string"
  disksToInclude = [
    {
      diskBlockSize = int
      diskController = {
        controllerId = int
        controllerLocation = int
        controllerName = "string"
      }
      diskFileFormat = "string"
      diskId = "string"
      diskIdentifier = "string"
      diskLogicalSectorSize = int
      diskPhysicalSectorSize = int
      diskSizeGB = int
      isDynamic = bool
      isOsDisk = bool
      storageContainerId = "string"
    }
  ]
  dynamicMemoryConfig = {
    maximumMemoryInMegaBytes = int
    minimumMemoryInMegaBytes = int
    targetMemoryBufferPercentage = int
  }
  fabricDiscoveryMachineId = "string"
  hyperVGeneration = "string"
  instanceType = "VMwareToAzStackHCI"
  isDynamicRam = bool
  nicsToInclude = [
    {
      isMacMigrationEnabled = bool
      isStaticIpMigrationEnabled = bool
      label = "string"
      nicId = "string"
      selectionTypeForFailover = "string"
      targetNetworkId = "string"
      testNetworkId = "string"
    }
  ]
  performAutoResync = bool
  runAsAccountId = "string"
  sourceFabricAgentName = "string"
  storageContainerId = "string"
  targetArcClusterCustomLocationId = "string"
  targetCpuCores = int
  targetFabricAgentName = "string"
  targetHciClusterId = "string"
  targetMemoryInMegaBytes = int
  targetNetworkId = "string"
  targetResourceGroupId = "string"
  targetVmName = "string"
  testNetworkId = "string"
}

Property Values

DiskControllerInputs

Nom	Description	Valeur
controllerId	Gets or sets the controller ID.	int (required)
controllerLocation	Gets or sets the controller Location.	int (required)
controllerName	Gets or sets the controller name (IDE,SCSI).	string Constraints: Min length = 1 (required)

HyperVToAzStackHCIDiskInput

Nom	Description	Valeur
diskBlockSize	Gets or sets a value of disk block size.	int
diskController	Disk controller.	DiskControllerInputs
diskFileFormat	Gets or sets the type of the virtual hard disk, vhd or vhdx.	string Constraints: Min length = 1 (required)
diskId	Gets or sets the disk Id.	string Constraints: Min length = 1 (required)
diskIdentifier	Gets or sets a value of disk identifier.	ficelle
diskLogicalSectorSize	Gets or sets a value of disk logical sector size.	int
diskPhysicalSectorSize	Gets or sets a value of disk physical sector size.	int
diskSizeGB	Gets or sets the disk size in GB.	int (required)
isDynamic	Gets or sets a value indicating whether dynamic sizing is enabled on the virtual hard disk.	bool
isOsDisk	Gets or sets a value indicating whether disk is os disk.	bool (required)
storageContainerId	Gets or sets the target storage account ARM Id.	ficelle

HyperVToAzStackHCINicInput

Nom	Description	Valeur
isMacMigrationEnabled	Gets or sets a value indicating whether mac address migration is enabled.	bool
isStaticIpMigrationEnabled	Gets or sets a value indicating whether static ip migration is enabled.	bool
nicId	Gets or sets the NIC Id.	string Constraints: Min length = 1 (required)
selectionTypeForFailover	Gets or sets the selection type of the NIC.	'NotSelected' 'SelectedByDefault' 'SelectedByUser' 'SelectedByUserOverride' (required)
targetNetworkId	Gets or sets the target network Id within AzStackHCI Cluster.	ficelle
testNetworkId	Gets or sets the target test network Id within AzStackHCI Cluster.	ficelle

HyperVToAzStackHCIProtectedItemModelCustomProperties

Nom	Description	Valeur
customLocationRegion	Gets or sets the location of Azure Arc HCI custom location resource.	string Constraints: Min length = 1 (required)
disksToInclude	Gets or sets the list of disks to replicate.	HyperVToAzStackHCIDiskInput[] (required)
dynamicMemoryConfig	Protected item dynamic memory config.	ProtectedItemDynamicMemoryConfig
fabricDiscoveryMachineId	Gets or sets the ARM Id of the discovered machine.	string (required)
hyperVGeneration	Gets or sets the hypervisor generation of the virtual machine.	string Constraints: Min length = 1 (required)
instanceType	Discriminator property for ProtectedItemModelCustomProperties.	'HyperVToAzStackHCI' (required)
isDynamicRam	Gets or sets a value indicating whether memory is dynamical.	bool
nicsToInclude	Gets or sets the list of VM NIC to replicate.	HyperVToAzStackHCINicInput[] (required)
runAsAccountId	Gets or sets the Run As account Id.	string Constraints: Min length = 1 (required)
sourceFabricAgentName	Gets or sets the source fabric agent name.	string Constraints: Min length = 1 (required)
storageContainerId	Gets or sets the target storage container ARM Id.	string (required)
targetArcClusterCustomLocationId	Gets or sets the Target Arc Cluster Custom Location ARM Id.	string (required)
targetCpuCores	Gets or sets the target CPU cores.	int
targetFabricAgentName	Gets or sets the target fabric agent name.	string Constraints: Min length = 1 (required)
targetHciClusterId	Gets or sets the Target HCI Cluster ARM Id.	string (required)
targetMemoryInMegaBytes	Gets or sets the target memory in mega-bytes.	int
targetNetworkId	Gets or sets the target network Id within AzStackHCI Cluster.	ficelle
targetResourceGroupId	Gets or sets the target resource group ARM Id.	string (required)
targetVmName	Gets or sets the target VM display name.	ficelle
testNetworkId	Gets or sets the target test network Id within AzStackHCI Cluster.	ficelle

Microsoft.DataReplication/replicationVaults/protectedItems

Nom	Description	Valeur
nom	The resource name	string Constraints: Pattern = `^[a-zA-Z0-9]*$` (required)
parent_id	The ID of the resource that is the parent for this resource.	ID for resource of type: replicationVaults
Propriétés	The resource-specific properties for this resource.	ProtectedItemModelProperties
type	The resource type	"Microsoft.DataReplication/replicationVaults/protectedItems@2024-09-01"

ProtectedItemDynamicMemoryConfig

Nom	Description	Valeur
maximumMemoryInMegaBytes	Gets or sets maximum memory in MB.	int (required)
minimumMemoryInMegaBytes	Gets or sets minimum memory in MB.	int (required)
targetMemoryBufferPercentage	Gets or sets target memory buffer in %.	int (required)

ProtectedItemModelCustomProperties

Nom	Description	Valeur
instanceType	Set to 'HyperVToAzStackHCI' for type HyperVToAzStackHCIProtectedItemModelCustomProperties. Set to 'VMwareToAzStackHCI' for type VMwareToAzStackHCIProtectedItemModelCustomProperties.	'HyperVToAzStackHCI' 'VMwareToAzStackHCI' (required)

ProtectedItemModelProperties

Nom	Description	Valeur
customProperties	Protected item model custom properties.	ProtectedItemModelCustomProperties (required)
policyName	Gets or sets the policy name.	string Constraints: Min length = 1 (required)
replicationExtensionName	Gets or sets the replication extension name.	string Constraints: Min length = 1 (required)

VMwareToAzStackHCIDiskInput

Nom	Description	Valeur
diskBlockSize	Gets or sets a value of disk block size.	int
diskController	Disk controller.	DiskControllerInputs
diskFileFormat	Gets or sets the type of the virtual hard disk, vhd or vhdx.	string Constraints: Min length = 1 (required)
diskId	Gets or sets the disk Id.	string Constraints: Min length = 1 (required)
diskIdentifier	Gets or sets a value of disk identifier.	ficelle
diskLogicalSectorSize	Gets or sets a value of disk logical sector size.	int
diskPhysicalSectorSize	Gets or sets a value of disk physical sector size.	int
diskSizeGB	Gets or sets the disk size in GB.	int (required)
isDynamic	Gets or sets a value indicating whether dynamic sizing is enabled on the virtual hard disk.	bool
isOsDisk	Gets or sets a value indicating whether disk is os disk.	bool (required)
storageContainerId	Gets or sets the target storage account ARM Id.	ficelle

VMwareToAzStackHCINicInput

Nom	Description	Valeur
isMacMigrationEnabled	Gets or sets a value indicating whether mac address migration is enabled.	bool
isStaticIpMigrationEnabled	Gets or sets a value indicating whether static ip migration is enabled.	bool
étiquette	Gets or sets the NIC label.	string Constraints: Min length = 1 (required)
nicId	Gets or sets the NIC Id.	string Constraints: Min length = 1 (required)
selectionTypeForFailover	Gets or sets the selection type of the NIC.	'NotSelected' 'SelectedByDefault' 'SelectedByUser' 'SelectedByUserOverride' (required)
targetNetworkId	Gets or sets the target network Id within AzStackHCI Cluster.	ficelle
testNetworkId	Gets or sets the target test network Id within AzStackHCI Cluster.	ficelle

VMwareToAzStackHCIProtectedItemModelCustomProperties

Nom	Description	Valeur
customLocationRegion	Gets or sets the location of Azure Arc HCI custom location resource.	string Constraints: Min length = 1 (required)
disksToInclude	Gets or sets the list of disks to replicate.	VMwareToAzStackHCIDiskInput[] (required)
dynamicMemoryConfig	Protected item dynamic memory config.	ProtectedItemDynamicMemoryConfig
fabricDiscoveryMachineId	Gets or sets the ARM Id of the discovered machine.	string (required)
hyperVGeneration	Gets or sets the hypervisor generation of the virtual machine possible values are 1,2.	string Constraints: Min length = 1 (required)
instanceType	Discriminator property for ProtectedItemModelCustomProperties.	'VMwareToAzStackHCI' (required)
isDynamicRam	Gets or sets a value indicating whether memory is dynamical.	bool
nicsToInclude	Gets or sets the list of VM NIC to replicate.	VMwareToAzStackHCINicInput[] (required)
performAutoResync	Gets or sets a value indicating whether auto resync is to be done.	bool
runAsAccountId	Gets or sets the run as account Id.	string Constraints: Min length = 1 (required)
sourceFabricAgentName	Gets or sets the source fabric agent name.	string Constraints: Min length = 1 (required)
storageContainerId	Gets or sets the target storage container ARM Id.	string (required)
targetArcClusterCustomLocationId	Gets or sets the Target Arc Cluster Custom Location ARM Id.	string (required)
targetCpuCores	Gets or sets the target CPU cores.	int
targetFabricAgentName	Gets or sets the target fabric agent name.	string Constraints: Min length = 1 (required)
targetHciClusterId	Gets or sets the Target HCI Cluster ARM Id.	string (required)
targetMemoryInMegaBytes	Gets or sets the target memory in mega-bytes.	int
targetNetworkId	Gets or sets the target network Id within AzStackHCI Cluster.	ficelle
targetResourceGroupId	Gets or sets the target resource group ARM Id.	string (required)
targetVmName	Gets or sets the target VM display name.	ficelle
testNetworkId	Gets or sets the target test network Id within AzStackHCI Cluster.	ficelle

Partager via

Microsoft.DataReplication replicationVaults/protectedItems 2024-09-01

Bicep resource definition

Resource format

ProtectedItemModelCustomProperties objects

Property Values

DiskControllerInputs

HyperVToAzStackHCIDiskInput

HyperVToAzStackHCINicInput

HyperVToAzStackHCIProtectedItemModelCustomProperties

Microsoft.DataReplication/replicationVaults/protectedItems

ProtectedItemDynamicMemoryConfig

ProtectedItemModelCustomProperties

ProtectedItemModelProperties

VMwareToAzStackHCIDiskInput

VMwareToAzStackHCINicInput

VMwareToAzStackHCIProtectedItemModelCustomProperties

ARM template resource definition

Resource format

ProtectedItemModelCustomProperties objects

Property Values

DiskControllerInputs

HyperVToAzStackHCIDiskInput

HyperVToAzStackHCINicInput

HyperVToAzStackHCIProtectedItemModelCustomProperties

Microsoft.DataReplication/replicationVaults/protectedItems

ProtectedItemDynamicMemoryConfig

ProtectedItemModelCustomProperties

ProtectedItemModelProperties

VMwareToAzStackHCIDiskInput

VMwareToAzStackHCINicInput

VMwareToAzStackHCIProtectedItemModelCustomProperties

Exemples d’utilisation

Terraform (AzAPI provider) resource definition

Resource format

ProtectedItemModelCustomProperties objects

Property Values

DiskControllerInputs

HyperVToAzStackHCIDiskInput

HyperVToAzStackHCINicInput

HyperVToAzStackHCIProtectedItemModelCustomProperties

Microsoft.DataReplication/replicationVaults/protectedItems

ProtectedItemDynamicMemoryConfig

ProtectedItemModelCustomProperties

ProtectedItemModelProperties

VMwareToAzStackHCIDiskInput

VMwareToAzStackHCINicInput

VMwareToAzStackHCIProtectedItemModelCustomProperties

Commentaires

Ressources supplémentaires