Microsoft.DataReplication replicationVaults/protectedItems 2021-02-16-preview

2024-12-09

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@2021-02-16-preview' = {
  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: [
    {
      diskFileFormat: 'string'
      diskId: 'string'
      diskSizeGB: int
      isDynamic: bool
      isOsDisk: bool
      storageContainerId: 'string'
    }
  ]
  dynamicMemoryConfig: {
    maximumMemoryInMegaBytes: int
    minimumMemoryInMegaBytes: int
    targetMemoryBufferPercentage: int
  }
  fabricDiscoveryMachineId: 'string'
  hyperVGeneration: 'string'
  instanceType: 'HyperVToAzStackHCI'
  isDynamicRam: bool
  nicsToInclude: [
    {
      nicId: 'string'
      selectionTypeForFailover: 'string'
      targetNetworkId: 'string'
      testNetworkId: 'string'
    }
  ]
  runAsAccountId: 'string'
  sourceDraName: 'string'
  storageContainerId: 'string'
  targetArcClusterCustomLocationId: 'string'
  targetCpuCores: int
  targetDraName: 'string'
  targetHciClusterId: 'string'
  targetMemoryInMegaBytes: int
  targetNetworkId: 'string'
  targetResourceGroupId: 'string'
  targetVmName: 'string'
  testNetworkId: 'string'
}

For VMwareToAzStackHCI, use:

{
  customLocationRegion: 'string'
  disksToInclude: [
    {
      diskFileFormat: 'string'
      diskId: 'string'
      diskSizeGB: int
      isDynamic: bool
      isOsDisk: bool
      storageContainerId: 'string'
    }
  ]
  dynamicMemoryConfig: {
    maximumMemoryInMegaBytes: int
    minimumMemoryInMegaBytes: int
    targetMemoryBufferPercentage: int
  }
  fabricDiscoveryMachineId: 'string'
  hyperVGeneration: 'string'
  instanceType: 'VMwareToAzStackHCI'
  isDynamicRam: bool
  nicsToInclude: [
    {
      label: 'string'
      nicId: 'string'
      selectionTypeForFailover: 'string'
      targetNetworkId: 'string'
      testNetworkId: 'string'
    }
  ]
  performAutoResync: bool
  runAsAccountId: 'string'
  sourceDraName: 'string'
  storageContainerId: 'string'
  targetArcClusterCustomLocationId: 'string'
  targetCpuCores: int
  targetDraName: 'string'
  targetHciClusterId: 'string'
  targetMemoryInMegaBytes: int
  targetNetworkId: 'string'
  targetResourceGroupId: 'string'
  targetVmName: 'string'
  testNetworkId: 'string'
}

Property Values

Microsoft.DataReplication/replicationVaults/protectedItems

Name	Description	Value
name	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
properties	Protected item model properties.	ProtectedItemModelProperties (required)

HyperVToAzStackHCIDiskInput

Name	Description	Value
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)
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.	string

HyperVToAzStackHCINicInput

Name	Description	Value
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.	string Constraints: Min length = 1 (required)
testNetworkId	Gets or sets the target test network Id within AzStackHCI Cluster.	string Constraints: Min length = 1 (required)

HyperVToAzStackHCIProtectedItemModelCustomProperties

Name	Description	Value
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 Constraints: Min length = 1 (required)
hyperVGeneration	Gets or sets the hypervisor generation of the virtual machine.	string Constraints: Min length = 1 (required)
instanceType	Gets or sets the instance type.	'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)
sourceDraName	Gets or sets the source DRA name.	string Constraints: Min length = 1 (required)
storageContainerId	Gets or sets the target storage container ARM Id.	string Constraints: Min length = 1 (required)
targetArcClusterCustomLocationId	Gets or sets the Target Arc Cluster Custom Location ARM Id.	string Constraints: Min length = 1 (required)
targetCpuCores	Gets or sets the target CPU cores.	int
targetDraName	Gets or sets the target DRA name.	string Constraints: Min length = 1 (required)
targetHciClusterId	Gets or sets the Target HCI Cluster ARM Id.	string Constraints: Min length = 1 (required)
targetMemoryInMegaBytes	Gets or sets the target memory in mega-bytes.	int
targetNetworkId	Gets or sets the target network Id within AzStackHCI Cluster.	string
targetResourceGroupId	Gets or sets the target resource group ARM Id.	string Constraints: Min length = 1 (required)
targetVmName	Gets or sets the target VM display name.	string
testNetworkId	Gets or sets the target test network Id within AzStackHCI Cluster.	string

ProtectedItemDynamicMemoryConfig

Name	Description	Value
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

Name	Description	Value
instanceType	Set to 'HyperVToAzStackHCI' for type HyperVToAzStackHCIProtectedItemModelCustomProperties. Set to 'VMwareToAzStackHCI' for type VMwareToAzStackHCIProtectedItemModelCustomProperties.	'HyperVToAzStackHCI' 'VMwareToAzStackHCI' (required)

ProtectedItemModelProperties

Name	Description	Value
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

Name	Description	Value
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)
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.	string

VMwareToAzStackHCINicInput

Name	Description	Value
label	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.	string Constraints: Min length = 1 (required)
testNetworkId	Gets or sets the target test network Id within AzStackHCI Cluster.	string Constraints: Min length = 1 (required)

VMwareToAzStackHCIProtectedItemModelCustomProperties

Name	Description	Value
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 Constraints: Min length = 1 (required)
hyperVGeneration	Gets or sets the hypervisor generation of the virtual machine possible values are 1,2.	string Constraints: Min length = 1 (required)
instanceType	Gets or sets the instance type.	'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)
sourceDraName	Gets or sets the source DRA name.	string Constraints: Min length = 1 (required)
storageContainerId	Gets or sets the target storage container ARM Id.	string Constraints: Min length = 1 (required)
targetArcClusterCustomLocationId	Gets or sets the Target Arc Cluster Custom Location ARM Id.	string Constraints: Min length = 1 (required)
targetCpuCores	Gets or sets the target CPU cores.	int
targetDraName	Gets or sets the target DRA name.	string Constraints: Min length = 1 (required)
targetHciClusterId	Gets or sets the Target HCI Cluster ARM Id.	string Constraints: Min length = 1 (required)
targetMemoryInMegaBytes	Gets or sets the target memory in mega-bytes.	int
targetNetworkId	Gets or sets the target network Id within AzStackHCI Cluster.	string
targetResourceGroupId	Gets or sets the target resource group ARM Id.	string Constraints: Min length = 1 (required)
targetVmName	Gets or sets the target VM display name.	string
testNetworkId	Gets or sets the target test network Id within AzStackHCI Cluster.	string

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": "2021-02-16-preview",
  "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": [
    {
      "diskFileFormat": "string",
      "diskId": "string",
      "diskSizeGB": "int",
      "isDynamic": "bool",
      "isOsDisk": "bool",
      "storageContainerId": "string"
    }
  ],
  "dynamicMemoryConfig": {
    "maximumMemoryInMegaBytes": "int",
    "minimumMemoryInMegaBytes": "int",
    "targetMemoryBufferPercentage": "int"
  },
  "fabricDiscoveryMachineId": "string",
  "hyperVGeneration": "string",
  "instanceType": "HyperVToAzStackHCI",
  "isDynamicRam": "bool",
  "nicsToInclude": [
    {
      "nicId": "string",
      "selectionTypeForFailover": "string",
      "targetNetworkId": "string",
      "testNetworkId": "string"
    }
  ],
  "runAsAccountId": "string",
  "sourceDraName": "string",
  "storageContainerId": "string",
  "targetArcClusterCustomLocationId": "string",
  "targetCpuCores": "int",
  "targetDraName": "string",
  "targetHciClusterId": "string",
  "targetMemoryInMegaBytes": "int",
  "targetNetworkId": "string",
  "targetResourceGroupId": "string",
  "targetVmName": "string",
  "testNetworkId": "string"
}

For VMwareToAzStackHCI, use:

{
  "customLocationRegion": "string",
  "disksToInclude": [
    {
      "diskFileFormat": "string",
      "diskId": "string",
      "diskSizeGB": "int",
      "isDynamic": "bool",
      "isOsDisk": "bool",
      "storageContainerId": "string"
    }
  ],
  "dynamicMemoryConfig": {
    "maximumMemoryInMegaBytes": "int",
    "minimumMemoryInMegaBytes": "int",
    "targetMemoryBufferPercentage": "int"
  },
  "fabricDiscoveryMachineId": "string",
  "hyperVGeneration": "string",
  "instanceType": "VMwareToAzStackHCI",
  "isDynamicRam": "bool",
  "nicsToInclude": [
    {
      "label": "string",
      "nicId": "string",
      "selectionTypeForFailover": "string",
      "targetNetworkId": "string",
      "testNetworkId": "string"
    }
  ],
  "performAutoResync": "bool",
  "runAsAccountId": "string",
  "sourceDraName": "string",
  "storageContainerId": "string",
  "targetArcClusterCustomLocationId": "string",
  "targetCpuCores": "int",
  "targetDraName": "string",
  "targetHciClusterId": "string",
  "targetMemoryInMegaBytes": "int",
  "targetNetworkId": "string",
  "targetResourceGroupId": "string",
  "targetVmName": "string",
  "testNetworkId": "string"
}

Property Values

Microsoft.DataReplication/replicationVaults/protectedItems

Name	Description	Value
apiVersion	The api version	'2021-02-16-preview'
name	The resource name	string Constraints: Pattern = `^[a-zA-Z0-9]*$` (required)
properties	Protected item model properties.	ProtectedItemModelProperties (required)
type	The resource type	'Microsoft.DataReplication/replicationVaults/protectedItems'

HyperVToAzStackHCIDiskInput

Name	Description	Value
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)
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.	string

HyperVToAzStackHCINicInput

Name	Description	Value
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.	string Constraints: Min length = 1 (required)
testNetworkId	Gets or sets the target test network Id within AzStackHCI Cluster.	string Constraints: Min length = 1 (required)

HyperVToAzStackHCIProtectedItemModelCustomProperties

Name	Description	Value
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 Constraints: Min length = 1 (required)
hyperVGeneration	Gets or sets the hypervisor generation of the virtual machine.	string Constraints: Min length = 1 (required)
instanceType	Gets or sets the instance type.	'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)
sourceDraName	Gets or sets the source DRA name.	string Constraints: Min length = 1 (required)
storageContainerId	Gets or sets the target storage container ARM Id.	string Constraints: Min length = 1 (required)
targetArcClusterCustomLocationId	Gets or sets the Target Arc Cluster Custom Location ARM Id.	string Constraints: Min length = 1 (required)
targetCpuCores	Gets or sets the target CPU cores.	int
targetDraName	Gets or sets the target DRA name.	string Constraints: Min length = 1 (required)
targetHciClusterId	Gets or sets the Target HCI Cluster ARM Id.	string Constraints: Min length = 1 (required)
targetMemoryInMegaBytes	Gets or sets the target memory in mega-bytes.	int
targetNetworkId	Gets or sets the target network Id within AzStackHCI Cluster.	string
targetResourceGroupId	Gets or sets the target resource group ARM Id.	string Constraints: Min length = 1 (required)
targetVmName	Gets or sets the target VM display name.	string
testNetworkId	Gets or sets the target test network Id within AzStackHCI Cluster.	string

ProtectedItemDynamicMemoryConfig

Name	Description	Value
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

Name	Description	Value
instanceType	Set to 'HyperVToAzStackHCI' for type HyperVToAzStackHCIProtectedItemModelCustomProperties. Set to 'VMwareToAzStackHCI' for type VMwareToAzStackHCIProtectedItemModelCustomProperties.	'HyperVToAzStackHCI' 'VMwareToAzStackHCI' (required)

ProtectedItemModelProperties

Name	Description	Value
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

Name	Description	Value
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)
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.	string

VMwareToAzStackHCINicInput

Name	Description	Value
label	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.	string Constraints: Min length = 1 (required)
testNetworkId	Gets or sets the target test network Id within AzStackHCI Cluster.	string Constraints: Min length = 1 (required)

VMwareToAzStackHCIProtectedItemModelCustomProperties

Name	Description	Value
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 Constraints: Min length = 1 (required)
hyperVGeneration	Gets or sets the hypervisor generation of the virtual machine possible values are 1,2.	string Constraints: Min length = 1 (required)
instanceType	Gets or sets the instance type.	'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)
sourceDraName	Gets or sets the source DRA name.	string Constraints: Min length = 1 (required)
storageContainerId	Gets or sets the target storage container ARM Id.	string Constraints: Min length = 1 (required)
targetArcClusterCustomLocationId	Gets or sets the Target Arc Cluster Custom Location ARM Id.	string Constraints: Min length = 1 (required)
targetCpuCores	Gets or sets the target CPU cores.	int
targetDraName	Gets or sets the target DRA name.	string Constraints: Min length = 1 (required)
targetHciClusterId	Gets or sets the Target HCI Cluster ARM Id.	string Constraints: Min length = 1 (required)
targetMemoryInMegaBytes	Gets or sets the target memory in mega-bytes.	int
targetNetworkId	Gets or sets the target network Id within AzStackHCI Cluster.	string
targetResourceGroupId	Gets or sets the target resource group ARM Id.	string Constraints: Min length = 1 (required)
targetVmName	Gets or sets the target VM display name.	string
testNetworkId	Gets or sets the target test network Id within AzStackHCI Cluster.	string

Usage Examples

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@2021-02-16-preview"
  name = "string"
  parent_id = "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 = [
    {
      diskFileFormat = "string"
      diskId = "string"
      diskSizeGB = int
      isDynamic = bool
      isOsDisk = bool
      storageContainerId = "string"
    }
  ]
  dynamicMemoryConfig = {
    maximumMemoryInMegaBytes = int
    minimumMemoryInMegaBytes = int
    targetMemoryBufferPercentage = int
  }
  fabricDiscoveryMachineId = "string"
  hyperVGeneration = "string"
  instanceType = "HyperVToAzStackHCI"
  isDynamicRam = bool
  nicsToInclude = [
    {
      nicId = "string"
      selectionTypeForFailover = "string"
      targetNetworkId = "string"
      testNetworkId = "string"
    }
  ]
  runAsAccountId = "string"
  sourceDraName = "string"
  storageContainerId = "string"
  targetArcClusterCustomLocationId = "string"
  targetCpuCores = int
  targetDraName = "string"
  targetHciClusterId = "string"
  targetMemoryInMegaBytes = int
  targetNetworkId = "string"
  targetResourceGroupId = "string"
  targetVmName = "string"
  testNetworkId = "string"
}

For VMwareToAzStackHCI, use:

{
  customLocationRegion = "string"
  disksToInclude = [
    {
      diskFileFormat = "string"
      diskId = "string"
      diskSizeGB = int
      isDynamic = bool
      isOsDisk = bool
      storageContainerId = "string"
    }
  ]
  dynamicMemoryConfig = {
    maximumMemoryInMegaBytes = int
    minimumMemoryInMegaBytes = int
    targetMemoryBufferPercentage = int
  }
  fabricDiscoveryMachineId = "string"
  hyperVGeneration = "string"
  instanceType = "VMwareToAzStackHCI"
  isDynamicRam = bool
  nicsToInclude = [
    {
      label = "string"
      nicId = "string"
      selectionTypeForFailover = "string"
      targetNetworkId = "string"
      testNetworkId = "string"
    }
  ]
  performAutoResync = bool
  runAsAccountId = "string"
  sourceDraName = "string"
  storageContainerId = "string"
  targetArcClusterCustomLocationId = "string"
  targetCpuCores = int
  targetDraName = "string"
  targetHciClusterId = "string"
  targetMemoryInMegaBytes = int
  targetNetworkId = "string"
  targetResourceGroupId = "string"
  targetVmName = "string"
  testNetworkId = "string"
}

Property Values

Microsoft.DataReplication/replicationVaults/protectedItems

Name	Description	Value
name	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
properties	Protected item model properties.	ProtectedItemModelProperties (required)
type	The resource type	"Microsoft.DataReplication/replicationVaults/protectedItems@2021-02-16-preview"

HyperVToAzStackHCIDiskInput

Name	Description	Value
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)
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.	string

HyperVToAzStackHCINicInput

Name	Description	Value
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.	string Constraints: Min length = 1 (required)
testNetworkId	Gets or sets the target test network Id within AzStackHCI Cluster.	string Constraints: Min length = 1 (required)

HyperVToAzStackHCIProtectedItemModelCustomProperties

Name	Description	Value
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 Constraints: Min length = 1 (required)
hyperVGeneration	Gets or sets the hypervisor generation of the virtual machine.	string Constraints: Min length = 1 (required)
instanceType	Gets or sets the instance type.	'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)
sourceDraName	Gets or sets the source DRA name.	string Constraints: Min length = 1 (required)
storageContainerId	Gets or sets the target storage container ARM Id.	string Constraints: Min length = 1 (required)
targetArcClusterCustomLocationId	Gets or sets the Target Arc Cluster Custom Location ARM Id.	string Constraints: Min length = 1 (required)
targetCpuCores	Gets or sets the target CPU cores.	int
targetDraName	Gets or sets the target DRA name.	string Constraints: Min length = 1 (required)
targetHciClusterId	Gets or sets the Target HCI Cluster ARM Id.	string Constraints: Min length = 1 (required)
targetMemoryInMegaBytes	Gets or sets the target memory in mega-bytes.	int
targetNetworkId	Gets or sets the target network Id within AzStackHCI Cluster.	string
targetResourceGroupId	Gets or sets the target resource group ARM Id.	string Constraints: Min length = 1 (required)
targetVmName	Gets or sets the target VM display name.	string
testNetworkId	Gets or sets the target test network Id within AzStackHCI Cluster.	string

ProtectedItemDynamicMemoryConfig

Name	Description	Value
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

Name	Description	Value
instanceType	Set to 'HyperVToAzStackHCI' for type HyperVToAzStackHCIProtectedItemModelCustomProperties. Set to 'VMwareToAzStackHCI' for type VMwareToAzStackHCIProtectedItemModelCustomProperties.	'HyperVToAzStackHCI' 'VMwareToAzStackHCI' (required)

ProtectedItemModelProperties

Name	Description	Value
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

Name	Description	Value
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)
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.	string

VMwareToAzStackHCINicInput

Name	Description	Value
label	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.	string Constraints: Min length = 1 (required)
testNetworkId	Gets or sets the target test network Id within AzStackHCI Cluster.	string Constraints: Min length = 1 (required)

VMwareToAzStackHCIProtectedItemModelCustomProperties

Name	Description	Value
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 Constraints: Min length = 1 (required)
hyperVGeneration	Gets or sets the hypervisor generation of the virtual machine possible values are 1,2.	string Constraints: Min length = 1 (required)
instanceType	Gets or sets the instance type.	'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)
sourceDraName	Gets or sets the source DRA name.	string Constraints: Min length = 1 (required)
storageContainerId	Gets or sets the target storage container ARM Id.	string Constraints: Min length = 1 (required)
targetArcClusterCustomLocationId	Gets or sets the Target Arc Cluster Custom Location ARM Id.	string Constraints: Min length = 1 (required)
targetCpuCores	Gets or sets the target CPU cores.	int
targetDraName	Gets or sets the target DRA name.	string Constraints: Min length = 1 (required)
targetHciClusterId	Gets or sets the Target HCI Cluster ARM Id.	string Constraints: Min length = 1 (required)
targetMemoryInMegaBytes	Gets or sets the target memory in mega-bytes.	int
targetNetworkId	Gets or sets the target network Id within AzStackHCI Cluster.	string
targetResourceGroupId	Gets or sets the target resource group ARM Id.	string Constraints: Min length = 1 (required)
targetVmName	Gets or sets the target VM display name.	string
testNetworkId	Gets or sets the target test network Id within AzStackHCI Cluster.	string

Share via

Microsoft.DataReplication replicationVaults/protectedItems 2021-02-16-preview

Bicep resource definition

Resource format

ProtectedItemModelCustomProperties objects

Property Values

Microsoft.DataReplication/replicationVaults/protectedItems

HyperVToAzStackHCIDiskInput

HyperVToAzStackHCINicInput

HyperVToAzStackHCIProtectedItemModelCustomProperties

ProtectedItemDynamicMemoryConfig

ProtectedItemModelCustomProperties

ProtectedItemModelProperties

VMwareToAzStackHCIDiskInput

VMwareToAzStackHCINicInput

VMwareToAzStackHCIProtectedItemModelCustomProperties

ARM template resource definition

Resource format

ProtectedItemModelCustomProperties objects

Property Values

Microsoft.DataReplication/replicationVaults/protectedItems

HyperVToAzStackHCIDiskInput

HyperVToAzStackHCINicInput

HyperVToAzStackHCIProtectedItemModelCustomProperties

ProtectedItemDynamicMemoryConfig

ProtectedItemModelCustomProperties

ProtectedItemModelProperties

VMwareToAzStackHCIDiskInput

VMwareToAzStackHCINicInput

VMwareToAzStackHCIProtectedItemModelCustomProperties

Usage Examples

Terraform (AzAPI provider) resource definition

Resource format

ProtectedItemModelCustomProperties objects

Property Values

Microsoft.DataReplication/replicationVaults/protectedItems

HyperVToAzStackHCIDiskInput

HyperVToAzStackHCINicInput

HyperVToAzStackHCIProtectedItemModelCustomProperties

ProtectedItemDynamicMemoryConfig

ProtectedItemModelCustomProperties

ProtectedItemModelProperties

VMwareToAzStackHCIDiskInput

VMwareToAzStackHCINicInput

VMwareToAzStackHCIProtectedItemModelCustomProperties

Feedback

Additional resources