Replication Protected Items - Update

Service:

Recovery Services - Site Recovery

API Version:

2023-02-01

Updates the replication protected item settings.
The operation to update the recovery settings of an ASR replication protected item.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}?api-version=2023-02-01

URI Parameters

Name	In	Required	Type	Description
fabricName	path	True	string	Fabric name.
protectionContainerName	path	True	string	Protection container name.
replicatedProtectedItemName	path	True	string	Replication protected item name.
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	UpdateReplicationProtectedItemInputProperties	Update replication protected item 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

Updates the replication protected Item settings.

Sample request

HTTP

PATCH 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=2023-02-01

{
  "properties": {
    "recoveryAzureVMName": "vm1",
    "recoveryAzureVMSize": "Basic_A0",
    "selectedRecoveryAzureNetworkId": "/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/siterecoveryProd1/providers/Microsoft.Network/virtualNetworks/vnetavrai",
    "vmNics": [
      {
        "nicId": "TWljcm9zb2Z0OkY4NDkxRTRGLTgxN0EtNDBERC1BOTBDLUFGNzczOTc4Qzc1Qlw3NjAwMzMxRS03NDk4LTQ0QTQtQjdDNy0xQjY1NkJDREQ1MkQ=",
        "selectionType": "SelectedByUser",
        "ipConfigs": [
          {
            "ipConfigName": "ipconfig1",
            "isPrimary": true,
            "recoverySubnetName": "subnet1",
            "recoveryStaticIPAddress": "10.0.2.46"
          }
        ]
      }
    ],
    "licenseType": "WindowsServer",
    "providerSpecificDetails": {
      "instanceType": "HyperVReplicaAzure"
    }
  }
}

Sample response

Status code:

200

Azure-AsyncOperation: https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-02-01

{
  "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

Azure-AsyncOperation: https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-02-01
Retry-After: 30

Definitions

Name	Description
A2ACrossClusterMigrationReplicationDetails	A2A provider specific settings.
A2AProtectedDiskDetails	A2A protected disk details.
A2AProtectedManagedDiskDetails	A2A protected managed disk details.
A2AReplicationDetails	A2A provider specific settings.
A2AUnprotectedDiskDetails	A2A unprotected disk details.
A2AUpdateReplicationProtectedItemInput	InMage Azure V2 input to update replication protected item.
A2AVmManagedDiskUpdateDetails	A2A Vm managed disk update details.
AgentUpgradeBlockedReason	The whether update is possible or not.
AutoProtectionOfDataDisk	A value indicating whether the auto protection is enabled.
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	Onprem disk details data.
DiskEncryptionInfo	Recovery disk encryption info (BEK and KEK).
DiskEncryptionKeyInfo	Disk Encryption Key Information (BitLocker Encryption Key (BEK) on Windows).
DiskReplicationProgressHealth	The progress health.
EthernetAddressType	The source IP address type.
ExtendedLocation	Extended location of the resource.
ExtendedLocationType	The extended location type.
HealthError	Health Error.
HealthErrorCustomerResolvability	Value indicating whether the health error is customer resolvable.
HyperVReplicaAzureManagedDiskDetails	Hyper-V Managed disk details.
HyperVReplicaAzureReplicationDetails	Hyper V Replica Azure provider specific settings.
HyperVReplicaAzureUpdateReplicationProtectedItemInput	HyperV replica Azure input to update replication protected item.
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.
InMageAzureV2ManagedDiskDetails	InMageAzureV2 Managed disk details.
InMageAzureV2ProtectedDiskDetails	InMageAzureV2 protected disk details.
InMageAzureV2ReplicationDetails	InMageAzureV2 provider specific settings.
InMageAzureV2SwitchProviderBlockingErrorDetails	InMageAzureV2 switch provider blocking error details.
InMageAzureV2SwitchProviderDetails	InMageAzureV2 switch provider details.
InMageAzureV2UpdateReplicationProtectedItemInput	InMage Azure V2 input to update replication protected item.
InMageProtectedDiskDetails	InMage protected disk details.
InMageRcmAgentUpgradeBlockingErrorDetails	InMageRcm source agent upgrade blocking error details.
InMageRcmDiscoveredProtectedVmDetails	InMageRcm discovered protected VM details.
InMageRcmFailbackDiscoveredProtectedVmDetails	InMageRcmFailback discovered VM details.
InMageRcmFailbackMobilityAgentDetails	InMageRcmFailback mobility agent details.
InMageRcmFailbackNicDetails	InMageRcmFailback NIC details.
InMageRcmFailbackProtectedDiskDetails	InMageRcmFailback protected disk details.
InMageRcmFailbackReplicationDetails	InMageRcmFailback provider specific details.
InMageRcmFailbackSyncDetails	InMageRcmFailback disk level sync details.
InMageRcmLastAgentUpgradeErrorDetails	InMageRcm last source agent upgrade error details.
InMageRcmMobilityAgentDetails	InMageRcm mobility agent details.
InMageRcmNicDetails	InMageRcm NIC details.
InMageRcmNicInput	InMageRcm NIC input.
InMageRcmProtectedDiskDetails	InMageRcm protected disk details.
InMageRcmReplicationDetails	InMageRcm provider specific details.
InMageRcmSyncDetails	InMageRcm disk level sync details.
InMageRcmUpdateReplicationProtectedItemInput	InMageRcm provider specific input to update replication protected item.
InMageReplicationDetails	InMage provider specific settings.
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
IPConfigDetails
IPConfigInputDetails
KeyEncryptionKeyInfo	Key Encryption Key (KEK) information.
LicenseType	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.
PlannedFailoverStatus	The last planned failover status.
ReplicationProtectedItem	Replication protected item.
ReplicationProtectedItemProperties	Replication protected item custom data details.
ResyncState	The resync state.
SqlServerLicenseType	The SQL Server license type.
UpdateDiskInput	Disk input for update.
UpdateReplicationProtectedItemInput	Update replication protected item input.
UpdateReplicationProtectedItemInputProperties	Update protected item input properties.
VmEncryptionType	The encryption type of the VM.
VMNicDetails	Hyper V VM network details.
VMNicInputDetails	Hyper V VM network input details.
VmReplicationProgressHealth	The initial replication progress health.

A2ACrossClusterMigrationReplicationDetails

Object

A2A provider specific settings.

Name	Type	Description
fabricObjectId	string	The fabric specific object Id of the virtual machine.
instanceType	string: A2ACrossClusterMigration	Gets the Instance type.
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.
osType	string	The type of operating system.
primaryFabricLocation	string	Primary fabric location.
vmProtectionState	string	The protection state for the vm.
vmProtectionStateDescription	string	The protection state description for the vm.

A2AProtectedDiskDetails

Object

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.
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.
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).
tfoDiskName	string	The test failover name for the managed disk.

A2AProtectedManagedDiskDetails

Object

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.
primaryDiskEncryptionSetId	string	The primary disk encryption set Id.
primaryStagingAzureStorageAccountId	string	The primary staging storage account.
recoveryDiskEncryptionSetId	string	The recovery disk encryption set Id.
recoveryOrignalTargetDiskId	string	Recovery original target disk Arm 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

Object

A2A provider specific settings.

Name	Type	Description
agentCertificateExpiryDate	string	Agent certificate expiry date.
agentExpiryDate	string	Agent expiry date.
agentVersion	string	The agent version.
autoProtectionOfDataDisk	AutoProtectionOfDataDisk	A value indicating whether the auto protection is enabled.
fabricObjectId	string	The fabric specific object Id of the virtual machine.
initialPrimaryExtendedLocation	ExtendedLocation	The initial primary extended location.
initialPrimaryFabricLocation	string	The initial primary fabric location.
initialPrimaryZone	string	The initial primary availability zone.
initialRecoveryExtendedLocation	ExtendedLocation	The initial recovery extended location.
initialRecoveryFabricLocation	string	The initial recovery fabric location.
initialRecoveryZone	string	The initial recovery availability zone.
instanceType	string: A2A	Gets the Instance type.
isReplicationAgentCertificateUpdateRequired	boolean	A value indicating whether agent certificate update is required.
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.
primaryAvailabilityZone	string	The primary availability zone.
primaryExtendedLocation	ExtendedLocation	The primary Extended Location.
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.
recoveryAzureGeneration	string	The recovery azure generation.
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.
recoveryCapacityReservationGroupId	string	The recovery capacity reservation group Id.
recoveryCloudService	string	The recovery cloud service.
recoveryExtendedLocation	ExtendedLocation	The recovery Extended Location.
recoveryFabricLocation	string	The recovery fabric location.
recoveryFabricObjectId	string	The recovery fabric object Id.
recoveryProximityPlacementGroupId	string	The recovery proximity placement group Id.
recoveryVirtualMachineScaleSetId	string	The recovery virtual machine scale set 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

Object

A2A unprotected disk details.

Name	Type	Description
diskAutoProtectionStatus	AutoProtectionOfDataDisk	A value indicating whether the disk auto protection is enabled.
diskLunId	integer	The source lun Id for the data disk.

A2AUpdateReplicationProtectedItemInput

Object

InMage Azure V2 input to update replication protected item.

Name	Type	Description
diskEncryptionInfo	DiskEncryptionInfo	The recovery os disk encryption information.
instanceType	string: A2A	The class type.
managedDiskUpdateDetails	A2AVmManagedDiskUpdateDetails[]	Managed disk update details.
recoveryBootDiagStorageAccountId	string	The boot diagnostic storage account.
recoveryCapacityReservationGroupId	string	The recovery capacity reservation group Id.
recoveryCloudServiceId	string	The target cloud service ARM Id (for V1).
recoveryProximityPlacementGroupId	string	The recovery proximity placement group Id.
recoveryResourceGroupId	string	The target resource group ARM Id (for V2).
recoveryVirtualMachineScaleSetId	string	The recovery virtual machine scale set Id.
tfoAzureVMName	string	The user given name for Test Failover VM.

A2AVmManagedDiskUpdateDetails

Object

A2A Vm managed disk update details.

Name	Type	Description
diskEncryptionInfo	DiskEncryptionInfo	The recovery os disk encryption information.
diskId	string	The disk Id.
failoverDiskName	string	The target disk name for unplanned failover operation.
recoveryReplicaDiskAccountType	string	The replica disk type before failover.
recoveryTargetDiskAccountType	string	The target disk type before failover.
tfoDiskName	string	The target disk name for test failover operation.

AgentUpgradeBlockedReason

Enumeration

The whether update is possible or not.

Value	Description
AgentNoHeartbeat
AlreadyOnLatestVersion
DistroIsNotReported
DistroNotSupportedForUpgrade
IncompatibleApplianceVersion
InvalidAgentVersion
InvalidDriverVersion
MissingUpgradePath
NotProtected
ProcessServerNoHeartbeat
RcmProxyNoHeartbeat
RebootRequired
Unknown
UnsupportedProtectionScenario

AutoProtectionOfDataDisk

Enumeration

A value indicating whether the auto protection is enabled.

Value	Description
Disabled
Enabled

AzureToAzureVmSyncedConfigDetails

Object

Azure to Azure VM synced configuration details.

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

AzureVmDiskDetails

Object

Disk details for E2A provider.

Name	Type	Description
customTargetDiskName	string	The custom target Azure disk name.
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

Object

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

Enumeration

The DiskType.

Value	Description
Premium_LRS
StandardSSD_LRS
Standard_LRS

DiskDetails

Object

Onprem 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

Object

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

Object

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.

DiskReplicationProgressHealth

Enumeration

The progress health.

Value	Description
InProgress
NoProgress
None
Queued
SlowProgress

EthernetAddressType

Enumeration

The source IP address type.

Value	Description
Dynamic
Static

ExtendedLocation

Object

Extended location of the resource.

Name	Type	Description
name	string	The name of the extended location.
type	ExtendedLocationType	The extended location type.

ExtendedLocationType

Enumeration

The extended location type.

Value	Description
EdgeZone

HealthError

Object

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

Enumeration

Value indicating whether the health error is customer resolvable.

Value	Description
Allowed
NotAllowed

HyperVReplicaAzureManagedDiskDetails

Object

Hyper-V Managed disk details.

Name	Type	Description
diskEncryptionSetId	string	The disk encryption set ARM Id.
diskId	string	The disk Id.
replicaDiskType	string	The replica disk type.
seedManagedDiskId	string	Seed managed disk Id.

HyperVReplicaAzureReplicationDetails

Object

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.
lastRecoveryPointReceived	string	The last recovery point received time.
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.
protectedManagedDisks	HyperVReplicaAzureManagedDiskDetails[]	The list of protected managed disks.
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.
seedManagedDiskTags	object	The tags for the seed managed disks.
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.
sqlServerLicenseType	string	The SQL Server license type.
targetAvailabilityZone	string	The target availability zone.
targetManagedDiskTags	object	The tags for the target managed disks.
targetNicTags	object	The tags for the target NICs.
targetProximityPlacementGroupId	string	The target proximity placement group Id.
targetVmTags	object	The target VM tags.
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.

HyperVReplicaAzureUpdateReplicationProtectedItemInput

Object

HyperV replica Azure input to update replication protected item.

Name	Type	Description
diskIdToDiskEncryptionMap	object	The dictionary of disk resource Id to disk encryption set ARM Id.
instanceType	string: HyperVReplicaAzure	The class type.
recoveryAzureV1ResourceGroupId	string	The recovery Azure resource group Id for classic deployment.
recoveryAzureV2ResourceGroupId	string	The recovery Azure resource group Id for resource manager deployment.
sqlServerLicenseType	SqlServerLicenseType	The SQL Server license type.
targetAvailabilityZone	string	The target availability zone.
targetManagedDiskTags	object	The tags for the target managed disks.
targetNicTags	object	The tags for the target NICs.
targetProximityPlacementGroupId	string	The target proximity placement group Id.
targetVmTags	object	The target VM tags.
useManagedDisks	string	A value indicating whether managed disks should be used during failover.
vmDisks	UpdateDiskInput[]	The list of disk update properties.

HyperVReplicaBaseReplicationDetails

Object

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

Object

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

Object

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

Object

Initial replication details.

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

InMageAgentDetails

Object

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.

InMageAzureV2ManagedDiskDetails

Object

InMageAzureV2 Managed disk details.

Name	Type	Description
diskEncryptionSetId	string	The DiskEncryptionSet ARM ID.
diskId	string	The disk id.
replicaDiskType	string	The replica disk type.
seedManagedDiskId	string	Seed managed disk Id.
targetDiskName	string	The target disk name.

InMageAzureV2ProtectedDiskDetails

Object

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.
progressHealth	string	The Progress Health.
progressStatus	string	The Progress Status.
protectionStage	string	The protection stage.
psDataInMegaBytes	number	The PS data transit in MB.
resyncDurationInSeconds	integer	The resync duration in seconds.
resyncLast15MinutesTransferredBytes	integer	The resync last 15 minutes transferred bytes.
resyncLastDataTransferTimeUTC	string	The last data transfer time in UTC.
resyncProcessedBytes	integer	The resync processed bytes.
resyncProgressPercentage	integer	The resync progress percentage.
resyncRequired	string	A value indicating whether resync is required for this disk.
resyncStartTime	string	The resync start time.
resyncTotalTransferredBytes	integer	The resync total transferred bytes.
rpoInSeconds	integer	The RPO in seconds.
secondsToTakeSwitchProvider	integer	The seconds to take for switch provider.
sourceDataInMegaBytes	number	The source data transit in MB.
targetDataInMegaBytes	number	The target data transit in MB.

InMageAzureV2ReplicationDetails

Object

InMageAzureV2 provider specific settings.

Name	Type	Description
agentExpiryDate	string	Agent expiry date.
agentVersion	string	The agent version.
azureVMDiskDetails	AzureVmDiskDetails[]	Azure VM Disk details.
azureVmGeneration	string	The target generation for this protected item.
compressedDataRateInMB	number	The compressed data change rate in MB.
datastores	string[]	The datastores of the on-premise machine. Value can be list of strings that contain datastore 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.
firmwareType	string	The firmware type of this protected item.
infrastructureVmId	string	The infrastructure VM Id.
instanceType	string: InMageAzureV2	Gets the Instance type.
ipAddress	string	The source IP address.
isAdditionalStatsAvailable	boolean	A value indicating whether additional IR stats are available or not.
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.
lastRecoveryPointReceived	string	The last recovery point received time.
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.
seedManagedDiskTags	object	The tags for the seed managed disks.
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.
sqlServerLicenseType	string	The SQL Server license type.
switchProviderBlockingErrorDetails	InMageAzureV2SwitchProviderBlockingErrorDetails[]	The switch provider blocking error information.
switchProviderDetails	InMageAzureV2SwitchProviderDetails	The switch provider blocking error information.
targetAvailabilityZone	string	The target availability zone.
targetManagedDiskTags	object	The tags for the target managed disks.
targetNicTags	object	The tags for the target NICs.
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.
targetVmTags	object	The target VM tags.
totalDataTransferred	integer	The total transferred data in bytes.
totalProgressHealth	string	The progress health.
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.

InMageAzureV2SwitchProviderBlockingErrorDetails

Object

InMageAzureV2 switch provider 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.

InMageAzureV2SwitchProviderDetails

Object

InMageAzureV2 switch provider details.

Name	Type	Description
targetApplianceId	string	The target appliance Id.
targetFabricId	string	The target fabric Id.
targetResourceId	string	The target resource Id.
targetVaultId	string	The target vault Id.

InMageAzureV2UpdateReplicationProtectedItemInput

Object

InMage Azure V2 input to update replication protected item.

Name	Type	Description
instanceType	string: InMageAzureV2	The class type.
recoveryAzureV1ResourceGroupId	string	The recovery Azure resource group Id for classic deployment.
recoveryAzureV2ResourceGroupId	string	The recovery Azure resource group Id for resource manager deployment.
sqlServerLicenseType	SqlServerLicenseType	The SQL Server license type.
targetAvailabilityZone	string	The target availability zone.
targetManagedDiskTags	object	The tags for the target managed disks.
targetNicTags	object	The tags for the target NICs.
targetProximityPlacementGroupId	string	The target proximity placement group Id.
targetVmTags	object	The target VM tags.
useManagedDisks	string	A value indicating whether managed disks should be used during failover.
vmDisks	UpdateDiskInput[]	The list of disk update properties.

InMageProtectedDiskDetails

Object

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.
progressHealth	string	The Progress Health.
progressStatus	string	The Progress Status.
protectionStage	string	The protection stage.
psDataInMB	number	The PS data transit in MB.
resyncDurationInSeconds	integer	The resync duration in seconds.
resyncLast15MinutesTransferredBytes	integer	The resync last 15 minutes transferred bytes.
resyncLastDataTransferTimeUTC	string	The last data transfer time in UTC.
resyncProcessedBytes	integer	The resync processed bytes.
resyncProgressPercentage	integer	The resync progress percentage.
resyncRequired	string	A value indicating whether resync is required for this disk.
resyncStartTime	string	The resync start time.
resyncTotalTransferredBytes	integer	The resync total transferred bytes.
rpoInSeconds	integer	The RPO in seconds.
sourceDataInMB	number	The source data transit in MB.
targetDataInMB	number	The target data transit in MB.

InMageRcmAgentUpgradeBlockingErrorDetails

Object

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.

InMageRcmDiscoveredProtectedVmDetails

Object

InMageRcm discovered protected VM details.

Name	Type	Description
createdTimestamp	string	The SDS created timestamp.
datastores	string[]	The list of datastores.
ipAddresses	string[]	The list of IP addresses.
isDeleted	boolean	A value indicating whether the VM is deleted.
lastDiscoveryTimeInUtc	string	The last time when SDS information discovered in SRS.
osName	string	The VM's OS name.
powerStatus	string	The VM power status.
updatedTimestamp	string	The SDS updated timestamp.
vCenterFqdn	string	The VCenter fqdn.
vCenterId	string	The VCenter Id.
vmFqdn	string	The VM fqdn.
vmwareToolsStatus	string	The VMware tools status.

InMageRcmFailbackDiscoveredProtectedVmDetails

Object

InMageRcmFailback discovered VM details.

Name	Type	Description
createdTimestamp	string	The SDS created timestamp.
datastores	string[]	The list of datastores.
ipAddresses	string[]	The list of IP addresses.
isDeleted	boolean	A value indicating whether the VM is deleted.
lastDiscoveryTimeInUtc	string	The last time when SDS information discovered in SRS.
osName	string	The VM's OS name.
powerStatus	string	The VM power status.
updatedTimestamp	string	The SDS updated timestamp.
vCenterFqdn	string	The VCenter fqdn.
vCenterId	string	The VCenter Id.
vmFqdn	string	The VM fqdn.
vmwareToolsStatus	string	The VMware tools status.

InMageRcmFailbackMobilityAgentDetails

Object

InMageRcmFailback 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	AgentUpgradeBlockedReason[]	The whether update is possible or not.
version	string	The agent version.

InMageRcmFailbackNicDetails

Object

InMageRcmFailback NIC details.

Name	Type	Description
adapterType	string	The adapter type.
macAddress	string	The mac address.
networkName	string	The network name.
sourceIpAddress	string	The IP address.

InMageRcmFailbackProtectedDiskDetails

Object

InMageRcmFailback protected disk details.

Name	Type	Description
capacityInBytes	integer	The disk capacity in bytes.
dataPendingAtSourceAgentInMB	number	The data pending at source agent in MB.
dataPendingInLogDataStoreInMB	number	The data pending in log data store in MB.
diskId	string	The disk Id (reported by source agent).
diskName	string	The disk name.
diskUuid	string	The disk Uuid (reported by vCenter).
irDetails	InMageRcmFailbackSyncDetails	The initial replication details.
isInitialReplicationComplete	string	A value indicating whether initial replication is complete or not.
isOSDisk	string	A value indicating whether the disk is the OS disk.
lastSyncTime	string	The last sync time.
resyncDetails	InMageRcmFailbackSyncDetails	The resync details.

InMageRcmFailbackReplicationDetails

Object

InMageRcmFailback provider specific details.

Name	Type	Description
azureVirtualMachineId	string	The ARM Id of the azure VM.
discoveredVmDetails	InMageRcmFailbackDiscoveredProtectedVmDetails	The discovered VM information.
initialReplicationProcessedBytes	integer	The initial replication processed bytes. This includes sum of total bytes transferred and matched bytes on all selected disks in source VM.
initialReplicationProgressHealth	VmReplicationProgressHealth	The initial replication progress health.
initialReplicationProgressPercentage	integer	The initial replication progress percentage.
initialReplicationTransferredBytes	integer	The initial replication transferred bytes from source VM to target for all selected disks on source VM.
instanceType	string: InMageRcmFailback	Gets the Instance type.
internalIdentifier	string	The virtual machine internal identifier.
isAgentRegistrationSuccessfulAfterFailover	boolean	A value indicating whether agent registration was successful after failover.
lastPlannedFailoverStartTime	string	The last planned failover start time.
lastPlannedFailoverStatus	PlannedFailoverStatus	The last planned failover status.
lastUsedPolicyFriendlyName	string	The policy friendly name used by the forward replication.
lastUsedPolicyId	string	The policy Id used by the forward replication.
logStorageAccountId	string	The log storage account ARM Id.
mobilityAgentDetails	InMageRcmFailbackMobilityAgentDetails	The mobility agent information.
multiVmGroupName	string	The multi VM group name.
osType	string	The type of the OS on the VM.
protectedDisks	InMageRcmFailbackProtectedDiskDetails[]	The list of protected disks.
reprotectAgentId	string	The reprotect agent Id.
reprotectAgentName	string	The reprotect agent name.
resyncProcessedBytes	integer	The resync processed bytes. This includes sum of total bytes transferred and matched bytes on all selected disks in source VM.
resyncProgressHealth	VmReplicationProgressHealth	The resync progress health.
resyncProgressPercentage	integer	The resync progress percentage.
resyncRequired	string	A value indicating whether resync is required.
resyncState	ResyncState	The resync state.
resyncTransferredBytes	integer	The resync transferred bytes from source VM to target for all selected disks on source VM.
targetDataStoreName	string	The target datastore name.
targetVmName	string	The target VM name.
targetvCenterId	string	The target vCenter Id.
vmNics	InMageRcmFailbackNicDetails[]	The network details.

InMageRcmFailbackSyncDetails

Object

InMageRcmFailback disk level sync details.

Name	Type	Description
last15MinutesTransferredBytes	integer	The bytes transferred in last 15 minutes from source VM to target.
lastDataTransferTimeUtc	string	The time of the last data transfer from source VM to target.
lastRefreshTime	string	The last refresh time.
processedBytes	integer	The total processed bytes. This includes bytes that are transferred from source VM to target and matched bytes.
progressHealth	DiskReplicationProgressHealth	The progress health.
progressPercentage	integer	Progress in percentage. Progress percentage is calculated based on processed bytes.
startTime	string	The start time.
transferredBytes	integer	The transferred bytes from source VM to azure for the disk.

InMageRcmLastAgentUpgradeErrorDetails

Object

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

Object

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.
latestAgentReleaseDate	string	The latest agent version release date.
latestUpgradableVersionWithoutReboot	string	The latest upgradeable version available without reboot.
latestVersion	string	The latest agent version available.
reasonsBlockingUpgrade	AgentUpgradeBlockedReason[]	The whether update is possible or not.
version	string	The agent version.

InMageRcmNicDetails

Object

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.

InMageRcmNicInput

Object

InMageRcm NIC input.

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.
targetStaticIPAddress	string	The target static IP address.
targetSubnetName	string	Target subnet name.
testStaticIPAddress	string	The test static IP address.
testSubnetName	string	The test subnet name.

InMageRcmProtectedDiskDetails

Object

InMageRcm protected disk details.

Name	Type	Description
capacityInBytes	integer	The disk capacity in bytes.
dataPendingAtSourceAgentInMB	number	The data pending at source agent in MB.
dataPendingInLogDataStoreInMB	number	The data pending in log data store in MB.
diskEncryptionSetId	string	The DiskEncryptionSet ARM Id.
diskId	string	The disk Id.
diskName	string	The disk name.
diskType	DiskAccountType	The disk type.
irDetails	InMageRcmSyncDetails	The initial replication details.
isInitialReplicationComplete	string	A value indicating whether initial replication is complete or not.
isOSDisk	string	A value indicating whether the disk is the OS disk.
logStorageAccountId	string	The log storage account ARM Id.
resyncDetails	InMageRcmSyncDetails	The resync details.
seedBlobUri	string	The uri of the seed blob.
seedManagedDiskId	string	The ARM Id of the seed managed disk.
targetManagedDiskId	string	The ARM Id of the target managed disk.

InMageRcmReplicationDetails

Object

InMageRcm provider specific details.

Name	Type	Description
agentUpgradeAttemptToVersion	string	The agent version to which last agent upgrade was attempted.
agentUpgradeBlockingErrorDetails	InMageRcmAgentUpgradeBlockingErrorDetails[]	The agent upgrade blocking error information.
agentUpgradeJobId	string	The agent upgrade job Id.
agentUpgradeState	MobilityAgentUpgradeState	The agent auto upgrade state.
allocatedMemoryInMB	number	The allocated memory in MB.
discoveredVmDetails	InMageRcmDiscoveredProtectedVmDetails	The discovered VM details.
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.
initialReplicationProgressHealth	VmReplicationProgressHealth	The initial replication progress health.
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.
isAgentRegistrationSuccessfulAfterFailover	boolean	A value indicating whether agent registration was successful after failover.
isLastUpgradeSuccessful	string	A value indicating whether last agent upgrade was successful or not.
lastAgentUpgradeErrorDetails	InMageRcmLastAgentUpgradeErrorDetails[]	The last agent upgrade error information.
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.
primaryNicIpAddress	string	The IP address of the primary network interface.
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.
resyncProgressHealth	VmReplicationProgressHealth	The resync progress health.
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.
storageAccountId	string	The replication storage account ARM Id. This is applicable only for the blob based replication test hook.
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.
targetLocation	string	The target location.
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.

InMageRcmSyncDetails

Object

InMageRcm disk level sync details.

Name	Type	Description
last15MinutesTransferredBytes	integer	The bytes transferred in last 15 minutes from source VM to azure.
lastDataTransferTimeUtc	string	The time of the last data transfer from source VM to azure.
lastRefreshTime	string	The last refresh time.
processedBytes	integer	The total processed bytes. This includes bytes that are transferred from source VM to azure and matched bytes.
progressHealth	DiskReplicationProgressHealth	The progress health.
progressPercentage	integer	Progress in percentage. Progress percentage is calculated based on processed bytes.
startTime	string	The start time.
transferredBytes	integer	The transferred bytes from source VM to azure for the disk.

InMageRcmUpdateReplicationProtectedItemInput

Object

InMageRcm provider specific input to update replication protected item.

Name	Type	Description
instanceType	string: InMageRcm	The class type.
licenseType	LicenseType	The license type.
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 target network ARM Id.
targetProximityPlacementGroupId	string	The target proximity placement group Id.
targetResourceGroupId	string	The target resource group ARM Id.
targetVmName	string	The target VM name.
targetVmSize	string	The target VM size.
testNetworkId	string	The test network ARM Id.
vmNics	InMageRcmNicInput[]	The list of NIC details.

InMageReplicationDetails

Object

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 datastores of the on-premise machine Value can be list of strings that contain datastore 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.
isAdditionalStatsAvailable	boolean	A value indicating whether additional IR stats are available or not.
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.
totalDataTransferred	integer	The total transferred data in bytes.
totalProgressHealth	string	The progress health.
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.

InnerHealthError

Object

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).
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.
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

Object

Name	Type	Description
endpointName	string
privatePort	integer
protocol	string
publicPort	integer

IPConfigDetails

Object

Name	Type	Description
ipAddressType	string
isPrimary	boolean
isSeletedForFailover	boolean
name	string
recoveryIPAddressType	string
recoveryLBBackendAddressPoolIds	string[]
recoveryPublicIPAddressId	string
recoveryStaticIPAddress	string
recoverySubnetName	string
staticIPAddress	string
subnetName	string
tfoLBBackendAddressPoolIds	string[]
tfoPublicIPAddressId	string
tfoStaticIPAddress	string
tfoSubnetName	string

IPConfigInputDetails

Object

Name	Type	Description
ipConfigName	string
isPrimary	boolean
isSeletedForFailover	boolean
recoveryLBBackendAddressPoolIds	string[]
recoveryPublicIPAddressId	string
recoveryStaticIPAddress	string
recoverySubnetName	string
tfoLBBackendAddressPoolIds	string[]
tfoPublicIPAddressId	string
tfoStaticIPAddress	string
tfoSubnetName	string

KeyEncryptionKeyInfo

Object

Key Encryption Key (KEK) information.

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

LicenseType

Enumeration

License type.

Value	Description
NoLicenseType
NotSpecified
WindowsServer

MobilityAgentUpgradeState

Enumeration

The agent auto upgrade state.

Value	Description
Commit
Completed
None
Started

MultiVmGroupCreateOption

Enumeration

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

Value	Description
AutoCreated
UserSpecified

OSDetails

Object

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

Object

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.

PlannedFailoverStatus

Enumeration

The last planned failover status.

Value	Description
Cancelled
Failed
Succeeded
Unknown

ReplicationProtectedItem

Object

Replication protected item.

Name	Type	Description
id	string	Resource Id
location	string	Resource Location
name	string	Resource Name
properties	ReplicationProtectedItemProperties	The custom data.
type	string	Resource Type

ReplicationProtectedItemProperties

Object

Replication protected item custom data details.

Name	Type	Description
activeLocation	string	The Current active location of the PE.
allowedOperations	string[]	The allowed operations on the Replication protected item.
currentScenario	CurrentScenarioDetails	The current scenario.
eventCorrelationId	string	The correlation Id for events associated with this protected item.
failoverHealth	string	The consolidated failover health for the VM.
failoverRecoveryPointId	string	The recovery point ARM Id to which the Vm was failed over.
friendlyName	string	The name.
healthErrors	HealthError[]	List of health errors.
lastSuccessfulFailoverTime	string	The Last successful failover time.
lastSuccessfulTestFailoverTime	string	The Last successful test failover time.
policyFriendlyName	string	The name of Policy governing this PE.
policyId	string	The ID of Policy governing this PE.
primaryFabricFriendlyName	string	The friendly name of the primary fabric.
primaryFabricProvider	string	The fabric provider of the primary fabric.
primaryProtectionContainerFriendlyName	string	The name of primary protection container friendly name.
protectableItemId	string	The protected item ARM Id.
protectedItemType	string	The type of protected item type.
protectionState	string	The protection status.
protectionStateDescription	string	The protection state description.
providerSpecificDetails	ReplicationProviderSpecificSettings: A2ACrossClusterMigrationReplicationDetails A2AReplicationDetails HyperVReplicaAzureReplicationDetails HyperVReplicaBaseReplicationDetails HyperVReplicaBlueReplicationDetails HyperVReplicaReplicationDetails InMageAzureV2ReplicationDetails InMageRcmFailbackReplicationDetails InMageRcmReplicationDetails InMageReplicationDetails	The Replication provider custom settings.
recoveryContainerId	string	The recovery container Id.
recoveryFabricFriendlyName	string	The friendly name of recovery fabric.
recoveryFabricId	string	The Arm Id of recovery fabric.
recoveryProtectionContainerFriendlyName	string	The name of recovery container friendly name.
recoveryServicesProviderId	string	The recovery provider ARM Id.
replicationHealth	string	The consolidated protection health for the VM taking any issues with SRS as well as all the replication units associated with the VM's replication group into account. This is a string representation of the ProtectionHealth enumeration.
switchProviderState	string	The switch provider state.
switchProviderStateDescription	string	The switch provider state description.
testFailoverState	string	The Test failover state.
testFailoverStateDescription	string	The Test failover state description.

ResyncState

Enumeration

The resync state.

Value	Description
None
PreparedForResynchronization
StartedResynchronization

SqlServerLicenseType

Enumeration

The SQL Server license type.

Value	Description
AHUB
NoLicenseType
NotSpecified
PAYG

UpdateDiskInput

Object

Disk input for update.

Name	Type	Description
diskId	string	The disk Id.
targetDiskName	string	The target disk name.

UpdateReplicationProtectedItemInput

Object

Update replication protected item input.

Name	Type	Description
properties	UpdateReplicationProtectedItemInputProperties	Update replication protected item properties.

UpdateReplicationProtectedItemInputProperties

Object

Update protected item input properties.

Name	Type	Description
enableRdpOnTargetOption	string	The selected option to enable RDP\SSH on target vm after failover. String value of SrsDataContract.EnableRDPOnTargetOption enum.
licenseType	LicenseType	License type.
providerSpecificDetails	UpdateReplicationProtectedItemProviderInput: A2AUpdateReplicationProtectedItemInput HyperVReplicaAzureUpdateReplicationProtectedItemInput InMageAzureV2UpdateReplicationProtectedItemInput InMageRcmUpdateReplicationProtectedItemInput	The provider specific input to update replication protected item.
recoveryAvailabilitySetId	string	The target availability set Id.
recoveryAzureVMName	string	Target Azure VM name given by the user.
recoveryAzureVMSize	string	Target Azure VM size.
selectedRecoveryAzureNetworkId	string	Target Azure Network Id.
selectedSourceNicId	string	The selected source nic Id which will be used as the primary nic during failover.
selectedTfoAzureNetworkId	string	The Azure Network Id for test failover.
vmNics	VMNicInputDetails[]	The list of VM nic details.

VmEncryptionType

Enumeration

The encryption type of the VM.

Value	Description
NotEncrypted
OnePassEncrypted
TwoPassEncrypted

VMNicDetails

Object

Hyper V VM network details.

Name	Type	Default value	Description
enableAcceleratedNetworkingOnRecovery	boolean		A value indicating whether the NIC has accelerated networking enabled.
enableAcceleratedNetworkingOnTfo	boolean		Whether the TFO NIC has accelerated networking enabled.
ipConfigs	IPConfigDetails[]		The IP configurations of the NIC.
nicId	string		The nic Id.
recoveryNetworkSecurityGroupId	string		The id of the NSG associated with the NIC.
recoveryNicName	string		The name of the NIC to be used when creating target NICs.
recoveryNicResourceGroupName	string		The resource group of the NIC to be used when creating target NICs.
recoveryVMNetworkId	string		Recovery VM network Id.
replicaNicId	string		The replica nic Id.
reuseExistingNic	boolean	False	A value indicating whether an existing NIC is allowed to be reused during failover subject to availability.
selectionType	string		Selection type for failover.
sourceNicArmId	string		The source nic ARM Id.
targetNicName	string		Target NIC name.
tfoNetworkSecurityGroupId	string		The NSG to be used by NIC during test failover.
tfoRecoveryNicName	string		The name of the NIC to be used when creating target NICs in TFO.
tfoRecoveryNicResourceGroupName	string		The resource group of the NIC to be used when creating target NICs in TFO.
tfoReuseExistingNic	boolean	False	A value indicating whether an existing NIC is allowed to be reused during test failover subject to availability.
tfoVMNetworkId	string		The network to be used by NIC during test failover.
vMNetworkName	string		VM network name.

VMNicInputDetails

Object

Hyper V VM network input details.

Name	Type	Description
enableAcceleratedNetworkingOnRecovery	boolean	Whether the NIC has accelerated networking enabled.
enableAcceleratedNetworkingOnTfo	boolean	Whether the test NIC has accelerated networking enabled.
ipConfigs	IPConfigInputDetails[]	The IP configurations to be used by NIC during test failover and failover.
nicId	string	The nic Id.
recoveryNetworkSecurityGroupId	string	The id of the NSG associated with the NIC.
recoveryNicName	string	The name of the NIC to be used when creating target NICs.
recoveryNicResourceGroupName	string	The resource group of the NIC to be used when creating target NICs.
reuseExistingNic	boolean	A value indicating whether an existing NIC is allowed to be reused during failover subject to availability.
selectionType	string	Selection type for failover.
targetNicName	string	Target NIC name.
tfoNetworkSecurityGroupId	string	The NSG to be used by NIC during test failover.
tfoNicName	string	The name of the NIC to be used when creating target NICs in TFO.
tfoNicResourceGroupName	string	The resource group of the NIC to be used when creating target NICs in TFO.
tfoReuseExistingNic	boolean	A value indicating whether an existing NIC is allowed to be reused during test failover subject to availability.

VmReplicationProgressHealth

Enumeration

The initial replication progress health.

Value	Description
InProgress
NoProgress
None
SlowProgress