Replication Protected Items - Create

Service:: Recovery Services - Site Recovery

API Version:: 2018-07-10

Enables protection.
The operation to create an ASR replication protected item (Enable replication).

PUT https://management.azure.com/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}?api-version=2018-07-10

URI Parameters

Name	In	Required	Type	Description
fabricName	path	True	string	Name of the fabric.
protectionContainerName	path	True	string	Protection container name.
replicatedProtectedItemName	path	True	string	A name for the replication protected item.
resourceGroupName	path	True	string	The name of the resource group where the recovery services vault is present.
resourceName	path	True	string	The name of the recovery services vault.
subscriptionId	path	True	string	The subscription Id.
api-version	query	True	string	Client Api Version.

Request Body

Name	Type	Description
properties	EnableProtectionInputProperties	Enable protection input properties.

Responses

Name	Type	Description
200 OK	ReplicationProtectedItem	OK
202 Accepted		Accepted

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account.

Examples

Enables protection.

Sample Request

PUT https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b?api-version=2018-07-10

Request Body

{
  "properties": {
    "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1",
    "protectableItemId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectableItems/f8491e4f-817a-40dd-a90c-af773978c75b",
    "providerSpecificDetails": {
      "instanceType": "HyperVReplicaAzure"
    }
  }
}

Sample Response

Status code:: 200

{
  "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b",
  "name": "f8491e4f-817a-40dd-a90c-af773978c75b",
  "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems",
  "properties": {
    "friendlyName": "vm1",
    "protectedItemType": "HyperVVirtualMachine",
    "protectableItemId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectableItems/f8491e4f-817a-40dd-a90c-af773978c75b",
    "recoveryServicesProviderId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/241641e6-ee7b-4ee4-8141-821fadda43fa",
    "primaryFabricFriendlyName": "cloud1",
    "recoveryFabricFriendlyName": "Microsoft Azure",
    "recoveryFabricId": "Microsoft Azure",
    "primaryProtectionContainerFriendlyName": "cloud1",
    "recoveryProtectionContainerFriendlyName": "Microsoft Azure",
    "protectionState": "Protected",
    "protectionStateDescription": "Protected",
    "activeLocation": "Primary",
    "testFailoverState": "None",
    "testFailoverStateDescription": "None",
    "allowedOperations": [
      "PlannedFailover",
      "UnplannedFailover",
      "DisableProtection",
      "TestFailover"
    ],
    "replicationHealth": "Normal",
    "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1",
    "policyFriendlyName": "protectionprofile1",
    "currentScenario": {
      "scenarioName": "None",
      "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/None",
      "startTime": "1753-01-01T01:01:01Z"
    },
    "providerSpecificDetails": {
      "instanceType": "HyperVReplicaAzure"
    },
    "recoveryContainerId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5/replicationProtectionContainers/d38048d4-b460-4791-8ece-108395ee8478"
  }
}

Status code:: 202

Definitions

A2AEnableProtectionInput	A2A enable protection input.
A2AProtectedDiskDetails	A2A protected disk details.
A2AProtectedManagedDiskDetails	A2A protected managed disk details.
A2AReplicationDetails	A2A provider specific settings.
A2AUnprotectedDiskDetails	A2A unprotected disk details.
A2AVmDiskInputDetails	Azure VM disk input details.
A2AVmManagedDiskInputDetails	Azure VM managed disk input details.
AzureToAzureVmSyncedConfigDetails	Azure to Azure VM synced configuration details.
AzureVmDiskDetails	Disk details for E2A provider.
CurrentScenarioDetails	Current scenario details of the protected entity.
DiskAccountType	The DiskType.
DiskDetails	On-prem disk details data.
DiskEncryptionInfo	Recovery disk encryption info (BEK and KEK).
DiskEncryptionKeyInfo	Disk Encryption Key Information (BitLocker Encryption Key (BEK) on Windows).
EnableProtectionInput	Enable protection input.
EnableProtectionInputProperties	Enable protection input properties.
EthernetAddressType	The source IP address type.
HealthError	Health Error
HealthErrorCustomerResolvability	Value indicating whether the health error is customer resolvable.
HyperVReplicaAzureEnableProtectionInput	Azure specific enable protection input.
HyperVReplicaAzureReplicationDetails	Hyper V Replica Azure provider specific settings.
HyperVReplicaBaseReplicationDetails	Hyper V replica provider specific settings base class.
HyperVReplicaBlueReplicationDetails	HyperV replica 2012 R2 (Blue) replication details.
HyperVReplicaReplicationDetails	HyperV replica 2012 replication details.
InitialReplicationDetails	Initial replication details.
InMageAgentDetails	The details of the InMage agent.
InMageAzureV2DiskInputDetails	Disk input details.
InMageAzureV2EnableProtectionInput	VMware Azure specific enable protection input.
InMageAzureV2ManagedDiskDetails	InMageAzureV2 Managed disk details.
InMageAzureV2ProtectedDiskDetails	InMageAzureV2 protected disk details.
InMageAzureV2ReplicationDetails	InMageAzureV2 provider specific settings
InMageDiskExclusionInput	DiskExclusionInput when doing enable protection of virtual machine in InMage provider.
InMageDiskSignatureExclusionOptions	Guest disk signature based disk exclusion option when doing enable protection of virtual machine in InMage provider.
InMageEnableProtectionInput	VMware Azure specific enable protection input.
InMageProtectedDiskDetails	InMage protected disk details.
InMageRcmAgentUpgradeBlockingErrorDetails	InMageRcm source agent upgrade blocking error details.
InMageRcmDiskInput	InMageRcm disk input.
InMageRcmDisksDefaultInput	InMageRcm disk input.
InMageRcmEnableProtectionInput	InMageRcm specific enable protection input.
InMageRcmLastAgentUpgradeErrorDetails	InMageRcm last source agent upgrade error details.
InMageRcmMobilityAgentDetails	InMageRcm mobility agent details.
InMageRcmNicDetails	InMageRcm NIC details.
InMageRcmProtectedDiskDetails	InMageRcm protected disk details.
InMageRcmReplicationDetails	InMageRcm provider specific details.
InMageReplicationDetails	InMage provider specific settings
InMageVolumeExclusionOptions	Guest disk signature based disk exclusion option when doing enable protection of virtual machine in InMage provider.
InnerHealthError	Implements InnerHealthError class. HealthError object has a list of InnerHealthErrors as child errors. InnerHealthError is used because this will prevent an infinite loop of structures when Hydra tries to auto-generate the contract. We are exposing the related health errors as inner health errors and all API consumers can utilize this in the same fashion as Exception -> InnerException.
InputEndpoint	Azure VM input endpoint details.
IPConfig	IP configuration details.
KeyEncryptionKeyInfo	Key Encryption Key (KEK) information.
LicenseType	The license type.
MobilityAgentUpgradeState	The agent auto upgrade state.
MultiVmGroupCreateOption	Whether Multi VM group is auto created or specified by user.
OSDetails	Disk Details.
OSDiskDetails	Details of the OS Disk.
ReplicationProtectedItem	Replication protected item.
ReplicationProtectedItemProperties	Replication protected item custom data details.
ResyncState	The resync state.
SanEnableProtectionInput	San enable protection provider specific input.
VmEncryptionType	The encryption type of the VM.
VMNicDetails	Hyper V VM network details.

A2AEnableProtectionInput

A2A enable protection input.

Name	Type	Description
diskEncryptionInfo	DiskEncryptionInfo	The recovery disk encryption information.
fabricObjectId	string	The fabric specific object Id of the virtual machine.
instanceType	string: A2A	The class type.
multiVmGroupName	string	The multi vm group name.
recoveryAvailabilitySetId	string	The recovery availability set Id.
recoveryAvailabilityZone	string	The recovery availability zone.
recoveryAzureNetworkId	string	The recovery Azure virtual network ARM id.
recoveryBootDiagStorageAccountId	string	The boot diagnostic storage account.
recoveryCloudServiceId	string	The recovery cloud service Id. Valid for V1 scenarios.
recoveryContainerId	string	The recovery container Id.
recoveryProximityPlacementGroupId	string	The recovery proximity placement group Id.
recoveryResourceGroupId	string	The recovery resource group Id. Valid for V2 scenarios.
recoverySubnetName	string	The recovery subnet name.
vmDisks	A2AVmDiskInputDetails[]	The list of vm disk details.
vmManagedDisks	A2AVmManagedDiskInputDetails[]	The list of vm managed disk details.

A2AProtectedDiskDetails

A2A protected disk details.

Name	Type	Description
allowedDiskLevelOperation	string[]	The disk level operations list.
dataPendingAtSourceAgentInMB	number	The data pending at source virtual machine in MB.
dataPendingInStagingStorageAccountInMB	number	The data pending for replication in MB at staging account.
dekKeyVaultArmId	string	The KeyVault resource id for secret (BEK).
diskCapacityInBytes	integer	The disk capacity in bytes.
diskName	string	The disk name.
diskState	string	The disk state.
diskType	string	The type of disk.
diskUri	string	The disk uri.
isDiskEncrypted	boolean	A value indicating whether vm has encrypted os disk or not.
isDiskKeyEncrypted	boolean	A value indicating whether disk key got encrypted or not.
kekKeyVaultArmId	string	The KeyVault resource id for key (KEK).
keyIdentifier	string	The key URL / identifier (KEK).
monitoringJobType	string	The type of the monitoring job. The progress is contained in MonitoringPercentageCompletion property.
monitoringPercentageCompletion	integer	The percentage of the monitoring job. The type of the monitoring job is defined by MonitoringJobType property.
primaryDiskAzureStorageAccountId	string	The primary disk storage account.
primaryStagingAzureStorageAccountId	string	The primary staging storage account.
recoveryAzureStorageAccountId	string	The recovery disk storage account.
recoveryDiskUri	string	Recovery disk uri.
resyncRequired	boolean	A value indicating whether resync is required for this disk.
secretIdentifier	string	The secret URL / identifier (BEK).

A2AProtectedManagedDiskDetails

A2A protected managed disk details.

Name	Type	Description
allowedDiskLevelOperation	string[]	The disk level operations list.
dataPendingAtSourceAgentInMB	number	The data pending at source virtual machine in MB.
dataPendingInStagingStorageAccountInMB	number	The data pending for replication in MB at staging account.
dekKeyVaultArmId	string	The KeyVault resource id for secret (BEK).
diskCapacityInBytes	integer	The disk capacity in bytes.
diskId	string	The managed disk Arm id.
diskName	string	The disk name.
diskState	string	The disk state.
diskType	string	The type of disk.
failoverDiskName	string	The failover name for the managed disk.
isDiskEncrypted	boolean	A value indicating whether vm has encrypted os disk or not.
isDiskKeyEncrypted	boolean	A value indicating whether disk key got encrypted or not.
kekKeyVaultArmId	string	The KeyVault resource id for key (KEK).
keyIdentifier	string	The key URL / identifier (KEK).
monitoringJobType	string	The type of the monitoring job. The progress is contained in MonitoringPercentageCompletion property.
monitoringPercentageCompletion	integer	The percentage of the monitoring job. The type of the monitoring job is defined by MonitoringJobType property.
primaryStagingAzureStorageAccountId	string	The primary staging storage account.
recoveryDiskEncryptionSetId	string	The recovery disk encryption set Id.
recoveryReplicaDiskAccountType	string	The replica disk type. Its an optional value and will be same as source disk type if not user provided.
recoveryReplicaDiskId	string	Recovery replica disk Arm Id.
recoveryResourceGroupId	string	The recovery disk resource group Arm Id.
recoveryTargetDiskAccountType	string	The target disk type after failover. Its an optional value and will be same as source disk type if not user provided.
recoveryTargetDiskId	string	Recovery target disk Arm Id.
resyncRequired	boolean	A value indicating whether resync is required for this disk.
secretIdentifier	string	The secret URL / identifier (BEK).
tfoDiskName	string	The test failover name for the managed disk.

A2AReplicationDetails

A2A provider specific settings.

Name	Type	Description
agentVersion	string	The agent version.
fabricObjectId	string	The fabric specific object Id of the virtual machine.
initialPrimaryFabricLocation	string	The initial primary fabric location.
initialPrimaryZone	string	The initial primary availability zone.
initialRecoveryFabricLocation	string	The initial recovery fabric location.
initialRecoveryZone	string	The initial recovery availability zone.
instanceType	string: A2A	Gets the Instance type.
isReplicationAgentUpdateRequired	boolean	A value indicating whether replication agent update is required.
lastHeartbeat	string	The last heartbeat received from the source server.
lastRpoCalculatedTime	string	The time (in UTC) when the last RPO value was calculated by Protection Service.
lifecycleId	string	An id associated with the PE that survives actions like switch protection which change the backing PE/CPE objects internally.The lifecycle id gets carried forward to have a link/continuity in being able to have an Id that denotes the "same" protected item even though other internal Ids/ARM Id might be changing.
managementId	string	The management Id.
monitoringJobType	string	The type of the monitoring job. The progress is contained in MonitoringPercentageCompletion property.
monitoringPercentageCompletion	integer	The percentage of the monitoring job. The type of the monitoring job is defined by MonitoringJobType property.
multiVmGroupCreateOption	MultiVmGroupCreateOption	Whether Multi VM group is auto created or specified by user.
multiVmGroupId	string	The multi vm group Id.
multiVmGroupName	string	The multi vm group name.
osType	string	The type of operating system.
primaryFabricLocation	string	Primary fabric location.
protectedDisks	A2AProtectedDiskDetails[]	The list of protected disks.
protectedManagedDisks	A2AProtectedManagedDiskDetails[]	The list of protected managed disks.
recoveryAvailabilitySet	string	The recovery availability set.
recoveryAvailabilityZone	string	The recovery availability zone.
recoveryAzureResourceGroupId	string	The recovery resource group.
recoveryAzureVMName	string	The name of recovery virtual machine.
recoveryAzureVMSize	string	The size of recovery virtual machine.
recoveryBootDiagStorageAccountId	string	The recovery boot diagnostic storage account Arm Id.
recoveryCloudService	string	The recovery cloud service.
recoveryFabricLocation	string	The recovery fabric location.
recoveryFabricObjectId	string	The recovery fabric object Id.
recoveryProximityPlacementGroupId	string	The recovery proximity placement group Id.
rpoInSeconds	integer	The last RPO value in seconds.
selectedRecoveryAzureNetworkId	string	The recovery virtual network.
selectedTfoAzureNetworkId	string	The test failover virtual network.
testFailoverRecoveryFabricObjectId	string	The test failover fabric object Id.
tfoAzureVMName	string	The test failover VM name.
unprotectedDisks	A2AUnprotectedDiskDetails[]	The list of unprotected disks.
vmEncryptionType	VmEncryptionType	The encryption type of the VM.
vmNics	VMNicDetails[]	The virtual machine nic details.
vmProtectionState	string	The protection state for the vm.
vmProtectionStateDescription	string	The protection state description for the vm.
vmSyncedConfigDetails	AzureToAzureVmSyncedConfigDetails	The synced configuration details.

A2AUnprotectedDiskDetails

A2A unprotected disk details.

Name	Type	Description
diskLunId	integer	The source lun Id for the data disk.

A2AVmDiskInputDetails

Azure VM disk input details.

Name	Type	Description
diskUri	string	The disk Uri.
primaryStagingAzureStorageAccountId	string	The primary staging storage account Id.
recoveryAzureStorageAccountId	string	The recovery VHD storage account Id.

A2AVmManagedDiskInputDetails

Azure VM managed disk input details.

Name	Type	Description
diskEncryptionInfo	DiskEncryptionInfo	The recovery disk encryption information (for one / single pass flows).
diskId	string	The disk Id.
primaryStagingAzureStorageAccountId	string	The primary staging storage account Arm Id.
recoveryDiskEncryptionSetId	string	The recovery disk encryption set Id.
recoveryReplicaDiskAccountType	string	The replica disk type. Its an optional value and will be same as source disk type if not user provided.
recoveryResourceGroupId	string	The target resource group Arm Id.
recoveryTargetDiskAccountType	string	The target disk type after failover. Its an optional value and will be same as source disk type if not user provided.

AzureToAzureVmSyncedConfigDetails

Azure to Azure VM synced configuration details.

Name	Type	Description
inputEndpoints	InputEndpoint[]	The Azure VM input endpoints.
tags	object	The Azure VM tags.

AzureVmDiskDetails

Disk details for E2A provider.

Name	Type	Description
diskEncryptionSetId	string	The DiskEncryptionSet ARM ID.
diskId	string	The disk resource id.
lunId	string	Ordinal\LunId of the disk for the Azure VM.
maxSizeMB	string	Max side in MB.
targetDiskLocation	string	Blob uri of the Azure disk.
targetDiskName	string	The target Azure disk name.
vhdId	string	The VHD id.
vhdName	string	VHD name.
vhdType	string	VHD type.

CurrentScenarioDetails

Current scenario details of the protected entity.

Name	Type	Description
jobId	string	ARM Id of the job being executed.
scenarioName	string	Scenario name.
startTime	string	Start time of the workflow.

DiskAccountType

The DiskType.

Name	Type	Description
Premium_LRS	string
StandardSSD_LRS	string
Standard_LRS	string

DiskDetails

On-prem disk details data.

Name	Type	Description
maxSizeMB	integer	The hard disk max size in MB.
vhdId	string	The VHD Id.
vhdName	string	The VHD name.
vhdType	string	The type of the volume.

DiskEncryptionInfo

Recovery disk encryption info (BEK and KEK).

Name	Type	Description
diskEncryptionKeyInfo	DiskEncryptionKeyInfo	The recovery KeyVault reference for secret.
keyEncryptionKeyInfo	KeyEncryptionKeyInfo	The recovery KeyVault reference for key.

DiskEncryptionKeyInfo

Disk Encryption Key Information (BitLocker Encryption Key (BEK) on Windows).

Name	Type	Description
keyVaultResourceArmId	string	The KeyVault resource ARM Id for secret.
secretIdentifier	string	The secret URL / identifier.

EnableProtectionInput

Enable protection input.

Name	Type	Description
properties	EnableProtectionInputProperties	Enable protection input properties.

EnableProtectionInputProperties

Enable protection input properties.

Name	Type	Description
policyId	string	The Policy Id.
protectableItemId	string	The protectable item Id.
providerSpecificDetails	EnableProtectionProviderSpecificInput: A2AEnableProtectionInput HyperVReplicaAzureEnableProtectionInput InMageAzureV2EnableProtectionInput InMageEnableProtectionInput InMageRcmEnableProtectionInput SanEnableProtectionInput	The ReplicationProviderInput. For HyperVReplicaAzure provider, it will be AzureEnableProtectionInput object. For San provider, it will be SanEnableProtectionInput object. For HyperVReplicaAzure provider, it can be null.

EthernetAddressType

The source IP address type.

Name	Type	Description
Dynamic	string
Static	string

HealthError

Health Error

Name	Type	Description
creationTimeUtc	string	Error creation time (UTC)
customerResolvability	HealthErrorCustomerResolvability	Value indicating whether the health error is customer resolvable.
entityId	string	ID of the entity.
errorCategory	string	Category of error.
errorCode	string	Error code.
errorId	string	The health error unique id.
errorLevel	string	Level of error.
errorMessage	string	Error message.
errorSource	string	Source of error.
errorType	string	Type of error.
innerHealthErrors	InnerHealthError[]	The inner health errors. HealthError having a list of HealthError as child errors is problematic. InnerHealthError is used because this will prevent an infinite loop of structures when Hydra tries to auto-generate the contract. We are exposing the related health errors as inner health errors and all API consumers can utilize this in the same fashion as Exception -> InnerException.
possibleCauses	string	Possible causes of error.
recommendedAction	string	Recommended action to resolve error.
recoveryProviderErrorMessage	string	DRA error message.
summaryMessage	string	Summary message of the entity.

HealthErrorCustomerResolvability

Value indicating whether the health error is customer resolvable.

Name	Type	Description
Allowed	string
NotAllowed	string

HyperVReplicaAzureEnableProtectionInput

Azure specific enable protection input.

Name	Type	Description
disksToInclude	string[]	The list of VHD IDs of disks to be protected.
enableRdpOnTargetOption	string	The selected option to enable RDP\SSH on target vm after failover. String value of {SrsDataContract.EnableRDPOnTargetOption} enum.
hvHostVmId	string	The Hyper-V host Vm Id.
instanceType	string: HyperVReplicaAzure	The class type.
logStorageAccountId	string	The storage account to be used for logging during replication.
osType	string	The OS type associated with vm.
targetAvailabilitySetId	string	The availability set ARM Id.
targetAvailabilityZone	string	The target availability zone.
targetAzureNetworkId	string	The selected target Azure network Id.
targetAzureSubnetId	string	The selected target Azure subnet Id.
targetAzureV1ResourceGroupId	string	The Id of the target resource group (for classic deployment) in which the failover VM is to be created.
targetAzureV2ResourceGroupId	string	The Id of the target resource group (for resource manager deployment) in which the failover VM is to be created.
targetAzureVmName	string	The target azure Vm Name.
targetProximityPlacementGroupId	string	The proximity placement group ARM Id.
targetStorageAccountId	string	The storage account name.
useManagedDisks	string	A value indicating whether managed disks should be used during failover.
vhdId	string	The OS disk VHD id associated with vm.
vmName	string	The Vm Name.

HyperVReplicaAzureReplicationDetails

Hyper V Replica Azure provider specific settings.

Name	Type	Description
azureVmDiskDetails	AzureVmDiskDetails[]	Azure VM Disk details.
enableRdpOnTargetOption	string	The selected option to enable RDP\SSH on target vm after failover. String value of {SrsDataContract.EnableRDPOnTargetOption} enum.
encryption	string	The encryption info.
initialReplicationDetails	InitialReplicationDetails	Initial replication details.
instanceType	string: HyperVReplicaAzure	Gets the Instance type.
lastReplicatedTime	string	The Last replication time.
lastRpoCalculatedTime	string	The last RPO calculated time.
licenseType	string	License Type of the VM to be used.
oSDetails	OSDetails	The operating system info.
recoveryAvailabilitySetId	string	The recovery availability set Id.
recoveryAzureLogStorageAccountId	string	The ARM id of the log storage account used for replication. This will be set to null if no log storage account was provided during enable protection.
recoveryAzureResourceGroupId	string	The target resource group Id.
recoveryAzureStorageAccount	string	The recovery Azure storage account.
recoveryAzureVMSize	string	The Recovery Azure VM size.
recoveryAzureVmName	string	Recovery Azure given name.
rpoInSeconds	integer	Last RPO value.
selectedRecoveryAzureNetworkId	string	The selected recovery azure network Id.
selectedSourceNicId	string	The selected source nic Id which will be used as the primary nic during failover.
sourceVmCpuCount	integer	The CPU count of the VM on the primary side.
sourceVmRamSizeInMB	integer	The RAM size of the VM on the primary side.
targetAvailabilityZone	string	The target availability zone.
targetProximityPlacementGroupId	string	The target proximity placement group Id.
useManagedDisks	string	A value indicating whether managed disks should be used during failover.
vmId	string	The virtual machine Id.
vmNics	VMNicDetails[]	The PE Network details.
vmProtectionState	string	The protection state for the vm.
vmProtectionStateDescription	string	The protection state description for the vm.

HyperVReplicaBaseReplicationDetails

Hyper V replica provider specific settings base class.

Name	Type	Description
initialReplicationDetails	InitialReplicationDetails	Initial replication details.
instanceType	string: HyperVReplicaBaseReplicationDetails	Gets the Instance type.
lastReplicatedTime	string	The Last replication time.
vMDiskDetails	DiskDetails[]	VM disk details.
vmId	string	The virtual machine Id.
vmNics	VMNicDetails[]	The PE Network details.
vmProtectionState	string	The protection state for the vm.
vmProtectionStateDescription	string	The protection state description for the vm.

HyperVReplicaBlueReplicationDetails

HyperV replica 2012 R2 (Blue) replication details.

Name	Type	Description
initialReplicationDetails	InitialReplicationDetails	Initial replication details.
instanceType	string: HyperVReplica2012R2	Gets the Instance type.
lastReplicatedTime	string	The Last replication time.
vMDiskDetails	DiskDetails[]	VM disk details.
vmId	string	The virtual machine Id.
vmNics	VMNicDetails[]	The PE Network details.
vmProtectionState	string	The protection state for the vm.
vmProtectionStateDescription	string	The protection state description for the vm.

HyperVReplicaReplicationDetails

HyperV replica 2012 replication details.

Name	Type	Description
initialReplicationDetails	InitialReplicationDetails	Initial replication details.
instanceType	string: HyperVReplica2012	Gets the Instance type.
lastReplicatedTime	string	The Last replication time.
vMDiskDetails	DiskDetails[]	VM disk details.
vmId	string	The virtual machine Id.
vmNics	VMNicDetails[]	The PE Network details.
vmProtectionState	string	The protection state for the vm.
vmProtectionStateDescription	string	The protection state description for the vm.

InitialReplicationDetails

Initial replication details.

Name	Type	Description
initialReplicationProgressPercentage	string	The initial replication progress percentage.
initialReplicationType	string	Initial replication type.

InMageAgentDetails

The details of the InMage agent.

Name	Type	Description
agentExpiryDate	string	Agent expiry date.
agentUpdateStatus	string	A value indicating whether installed agent needs to be updated.
agentVersion	string	The agent version.
postUpdateRebootStatus	string	A value indicating whether reboot is required after update is applied.

InMageAzureV2DiskInputDetails

Disk input details.

Name	Type	Description
diskEncryptionSetId	string	The DiskEncryptionSet ARM ID.
diskId	string	The DiskId.
diskType	DiskAccountType	The DiskType.
logStorageAccountId	string	The LogStorageAccountId.

InMageAzureV2EnableProtectionInput

VMware Azure specific enable protection input.

Name	Type	Description
diskEncryptionSetId	string	The DiskEncryptionSet ARM ID.
diskType	DiskAccountType	The DiskType.
disksToInclude	InMageAzureV2DiskInputDetails[]	The disks to include list.
enableRdpOnTargetOption	string	The selected option to enable RDP\SSH on target vm after failover. String value of {SrsDataContract.EnableRDPOnTargetOption} enum.
instanceType	string: InMageAzureV2	The class type.
logStorageAccountId	string	The storage account to be used for logging during replication.
masterTargetId	string	The Master target Id.
multiVmGroupId	string	The multi vm group Id.
multiVmGroupName	string	The multi vm group name.
processServerId	string	The Process Server Id.
runAsAccountId	string	The CS account Id.
storageAccountId	string	The storage account name.
targetAvailabilitySetId	string	The availability set ARM Id.
targetAvailabilityZone	string	The target availability zone.
targetAzureNetworkId	string	The selected target Azure network Id.
targetAzureSubnetId	string	The selected target Azure subnet Id.
targetAzureV1ResourceGroupId	string	The Id of the target resource group (for classic deployment) in which the failover VM is to be created.
targetAzureV2ResourceGroupId	string	The Id of the target resource group (for resource manager deployment) in which the failover VM is to be created.
targetAzureVmName	string	The target azure Vm Name.
targetProximityPlacementGroupId	string	The proximity placement group ARM Id.

InMageAzureV2ManagedDiskDetails

InMageAzureV2 Managed disk details.

Name	Type	Description
diskId	string	The disk id.
replicaDiskType	string	The replica disk type.
seedManagedDiskId	string	Seed managed disk Id.

InMageAzureV2ProtectedDiskDetails

InMageAzureV2 protected disk details.

Name	Type	Description
diskCapacityInBytes	integer	The disk capacity in bytes.
diskId	string	The disk id.
diskName	string	The disk name.
diskResized	string	A value indicating whether disk is resized.
fileSystemCapacityInBytes	integer	The disk file system capacity in bytes.
healthErrorCode	string	The health error code for the disk.
lastRpoCalculatedTime	string	The last RPO calculated time.
protectionStage	string	The protection stage.
psDataInMegaBytes	number	The PS data transit in MB.
resyncDurationInSeconds	integer	The resync duration in seconds.
resyncProgressPercentage	integer	The resync progress percentage.
resyncRequired	string	A value indicating whether resync is required for this disk.
rpoInSeconds	integer	The RPO in seconds.
sourceDataInMegaBytes	number	The source data transit in MB.
targetDataInMegaBytes	number	The target data transit in MB.

InMageAzureV2ReplicationDetails

InMageAzureV2 provider specific settings

Name	Type	Description
agentExpiryDate	string	Agent expiry date.
agentVersion	string	The agent version.
azureVMDiskDetails	AzureVmDiskDetails[]	Azure VM Disk details.
compressedDataRateInMB	number	The compressed data change rate in MB.
datastores	string[]	The data stores of the on-premise machine. Value can be list of strings that contain data store names.
discoveryType	string	A value indicating the discovery type of the machine. Value can be vCenter or physical.
diskResized	string	A value indicating whether any disk is resized for this VM.
enableRdpOnTargetOption	string	The selected option to enable RDP\SSH on target vm after failover. String value of {SrsDataContract.EnableRDPOnTargetOption} enum.
infrastructureVmId	string	The infrastructure VM Id.
instanceType	string: InMageAzureV2	Gets the Instance type.
ipAddress	string	The source IP address.
isAgentUpdateRequired	string	A value indicating whether installed agent needs to be updated.
isRebootAfterUpdateRequired	string	A value indicating whether the source server requires a restart after update.
lastHeartbeat	string	The last heartbeat received from the source server.
lastRpoCalculatedTime	string	The last RPO calculated time.
lastUpdateReceivedTime	string	The last update time received from on-prem components.
licenseType	string	License Type of the VM to be used.
masterTargetId	string	The master target Id.
multiVmGroupId	string	The multi vm group Id.
multiVmGroupName	string	The multi vm group name.
multiVmSyncStatus	string	A value indicating whether multi vm sync is enabled or disabled.
osDiskId	string	The id of the disk containing the OS.
osType	string	The type of the OS on the VM.
osVersion	string	The OS Version of the protected item.
processServerId	string	The process server Id.
processServerName	string	The process server name.
protectedDisks	InMageAzureV2ProtectedDiskDetails[]	The list of protected disks.
protectedManagedDisks	InMageAzureV2ManagedDiskDetails[]	The list of protected managed disks.
protectionStage	string	The protection stage.
recoveryAvailabilitySetId	string	The recovery availability set Id.
recoveryAzureLogStorageAccountId	string	The ARM id of the log storage account used for replication. This will be set to null if no log storage account was provided during enable protection.
recoveryAzureResourceGroupId	string	The target resource group Id.
recoveryAzureStorageAccount	string	The recovery Azure storage account.
recoveryAzureVMName	string	Recovery Azure given name.
recoveryAzureVMSize	string	The Recovery Azure VM size.
replicaId	string	The replica id of the protected item.
resyncProgressPercentage	integer	The resync progress percentage.
rpoInSeconds	integer	The RPO in seconds.
selectedRecoveryAzureNetworkId	string	The selected recovery azure network Id.
selectedSourceNicId	string	The selected source nic Id which will be used as the primary nic during failover.
selectedTfoAzureNetworkId	string	The test failover virtual network.
sourceVmCpuCount	integer	The CPU count of the VM on the primary side.
sourceVmRamSizeInMB	integer	The RAM size of the VM on the primary side.
targetAvailabilityZone	string	The target availability zone.
targetProximityPlacementGroupId	string	The target proximity placement group Id.
targetVmId	string	The ARM Id of the target Azure VM. This value will be null until the VM is failed over. Only after failure it will be populated with the ARM Id of the Azure VM.
uncompressedDataRateInMB	number	The uncompressed data change rate in MB.
useManagedDisks	string	A value indicating whether managed disks should be used during failover.
vCenterInfrastructureId	string	The vCenter infrastructure Id.
validationErrors	HealthError[]	The validation errors of the on-premise machine Value can be list of validation errors.
vhdName	string	The OS disk VHD name.
vmId	string	The virtual machine Id.
vmNics	VMNicDetails[]	The PE Network details.
vmProtectionState	string	The protection state for the vm.
vmProtectionStateDescription	string	The protection state description for the vm.

InMageDiskExclusionInput

DiskExclusionInput when doing enable protection of virtual machine in InMage provider.

Name	Type	Description
diskSignatureOptions	InMageDiskSignatureExclusionOptions[]	The guest disk signature based option for disk exclusion.
volumeOptions	InMageVolumeExclusionOptions[]	The volume label based option for disk exclusion.

InMageDiskSignatureExclusionOptions

Guest disk signature based disk exclusion option when doing enable protection of virtual machine in InMage provider.

Name	Type	Description
diskSignature	string	The guest signature of disk to be excluded from replication.

InMageEnableProtectionInput

VMware Azure specific enable protection input.

Name	Type	Description
datastoreName	string	The target data store name.
diskExclusionInput	InMageDiskExclusionInput	The enable disk exclusion input.
disksToInclude	string[]	The disks to include list.
instanceType	string: InMage	The class type.
masterTargetId	string	The Master Target Id.
multiVmGroupId	string	The multi vm group Id.
multiVmGroupName	string	The multi vm group name.
processServerId	string	The Process Server Id.
retentionDrive	string	The retention drive to use on the MT.
runAsAccountId	string	The CS account Id.
vmFriendlyName	string	The Vm Name.

InMageProtectedDiskDetails

InMage protected disk details.

Name	Type	Description
diskCapacityInBytes	integer	The disk capacity in bytes.
diskId	string	The disk id.
diskName	string	The disk name.
diskResized	string	A value indicating whether disk is resized.
fileSystemCapacityInBytes	integer	The file system capacity in bytes.
healthErrorCode	string	The health error code for the disk.
lastRpoCalculatedTime	string	The last RPO calculated time.
protectionStage	string	The protection stage.
psDataInMB	number	The PS data transit in MB.
resyncDurationInSeconds	integer	The resync duration in seconds.
resyncProgressPercentage	integer	The resync progress percentage.
resyncRequired	string	A value indicating whether resync is required for this disk.
rpoInSeconds	integer	The RPO in seconds.
sourceDataInMB	number	The source data transit in MB.
targetDataInMB	number	The target data transit in MB.

InMageRcmAgentUpgradeBlockingErrorDetails

InMageRcm source agent upgrade blocking error details.

Name	Type	Description
errorCode	string	The error code.
errorMessage	string	The error message.
errorMessageParameters	object	The error message parameters.
errorTags	object	The error tags.
possibleCauses	string	The possible causes.
recommendedAction	string	The recommended action.

InMageRcmDiskInput

InMageRcm disk input.

Name	Type	Description
diskEncryptionSetId	string	The disk encryption set ARM Id.
diskId	string	The disk Id.
diskType	DiskAccountType	The disk type.
logStorageAccountId	string	The log storage account ARM Id.

InMageRcmDisksDefaultInput

InMageRcm disk input.

Name	Type	Description
diskEncryptionSetId	string	The disk encryption set ARM Id.
diskType	DiskAccountType	The disk type.
logStorageAccountId	string	The log storage account ARM Id.

InMageRcmEnableProtectionInput

InMageRcm specific enable protection input.

Name	Type	Description
disksDefault	InMageRcmDisksDefaultInput	The default disk input.
disksToInclude	InMageRcmDiskInput[]	The disks to include list.
fabricDiscoveryMachineId	string	The ARM Id of discovered machine.
instanceType	string: InMageRcm	The class type.
licenseType	LicenseType	The license type.
multiVmGroupName	string	The multi VM group name.
processServerId	string	The process server Id.
runAsAccountId	string	The run-as account Id.
targetAvailabilitySetId	string	The target availability set ARM Id.
targetAvailabilityZone	string	The target availability zone.
targetBootDiagnosticsStorageAccountId	string	The target boot diagnostics storage account ARM Id.
targetNetworkId	string	The selected target network ARM Id.
targetProximityPlacementGroupId	string	The target proximity placement group Id.
targetResourceGroupId	string	The target resource group ARM Id.
targetSubnetName	string	The selected target subnet name.
targetVmName	string	The target VM name.
targetVmSize	string	The target VM size.
testNetworkId	string	The selected test network ARM Id.
testSubnetName	string	The selected test subnet name.

InMageRcmLastAgentUpgradeErrorDetails

InMageRcm last source agent upgrade error details.

Name	Type	Description
errorCode	string	The error code.
errorMessage	string	The error message.
errorMessageParameters	object	The error message parameters.
errorTags	object	The error tags.
possibleCauses	string	The possible causes.
recommendedAction	string	The recommended action.

InMageRcmMobilityAgentDetails

InMageRcm mobility agent details.

Name	Type	Description
agentVersionExpiryDate	string	The agent version expiry date.
driverVersion	string	The driver version.
driverVersionExpiryDate	string	The driver version expiry date.
isUpgradeable	string	A value indicating whether agent is upgradeable or not.
lastHeartbeatUtc	string	The time of the last heartbeat received from the agent.
latestUpgradableVersionWithoutReboot	string	The latest upgradeable version available without reboot.
latestVersion	string	The latest agent version available.
reasonsBlockingUpgrade	string[]	The whether update is possible or not.
version	string	The agent version.

InMageRcmNicDetails

InMageRcm NIC details.

Name	Type	Description
isPrimaryNic	string	A value indicating whether this is the primary NIC.
isSelectedForFailover	string	A value indicating whether this NIC is selected for failover.
nicId	string	The NIC Id.
sourceIPAddress	string	The source IP address.
sourceIPAddressType	EthernetAddressType	The source IP address type.
sourceNetworkId	string	Source network Id.
sourceSubnetName	string	Source subnet name.
targetIPAddress	string	The target IP address.
targetIPAddressType	EthernetAddressType	The target IP address type.
targetSubnetName	string	Target subnet name.
testIPAddress	string	The test IP address.
testIPAddressType	EthernetAddressType	The test IP address type.
testSubnetName	string	Test subnet name.

InMageRcmProtectedDiskDetails

InMageRcm protected disk details.

Name	Type	Description
capacityInBytes	integer	The disk capacity in bytes.
diskEncryptionSetId	string	The disk encryption set ARM Id.
diskId	string	The disk Id.
diskName	string	The disk name.
diskType	DiskAccountType	The disk type.
isOSDisk	string	A value indicating whether the disk is the OS disk.
logStorageAccountId	string	The log storage account ARM Id.
seedManagedDiskId	string	The ARM Id of the seed managed disk.
targetManagedDiskId	string	The ARM Id of the target managed disk.

InMageRcmReplicationDetails

InMageRcm provider specific details.

Name	Type	Description
agentUpgradeBlockingErrorDetails	InMageRcmAgentUpgradeBlockingErrorDetails[]	The agent upgrade blocking error information.
agentUpgradeState	MobilityAgentUpgradeState	The agent auto upgrade state.
allocatedMemoryInMB	number	The allocated memory in MB.
discoveryType	string	The type of the discovered VM.
fabricDiscoveryMachineId	string	The ARM Id of the discovered VM.
failoverRecoveryPointId	string	The recovery point Id to which the VM was failed over.
firmwareType	string	The firmware type.
initialReplicationProcessedBytes	integer	The initial replication processed bytes. This includes sum of total bytes transferred and matched bytes on all selected disks in source VM.
initialReplicationProgressPercentage	integer	The initial replication progress percentage. This is calculated based on total bytes processed for all disks in the source VM.
initialReplicationTransferredBytes	integer	The initial replication transferred bytes from source VM to azure for all selected disks on source VM.
instanceType	string: InMageRcm	Gets the Instance type.
internalIdentifier	string	The virtual machine internal identifier.
isLastUpgradeSuccessful	string	A value indicating whether last agent upgrade was successful or not.
lastAgentUpgradeErrorDetails	InMageRcmLastAgentUpgradeErrorDetails[]	The last agent upgrade error information.
lastAgentUpgradeFailedJobId	string	The last agent upgrade failed or cancelled job Id.
lastAgentUpgradeType	string	The last agent upgrade type.
lastRecoveryPointId	string	The last recovery point Id.
lastRecoveryPointReceived	string	The last recovery point received time.
lastRpoCalculatedTime	string	The last recovery point objective calculated time.
lastRpoInSeconds	integer	The last recovery point objective value.
licenseType	string	License Type of the VM to be used.
mobilityAgentDetails	InMageRcmMobilityAgentDetails	The mobility agent information.
multiVmGroupName	string	The multi VM group name.
osType	string	The type of the OS on the VM.
processServerId	string	The process server Id.
processServerName	string	The process server name.
processorCoreCount	integer	The processor core count.
protectedDisks	InMageRcmProtectedDiskDetails[]	The list of protected disks.
resyncProcessedBytes	integer	The resync processed bytes. This includes sum of total bytes transferred and matched bytes on all selected disks in source VM.
resyncProgressPercentage	integer	The resync progress percentage. This is calculated based on total bytes processed for all disks in the source VM.
resyncRequired	string	A value indicating whether resync is required.
resyncState	ResyncState	The resync state.
resyncTransferredBytes	integer	The resync transferred bytes from source VM to azure for all selected disks on source VM.
runAsAccountId	string	The run-as account Id.
targetAvailabilitySetId	string	The target availability set Id.
targetAvailabilityZone	string	The target availability zone.
targetBootDiagnosticsStorageAccountId	string	The target boot diagnostics storage account ARM Id.
targetGeneration	string	The target generation.
targetNetworkId	string	The target network Id.
targetProximityPlacementGroupId	string	The target proximity placement group Id.
targetResourceGroupId	string	The target resource group Id.
targetVmName	string	Target VM name.
targetVmSize	string	The target VM size.
testNetworkId	string	The test network Id.
vmNics	InMageRcmNicDetails[]	The network details.

InMageReplicationDetails

InMage provider specific settings

Name	Type	Description
activeSiteType	string	The active location of the VM. If the VM is being protected from Azure, this field will take values from { Azure, OnPrem }. If the VM is being protected between two data-centers, this field will be OnPrem always.
agentDetails	InMageAgentDetails	The agent details.
azureStorageAccountId	string	A value indicating the underlying Azure storage account. If the VM is not running in Azure, this value shall be set to null.
compressedDataRateInMB	number	The compressed data change rate in MB.
consistencyPoints	object	The collection of Consistency points.
datastores	string[]	The data stores of the on-premise machine Value can be list of strings that contain data store names
discoveryType	string	A value indicating the discovery type of the machine.
diskResized	string	A value indicating whether any disk is resized for this VM.
infrastructureVmId	string	The infrastructure VM Id.
instanceType	string: InMage	Gets the Instance type.
ipAddress	string	The source IP address.
lastHeartbeat	string	The last heartbeat received from the source server.
lastRpoCalculatedTime	string	The last RPO calculated time.
lastUpdateReceivedTime	string	The last update time received from on-prem components.
masterTargetId	string	The master target Id.
multiVmGroupId	string	The multi vm group Id, if any.
multiVmGroupName	string	The multi vm group name, if any.
multiVmSyncStatus	string	A value indicating whether the multi vm sync is enabled or disabled.
osDetails	OSDiskDetails	The OS details.
osVersion	string	The OS Version of the protected item.
processServerId	string	The process server Id.
protectedDisks	InMageProtectedDiskDetails[]	The list of protected disks.
protectionStage	string	The protection stage.
rebootAfterUpdateStatus	string	A value indicating whether the source server requires a restart after update.
replicaId	string	The replica id of the protected item.
resyncDetails	InitialReplicationDetails	The resync details of the machine
retentionWindowEnd	string	The retention window end time.
retentionWindowStart	string	The retention window start time.
rpoInSeconds	integer	The RPO in seconds.
sourceVmCpuCount	integer	The CPU count of the VM on the primary side.
sourceVmRamSizeInMB	integer	The RAM size of the VM on the primary side.
uncompressedDataRateInMB	number	The uncompressed data change rate in MB.
vCenterInfrastructureId	string	The vCenter infrastructure Id.
validationErrors	HealthError[]	The validation errors of the on-premise machine Value can be list of validation errors
vmId	string	The virtual machine Id.
vmNics	VMNicDetails[]	The PE Network details.
vmProtectionState	string	The protection state for the vm.
vmProtectionStateDescription	string	The protection state description for the vm.

InMageVolumeExclusionOptions

Guest disk signature based disk exclusion option when doing enable protection of virtual machine in InMage provider.

Name	Type	Description
onlyExcludeIfSingleVolume	string	The value indicating whether to exclude multi volume disk or not. If a disk has multiple volumes and one of the volume has label matching with VolumeLabel this disk will be excluded from replication if OnlyExcludeIfSingleVolume is false.
volumeLabel	string	The volume label. The disk having any volume with this label will be excluded from replication.

InnerHealthError

Implements InnerHealthError class. HealthError object has a list of InnerHealthErrors as child errors. InnerHealthError is used because this will prevent an infinite loop of structures when Hydra tries to auto-generate the contract. We are exposing the related health errors as inner health errors and all API consumers can utilize this in the same fashion as Exception -> InnerException.

Name	Type	Description
creationTimeUtc	string	Error creation time (UTC)
entityId	string	ID of the entity.
errorCategory	string	Category of error.
errorCode	string	Error code.
errorLevel	string	Level of error.
errorMessage	string	Error message.
errorSource	string	Source of error.
errorType	string	Type of error.
possibleCauses	string	Possible causes of error.
recommendedAction	string	Recommended action to resolve error.
recoveryProviderErrorMessage	string	DRA error message.
summaryMessage	string	Summary message of the entity.

InputEndpoint

Azure VM input endpoint details.

Name	Type	Description
endpointName	string	The input endpoint name.
privatePort	integer	The input endpoint private port.
protocol	string	The input endpoint protocol.
publicPort	integer	The input endpoint public port.

IPConfig

IP configuration details.

Name	Type	Description
lBBackendAddressPoolIds	string[]	The backend address pools associated with the IP configuration.
publicIpAddressId	string	The Id of the public IP address associated with the IP configuration.
staticIPAddress	string	The static IP address of the IP configuration.

KeyEncryptionKeyInfo

Key Encryption Key (KEK) information.

Name	Type	Description
keyIdentifier	string	The key URL / identifier.
keyVaultResourceArmId	string	The KeyVault resource ARM Id for key.

LicenseType

The license type.

Name	Type	Description
NoLicenseType	string
NotSpecified	string
WindowsServer	string

MobilityAgentUpgradeState

The agent auto upgrade state.

Name	Type	Description
Commit	string
Completed	string
None	string
Started	string

MultiVmGroupCreateOption

Whether Multi VM group is auto created or specified by user.

Name	Type	Description
AutoCreated	string
UserSpecified	string

OSDetails

Disk Details.

Name	Type	Description
oSMajorVersion	string	The OS Major Version.
oSMinorVersion	string	The OS Minor Version.
oSVersion	string	The OS Version.
osEdition	string	The OSEdition.
osType	string	VM Disk details.
productType	string	Product type.

OSDiskDetails

Details of the OS Disk.

Name	Type	Description
osType	string	The type of the OS on the VM.
osVhdId	string	The id of the disk containing the OS.
vhdName	string	The OS disk VHD name.