Replication Protected Items - List

Gets the list of replication protected items.
Gets the list of ASR replication protected items in the vault.

GET https://management.azure.com/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationProtectedItems?api-version=2018-07-10
GET https://management.azure.com/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationProtectedItems?api-version=2018-07-10&skipToken={skipToken}&$filter={$filter}

URI Parameters

Name In Required Type Description
subscriptionId
path True
  • string

The subscription Id.

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.

api-version
query True
  • string

Client Api Version.

skipToken
query
  • string

The pagination token. Possible values: "FabricId" or "FabricId_CloudId" or null

$filter
query
  • string

OData filter options.

Responses

Name Type Description
200 OK

OK

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

Gets the list of replication protected items.

Sample Request

GET https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationProtectedItems?api-version=2018-07-10

Sample Response

{
  "value": [
    {
      "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"
      }
    }
  ]
}

Definitions

A2AProtectedDiskDetails

A2A protected disk details.

A2AProtectedManagedDiskDetails

A2A protected managed disk details.

A2AReplicationDetails

A2A provider specific settings.

A2AUnprotectedDiskDetails

A2A unprotected disk details.

AzureToAzureVmSyncedConfigDetails

Azure to Azure VM synced configuration details.

AzureVmDiskDetails

Disk details for E2A provider.

CurrentScenarioDetails

Current scenario details of the protected entity.

DiskDetails

On-prem disk details data.

HealthError

Health Error

HealthErrorCustomerResolvability

Value indicating whether the health error is customer resolvable.

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.

InMageAzureV2ManagedDiskDetails

InMageAzureV2 Managed disk details.

InMageAzureV2ProtectedDiskDetails

InMageAzureV2 protected disk details.

InMageAzureV2ReplicationDetails

InMageAzureV2 provider specific settings

InMageProtectedDiskDetails

InMage protected disk details.

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

Azure VM input endpoint details.

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.

ReplicationProtectedItemCollection

Replication protected item collection.

ReplicationProtectedItemProperties

Replication protected item custom data details.

VmEncryptionType

The encryption type of the VM.

VMNicDetails

Hyper V VM network 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.

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.

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

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.

initialRecoveryFabricLocation
  • string

The initial recovery fabric location.

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

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

The list of protected disks.

protectedManagedDisks

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.

rpoInSeconds
  • integer

The last RPO value in seconds.

selectedRecoveryAzureNetworkId
  • string

The recovery virtual network.

testFailoverRecoveryFabricObjectId
  • string

The test failover fabric object Id.

unprotectedDisks

The list of unprotected disks.

vmEncryptionType

The encryption type of the VM.

vmNics

The virtual machine nic details.

vmProtectionState
  • string

The protection state for the vm.

vmProtectionStateDescription
  • string

The protection state description for the vm.

vmSyncedConfigDetails

The synced configuration details.

A2AUnprotectedDiskDetails

A2A unprotected disk details.

Name Type Description
diskLunId
  • integer

The source lun Id for the data disk.

AzureToAzureVmSyncedConfigDetails

Azure to Azure VM synced configuration details.

Name Type Description
inputEndpoints

The Azure VM input endpoints.

tags
  • object

The Azure VM tags.

AzureVmDiskDetails

Disk details for E2A provider.

Name Type Description
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.

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.

HealthError

Health Error

Name Type Description
creationTimeUtc
  • string

Error creation time (UTC)

customerResolvability

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

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

HyperVReplicaAzureReplicationDetails

Hyper V Replica Azure provider specific settings.

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

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

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.

useManagedDisks
  • string

A value indicating whether managed disks should be used during failover.

vmId
  • string

The virtual machine Id.

vmNics

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

Initial replication details.

instanceType string:

Gets the Instance type.

lastReplicatedTime
  • string

The Last replication time.

vMDiskDetails

VM disk details.

vmId
  • string

The virtual machine Id.

vmNics

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

Initial replication details.

instanceType string:
  • HyperVReplica2012R2

Gets the Instance type.

lastReplicatedTime
  • string

The Last replication time.

vMDiskDetails

VM disk details.

vmId
  • string

The virtual machine Id.

vmNics

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

Initial replication details.

instanceType string:
  • HyperVReplica2012

Gets the Instance type.

lastReplicatedTime
  • string

The Last replication time.

vMDiskDetails

VM disk details.

vmId
  • string

The virtual machine Id.

vmNics

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.

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

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.

protectedDisks

The list of protected disks.

protectedManagedDisks

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.

sourceVmCpuCount
  • integer

The CPU count of the VM on the primary side.

sourceVmRamSizeInMB
  • integer

The RAM size of the VM on the primary side.

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

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

The PE Network details.

vmProtectionState
  • string

The protection state for the vm.

vmProtectionStateDescription
  • string

The protection state description for the vm.

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.

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

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

The OS details.

osVersion
  • string

The OS Version of the protected item.

processServerId
  • string

The process server Id.

protectedDisks

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

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

The validation errors of the on-premise machine Value can be list of validation errors

vmId
  • string

The virtual machine Id.

vmNics

The PE Network details.

vmProtectionState
  • string

The protection state for the vm.

vmProtectionStateDescription
  • string

The protection state description for the vm.

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.

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.

ReplicationProtectedItem

Replication protected item.

Name Type Description
id
  • string

Resource Id

location
  • string

Resource Location

name
  • string

Resource Name

properties

The custom data.

type
  • string

Resource Type

ReplicationProtectedItemCollection

Replication protected item collection.

Name Type Description
nextLink
  • string

The value of next link.

value

The Replication protected item details.

ReplicationProtectedItemProperties

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

The current scenario.

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

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:

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.

testFailoverState
  • string

The Test failover state.

testFailoverStateDescription
  • string

The Test failover state description.

VmEncryptionType

The encryption type of the VM.

Name Type Description
NotEncrypted
  • string
OnePassEncrypted
  • string
TwoPassEncrypted
  • string

VMNicDetails

Hyper V VM network details.

Name Type Description
enableAcceleratedNetworkingOnRecovery
  • boolean

A value indicating whether the NIC has accelerated networking enabled.

ipAddressType
  • string

Ip address type.

nicId
  • string

The nic Id.

primaryNicStaticIPAddress
  • string

Primary nic static IP address.

recoveryLBBackendAddressPoolIds
  • string[]

The target backend address pools for the NIC.

recoveryNetworkSecurityGroupId
  • string

The id of the NSG associated with the NIC.

recoveryNicIpAddressType
  • string

IP allocation type for recovery VM.

recoveryPublicIpAddressId
  • string

The id of the public IP address resource associated with the NIC.

recoveryVMNetworkId
  • string

Recovery VM network Id.

recoveryVMSubnetName
  • string

Recovery VM subnet name.

replicaNicId
  • string

The replica nic Id.

replicaNicStaticIPAddress
  • string

Replica nic static IP address.

selectionType
  • string

Selection type for failover.

sourceNicArmId
  • string

The source nic ARM Id.

vMNetworkName
  • string

VM network name.

vMSubnetName
  • string

VM subnet name.