Microsoft.RecoveryServices (stable:2025-02-01)

2025/05/20 • 153 new methods

Operations_List (new)
Description :  Operation to return the list of available operations.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/operations
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The ClientDiscovery details. ,
Required: False ,
}
[
{
name:
{
Description: Name of the API. The name of the operation being performed on this particular object. It should match the action name that appears in RBAC / the event service. Examples of operations include: * Microsoft.Compute/virtualMachine/capture/action * Microsoft.Compute/virtualMachine/restart/action * Microsoft.Compute/virtualMachine/write * Microsoft.Compute/virtualMachine/read * Microsoft.Compute/virtualMachine/delete Each action should include, in order: (1) Resource Provider Namespace (2) Type hierarchy for which the action applies (e.g. server/databases for a SQL Azure database) (3) Read, Write, Action or Delete indicating which type applies. If it is a PUT/PATCH on a collection or named value, Write should be used. If it is a GET, Read should be used. If it is a DELETE, Delete should be used. If it is a POST, Action should be used. As a note: all resource providers would need to include the "{Resource Provider Namespace}/register/action" operation in their response. This API is used to register for their service, and should include details about the operation (e.g. a localized name for the resource provider + any special considerations like PII release). ,
Required: False ,
}
string ,
display:
{
Description: Object type. ,
Required: False ,
}
{
provider:
{
Description: The provider. The localized friendly form of the resource provider name - it is expected to also include the publisher/company responsible. It should use Title Casing and begin with "Microsoft" for 1st party services. e.g. "Microsoft Monitoring Insights" or "Microsoft Compute.". ,
Required: False ,
}
string ,
resource:
{
Description: The resource. The localized friendly form of the resource related to this action/operation - it should match the public documentation for the resource provider. It should use Title Casing. This value should be unique for a particular URL type (e.g. nested types should *not* reuse their parent's display.resource field). e.g. "Virtual Machines" or "Scheduler Job Collections", or "Virtual Machine VM Sizes" or "Scheduler Jobs". ,
Required: False ,
}
string ,
operation:
{
Description: The operation. The localized friendly name for the operation, as it should be shown to the user. It should be concise (to fit in drop downs) but clear (i.e. self-documenting). It should use Title Casing. Prescriptive guidance: Read Create or Update Delete 'ActionName'. ,
Required: False ,
}
string ,
description:
{
Description: The description. The localized friendly description for the operation, as it should be shown to the user. It should be thorough, yet concise - it will be used in tool tips and detailed views. Prescriptive guidance for namespaces: Read any 'display.provider' resource Create or Update any 'display.provider' resource Delete any 'display.provider' resource Perform any other action on any 'display.provider' resource Prescriptive guidance for namespaces: Read any 'display.resource' Create or Update any 'display.resource' Delete any 'display.resource' 'ActionName' any 'display.resources'. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: Origin. The intended executor of the operation; governs the display of the operation in the RBAC UX and the audit logs UX. Default value is "user,system". ,
Required: False ,
}
string ,
properties:
{
Description: Properties. Reserved for future use. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: The value of next link. ,
Required: False ,
}
string ,
}
ReplicationAlertSettings_List (new)
Description :  Gets the list of email notification(alert) configurations for the vault.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationAlertSettings
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of alerts. ,
Required: False ,
}
[
{
properties:
{
Description: Alert related data. ,
Required: False ,
}
{
sendToOwners:
{
Description: A value indicating whether to send email to subscription administrator. ,
Required: False ,
}
string ,
customEmailAddresses:
{
Description: The custom email address for sending emails. ,
Required: False ,
}
[
string ,
]
,
locale:
{
Description: The locale for the email notification. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The value of next link. ,
Required: False ,
}
string ,
}
ReplicationAlertSettings_Get (new)
Description :  Gets the details of the specified email notification(alert) configuration.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationAlertSettings/{alertSettingName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
alertSettingName:
{
Description: The name of the email notification configuration. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Alert related data. ,
Required: False ,
}
{
sendToOwners:
{
Description: A value indicating whether to send email to subscription administrator. ,
Required: False ,
}
string ,
customEmailAddresses:
{
Description: The custom email address for sending emails. ,
Required: False ,
}
[
string ,
]
,
locale:
{
Description: The locale for the email notification. ,
Required: False ,
}
string ,
}
,
}
ReplicationAlertSettings_Create (new)
Description :  Create or update an email notification(alert) configuration.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationAlertSettings/{alertSettingName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
alertSettingName:
{
Description: The name of the email notification(alert) configuration. ,
Required: True ,
}
string ,
request:
{
Description: The input to configure the email notification(alert). ,
Required: True ,
}
{
properties:
{
Description: The properties of a configure alert request. ,
Required: False ,
}
{
sendToOwners:
{
Description: A value indicating whether to send email to subscription administrator. ,
Required: False ,
}
string ,
customEmailAddresses:
{
Description: The custom email address for sending emails. ,
Required: False ,
}
[
string ,
]
,
locale:
{
Description: The locale for the email notification. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Alert related data. ,
Required: False ,
}
{
sendToOwners:
{
Description: A value indicating whether to send email to subscription administrator. ,
Required: False ,
}
string ,
customEmailAddresses:
{
Description: The custom email address for sending emails. ,
Required: False ,
}
[
string ,
]
,
locale:
{
Description: The locale for the email notification. ,
Required: False ,
}
string ,
}
,
}
ReplicationAppliances_List (new)
Description :  Gets the list of Azure Site Recovery appliances for the vault.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationAppliances
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
$filter:
{
Description: OData filter options. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The appliance details. ,
Required: False ,
}
[
{
properties:
{
Description: Appliance related data. ,
Required: False ,
}
{
providerSpecificDetails:
{
Description: Provider specific settings. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the class type. Overridden in derived classes. ,
Required: True ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The value of next link. ,
Required: False ,
}
string ,
}
ReplicationEligibilityResults_List (new)
Description :  Validates whether a given VM can be protected or not in which case returns list of errors.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{virtualMachineName}/providers/Microsoft.RecoveryServices/replicationEligibilityResults
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
virtualMachineName:
{
Description: Virtual Machine name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The replication eligibility results details. ,
Required: False ,
}
[
{
name:
{
Description: Gets the name of this object. ,
Required: False ,
}
string ,
type:
{
Description: Gets the object type. ,
Required: False ,
}
string ,
id:
{
Description: Gets Unique ARM identifier for this object. ,
Required: False ,
}
string ,
properties:
{
Description: Gets properties model for replication eligibility results API. ,
Required: False ,
}
{
clientRequestId:
{
Description: The client request Id. ,
Required: False ,
}
string ,
errors:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: The possible causes. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: The recommended action. ,
Required: False ,
}
string ,
status:
{
Description: The error status. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
}
ReplicationEligibilityResults_Get (new)
Description :  Validates whether a given VM can be protected or not in which case returns list of errors.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{virtualMachineName}/providers/Microsoft.RecoveryServices/replicationEligibilityResults/default
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
virtualMachineName:
{
Description: Virtual Machine name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: Gets the name of this object. ,
Required: False ,
}
string ,
type:
{
Description: Gets the object type. ,
Required: False ,
}
string ,
id:
{
Description: Gets Unique ARM identifier for this object. ,
Required: False ,
}
string ,
properties:
{
Description: Gets properties model for replication eligibility results API. ,
Required: False ,
}
{
clientRequestId:
{
Description: The client request Id. ,
Required: False ,
}
string ,
errors:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: The possible causes. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: The recommended action. ,
Required: False ,
}
string ,
status:
{
Description: The error status. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
ReplicationEvents_List (new)
Description :  Gets the list of Azure Site Recovery events for the vault.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationEvents
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
$filter:
{
Description: OData filter options. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of events. ,
Required: False ,
}
[
{
properties:
{
Description: Event related data. ,
Required: False ,
}
{
eventCode:
{
Description: The Id of the monitoring event. ,
Required: False ,
}
string ,
description:
{
Description: The event name. ,
Required: False ,
}
string ,
eventType:
{
Description: The type of the event. for example: VM Health, Server Health, Job Failure etc. ,
Required: False ,
}
string ,
affectedObjectFriendlyName:
{
Description: The friendly name of the source of the event on which it is raised (for example, VM, VMM etc). ,
Required: False ,
}
string ,
affectedObjectCorrelationId:
{
Description: The affected object correlationId for the event. ,
Required: False ,
}
string ,
severity:
{
Description: The severity of the event. ,
Required: False ,
}
string ,
timeOfOccurrence:
{
Description: The time of occurrence of the event. ,
Format: date-time ,
Required: False ,
}
string ,
fabricId:
{
Description: The ARM ID of the fabric. ,
Required: False ,
}
string ,
providerSpecificDetails:
{
Description: The provider specific settings. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the class type. Overridden in derived classes. ,
Required: True ,
}
string ,
}
,
eventSpecificDetails:
{
Description: The event specific settings. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the class type. Overridden in derived classes. ,
Required: True ,
}
string ,
}
,
healthErrors:
{
Description: The list of errors / warnings capturing details associated with the issue(s). ,
Required: False ,
}
[
{
innerHealthErrors:
{
Description: 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. ,
Required: False ,
}
[
{
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The value of next link. ,
Required: False ,
}
string ,
}
ReplicationEvents_Get (new)
Description :  The operation to get the details of an Azure Site recovery event.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationEvents/{eventName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
eventName:
{
Description: The name of the Azure Site Recovery event. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Event related data. ,
Required: False ,
}
{
eventCode:
{
Description: The Id of the monitoring event. ,
Required: False ,
}
string ,
description:
{
Description: The event name. ,
Required: False ,
}
string ,
eventType:
{
Description: The type of the event. for example: VM Health, Server Health, Job Failure etc. ,
Required: False ,
}
string ,
affectedObjectFriendlyName:
{
Description: The friendly name of the source of the event on which it is raised (for example, VM, VMM etc). ,
Required: False ,
}
string ,
affectedObjectCorrelationId:
{
Description: The affected object correlationId for the event. ,
Required: False ,
}
string ,
severity:
{
Description: The severity of the event. ,
Required: False ,
}
string ,
timeOfOccurrence:
{
Description: The time of occurrence of the event. ,
Format: date-time ,
Required: False ,
}
string ,
fabricId:
{
Description: The ARM ID of the fabric. ,
Required: False ,
}
string ,
providerSpecificDetails:
{
Description: The provider specific settings. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the class type. Overridden in derived classes. ,
Required: True ,
}
string ,
}
,
eventSpecificDetails:
{
Description: The event specific settings. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the class type. Overridden in derived classes. ,
Required: True ,
}
string ,
}
,
healthErrors:
{
Description: The list of errors / warnings capturing details associated with the issue(s). ,
Required: False ,
}
[
{
innerHealthErrors:
{
Description: 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. ,
Required: False ,
}
[
{
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
ReplicationFabrics_List (new)
Description :  Gets a list of the Azure Site Recovery fabrics in the vault.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The fabric details. ,
Required: False ,
}
[
{
properties:
{
Description: Fabric related data. ,
Required: False ,
}
{
friendlyName:
{
Description: Friendly name of the fabric. ,
Required: False ,
}
string ,
encryptionDetails:
{
Description: Encryption details for the fabric. ,
Required: False ,
}
{
kekState:
{
Description: The key encryption key state for the Vmm. ,
Required: False ,
}
string ,
kekCertThumbprint:
{
Description: The key encryption key certificate thumbprint. ,
Required: False ,
}
string ,
kekCertExpiryDate:
{
Description: The key encryption key certificate expiry date. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
rolloverEncryptionDetails:
{
Description: Rollover encryption details for the fabric. ,
Required: False ,
}
{
kekState:
{
Description: The key encryption key state for the Vmm. ,
Required: False ,
}
string ,
kekCertThumbprint:
{
Description: The key encryption key certificate thumbprint. ,
Required: False ,
}
string ,
kekCertExpiryDate:
{
Description: The key encryption key certificate expiry date. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
internalIdentifier:
{
Description: Dra Registration Id. ,
Required: False ,
}
string ,
bcdrState:
{
Description: BCDR state of the fabric. ,
Required: False ,
}
string ,
customDetails:
{
Description: Fabric specific settings. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the class type. Overridden in derived classes. ,
Required: True ,
}
string ,
}
,
healthErrorDetails:
{
Description: Fabric health error details. ,
Required: False ,
}
[
{
innerHealthErrors:
{
Description: 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. ,
Required: False ,
}
[
{
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
health:
{
Description: Health of fabric. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The value of next link. ,
Required: False ,
}
string ,
}
ReplicationFabrics_Get (new)
Description :  Gets the details of an Azure Site Recovery fabric.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric name. ,
Required: True ,
}
string ,
$filter:
{
Description: OData filter options. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Fabric related data. ,
Required: False ,
}
{
friendlyName:
{
Description: Friendly name of the fabric. ,
Required: False ,
}
string ,
encryptionDetails:
{
Description: Encryption details for the fabric. ,
Required: False ,
}
{
kekState:
{
Description: The key encryption key state for the Vmm. ,
Required: False ,
}
string ,
kekCertThumbprint:
{
Description: The key encryption key certificate thumbprint. ,
Required: False ,
}
string ,
kekCertExpiryDate:
{
Description: The key encryption key certificate expiry date. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
rolloverEncryptionDetails:
{
Description: Rollover encryption details for the fabric. ,
Required: False ,
}
{
kekState:
{
Description: The key encryption key state for the Vmm. ,
Required: False ,
}
string ,
kekCertThumbprint:
{
Description: The key encryption key certificate thumbprint. ,
Required: False ,
}
string ,
kekCertExpiryDate:
{
Description: The key encryption key certificate expiry date. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
internalIdentifier:
{
Description: Dra Registration Id. ,
Required: False ,
}
string ,
bcdrState:
{
Description: BCDR state of the fabric. ,
Required: False ,
}
string ,
customDetails:
{
Description: Fabric specific settings. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the class type. Overridden in derived classes. ,
Required: True ,
}
string ,
}
,
healthErrorDetails:
{
Description: Fabric health error details. ,
Required: False ,
}
[
{
innerHealthErrors:
{
Description: 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. ,
Required: False ,
}
[
{
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
health:
{
Description: Health of fabric. ,
Required: False ,
}
string ,
}
,
}
ReplicationFabrics_Create (new)
Description :  The operation to create an Azure Site Recovery fabric (for e.g. Hyper-V site).
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Name of the ASR fabric. ,
Required: True ,
}
string ,
input:
{
Description: Fabric creation input. ,
Required: True ,
}
{
properties:
{
Description: Fabric creation input. ,
Required: False ,
}
{
customDetails:
{
Description: Fabric provider specific creation input. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the class type. ,
Required: True ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Fabric related data. ,
Required: False ,
}
{
friendlyName:
{
Description: Friendly name of the fabric. ,
Required: False ,
}
string ,
encryptionDetails:
{
Description: Encryption details for the fabric. ,
Required: False ,
}
{
kekState:
{
Description: The key encryption key state for the Vmm. ,
Required: False ,
}
string ,
kekCertThumbprint:
{
Description: The key encryption key certificate thumbprint. ,
Required: False ,
}
string ,
kekCertExpiryDate:
{
Description: The key encryption key certificate expiry date. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
rolloverEncryptionDetails:
{
Description: Rollover encryption details for the fabric. ,
Required: False ,
}
{
kekState:
{
Description: The key encryption key state for the Vmm. ,
Required: False ,
}
string ,
kekCertThumbprint:
{
Description: The key encryption key certificate thumbprint. ,
Required: False ,
}
string ,
kekCertExpiryDate:
{
Description: The key encryption key certificate expiry date. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
internalIdentifier:
{
Description: Dra Registration Id. ,
Required: False ,
}
string ,
bcdrState:
{
Description: BCDR state of the fabric. ,
Required: False ,
}
string ,
customDetails:
{
Description: Fabric specific settings. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the class type. Overridden in derived classes. ,
Required: True ,
}
string ,
}
,
healthErrorDetails:
{
Description: Fabric health error details. ,
Required: False ,
}
[
{
innerHealthErrors:
{
Description: 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. ,
Required: False ,
}
[
{
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
health:
{
Description: Health of fabric. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}
ReplicationFabrics_Purge (new)
Description :  The operation to purge(force delete) an Azure Site Recovery fabric.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: ASR fabric to purge. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
ReplicationFabrics_CheckConsistency (new)
Description :  The operation to perform a consistency check on the fabric.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/checkConsistency
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Fabric related data. ,
Required: False ,
}
{
friendlyName:
{
Description: Friendly name of the fabric. ,
Required: False ,
}
string ,
encryptionDetails:
{
Description: Encryption details for the fabric. ,
Required: False ,
}
{
kekState:
{
Description: The key encryption key state for the Vmm. ,
Required: False ,
}
string ,
kekCertThumbprint:
{
Description: The key encryption key certificate thumbprint. ,
Required: False ,
}
string ,
kekCertExpiryDate:
{
Description: The key encryption key certificate expiry date. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
rolloverEncryptionDetails:
{
Description: Rollover encryption details for the fabric. ,
Required: False ,
}
{
kekState:
{
Description: The key encryption key state for the Vmm. ,
Required: False ,
}
string ,
kekCertThumbprint:
{
Description: The key encryption key certificate thumbprint. ,
Required: False ,
}
string ,
kekCertExpiryDate:
{
Description: The key encryption key certificate expiry date. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
internalIdentifier:
{
Description: Dra Registration Id. ,
Required: False ,
}
string ,
bcdrState:
{
Description: BCDR state of the fabric. ,
Required: False ,
}
string ,
customDetails:
{
Description: Fabric specific settings. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the class type. Overridden in derived classes. ,
Required: True ,
}
string ,
}
,
healthErrorDetails:
{
Description: Fabric health error details. ,
Required: False ,
}
[
{
innerHealthErrors:
{
Description: 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. ,
Required: False ,
}
[
{
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
health:
{
Description: Health of fabric. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}
ReplicationFabrics_MigrateToAad (new)
Description :  The operation to migrate an Azure Site Recovery fabric to AAD.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/migratetoaad
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: ASR fabric to migrate. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
ReplicationFabrics_ReassociateGateway (new)
Description :  The operation to move replications from a process server to another process server.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/reassociateGateway
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: The name of the fabric containing the process server. ,
Required: True ,
}
string ,
failoverProcessServerRequest:
{
Description: The input to the failover process server operation. ,
Required: True ,
}
{
properties:
{
Description: The properties of the PS Failover request. ,
Required: False ,
}
{
containerName:
{
Description: The container identifier. ,
Required: False ,
}
string ,
sourceProcessServerId:
{
Description: The source process server. ,
Required: False ,
}
string ,
targetProcessServerId:
{
Description: The new process server. ,
Required: False ,
}
string ,
vmsToMigrate:
{
Description: The VMS to migrate. ,
Required: False ,
}
[
string ,
]
,
updateType:
{
Description: A value for failover type. It can be systemlevel/serverlevel. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Fabric related data. ,
Required: False ,
}
{
friendlyName:
{
Description: Friendly name of the fabric. ,
Required: False ,
}
string ,
encryptionDetails:
{
Description: Encryption details for the fabric. ,
Required: False ,
}
{
kekState:
{
Description: The key encryption key state for the Vmm. ,
Required: False ,
}
string ,
kekCertThumbprint:
{
Description: The key encryption key certificate thumbprint. ,
Required: False ,
}
string ,
kekCertExpiryDate:
{
Description: The key encryption key certificate expiry date. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
rolloverEncryptionDetails:
{
Description: Rollover encryption details for the fabric. ,
Required: False ,
}
{
kekState:
{
Description: The key encryption key state for the Vmm. ,
Required: False ,
}
string ,
kekCertThumbprint:
{
Description: The key encryption key certificate thumbprint. ,
Required: False ,
}
string ,
kekCertExpiryDate:
{
Description: The key encryption key certificate expiry date. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
internalIdentifier:
{
Description: Dra Registration Id. ,
Required: False ,
}
string ,
bcdrState:
{
Description: BCDR state of the fabric. ,
Required: False ,
}
string ,
customDetails:
{
Description: Fabric specific settings. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the class type. Overridden in derived classes. ,
Required: True ,
}
string ,
}
,
healthErrorDetails:
{
Description: Fabric health error details. ,
Required: False ,
}
[
{
innerHealthErrors:
{
Description: 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. ,
Required: False ,
}
[
{
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
health:
{
Description: Health of fabric. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}
ReplicationFabrics_Delete (new)
Description :  The operation to delete or remove an Azure Site Recovery fabric.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/remove
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: ASR fabric to delete. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
ReplicationFabrics_RenewCertificate (new)
Description :  Renews the connection certificate for the ASR replication fabric.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/renewCertificate
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: fabric name to renew certs for. ,
Required: True ,
}
string ,
renewCertificate:
{
Description: Renew certificate input. ,
Required: True ,
}
{
properties:
{
Description: Renew certificate input properties. ,
Required: False ,
}
{
renewCertificateType:
{
Description: Renew certificate type. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Fabric related data. ,
Required: False ,
}
{
friendlyName:
{
Description: Friendly name of the fabric. ,
Required: False ,
}
string ,
encryptionDetails:
{
Description: Encryption details for the fabric. ,
Required: False ,
}
{
kekState:
{
Description: The key encryption key state for the Vmm. ,
Required: False ,
}
string ,
kekCertThumbprint:
{
Description: The key encryption key certificate thumbprint. ,
Required: False ,
}
string ,
kekCertExpiryDate:
{
Description: The key encryption key certificate expiry date. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
rolloverEncryptionDetails:
{
Description: Rollover encryption details for the fabric. ,
Required: False ,
}
{
kekState:
{
Description: The key encryption key state for the Vmm. ,
Required: False ,
}
string ,
kekCertThumbprint:
{
Description: The key encryption key certificate thumbprint. ,
Required: False ,
}
string ,
kekCertExpiryDate:
{
Description: The key encryption key certificate expiry date. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
internalIdentifier:
{
Description: Dra Registration Id. ,
Required: False ,
}
string ,
bcdrState:
{
Description: BCDR state of the fabric. ,
Required: False ,
}
string ,
customDetails:
{
Description: Fabric specific settings. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the class type. Overridden in derived classes. ,
Required: True ,
}
string ,
}
,
healthErrorDetails:
{
Description: Fabric health error details. ,
Required: False ,
}
[
{
innerHealthErrors:
{
Description: 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. ,
Required: False ,
}
[
{
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
health:
{
Description: Health of fabric. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}
ReplicationFabrics_RemoveInfra (new)
Description :  Removes the appliance's infrastructure under the fabric.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/removeInfra
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
resourceName:
{
Description: Resource name. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric name. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ReplicationLogicalNetworks_ListByReplicationFabrics (new)
Description :  Lists all the logical networks of the Azure Site Recovery fabric.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationLogicalNetworks
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Server Id. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Logical Networks list details. ,
Required: False ,
}
[
{
properties:
{
Description: The Logical Network Properties. ,
Required: False ,
}
{
friendlyName:
{
Description: The Friendly Name. ,
Required: False ,
}
string ,
networkVirtualizationStatus:
{
Description: A value indicating whether Network Virtualization is enabled for the logical network. ,
Required: False ,
}
string ,
logicalNetworkUsage:
{
Description: A value indicating whether logical network is used as private test network by test failover. ,
Required: False ,
}
string ,
logicalNetworkDefinitionsStatus:
{
Description: A value indicating whether logical network definitions are isolated. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The value of next link. ,
Required: False ,
}
string ,
}
ReplicationLogicalNetworks_Get (new)
Description :  Gets the details of a logical network.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationLogicalNetworks/{logicalNetworkName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Server Id. ,
Required: True ,
}
string ,
logicalNetworkName:
{
Description: Logical network name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The Logical Network Properties. ,
Required: False ,
}
{
friendlyName:
{
Description: The Friendly Name. ,
Required: False ,
}
string ,
networkVirtualizationStatus:
{
Description: A value indicating whether Network Virtualization is enabled for the logical network. ,
Required: False ,
}
string ,
logicalNetworkUsage:
{
Description: A value indicating whether logical network is used as private test network by test failover. ,
Required: False ,
}
string ,
logicalNetworkDefinitionsStatus:
{
Description: A value indicating whether logical network definitions are isolated. ,
Required: False ,
}
string ,
}
,
}
ReplicationNetworks_ListByReplicationFabrics (new)
Description :  Lists the networks available for a fabric.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationNetworks
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Networks list details. ,
Required: False ,
}
[
{
properties:
{
Description: The Network Properties. ,
Required: False ,
}
{
fabricType:
{
Description: The Fabric Type. ,
Required: False ,
}
string ,
subnets:
{
Description: The List of subnets. ,
Required: False ,
}
[
{
name:
{
Description: The subnet name. ,
Required: False ,
}
string ,
friendlyName:
{
Description: The subnet friendly name. ,
Required: False ,
}
string ,
addressList:
{
Description: The list of addresses for the subnet. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
friendlyName:
{
Description: The Friendly Name. ,
Required: False ,
}
string ,
networkType:
{
Description: The Network Type. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The value of next link. ,
Required: False ,
}
string ,
}
ReplicationNetworks_Get (new)
Description :  Gets the details of a network.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationNetworks/{networkName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Server Id. ,
Required: True ,
}
string ,
networkName:
{
Description: Primary network name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The Network Properties. ,
Required: False ,
}
{
fabricType:
{
Description: The Fabric Type. ,
Required: False ,
}
string ,
subnets:
{
Description: The List of subnets. ,
Required: False ,
}
[
{
name:
{
Description: The subnet name. ,
Required: False ,
}
string ,
friendlyName:
{
Description: The subnet friendly name. ,
Required: False ,
}
string ,
addressList:
{
Description: The list of addresses for the subnet. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
friendlyName:
{
Description: The Friendly Name. ,
Required: False ,
}
string ,
networkType:
{
Description: The Network Type. ,
Required: False ,
}
string ,
}
,
}
ReplicationNetworkMappings_ListByReplicationNetworks (new)
Description :  Lists all ASR network mappings for the specified network.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationNetworks/{networkName}/replicationNetworkMappings
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Primary fabric name. ,
Required: True ,
}
string ,
networkName:
{
Description: Primary network name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Network Mappings list. ,
Required: False ,
}
[
{
properties:
{
Description: The Network Mapping Properties. ,
Required: False ,
}
{
state:
{
Description: The pairing state for network mapping. ,
Required: False ,
}
string ,
primaryNetworkFriendlyName:
{
Description: The primary network friendly name. ,
Required: False ,
}
string ,
primaryNetworkId:
{
Description: The primary network id for network mapping. ,
Required: False ,
}
string ,
primaryFabricFriendlyName:
{
Description: The primary fabric friendly name. ,
Required: False ,
}
string ,
recoveryNetworkFriendlyName:
{
Description: The recovery network friendly name. ,
Required: False ,
}
string ,
recoveryNetworkId:
{
Description: The recovery network id for network mapping. ,
Required: False ,
}
string ,
recoveryFabricArmId:
{
Description: The recovery fabric ARM id. ,
Required: False ,
}
string ,
recoveryFabricFriendlyName:
{
Description: The recovery fabric friendly name. ,
Required: False ,
}
string ,
fabricSpecificSettings:
{
Description: The fabric specific settings. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the Instance type. ,
Required: True ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The value of next link. ,
Required: False ,
}
string ,
}
ReplicationNetworkMappings_Get (new)
Description :  Gets the details of an ASR network mapping.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationNetworks/{networkName}/replicationNetworkMappings/{networkMappingName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Primary fabric name. ,
Required: True ,
}
string ,
networkName:
{
Description: Primary network name. ,
Required: True ,
}
string ,
networkMappingName:
{
Description: Network mapping name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The Network Mapping Properties. ,
Required: False ,
}
{
state:
{
Description: The pairing state for network mapping. ,
Required: False ,
}
string ,
primaryNetworkFriendlyName:
{
Description: The primary network friendly name. ,
Required: False ,
}
string ,
primaryNetworkId:
{
Description: The primary network id for network mapping. ,
Required: False ,
}
string ,
primaryFabricFriendlyName:
{
Description: The primary fabric friendly name. ,
Required: False ,
}
string ,
recoveryNetworkFriendlyName:
{
Description: The recovery network friendly name. ,
Required: False ,
}
string ,
recoveryNetworkId:
{
Description: The recovery network id for network mapping. ,
Required: False ,
}
string ,
recoveryFabricArmId:
{
Description: The recovery fabric ARM id. ,
Required: False ,
}
string ,
recoveryFabricFriendlyName:
{
Description: The recovery fabric friendly name. ,
Required: False ,
}
string ,
fabricSpecificSettings:
{
Description: The fabric specific settings. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the Instance type. ,
Required: True ,
}
string ,
}
,
}
,
}
ReplicationNetworkMappings_Create (new)
Description :  The operation to create an ASR network mapping.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationNetworks/{networkName}/replicationNetworkMappings/{networkMappingName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Primary fabric name. ,
Required: True ,
}
string ,
networkName:
{
Description: Primary network name. ,
Required: True ,
}
string ,
networkMappingName:
{
Description: Network mapping name. ,
Required: True ,
}
string ,
input:
{
Description: Create network mapping input. ,
Required: True ,
}
{
properties:
{
Description: Input properties for creating network mapping. ,
Required: True ,
}
{
recoveryFabricName:
{
Description: Recovery fabric Name. ,
Required: False ,
}
string ,
recoveryNetworkId:
{
Description: Recovery network Id. ,
Required: True ,
}
string ,
fabricSpecificDetails:
{
Description: Fabric specific input properties. ,
Required: False ,
}
{
instanceType:
{
Description: The instance type. ,
Required: True ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The Network Mapping Properties. ,
Required: False ,
}
{
state:
{
Description: The pairing state for network mapping. ,
Required: False ,
}
string ,
primaryNetworkFriendlyName:
{
Description: The primary network friendly name. ,
Required: False ,
}
string ,
primaryNetworkId:
{
Description: The primary network id for network mapping. ,
Required: False ,
}
string ,
primaryFabricFriendlyName:
{
Description: The primary fabric friendly name. ,
Required: False ,
}
string ,
recoveryNetworkFriendlyName:
{
Description: The recovery network friendly name. ,
Required: False ,
}
string ,
recoveryNetworkId:
{
Description: The recovery network id for network mapping. ,
Required: False ,
}
string ,
recoveryFabricArmId:
{
Description: The recovery fabric ARM id. ,
Required: False ,
}
string ,
recoveryFabricFriendlyName:
{
Description: The recovery fabric friendly name. ,
Required: False ,
}
string ,
fabricSpecificSettings:
{
Description: The fabric specific settings. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the Instance type. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{}
ReplicationNetworkMappings_Delete (new)
Description :  The operation to delete a network mapping.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationNetworks/{networkName}/replicationNetworkMappings/{networkMappingName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Primary fabric name. ,
Required: True ,
}
string ,
networkName:
{
Description: Primary network name. ,
Required: True ,
}
string ,
networkMappingName:
{
Description: ARM Resource Name for network mapping. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
ReplicationNetworkMappings_Update (new)
Description :  The operation to update an ASR network mapping.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationNetworks/{networkName}/replicationNetworkMappings/{networkMappingName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Primary fabric name. ,
Required: True ,
}
string ,
networkName:
{
Description: Primary network name. ,
Required: True ,
}
string ,
networkMappingName:
{
Description: Network mapping name. ,
Required: True ,
}
string ,
input:
{
Description: Update network mapping input. ,
Required: True ,
}
{
properties:
{
Description: The input properties needed to update network mapping. ,
Required: False ,
}
{
recoveryFabricName:
{
Description: Recovery fabric name. ,
Required: False ,
}
string ,
recoveryNetworkId:
{
Description: Recovery network Id. ,
Required: False ,
}
string ,
fabricSpecificDetails:
{
Description: Fabrics specific input network Id. ,
Required: False ,
}
{
instanceType:
{
Description: The instance type. ,
Required: True ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The Network Mapping Properties. ,
Required: False ,
}
{
state:
{
Description: The pairing state for network mapping. ,
Required: False ,
}
string ,
primaryNetworkFriendlyName:
{
Description: The primary network friendly name. ,
Required: False ,
}
string ,
primaryNetworkId:
{
Description: The primary network id for network mapping. ,
Required: False ,
}
string ,
primaryFabricFriendlyName:
{
Description: The primary fabric friendly name. ,
Required: False ,
}
string ,
recoveryNetworkFriendlyName:
{
Description: The recovery network friendly name. ,
Required: False ,
}
string ,
recoveryNetworkId:
{
Description: The recovery network id for network mapping. ,
Required: False ,
}
string ,
recoveryFabricArmId:
{
Description: The recovery fabric ARM id. ,
Required: False ,
}
string ,
recoveryFabricFriendlyName:
{
Description: The recovery fabric friendly name. ,
Required: False ,
}
string ,
fabricSpecificSettings:
{
Description: The fabric specific settings. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the Instance type. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{}
ReplicationProtectionContainers_ListByReplicationFabrics (new)
Description :  Lists the protection containers in the specified fabric.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Protection Container details. ,
Required: False ,
}
[
{
properties:
{
Description: The custom data. ,
Required: False ,
}
{
fabricFriendlyName:
{
Description: Fabric friendly name. ,
Required: False ,
}
string ,
friendlyName:
{
Description: The name. ,
Required: False ,
}
string ,
fabricType:
{
Description: The fabric type. ,
Required: False ,
}
string ,
protectedItemCount:
{
Description: Number of protected PEs. ,
Format: int32 ,
Required: False ,
}
integer ,
pairingStatus:
{
Description: The pairing status of this cloud. ,
Required: False ,
}
string ,
role:
{
Description: The role of this cloud. ,
Required: False ,
}
string ,
fabricSpecificDetails:
{
Description: Fabric specific details. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the class type. Overridden in derived classes. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The value of next link. ,
Required: False ,
}
string ,
}
ReplicationProtectionContainers_Get (new)
Description :  Gets the details of a protection container.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric name. ,
Required: True ,
}
string ,
protectionContainerName:
{
Description: Protection container name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The custom data. ,
Required: False ,
}
{
fabricFriendlyName:
{
Description: Fabric friendly name. ,
Required: False ,
}
string ,
friendlyName:
{
Description: The name. ,
Required: False ,
}
string ,
fabricType:
{
Description: The fabric type. ,
Required: False ,
}
string ,
protectedItemCount:
{
Description: Number of protected PEs. ,
Format: int32 ,
Required: False ,
}
integer ,
pairingStatus:
{
Description: The pairing status of this cloud. ,
Required: False ,
}
string ,
role:
{
Description: The role of this cloud. ,
Required: False ,
}
string ,
fabricSpecificDetails:
{
Description: Fabric specific details. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the class type. Overridden in derived classes. ,
Required: False ,
}
string ,
}
,
}
,
}
ReplicationProtectionContainers_Create (new)
Description :  Operation to create a protection container.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Unique fabric ARM name. ,
Required: True ,
}
string ,
protectionContainerName:
{
Description: Unique protection container ARM name. ,
Required: True ,
}
string ,
creationInput:
{
Description: Creation input. ,
Required: True ,
}
{
properties:
{
Description: Create protection container input properties. ,
Required: False ,
}
{
providerSpecificInput:
{
Description: Provider specific inputs for container creation. ,
Required: False ,
}
[
{
instanceType:
{
Description: The class type. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The custom data. ,
Required: False ,
}
{
fabricFriendlyName:
{
Description: Fabric friendly name. ,
Required: False ,
}
string ,
friendlyName:
{
Description: The name. ,
Required: False ,
}
string ,
fabricType:
{
Description: The fabric type. ,
Required: False ,
}
string ,
protectedItemCount:
{
Description: Number of protected PEs. ,
Format: int32 ,
Required: False ,
}
integer ,
pairingStatus:
{
Description: The pairing status of this cloud. ,
Required: False ,
}
string ,
role:
{
Description: The role of this cloud. ,
Required: False ,
}
string ,
fabricSpecificDetails:
{
Description: Fabric specific details. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the class type. Overridden in derived classes. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{}
ReplicationProtectionContainers_DiscoverProtectableItem (new)
Description :  The operation to a add a protectable item to a protection container(Add physical server).
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/discoverProtectableItem
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: The name of the fabric. ,
Required: True ,
}
string ,
protectionContainerName:
{
Description: The name of the protection container. ,
Required: True ,
}
string ,
discoverProtectableItemRequest:
{
Description: The request object to add a protectable item. ,
Required: True ,
}
{
properties:
{
Description: The properties of a discover protectable item request. ,
Required: False ,
}
{
friendlyName:
{
Description: The friendly name of the physical machine. ,
Required: False ,
}
string ,
ipAddress:
{
Description: The IP address of the physical machine to be discovered. ,
Required: False ,
}
string ,
osType:
{
Description: The OS type on the physical machine. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The custom data. ,
Required: False ,
}
{
fabricFriendlyName:
{
Description: Fabric friendly name. ,
Required: False ,
}
string ,
friendlyName:
{
Description: The name. ,
Required: False ,
}
string ,
fabricType:
{
Description: The fabric type. ,
Required: False ,
}
string ,
protectedItemCount:
{
Description: Number of protected PEs. ,
Format: int32 ,
Required: False ,
}
integer ,
pairingStatus:
{
Description: The pairing status of this cloud. ,
Required: False ,
}
string ,
role:
{
Description: The role of this cloud. ,
Required: False ,
}
string ,
fabricSpecificDetails:
{
Description: Fabric specific details. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the class type. Overridden in derived classes. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{}
ReplicationProtectionContainers_Delete (new)
Description :  Operation to remove a protection container.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/remove
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Unique fabric ARM name. ,
Required: True ,
}
string ,
protectionContainerName:
{
Description: Unique protection container ARM name. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
ReplicationMigrationItems_ListByReplicationProtectionContainers (new)
Description :  Gets the list of ASR migration items in the protection container.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationMigrationItems
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric name. ,
Required: True ,
}
string ,
protectionContainerName:
{
Description: Protection container name. ,
Required: True ,
}
string ,
skipToken:
{
Description: The pagination token. ,
Required: False ,
}
string ,
takeToken:
{
Description: The page size. ,
Required: False ,
}
string ,
$filter:
{
Description: OData filter options. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of migration items. ,
Required: False ,
}
[
{
properties:
{
Description: The migration item properties. ,
Required: False ,
}
{
machineName:
{
Description: The on-premise virtual machine name. ,
Required: False ,
}
string ,
policyId:
{
Description: The ARM Id of policy governing this item. ,
Required: False ,
}
string ,
policyFriendlyName:
{
Description: The name of policy governing this item. ,
Required: False ,
}
string ,
recoveryServicesProviderId:
{
Description: The recovery services provider ARM Id. ,
Required: False ,
}
string ,
replicationStatus:
{
Description: The replication status. ,
Required: False ,
}
string ,
migrationState:
{
Description: The migration status. ,
Enum:
{
None: No description available. ,
EnableMigrationInProgress: No description available. ,
EnableMigrationFailed: No description available. ,
DisableMigrationInProgress: No description available. ,
DisableMigrationFailed: No description available. ,
InitialSeedingInProgress: No description available. ,
InitialSeedingFailed: No description available. ,
Replicating: No description available. ,
MigrationInProgress: No description available. ,
MigrationSucceeded: No description available. ,
MigrationFailed: No description available. ,
ResumeInProgress: No description available. ,
ResumeInitiated: No description available. ,
SuspendingProtection: No description available. ,
ProtectionSuspended: No description available. ,
MigrationCompletedWithInformation: No description available. ,
MigrationPartiallySucceeded: No description available. ,
}
,
Required: False ,
}
enum ,
migrationStateDescription:
{
Description: The migration state description. ,
Required: False ,
}
string ,
lastTestMigrationTime:
{
Description: The last test migration time. ,
Format: date-time ,
Required: False ,
}
string ,
lastTestMigrationStatus:
{
Description: The status of the last test migration. ,
Required: False ,
}
string ,
lastMigrationTime:
{
Description: The last migration time. ,
Format: date-time ,
Required: False ,
}
string ,
lastMigrationStatus:
{
Description: The status of the last migration. ,
Required: False ,
}
string ,
testMigrateState:
{
Description: The test migrate state. ,
Enum:
{
None: No description available. ,
TestMigrationInProgress: No description available. ,
TestMigrationSucceeded: No description available. ,
TestMigrationFailed: No description available. ,
TestMigrationCleanupInProgress: No description available. ,
TestMigrationCompletedWithInformation: No description available. ,
TestMigrationPartiallySucceeded: No description available. ,
}
,
Required: False ,
}
enum ,
testMigrateStateDescription:
{
Description: The test migrate state description. ,
Required: False ,
}
string ,
health:
{
Description: The consolidated health. ,
Enum:
{
None: No description available. ,
Normal: No description available. ,
Warning: No description available. ,
Critical: No description available. ,
}
,
Required: False ,
}
enum ,
healthErrors:
{
Description: The list of health errors. ,
Required: False ,
}
[
{
innerHealthErrors:
{
Description: 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. ,
Required: False ,
}
[
{
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
allowedOperations:
{
Description: The allowed operations on the migration item based on the current migration state of the item. ,
Required: False ,
}
[
string ,
]
,
currentJob:
{
Description: The current job details. ,
Required: False ,
}
{
jobName:
{
Description: The job name. ,
Required: False ,
}
string ,
jobId:
{
Description: The ARM Id of the job being executed. ,
Required: False ,
}
string ,
startTime:
{
Description: The start time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
criticalJobHistory:
{
Description: The critical past job details. ,
Required: False ,
}
[
{
jobName:
{
Description: The job name. ,
Required: False ,
}
string ,
jobId:
{
Description: The ARM Id of the job being executed. ,
Required: False ,
}
string ,
startTime:
{
Description: The start time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
jobStatus:
{
Description: The job state. ,
Required: False ,
}
string ,
}
,
]
,
eventCorrelationId:
{
Description: The correlation Id for events associated with this migration item. ,
Required: False ,
}
string ,
providerSpecificDetails:
{
Description: The migration provider custom settings. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the instance type. ,
Required: True ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The value of next link. ,
Required: False ,
}
string ,
}
ReplicationMigrationItems_Get (new)
Description :  Gets the details of a migration item.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationMigrationItems/{migrationItemName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric unique name. ,
Required: True ,
}
string ,
protectionContainerName:
{
Description: Protection container name. ,
Required: True ,
}
string ,
migrationItemName:
{
Description: Migration item name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The migration item properties. ,
Required: False ,
}
{
machineName:
{
Description: The on-premise virtual machine name. ,
Required: False ,
}
string ,
policyId:
{
Description: The ARM Id of policy governing this item. ,
Required: False ,
}
string ,
policyFriendlyName:
{
Description: The name of policy governing this item. ,
Required: False ,
}
string ,
recoveryServicesProviderId:
{
Description: The recovery services provider ARM Id. ,
Required: False ,
}
string ,
replicationStatus:
{
Description: The replication status. ,
Required: False ,
}
string ,
migrationState:
{
Description: The migration status. ,
Enum:
{
None: No description available. ,
EnableMigrationInProgress: No description available. ,
EnableMigrationFailed: No description available. ,
DisableMigrationInProgress: No description available. ,
DisableMigrationFailed: No description available. ,
InitialSeedingInProgress: No description available. ,
InitialSeedingFailed: No description available. ,
Replicating: No description available. ,
MigrationInProgress: No description available. ,
MigrationSucceeded: No description available. ,
MigrationFailed: No description available. ,
ResumeInProgress: No description available. ,
ResumeInitiated: No description available. ,
SuspendingProtection: No description available. ,
ProtectionSuspended: No description available. ,
MigrationCompletedWithInformation: No description available. ,
MigrationPartiallySucceeded: No description available. ,
}
,
Required: False ,
}
enum ,
migrationStateDescription:
{
Description: The migration state description. ,
Required: False ,
}
string ,
lastTestMigrationTime:
{
Description: The last test migration time. ,
Format: date-time ,
Required: False ,
}
string ,
lastTestMigrationStatus:
{
Description: The status of the last test migration. ,
Required: False ,
}
string ,
lastMigrationTime:
{
Description: The last migration time. ,
Format: date-time ,
Required: False ,
}
string ,
lastMigrationStatus:
{
Description: The status of the last migration. ,
Required: False ,
}
string ,
testMigrateState:
{
Description: The test migrate state. ,
Enum:
{
None: No description available. ,
TestMigrationInProgress: No description available. ,
TestMigrationSucceeded: No description available. ,
TestMigrationFailed: No description available. ,
TestMigrationCleanupInProgress: No description available. ,
TestMigrationCompletedWithInformation: No description available. ,
TestMigrationPartiallySucceeded: No description available. ,
}
,
Required: False ,
}
enum ,
testMigrateStateDescription:
{
Description: The test migrate state description. ,
Required: False ,
}
string ,
health:
{
Description: The consolidated health. ,
Enum:
{
None: No description available. ,
Normal: No description available. ,
Warning: No description available. ,
Critical: No description available. ,
}
,
Required: False ,
}
enum ,
healthErrors:
{
Description: The list of health errors. ,
Required: False ,
}
[
{
innerHealthErrors:
{
Description: 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. ,
Required: False ,
}
[
{
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
allowedOperations:
{
Description: The allowed operations on the migration item based on the current migration state of the item. ,
Required: False ,
}
[
string ,
]
,
currentJob:
{
Description: The current job details. ,
Required: False ,
}
{
jobName:
{
Description: The job name. ,
Required: False ,
}
string ,
jobId:
{
Description: The ARM Id of the job being executed. ,
Required: False ,
}
string ,
startTime:
{
Description: The start time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
criticalJobHistory:
{
Description: The critical past job details. ,
Required: False ,
}
[
{
jobName:
{
Description: The job name. ,
Required: False ,
}
string ,
jobId:
{
Description: The ARM Id of the job being executed. ,
Required: False ,
}
string ,
startTime:
{
Description: The start time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
jobStatus:
{
Description: The job state. ,
Required: False ,
}
string ,
}
,
]
,
eventCorrelationId:
{
Description: The correlation Id for events associated with this migration item. ,
Required: False ,
}
string ,
providerSpecificDetails:
{
Description: The migration provider custom settings. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the instance type. ,
Required: True ,
}
string ,
}
,
}
,
}
ReplicationMigrationItems_Create (new)
Description :  The operation to create an ASR migration item (enable migration).
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationMigrationItems/{migrationItemName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric name. ,
Required: True ,
}
string ,
protectionContainerName:
{
Description: Protection container name. ,
Required: True ,
}
string ,
migrationItemName:
{
Description: Migration item name. ,
Required: True ,
}
string ,
input:
{
Description: Enable migration input. ,
Required: True ,
}
{
properties:
{
Description: Enable migration input properties. ,
Required: True ,
}
{
policyId:
{
Description: The policy Id. ,
Required: True ,
}
string ,
providerSpecificDetails:
{
Description: The provider specific details. ,
Required: True ,
}
{
instanceType:
{
Description: The class type. ,
Required: True ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The migration item properties. ,
Required: False ,
}
{
machineName:
{
Description: The on-premise virtual machine name. ,
Required: False ,
}
string ,
policyId:
{
Description: The ARM Id of policy governing this item. ,
Required: False ,
}
string ,
policyFriendlyName:
{
Description: The name of policy governing this item. ,
Required: False ,
}
string ,
recoveryServicesProviderId:
{
Description: The recovery services provider ARM Id. ,
Required: False ,
}
string ,
replicationStatus:
{
Description: The replication status. ,
Required: False ,
}
string ,
migrationState:
{
Description: The migration status. ,
Enum:
{
None: No description available. ,
EnableMigrationInProgress: No description available. ,
EnableMigrationFailed: No description available. ,
DisableMigrationInProgress: No description available. ,
DisableMigrationFailed: No description available. ,
InitialSeedingInProgress: No description available. ,
InitialSeedingFailed: No description available. ,
Replicating: No description available. ,
MigrationInProgress: No description available. ,
MigrationSucceeded: No description available. ,
MigrationFailed: No description available. ,
ResumeInProgress: No description available. ,
ResumeInitiated: No description available. ,
SuspendingProtection: No description available. ,
ProtectionSuspended: No description available. ,
MigrationCompletedWithInformation: No description available. ,
MigrationPartiallySucceeded: No description available. ,
}
,
Required: False ,
}
enum ,
migrationStateDescription:
{
Description: The migration state description. ,
Required: False ,
}
string ,
lastTestMigrationTime:
{
Description: The last test migration time. ,
Format: date-time ,
Required: False ,
}
string ,
lastTestMigrationStatus:
{
Description: The status of the last test migration. ,
Required: False ,
}
string ,
lastMigrationTime:
{
Description: The last migration time. ,
Format: date-time ,
Required: False ,
}
string ,
lastMigrationStatus:
{
Description: The status of the last migration. ,
Required: False ,
}
string ,
testMigrateState:
{
Description: The test migrate state. ,
Enum:
{
None: No description available. ,
TestMigrationInProgress: No description available. ,
TestMigrationSucceeded: No description available. ,
TestMigrationFailed: No description available. ,
TestMigrationCleanupInProgress: No description available. ,
TestMigrationCompletedWithInformation: No description available. ,
TestMigrationPartiallySucceeded: No description available. ,
}
,
Required: False ,
}
enum ,
testMigrateStateDescription:
{
Description: The test migrate state description. ,
Required: False ,
}
string ,
health:
{
Description: The consolidated health. ,
Enum:
{
None: No description available. ,
Normal: No description available. ,
Warning: No description available. ,
Critical: No description available. ,
}
,
Required: False ,
}
enum ,
healthErrors:
{
Description: The list of health errors. ,
Required: False ,
}
[
{
innerHealthErrors:
{
Description: 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. ,
Required: False ,
}
[
{
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
allowedOperations:
{
Description: The allowed operations on the migration item based on the current migration state of the item. ,
Required: False ,
}
[
string ,
]
,
currentJob:
{
Description: The current job details. ,
Required: False ,
}
{
jobName:
{
Description: The job name. ,
Required: False ,
}
string ,
jobId:
{
Description: The ARM Id of the job being executed. ,
Required: False ,
}
string ,
startTime:
{
Description: The start time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
criticalJobHistory:
{
Description: The critical past job details. ,
Required: False ,
}
[
{
jobName:
{
Description: The job name. ,
Required: False ,
}
string ,
jobId:
{
Description: The ARM Id of the job being executed. ,
Required: False ,
}
string ,
startTime:
{
Description: The start time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
jobStatus:
{
Description: The job state. ,
Required: False ,
}
string ,
}
,
]
,
eventCorrelationId:
{
Description: The correlation Id for events associated with this migration item. ,
Required: False ,
}
string ,
providerSpecificDetails:
{
Description: The migration provider custom settings. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the instance type. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{}
ReplicationMigrationItems_Delete (new)
Description :  The operation to delete an ASR migration item.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationMigrationItems/{migrationItemName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric name. ,
Required: True ,
}
string ,
protectionContainerName:
{
Description: Protection container name. ,
Required: True ,
}
string ,
migrationItemName:
{
Description: Migration item name. ,
Required: True ,
}
string ,
deleteOption:
{
Description: The delete option. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
ReplicationMigrationItems_Update (new)
Description :  The operation to update the recovery settings of an ASR migration item.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationMigrationItems/{migrationItemName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric name. ,
Required: True ,
}
string ,
protectionContainerName:
{
Description: Protection container name. ,
Required: True ,
}
string ,
migrationItemName:
{
Description: Migration item name. ,
Required: True ,
}
string ,
input:
{
Description: Update migration item input. ,
Required: True ,
}
{
properties:
{
Description: Update migration item input properties. ,
Required: False ,
}
{
providerSpecificDetails:
{
Description: The provider specific input to update migration item. ,
Required: True ,
}
{
instanceType:
{
Description: The class type. ,
Required: True ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The migration item properties. ,
Required: False ,
}
{
machineName:
{
Description: The on-premise virtual machine name. ,
Required: False ,
}
string ,
policyId:
{
Description: The ARM Id of policy governing this item. ,
Required: False ,
}
string ,
policyFriendlyName:
{
Description: The name of policy governing this item. ,
Required: False ,
}
string ,
recoveryServicesProviderId:
{
Description: The recovery services provider ARM Id. ,
Required: False ,
}
string ,
replicationStatus:
{
Description: The replication status. ,
Required: False ,
}
string ,
migrationState:
{
Description: The migration status. ,
Enum:
{
None: No description available. ,
EnableMigrationInProgress: No description available. ,
EnableMigrationFailed: No description available. ,
DisableMigrationInProgress: No description available. ,
DisableMigrationFailed: No description available. ,
InitialSeedingInProgress: No description available. ,
InitialSeedingFailed: No description available. ,
Replicating: No description available. ,
MigrationInProgress: No description available. ,
MigrationSucceeded: No description available. ,
MigrationFailed: No description available. ,
ResumeInProgress: No description available. ,
ResumeInitiated: No description available. ,
SuspendingProtection: No description available. ,
ProtectionSuspended: No description available. ,
MigrationCompletedWithInformation: No description available. ,
MigrationPartiallySucceeded: No description available. ,
}
,
Required: False ,
}
enum ,
migrationStateDescription:
{
Description: The migration state description. ,
Required: False ,
}
string ,
lastTestMigrationTime:
{
Description: The last test migration time. ,
Format: date-time ,
Required: False ,
}
string ,
lastTestMigrationStatus:
{
Description: The status of the last test migration. ,
Required: False ,
}
string ,
lastMigrationTime:
{
Description: The last migration time. ,
Format: date-time ,
Required: False ,
}
string ,
lastMigrationStatus:
{
Description: The status of the last migration. ,
Required: False ,
}
string ,
testMigrateState:
{
Description: The test migrate state. ,
Enum:
{
None: No description available. ,
TestMigrationInProgress: No description available. ,
TestMigrationSucceeded: No description available. ,
TestMigrationFailed: No description available. ,
TestMigrationCleanupInProgress: No description available. ,
TestMigrationCompletedWithInformation: No description available. ,
TestMigrationPartiallySucceeded: No description available. ,
}
,
Required: False ,
}
enum ,
testMigrateStateDescription:
{
Description: The test migrate state description. ,
Required: False ,
}
string ,
health:
{
Description: The consolidated health. ,
Enum:
{
None: No description available. ,
Normal: No description available. ,
Warning: No description available. ,
Critical: No description available. ,
}
,
Required: False ,
}
enum ,
healthErrors:
{
Description: The list of health errors. ,
Required: False ,
}
[
{
innerHealthErrors:
{
Description: 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. ,
Required: False ,
}
[
{
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
allowedOperations:
{
Description: The allowed operations on the migration item based on the current migration state of the item. ,
Required: False ,
}
[
string ,
]
,
currentJob:
{
Description: The current job details. ,
Required: False ,
}
{
jobName:
{
Description: The job name. ,
Required: False ,
}
string ,
jobId:
{
Description: The ARM Id of the job being executed. ,
Required: False ,
}
string ,
startTime:
{
Description: The start time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
criticalJobHistory:
{
Description: The critical past job details. ,
Required: False ,
}
[
{
jobName:
{
Description: The job name. ,
Required: False ,
}
string ,
jobId:
{
Description: The ARM Id of the job being executed. ,
Required: False ,
}
string ,
startTime:
{
Description: The start time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
jobStatus:
{
Description: The job state. ,
Required: False ,
}
string ,
}
,
]
,
eventCorrelationId:
{
Description: The correlation Id for events associated with this migration item. ,
Required: False ,
}
string ,
providerSpecificDetails:
{
Description: The migration provider custom settings. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the instance type. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{}
ReplicationMigrationItems_Migrate (new)
Description :  The operation to initiate migration of the item.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationMigrationItems/{migrationItemName}/migrate
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric name. ,
Required: True ,
}
string ,
protectionContainerName:
{
Description: Protection container name. ,
Required: True ,
}
string ,
migrationItemName:
{
Description: Migration item name. ,
Required: True ,
}
string ,
migrateInput:
{
Description: Migrate input. ,
Required: True ,
}
{
properties:
{
Description: Migrate input properties. ,
Required: True ,
}
{
providerSpecificDetails:
{
Description: The provider specific details. ,
Required: True ,
}
{
instanceType:
{
Description: The class type. ,
Required: True ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The migration item properties. ,
Required: False ,
}
{
machineName:
{
Description: The on-premise virtual machine name. ,
Required: False ,
}
string ,
policyId:
{
Description: The ARM Id of policy governing this item. ,
Required: False ,
}
string ,
policyFriendlyName:
{
Description: The name of policy governing this item. ,
Required: False ,
}
string ,
recoveryServicesProviderId:
{
Description: The recovery services provider ARM Id. ,
Required: False ,
}
string ,
replicationStatus:
{
Description: The replication status. ,
Required: False ,
}
string ,
migrationState:
{
Description: The migration status. ,
Enum:
{
None: No description available. ,
EnableMigrationInProgress: No description available. ,
EnableMigrationFailed: No description available. ,
DisableMigrationInProgress: No description available. ,
DisableMigrationFailed: No description available. ,
InitialSeedingInProgress: No description available. ,
InitialSeedingFailed: No description available. ,
Replicating: No description available. ,
MigrationInProgress: No description available. ,
MigrationSucceeded: No description available. ,
MigrationFailed: No description available. ,
ResumeInProgress: No description available. ,
ResumeInitiated: No description available. ,
SuspendingProtection: No description available. ,
ProtectionSuspended: No description available. ,
MigrationCompletedWithInformation: No description available. ,
MigrationPartiallySucceeded: No description available. ,
}
,
Required: False ,
}
enum ,
migrationStateDescription:
{
Description: The migration state description. ,
Required: False ,
}
string ,
lastTestMigrationTime:
{
Description: The last test migration time. ,
Format: date-time ,
Required: False ,
}
string ,
lastTestMigrationStatus:
{
Description: The status of the last test migration. ,
Required: False ,
}
string ,
lastMigrationTime:
{
Description: The last migration time. ,
Format: date-time ,
Required: False ,
}
string ,
lastMigrationStatus:
{
Description: The status of the last migration. ,
Required: False ,
}
string ,
testMigrateState:
{
Description: The test migrate state. ,
Enum:
{
None: No description available. ,
TestMigrationInProgress: No description available. ,
TestMigrationSucceeded: No description available. ,
TestMigrationFailed: No description available. ,
TestMigrationCleanupInProgress: No description available. ,
TestMigrationCompletedWithInformation: No description available. ,
TestMigrationPartiallySucceeded: No description available. ,
}
,
Required: False ,
}
enum ,
testMigrateStateDescription:
{
Description: The test migrate state description. ,
Required: False ,
}
string ,
health:
{
Description: The consolidated health. ,
Enum:
{
None: No description available. ,
Normal: No description available. ,
Warning: No description available. ,
Critical: No description available. ,
}
,
Required: False ,
}
enum ,
healthErrors:
{
Description: The list of health errors. ,
Required: False ,
}
[
{
innerHealthErrors:
{
Description: 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. ,
Required: False ,
}
[
{
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
allowedOperations:
{
Description: The allowed operations on the migration item based on the current migration state of the item. ,
Required: False ,
}
[
string ,
]
,
currentJob:
{
Description: The current job details. ,
Required: False ,
}
{
jobName:
{
Description: The job name. ,
Required: False ,
}
string ,
jobId:
{
Description: The ARM Id of the job being executed. ,
Required: False ,
}
string ,
startTime:
{
Description: The start time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
criticalJobHistory:
{
Description: The critical past job details. ,
Required: False ,
}
[
{
jobName:
{
Description: The job name. ,
Required: False ,
}
string ,
jobId:
{
Description: The ARM Id of the job being executed. ,
Required: False ,
}
string ,
startTime:
{
Description: The start time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
jobStatus:
{
Description: The job state. ,
Required: False ,
}
string ,
}
,
]
,
eventCorrelationId:
{
Description: The correlation Id for events associated with this migration item. ,
Required: False ,
}
string ,
providerSpecificDetails:
{
Description: The migration provider custom settings. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the instance type. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{}
MigrationRecoveryPoints_ListByReplicationMigrationItems (new)
Description :  Gets the recovery points for a migration item.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationMigrationItems/{migrationItemName}/migrationRecoveryPoints
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric unique name. ,
Required: True ,
}
string ,
protectionContainerName:
{
Description: Protection container name. ,
Required: True ,
}
string ,
migrationItemName:
{
Description: Migration item name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The migration recovery point details. ,
Required: False ,
}
[
{
properties:
{
Description: Recovery point properties. ,
Required: False ,
}
{
recoveryPointTime:
{
Description: The recovery point time. ,
Format: date-time ,
Required: False ,
}
string ,
recoveryPointType:
{
Description: The recovery point type. ,
Enum:
{
NotSpecified: No description available. ,
ApplicationConsistent: No description available. ,
CrashConsistent: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The value of next link. ,
Required: False ,
}
string ,
}
MigrationRecoveryPoints_Get (new)
Description :  Gets a recovery point for a migration item.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationMigrationItems/{migrationItemName}/migrationRecoveryPoints/{migrationRecoveryPointName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric unique name. ,
Required: True ,
}
string ,
protectionContainerName:
{
Description: Protection container name. ,
Required: True ,
}
string ,
migrationItemName:
{
Description: Migration item name. ,
Required: True ,
}
string ,
migrationRecoveryPointName:
{
Description: The migration recovery point name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Recovery point properties. ,
Required: False ,
}
{
recoveryPointTime:
{
Description: The recovery point time. ,
Format: date-time ,
Required: False ,
}
string ,
recoveryPointType:
{
Description: The recovery point type. ,
Enum:
{
NotSpecified: No description available. ,
ApplicationConsistent: No description available. ,
CrashConsistent: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
ReplicationMigrationItems_PauseReplication (new)
Description :  The operation to initiate pause replication of the item.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationMigrationItems/{migrationItemName}/pauseReplication
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric name. ,
Required: True ,
}
string ,
protectionContainerName:
{
Description: Protection container name. ,
Required: True ,
}
string ,
migrationItemName:
{
Description: Migration item name. ,
Required: True ,
}
string ,
pauseReplicationInput:
{
Description: Pause replication input. ,
Required: True ,
}
{
properties:
{
Description: Pause replication input properties. ,
Required: True ,
}
{
instanceType:
{
Description: The class type. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The migration item properties. ,
Required: False ,
}
{
machineName:
{
Description: The on-premise virtual machine name. ,
Required: False ,
}
string ,
policyId:
{
Description: The ARM Id of policy governing this item. ,
Required: False ,
}
string ,
policyFriendlyName:
{
Description: The name of policy governing this item. ,
Required: False ,
}
string ,
recoveryServicesProviderId:
{
Description: The recovery services provider ARM Id. ,
Required: False ,
}
string ,
replicationStatus:
{
Description: The replication status. ,
Required: False ,
}
string ,
migrationState:
{
Description: The migration status. ,
Enum:
{
None: No description available. ,
EnableMigrationInProgress: No description available. ,
EnableMigrationFailed: No description available. ,
DisableMigrationInProgress: No description available. ,
DisableMigrationFailed: No description available. ,
InitialSeedingInProgress: No description available. ,
InitialSeedingFailed: No description available. ,
Replicating: No description available. ,
MigrationInProgress: No description available. ,
MigrationSucceeded: No description available. ,
MigrationFailed: No description available. ,
ResumeInProgress: No description available. ,
ResumeInitiated: No description available. ,
SuspendingProtection: No description available. ,
ProtectionSuspended: No description available. ,
MigrationCompletedWithInformation: No description available. ,
MigrationPartiallySucceeded: No description available. ,
}
,
Required: False ,
}
enum ,
migrationStateDescription:
{
Description: The migration state description. ,
Required: False ,
}
string ,
lastTestMigrationTime:
{
Description: The last test migration time. ,
Format: date-time ,
Required: False ,
}
string ,
lastTestMigrationStatus:
{
Description: The status of the last test migration. ,
Required: False ,
}
string ,
lastMigrationTime:
{
Description: The last migration time. ,
Format: date-time ,
Required: False ,
}
string ,
lastMigrationStatus:
{
Description: The status of the last migration. ,
Required: False ,
}
string ,
testMigrateState:
{
Description: The test migrate state. ,
Enum:
{
None: No description available. ,
TestMigrationInProgress: No description available. ,
TestMigrationSucceeded: No description available. ,
TestMigrationFailed: No description available. ,
TestMigrationCleanupInProgress: No description available. ,
TestMigrationCompletedWithInformation: No description available. ,
TestMigrationPartiallySucceeded: No description available. ,
}
,
Required: False ,
}
enum ,
testMigrateStateDescription:
{
Description: The test migrate state description. ,
Required: False ,
}
string ,
health:
{
Description: The consolidated health. ,
Enum:
{
None: No description available. ,
Normal: No description available. ,
Warning: No description available. ,
Critical: No description available. ,
}
,
Required: False ,
}
enum ,
healthErrors:
{
Description: The list of health errors. ,
Required: False ,
}
[
{
innerHealthErrors:
{
Description: 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. ,
Required: False ,
}
[
{
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
allowedOperations:
{
Description: The allowed operations on the migration item based on the current migration state of the item. ,
Required: False ,
}
[
string ,
]
,
currentJob:
{
Description: The current job details. ,
Required: False ,
}
{
jobName:
{
Description: The job name. ,
Required: False ,
}
string ,
jobId:
{
Description: The ARM Id of the job being executed. ,
Required: False ,
}
string ,
startTime:
{
Description: The start time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
criticalJobHistory:
{
Description: The critical past job details. ,
Required: False ,
}
[
{
jobName:
{
Description: The job name. ,
Required: False ,
}
string ,
jobId:
{
Description: The ARM Id of the job being executed. ,
Required: False ,
}
string ,
startTime:
{
Description: The start time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
jobStatus:
{
Description: The job state. ,
Required: False ,
}
string ,
}
,
]
,
eventCorrelationId:
{
Description: The correlation Id for events associated with this migration item. ,
Required: False ,
}
string ,
providerSpecificDetails:
{
Description: The migration provider custom settings. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the instance type. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{}
ReplicationMigrationItems_ResumeReplication (new)
Description :  The operation to initiate resume replication of the item.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationMigrationItems/{migrationItemName}/resumeReplication
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric name. ,
Required: True ,
}
string ,
protectionContainerName:
{
Description: Protection container name. ,
Required: True ,
}
string ,
migrationItemName:
{
Description: Migration item name. ,
Required: True ,
}
string ,
resumeReplicationInput:
{
Description: Resume replication input. ,
Required: True ,
}
{
properties:
{
Description: Resume replication input properties. ,
Required: True ,
}
{
providerSpecificDetails:
{
Description: The provider specific input for resume replication. ,
Required: True ,
}
{
instanceType:
{
Description: The class type. ,
Required: True ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The migration item properties. ,
Required: False ,
}
{
machineName:
{
Description: The on-premise virtual machine name. ,
Required: False ,
}
string ,
policyId:
{
Description: The ARM Id of policy governing this item. ,
Required: False ,
}
string ,
policyFriendlyName:
{
Description: The name of policy governing this item. ,
Required: False ,
}
string ,
recoveryServicesProviderId:
{
Description: The recovery services provider ARM Id. ,
Required: False ,
}
string ,
replicationStatus:
{
Description: The replication status. ,
Required: False ,
}
string ,
migrationState:
{
Description: The migration status. ,
Enum:
{
None: No description available. ,
EnableMigrationInProgress: No description available. ,
EnableMigrationFailed: No description available. ,
DisableMigrationInProgress: No description available. ,
DisableMigrationFailed: No description available. ,
InitialSeedingInProgress: No description available. ,
InitialSeedingFailed: No description available. ,
Replicating: No description available. ,
MigrationInProgress: No description available. ,
MigrationSucceeded: No description available. ,
MigrationFailed: No description available. ,
ResumeInProgress: No description available. ,
ResumeInitiated: No description available. ,
SuspendingProtection: No description available. ,
ProtectionSuspended: No description available. ,
MigrationCompletedWithInformation: No description available. ,
MigrationPartiallySucceeded: No description available. ,
}
,
Required: False ,
}
enum ,
migrationStateDescription:
{
Description: The migration state description. ,
Required: False ,
}
string ,
lastTestMigrationTime:
{
Description: The last test migration time. ,
Format: date-time ,
Required: False ,
}
string ,
lastTestMigrationStatus:
{
Description: The status of the last test migration. ,
Required: False ,
}
string ,
lastMigrationTime:
{
Description: The last migration time. ,
Format: date-time ,
Required: False ,
}
string ,
lastMigrationStatus:
{
Description: The status of the last migration. ,
Required: False ,
}
string ,
testMigrateState:
{
Description: The test migrate state. ,
Enum:
{
None: No description available. ,
TestMigrationInProgress: No description available. ,
TestMigrationSucceeded: No description available. ,
TestMigrationFailed: No description available. ,
TestMigrationCleanupInProgress: No description available. ,
TestMigrationCompletedWithInformation: No description available. ,
TestMigrationPartiallySucceeded: No description available. ,
}
,
Required: False ,
}
enum ,
testMigrateStateDescription:
{
Description: The test migrate state description. ,
Required: False ,
}
string ,
health:
{
Description: The consolidated health. ,
Enum:
{
None: No description available. ,
Normal: No description available. ,
Warning: No description available. ,
Critical: No description available. ,
}
,
Required: False ,
}
enum ,
healthErrors:
{
Description: The list of health errors. ,
Required: False ,
}
[
{
innerHealthErrors:
{
Description: 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. ,
Required: False ,
}
[
{
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
allowedOperations:
{
Description: The allowed operations on the migration item based on the current migration state of the item. ,
Required: False ,
}
[
string ,
]
,
currentJob:
{
Description: The current job details. ,
Required: False ,
}
{
jobName:
{
Description: The job name. ,
Required: False ,
}
string ,
jobId:
{
Description: The ARM Id of the job being executed. ,
Required: False ,
}
string ,
startTime:
{
Description: The start time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
criticalJobHistory:
{
Description: The critical past job details. ,
Required: False ,
}
[
{
jobName:
{
Description: The job name. ,
Required: False ,
}
string ,
jobId:
{
Description: The ARM Id of the job being executed. ,
Required: False ,
}
string ,
startTime:
{
Description: The start time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
jobStatus:
{
Description: The job state. ,
Required: False ,
}
string ,
}
,
]
,
eventCorrelationId:
{
Description: The correlation Id for events associated with this migration item. ,
Required: False ,
}
string ,
providerSpecificDetails:
{
Description: The migration provider custom settings. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the instance type. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{}
ReplicationMigrationItems_Resync (new)
Description :  The operation to resynchronize replication of an ASR migration item.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationMigrationItems/{migrationItemName}/resync
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric name. ,
Required: True ,
}
string ,
protectionContainerName:
{
Description: Protection container name. ,
Required: True ,
}
string ,
migrationItemName:
{
Description: Migration item name. ,
Required: True ,
}
string ,
input:
{
Description: Resync input. ,
Required: True ,
}
{
properties:
{
Description: Resync input properties. ,
Required: True ,
}
{
providerSpecificDetails:
{
Description: The provider specific details. ,
Required: True ,
}
{
instanceType:
{
Description: The class type. ,
Required: True ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The migration item properties. ,
Required: False ,
}
{
machineName:
{
Description: The on-premise virtual machine name. ,
Required: False ,
}
string ,
policyId:
{
Description: The ARM Id of policy governing this item. ,
Required: False ,
}
string ,
policyFriendlyName:
{
Description: The name of policy governing this item. ,
Required: False ,
}
string ,
recoveryServicesProviderId:
{
Description: The recovery services provider ARM Id. ,
Required: False ,
}
string ,
replicationStatus:
{
Description: The replication status. ,
Required: False ,
}
string ,
migrationState:
{
Description: The migration status. ,
Enum:
{
None: No description available. ,
EnableMigrationInProgress: No description available. ,
EnableMigrationFailed: No description available. ,
DisableMigrationInProgress: No description available. ,
DisableMigrationFailed: No description available. ,
InitialSeedingInProgress: No description available. ,
InitialSeedingFailed: No description available. ,
Replicating: No description available. ,
MigrationInProgress: No description available. ,
MigrationSucceeded: No description available. ,
MigrationFailed: No description available. ,
ResumeInProgress: No description available. ,
ResumeInitiated: No description available. ,
SuspendingProtection: No description available. ,
ProtectionSuspended: No description available. ,
MigrationCompletedWithInformation: No description available. ,
MigrationPartiallySucceeded: No description available. ,
}
,
Required: False ,
}
enum ,
migrationStateDescription:
{
Description: The migration state description. ,
Required: False ,
}
string ,
lastTestMigrationTime:
{
Description: The last test migration time. ,
Format: date-time ,
Required: False ,
}
string ,
lastTestMigrationStatus:
{
Description: The status of the last test migration. ,
Required: False ,
}
string ,
lastMigrationTime:
{
Description: The last migration time. ,
Format: date-time ,
Required: False ,
}
string ,
lastMigrationStatus:
{
Description: The status of the last migration. ,
Required: False ,
}
string ,
testMigrateState:
{
Description: The test migrate state. ,
Enum:
{
None: No description available. ,
TestMigrationInProgress: No description available. ,
TestMigrationSucceeded: No description available. ,
TestMigrationFailed: No description available. ,
TestMigrationCleanupInProgress: No description available. ,
TestMigrationCompletedWithInformation: No description available. ,
TestMigrationPartiallySucceeded: No description available. ,
}
,
Required: False ,
}
enum ,
testMigrateStateDescription:
{
Description: The test migrate state description. ,
Required: False ,
}
string ,
health:
{
Description: The consolidated health. ,
Enum:
{
None: No description available. ,
Normal: No description available. ,
Warning: No description available. ,
Critical: No description available. ,
}
,
Required: False ,
}
enum ,
healthErrors:
{
Description: The list of health errors. ,
Required: False ,
}
[
{
innerHealthErrors:
{
Description: 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. ,
Required: False ,
}
[
{
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
allowedOperations:
{
Description: The allowed operations on the migration item based on the current migration state of the item. ,
Required: False ,
}
[
string ,
]
,
currentJob:
{
Description: The current job details. ,
Required: False ,
}
{
jobName:
{
Description: The job name. ,
Required: False ,
}
string ,
jobId:
{
Description: The ARM Id of the job being executed. ,
Required: False ,
}
string ,
startTime:
{
Description: The start time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
criticalJobHistory:
{
Description: The critical past job details. ,
Required: False ,
}
[
{
jobName:
{
Description: The job name. ,
Required: False ,
}
string ,
jobId:
{
Description: The ARM Id of the job being executed. ,
Required: False ,
}
string ,
startTime:
{
Description: The start time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
jobStatus:
{
Description: The job state. ,
Required: False ,
}
string ,
}
,
]
,
eventCorrelationId:
{
Description: The correlation Id for events associated with this migration item. ,
Required: False ,
}
string ,
providerSpecificDetails:
{
Description: The migration provider custom settings. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the instance type. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{}
ReplicationMigrationItems_TestMigrate (new)
Description :  The operation to initiate test migration of the item.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationMigrationItems/{migrationItemName}/testMigrate
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric name. ,
Required: True ,
}
string ,
protectionContainerName:
{
Description: Protection container name. ,
Required: True ,
}
string ,
migrationItemName:
{
Description: Migration item name. ,
Required: True ,
}
string ,
testMigrateInput:
{
Description: Test migrate input. ,
Required: True ,
}
{
properties:
{
Description: Test migrate input properties. ,
Required: True ,
}
{
providerSpecificDetails:
{
Description: The provider specific details. ,
Required: True ,
}
{
instanceType:
{
Description: The class type. ,
Required: True ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The migration item properties. ,
Required: False ,
}
{
machineName:
{
Description: The on-premise virtual machine name. ,
Required: False ,
}
string ,
policyId:
{
Description: The ARM Id of policy governing this item. ,
Required: False ,
}
string ,
policyFriendlyName:
{
Description: The name of policy governing this item. ,
Required: False ,
}
string ,
recoveryServicesProviderId:
{
Description: The recovery services provider ARM Id. ,
Required: False ,
}
string ,
replicationStatus:
{
Description: The replication status. ,
Required: False ,
}
string ,
migrationState:
{
Description: The migration status. ,
Enum:
{
None: No description available. ,
EnableMigrationInProgress: No description available. ,
EnableMigrationFailed: No description available. ,
DisableMigrationInProgress: No description available. ,
DisableMigrationFailed: No description available. ,
InitialSeedingInProgress: No description available. ,
InitialSeedingFailed: No description available. ,
Replicating: No description available. ,
MigrationInProgress: No description available. ,
MigrationSucceeded: No description available. ,
MigrationFailed: No description available. ,
ResumeInProgress: No description available. ,
ResumeInitiated: No description available. ,
SuspendingProtection: No description available. ,
ProtectionSuspended: No description available. ,
MigrationCompletedWithInformation: No description available. ,
MigrationPartiallySucceeded: No description available. ,
}
,
Required: False ,
}
enum ,
migrationStateDescription:
{
Description: The migration state description. ,
Required: False ,
}
string ,
lastTestMigrationTime:
{
Description: The last test migration time. ,
Format: date-time ,
Required: False ,
}
string ,
lastTestMigrationStatus:
{
Description: The status of the last test migration. ,
Required: False ,
}
string ,
lastMigrationTime:
{
Description: The last migration time. ,
Format: date-time ,
Required: False ,
}
string ,
lastMigrationStatus:
{
Description: The status of the last migration. ,
Required: False ,
}
string ,
testMigrateState:
{
Description: The test migrate state. ,
Enum:
{
None: No description available. ,
TestMigrationInProgress: No description available. ,
TestMigrationSucceeded: No description available. ,
TestMigrationFailed: No description available. ,
TestMigrationCleanupInProgress: No description available. ,
TestMigrationCompletedWithInformation: No description available. ,
TestMigrationPartiallySucceeded: No description available. ,
}
,
Required: False ,
}
enum ,
testMigrateStateDescription:
{
Description: The test migrate state description. ,
Required: False ,
}
string ,
health:
{
Description: The consolidated health. ,
Enum:
{
None: No description available. ,
Normal: No description available. ,
Warning: No description available. ,
Critical: No description available. ,
}
,
Required: False ,
}
enum ,
healthErrors:
{
Description: The list of health errors. ,
Required: False ,
}
[
{
innerHealthErrors:
{
Description: 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. ,
Required: False ,
}
[
{
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
allowedOperations:
{
Description: The allowed operations on the migration item based on the current migration state of the item. ,
Required: False ,
}
[
string ,
]
,
currentJob:
{
Description: The current job details. ,
Required: False ,
}
{
jobName:
{
Description: The job name. ,
Required: False ,
}
string ,
jobId:
{
Description: The ARM Id of the job being executed. ,
Required: False ,
}
string ,
startTime:
{
Description: The start time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
criticalJobHistory:
{
Description: The critical past job details. ,
Required: False ,
}
[
{
jobName:
{
Description: The job name. ,
Required: False ,
}
string ,
jobId:
{
Description: The ARM Id of the job being executed. ,
Required: False ,
}
string ,
startTime:
{
Description: The start time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
jobStatus:
{
Description: The job state. ,
Required: False ,
}
string ,
}
,
]
,
eventCorrelationId:
{
Description: The correlation Id for events associated with this migration item. ,
Required: False ,
}
string ,
providerSpecificDetails:
{
Description: The migration provider custom settings. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the instance type. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{}
ReplicationMigrationItems_TestMigrateCleanup (new)
Description :  The operation to initiate test migrate cleanup.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationMigrationItems/{migrationItemName}/testMigrateCleanup
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric name. ,
Required: True ,
}
string ,
protectionContainerName:
{
Description: Protection container name. ,
Required: True ,
}
string ,
migrationItemName:
{
Description: Migration item name. ,
Required: True ,
}
string ,
testMigrateCleanupInput:
{
Description: Test migrate cleanup input. ,
Required: True ,
}
{
properties:
{
Description: Test migrate cleanup input properties. ,
Required: True ,
}
{
comments:
{
Description: Test migrate cleanup comments. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The migration item properties. ,
Required: False ,
}
{
machineName:
{
Description: The on-premise virtual machine name. ,
Required: False ,
}
string ,
policyId:
{
Description: The ARM Id of policy governing this item. ,
Required: False ,
}
string ,
policyFriendlyName:
{
Description: The name of policy governing this item. ,
Required: False ,
}
string ,
recoveryServicesProviderId:
{
Description: The recovery services provider ARM Id. ,
Required: False ,
}
string ,
replicationStatus:
{
Description: The replication status. ,
Required: False ,
}
string ,
migrationState:
{
Description: The migration status. ,
Enum:
{
None: No description available. ,
EnableMigrationInProgress: No description available. ,
EnableMigrationFailed: No description available. ,
DisableMigrationInProgress: No description available. ,
DisableMigrationFailed: No description available. ,
InitialSeedingInProgress: No description available. ,
InitialSeedingFailed: No description available. ,
Replicating: No description available. ,
MigrationInProgress: No description available. ,
MigrationSucceeded: No description available. ,
MigrationFailed: No description available. ,
ResumeInProgress: No description available. ,
ResumeInitiated: No description available. ,
SuspendingProtection: No description available. ,
ProtectionSuspended: No description available. ,
MigrationCompletedWithInformation: No description available. ,
MigrationPartiallySucceeded: No description available. ,
}
,
Required: False ,
}
enum ,
migrationStateDescription:
{
Description: The migration state description. ,
Required: False ,
}
string ,
lastTestMigrationTime:
{
Description: The last test migration time. ,
Format: date-time ,
Required: False ,
}
string ,
lastTestMigrationStatus:
{
Description: The status of the last test migration. ,
Required: False ,
}
string ,
lastMigrationTime:
{
Description: The last migration time. ,
Format: date-time ,
Required: False ,
}
string ,
lastMigrationStatus:
{
Description: The status of the last migration. ,
Required: False ,
}
string ,
testMigrateState:
{
Description: The test migrate state. ,
Enum:
{
None: No description available. ,
TestMigrationInProgress: No description available. ,
TestMigrationSucceeded: No description available. ,
TestMigrationFailed: No description available. ,
TestMigrationCleanupInProgress: No description available. ,
TestMigrationCompletedWithInformation: No description available. ,
TestMigrationPartiallySucceeded: No description available. ,
}
,
Required: False ,
}
enum ,
testMigrateStateDescription:
{
Description: The test migrate state description. ,
Required: False ,
}
string ,
health:
{
Description: The consolidated health. ,
Enum:
{
None: No description available. ,
Normal: No description available. ,
Warning: No description available. ,
Critical: No description available. ,
}
,
Required: False ,
}
enum ,
healthErrors:
{
Description: The list of health errors. ,
Required: False ,
}
[
{
innerHealthErrors:
{
Description: 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. ,
Required: False ,
}
[
{
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
allowedOperations:
{
Description: The allowed operations on the migration item based on the current migration state of the item. ,
Required: False ,
}
[
string ,
]
,
currentJob:
{
Description: The current job details. ,
Required: False ,
}
{
jobName:
{
Description: The job name. ,
Required: False ,
}
string ,
jobId:
{
Description: The ARM Id of the job being executed. ,
Required: False ,
}
string ,
startTime:
{
Description: The start time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
criticalJobHistory:
{
Description: The critical past job details. ,
Required: False ,
}
[
{
jobName:
{
Description: The job name. ,
Required: False ,
}
string ,
jobId:
{
Description: The ARM Id of the job being executed. ,
Required: False ,
}
string ,
startTime:
{
Description: The start time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
jobStatus:
{
Description: The job state. ,
Required: False ,
}
string ,
}
,
]
,
eventCorrelationId:
{
Description: The correlation Id for events associated with this migration item. ,
Required: False ,
}
string ,
providerSpecificDetails:
{
Description: The migration provider custom settings. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the instance type. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{}
ReplicationProtectableItems_ListByReplicationProtectionContainers (new)
Description :  Lists the protectable items in a protection container.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectableItems
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric name. ,
Required: True ,
}
string ,
protectionContainerName:
{
Description: Protection container name. ,
Required: True ,
}
string ,
$filter:
{
Description: OData filter options. ,
Required: False ,
}
string ,
$take:
{
Description: take OData query parameter. ,
Required: False ,
}
string ,
$skipToken:
{
Description: skipToken OData query parameter. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Protectable item details. ,
Required: False ,
}
[
{
properties:
{
Description: The custom data. ,
Required: False ,
}
{
friendlyName:
{
Description: The name. ,
Required: False ,
}
string ,
protectionStatus:
{
Description: The protection status. ,
Required: False ,
}
string ,
replicationProtectedItemId:
{
Description: The ARM resource of protected items. ,
Required: False ,
}
string ,
recoveryServicesProviderId:
{
Description: The recovery provider ARM Id. ,
Required: False ,
}
string ,
protectionReadinessErrors:
{
Description: The Current protection readiness errors. ,
Required: False ,
}
[
string ,
]
,
supportedReplicationProviders:
{
Description: The list of replication providers supported for the protectable item. ,
Required: False ,
}
[
string ,
]
,
customDetails:
{
Description: The Replication provider custom settings. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the class type. Overridden in derived classes. ,
Required: True ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The value of next link. ,
Required: False ,
}
string ,
}
ReplicationProtectableItems_Get (new)
Description :  The operation to get the details of a protectable item.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectableItems/{protectableItemName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric name. ,
Required: True ,
}
string ,
protectionContainerName:
{
Description: Protection container name. ,
Required: True ,
}
string ,
protectableItemName:
{
Description: Protectable item name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The custom data. ,
Required: False ,
}
{
friendlyName:
{
Description: The name. ,
Required: False ,
}
string ,
protectionStatus:
{
Description: The protection status. ,
Required: False ,
}
string ,
replicationProtectedItemId:
{
Description: The ARM resource of protected items. ,
Required: False ,
}
string ,
recoveryServicesProviderId:
{
Description: The recovery provider ARM Id. ,
Required: False ,
}
string ,
protectionReadinessErrors:
{
Description: The Current protection readiness errors. ,
Required: False ,
}
[
string ,
]
,
supportedReplicationProviders:
{
Description: The list of replication providers supported for the protectable item. ,
Required: False ,
}
[
string ,
]
,
customDetails:
{
Description: The Replication provider custom settings. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the class type. Overridden in derived classes. ,
Required: True ,
}
string ,
}
,
}
,
}
ReplicationProtectedItems_ListByReplicationProtectionContainers (new)
Description :  Gets the list of ASR replication protected items in the protection container.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric name. ,
Required: True ,
}
string ,
protectionContainerName:
{
Description: Protection container name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Replication protected item details. ,
Required: False ,
}
[
{
properties:
{
Description: The custom data. ,
Required: False ,
}
{
friendlyName:
{
Description: The name. ,
Required: False ,
}
string ,
protectedItemType:
{
Description: The type of protected item type. ,
Required: False ,
}
string ,
protectableItemId:
{
Description: The protected item ARM Id. ,
Required: False ,
}
string ,
recoveryServicesProviderId:
{
Description: The recovery provider ARM Id. ,
Required: False ,
}
string ,
primaryFabricFriendlyName:
{
Description: The friendly name of the primary fabric. ,
Required: False ,
}
string ,
primaryFabricProvider:
{
Description: The fabric provider of the primary fabric. ,
Required: False ,
}
string ,
recoveryFabricFriendlyName:
{
Description: The friendly name of recovery fabric. ,
Required: False ,
}
string ,
recoveryFabricId:
{
Description: The Arm Id of recovery fabric. ,
Required: False ,
}
string ,
primaryProtectionContainerFriendlyName:
{
Description: The name of primary protection container friendly name. ,
Required: False ,
}
string ,
recoveryProtectionContainerFriendlyName:
{
Description: The name of recovery container friendly name. ,
Required: False ,
}
string ,
protectionState:
{
Description: The protection status. ,
Required: False ,
}
string ,
protectionStateDescription:
{
Description: The protection state description. ,
Required: False ,
}
string ,
activeLocation:
{
Description: The Current active location of the PE. ,
Required: False ,
}
string ,
testFailoverState:
{
Description: The Test failover state. ,
Required: False ,
}
string ,
testFailoverStateDescription:
{
Description: The Test failover state description. ,
Required: False ,
}
string ,
switchProviderState:
{
Description: The switch provider state. ,
Required: False ,
}
string ,
switchProviderStateDescription:
{
Description: The switch provider state description. ,
Required: False ,
}
string ,
allowedOperations:
{
Description: The allowed operations on the Replication protected item. ,
Required: False ,
}
[
string ,
]
,
replicationHealth:
{
Description: 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. ,
Required: False ,
}
string ,
failoverHealth:
{
Description: The consolidated failover health for the VM. ,
Required: False ,
}
string ,
healthErrors:
{
Description: List of health errors. ,
Required: False ,
}
[
{
innerHealthErrors:
{
Description: 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. ,
Required: False ,
}
[
{
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
policyId:
{
Description: The ID of Policy governing this PE. ,
Required: False ,
}
string ,
policyFriendlyName:
{
Description: The name of Policy governing this PE. ,
Required: False ,
}
string ,
lastSuccessfulFailoverTime:
{
Description: The Last successful failover time. ,
Format: date-time ,
Required: False ,
}
string ,
lastSuccessfulTestFailoverTime:
{
Description: The Last successful test failover time. ,
Format: date-time ,
Required: False ,
}
string ,
currentScenario:
{
Description: The current scenario. ,
Required: False ,
}
{
scenarioName:
{
Description: Scenario name. ,
Required: False ,
}
string ,
jobId:
{
Description: ARM Id of the job being executed. ,
Required: False ,
}
string ,
startTime:
{
Description: Start time of the workflow. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
failoverRecoveryPointId:
{
Description: The recovery point ARM Id to which the Vm was failed over. ,
Required: False ,
}
string ,
providerSpecificDetails:
{
Description: The Replication provider custom settings. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the Instance type. ,
Required: True ,
}
string ,
}
,
recoveryContainerId:
{
Description: The recovery container Id. ,
Required: False ,
}
string ,
eventCorrelationId:
{
Description: The correlation Id for events associated with this protected item. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The value of next link. ,
Required: False ,
}
string ,
}
ReplicationProtectedItems_Get (new)
Description :  Gets the details of an ASR replication protected item.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric unique name. ,
Required: True ,
}
string ,
protectionContainerName:
{
Description: Protection container name. ,
Required: True ,
}
string ,
replicatedProtectedItemName:
{
Description: Replication protected item name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The custom data. ,
Required: False ,
}
{
friendlyName:
{
Description: The name. ,
Required: False ,
}
string ,
protectedItemType:
{
Description: The type of protected item type. ,
Required: False ,
}
string ,
protectableItemId:
{
Description: The protected item ARM Id. ,
Required: False ,
}
string ,
recoveryServicesProviderId:
{
Description: The recovery provider ARM Id. ,
Required: False ,
}
string ,
primaryFabricFriendlyName:
{
Description: The friendly name of the primary fabric. ,
Required: False ,
}
string ,
primaryFabricProvider:
{
Description: The fabric provider of the primary fabric. ,
Required: False ,
}
string ,
recoveryFabricFriendlyName:
{
Description: The friendly name of recovery fabric. ,
Required: False ,
}
string ,
recoveryFabricId:
{
Description: The Arm Id of recovery fabric. ,
Required: False ,
}
string ,
primaryProtectionContainerFriendlyName:
{
Description: The name of primary protection container friendly name. ,
Required: False ,
}
string ,
recoveryProtectionContainerFriendlyName:
{
Description: The name of recovery container friendly name. ,
Required: False ,
}
string ,
protectionState:
{
Description: The protection status. ,
Required: False ,
}
string ,
protectionStateDescription:
{
Description: The protection state description. ,
Required: False ,
}
string ,
activeLocation:
{
Description: The Current active location of the PE. ,
Required: False ,
}
string ,
testFailoverState:
{
Description: The Test failover state. ,
Required: False ,
}
string ,
testFailoverStateDescription:
{
Description: The Test failover state description. ,
Required: False ,
}
string ,
switchProviderState:
{
Description: The switch provider state. ,
Required: False ,
}
string ,
switchProviderStateDescription:
{
Description: The switch provider state description. ,
Required: False ,
}
string ,
allowedOperations:
{
Description: The allowed operations on the Replication protected item. ,
Required: False ,
}
[
string ,
]
,
replicationHealth:
{
Description: 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. ,
Required: False ,
}
string ,
failoverHealth:
{
Description: The consolidated failover health for the VM. ,
Required: False ,
}
string ,
healthErrors:
{
Description: List of health errors. ,
Required: False ,
}
[
{
innerHealthErrors:
{
Description: 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. ,
Required: False ,
}
[
{
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
policyId:
{
Description: The ID of Policy governing this PE. ,
Required: False ,
}
string ,
policyFriendlyName:
{
Description: The name of Policy governing this PE. ,
Required: False ,
}
string ,
lastSuccessfulFailoverTime:
{
Description: The Last successful failover time. ,
Format: date-time ,
Required: False ,
}
string ,
lastSuccessfulTestFailoverTime:
{
Description: The Last successful test failover time. ,
Format: date-time ,
Required: False ,
}
string ,
currentScenario:
{
Description: The current scenario. ,
Required: False ,
}
{
scenarioName:
{
Description: Scenario name. ,
Required: False ,
}
string ,
jobId:
{
Description: ARM Id of the job being executed. ,
Required: False ,
}
string ,
startTime:
{
Description: Start time of the workflow. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
failoverRecoveryPointId:
{
Description: The recovery point ARM Id to which the Vm was failed over. ,
Required: False ,
}
string ,
providerSpecificDetails:
{
Description: The Replication provider custom settings. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the Instance type. ,
Required: True ,
}
string ,
}
,
recoveryContainerId:
{
Description: The recovery container Id. ,
Required: False ,
}
string ,
eventCorrelationId:
{
Description: The correlation Id for events associated with this protected item. ,
Required: False ,
}
string ,
}
,
}
ReplicationProtectedItems_Create (new)
Description :  The operation to create an ASR replication protected item (Enable replication).
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Name of the fabric. ,
Required: True ,
}
string ,
protectionContainerName:
{
Description: Protection container name. ,
Required: True ,
}
string ,
replicatedProtectedItemName:
{
Description: A name for the replication protected item. ,
Required: True ,
}
string ,
input:
{
Description: Enable Protection Input. ,
Required: True ,
}
{
properties:
{
Description: Enable protection input properties. ,
Required: False ,
}
{
policyId:
{
Description: The Policy Id. ,
Required: False ,
}
string ,
protectableItemId:
{
Description: The protectable item Id. ,
Required: False ,
}
string ,
providerSpecificDetails:
{
Description: The ReplicationProviderInput. For HyperVReplicaAzure provider, it will be AzureEnableProtectionInput object. For San provider, it will be SanEnableProtectionInput object. For HyperVReplicaAzure provider, it can be null. ,
Required: False ,
}
{
instanceType:
{
Description: The class type. ,
Required: True ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The custom data. ,
Required: False ,
}
{
friendlyName:
{
Description: The name. ,
Required: False ,
}
string ,
protectedItemType:
{
Description: The type of protected item type. ,
Required: False ,
}
string ,
protectableItemId:
{
Description: The protected item ARM Id. ,
Required: False ,
}
string ,
recoveryServicesProviderId:
{
Description: The recovery provider ARM Id. ,
Required: False ,
}
string ,
primaryFabricFriendlyName:
{
Description: The friendly name of the primary fabric. ,
Required: False ,
}
string ,
primaryFabricProvider:
{
Description: The fabric provider of the primary fabric. ,
Required: False ,
}
string ,
recoveryFabricFriendlyName:
{
Description: The friendly name of recovery fabric. ,
Required: False ,
}
string ,
recoveryFabricId:
{
Description: The Arm Id of recovery fabric. ,
Required: False ,
}
string ,
primaryProtectionContainerFriendlyName:
{
Description: The name of primary protection container friendly name. ,
Required: False ,
}
string ,
recoveryProtectionContainerFriendlyName:
{
Description: The name of recovery container friendly name. ,
Required: False ,
}
string ,
protectionState:
{
Description: The protection status. ,
Required: False ,
}
string ,
protectionStateDescription:
{
Description: The protection state description. ,
Required: False ,
}
string ,
activeLocation:
{
Description: The Current active location of the PE. ,
Required: False ,
}
string ,
testFailoverState:
{
Description: The Test failover state. ,
Required: False ,
}
string ,
testFailoverStateDescription:
{
Description: The Test failover state description. ,
Required: False ,
}
string ,
switchProviderState:
{
Description: The switch provider state. ,
Required: False ,
}
string ,
switchProviderStateDescription:
{
Description: The switch provider state description. ,
Required: False ,
}
string ,
allowedOperations:
{
Description: The allowed operations on the Replication protected item. ,
Required: False ,
}
[
string ,
]
,
replicationHealth:
{
Description: 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. ,
Required: False ,
}
string ,
failoverHealth:
{
Description: The consolidated failover health for the VM. ,
Required: False ,
}
string ,
healthErrors:
{
Description: List of health errors. ,
Required: False ,
}
[
{
innerHealthErrors:
{
Description: 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. ,
Required: False ,
}
[
{
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
policyId:
{
Description: The ID of Policy governing this PE. ,
Required: False ,
}
string ,
policyFriendlyName:
{
Description: The name of Policy governing this PE. ,
Required: False ,
}
string ,
lastSuccessfulFailoverTime:
{
Description: The Last successful failover time. ,
Format: date-time ,
Required: False ,
}
string ,
lastSuccessfulTestFailoverTime:
{
Description: The Last successful test failover time. ,
Format: date-time ,
Required: False ,
}
string ,
currentScenario:
{
Description: The current scenario. ,
Required: False ,
}
{
scenarioName:
{
Description: Scenario name. ,
Required: False ,
}
string ,
jobId:
{
Description: ARM Id of the job being executed. ,
Required: False ,
}
string ,
startTime:
{
Description: Start time of the workflow. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
failoverRecoveryPointId:
{
Description: The recovery point ARM Id to which the Vm was failed over. ,
Required: False ,
}
string ,
providerSpecificDetails:
{
Description: The Replication provider custom settings. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the Instance type. ,
Required: True ,
}
string ,
}
,
recoveryContainerId:
{
Description: The recovery container Id. ,
Required: False ,
}
string ,
eventCorrelationId:
{
Description: The correlation Id for events associated with this protected item. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}
ReplicationProtectedItems_Purge (new)
Description :  The operation to delete or purge a replication protected item. This operation will force delete the replication protected item. Use the remove operation on replication protected item to perform a clean disable replication for the item.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric name. ,
Required: True ,
}
string ,
protectionContainerName:
{
Description: Protection container name. ,
Required: True ,
}
string ,
replicatedProtectedItemName:
{
Description: Replication protected item name. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
ReplicationProtectedItems_Update (new)
Description :  The operation to update the recovery settings of an ASR replication protected item.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric name. ,
Required: True ,
}
string ,
protectionContainerName:
{
Description: Protection container name. ,
Required: True ,
}
string ,
replicatedProtectedItemName:
{
Description: Replication protected item name. ,
Required: True ,
}
string ,
updateProtectionInput:
{
Description: Update protection input. ,
Required: True ,
}
{
properties:
{
Description: Update replication protected item properties. ,
Required: False ,
}
{
recoveryAzureVMName:
{
Description: Target Azure VM name given by the user. ,
Required: False ,
}
string ,
recoveryAzureVMSize:
{
Description: Target Azure VM size. ,
Required: False ,
}
string ,
selectedRecoveryAzureNetworkId:
{
Description: Target Azure Network Id. ,
Required: False ,
}
string ,
selectedTfoAzureNetworkId:
{
Description: The Azure Network Id for test failover. ,
Required: False ,
}
string ,
selectedSourceNicId:
{
Description: The selected source nic Id which will be used as the primary nic during failover. ,
Required: False ,
}
string ,
enableRdpOnTargetOption:
{
Description: The selected option to enable RDP\SSH on target vm after failover. String value of SrsDataContract.EnableRDPOnTargetOption enum. ,
Required: False ,
}
string ,
vmNics:
{
Description: The list of VM nic details. ,
Required: False ,
}
[
{
nicId:
{
Description: The nic Id. ,
Required: False ,
}
string ,
ipConfigs:
{
Description: The IP configurations to be used by NIC during test failover and failover. ,
Required: False ,
}
[
{
ipConfigName:
{
Required: False ,
}
string ,
isPrimary:
{
Required: False ,
}
boolean ,
isSeletedForFailover:
{
Required: False ,
}
boolean ,
recoverySubnetName:
{
Required: False ,
}
string ,
recoveryStaticIPAddress:
{
Required: False ,
}
string ,
recoveryPublicIPAddressId:
{
Required: False ,
}
string ,
recoveryLBBackendAddressPoolIds:
{
Required: False ,
}
[
string ,
]
,
tfoSubnetName:
{
Required: False ,
}
string ,
tfoStaticIPAddress:
{
Required: False ,
}
string ,
tfoPublicIPAddressId:
{
Required: False ,
}
string ,
tfoLBBackendAddressPoolIds:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
selectionType:
{
Description: Selection type for failover. ,
Required: False ,
}
string ,
recoveryNetworkSecurityGroupId:
{
Description: The id of the NSG associated with the NIC. ,
Required: False ,
}
string ,
enableAcceleratedNetworkingOnRecovery:
{
Description: Whether the NIC has accelerated networking enabled. ,
Required: False ,
}
boolean ,
tfoNetworkSecurityGroupId:
{
Description: The NSG to be used by NIC during test failover. ,
Required: False ,
}
string ,
enableAcceleratedNetworkingOnTfo:
{
Description: Whether the test NIC has accelerated networking enabled. ,
Required: False ,
}
boolean ,
recoveryNicName:
{
Description: The name of the NIC to be used when creating target NICs. ,
Required: False ,
}
string ,
recoveryNicResourceGroupName:
{
Description: The resource group of the NIC to be used when creating target NICs. ,
Required: False ,
}
string ,
reuseExistingNic:
{
Description: A value indicating whether an existing NIC is allowed to be reused during failover subject to availability. ,
Required: False ,
}
boolean ,
tfoNicName:
{
Description: The name of the NIC to be used when creating target NICs in TFO. ,
Required: False ,
}
string ,
tfoNicResourceGroupName:
{
Description: The resource group of the NIC to be used when creating target NICs in TFO. ,
Required: False ,
}
string ,
tfoReuseExistingNic:
{
Description: A value indicating whether an existing NIC is allowed to be reused during test failover subject to availability. ,
Required: False ,
}
boolean ,
targetNicName:
{
Description: Target NIC name. ,
Required: False ,
}
string ,
}
,
]
,
licenseType:
{
Description: License type. ,
Enum:
{
NotSpecified: No description available. ,
NoLicenseType: No description available. ,
WindowsServer: No description available. ,
}
,
Required: False ,
}
enum ,
recoveryAvailabilitySetId:
{
Description: The target availability set Id. ,
Required: False ,
}
string ,
providerSpecificDetails:
{
Description: The provider specific input to update replication protected item. ,
Required: False ,
}
{
instanceType:
{
Description: The class type. ,
Required: True ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The custom data. ,
Required: False ,
}
{
friendlyName:
{
Description: The name. ,
Required: False ,
}
string ,
protectedItemType:
{
Description: The type of protected item type. ,
Required: False ,
}
string ,
protectableItemId:
{
Description: The protected item ARM Id. ,
Required: False ,
}
string ,
recoveryServicesProviderId:
{
Description: The recovery provider ARM Id. ,
Required: False ,
}
string ,
primaryFabricFriendlyName:
{
Description: The friendly name of the primary fabric. ,
Required: False ,
}
string ,
primaryFabricProvider:
{
Description: The fabric provider of the primary fabric. ,
Required: False ,
}
string ,
recoveryFabricFriendlyName:
{
Description: The friendly name of recovery fabric. ,
Required: False ,
}
string ,
recoveryFabricId:
{
Description: The Arm Id of recovery fabric. ,
Required: False ,
}
string ,
primaryProtectionContainerFriendlyName:
{
Description: The name of primary protection container friendly name. ,
Required: False ,
}
string ,
recoveryProtectionContainerFriendlyName:
{
Description: The name of recovery container friendly name. ,
Required: False ,
}
string ,
protectionState:
{
Description: The protection status. ,
Required: False ,
}
string ,
protectionStateDescription:
{
Description: The protection state description. ,
Required: False ,
}
string ,
activeLocation:
{
Description: The Current active location of the PE. ,
Required: False ,
}
string ,
testFailoverState:
{
Description: The Test failover state. ,
Required: False ,
}
string ,
testFailoverStateDescription:
{
Description: The Test failover state description. ,
Required: False ,
}
string ,
switchProviderState:
{
Description: The switch provider state. ,
Required: False ,
}
string ,
switchProviderStateDescription:
{
Description: The switch provider state description. ,
Required: False ,
}
string ,
allowedOperations:
{
Description: The allowed operations on the Replication protected item. ,
Required: False ,
}
[
string ,
]
,
replicationHealth:
{
Description: 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. ,
Required: False ,
}
string ,
failoverHealth:
{
Description: The consolidated failover health for the VM. ,
Required: False ,
}
string ,
healthErrors:
{
Description: List of health errors. ,
Required: False ,
}
[
{
innerHealthErrors:
{
Description: 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. ,
Required: False ,
}
[
{
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
policyId:
{
Description: The ID of Policy governing this PE. ,
Required: False ,
}
string ,
policyFriendlyName:
{
Description: The name of Policy governing this PE. ,
Required: False ,
}
string ,
lastSuccessfulFailoverTime:
{
Description: The Last successful failover time. ,
Format: date-time ,
Required: False ,
}
string ,
lastSuccessfulTestFailoverTime:
{
Description: The Last successful test failover time. ,
Format: date-time ,
Required: False ,
}
string ,
currentScenario:
{
Description: The current scenario. ,
Required: False ,
}
{
scenarioName:
{
Description: Scenario name. ,
Required: False ,
}
string ,
jobId:
{
Description: ARM Id of the job being executed. ,
Required: False ,
}
string ,
startTime:
{
Description: Start time of the workflow. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
failoverRecoveryPointId:
{
Description: The recovery point ARM Id to which the Vm was failed over. ,
Required: False ,
}
string ,
providerSpecificDetails:
{
Description: The Replication provider custom settings. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the Instance type. ,
Required: True ,
}
string ,
}
,
recoveryContainerId:
{
Description: The recovery container Id. ,
Required: False ,
}
string ,
eventCorrelationId:
{
Description: The correlation Id for events associated with this protected item. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}
ReplicationProtectedItems_AddDisks (new)
Description :  Operation to add disks(s) to the replication protected item.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/addDisks
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Unique fabric name. ,
Required: True ,
}
string ,
protectionContainerName:
{
Description: Protection container name. ,
Required: True ,
}
string ,
replicatedProtectedItemName:
{
Description: Replication protected item name. ,
Required: True ,
}
string ,
addDisksInput:
{
Description: Add disks input. ,
Required: True ,
}
{
properties:
{
Description: Add disks input properties. ,
Required: False ,
}
{
providerSpecificDetails:
{
Description: The ReplicationProviderInput. For HyperVReplicaAzure provider, it will be AzureEnableProtectionInput object. For San provider, it will be SanEnableProtectionInput object. For HyperVReplicaAzure provider, it can be null. ,
Required: True ,
}
{
instanceType:
{
Description: The class type. ,
Required: True ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The custom data. ,
Required: False ,
}
{
friendlyName:
{
Description: The name. ,
Required: False ,
}
string ,
protectedItemType:
{
Description: The type of protected item type. ,
Required: False ,
}
string ,
protectableItemId:
{
Description: The protected item ARM Id. ,
Required: False ,
}
string ,
recoveryServicesProviderId:
{
Description: The recovery provider ARM Id. ,
Required: False ,
}
string ,
primaryFabricFriendlyName:
{
Description: The friendly name of the primary fabric. ,
Required: False ,
}
string ,
primaryFabricProvider:
{
Description: The fabric provider of the primary fabric. ,
Required: False ,
}
string ,
recoveryFabricFriendlyName:
{
Description: The friendly name of recovery fabric. ,
Required: False ,
}
string ,
recoveryFabricId:
{
Description: The Arm Id of recovery fabric. ,
Required: False ,
}
string ,
primaryProtectionContainerFriendlyName:
{
Description: The name of primary protection container friendly name. ,
Required: False ,
}
string ,
recoveryProtectionContainerFriendlyName:
{
Description: The name of recovery container friendly name. ,
Required: False ,
}
string ,
protectionState:
{
Description: The protection status. ,
Required: False ,
}
string ,
protectionStateDescription:
{
Description: The protection state description. ,
Required: False ,
}
string ,
activeLocation:
{
Description: The Current active location of the PE. ,
Required: False ,
}
string ,
testFailoverState:
{
Description: The Test failover state. ,
Required: False ,
}
string ,
testFailoverStateDescription:
{
Description: The Test failover state description. ,
Required: False ,
}
string ,
switchProviderState:
{
Description: The switch provider state. ,
Required: False ,
}
string ,
switchProviderStateDescription:
{
Description: The switch provider state description. ,
Required: False ,
}
string ,
allowedOperations:
{
Description: The allowed operations on the Replication protected item. ,
Required: False ,
}
[
string ,
]
,
replicationHealth:
{
Description: 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. ,
Required: False ,
}
string ,
failoverHealth:
{
Description: The consolidated failover health for the VM. ,
Required: False ,
}
string ,
healthErrors:
{
Description: List of health errors. ,
Required: False ,
}
[
{
innerHealthErrors:
{
Description: 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. ,
Required: False ,
}
[
{
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
policyId:
{
Description: The ID of Policy governing this PE. ,
Required: False ,
}
string ,
policyFriendlyName:
{
Description: The name of Policy governing this PE. ,
Required: False ,
}
string ,
lastSuccessfulFailoverTime:
{
Description: The Last successful failover time. ,
Format: date-time ,
Required: False ,
}
string ,
lastSuccessfulTestFailoverTime:
{
Description: The Last successful test failover time. ,
Format: date-time ,
Required: False ,
}
string ,
currentScenario:
{
Description: The current scenario. ,
Required: False ,
}
{
scenarioName:
{
Description: Scenario name. ,
Required: False ,
}
string ,
jobId:
{
Description: ARM Id of the job being executed. ,
Required: False ,
}
string ,
startTime:
{
Description: Start time of the workflow. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
failoverRecoveryPointId:
{
Description: The recovery point ARM Id to which the Vm was failed over. ,
Required: False ,
}
string ,
providerSpecificDetails:
{
Description: The Replication provider custom settings. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the Instance type. ,
Required: True ,
}
string ,
}
,
recoveryContainerId:
{
Description: The recovery container Id. ,
Required: False ,
}
string ,
eventCorrelationId:
{
Description: The correlation Id for events associated with this protected item. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}
ReplicationProtectedItems_ApplyRecoveryPoint (new)
Description :  The operation to change the recovery point of a failed over replication protected item.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/applyRecoveryPoint
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: The ARM fabric name. ,
Required: True ,
}
string ,
protectionContainerName:
{
Description: The protection container name. ,
Required: True ,
}
string ,
replicatedProtectedItemName:
{
Description: The replicated protected item name. ,
Required: True ,
}
string ,
applyRecoveryPointInput:
{
Description: The ApplyRecoveryPointInput. ,
Required: True ,
}
{
properties:
{
Description: The input properties to apply recovery point. ,
Required: True ,
}
{
recoveryPointId:
{
Description: The recovery point Id. ,
Required: False ,
}
string ,
providerSpecificDetails:
{
Description: Provider specific input for applying recovery point. ,
Required: True ,
}
{
instanceType:
{
Description: The class type. ,
Required: True ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The custom data. ,
Required: False ,
}
{
friendlyName:
{
Description: The name. ,
Required: False ,
}
string ,
protectedItemType:
{
Description: The type of protected item type. ,
Required: False ,
}
string ,
protectableItemId:
{
Description: The protected item ARM Id. ,
Required: False ,
}
string ,
recoveryServicesProviderId:
{
Description: The recovery provider ARM Id. ,
Required: False ,
}
string ,
primaryFabricFriendlyName:
{
Description: The friendly name of the primary fabric. ,
Required: False ,
}
string ,
primaryFabricProvider:
{
Description: The fabric provider of the primary fabric. ,
Required: False ,
}
string ,
recoveryFabricFriendlyName:
{
Description: The friendly name of recovery fabric. ,
Required: False ,
}
string ,
recoveryFabricId:
{
Description: The Arm Id of recovery fabric. ,
Required: False ,
}
string ,
primaryProtectionContainerFriendlyName:
{
Description: The name of primary protection container friendly name. ,
Required: False ,
}
string ,
recoveryProtectionContainerFriendlyName:
{
Description: The name of recovery container friendly name. ,
Required: False ,
}
string ,
protectionState:
{
Description: The protection status. ,
Required: False ,
}
string ,
protectionStateDescription:
{
Description: The protection state description. ,
Required: False ,
}
string ,
activeLocation:
{
Description: The Current active location of the PE. ,
Required: False ,
}
string ,
testFailoverState:
{
Description: The Test failover state. ,
Required: False ,
}
string ,
testFailoverStateDescription:
{
Description: The Test failover state description. ,
Required: False ,
}
string ,
switchProviderState:
{
Description: The switch provider state. ,
Required: False ,
}
string ,
switchProviderStateDescription:
{
Description: The switch provider state description. ,
Required: False ,
}
string ,
allowedOperations:
{
Description: The allowed operations on the Replication protected item. ,
Required: False ,
}
[
string ,
]
,
replicationHealth:
{
Description: 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. ,
Required: False ,
}
string ,
failoverHealth:
{
Description: The consolidated failover health for the VM. ,
Required: False ,
}
string ,
healthErrors:
{
Description: List of health errors. ,
Required: False ,
}
[
{
innerHealthErrors:
{
Description: 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. ,
Required: False ,
}
[
{
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
policyId:
{
Description: The ID of Policy governing this PE. ,
Required: False ,
}
string ,
policyFriendlyName:
{
Description: The name of Policy governing this PE. ,
Required: False ,
}
string ,
lastSuccessfulFailoverTime:
{
Description: The Last successful failover time. ,
Format: date-time ,
Required: False ,
}
string ,
lastSuccessfulTestFailoverTime:
{
Description: The Last successful test failover time. ,
Format: date-time ,
Required: False ,
}
string ,
currentScenario:
{
Description: The current scenario. ,
Required: False ,
}
{
scenarioName:
{
Description: Scenario name. ,
Required: False ,
}
string ,
jobId:
{
Description: ARM Id of the job being executed. ,
Required: False ,
}
string ,
startTime:
{
Description: Start time of the workflow. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
failoverRecoveryPointId:
{
Description: The recovery point ARM Id to which the Vm was failed over. ,
Required: False ,
}
string ,
providerSpecificDetails:
{
Description: The Replication provider custom settings. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the Instance type. ,
Required: True ,
}
string ,
}
,
recoveryContainerId:
{
Description: The recovery container Id. ,
Required: False ,
}
string ,
eventCorrelationId:
{
Description: The correlation Id for events associated with this protected item. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}
ReplicationProtectedItems_FailoverCancel (new)
Description :  Operation to cancel the failover of the replication protected item.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/failoverCancel
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Unique fabric name. ,
Required: True ,
}
string ,
protectionContainerName:
{
Description: Protection container name. ,
Required: True ,
}
string ,
replicatedProtectedItemName:
{
Description: Replication protected item name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The custom data. ,
Required: False ,
}
{
friendlyName:
{
Description: The name. ,
Required: False ,
}
string ,
protectedItemType:
{
Description: The type of protected item type. ,
Required: False ,
}
string ,
protectableItemId:
{
Description: The protected item ARM Id. ,
Required: False ,
}
string ,
recoveryServicesProviderId:
{
Description: The recovery provider ARM Id. ,
Required: False ,
}
string ,
primaryFabricFriendlyName:
{
Description: The friendly name of the primary fabric. ,
Required: False ,
}
string ,
primaryFabricProvider:
{
Description: The fabric provider of the primary fabric. ,
Required: False ,
}
string ,
recoveryFabricFriendlyName:
{
Description: The friendly name of recovery fabric. ,
Required: False ,
}
string ,
recoveryFabricId:
{
Description: The Arm Id of recovery fabric. ,
Required: False ,
}
string ,
primaryProtectionContainerFriendlyName:
{
Description: The name of primary protection container friendly name. ,
Required: False ,
}
string ,
recoveryProtectionContainerFriendlyName:
{
Description: The name of recovery container friendly name. ,
Required: False ,
}
string ,
protectionState:
{
Description: The protection status. ,
Required: False ,
}
string ,
protectionStateDescription:
{
Description: The protection state description. ,
Required: False ,
}
string ,
activeLocation:
{
Description: The Current active location of the PE. ,
Required: False ,
}
string ,
testFailoverState:
{
Description: The Test failover state. ,
Required: False ,
}
string ,
testFailoverStateDescription:
{
Description: The Test failover state description. ,
Required: False ,
}
string ,
switchProviderState:
{
Description: The switch provider state. ,
Required: False ,
}
string ,
switchProviderStateDescription:
{
Description: The switch provider state description. ,
Required: False ,
}
string ,
allowedOperations:
{
Description: The allowed operations on the Replication protected item. ,
Required: False ,
}
[
string ,
]
,
replicationHealth:
{
Description: 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. ,
Required: False ,
}
string ,
failoverHealth:
{
Description: The consolidated failover health for the VM. ,
Required: False ,
}
string ,
healthErrors:
{
Description: List of health errors. ,
Required: False ,
}
[
{
innerHealthErrors:
{
Description: 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. ,
Required: False ,
}
[
{
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
policyId:
{
Description: The ID of Policy governing this PE. ,
Required: False ,
}
string ,
policyFriendlyName:
{
Description: The name of Policy governing this PE. ,
Required: False ,
}
string ,
lastSuccessfulFailoverTime:
{
Description: The Last successful failover time. ,
Format: date-time ,
Required: False ,
}
string ,
lastSuccessfulTestFailoverTime:
{
Description: The Last successful test failover time. ,
Format: date-time ,
Required: False ,
}
string ,
currentScenario:
{
Description: The current scenario. ,
Required: False ,
}
{
scenarioName:
{
Description: Scenario name. ,
Required: False ,
}
string ,
jobId:
{
Description: ARM Id of the job being executed. ,
Required: False ,
}
string ,
startTime:
{
Description: Start time of the workflow. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
failoverRecoveryPointId:
{
Description: The recovery point ARM Id to which the Vm was failed over. ,
Required: False ,
}
string ,
providerSpecificDetails:
{
Description: The Replication provider custom settings. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the Instance type. ,
Required: True ,
}
string ,
}
,
recoveryContainerId:
{
Description: The recovery container Id. ,
Required: False ,
}
string ,
eventCorrelationId:
{
Description: The correlation Id for events associated with this protected item. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}
ReplicationProtectedItems_FailoverCommit (new)
Description :  Operation to commit the failover of the replication protected item.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/failoverCommit
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Unique fabric name. ,
Required: True ,
}
string ,
protectionContainerName:
{
Description: Protection container name. ,
Required: True ,
}
string ,
replicatedProtectedItemName:
{
Description: Replication protected item name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The custom data. ,
Required: False ,
}
{
friendlyName:
{
Description: The name. ,
Required: False ,
}
string ,
protectedItemType:
{
Description: The type of protected item type. ,
Required: False ,
}
string ,
protectableItemId:
{
Description: The protected item ARM Id. ,
Required: False ,
}
string ,
recoveryServicesProviderId:
{
Description: The recovery provider ARM Id. ,
Required: False ,
}
string ,
primaryFabricFriendlyName:
{
Description: The friendly name of the primary fabric. ,
Required: False ,
}
string ,
primaryFabricProvider:
{
Description: The fabric provider of the primary fabric. ,
Required: False ,
}
string ,
recoveryFabricFriendlyName:
{
Description: The friendly name of recovery fabric. ,
Required: False ,
}
string ,
recoveryFabricId:
{
Description: The Arm Id of recovery fabric. ,
Required: False ,
}
string ,
primaryProtectionContainerFriendlyName:
{
Description: The name of primary protection container friendly name. ,
Required: False ,
}
string ,
recoveryProtectionContainerFriendlyName:
{
Description: The name of recovery container friendly name. ,
Required: False ,
}
string ,
protectionState:
{
Description: The protection status. ,
Required: False ,
}
string ,
protectionStateDescription:
{
Description: The protection state description. ,
Required: False ,
}
string ,
activeLocation:
{
Description: The Current active location of the PE. ,
Required: False ,
}
string ,
testFailoverState:
{
Description: The Test failover state. ,
Required: False ,
}
string ,
testFailoverStateDescription:
{
Description: The Test failover state description. ,
Required: False ,
}
string ,
switchProviderState:
{
Description: The switch provider state. ,
Required: False ,
}
string ,
switchProviderStateDescription:
{
Description: The switch provider state description. ,
Required: False ,
}
string ,
allowedOperations:
{
Description: The allowed operations on the Replication protected item. ,
Required: False ,
}
[
string ,
]
,
replicationHealth:
{
Description: 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. ,
Required: False ,
}
string ,
failoverHealth:
{
Description: The consolidated failover health for the VM. ,
Required: False ,
}
string ,
healthErrors:
{
Description: List of health errors. ,
Required: False ,
}
[
{
innerHealthErrors:
{
Description: 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. ,
Required: False ,
}
[
{
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
policyId:
{
Description: The ID of Policy governing this PE. ,
Required: False ,
}
string ,
policyFriendlyName:
{
Description: The name of Policy governing this PE. ,
Required: False ,
}
string ,
lastSuccessfulFailoverTime:
{
Description: The Last successful failover time. ,
Format: date-time ,
Required: False ,
}
string ,
lastSuccessfulTestFailoverTime:
{
Description: The Last successful test failover time. ,
Format: date-time ,
Required: False ,
}
string ,
currentScenario:
{
Description: The current scenario. ,
Required: False ,
}
{
scenarioName:
{
Description: Scenario name. ,
Required: False ,
}
string ,
jobId:
{
Description: ARM Id of the job being executed. ,
Required: False ,
}
string ,
startTime:
{
Description: Start time of the workflow. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
failoverRecoveryPointId:
{
Description: The recovery point ARM Id to which the Vm was failed over. ,
Required: False ,
}
string ,
providerSpecificDetails:
{
Description: The Replication provider custom settings. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the Instance type. ,
Required: True ,
}
string ,
}
,
recoveryContainerId:
{
Description: The recovery container Id. ,
Required: False ,
}
string ,
eventCorrelationId:
{
Description: The correlation Id for events associated with this protected item. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}
ReplicationProtectedItems_PlannedFailover (new)
Description :  Operation to initiate a planned failover of the replication protected item.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/plannedFailover
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Unique fabric name. ,
Required: True ,
}
string ,
protectionContainerName:
{
Description: Protection container name. ,
Required: True ,
}
string ,
replicatedProtectedItemName:
{
Description: Replication protected item name. ,
Required: True ,
}
string ,
failoverInput:
{
Description: Planned failover input. ,
Required: True ,
}
{
properties:
{
Description: Planned failover input properties. ,
Required: False ,
}
{
failoverDirection:
{
Description: Failover direction. ,
Required: False ,
}
string ,
providerSpecificDetails:
{
Description: Provider specific settings. ,
Required: False ,
}
{
instanceType:
{
Description: The class type. ,
Required: True ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The custom data. ,
Required: False ,
}
{
friendlyName:
{
Description: The name. ,
Required: False ,
}
string ,
protectedItemType:
{
Description: The type of protected item type. ,
Required: False ,
}
string ,
protectableItemId:
{
Description: The protected item ARM Id. ,
Required: False ,
}
string ,
recoveryServicesProviderId:
{
Description: The recovery provider ARM Id. ,
Required: False ,
}
string ,
primaryFabricFriendlyName:
{
Description: The friendly name of the primary fabric. ,
Required: False ,
}
string ,
primaryFabricProvider:
{
Description: The fabric provider of the primary fabric. ,
Required: False ,
}
string ,
recoveryFabricFriendlyName:
{
Description: The friendly name of recovery fabric. ,
Required: False ,
}
string ,
recoveryFabricId:
{
Description: The Arm Id of recovery fabric. ,
Required: False ,
}
string ,
primaryProtectionContainerFriendlyName:
{
Description: The name of primary protection container friendly name. ,
Required: False ,
}
string ,
recoveryProtectionContainerFriendlyName:
{
Description: The name of recovery container friendly name. ,
Required: False ,
}
string ,
protectionState:
{
Description: The protection status. ,
Required: False ,
}
string ,
protectionStateDescription:
{
Description: The protection state description. ,
Required: False ,
}
string ,
activeLocation:
{
Description: The Current active location of the PE. ,
Required: False ,
}
string ,
testFailoverState:
{
Description: The Test failover state. ,
Required: False ,
}
string ,
testFailoverStateDescription:
{
Description: The Test failover state description. ,
Required: False ,
}
string ,
switchProviderState:
{
Description: The switch provider state. ,
Required: False ,
}
string ,
switchProviderStateDescription:
{
Description: The switch provider state description. ,
Required: False ,
}
string ,
allowedOperations:
{
Description: The allowed operations on the Replication protected item. ,
Required: False ,
}
[
string ,
]
,
replicationHealth:
{
Description: 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. ,
Required: False ,
}
string ,
failoverHealth:
{
Description: The consolidated failover health for the VM. ,
Required: False ,
}
string ,
healthErrors:
{
Description: List of health errors. ,
Required: False ,
}
[
{
innerHealthErrors:
{
Description: 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. ,
Required: False ,
}
[
{
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
policyId:
{
Description: The ID of Policy governing this PE. ,
Required: False ,
}
string ,
policyFriendlyName:
{
Description: The name of Policy governing this PE. ,
Required: False ,
}
string ,
lastSuccessfulFailoverTime:
{
Description: The Last successful failover time. ,
Format: date-time ,
Required: False ,
}
string ,
lastSuccessfulTestFailoverTime:
{
Description: The Last successful test failover time. ,
Format: date-time ,
Required: False ,
}
string ,
currentScenario:
{
Description: The current scenario. ,
Required: False ,
}
{
scenarioName:
{
Description: Scenario name. ,
Required: False ,
}
string ,
jobId:
{
Description: ARM Id of the job being executed. ,
Required: False ,
}
string ,
startTime:
{
Description: Start time of the workflow. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
failoverRecoveryPointId:
{
Description: The recovery point ARM Id to which the Vm was failed over. ,
Required: False ,
}
string ,
providerSpecificDetails:
{
Description: The Replication provider custom settings. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the Instance type. ,
Required: True ,
}
string ,
}
,
recoveryContainerId:
{
Description: The recovery container Id. ,
Required: False ,
}
string ,
eventCorrelationId:
{
Description: The correlation Id for events associated with this protected item. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}
RecoveryPoints_ListByReplicationProtectedItems (new)
Description :  Lists the available recovery points for a replication protected item.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/recoveryPoints
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: The fabric name. ,
Required: True ,
}
string ,
protectionContainerName:
{
Description: The protection container name. ,
Required: True ,
}
string ,
replicatedProtectedItemName:
{
Description: The replication protected item name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The recovery point details. ,
Required: False ,
}
[
{
properties:
{
Description: The recovery point properties. ,
Required: False ,
}
{
recoveryPointTime:
{
Description: The recovery point time. ,
Format: date-time ,
Required: False ,
}
string ,
recoveryPointType:
{
Description: The recovery point type: ApplicationConsistent, CrashConsistent. ,
Required: False ,
}
string ,
providerSpecificDetails:
{
Description: The provider specific details for the recovery point. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the provider type. ,
Required: True ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The value of next link. ,
Required: False ,
}
string ,
}
RecoveryPoints_Get (new)
Description :  Get the details of specified recovery point.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/recoveryPoints/{recoveryPointName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: The fabric name. ,
Required: True ,
}
string ,
protectionContainerName:
{
Description: The protection container name. ,
Required: True ,
}
string ,
replicatedProtectedItemName:
{
Description: The replication protected item name. ,
Required: True ,
}
string ,
recoveryPointName:
{
Description: The recovery point name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The recovery point properties. ,
Required: False ,
}
{
recoveryPointTime:
{
Description: The recovery point time. ,
Format: date-time ,
Required: False ,
}
string ,
recoveryPointType:
{
Description: The recovery point type: ApplicationConsistent, CrashConsistent. ,
Required: False ,
}
string ,
providerSpecificDetails:
{
Description: The provider specific details for the recovery point. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the provider type. ,
Required: True ,
}
string ,
}
,
}
,
}
ReplicationProtectedItems_Delete (new)
Description :  The operation to disable replication on a replication protected item. This will also remove the item.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/remove
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric name. ,
Required: True ,
}
string ,
protectionContainerName:
{
Description: Protection container name. ,
Required: True ,
}
string ,
replicatedProtectedItemName:
{
Description: Replication protected item name. ,
Required: True ,
}
string ,
disableProtectionInput:
{
Description: Disable protection input. ,
Required: True ,
}
{
properties:
{
Description: Disable protection input properties. ,
Required: True ,
}
{
disableProtectionReason:
{
Description: Disable protection reason. It can have values NotSpecified/MigrationComplete. ,
Enum:
{
NotSpecified: No description available. ,
MigrationComplete: No description available. ,
}
,
Required: False ,
}
enum ,
replicationProviderInput:
{
Description: Replication provider specific input. ,
Required: False ,
}
{
instanceType:
{
Description: The class type. ,
Required: True ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
ReplicationProtectedItems_RemoveDisks (new)
Description :  Operation to remove disk(s) from the replication protected item.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/removeDisks
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Unique fabric name. ,
Required: True ,
}
string ,
protectionContainerName:
{
Description: Protection container name. ,
Required: True ,
}
string ,
replicatedProtectedItemName:
{
Description: Replication protected item name. ,
Required: True ,
}
string ,
removeDisksInput:
{
Description: Remove disks input. ,
Required: True ,
}
{
properties:
{
Description: Remove disk input properties. ,
Required: False ,
}
{
providerSpecificDetails:
{
Description: The ReplicationProviderInput. For HyperVReplicaAzure provider, it will be AzureEnableProtectionInput object. For San provider, it will be SanEnableProtectionInput object. For HyperVReplicaAzure provider, it can be null. ,
Required: False ,
}
{
instanceType:
{
Description: The class type. ,
Required: True ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The custom data. ,
Required: False ,
}
{
friendlyName:
{
Description: The name. ,
Required: False ,
}
string ,
protectedItemType:
{
Description: The type of protected item type. ,
Required: False ,
}
string ,
protectableItemId:
{
Description: The protected item ARM Id. ,
Required: False ,
}
string ,
recoveryServicesProviderId:
{
Description: The recovery provider ARM Id. ,
Required: False ,
}
string ,
primaryFabricFriendlyName:
{
Description: The friendly name of the primary fabric. ,
Required: False ,
}
string ,
primaryFabricProvider:
{
Description: The fabric provider of the primary fabric. ,
Required: False ,
}
string ,
recoveryFabricFriendlyName:
{
Description: The friendly name of recovery fabric. ,
Required: False ,
}
string ,
recoveryFabricId:
{
Description: The Arm Id of recovery fabric. ,
Required: False ,
}
string ,
primaryProtectionContainerFriendlyName:
{
Description: The name of primary protection container friendly name. ,
Required: False ,
}
string ,
recoveryProtectionContainerFriendlyName:
{
Description: The name of recovery container friendly name. ,
Required: False ,
}
string ,
protectionState:
{
Description: The protection status. ,
Required: False ,
}
string ,
protectionStateDescription:
{
Description: The protection state description. ,
Required: False ,
}
string ,
activeLocation:
{
Description: The Current active location of the PE. ,
Required: False ,
}
string ,
testFailoverState:
{
Description: The Test failover state. ,
Required: False ,
}
string ,
testFailoverStateDescription:
{
Description: The Test failover state description. ,
Required: False ,
}
string ,
switchProviderState:
{
Description: The switch provider state. ,
Required: False ,
}
string ,
switchProviderStateDescription:
{
Description: The switch provider state description. ,
Required: False ,
}
string ,
allowedOperations:
{
Description: The allowed operations on the Replication protected item. ,
Required: False ,
}
[
string ,
]
,
replicationHealth:
{
Description: 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. ,
Required: False ,
}
string ,
failoverHealth:
{
Description: The consolidated failover health for the VM. ,
Required: False ,
}
string ,
healthErrors:
{
Description: List of health errors. ,
Required: False ,
}
[
{
innerHealthErrors:
{
Description: 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. ,
Required: False ,
}
[
{
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
policyId:
{
Description: The ID of Policy governing this PE. ,
Required: False ,
}
string ,
policyFriendlyName:
{
Description: The name of Policy governing this PE. ,
Required: False ,
}
string ,
lastSuccessfulFailoverTime:
{
Description: The Last successful failover time. ,
Format: date-time ,
Required: False ,
}
string ,
lastSuccessfulTestFailoverTime:
{
Description: The Last successful test failover time. ,
Format: date-time ,
Required: False ,
}
string ,
currentScenario:
{
Description: The current scenario. ,
Required: False ,
}
{
scenarioName:
{
Description: Scenario name. ,
Required: False ,
}
string ,
jobId:
{
Description: ARM Id of the job being executed. ,
Required: False ,
}
string ,
startTime:
{
Description: Start time of the workflow. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
failoverRecoveryPointId:
{
Description: The recovery point ARM Id to which the Vm was failed over. ,
Required: False ,
}
string ,
providerSpecificDetails:
{
Description: The Replication provider custom settings. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the Instance type. ,
Required: True ,
}
string ,
}
,
recoveryContainerId:
{
Description: The recovery container Id. ,
Required: False ,
}
string ,
eventCorrelationId:
{
Description: The correlation Id for events associated with this protected item. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}
ReplicationProtectedItems_RepairReplication (new)
Description :  The operation to start resynchronize/repair replication for a replication protected item requiring resynchronization.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/repairReplication
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: The name of the fabric. ,
Required: True ,
}
string ,
protectionContainerName:
{
Description: The name of the container. ,
Required: True ,
}
string ,
replicatedProtectedItemName:
{
Description: The name of the replication protected item. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The custom data. ,
Required: False ,
}
{
friendlyName:
{
Description: The name. ,
Required: False ,
}
string ,
protectedItemType:
{
Description: The type of protected item type. ,
Required: False ,
}
string ,
protectableItemId:
{
Description: The protected item ARM Id. ,
Required: False ,
}
string ,
recoveryServicesProviderId:
{
Description: The recovery provider ARM Id. ,
Required: False ,
}
string ,
primaryFabricFriendlyName:
{
Description: The friendly name of the primary fabric. ,
Required: False ,
}
string ,
primaryFabricProvider:
{
Description: The fabric provider of the primary fabric. ,
Required: False ,
}
string ,
recoveryFabricFriendlyName:
{
Description: The friendly name of recovery fabric. ,
Required: False ,
}
string ,
recoveryFabricId:
{
Description: The Arm Id of recovery fabric. ,
Required: False ,
}
string ,
primaryProtectionContainerFriendlyName:
{
Description: The name of primary protection container friendly name. ,
Required: False ,
}
string ,
recoveryProtectionContainerFriendlyName:
{
Description: The name of recovery container friendly name. ,
Required: False ,
}
string ,
protectionState:
{
Description: The protection status. ,
Required: False ,
}
string ,
protectionStateDescription:
{
Description: The protection state description. ,
Required: False ,
}
string ,
activeLocation:
{
Description: The Current active location of the PE. ,
Required: False ,
}
string ,
testFailoverState:
{
Description: The Test failover state. ,
Required: False ,
}
string ,
testFailoverStateDescription:
{
Description: The Test failover state description. ,
Required: False ,
}
string ,
switchProviderState:
{
Description: The switch provider state. ,
Required: False ,
}
string ,
switchProviderStateDescription:
{
Description: The switch provider state description. ,
Required: False ,
}
string ,
allowedOperations:
{
Description: The allowed operations on the Replication protected item. ,
Required: False ,
}
[
string ,
]
,
replicationHealth:
{
Description: 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. ,
Required: False ,
}
string ,
failoverHealth:
{
Description: The consolidated failover health for the VM. ,
Required: False ,
}
string ,
healthErrors:
{
Description: List of health errors. ,
Required: False ,
}
[
{
innerHealthErrors:
{
Description: 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. ,
Required: False ,
}
[
{
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
policyId:
{
Description: The ID of Policy governing this PE. ,
Required: False ,
}
string ,
policyFriendlyName:
{
Description: The name of Policy governing this PE. ,
Required: False ,
}
string ,
lastSuccessfulFailoverTime:
{
Description: The Last successful failover time. ,
Format: date-time ,
Required: False ,
}
string ,
lastSuccessfulTestFailoverTime:
{
Description: The Last successful test failover time. ,
Format: date-time ,
Required: False ,
}
string ,
currentScenario:
{
Description: The current scenario. ,
Required: False ,
}
{
scenarioName:
{
Description: Scenario name. ,
Required: False ,
}
string ,
jobId:
{
Description: ARM Id of the job being executed. ,
Required: False ,
}
string ,
startTime:
{
Description: Start time of the workflow. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
failoverRecoveryPointId:
{
Description: The recovery point ARM Id to which the Vm was failed over. ,
Required: False ,
}
string ,
providerSpecificDetails:
{
Description: The Replication provider custom settings. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the Instance type. ,
Required: True ,
}
string ,
}
,
recoveryContainerId:
{
Description: The recovery container Id. ,
Required: False ,
}
string ,
eventCorrelationId:
{
Description: The correlation Id for events associated with this protected item. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}
ReplicationProtectedItems_Reprotect (new)
Description :  Operation to reprotect or reverse replicate a failed over replication protected item.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/reProtect
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Unique fabric name. ,
Required: True ,
}
string ,
protectionContainerName:
{
Description: Protection container name. ,
Required: True ,
}
string ,
replicatedProtectedItemName:
{
Description: Replication protected item name. ,
Required: True ,
}
string ,
reprotectInput:
{
Description: Reverse replication input. ,
Required: True ,
}
{
properties:
{
Description: Reverse replication properties. ,
Required: False ,
}
{
failoverDirection:
{
Description: Failover direction. ,
Required: False ,
}
string ,
providerSpecificDetails:
{
Description: Provider specific reverse replication input. ,
Required: False ,
}
{
instanceType:
{
Description: The class type. ,
Required: True ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The custom data. ,
Required: False ,
}
{
friendlyName:
{
Description: The name. ,
Required: False ,
}
string ,
protectedItemType:
{
Description: The type of protected item type. ,
Required: False ,
}
string ,
protectableItemId:
{
Description: The protected item ARM Id. ,
Required: False ,
}
string ,
recoveryServicesProviderId:
{
Description: The recovery provider ARM Id. ,
Required: False ,
}
string ,
primaryFabricFriendlyName:
{
Description: The friendly name of the primary fabric. ,
Required: False ,
}
string ,
primaryFabricProvider:
{
Description: The fabric provider of the primary fabric. ,
Required: False ,
}
string ,
recoveryFabricFriendlyName:
{
Description: The friendly name of recovery fabric. ,
Required: False ,
}
string ,
recoveryFabricId:
{
Description: The Arm Id of recovery fabric. ,
Required: False ,
}
string ,
primaryProtectionContainerFriendlyName:
{
Description: The name of primary protection container friendly name. ,
Required: False ,
}
string ,
recoveryProtectionContainerFriendlyName:
{
Description: The name of recovery container friendly name. ,
Required: False ,
}
string ,
protectionState:
{
Description: The protection status. ,
Required: False ,
}
string ,
protectionStateDescription:
{
Description: The protection state description. ,
Required: False ,
}
string ,
activeLocation:
{
Description: The Current active location of the PE. ,
Required: False ,
}
string ,
testFailoverState:
{
Description: The Test failover state. ,
Required: False ,
}
string ,
testFailoverStateDescription:
{
Description: The Test failover state description. ,
Required: False ,
}
string ,
switchProviderState:
{
Description: The switch provider state. ,
Required: False ,
}
string ,
switchProviderStateDescription:
{
Description: The switch provider state description. ,
Required: False ,
}
string ,
allowedOperations:
{
Description: The allowed operations on the Replication protected item. ,
Required: False ,
}
[
string ,
]
,
replicationHealth:
{
Description: 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. ,
Required: False ,
}
string ,
failoverHealth:
{
Description: The consolidated failover health for the VM. ,
Required: False ,
}
string ,
healthErrors:
{
Description: List of health errors. ,
Required: False ,
}
[
{
innerHealthErrors:
{
Description: 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. ,
Required: False ,
}
[
{
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
policyId:
{
Description: The ID of Policy governing this PE. ,
Required: False ,
}
string ,
policyFriendlyName:
{
Description: The name of Policy governing this PE. ,
Required: False ,
}
string ,
lastSuccessfulFailoverTime:
{
Description: The Last successful failover time. ,
Format: date-time ,
Required: False ,
}
string ,
lastSuccessfulTestFailoverTime:
{
Description: The Last successful test failover time. ,
Format: date-time ,
Required: False ,
}
string ,
currentScenario:
{
Description: The current scenario. ,
Required: False ,
}
{
scenarioName:
{
Description: Scenario name. ,
Required: False ,
}
string ,
jobId:
{
Description: ARM Id of the job being executed. ,
Required: False ,
}
string ,
startTime:
{
Description: Start time of the workflow. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
failoverRecoveryPointId:
{
Description: The recovery point ARM Id to which the Vm was failed over. ,
Required: False ,
}
string ,
providerSpecificDetails:
{
Description: The Replication provider custom settings. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the Instance type. ,
Required: True ,
}
string ,
}
,
recoveryContainerId:
{
Description: The recovery container Id. ,
Required: False ,
}
string ,
eventCorrelationId:
{
Description: The correlation Id for events associated with this protected item. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}
ReplicationProtectedItems_ResolveHealthErrors (new)
Description :  Operation to resolve health issues of the replication protected item.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/resolveHealthErrors
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Unique fabric name. ,
Required: True ,
}
string ,
protectionContainerName:
{
Description: Protection container name. ,
Required: True ,
}
string ,
replicatedProtectedItemName:
{
Description: Replication protected item name. ,
Required: True ,
}
string ,
resolveHealthInput:
{
Description: Health issue input object. ,
Required: True ,
}
{
properties:
{
Description: Disable resolve health input properties. ,
Required: False ,
}
{
healthErrors:
{
Description: Health errors. ,
Required: False ,
}
[
{
healthErrorId:
{
Description: Health error id. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The custom data. ,
Required: False ,
}
{
friendlyName:
{
Description: The name. ,
Required: False ,
}
string ,
protectedItemType:
{
Description: The type of protected item type. ,
Required: False ,
}
string ,
protectableItemId:
{
Description: The protected item ARM Id. ,
Required: False ,
}
string ,
recoveryServicesProviderId:
{
Description: The recovery provider ARM Id. ,
Required: False ,
}
string ,
primaryFabricFriendlyName:
{
Description: The friendly name of the primary fabric. ,
Required: False ,
}
string ,
primaryFabricProvider:
{
Description: The fabric provider of the primary fabric. ,
Required: False ,
}
string ,
recoveryFabricFriendlyName:
{
Description: The friendly name of recovery fabric. ,
Required: False ,
}
string ,
recoveryFabricId:
{
Description: The Arm Id of recovery fabric. ,
Required: False ,
}
string ,
primaryProtectionContainerFriendlyName:
{
Description: The name of primary protection container friendly name. ,
Required: False ,
}
string ,
recoveryProtectionContainerFriendlyName:
{
Description: The name of recovery container friendly name. ,
Required: False ,
}
string ,
protectionState:
{
Description: The protection status. ,
Required: False ,
}
string ,
protectionStateDescription:
{
Description: The protection state description. ,
Required: False ,
}
string ,
activeLocation:
{
Description: The Current active location of the PE. ,
Required: False ,
}
string ,
testFailoverState:
{
Description: The Test failover state. ,
Required: False ,
}
string ,
testFailoverStateDescription:
{
Description: The Test failover state description. ,
Required: False ,
}
string ,
switchProviderState:
{
Description: The switch provider state. ,
Required: False ,
}
string ,
switchProviderStateDescription:
{
Description: The switch provider state description. ,
Required: False ,
}
string ,
allowedOperations:
{
Description: The allowed operations on the Replication protected item. ,
Required: False ,
}
[
string ,
]
,
replicationHealth:
{
Description: 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. ,
Required: False ,
}
string ,
failoverHealth:
{
Description: The consolidated failover health for the VM. ,
Required: False ,
}
string ,
healthErrors:
{
Description: List of health errors. ,
Required: False ,
}
[
{
innerHealthErrors:
{
Description: 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. ,
Required: False ,
}
[
{
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
policyId:
{
Description: The ID of Policy governing this PE. ,
Required: False ,
}
string ,
policyFriendlyName:
{
Description: The name of Policy governing this PE. ,
Required: False ,
}
string ,
lastSuccessfulFailoverTime:
{
Description: The Last successful failover time. ,
Format: date-time ,
Required: False ,
}
string ,
lastSuccessfulTestFailoverTime:
{
Description: The Last successful test failover time. ,
Format: date-time ,
Required: False ,
}
string ,
currentScenario:
{
Description: The current scenario. ,
Required: False ,
}
{
scenarioName:
{
Description: Scenario name. ,
Required: False ,
}
string ,
jobId:
{
Description: ARM Id of the job being executed. ,
Required: False ,
}
string ,
startTime:
{
Description: Start time of the workflow. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
failoverRecoveryPointId:
{
Description: The recovery point ARM Id to which the Vm was failed over. ,
Required: False ,
}
string ,
providerSpecificDetails:
{
Description: The Replication provider custom settings. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the Instance type. ,
Required: True ,
}
string ,
}
,
recoveryContainerId:
{
Description: The recovery container Id. ,
Required: False ,
}
string ,
eventCorrelationId:
{
Description: The correlation Id for events associated with this protected item. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}
ReplicationProtectedItems_SwitchProvider (new)
Description :  Operation to initiate a switch provider of the replication protected item.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/switchProvider
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Unique fabric name. ,
Required: True ,
}
string ,
protectionContainerName:
{
Description: Protection container name. ,
Required: True ,
}
string ,
replicatedProtectedItemName:
{
Description: Replication protected item name. ,
Required: True ,
}
string ,
switchProviderInput:
{
Description: Switch provider input. ,
Required: True ,
}
{
properties:
{
Description: Switch provider input properties. ,
Required: False ,
}
{
targetInstanceType:
{
Description: Target provider type. ,
Required: False ,
}
string ,
providerSpecificDetails:
{
Description: Provider specific settings. ,
Required: False ,
}
{
instanceType:
{
Description: The class type. ,
Required: True ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The custom data. ,
Required: False ,
}
{
friendlyName:
{
Description: The name. ,
Required: False ,
}
string ,
protectedItemType:
{
Description: The type of protected item type. ,
Required: False ,
}
string ,
protectableItemId:
{
Description: The protected item ARM Id. ,
Required: False ,
}
string ,
recoveryServicesProviderId:
{
Description: The recovery provider ARM Id. ,
Required: False ,
}
string ,
primaryFabricFriendlyName:
{
Description: The friendly name of the primary fabric. ,
Required: False ,
}
string ,
primaryFabricProvider:
{
Description: The fabric provider of the primary fabric. ,
Required: False ,
}
string ,
recoveryFabricFriendlyName:
{
Description: The friendly name of recovery fabric. ,
Required: False ,
}
string ,
recoveryFabricId:
{
Description: The Arm Id of recovery fabric. ,
Required: False ,
}
string ,
primaryProtectionContainerFriendlyName:
{
Description: The name of primary protection container friendly name. ,
Required: False ,
}
string ,
recoveryProtectionContainerFriendlyName:
{
Description: The name of recovery container friendly name. ,
Required: False ,
}
string ,
protectionState:
{
Description: The protection status. ,
Required: False ,
}
string ,
protectionStateDescription:
{
Description: The protection state description. ,
Required: False ,
}
string ,
activeLocation:
{
Description: The Current active location of the PE. ,
Required: False ,
}
string ,
testFailoverState:
{
Description: The Test failover state. ,
Required: False ,
}
string ,
testFailoverStateDescription:
{
Description: The Test failover state description. ,
Required: False ,
}
string ,
switchProviderState:
{
Description: The switch provider state. ,
Required: False ,
}
string ,
switchProviderStateDescription:
{
Description: The switch provider state description. ,
Required: False ,
}
string ,
allowedOperations:
{
Description: The allowed operations on the Replication protected item. ,
Required: False ,
}
[
string ,
]
,
replicationHealth:
{
Description: 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. ,
Required: False ,
}
string ,
failoverHealth:
{
Description: The consolidated failover health for the VM. ,
Required: False ,
}
string ,
healthErrors:
{
Description: List of health errors. ,
Required: False ,
}
[
{
innerHealthErrors:
{
Description: 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. ,
Required: False ,
}
[
{
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
policyId:
{
Description: The ID of Policy governing this PE. ,
Required: False ,
}
string ,
policyFriendlyName:
{
Description: The name of Policy governing this PE. ,
Required: False ,
}
string ,
lastSuccessfulFailoverTime:
{
Description: The Last successful failover time. ,
Format: date-time ,
Required: False ,
}
string ,
lastSuccessfulTestFailoverTime:
{
Description: The Last successful test failover time. ,
Format: date-time ,
Required: False ,
}
string ,
currentScenario:
{
Description: The current scenario. ,
Required: False ,
}
{
scenarioName:
{
Description: Scenario name. ,
Required: False ,
}
string ,
jobId:
{
Description: ARM Id of the job being executed. ,
Required: False ,
}
string ,
startTime:
{
Description: Start time of the workflow. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
failoverRecoveryPointId:
{
Description: The recovery point ARM Id to which the Vm was failed over. ,
Required: False ,
}
string ,
providerSpecificDetails:
{
Description: The Replication provider custom settings. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the Instance type. ,
Required: True ,
}
string ,
}
,
recoveryContainerId:
{
Description: The recovery container Id. ,
Required: False ,
}
string ,
eventCorrelationId:
{
Description: The correlation Id for events associated with this protected item. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}
TargetComputeSizes_ListByReplicationProtectedItems (new)
Description :  Lists the available target compute sizes for a replication protected item.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/targetComputeSizes
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric name. ,
Required: True ,
}
string ,
protectionContainerName:
{
Description: protection container name. ,
Required: True ,
}
string ,
replicatedProtectedItemName:
{
Description: Replication protected item name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of target compute sizes. ,
Required: False ,
}
[
{
id:
{
Description: The Id. ,
Required: False ,
}
string ,
name:
{
Description: The name. ,
Required: False ,
}
string ,
type:
{
Description: The Type of the object. ,
Required: False ,
}
string ,
properties:
{
Description: The custom data. ,
Required: False ,
}
{
name:
{
Description: Target compute size name. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Target compute size display name. ,
Required: False ,
}
string ,
cpuCoresCount:
{
Description: The maximum cpu cores count supported by target compute size. ,
Format: int32 ,
Required: False ,
}
integer ,
vCPUsAvailable:
{
Description: The Available vCPUs supported by target compute size. ,
Format: int32 ,
Required: False ,
}
integer ,
memoryInGB:
{
Description: The maximum memory in GB supported by target compute size. ,
Format: double ,
Required: False ,
}
number ,
maxDataDiskCount:
{
Description: The maximum data disks count supported by target compute size. ,
Format: int32 ,
Required: False ,
}
integer ,
maxNicsCount:
{
Description: The maximum Nics count supported by target compute size. ,
Format: int32 ,
Required: False ,
}
integer ,
errors:
{
Description: The reasons why the target compute size is not applicable for the protected item. ,
Required: False ,
}
[
{
message:
{
Description: The error message. ,
Required: False ,
}
string ,
severity:
{
Description: The severity of the error. ,
Required: False ,
}
string ,
}
,
]
,
highIopsSupported:
{
Description: The value indicating whether the target compute size supports high Iops. ,
Required: False ,
}
string ,
hyperVGenerations:
{
Description: The supported HyperV Generations. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The value of next link. ,
Required: False ,
}
string ,
}
ReplicationProtectedItems_TestFailover (new)
Description :  Operation to perform a test failover of the replication protected item.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/testFailover
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Unique fabric name. ,
Required: True ,
}
string ,
protectionContainerName:
{
Description: Protection container name. ,
Required: True ,
}
string ,
replicatedProtectedItemName:
{
Description: Replication protected item name. ,
Required: True ,
}
string ,
testfailoverInput:
{
Description: Test failover input. ,
Required: True ,
}
{
properties:
{
Description: Test failover input properties. ,
Required: True ,
}
{
failoverDirection:
{
Description: Test failover direction. ,
Required: False ,
}
string ,
networkType:
{
Description: Network type to be used for test failover. ,
Required: False ,
}
string ,
networkId:
{
Description: The id of the network to be used for test failover. ,
Required: False ,
}
string ,
providerSpecificDetails:
{
Description: Provider specific settings. ,
Required: False ,
}
{
instanceType:
{
Description: The class type. ,
Required: True ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The custom data. ,
Required: False ,
}
{
friendlyName:
{
Description: The name. ,
Required: False ,
}
string ,
protectedItemType:
{
Description: The type of protected item type. ,
Required: False ,
}
string ,
protectableItemId:
{
Description: The protected item ARM Id. ,
Required: False ,
}
string ,
recoveryServicesProviderId:
{
Description: The recovery provider ARM Id. ,
Required: False ,
}
string ,
primaryFabricFriendlyName:
{
Description: The friendly name of the primary fabric. ,
Required: False ,
}
string ,
primaryFabricProvider:
{
Description: The fabric provider of the primary fabric. ,
Required: False ,
}
string ,
recoveryFabricFriendlyName:
{
Description: The friendly name of recovery fabric. ,
Required: False ,
}
string ,
recoveryFabricId:
{
Description: The Arm Id of recovery fabric. ,
Required: False ,
}
string ,
primaryProtectionContainerFriendlyName:
{
Description: The name of primary protection container friendly name. ,
Required: False ,
}
string ,
recoveryProtectionContainerFriendlyName:
{
Description: The name of recovery container friendly name. ,
Required: False ,
}
string ,
protectionState:
{
Description: The protection status. ,
Required: False ,
}
string ,
protectionStateDescription:
{
Description: The protection state description. ,
Required: False ,
}
string ,
activeLocation:
{
Description: The Current active location of the PE. ,
Required: False ,
}
string ,
testFailoverState:
{
Description: The Test failover state. ,
Required: False ,
}
string ,
testFailoverStateDescription:
{
Description: The Test failover state description. ,
Required: False ,
}
string ,
switchProviderState:
{
Description: The switch provider state. ,
Required: False ,
}
string ,
switchProviderStateDescription:
{
Description: The switch provider state description. ,
Required: False ,
}
string ,
allowedOperations:
{
Description: The allowed operations on the Replication protected item. ,
Required: False ,
}
[
string ,
]
,
replicationHealth:
{
Description: 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. ,
Required: False ,
}
string ,
failoverHealth:
{
Description: The consolidated failover health for the VM. ,
Required: False ,
}
string ,
healthErrors:
{
Description: List of health errors. ,
Required: False ,
}
[
{
innerHealthErrors:
{
Description: 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. ,
Required: False ,
}
[
{
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
policyId:
{
Description: The ID of Policy governing this PE. ,
Required: False ,
}
string ,
policyFriendlyName:
{
Description: The name of Policy governing this PE. ,
Required: False ,
}
string ,
lastSuccessfulFailoverTime:
{
Description: The Last successful failover time. ,
Format: date-time ,
Required: False ,
}
string ,
lastSuccessfulTestFailoverTime:
{
Description: The Last successful test failover time. ,
Format: date-time ,
Required: False ,
}
string ,
currentScenario:
{
Description: The current scenario. ,
Required: False ,
}
{
scenarioName:
{
Description: Scenario name. ,
Required: False ,
}
string ,
jobId:
{
Description: ARM Id of the job being executed. ,
Required: False ,
}
string ,
startTime:
{
Description: Start time of the workflow. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
failoverRecoveryPointId:
{
Description: The recovery point ARM Id to which the Vm was failed over. ,
Required: False ,
}
string ,
providerSpecificDetails:
{
Description: The Replication provider custom settings. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the Instance type. ,
Required: True ,
}
string ,
}
,
recoveryContainerId:
{
Description: The recovery container Id. ,
Required: False ,
}
string ,
eventCorrelationId:
{
Description: The correlation Id for events associated with this protected item. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}
ReplicationProtectedItems_TestFailoverCleanup (new)
Description :  Operation to clean up the test failover of a replication protected item.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/testFailoverCleanup
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Unique fabric name. ,
Required: True ,
}
string ,
protectionContainerName:
{
Description: Protection container name. ,
Required: True ,
}
string ,
replicatedProtectedItemName:
{
Description: Replication protected item name. ,
Required: True ,
}
string ,
cleanupInput:
{
Description: Test failover cleanup input. ,
Required: True ,
}
{
properties:
{
Description: Test failover cleanup input properties. ,
Required: True ,
}
{
comments:
{
Description: Test failover cleanup comments. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The custom data. ,
Required: False ,
}
{
friendlyName:
{
Description: The name. ,
Required: False ,
}
string ,
protectedItemType:
{
Description: The type of protected item type. ,
Required: False ,
}
string ,
protectableItemId:
{
Description: The protected item ARM Id. ,
Required: False ,
}
string ,
recoveryServicesProviderId:
{
Description: The recovery provider ARM Id. ,
Required: False ,
}
string ,
primaryFabricFriendlyName:
{
Description: The friendly name of the primary fabric. ,
Required: False ,
}
string ,
primaryFabricProvider:
{
Description: The fabric provider of the primary fabric. ,
Required: False ,
}
string ,
recoveryFabricFriendlyName:
{
Description: The friendly name of recovery fabric. ,
Required: False ,
}
string ,
recoveryFabricId:
{
Description: The Arm Id of recovery fabric. ,
Required: False ,
}
string ,
primaryProtectionContainerFriendlyName:
{
Description: The name of primary protection container friendly name. ,
Required: False ,
}
string ,
recoveryProtectionContainerFriendlyName:
{
Description: The name of recovery container friendly name. ,
Required: False ,
}
string ,
protectionState:
{
Description: The protection status. ,
Required: False ,
}
string ,
protectionStateDescription:
{
Description: The protection state description. ,
Required: False ,
}
string ,
activeLocation:
{
Description: The Current active location of the PE. ,
Required: False ,
}
string ,
testFailoverState:
{
Description: The Test failover state. ,
Required: False ,
}
string ,
testFailoverStateDescription:
{
Description: The Test failover state description. ,
Required: False ,
}
string ,
switchProviderState:
{
Description: The switch provider state. ,
Required: False ,
}
string ,
switchProviderStateDescription:
{
Description: The switch provider state description. ,
Required: False ,
}
string ,
allowedOperations:
{
Description: The allowed operations on the Replication protected item. ,
Required: False ,
}
[
string ,
]
,
replicationHealth:
{
Description: 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. ,
Required: False ,
}
string ,
failoverHealth:
{
Description: The consolidated failover health for the VM. ,
Required: False ,
}
string ,
healthErrors:
{
Description: List of health errors. ,
Required: False ,
}
[
{
innerHealthErrors:
{
Description: 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. ,
Required: False ,
}
[
{
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
policyId:
{
Description: The ID of Policy governing this PE. ,
Required: False ,
}
string ,
policyFriendlyName:
{
Description: The name of Policy governing this PE. ,
Required: False ,
}
string ,
lastSuccessfulFailoverTime:
{
Description: The Last successful failover time. ,
Format: date-time ,
Required: False ,
}
string ,
lastSuccessfulTestFailoverTime:
{
Description: The Last successful test failover time. ,
Format: date-time ,
Required: False ,
}
string ,
currentScenario:
{
Description: The current scenario. ,
Required: False ,
}
{
scenarioName:
{
Description: Scenario name. ,
Required: False ,
}
string ,
jobId:
{
Description: ARM Id of the job being executed. ,
Required: False ,
}
string ,
startTime:
{
Description: Start time of the workflow. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
failoverRecoveryPointId:
{
Description: The recovery point ARM Id to which the Vm was failed over. ,
Required: False ,
}
string ,
providerSpecificDetails:
{
Description: The Replication provider custom settings. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the Instance type. ,
Required: True ,
}
string ,
}
,
recoveryContainerId:
{
Description: The recovery container Id. ,
Required: False ,
}
string ,
eventCorrelationId:
{
Description: The correlation Id for events associated with this protected item. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}
ReplicationProtectedItems_UnplannedFailover (new)
Description :  Operation to initiate a failover of the replication protected item.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/unplannedFailover
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Unique fabric name. ,
Required: True ,
}
string ,
protectionContainerName:
{
Description: Protection container name. ,
Required: True ,
}
string ,
replicatedProtectedItemName:
{
Description: Replication protected item name. ,
Required: True ,
}
string ,
failoverInput:
{
Description: Failover input. ,
Required: True ,
}
{
properties:
{
Description: Unplanned failover input properties. ,
Required: True ,
}
{
failoverDirection:
{
Description: Failover direction. ,
Required: False ,
}
string ,
sourceSiteOperations:
{
Description: Source site operations status. ,
Required: False ,
}
string ,
providerSpecificDetails:
{
Description: Provider specific settings. ,
Required: False ,
}
{
instanceType:
{
Description: The class type. ,
Required: True ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The custom data. ,
Required: False ,
}
{
friendlyName:
{
Description: The name. ,
Required: False ,
}
string ,
protectedItemType:
{
Description: The type of protected item type. ,
Required: False ,
}
string ,
protectableItemId:
{
Description: The protected item ARM Id. ,
Required: False ,
}
string ,
recoveryServicesProviderId:
{
Description: The recovery provider ARM Id. ,
Required: False ,
}
string ,
primaryFabricFriendlyName:
{
Description: The friendly name of the primary fabric. ,
Required: False ,
}
string ,
primaryFabricProvider:
{
Description: The fabric provider of the primary fabric. ,
Required: False ,
}
string ,
recoveryFabricFriendlyName:
{
Description: The friendly name of recovery fabric. ,
Required: False ,
}
string ,
recoveryFabricId:
{
Description: The Arm Id of recovery fabric. ,
Required: False ,
}
string ,
primaryProtectionContainerFriendlyName:
{
Description: The name of primary protection container friendly name. ,
Required: False ,
}
string ,
recoveryProtectionContainerFriendlyName:
{
Description: The name of recovery container friendly name. ,
Required: False ,
}
string ,
protectionState:
{
Description: The protection status. ,
Required: False ,
}
string ,
protectionStateDescription:
{
Description: The protection state description. ,
Required: False ,
}
string ,
activeLocation:
{
Description: The Current active location of the PE. ,
Required: False ,
}
string ,
testFailoverState:
{
Description: The Test failover state. ,
Required: False ,
}
string ,
testFailoverStateDescription:
{
Description: The Test failover state description. ,
Required: False ,
}
string ,
switchProviderState:
{
Description: The switch provider state. ,
Required: False ,
}
string ,
switchProviderStateDescription:
{
Description: The switch provider state description. ,
Required: False ,
}
string ,
allowedOperations:
{
Description: The allowed operations on the Replication protected item. ,
Required: False ,
}
[
string ,
]
,
replicationHealth:
{
Description: 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. ,
Required: False ,
}
string ,
failoverHealth:
{
Description: The consolidated failover health for the VM. ,
Required: False ,
}
string ,
healthErrors:
{
Description: List of health errors. ,
Required: False ,
}
[
{
innerHealthErrors:
{
Description: 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. ,
Required: False ,
}
[
{
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
policyId:
{
Description: The ID of Policy governing this PE. ,
Required: False ,
}
string ,
policyFriendlyName:
{
Description: The name of Policy governing this PE. ,
Required: False ,
}
string ,
lastSuccessfulFailoverTime:
{
Description: The Last successful failover time. ,
Format: date-time ,
Required: False ,
}
string ,
lastSuccessfulTestFailoverTime:
{
Description: The Last successful test failover time. ,
Format: date-time ,
Required: False ,
}
string ,
currentScenario:
{
Description: The current scenario. ,
Required: False ,
}
{
scenarioName:
{
Description: Scenario name. ,
Required: False ,
}
string ,
jobId:
{
Description: ARM Id of the job being executed. ,
Required: False ,
}
string ,
startTime:
{
Description: Start time of the workflow. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
failoverRecoveryPointId:
{
Description: The recovery point ARM Id to which the Vm was failed over. ,
Required: False ,
}
string ,
providerSpecificDetails:
{
Description: The Replication provider custom settings. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the Instance type. ,
Required: True ,
}
string ,
}
,
recoveryContainerId:
{
Description: The recovery container Id. ,
Required: False ,
}
string ,
eventCorrelationId:
{
Description: The correlation Id for events associated with this protected item. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}
ReplicationProtectedItems_UpdateAppliance (new)
Description :  The operation to update appliance of an ASR replication protected item.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/updateAppliance
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric name. ,
Required: True ,
}
string ,
protectionContainerName:
{
Description: Protection container name. ,
Required: True ,
}
string ,
replicatedProtectedItemName:
{
Description: Replication protected item name. ,
Required: True ,
}
string ,
applianceUpdateInput:
{
Description: Appliance update protection input. ,
Required: True ,
}
{
properties:
{
Description: Update appliance replication protected item properties. ,
Required: True ,
}
{
targetApplianceId:
{
Description: The target appliance Id. ,
Required: True ,
}
string ,
providerSpecificDetails:
{
Description: The provider specific input to update replication protected item. ,
Required: True ,
}
{
instanceType:
{
Description: The class type. ,
Required: True ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The custom data. ,
Required: False ,
}
{
friendlyName:
{
Description: The name. ,
Required: False ,
}
string ,
protectedItemType:
{
Description: The type of protected item type. ,
Required: False ,
}
string ,
protectableItemId:
{
Description: The protected item ARM Id. ,
Required: False ,
}
string ,
recoveryServicesProviderId:
{
Description: The recovery provider ARM Id. ,
Required: False ,
}
string ,
primaryFabricFriendlyName:
{
Description: The friendly name of the primary fabric. ,
Required: False ,
}
string ,
primaryFabricProvider:
{
Description: The fabric provider of the primary fabric. ,
Required: False ,
}
string ,
recoveryFabricFriendlyName:
{
Description: The friendly name of recovery fabric. ,
Required: False ,
}
string ,
recoveryFabricId:
{
Description: The Arm Id of recovery fabric. ,
Required: False ,
}
string ,
primaryProtectionContainerFriendlyName:
{
Description: The name of primary protection container friendly name. ,
Required: False ,
}
string ,
recoveryProtectionContainerFriendlyName:
{
Description: The name of recovery container friendly name. ,
Required: False ,
}
string ,
protectionState:
{
Description: The protection status. ,
Required: False ,
}
string ,
protectionStateDescription:
{
Description: The protection state description. ,
Required: False ,
}
string ,
activeLocation:
{
Description: The Current active location of the PE. ,
Required: False ,
}
string ,
testFailoverState:
{
Description: The Test failover state. ,
Required: False ,
}
string ,
testFailoverStateDescription:
{
Description: The Test failover state description. ,
Required: False ,
}
string ,
switchProviderState:
{
Description: The switch provider state. ,
Required: False ,
}
string ,
switchProviderStateDescription:
{
Description: The switch provider state description. ,
Required: False ,
}
string ,
allowedOperations:
{
Description: The allowed operations on the Replication protected item. ,
Required: False ,
}
[
string ,
]
,
replicationHealth:
{
Description: 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. ,
Required: False ,
}
string ,
failoverHealth:
{
Description: The consolidated failover health for the VM. ,
Required: False ,
}
string ,
healthErrors:
{
Description: List of health errors. ,
Required: False ,
}
[
{
innerHealthErrors:
{
Description: 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. ,
Required: False ,
}
[
{
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
policyId:
{
Description: The ID of Policy governing this PE. ,
Required: False ,
}
string ,
policyFriendlyName:
{
Description: The name of Policy governing this PE. ,
Required: False ,
}
string ,
lastSuccessfulFailoverTime:
{
Description: The Last successful failover time. ,
Format: date-time ,
Required: False ,
}
string ,
lastSuccessfulTestFailoverTime:
{
Description: The Last successful test failover time. ,
Format: date-time ,
Required: False ,
}
string ,
currentScenario:
{
Description: The current scenario. ,
Required: False ,
}
{
scenarioName:
{
Description: Scenario name. ,
Required: False ,
}
string ,
jobId:
{
Description: ARM Id of the job being executed. ,
Required: False ,
}
string ,
startTime:
{
Description: Start time of the workflow. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
failoverRecoveryPointId:
{
Description: The recovery point ARM Id to which the Vm was failed over. ,
Required: False ,
}
string ,
providerSpecificDetails:
{
Description: The Replication provider custom settings. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the Instance type. ,
Required: True ,
}
string ,
}
,
recoveryContainerId:
{
Description: The recovery container Id. ,
Required: False ,
}
string ,
eventCorrelationId:
{
Description: The correlation Id for events associated with this protected item. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}
ReplicationProtectedItems_UpdateMobilityService (new)
Description :  The operation to update(push update) the installed mobility service software on a replication protected item to the latest available version.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/updateMobilityService
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: The name of the fabric containing the protected item. ,
Required: True ,
}
string ,
protectionContainerName:
{
Description: The name of the container containing the protected item. ,
Required: True ,
}
string ,
replicatedProtectedItemName:
{
Description: The name of the protected item on which the agent is to be updated. ,
Required: True ,
}
string ,
updateMobilityServiceRequest:
{
Description: Request to update the mobility service on the protected item. ,
Required: True ,
}
{
properties:
{
Description: The properties of the update mobility service request. ,
Required: False ,
}
{
runAsAccountId:
{
Description: The CS run as account Id. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The custom data. ,
Required: False ,
}
{
friendlyName:
{
Description: The name. ,
Required: False ,
}
string ,
protectedItemType:
{
Description: The type of protected item type. ,
Required: False ,
}
string ,
protectableItemId:
{
Description: The protected item ARM Id. ,
Required: False ,
}
string ,
recoveryServicesProviderId:
{
Description: The recovery provider ARM Id. ,
Required: False ,
}
string ,
primaryFabricFriendlyName:
{
Description: The friendly name of the primary fabric. ,
Required: False ,
}
string ,
primaryFabricProvider:
{
Description: The fabric provider of the primary fabric. ,
Required: False ,
}
string ,
recoveryFabricFriendlyName:
{
Description: The friendly name of recovery fabric. ,
Required: False ,
}
string ,
recoveryFabricId:
{
Description: The Arm Id of recovery fabric. ,
Required: False ,
}
string ,
primaryProtectionContainerFriendlyName:
{
Description: The name of primary protection container friendly name. ,
Required: False ,
}
string ,
recoveryProtectionContainerFriendlyName:
{
Description: The name of recovery container friendly name. ,
Required: False ,
}
string ,
protectionState:
{
Description: The protection status. ,
Required: False ,
}
string ,
protectionStateDescription:
{
Description: The protection state description. ,
Required: False ,
}
string ,
activeLocation:
{
Description: The Current active location of the PE. ,
Required: False ,
}
string ,
testFailoverState:
{
Description: The Test failover state. ,
Required: False ,
}
string ,
testFailoverStateDescription:
{
Description: The Test failover state description. ,
Required: False ,
}
string ,
switchProviderState:
{
Description: The switch provider state. ,
Required: False ,
}
string ,
switchProviderStateDescription:
{
Description: The switch provider state description. ,
Required: False ,
}
string ,
allowedOperations:
{
Description: The allowed operations on the Replication protected item. ,
Required: False ,
}
[
string ,
]
,
replicationHealth:
{
Description: 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. ,
Required: False ,
}
string ,
failoverHealth:
{
Description: The consolidated failover health for the VM. ,
Required: False ,
}
string ,
healthErrors:
{
Description: List of health errors. ,
Required: False ,
}
[
{
innerHealthErrors:
{
Description: 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. ,
Required: False ,
}
[
{
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
policyId:
{
Description: The ID of Policy governing this PE. ,
Required: False ,
}
string ,
policyFriendlyName:
{
Description: The name of Policy governing this PE. ,
Required: False ,
}
string ,
lastSuccessfulFailoverTime:
{
Description: The Last successful failover time. ,
Format: date-time ,
Required: False ,
}
string ,
lastSuccessfulTestFailoverTime:
{
Description: The Last successful test failover time. ,
Format: date-time ,
Required: False ,
}
string ,
currentScenario:
{
Description: The current scenario. ,
Required: False ,
}
{
scenarioName:
{
Description: Scenario name. ,
Required: False ,
}
string ,
jobId:
{
Description: ARM Id of the job being executed. ,
Required: False ,
}
string ,
startTime:
{
Description: Start time of the workflow. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
failoverRecoveryPointId:
{
Description: The recovery point ARM Id to which the Vm was failed over. ,
Required: False ,
}
string ,
providerSpecificDetails:
{
Description: The Replication provider custom settings. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the Instance type. ,
Required: True ,
}
string ,
}
,
recoveryContainerId:
{
Description: The recovery container Id. ,
Required: False ,
}
string ,
eventCorrelationId:
{
Description: The correlation Id for events associated with this protected item. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
location: string ,
}
ReplicationProtectionClusters_ListByReplicationProtectionContainers (new)
Description :  Gets the list of ASR replication protected clusters in the protection container.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectionClusters
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric name. ,
Required: True ,
}
string ,
protectionContainerName:
{
Description: Protection container name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Replication protection cluster details. ,
Required: False ,
}
[
{
id:
{
Description: The protection cluster Id. ,
Required: False ,
}
string ,
name:
{
Description: The name of the protection cluster. ,
Required: False ,
}
string ,
type:
{
Description: The Type of the object. ,
Required: False ,
}
string ,
properties:
{
Description: The custom data. ,
Required: False ,
}
{
protectionClusterType:
{
Description: The type of protection cluster type. ,
Required: False ,
}
string ,
primaryFabricFriendlyName:
{
Description: The friendly name of the primary fabric. ,
Required: False ,
}
string ,
primaryFabricProvider:
{
Description: The fabric provider of the primary fabric. ,
Required: False ,
}
string ,
recoveryFabricFriendlyName:
{
Description: The friendly name of recovery fabric. ,
Required: False ,
}
string ,
recoveryFabricId:
{
Description: The Arm Id of recovery fabric. ,
Format: arm-id ,
Required: False ,
}
string ,
primaryProtectionContainerFriendlyName:
{
Description: The name of primary protection container friendly name. ,
Required: False ,
}
string ,
recoveryProtectionContainerFriendlyName:
{
Description: The name of recovery container friendly name. ,
Required: False ,
}
string ,
protectionState:
{
Description: The protection status. ,
Required: False ,
}
string ,
protectionStateDescription:
{
Description: The protection state description. ,
Required: False ,
}
string ,
activeLocation:
{
Description: The Current active location of the Protection cluster. ,
Required: False ,
}
string ,
testFailoverState:
{
Description: The Test failover state. ,
Required: False ,
}
string ,
testFailoverStateDescription:
{
Description: The Test failover state description. ,
Required: False ,
}
string ,
allowedOperations:
{
Description: The allowed operations on the Replication protection cluster. ,
Required: False ,
}
[
string ,
]
,
replicationHealth:
{
Description: 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. ,
Required: False ,
}
string ,
healthErrors:
{
Description: List of health errors. ,
Required: False ,
}
[
{
innerHealthErrors:
{
Description: 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. ,
Required: False ,
}
[
{
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
lastSuccessfulFailoverTime:
{
Description: The last successful failover time. ,
Format: date-time ,
Required: False ,
}
string ,
lastSuccessfulTestFailoverTime:
{
Description: The last successful test failover time. ,
Format: date-time ,
Required: False ,
}
string ,
policyFriendlyName:
{
Description: The name of Policy governing this PE. ,
Required: False ,
}
string ,
currentScenario:
{
Description: The current scenario. ,
Required: False ,
}
{
scenarioName:
{
Description: Scenario name. ,
Required: False ,
}
string ,
jobId:
{
Description: ARM Id of the job being executed. ,
Required: False ,
}
string ,
startTime:
{
Description: Start time of the workflow. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
recoveryContainerId:
{
Description: The recovery container Id. ,
Format: arm-id ,
Required: False ,
}
string ,
agentClusterId:
{
Description: The Agent cluster Id. ,
Required: False ,
}
string ,
clusterFqdn:
{
Description: The cluster FQDN. ,
Required: False ,
}
string ,
clusterNodeFqdns:
{
Description: The List of cluster Node FQDNs. ,
Required: False ,
}
[
string ,
]
,
clusterProtectedItemIds:
{
Description: The List of Protected Item Id's. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the cluster. ,
Required: False ,
}
string ,
areAllClusterNodesRegistered:
{
Description: A value indicating whether all nodes of the cluster are registered or not. ,
Required: False ,
}
boolean ,
clusterRegisteredNodes:
{
Description: The registered node details. ,
Required: False ,
}
[
{
clusterNodeFqdn:
{
Description: The cluster node name. ,
Required: False ,
}
string ,
machineId:
{
Description: The machine ID. ,
Required: False ,
}
string ,
biosId:
{
Description: The BIOS ID. ,
Required: False ,
}
string ,
isSharedDiskVirtualNode:
{
Description: A value indicating whether this represents virtual entity hosting all the shared disks. ,
Required: False ,
}
boolean ,
}
,
]
,
providerSpecificDetails:
{
Description: The Replication cluster provider custom settings. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the Instance type. ,
Required: True ,
}
string ,
}
,
sharedDiskProperties:
{
Description: The shared disk properties. ,
Required: False ,
}
{
protectionState:
{
Description: The protection state of shared disk. ,
Required: False ,
}
string ,
testFailoverState:
{
Description: The tfo state of shared disk. ,
Required: False ,
}
string ,
activeLocation:
{
Description: The Current active location of the PE. ,
Required: False ,
}
string ,
allowedOperations:
{
Description: The allowed operations on the Replication protected item. ,
Required: False ,
}
[
string ,
]
,
replicationHealth:
{
Description: 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. ,
Required: False ,
}
string ,
healthErrors:
{
Description: List of health errors. ,
Required: False ,
}
[
{
innerHealthErrors:
{
Description: 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. ,
Required: False ,
}
[
{
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
currentScenario:
{
Description: The current scenario. ,
Required: False ,
}
{
scenarioName:
{
Description: Scenario name. ,
Required: False ,
}
string ,
jobId:
{
Description: ARM Id of the job being executed. ,
Required: False ,
}
string ,
startTime:
{
Description: Start time of the workflow. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
sharedDiskProviderSpecificDetails:
{
Description: The Replication provider custom settings. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the Instance type. ,
Required: True ,
}
string ,
}
,
}
,
policyId:
{
Description: The Policy Id. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The value of next link. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ReplicationProtectionClusters_Get (new)
Description :  Gets the details of an ASR replication protection cluster.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectionClusters/{replicationProtectionClusterName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric name. ,
Required: True ,
}
string ,
protectionContainerName:
{
Description: Protection container name. ,
Required: True ,
}
string ,
replicationProtectionClusterName:
{
Description: Replication protection cluster name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The protection cluster Id. ,
Required: False ,
}
string ,
name:
{
Description: The name of the protection cluster. ,
Required: False ,
}
string ,
type:
{
Description: The Type of the object. ,
Required: False ,
}
string ,
properties:
{
Description: The custom data. ,
Required: False ,
}
{
protectionClusterType:
{
Description: The type of protection cluster type. ,
Required: False ,
}
string ,
primaryFabricFriendlyName:
{
Description: The friendly name of the primary fabric. ,
Required: False ,
}
string ,
primaryFabricProvider:
{
Description: The fabric provider of the primary fabric. ,
Required: False ,
}
string ,
recoveryFabricFriendlyName:
{
Description: The friendly name of recovery fabric. ,
Required: False ,
}
string ,
recoveryFabricId:
{
Description: The Arm Id of recovery fabric. ,
Format: arm-id ,
Required: False ,
}
string ,
primaryProtectionContainerFriendlyName:
{
Description: The name of primary protection container friendly name. ,
Required: False ,
}
string ,
recoveryProtectionContainerFriendlyName:
{
Description: The name of recovery container friendly name. ,
Required: False ,
}
string ,
protectionState:
{
Description: The protection status. ,
Required: False ,
}
string ,
protectionStateDescription:
{
Description: The protection state description. ,
Required: False ,
}
string ,
activeLocation:
{
Description: The Current active location of the Protection cluster. ,
Required: False ,
}
string ,
testFailoverState:
{
Description: The Test failover state. ,
Required: False ,
}
string ,
testFailoverStateDescription:
{
Description: The Test failover state description. ,
Required: False ,
}
string ,
allowedOperations:
{
Description: The allowed operations on the Replication protection cluster. ,
Required: False ,
}
[
string ,
]
,
replicationHealth:
{
Description: 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. ,
Required: False ,
}
string ,
healthErrors:
{
Description: List of health errors. ,
Required: False ,
}
[
{
innerHealthErrors:
{
Description: 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. ,
Required: False ,
}
[
{
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
lastSuccessfulFailoverTime:
{
Description: The last successful failover time. ,
Format: date-time ,
Required: False ,
}
string ,
lastSuccessfulTestFailoverTime:
{
Description: The last successful test failover time. ,
Format: date-time ,
Required: False ,
}
string ,
policyFriendlyName:
{
Description: The name of Policy governing this PE. ,
Required: False ,
}
string ,
currentScenario:
{
Description: The current scenario. ,
Required: False ,
}
{
scenarioName:
{
Description: Scenario name. ,
Required: False ,
}
string ,
jobId:
{
Description: ARM Id of the job being executed. ,
Required: False ,
}
string ,
startTime:
{
Description: Start time of the workflow. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
recoveryContainerId:
{
Description: The recovery container Id. ,
Format: arm-id ,
Required: False ,
}
string ,
agentClusterId:
{
Description: The Agent cluster Id. ,
Required: False ,
}
string ,
clusterFqdn:
{
Description: The cluster FQDN. ,
Required: False ,
}
string ,
clusterNodeFqdns:
{
Description: The List of cluster Node FQDNs. ,
Required: False ,
}
[
string ,
]
,
clusterProtectedItemIds:
{
Description: The List of Protected Item Id's. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the cluster. ,
Required: False ,
}
string ,
areAllClusterNodesRegistered:
{
Description: A value indicating whether all nodes of the cluster are registered or not. ,
Required: False ,
}
boolean ,
clusterRegisteredNodes:
{
Description: The registered node details. ,
Required: False ,
}
[
{
clusterNodeFqdn:
{
Description: The cluster node name. ,
Required: False ,
}
string ,
machineId:
{
Description: The machine ID. ,
Required: False ,
}
string ,
biosId:
{
Description: The BIOS ID. ,
Required: False ,
}
string ,
isSharedDiskVirtualNode:
{
Description: A value indicating whether this represents virtual entity hosting all the shared disks. ,
Required: False ,
}
boolean ,
}
,
]
,
providerSpecificDetails:
{
Description: The Replication cluster provider custom settings. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the Instance type. ,
Required: True ,
}
string ,
}
,
sharedDiskProperties:
{
Description: The shared disk properties. ,
Required: False ,
}
{
protectionState:
{
Description: The protection state of shared disk. ,
Required: False ,
}
string ,
testFailoverState:
{
Description: The tfo state of shared disk. ,
Required: False ,
}
string ,
activeLocation:
{
Description: The Current active location of the PE. ,
Required: False ,
}
string ,
allowedOperations:
{
Description: The allowed operations on the Replication protected item. ,
Required: False ,
}
[
string ,
]
,
replicationHealth:
{
Description: 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. ,
Required: False ,
}
string ,
healthErrors:
{
Description: List of health errors. ,
Required: False ,
}
[
{
innerHealthErrors:
{
Description: 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. ,
Required: False ,
}
[
{
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
currentScenario:
{
Description: The current scenario. ,
Required: False ,
}
{
scenarioName:
{
Description: Scenario name. ,
Required: False ,
}
string ,
jobId:
{
Description: ARM Id of the job being executed. ,
Required: False ,
}
string ,
startTime:
{
Description: Start time of the workflow. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
sharedDiskProviderSpecificDetails:
{
Description: The Replication provider custom settings. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the Instance type. ,
Required: True ,
}
string ,
}
,
}
,
policyId:
{
Description: The Policy Id. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ReplicationProtectionClusters_Create (new)
Description :  The operation to create an ASR replication protection cluster item.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectionClusters/{replicationProtectionClusterName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric name. ,
Required: True ,
}
string ,
protectionContainerName:
{
Description: Protection container name. ,
Required: True ,
}
string ,
replicationProtectionClusterName:
{
Description: Replication protection cluster name. ,
Required: True ,
}
string ,
replicationProtectionCluster:
{
Description: Create replication protection cluster Input. ,
Required: True ,
}
{
id:
{
Description: The protection cluster Id. ,
Required: False ,
}
string ,
name:
{
Description: The name of the protection cluster. ,
Required: False ,
}
string ,
type:
{
Description: The Type of the object. ,
Required: False ,
}
string ,
properties:
{
Description: The custom data. ,
Required: False ,
}
{
protectionClusterType:
{
Description: The type of protection cluster type. ,
Required: False ,
}
string ,
primaryFabricFriendlyName:
{
Description: The friendly name of the primary fabric. ,
Required: False ,
}
string ,
primaryFabricProvider:
{
Description: The fabric provider of the primary fabric. ,
Required: False ,
}
string ,
recoveryFabricFriendlyName:
{
Description: The friendly name of recovery fabric. ,
Required: False ,
}
string ,
recoveryFabricId:
{
Description: The Arm Id of recovery fabric. ,
Format: arm-id ,
Required: False ,
}
string ,
primaryProtectionContainerFriendlyName:
{
Description: The name of primary protection container friendly name. ,
Required: False ,
}
string ,
recoveryProtectionContainerFriendlyName:
{
Description: The name of recovery container friendly name. ,
Required: False ,
}
string ,
protectionState:
{
Description: The protection status. ,
Required: False ,
}
string ,
protectionStateDescription:
{
Description: The protection state description. ,
Required: False ,
}
string ,
activeLocation:
{
Description: The Current active location of the Protection cluster. ,
Required: False ,
}
string ,
testFailoverState:
{
Description: The Test failover state. ,
Required: False ,
}
string ,
testFailoverStateDescription:
{
Description: The Test failover state description. ,
Required: False ,
}
string ,
allowedOperations:
{
Description: The allowed operations on the Replication protection cluster. ,
Required: False ,
}
[
string ,
]
,
replicationHealth:
{
Description: 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. ,
Required: False ,
}
string ,
healthErrors:
{
Description: List of health errors. ,
Required: False ,
}
[
{
innerHealthErrors:
{
Description: 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. ,
Required: False ,
}
[
{
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
lastSuccessfulFailoverTime:
{
Description: The last successful failover time. ,
Format: date-time ,
Required: False ,
}
string ,
lastSuccessfulTestFailoverTime:
{
Description: The last successful test failover time. ,
Format: date-time ,
Required: False ,
}
string ,
policyFriendlyName:
{
Description: The name of Policy governing this PE. ,
Required: False ,
}
string ,
currentScenario:
{
Description: The current scenario. ,
Required: False ,
}
{
scenarioName:
{
Description: Scenario name. ,
Required: False ,
}
string ,
jobId:
{
Description: ARM Id of the job being executed. ,
Required: False ,
}
string ,
startTime:
{
Description: Start time of the workflow. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
recoveryContainerId:
{
Description: The recovery container Id. ,
Format: arm-id ,
Required: False ,
}
string ,
agentClusterId:
{
Description: The Agent cluster Id. ,
Required: False ,
}
string ,
clusterFqdn:
{
Description: The cluster FQDN. ,
Required: False ,
}
string ,
clusterNodeFqdns:
{
Description: The List of cluster Node FQDNs. ,
Required: False ,
}
[
string ,
]
,
clusterProtectedItemIds:
{
Description: The List of Protected Item Id's. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the cluster. ,
Required: False ,
}
string ,
areAllClusterNodesRegistered:
{
Description: A value indicating whether all nodes of the cluster are registered or not. ,
Required: False ,
}
boolean ,
clusterRegisteredNodes:
{
Description: The registered node details. ,
Required: False ,
}
[
{
clusterNodeFqdn:
{
Description: The cluster node name. ,
Required: False ,
}
string ,
machineId:
{
Description: The machine ID. ,
Required: False ,
}
string ,
biosId:
{
Description: The BIOS ID. ,
Required: False ,
}
string ,
isSharedDiskVirtualNode:
{
Description: A value indicating whether this represents virtual entity hosting all the shared disks. ,
Required: False ,
}
boolean ,
}
,
]
,
providerSpecificDetails:
{
Description: The Replication cluster provider custom settings. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the Instance type. ,
Required: True ,
}
string ,
}
,
sharedDiskProperties:
{
Description: The shared disk properties. ,
Required: False ,
}
{
protectionState:
{
Description: The protection state of shared disk. ,
Required: False ,
}
string ,
testFailoverState:
{
Description: The tfo state of shared disk. ,
Required: False ,
}
string ,
activeLocation:
{
Description: The Current active location of the PE. ,
Required: False ,
}
string ,
allowedOperations:
{
Description: The allowed operations on the Replication protected item. ,
Required: False ,
}
[
string ,
]
,
replicationHealth:
{
Description: 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. ,
Required: False ,
}
string ,
healthErrors:
{
Description: List of health errors. ,
Required: False ,
}
[
{
innerHealthErrors:
{
Description: 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. ,
Required: False ,
}
[
{
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
currentScenario:
{
Description: The current scenario. ,
Required: False ,
}
{
scenarioName:
{
Description: Scenario name. ,
Required: False ,
}
string ,
jobId:
{
Description: ARM Id of the job being executed. ,
Required: False ,
}
string ,
startTime:
{
Description: Start time of the workflow. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
sharedDiskProviderSpecificDetails:
{
Description: The Replication provider custom settings. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the Instance type. ,
Required: True ,
}
string ,
}
,
}
,
policyId:
{
Description: The Policy Id. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
id:
{
Description: The protection cluster Id. ,
Required: False ,
}
string ,
name:
{
Description: The name of the protection cluster. ,
Required: False ,
}
string ,
type:
{
Description: The Type of the object. ,
Required: False ,
}
string ,
properties:
{
Description: The custom data. ,
Required: False ,
}
{
protectionClusterType:
{
Description: The type of protection cluster type. ,
Required: False ,
}
string ,
primaryFabricFriendlyName:
{
Description: The friendly name of the primary fabric. ,
Required: False ,
}
string ,
primaryFabricProvider:
{
Description: The fabric provider of the primary fabric. ,
Required: False ,
}
string ,
recoveryFabricFriendlyName:
{
Description: The friendly name of recovery fabric. ,
Required: False ,
}
string ,
recoveryFabricId:
{
Description: The Arm Id of recovery fabric. ,
Format: arm-id ,
Required: False ,
}
string ,
primaryProtectionContainerFriendlyName:
{
Description: The name of primary protection container friendly name. ,
Required: False ,
}
string ,
recoveryProtectionContainerFriendlyName:
{
Description: The name of recovery container friendly name. ,
Required: False ,
}
string ,
protectionState:
{
Description: The protection status. ,
Required: False ,
}
string ,
protectionStateDescription:
{
Description: The protection state description. ,
Required: False ,
}
string ,
activeLocation:
{
Description: The Current active location of the Protection cluster. ,
Required: False ,
}
string ,
testFailoverState:
{
Description: The Test failover state. ,
Required: False ,
}
string ,
testFailoverStateDescription:
{
Description: The Test failover state description. ,
Required: False ,
}
string ,
allowedOperations:
{
Description: The allowed operations on the Replication protection cluster. ,
Required: False ,
}
[
string ,
]
,
replicationHealth:
{
Description: 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. ,
Required: False ,
}
string ,
healthErrors:
{
Description: List of health errors. ,
Required: False ,
}
[
{
innerHealthErrors:
{
Description: 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. ,
Required: False ,
}
[
{
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
lastSuccessfulFailoverTime:
{
Description: The last successful failover time. ,
Format: date-time ,
Required: False ,
}
string ,
lastSuccessfulTestFailoverTime:
{
Description: The last successful test failover time. ,
Format: date-time ,
Required: False ,
}
string ,
policyFriendlyName:
{
Description: The name of Policy governing this PE. ,
Required: False ,
}
string ,
currentScenario:
{
Description: The current scenario. ,
Required: False ,
}
{
scenarioName:
{
Description: Scenario name. ,
Required: False ,
}
string ,
jobId:
{
Description: ARM Id of the job being executed. ,
Required: False ,
}
string ,
startTime:
{
Description: Start time of the workflow. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
recoveryContainerId:
{
Description: The recovery container Id. ,
Format: arm-id ,
Required: False ,
}
string ,
agentClusterId:
{
Description: The Agent cluster Id. ,
Required: False ,
}
string ,
clusterFqdn:
{
Description: The cluster FQDN. ,
Required: False ,
}
string ,
clusterNodeFqdns:
{
Description: The List of cluster Node FQDNs. ,
Required: False ,
}
[
string ,
]
,
clusterProtectedItemIds:
{
Description: The List of Protected Item Id's. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the cluster. ,
Required: False ,
}
string ,
areAllClusterNodesRegistered:
{
Description: A value indicating whether all nodes of the cluster are registered or not. ,
Required: False ,
}
boolean ,
clusterRegisteredNodes:
{
Description: The registered node details. ,
Required: False ,
}
[
{
clusterNodeFqdn:
{
Description: The cluster node name. ,
Required: False ,
}
string ,
machineId:
{
Description: The machine ID. ,
Required: False ,
}
string ,
biosId:
{
Description: The BIOS ID. ,
Required: False ,
}
string ,
isSharedDiskVirtualNode:
{
Description: A value indicating whether this represents virtual entity hosting all the shared disks. ,
Required: False ,
}
boolean ,
}
,
]
,
providerSpecificDetails:
{
Description: The Replication cluster provider custom settings. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the Instance type. ,
Required: True ,
}
string ,
}
,
sharedDiskProperties:
{
Description: The shared disk properties. ,
Required: False ,
}
{
protectionState:
{
Description: The protection state of shared disk. ,
Required: False ,
}
string ,
testFailoverState:
{
Description: The tfo state of shared disk. ,
Required: False ,
}
string ,
activeLocation:
{
Description: The Current active location of the PE. ,
Required: False ,
}
string ,
allowedOperations:
{
Description: The allowed operations on the Replication protected item. ,
Required: False ,
}
[
string ,
]
,
replicationHealth:
{
Description: 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. ,
Required: False ,
}
string ,
healthErrors:
{
Description: List of health errors. ,
Required: False ,
}
[
{
innerHealthErrors:
{
Description: 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. ,
Required: False ,
}
[
{
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
currentScenario:
{
Description: The current scenario. ,
Required: False ,
}
{
scenarioName:
{
Description: Scenario name. ,
Required: False ,
}
string ,
jobId:
{
Description: ARM Id of the job being executed. ,
Required: False ,
}
string ,
startTime:
{
Description: Start time of the workflow. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
sharedDiskProviderSpecificDetails:
{
Description: The Replication provider custom settings. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the Instance type. ,
Required: True ,
}
string ,
}
,
}
,
policyId:
{
Description: The Policy Id. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
location: string ,
azure-asyncoperation: string ,
retry-after: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ReplicationProtectionClusters_Purge (new)
Description :  The operation to purge the replication protection cluster. This operation will force delete the replication protection cluster. Use the remove operation on replication protection cluster to perform a clean disable replication protection cluster.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectionClusters/{replicationProtectionClusterName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric name. ,
Required: True ,
}
string ,
protectionContainerName:
{
Description: Protection container name. ,
Required: True ,
}
string ,
replicationProtectionClusterName:
{
Description: Replication protection cluster name. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location: string ,
azure-asyncoperation: string ,
retry-after: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ReplicationProtectionClusters_ApplyRecoveryPoint (new)
Description :  Operation to apply a new cluster recovery point on the Protection cluster.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectionClusters/{replicationProtectionClusterName}/applyRecoveryPoint
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric name. ,
Required: True ,
}
string ,
protectionContainerName:
{
Description: Protection container name. ,
Required: True ,
}
string ,
replicationProtectionClusterName:
{
Description: Replication protection cluster name. ,
Required: True ,
}
string ,
applyClusterRecoveryPointInput:
{
Description: Apply recovery point input. ,
Required: True ,
}
{
properties:
{
Description: The properties to apply cluster recovery point input. ,
Required: True ,
}
{
clusterRecoveryPointId:
{
Description: The cluster recovery point id to be passed to failover to a particular recovery point. ,
Format: arm-id ,
Required: False ,
}
string ,
individualNodeRecoveryPoints:
{
Description: The list of individual node recovery points. ,
Required: False ,
}
[
string ,
]
,
providerSpecificDetails:
{
Description: The provider specific input for applying cluster recovery point. ,
Required: True ,
}
{
instanceType:
{
Description: The class type. ,
Required: True ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
id:
{
Description: The protection cluster Id. ,
Required: False ,
}
string ,
name:
{
Description: The name of the protection cluster. ,
Required: False ,
}
string ,
type:
{
Description: The Type of the object. ,
Required: False ,
}
string ,
properties:
{
Description: The custom data. ,
Required: False ,
}
{
protectionClusterType:
{
Description: The type of protection cluster type. ,
Required: False ,
}
string ,
primaryFabricFriendlyName:
{
Description: The friendly name of the primary fabric. ,
Required: False ,
}
string ,
primaryFabricProvider:
{
Description: The fabric provider of the primary fabric. ,
Required: False ,
}
string ,
recoveryFabricFriendlyName:
{
Description: The friendly name of recovery fabric. ,
Required: False ,
}
string ,
recoveryFabricId:
{
Description: The Arm Id of recovery fabric. ,
Format: arm-id ,
Required: False ,
}
string ,
primaryProtectionContainerFriendlyName:
{
Description: The name of primary protection container friendly name. ,
Required: False ,
}
string ,
recoveryProtectionContainerFriendlyName:
{
Description: The name of recovery container friendly name. ,
Required: False ,
}
string ,
protectionState:
{
Description: The protection status. ,
Required: False ,
}
string ,
protectionStateDescription:
{
Description: The protection state description. ,
Required: False ,
}
string ,
activeLocation:
{
Description: The Current active location of the Protection cluster. ,
Required: False ,
}
string ,
testFailoverState:
{
Description: The Test failover state. ,
Required: False ,
}
string ,
testFailoverStateDescription:
{
Description: The Test failover state description. ,
Required: False ,
}
string ,
allowedOperations:
{
Description: The allowed operations on the Replication protection cluster. ,
Required: False ,
}
[
string ,
]
,
replicationHealth:
{
Description: 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. ,
Required: False ,
}
string ,
healthErrors:
{
Description: List of health errors. ,
Required: False ,
}
[
{
innerHealthErrors:
{
Description: 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. ,
Required: False ,
}
[
{
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
lastSuccessfulFailoverTime:
{
Description: The last successful failover time. ,
Format: date-time ,
Required: False ,
}
string ,
lastSuccessfulTestFailoverTime:
{
Description: The last successful test failover time. ,
Format: date-time ,
Required: False ,
}
string ,
policyFriendlyName:
{
Description: The name of Policy governing this PE. ,
Required: False ,
}
string ,
currentScenario:
{
Description: The current scenario. ,
Required: False ,
}
{
scenarioName:
{
Description: Scenario name. ,
Required: False ,
}
string ,
jobId:
{
Description: ARM Id of the job being executed. ,
Required: False ,
}
string ,
startTime:
{
Description: Start time of the workflow. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
recoveryContainerId:
{
Description: The recovery container Id. ,
Format: arm-id ,
Required: False ,
}
string ,
agentClusterId:
{
Description: The Agent cluster Id. ,
Required: False ,
}
string ,
clusterFqdn:
{
Description: The cluster FQDN. ,
Required: False ,
}
string ,
clusterNodeFqdns:
{
Description: The List of cluster Node FQDNs. ,
Required: False ,
}
[
string ,
]
,
clusterProtectedItemIds:
{
Description: The List of Protected Item Id's. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the cluster. ,
Required: False ,
}
string ,
areAllClusterNodesRegistered:
{
Description: A value indicating whether all nodes of the cluster are registered or not. ,
Required: False ,
}
boolean ,
clusterRegisteredNodes:
{
Description: The registered node details. ,
Required: False ,
}
[
{
clusterNodeFqdn:
{
Description: The cluster node name. ,
Required: False ,
}
string ,
machineId:
{
Description: The machine ID. ,
Required: False ,
}
string ,
biosId:
{
Description: The BIOS ID. ,
Required: False ,
}
string ,
isSharedDiskVirtualNode:
{
Description: A value indicating whether this represents virtual entity hosting all the shared disks. ,
Required: False ,
}
boolean ,
}
,
]
,
providerSpecificDetails:
{
Description: The Replication cluster provider custom settings. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the Instance type. ,
Required: True ,
}
string ,
}
,
sharedDiskProperties:
{
Description: The shared disk properties. ,
Required: False ,
}
{
protectionState:
{
Description: The protection state of shared disk. ,
Required: False ,
}
string ,
testFailoverState:
{
Description: The tfo state of shared disk. ,
Required: False ,
}
string ,
activeLocation:
{
Description: The Current active location of the PE. ,
Required: False ,
}
string ,
allowedOperations:
{
Description: The allowed operations on the Replication protected item. ,
Required: False ,
}
[
string ,
]
,
replicationHealth:
{
Description: 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. ,
Required: False ,
}
string ,
healthErrors:
{
Description: List of health errors. ,
Required: False ,
}
[
{
innerHealthErrors:
{
Description: 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. ,
Required: False ,
}
[
{
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
currentScenario:
{
Description: The current scenario. ,
Required: False ,
}
{
scenarioName:
{
Description: Scenario name. ,
Required: False ,
}
string ,
jobId:
{
Description: ARM Id of the job being executed. ,
Required: False ,
}
string ,
startTime:
{
Description: Start time of the workflow. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
sharedDiskProviderSpecificDetails:
{
Description: The Replication provider custom settings. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the Instance type. ,
Required: True ,
}
string ,
}
,
}
,
policyId:
{
Description: The Policy Id. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
location: string ,
azure-asyncoperation: string ,
retry-after: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ReplicationProtectionClusters_FailoverCommit (new)
Description :  Operation to initiate commit failover of the replication protection cluster.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectionClusters/{replicationProtectionClusterName}/failoverCommit
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric name. ,
Required: True ,
}
string ,
protectionContainerName:
{
Description: Protection container name. ,
Required: True ,
}
string ,
replicationProtectionClusterName:
{
Description: Replication protection cluster name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The protection cluster Id. ,
Required: False ,
}
string ,
name:
{
Description: The name of the protection cluster. ,
Required: False ,
}
string ,
type:
{
Description: The Type of the object. ,
Required: False ,
}
string ,
properties:
{
Description: The custom data. ,
Required: False ,
}
{
protectionClusterType:
{
Description: The type of protection cluster type. ,
Required: False ,
}
string ,
primaryFabricFriendlyName:
{
Description: The friendly name of the primary fabric. ,
Required: False ,
}
string ,
primaryFabricProvider:
{
Description: The fabric provider of the primary fabric. ,
Required: False ,
}
string ,
recoveryFabricFriendlyName:
{
Description: The friendly name of recovery fabric. ,
Required: False ,
}
string ,
recoveryFabricId:
{
Description: The Arm Id of recovery fabric. ,
Format: arm-id ,
Required: False ,
}
string ,
primaryProtectionContainerFriendlyName:
{
Description: The name of primary protection container friendly name. ,
Required: False ,
}
string ,
recoveryProtectionContainerFriendlyName:
{
Description: The name of recovery container friendly name. ,
Required: False ,
}
string ,
protectionState:
{
Description: The protection status. ,
Required: False ,
}
string ,
protectionStateDescription:
{
Description: The protection state description. ,
Required: False ,
}
string ,
activeLocation:
{
Description: The Current active location of the Protection cluster. ,
Required: False ,
}
string ,
testFailoverState:
{
Description: The Test failover state. ,
Required: False ,
}
string ,
testFailoverStateDescription:
{
Description: The Test failover state description. ,
Required: False ,
}
string ,
allowedOperations:
{
Description: The allowed operations on the Replication protection cluster. ,
Required: False ,
}
[
string ,
]
,
replicationHealth:
{
Description: 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. ,
Required: False ,
}
string ,
healthErrors:
{
Description: List of health errors. ,
Required: False ,
}
[
{
innerHealthErrors:
{
Description: 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. ,
Required: False ,
}
[
{
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
lastSuccessfulFailoverTime:
{
Description: The last successful failover time. ,
Format: date-time ,
Required: False ,
}
string ,
lastSuccessfulTestFailoverTime:
{
Description: The last successful test failover time. ,
Format: date-time ,
Required: False ,
}
string ,
policyFriendlyName:
{
Description: The name of Policy governing this PE. ,
Required: False ,
}
string ,
currentScenario:
{
Description: The current scenario. ,
Required: False ,
}
{
scenarioName:
{
Description: Scenario name. ,
Required: False ,
}
string ,
jobId:
{
Description: ARM Id of the job being executed. ,
Required: False ,
}
string ,
startTime:
{
Description: Start time of the workflow. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
recoveryContainerId:
{
Description: The recovery container Id. ,
Format: arm-id ,
Required: False ,
}
string ,
agentClusterId:
{
Description: The Agent cluster Id. ,
Required: False ,
}
string ,
clusterFqdn:
{
Description: The cluster FQDN. ,
Required: False ,
}
string ,
clusterNodeFqdns:
{
Description: The List of cluster Node FQDNs. ,
Required: False ,
}
[
string ,
]
,
clusterProtectedItemIds:
{
Description: The List of Protected Item Id's. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the cluster. ,
Required: False ,
}
string ,
areAllClusterNodesRegistered:
{
Description: A value indicating whether all nodes of the cluster are registered or not. ,
Required: False ,
}
boolean ,
clusterRegisteredNodes:
{
Description: The registered node details. ,
Required: False ,
}
[
{
clusterNodeFqdn:
{
Description: The cluster node name. ,
Required: False ,
}
string ,
machineId:
{
Description: The machine ID. ,
Required: False ,
}
string ,
biosId:
{
Description: The BIOS ID. ,
Required: False ,
}
string ,
isSharedDiskVirtualNode:
{
Description: A value indicating whether this represents virtual entity hosting all the shared disks. ,
Required: False ,
}
boolean ,
}
,
]
,
providerSpecificDetails:
{
Description: The Replication cluster provider custom settings. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the Instance type. ,
Required: True ,
}
string ,
}
,
sharedDiskProperties:
{
Description: The shared disk properties. ,
Required: False ,
}
{
protectionState:
{
Description: The protection state of shared disk. ,
Required: False ,
}
string ,
testFailoverState:
{
Description: The tfo state of shared disk. ,
Required: False ,
}
string ,
activeLocation:
{
Description: The Current active location of the PE. ,
Required: False ,
}
string ,
allowedOperations:
{
Description: The allowed operations on the Replication protected item. ,
Required: False ,
}
[
string ,
]
,
replicationHealth:
{
Description: 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. ,
Required: False ,
}
string ,
healthErrors:
{
Description: List of health errors. ,
Required: False ,
}
[
{
innerHealthErrors:
{
Description: 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. ,
Required: False ,
}
[
{
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
currentScenario:
{
Description: The current scenario. ,
Required: False ,
}
{
scenarioName:
{
Description: Scenario name. ,
Required: False ,
}
string ,
jobId:
{
Description: ARM Id of the job being executed. ,
Required: False ,
}
string ,
startTime:
{
Description: Start time of the workflow. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
sharedDiskProviderSpecificDetails:
{
Description: The Replication provider custom settings. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the Instance type. ,
Required: True ,
}
string ,
}
,
}
,
policyId:
{
Description: The Policy Id. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
location: string ,
azure-asyncoperation: string ,
retry-after: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ReplicationProtectionClusters_GetOperationResults (new)
Description :  Track the results of an asynchronous operation on the replication protection cluster.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectionClusters/{replicationProtectionClusterName}/operationResults/{jobId}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric name. ,
Required: True ,
}
string ,
protectionContainerName:
{
Description: Protection container name. ,
Required: True ,
}
string ,
replicationProtectionClusterName:
{
Description: Replication protection cluster name. ,
Required: True ,
}
string ,
jobId:
{
Description: job id to track. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The protection cluster Id. ,
Required: False ,
}
string ,
name:
{
Description: The name of the protection cluster. ,
Required: False ,
}
string ,
type:
{
Description: The Type of the object. ,
Required: False ,
}
string ,
properties:
{
Description: The custom data. ,
Required: False ,
}
{
protectionClusterType:
{
Description: The type of protection cluster type. ,
Required: False ,
}
string ,
primaryFabricFriendlyName:
{
Description: The friendly name of the primary fabric. ,
Required: False ,
}
string ,
primaryFabricProvider:
{
Description: The fabric provider of the primary fabric. ,
Required: False ,
}
string ,
recoveryFabricFriendlyName:
{
Description: The friendly name of recovery fabric. ,
Required: False ,
}
string ,
recoveryFabricId:
{
Description: The Arm Id of recovery fabric. ,
Format: arm-id ,
Required: False ,
}
string ,
primaryProtectionContainerFriendlyName:
{
Description: The name of primary protection container friendly name. ,
Required: False ,
}
string ,
recoveryProtectionContainerFriendlyName:
{
Description: The name of recovery container friendly name. ,
Required: False ,
}
string ,
protectionState:
{
Description: The protection status. ,
Required: False ,
}
string ,
protectionStateDescription:
{
Description: The protection state description. ,
Required: False ,
}
string ,
activeLocation:
{
Description: The Current active location of the Protection cluster. ,
Required: False ,
}
string ,
testFailoverState:
{
Description: The Test failover state. ,
Required: False ,
}
string ,
testFailoverStateDescription:
{
Description: The Test failover state description. ,
Required: False ,
}
string ,
allowedOperations:
{
Description: The allowed operations on the Replication protection cluster. ,
Required: False ,
}
[
string ,
]
,
replicationHealth:
{
Description: 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. ,
Required: False ,
}
string ,
healthErrors:
{
Description: List of health errors. ,
Required: False ,
}
[
{
innerHealthErrors:
{
Description: 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. ,
Required: False ,
}
[
{
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
lastSuccessfulFailoverTime:
{
Description: The last successful failover time. ,
Format: date-time ,
Required: False ,
}
string ,
lastSuccessfulTestFailoverTime:
{
Description: The last successful test failover time. ,
Format: date-time ,
Required: False ,
}
string ,
policyFriendlyName:
{
Description: The name of Policy governing this PE. ,
Required: False ,
}
string ,
currentScenario:
{
Description: The current scenario. ,
Required: False ,
}
{
scenarioName:
{
Description: Scenario name. ,
Required: False ,
}
string ,
jobId:
{
Description: ARM Id of the job being executed. ,
Required: False ,
}
string ,
startTime:
{
Description: Start time of the workflow. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
recoveryContainerId:
{
Description: The recovery container Id. ,
Format: arm-id ,
Required: False ,
}
string ,
agentClusterId:
{
Description: The Agent cluster Id. ,
Required: False ,
}
string ,
clusterFqdn:
{
Description: The cluster FQDN. ,
Required: False ,
}
string ,
clusterNodeFqdns:
{
Description: The List of cluster Node FQDNs. ,
Required: False ,
}
[
string ,
]
,
clusterProtectedItemIds:
{
Description: The List of Protected Item Id's. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the cluster. ,
Required: False ,
}
string ,
areAllClusterNodesRegistered:
{
Description: A value indicating whether all nodes of the cluster are registered or not. ,
Required: False ,
}
boolean ,
clusterRegisteredNodes:
{
Description: The registered node details. ,
Required: False ,
}
[
{
clusterNodeFqdn:
{
Description: The cluster node name. ,
Required: False ,
}
string ,
machineId:
{
Description: The machine ID. ,
Required: False ,
}
string ,
biosId:
{
Description: The BIOS ID. ,
Required: False ,
}
string ,
isSharedDiskVirtualNode:
{
Description: A value indicating whether this represents virtual entity hosting all the shared disks. ,
Required: False ,
}
boolean ,
}
,
]
,
providerSpecificDetails:
{
Description: The Replication cluster provider custom settings. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the Instance type. ,
Required: True ,
}
string ,
}
,
sharedDiskProperties:
{
Description: The shared disk properties. ,
Required: False ,
}
{
protectionState:
{
Description: The protection state of shared disk. ,
Required: False ,
}
string ,
testFailoverState:
{
Description: The tfo state of shared disk. ,
Required: False ,
}
string ,
activeLocation:
{
Description: The Current active location of the PE. ,
Required: False ,
}
string ,
allowedOperations:
{
Description: The allowed operations on the Replication protected item. ,
Required: False ,
}
[
string ,
]
,
replicationHealth:
{
Description: 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. ,
Required: False ,
}
string ,
healthErrors:
{
Description: List of health errors. ,
Required: False ,
}
[
{
innerHealthErrors:
{
Description: 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. ,
Required: False ,
}
[
{
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
currentScenario:
{
Description: The current scenario. ,
Required: False ,
}
{
scenarioName:
{
Description: Scenario name. ,
Required: False ,
}
string ,
jobId:
{
Description: ARM Id of the job being executed. ,
Required: False ,
}
string ,
startTime:
{
Description: Start time of the workflow. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
sharedDiskProviderSpecificDetails:
{
Description: The Replication provider custom settings. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the Instance type. ,
Required: True ,
}
string ,
}
,
}
,
policyId:
{
Description: The Policy Id. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ClusterRecoveryPoints_ListByReplicationProtectionCluster (new)
Description :  The list of cluster recovery points.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectionClusters/{replicationProtectionClusterName}/recoveryPoints
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric name. ,
Required: True ,
}
string ,
protectionContainerName:
{
Description: Protection container name. ,
Required: True ,
}
string ,
replicationProtectionClusterName:
{
Description: Replication protection cluster name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The cluster recovery point details. ,
Required: False ,
}
[
{
id:
{
Description: The recovery point Id. ,
Format: arm-id ,
Required: False ,
}
string ,
name:
{
Description: The name of the recovery point. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The recovery point properties. ,
Required: False ,
}
{
recoveryPointTime:
{
Description: The recovery point time. ,
Format: date-time ,
Required: False ,
}
string ,
recoveryPointType:
{
Description: The recovery point type. ,
Enum:
{
NotSpecified: No description available. ,
ApplicationConsistent: No description available. ,
CrashConsistent: No description available. ,
}
,
Required: False ,
}
enum ,
providerSpecificDetails:
{
Description: The provider specific details for the recovery point. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the provider type. ,
Required: True ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The value of next link. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ClusterRecoveryPoint_Get (new)
Description :  Get the details of specified recovery point.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectionClusters/{replicationProtectionClusterName}/recoveryPoints/{recoveryPointName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric name. ,
Required: True ,
}
string ,
protectionContainerName:
{
Description: Protection container name. ,
Required: True ,
}
string ,
replicationProtectionClusterName:
{
Description: Replication protection cluster name. ,
Required: True ,
}
string ,
recoveryPointName:
{
Description: The recovery point name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The recovery point Id. ,
Format: arm-id ,
Required: False ,
}
string ,
name:
{
Description: The name of the recovery point. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The recovery point properties. ,
Required: False ,
}
{
recoveryPointTime:
{
Description: The recovery point time. ,
Format: date-time ,
Required: False ,
}
string ,
recoveryPointType:
{
Description: The recovery point type. ,
Enum:
{
NotSpecified: No description available. ,
ApplicationConsistent: No description available. ,
CrashConsistent: No description available. ,
}
,
Required: False ,
}
enum ,
providerSpecificDetails:
{
Description: The provider specific details for the recovery point. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the provider type. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ReplicationProtectionClusters_RepairReplication (new)
Description :  The operation to repair replication protection cluster.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectionClusters/{replicationProtectionClusterName}/repairReplication
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric name. ,
Required: True ,
}
string ,
protectionContainerName:
{
Description: Protection container name. ,
Required: True ,
}
string ,
replicationProtectionClusterName:
{
Description: Replication protection cluster name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The protection cluster Id. ,
Required: False ,
}
string ,
name:
{
Description: The name of the protection cluster. ,
Required: False ,
}
string ,
type:
{
Description: The Type of the object. ,
Required: False ,
}
string ,
properties:
{
Description: The custom data. ,
Required: False ,
}
{
protectionClusterType:
{
Description: The type of protection cluster type. ,
Required: False ,
}
string ,
primaryFabricFriendlyName:
{
Description: The friendly name of the primary fabric. ,
Required: False ,
}
string ,
primaryFabricProvider:
{
Description: The fabric provider of the primary fabric. ,
Required: False ,
}
string ,
recoveryFabricFriendlyName:
{
Description: The friendly name of recovery fabric. ,
Required: False ,
}
string ,
recoveryFabricId:
{
Description: The Arm Id of recovery fabric. ,
Format: arm-id ,
Required: False ,
}
string ,
primaryProtectionContainerFriendlyName:
{
Description: The name of primary protection container friendly name. ,
Required: False ,
}
string ,
recoveryProtectionContainerFriendlyName:
{
Description: The name of recovery container friendly name. ,
Required: False ,
}
string ,
protectionState:
{
Description: The protection status. ,
Required: False ,
}
string ,
protectionStateDescription:
{
Description: The protection state description. ,
Required: False ,
}
string ,
activeLocation:
{
Description: The Current active location of the Protection cluster. ,
Required: False ,
}
string ,
testFailoverState:
{
Description: The Test failover state. ,
Required: False ,
}
string ,
testFailoverStateDescription:
{
Description: The Test failover state description. ,
Required: False ,
}
string ,
allowedOperations:
{
Description: The allowed operations on the Replication protection cluster. ,
Required: False ,
}
[
string ,
]
,
replicationHealth:
{
Description: 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. ,
Required: False ,
}
string ,
healthErrors:
{
Description: List of health errors. ,
Required: False ,
}
[
{
innerHealthErrors:
{
Description: 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. ,
Required: False ,
}
[
{
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
lastSuccessfulFailoverTime:
{
Description: The last successful failover time. ,
Format: date-time ,
Required: False ,
}
string ,
lastSuccessfulTestFailoverTime:
{
Description: The last successful test failover time. ,
Format: date-time ,
Required: False ,
}
string ,
policyFriendlyName:
{
Description: The name of Policy governing this PE. ,
Required: False ,
}
string ,
currentScenario:
{
Description: The current scenario. ,
Required: False ,
}
{
scenarioName:
{
Description: Scenario name. ,
Required: False ,
}
string ,
jobId:
{
Description: ARM Id of the job being executed. ,
Required: False ,
}
string ,
startTime:
{
Description: Start time of the workflow. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
recoveryContainerId:
{
Description: The recovery container Id. ,
Format: arm-id ,
Required: False ,
}
string ,
agentClusterId:
{
Description: The Agent cluster Id. ,
Required: False ,
}
string ,
clusterFqdn:
{
Description: The cluster FQDN. ,
Required: False ,
}
string ,
clusterNodeFqdns:
{
Description: The List of cluster Node FQDNs. ,
Required: False ,
}
[
string ,
]
,
clusterProtectedItemIds:
{
Description: The List of Protected Item Id's. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the cluster. ,
Required: False ,
}
string ,
areAllClusterNodesRegistered:
{
Description: A value indicating whether all nodes of the cluster are registered or not. ,
Required: False ,
}
boolean ,
clusterRegisteredNodes:
{
Description: The registered node details. ,
Required: False ,
}
[
{
clusterNodeFqdn:
{
Description: The cluster node name. ,
Required: False ,
}
string ,
machineId:
{
Description: The machine ID. ,
Required: False ,
}
string ,
biosId:
{
Description: The BIOS ID. ,
Required: False ,
}
string ,
isSharedDiskVirtualNode:
{
Description: A value indicating whether this represents virtual entity hosting all the shared disks. ,
Required: False ,
}
boolean ,
}
,
]
,
providerSpecificDetails:
{
Description: The Replication cluster provider custom settings. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the Instance type. ,
Required: True ,
}
string ,
}
,
sharedDiskProperties:
{
Description: The shared disk properties. ,
Required: False ,
}
{
protectionState:
{
Description: The protection state of shared disk. ,
Required: False ,
}
string ,
testFailoverState:
{
Description: The tfo state of shared disk. ,
Required: False ,
}
string ,
activeLocation:
{
Description: The Current active location of the PE. ,
Required: False ,
}
string ,
allowedOperations:
{
Description: The allowed operations on the Replication protected item. ,
Required: False ,
}
[
string ,
]
,
replicationHealth:
{
Description: 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. ,
Required: False ,
}
string ,
healthErrors:
{
Description: List of health errors. ,
Required: False ,
}
[
{
innerHealthErrors:
{
Description: 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. ,
Required: False ,
}
[
{
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
currentScenario:
{
Description: The current scenario. ,
Required: False ,
}
{
scenarioName:
{
Description: Scenario name. ,
Required: False ,
}
string ,
jobId:
{
Description: ARM Id of the job being executed. ,
Required: False ,
}
string ,
startTime:
{
Description: Start time of the workflow. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
sharedDiskProviderSpecificDetails:
{
Description: The Replication provider custom settings. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the Instance type. ,
Required: True ,
}
string ,
}
,
}
,
policyId:
{
Description: The Policy Id. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
location: string ,
azure-asyncoperation: string ,
retry-after: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ReplicationProtectionClusters_TestFailover (new)
Description :  Operation to initiate a failover of the replication protection cluster.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectionClusters/{replicationProtectionClusterName}/testFailover
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric name. ,
Required: True ,
}
string ,
protectionContainerName:
{
Description: Protection container name. ,
Required: True ,
}
string ,
replicationProtectionClusterName:
{
Description: Replication protection cluster name. ,
Required: True ,
}
string ,
failoverInput:
{
Description: Cluster test failover input body. ,
Required: True ,
}
{
properties:
{
Description: Test failover input properties. ,
Required: True ,
}
{
failoverDirection:
{
Description: Failover direction. ,
Enum:
{
PrimaryToRecovery: No description available. ,
RecoveryToPrimary: No description available. ,
}
,
Required: False ,
}
enum ,
networkType:
{
Description: Network type to be used for test failover. ,
Required: False ,
}
string ,
networkId:
{
Description: The id of the network to be used for test failover. ,
Format: arm-id ,
Required: False ,
}
string ,
providerSpecificDetails:
{
Description: Provider specific settings. ,
Required: False ,
}
{
instanceType:
{
Description: The class type. ,
Required: True ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
id:
{
Description: The protection cluster Id. ,
Required: False ,
}
string ,
name:
{
Description: The name of the protection cluster. ,
Required: False ,
}
string ,
type:
{
Description: The Type of the object. ,
Required: False ,
}
string ,
properties:
{
Description: The custom data. ,
Required: False ,
}
{
protectionClusterType:
{
Description: The type of protection cluster type. ,
Required: False ,
}
string ,
primaryFabricFriendlyName:
{
Description: The friendly name of the primary fabric. ,
Required: False ,
}
string ,
primaryFabricProvider:
{
Description: The fabric provider of the primary fabric. ,
Required: False ,
}
string ,
recoveryFabricFriendlyName:
{
Description: The friendly name of recovery fabric. ,
Required: False ,
}
string ,
recoveryFabricId:
{
Description: The Arm Id of recovery fabric. ,
Format: arm-id ,
Required: False ,
}
string ,
primaryProtectionContainerFriendlyName:
{
Description: The name of primary protection container friendly name. ,
Required: False ,
}
string ,
recoveryProtectionContainerFriendlyName:
{
Description: The name of recovery container friendly name. ,
Required: False ,
}
string ,
protectionState:
{
Description: The protection status. ,
Required: False ,
}
string ,
protectionStateDescription:
{
Description: The protection state description. ,
Required: False ,
}
string ,
activeLocation:
{
Description: The Current active location of the Protection cluster. ,
Required: False ,
}
string ,
testFailoverState:
{
Description: The Test failover state. ,
Required: False ,
}
string ,
testFailoverStateDescription:
{
Description: The Test failover state description. ,
Required: False ,
}
string ,
allowedOperations:
{
Description: The allowed operations on the Replication protection cluster. ,
Required: False ,
}
[
string ,
]
,
replicationHealth:
{
Description: 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. ,
Required: False ,
}
string ,
healthErrors:
{
Description: List of health errors. ,
Required: False ,
}
[
{
innerHealthErrors:
{
Description: 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. ,
Required: False ,
}
[
{
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
lastSuccessfulFailoverTime:
{
Description: The last successful failover time. ,
Format: date-time ,
Required: False ,
}
string ,
lastSuccessfulTestFailoverTime:
{
Description: The last successful test failover time. ,
Format: date-time ,
Required: False ,
}
string ,
policyFriendlyName:
{
Description: The name of Policy governing this PE. ,
Required: False ,
}
string ,
currentScenario:
{
Description: The current scenario. ,
Required: False ,
}
{
scenarioName:
{
Description: Scenario name. ,
Required: False ,
}
string ,
jobId:
{
Description: ARM Id of the job being executed. ,
Required: False ,
}
string ,
startTime:
{
Description: Start time of the workflow. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
recoveryContainerId:
{
Description: The recovery container Id. ,
Format: arm-id ,
Required: False ,
}
string ,
agentClusterId:
{
Description: The Agent cluster Id. ,
Required: False ,
}
string ,
clusterFqdn:
{
Description: The cluster FQDN. ,
Required: False ,
}
string ,
clusterNodeFqdns:
{
Description: The List of cluster Node FQDNs. ,
Required: False ,
}
[
string ,
]
,
clusterProtectedItemIds:
{
Description: The List of Protected Item Id's. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the cluster. ,
Required: False ,
}
string ,
areAllClusterNodesRegistered:
{
Description: A value indicating whether all nodes of the cluster are registered or not. ,
Required: False ,
}
boolean ,
clusterRegisteredNodes:
{
Description: The registered node details. ,
Required: False ,
}
[
{
clusterNodeFqdn:
{
Description: The cluster node name. ,
Required: False ,
}
string ,
machineId:
{
Description: The machine ID. ,
Required: False ,
}
string ,
biosId:
{
Description: The BIOS ID. ,
Required: False ,
}
string ,
isSharedDiskVirtualNode:
{
Description: A value indicating whether this represents virtual entity hosting all the shared disks. ,
Required: False ,
}
boolean ,
}
,
]
,
providerSpecificDetails:
{
Description: The Replication cluster provider custom settings. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the Instance type. ,
Required: True ,
}
string ,
}
,
sharedDiskProperties:
{
Description: The shared disk properties. ,
Required: False ,
}
{
protectionState:
{
Description: The protection state of shared disk. ,
Required: False ,
}
string ,
testFailoverState:
{
Description: The tfo state of shared disk. ,
Required: False ,
}
string ,
activeLocation:
{
Description: The Current active location of the PE. ,
Required: False ,
}
string ,
allowedOperations:
{
Description: The allowed operations on the Replication protected item. ,
Required: False ,
}
[
string ,
]
,
replicationHealth:
{
Description: 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. ,
Required: False ,
}
string ,
healthErrors:
{
Description: List of health errors. ,
Required: False ,
}
[
{
innerHealthErrors:
{
Description: 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. ,
Required: False ,
}
[
{
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
currentScenario:
{
Description: The current scenario. ,
Required: False ,
}
{
scenarioName:
{
Description: Scenario name. ,
Required: False ,
}
string ,
jobId:
{
Description: ARM Id of the job being executed. ,
Required: False ,
}
string ,
startTime:
{
Description: Start time of the workflow. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
sharedDiskProviderSpecificDetails:
{
Description: The Replication provider custom settings. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the Instance type. ,
Required: True ,
}
string ,
}
,
}
,
policyId:
{
Description: The Policy Id. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
location: string ,
azure-asyncoperation: string ,
retry-after: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ReplicationProtectionClusters_TestFailoverCleanup (new)
Description :  Operation to clean up the test failover of a replication protected cluster.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectionClusters/{replicationProtectionClusterName}/testFailoverCleanup
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric name. ,
Required: True ,
}
string ,
protectionContainerName:
{
Description: Protection container name. ,
Required: True ,
}
string ,
replicationProtectionClusterName:
{
Description: Replication protection cluster name. ,
Required: True ,
}
string ,
cleanupInput:
{
Description: Test failover cleanup input. ,
Required: True ,
}
{
properties:
{
Description: Test failover cleanup input properties. ,
Required: True ,
}
{
comments:
{
Description: Test failover cleanup comments. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
id:
{
Description: The protection cluster Id. ,
Required: False ,
}
string ,
name:
{
Description: The name of the protection cluster. ,
Required: False ,
}
string ,
type:
{
Description: The Type of the object. ,
Required: False ,
}
string ,
properties:
{
Description: The custom data. ,
Required: False ,
}
{
protectionClusterType:
{
Description: The type of protection cluster type. ,
Required: False ,
}
string ,
primaryFabricFriendlyName:
{
Description: The friendly name of the primary fabric. ,
Required: False ,
}
string ,
primaryFabricProvider:
{
Description: The fabric provider of the primary fabric. ,
Required: False ,
}
string ,
recoveryFabricFriendlyName:
{
Description: The friendly name of recovery fabric. ,
Required: False ,
}
string ,
recoveryFabricId:
{
Description: The Arm Id of recovery fabric. ,
Format: arm-id ,
Required: False ,
}
string ,
primaryProtectionContainerFriendlyName:
{
Description: The name of primary protection container friendly name. ,
Required: False ,
}
string ,
recoveryProtectionContainerFriendlyName:
{
Description: The name of recovery container friendly name. ,
Required: False ,
}
string ,
protectionState:
{
Description: The protection status. ,
Required: False ,
}
string ,
protectionStateDescription:
{
Description: The protection state description. ,
Required: False ,
}
string ,
activeLocation:
{
Description: The Current active location of the Protection cluster. ,
Required: False ,
}
string ,
testFailoverState:
{
Description: The Test failover state. ,
Required: False ,
}
string ,
testFailoverStateDescription:
{
Description: The Test failover state description. ,
Required: False ,
}
string ,
allowedOperations:
{
Description: The allowed operations on the Replication protection cluster. ,
Required: False ,
}
[
string ,
]
,
replicationHealth:
{
Description: 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. ,
Required: False ,
}
string ,
healthErrors:
{
Description: List of health errors. ,
Required: False ,
}
[
{
innerHealthErrors:
{
Description: 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. ,
Required: False ,
}
[
{
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
lastSuccessfulFailoverTime:
{
Description: The last successful failover time. ,
Format: date-time ,
Required: False ,
}
string ,
lastSuccessfulTestFailoverTime:
{
Description: The last successful test failover time. ,
Format: date-time ,
Required: False ,
}
string ,
policyFriendlyName:
{
Description: The name of Policy governing this PE. ,
Required: False ,
}
string ,
currentScenario:
{
Description: The current scenario. ,
Required: False ,
}
{
scenarioName:
{
Description: Scenario name. ,
Required: False ,
}
string ,
jobId:
{
Description: ARM Id of the job being executed. ,
Required: False ,
}
string ,
startTime:
{
Description: Start time of the workflow. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
recoveryContainerId:
{
Description: The recovery container Id. ,
Format: arm-id ,
Required: False ,
}
string ,
agentClusterId:
{
Description: The Agent cluster Id. ,
Required: False ,
}
string ,
clusterFqdn:
{
Description: The cluster FQDN. ,
Required: False ,
}
string ,
clusterNodeFqdns:
{
Description: The List of cluster Node FQDNs. ,
Required: False ,
}
[
string ,
]
,
clusterProtectedItemIds:
{
Description: The List of Protected Item Id's. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the cluster. ,
Required: False ,
}
string ,
areAllClusterNodesRegistered:
{
Description: A value indicating whether all nodes of the cluster are registered or not. ,
Required: False ,
}
boolean ,
clusterRegisteredNodes:
{
Description: The registered node details. ,
Required: False ,
}
[
{
clusterNodeFqdn:
{
Description: The cluster node name. ,
Required: False ,
}
string ,
machineId:
{
Description: The machine ID. ,
Required: False ,
}
string ,
biosId:
{
Description: The BIOS ID. ,
Required: False ,
}
string ,
isSharedDiskVirtualNode:
{
Description: A value indicating whether this represents virtual entity hosting all the shared disks. ,
Required: False ,
}
boolean ,
}
,
]
,
providerSpecificDetails:
{
Description: The Replication cluster provider custom settings. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the Instance type. ,
Required: True ,
}
string ,
}
,
sharedDiskProperties:
{
Description: The shared disk properties. ,
Required: False ,
}
{
protectionState:
{
Description: The protection state of shared disk. ,
Required: False ,
}
string ,
testFailoverState:
{
Description: The tfo state of shared disk. ,
Required: False ,
}
string ,
activeLocation:
{
Description: The Current active location of the PE. ,
Required: False ,
}
string ,
allowedOperations:
{
Description: The allowed operations on the Replication protected item. ,
Required: False ,
}
[
string ,
]
,
replicationHealth:
{
Description: 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. ,
Required: False ,
}
string ,
healthErrors:
{
Description: List of health errors. ,
Required: False ,
}
[
{
innerHealthErrors:
{
Description: 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. ,
Required: False ,
}
[
{
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
currentScenario:
{
Description: The current scenario. ,
Required: False ,
}
{
scenarioName:
{
Description: Scenario name. ,
Required: False ,
}
string ,
jobId:
{
Description: ARM Id of the job being executed. ,
Required: False ,
}
string ,
startTime:
{
Description: Start time of the workflow. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
sharedDiskProviderSpecificDetails:
{
Description: The Replication provider custom settings. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the Instance type. ,
Required: True ,
}
string ,
}
,
}
,
policyId:
{
Description: The Policy Id. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
location: string ,
azure-asyncoperation: string ,
retry-after: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ReplicationProtectionClusters_UnplannedFailover (new)
Description :  Operation to initiate a failover of the replication protection cluster.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectionClusters/{replicationProtectionClusterName}/unplannedFailover
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric name. ,
Required: True ,
}
string ,
protectionContainerName:
{
Description: Protection container name. ,
Required: True ,
}
string ,
replicationProtectionClusterName:
{
Description: Replication protection cluster name. ,
Required: True ,
}
string ,
failoverInput:
{
Description: Failover input. ,
Required: True ,
}
{
properties:
{
Description: Unplanned failover input properties. ,
Required: True ,
}
{
failoverDirection:
{
Description: Failover direction. ,
Required: False ,
}
string ,
sourceSiteOperations:
{
Description: Source site operations status. ,
Required: False ,
}
string ,
providerSpecificDetails:
{
Description: Provider specific settings. ,
Required: False ,
}
{
instanceType:
{
Description: The class type. ,
Required: True ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
id:
{
Description: The protection cluster Id. ,
Required: False ,
}
string ,
name:
{
Description: The name of the protection cluster. ,
Required: False ,
}
string ,
type:
{
Description: The Type of the object. ,
Required: False ,
}
string ,
properties:
{
Description: The custom data. ,
Required: False ,
}
{
protectionClusterType:
{
Description: The type of protection cluster type. ,
Required: False ,
}
string ,
primaryFabricFriendlyName:
{
Description: The friendly name of the primary fabric. ,
Required: False ,
}
string ,
primaryFabricProvider:
{
Description: The fabric provider of the primary fabric. ,
Required: False ,
}
string ,
recoveryFabricFriendlyName:
{
Description: The friendly name of recovery fabric. ,
Required: False ,
}
string ,
recoveryFabricId:
{
Description: The Arm Id of recovery fabric. ,
Format: arm-id ,
Required: False ,
}
string ,
primaryProtectionContainerFriendlyName:
{
Description: The name of primary protection container friendly name. ,
Required: False ,
}
string ,
recoveryProtectionContainerFriendlyName:
{
Description: The name of recovery container friendly name. ,
Required: False ,
}
string ,
protectionState:
{
Description: The protection status. ,
Required: False ,
}
string ,
protectionStateDescription:
{
Description: The protection state description. ,
Required: False ,
}
string ,
activeLocation:
{
Description: The Current active location of the Protection cluster. ,
Required: False ,
}
string ,
testFailoverState:
{
Description: The Test failover state. ,
Required: False ,
}
string ,
testFailoverStateDescription:
{
Description: The Test failover state description. ,
Required: False ,
}
string ,
allowedOperations:
{
Description: The allowed operations on the Replication protection cluster. ,
Required: False ,
}
[
string ,
]
,
replicationHealth:
{
Description: 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. ,
Required: False ,
}
string ,
healthErrors:
{
Description: List of health errors. ,
Required: False ,
}
[
{
innerHealthErrors:
{
Description: 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. ,
Required: False ,
}
[
{
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
lastSuccessfulFailoverTime:
{
Description: The last successful failover time. ,
Format: date-time ,
Required: False ,
}
string ,
lastSuccessfulTestFailoverTime:
{
Description: The last successful test failover time. ,
Format: date-time ,
Required: False ,
}
string ,
policyFriendlyName:
{
Description: The name of Policy governing this PE. ,
Required: False ,
}
string ,
currentScenario:
{
Description: The current scenario. ,
Required: False ,
}
{
scenarioName:
{
Description: Scenario name. ,
Required: False ,
}
string ,
jobId:
{
Description: ARM Id of the job being executed. ,
Required: False ,
}
string ,
startTime:
{
Description: Start time of the workflow. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
recoveryContainerId:
{
Description: The recovery container Id. ,
Format: arm-id ,
Required: False ,
}
string ,
agentClusterId:
{
Description: The Agent cluster Id. ,
Required: False ,
}
string ,
clusterFqdn:
{
Description: The cluster FQDN. ,
Required: False ,
}
string ,
clusterNodeFqdns:
{
Description: The List of cluster Node FQDNs. ,
Required: False ,
}
[
string ,
]
,
clusterProtectedItemIds:
{
Description: The List of Protected Item Id's. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the cluster. ,
Required: False ,
}
string ,
areAllClusterNodesRegistered:
{
Description: A value indicating whether all nodes of the cluster are registered or not. ,
Required: False ,
}
boolean ,
clusterRegisteredNodes:
{
Description: The registered node details. ,
Required: False ,
}
[
{
clusterNodeFqdn:
{
Description: The cluster node name. ,
Required: False ,
}
string ,
machineId:
{
Description: The machine ID. ,
Required: False ,
}
string ,
biosId:
{
Description: The BIOS ID. ,
Required: False ,
}
string ,
isSharedDiskVirtualNode:
{
Description: A value indicating whether this represents virtual entity hosting all the shared disks. ,
Required: False ,
}
boolean ,
}
,
]
,
providerSpecificDetails:
{
Description: The Replication cluster provider custom settings. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the Instance type. ,
Required: True ,
}
string ,
}
,
sharedDiskProperties:
{
Description: The shared disk properties. ,
Required: False ,
}
{
protectionState:
{
Description: The protection state of shared disk. ,
Required: False ,
}
string ,
testFailoverState:
{
Description: The tfo state of shared disk. ,
Required: False ,
}
string ,
activeLocation:
{
Description: The Current active location of the PE. ,
Required: False ,
}
string ,
allowedOperations:
{
Description: The allowed operations on the Replication protected item. ,
Required: False ,
}
[
string ,
]
,
replicationHealth:
{
Description: 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. ,
Required: False ,
}
string ,
healthErrors:
{
Description: List of health errors. ,
Required: False ,
}
[
{
innerHealthErrors:
{
Description: 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. ,
Required: False ,
}
[
{
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
currentScenario:
{
Description: The current scenario. ,
Required: False ,
}
{
scenarioName:
{
Description: Scenario name. ,
Required: False ,
}
string ,
jobId:
{
Description: ARM Id of the job being executed. ,
Required: False ,
}
string ,
startTime:
{
Description: Start time of the workflow. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
sharedDiskProviderSpecificDetails:
{
Description: The Replication provider custom settings. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the Instance type. ,
Required: True ,
}
string ,
}
,
}
,
policyId:
{
Description: The Policy Id. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
location: string ,
azure-asyncoperation: string ,
retry-after: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ReplicationProtectionContainerMappings_ListByReplicationProtectionContainers (new)
Description :  Lists the protection container mappings for a protection container.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectionContainerMappings
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric name. ,
Required: True ,
}
string ,
protectionContainerName:
{
Description: Protection container name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of container mappings. ,
Required: False ,
}
[
{
properties:
{
Description: The custom data. ,
Required: False ,
}
{
targetProtectionContainerId:
{
Description: Paired protection container ARM ID. ,
Required: False ,
}
string ,
targetProtectionContainerFriendlyName:
{
Description: Friendly name of paired container. ,
Required: False ,
}
string ,
providerSpecificDetails:
{
Description: Provider specific provider details. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the class type. Overridden in derived classes. ,
Required: True ,
}
string ,
}
,
health:
{
Description: Health of pairing. ,
Required: False ,
}
string ,
healthErrorDetails:
{
Description: Health error. ,
Required: False ,
}
[
{
innerHealthErrors:
{
Description: 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. ,
Required: False ,
}
[
{
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
policyId:
{
Description: Policy ARM Id. ,
Required: False ,
}
string ,
state:
{
Description: Association Status. ,
Required: False ,
}
string ,
sourceProtectionContainerFriendlyName:
{
Description: Friendly name of source protection container. ,
Required: False ,
}
string ,
sourceFabricFriendlyName:
{
Description: Friendly name of source fabric. ,
Required: False ,
}
string ,
targetFabricFriendlyName:
{
Description: Friendly name of target fabric. ,
Required: False ,
}
string ,
policyFriendlyName:
{
Description: Friendly name of replication policy. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to fetch rest of the data. ,
Required: False ,
}
string ,
}
ReplicationProtectionContainerMappings_Get (new)
Description :  Gets the details of a protection container mapping.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectionContainerMappings/{mappingName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric name. ,
Required: True ,
}
string ,
protectionContainerName:
{
Description: Protection container name. ,
Required: True ,
}
string ,
mappingName:
{
Description: Protection Container mapping name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The custom data. ,
Required: False ,
}
{
targetProtectionContainerId:
{
Description: Paired protection container ARM ID. ,
Required: False ,
}
string ,
targetProtectionContainerFriendlyName:
{
Description: Friendly name of paired container. ,
Required: False ,
}
string ,
providerSpecificDetails:
{
Description: Provider specific provider details. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the class type. Overridden in derived classes. ,
Required: True ,
}
string ,
}
,
health:
{
Description: Health of pairing. ,
Required: False ,
}
string ,
healthErrorDetails:
{
Description: Health error. ,
Required: False ,
}
[
{
innerHealthErrors:
{
Description: 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. ,
Required: False ,
}
[
{
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
policyId:
{
Description: Policy ARM Id. ,
Required: False ,
}
string ,
state:
{
Description: Association Status. ,
Required: False ,
}
string ,
sourceProtectionContainerFriendlyName:
{
Description: Friendly name of source protection container. ,
Required: False ,
}
string ,
sourceFabricFriendlyName:
{
Description: Friendly name of source fabric. ,
Required: False ,
}
string ,
targetFabricFriendlyName:
{
Description: Friendly name of target fabric. ,
Required: False ,
}
string ,
policyFriendlyName:
{
Description: Friendly name of replication policy. ,
Required: False ,
}
string ,
}
,
}
ReplicationProtectionContainerMappings_Create (new)
Description :  The operation to create a protection container mapping.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectionContainerMappings/{mappingName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric name. ,
Required: True ,
}
string ,
protectionContainerName:
{
Description: Protection container name. ,
Required: True ,
}
string ,
mappingName:
{
Description: Protection container mapping name. ,
Required: True ,
}
string ,
creationInput:
{
Description: Mapping creation input. ,
Required: True ,
}
{
properties:
{
Description: Configure protection input properties. ,
Required: False ,
}
{
targetProtectionContainerId:
{
Description: The target unique protection container name. ,
Required: False ,
}
string ,
policyId:
{
Description: Applicable policy. ,
Required: False ,
}
string ,
providerSpecificInput:
{
Description: Provider specific input for pairing. ,
Required: False ,
}
{
instanceType:
{
Description: The class type. ,
Required: True ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The custom data. ,
Required: False ,
}
{
targetProtectionContainerId:
{
Description: Paired protection container ARM ID. ,
Required: False ,
}
string ,
targetProtectionContainerFriendlyName:
{
Description: Friendly name of paired container. ,
Required: False ,
}
string ,
providerSpecificDetails:
{
Description: Provider specific provider details. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the class type. Overridden in derived classes. ,
Required: True ,
}
string ,
}
,
health:
{
Description: Health of pairing. ,
Required: False ,
}
string ,
healthErrorDetails:
{
Description: Health error. ,
Required: False ,
}
[
{
innerHealthErrors:
{
Description: 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. ,
Required: False ,
}
[
{
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
policyId:
{
Description: Policy ARM Id. ,
Required: False ,
}
string ,
state:
{
Description: Association Status. ,
Required: False ,
}
string ,
sourceProtectionContainerFriendlyName:
{
Description: Friendly name of source protection container. ,
Required: False ,
}
string ,
sourceFabricFriendlyName:
{
Description: Friendly name of source fabric. ,
Required: False ,
}
string ,
targetFabricFriendlyName:
{
Description: Friendly name of target fabric. ,
Required: False ,
}
string ,
policyFriendlyName:
{
Description: Friendly name of replication policy. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}
ReplicationProtectionContainerMappings_Purge (new)
Description :  The operation to purge(force delete) a protection container mapping.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectionContainerMappings/{mappingName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric name. ,
Required: True ,
}
string ,
protectionContainerName:
{
Description: Protection container name. ,
Required: True ,
}
string ,
mappingName:
{
Description: Protection container mapping name. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
ReplicationProtectionContainerMappings_Update (new)
Description :  The operation to update protection container mapping.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectionContainerMappings/{mappingName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric name. ,
Required: True ,
}
string ,
protectionContainerName:
{
Description: Protection container name. ,
Required: True ,
}
string ,
mappingName:
{
Description: Protection container mapping name. ,
Required: True ,
}
string ,
updateInput:
{
Description: Mapping update input. ,
Required: True ,
}
{
properties:
{
Description: Update protection container mapping input properties. ,
Required: False ,
}
{
providerSpecificInput:
{
Description: Provider specific input for updating protection container mapping. ,
Required: False ,
}
{
instanceType:
{
Description: The class type. ,
Required: True ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The custom data. ,
Required: False ,
}
{
targetProtectionContainerId:
{
Description: Paired protection container ARM ID. ,
Required: False ,
}
string ,
targetProtectionContainerFriendlyName:
{
Description: Friendly name of paired container. ,
Required: False ,
}
string ,
providerSpecificDetails:
{
Description: Provider specific provider details. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the class type. Overridden in derived classes. ,
Required: True ,
}
string ,
}
,
health:
{
Description: Health of pairing. ,
Required: False ,
}
string ,
healthErrorDetails:
{
Description: Health error. ,
Required: False ,
}
[
{
innerHealthErrors:
{
Description: 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. ,
Required: False ,
}
[
{
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
policyId:
{
Description: Policy ARM Id. ,
Required: False ,
}
string ,
state:
{
Description: Association Status. ,
Required: False ,
}
string ,
sourceProtectionContainerFriendlyName:
{
Description: Friendly name of source protection container. ,
Required: False ,
}
string ,
sourceFabricFriendlyName:
{
Description: Friendly name of source fabric. ,
Required: False ,
}
string ,
targetFabricFriendlyName:
{
Description: Friendly name of target fabric. ,
Required: False ,
}
string ,
policyFriendlyName:
{
Description: Friendly name of replication policy. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}
ReplicationProtectionContainerMappings_Delete (new)
Description :  The operation to delete or remove a protection container mapping.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectionContainerMappings/{mappingName}/remove
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric name. ,
Required: True ,
}
string ,
protectionContainerName:
{
Description: Protection container name. ,
Required: True ,
}
string ,
mappingName:
{
Description: Protection container mapping name. ,
Required: True ,
}
string ,
removalInput:
{
Description: Removal input. ,
Required: True ,
}
{
properties:
{
Description: Configure protection input properties. ,
Required: False ,
}
{
providerSpecificInput:
{
Description: Provider specific input for unpairing. ,
Required: False ,
}
{
instanceType:
{
Description: The class type. ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
ReplicationProtectionContainers_SwitchClusterProtection (new)
Description :  Operation to switch protection from one container to another.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/switchClusterProtection
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric name. ,
Required: True ,
}
string ,
protectionContainerName:
{
Description: Protection container name. ,
Required: True ,
}
string ,
switchInput:
{
Description: Switch protection input. ,
Required: True ,
}
{
properties:
{
Description: Switch cluster protection properties. ,
Required: False ,
}
{
replicationProtectionClusterName:
{
Description: The unique replication protection cluster name. ,
Required: False ,
}
string ,
providerSpecificDetails:
{
Description: Provider specific switch protection input. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the Instance type. ,
Required: True ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The custom data. ,
Required: False ,
}
{
fabricFriendlyName:
{
Description: Fabric friendly name. ,
Required: False ,
}
string ,
friendlyName:
{
Description: The name. ,
Required: False ,
}
string ,
fabricType:
{
Description: The fabric type. ,
Required: False ,
}
string ,
protectedItemCount:
{
Description: Number of protected PEs. ,
Format: int32 ,
Required: False ,
}
integer ,
pairingStatus:
{
Description: The pairing status of this cloud. ,
Required: False ,
}
string ,
role:
{
Description: The role of this cloud. ,
Required: False ,
}
string ,
fabricSpecificDetails:
{
Description: Fabric specific details. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the class type. Overridden in derived classes. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{
location: string ,
azure-asyncoperation: string ,
retry-after: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ReplicationProtectionContainers_SwitchProtection (new)
Description :  Operation to switch protection from one container to another or one replication provider to another.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/switchprotection
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Unique fabric name. ,
Required: True ,
}
string ,
protectionContainerName:
{
Description: Protection container name. ,
Required: True ,
}
string ,
switchInput:
{
Description: Switch protection input. ,
Required: True ,
}
{
properties:
{
Description: Switch protection properties. ,
Required: False ,
}
{
replicationProtectedItemName:
{
Description: The unique replication protected item name. ,
Required: False ,
}
string ,
providerSpecificDetails:
{
Description: Provider specific switch protection input. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the Instance type. ,
Required: True ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The custom data. ,
Required: False ,
}
{
fabricFriendlyName:
{
Description: Fabric friendly name. ,
Required: False ,
}
string ,
friendlyName:
{
Description: The name. ,
Required: False ,
}
string ,
fabricType:
{
Description: The fabric type. ,
Required: False ,
}
string ,
protectedItemCount:
{
Description: Number of protected PEs. ,
Format: int32 ,
Required: False ,
}
integer ,
pairingStatus:
{
Description: The pairing status of this cloud. ,
Required: False ,
}
string ,
role:
{
Description: The role of this cloud. ,
Required: False ,
}
string ,
fabricSpecificDetails:
{
Description: Fabric specific details. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the class type. Overridden in derived classes. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{
location: string ,
azure-asyncoperation: string ,
retry-after: string ,
}
ReplicationRecoveryServicesProviders_ListByReplicationFabrics (new)
Description :  Lists the registered recovery services providers for the specified fabric.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationRecoveryServicesProviders
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Servers details. ,
Required: False ,
}
[
{
properties:
{
Description: Provider properties. ,
Required: False ,
}
{
fabricType:
{
Description: Type of the site. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name of the DRA. ,
Required: False ,
}
string ,
providerVersion:
{
Description: The provider version. ,
Required: False ,
}
string ,
serverVersion:
{
Description: The fabric provider. ,
Required: False ,
}
string ,
providerVersionState:
{
Description: DRA version status. ,
Required: False ,
}
string ,
providerVersionExpiryDate:
{
Description: Expiry date of the version. ,
Format: date-time ,
Required: False ,
}
string ,
fabricFriendlyName:
{
Description: The fabric friendly name. ,
Required: False ,
}
string ,
lastHeartBeat:
{
Description: Time when last heartbeat was sent by the DRA. ,
Format: date-time ,
Required: False ,
}
string ,
connectionStatus:
{
Description: A value indicating whether DRA is responsive. ,
Required: False ,
}
string ,
protectedItemCount:
{
Description: Number of protected VMs currently managed by the DRA. ,
Format: int32 ,
Required: False ,
}
integer ,
allowedScenarios:
{
Description: The scenarios allowed on this provider. ,
Required: False ,
}
[
string ,
]
,
healthErrorDetails:
{
Description: The recovery services provider health error details. ,
Required: False ,
}
[
{
innerHealthErrors:
{
Description: 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. ,
Required: False ,
}
[
{
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
draIdentifier:
{
Description: The DRA Id. ,
Required: False ,
}
string ,
machineId:
{
Description: The machine Id. ,
Required: False ,
}
string ,
machineName:
{
Description: The machine name. ,
Required: False ,
}
string ,
biosId:
{
Description: The Bios Id. ,
Required: False ,
}
string ,
authenticationIdentityDetails:
{
Description: The authentication identity details. ,
Required: False ,
}
{
tenantId:
{
Description: The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
applicationId:
{
Description: The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
objectId:
{
Description: The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
audience:
{
Description: The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
aadAuthority:
{
Description: The base authority for Azure Active Directory authentication. ,
Required: False ,
}
string ,
}
,
resourceAccessIdentityDetails:
{
Description: The resource access identity details. ,
Required: False ,
}
{
tenantId:
{
Description: The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
applicationId:
{
Description: The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
objectId:
{
Description: The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
audience:
{
Description: The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
aadAuthority:
{
Description: The base authority for Azure Active Directory authentication. ,
Required: False ,
}
string ,
}
,
dataPlaneAuthenticationIdentityDetails:
{
Description: The data plane authentication identity details. ,
Required: False ,
}
{
tenantId:
{
Description: The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
applicationId:
{
Description: The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
objectId:
{
Description: The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
audience:
{
Description: The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
aadAuthority:
{
Description: The base authority for Azure Active Directory authentication. ,
Required: False ,
}
string ,
}
,
providerVersionDetails:
{
Description: The provider version details. ,
Required: False ,
}
{
version:
{
Description: The agent version. ,
Required: False ,
}
string ,
expiryDate:
{
Description: Version expiry date. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: A value indicating whether security update required. ,
Enum:
{
Supported: No description available. ,
NotSupported: No description available. ,
Deprecated: No description available. ,
UpdateRequired: No description available. ,
SecurityUpdateRequired: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The value of next link. ,
Required: False ,
}
string ,
}
ReplicationRecoveryServicesProviders_Get (new)
Description :  Gets the details of registered recovery services provider.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationRecoveryServicesProviders/{providerName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric name. ,
Required: True ,
}
string ,
providerName:
{
Description: Recovery services provider name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Provider properties. ,
Required: False ,
}
{
fabricType:
{
Description: Type of the site. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name of the DRA. ,
Required: False ,
}
string ,
providerVersion:
{
Description: The provider version. ,
Required: False ,
}
string ,
serverVersion:
{
Description: The fabric provider. ,
Required: False ,
}
string ,
providerVersionState:
{
Description: DRA version status. ,
Required: False ,
}
string ,
providerVersionExpiryDate:
{
Description: Expiry date of the version. ,
Format: date-time ,
Required: False ,
}
string ,
fabricFriendlyName:
{
Description: The fabric friendly name. ,
Required: False ,
}
string ,
lastHeartBeat:
{
Description: Time when last heartbeat was sent by the DRA. ,
Format: date-time ,
Required: False ,
}
string ,
connectionStatus:
{
Description: A value indicating whether DRA is responsive. ,
Required: False ,
}
string ,
protectedItemCount:
{
Description: Number of protected VMs currently managed by the DRA. ,
Format: int32 ,
Required: False ,
}
integer ,
allowedScenarios:
{
Description: The scenarios allowed on this provider. ,
Required: False ,
}
[
string ,
]
,
healthErrorDetails:
{
Description: The recovery services provider health error details. ,
Required: False ,
}
[
{
innerHealthErrors:
{
Description: 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. ,
Required: False ,
}
[
{
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
draIdentifier:
{
Description: The DRA Id. ,
Required: False ,
}
string ,
machineId:
{
Description: The machine Id. ,
Required: False ,
}
string ,
machineName:
{
Description: The machine name. ,
Required: False ,
}
string ,
biosId:
{
Description: The Bios Id. ,
Required: False ,
}
string ,
authenticationIdentityDetails:
{
Description: The authentication identity details. ,
Required: False ,
}
{
tenantId:
{
Description: The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
applicationId:
{
Description: The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
objectId:
{
Description: The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
audience:
{
Description: The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
aadAuthority:
{
Description: The base authority for Azure Active Directory authentication. ,
Required: False ,
}
string ,
}
,
resourceAccessIdentityDetails:
{
Description: The resource access identity details. ,
Required: False ,
}
{
tenantId:
{
Description: The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
applicationId:
{
Description: The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
objectId:
{
Description: The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
audience:
{
Description: The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
aadAuthority:
{
Description: The base authority for Azure Active Directory authentication. ,
Required: False ,
}
string ,
}
,
dataPlaneAuthenticationIdentityDetails:
{
Description: The data plane authentication identity details. ,
Required: False ,
}
{
tenantId:
{
Description: The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
applicationId:
{
Description: The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
objectId:
{
Description: The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
audience:
{
Description: The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
aadAuthority:
{
Description: The base authority for Azure Active Directory authentication. ,
Required: False ,
}
string ,
}
,
providerVersionDetails:
{
Description: The provider version details. ,
Required: False ,
}
{
version:
{
Description: The agent version. ,
Required: False ,
}
string ,
expiryDate:
{
Description: Version expiry date. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: A value indicating whether security update required. ,
Enum:
{
Supported: No description available. ,
NotSupported: No description available. ,
Deprecated: No description available. ,
UpdateRequired: No description available. ,
SecurityUpdateRequired: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
ReplicationRecoveryServicesProviders_Create (new)
Description :  The operation to add a recovery services provider.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationRecoveryServicesProviders/{providerName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric name. ,
Required: True ,
}
string ,
providerName:
{
Description: Recovery services provider name. ,
Required: True ,
}
string ,
addProviderInput:
{
Description: Add provider input. ,
Required: True ,
}
{
properties:
{
Description: The properties of an add provider request. ,
Required: True ,
}
{
machineName:
{
Description: The name of the machine where the provider is getting added. ,
Required: True ,
}
string ,
machineId:
{
Description: The Id of the machine where the provider is getting added. ,
Required: False ,
}
string ,
biosId:
{
Description: The Bios Id of the machine. ,
Required: False ,
}
string ,
authenticationIdentityInput:
{
Description: The identity provider input for DRA authentication. ,
Required: True ,
}
{
tenantId:
{
Description: The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: True ,
}
string ,
applicationId:
{
Description: The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: True ,
}
string ,
objectId:
{
Description: The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: True ,
}
string ,
audience:
{
Description: The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: True ,
}
string ,
aadAuthority:
{
Description: The base authority for Azure Active Directory authentication. ,
Required: True ,
}
string ,
}
,
resourceAccessIdentityInput:
{
Description: The identity provider input for resource access. ,
Required: True ,
}
{
tenantId:
{
Description: The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: True ,
}
string ,
applicationId:
{
Description: The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: True ,
}
string ,
objectId:
{
Description: The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: True ,
}
string ,
audience:
{
Description: The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: True ,
}
string ,
aadAuthority:
{
Description: The base authority for Azure Active Directory authentication. ,
Required: True ,
}
string ,
}
,
dataPlaneAuthenticationIdentityInput:
{
Description: The identity provider input for data plane authentication. ,
Required: False ,
}
{
tenantId:
{
Description: The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: True ,
}
string ,
applicationId:
{
Description: The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: True ,
}
string ,
objectId:
{
Description: The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: True ,
}
string ,
audience:
{
Description: The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: True ,
}
string ,
aadAuthority:
{
Description: The base authority for Azure Active Directory authentication. ,
Required: True ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Provider properties. ,
Required: False ,
}
{
fabricType:
{
Description: Type of the site. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name of the DRA. ,
Required: False ,
}
string ,
providerVersion:
{
Description: The provider version. ,
Required: False ,
}
string ,
serverVersion:
{
Description: The fabric provider. ,
Required: False ,
}
string ,
providerVersionState:
{
Description: DRA version status. ,
Required: False ,
}
string ,
providerVersionExpiryDate:
{
Description: Expiry date of the version. ,
Format: date-time ,
Required: False ,
}
string ,
fabricFriendlyName:
{
Description: The fabric friendly name. ,
Required: False ,
}
string ,
lastHeartBeat:
{
Description: Time when last heartbeat was sent by the DRA. ,
Format: date-time ,
Required: False ,
}
string ,
connectionStatus:
{
Description: A value indicating whether DRA is responsive. ,
Required: False ,
}
string ,
protectedItemCount:
{
Description: Number of protected VMs currently managed by the DRA. ,
Format: int32 ,
Required: False ,
}
integer ,
allowedScenarios:
{
Description: The scenarios allowed on this provider. ,
Required: False ,
}
[
string ,
]
,
healthErrorDetails:
{
Description: The recovery services provider health error details. ,
Required: False ,
}
[
{
innerHealthErrors:
{
Description: 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. ,
Required: False ,
}
[
{
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
draIdentifier:
{
Description: The DRA Id. ,
Required: False ,
}
string ,
machineId:
{
Description: The machine Id. ,
Required: False ,
}
string ,
machineName:
{
Description: The machine name. ,
Required: False ,
}
string ,
biosId:
{
Description: The Bios Id. ,
Required: False ,
}
string ,
authenticationIdentityDetails:
{
Description: The authentication identity details. ,
Required: False ,
}
{
tenantId:
{
Description: The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
applicationId:
{
Description: The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
objectId:
{
Description: The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
audience:
{
Description: The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
aadAuthority:
{
Description: The base authority for Azure Active Directory authentication. ,
Required: False ,
}
string ,
}
,
resourceAccessIdentityDetails:
{
Description: The resource access identity details. ,
Required: False ,
}
{
tenantId:
{
Description: The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
applicationId:
{
Description: The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
objectId:
{
Description: The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
audience:
{
Description: The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
aadAuthority:
{
Description: The base authority for Azure Active Directory authentication. ,
Required: False ,
}
string ,
}
,
dataPlaneAuthenticationIdentityDetails:
{
Description: The data plane authentication identity details. ,
Required: False ,
}
{
tenantId:
{
Description: The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
applicationId:
{
Description: The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
objectId:
{
Description: The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
audience:
{
Description: The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
aadAuthority:
{
Description: The base authority for Azure Active Directory authentication. ,
Required: False ,
}
string ,
}
,
providerVersionDetails:
{
Description: The provider version details. ,
Required: False ,
}
{
version:
{
Description: The agent version. ,
Required: False ,
}
string ,
expiryDate:
{
Description: Version expiry date. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: A value indicating whether security update required. ,
Enum:
{
Supported: No description available. ,
NotSupported: No description available. ,
Deprecated: No description available. ,
UpdateRequired: No description available. ,
SecurityUpdateRequired: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (202)

{}
ReplicationRecoveryServicesProviders_Purge (new)
Description :  The operation to purge(force delete) a recovery services provider from the vault.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationRecoveryServicesProviders/{providerName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric name. ,
Required: True ,
}
string ,
providerName:
{
Description: Recovery services provider name. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
ReplicationRecoveryServicesProviders_RefreshProvider (new)
Description :  The operation to refresh the information from the recovery services provider.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationRecoveryServicesProviders/{providerName}/refreshProvider
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric name. ,
Required: True ,
}
string ,
providerName:
{
Description: Recovery services provider name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Provider properties. ,
Required: False ,
}
{
fabricType:
{
Description: Type of the site. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name of the DRA. ,
Required: False ,
}
string ,
providerVersion:
{
Description: The provider version. ,
Required: False ,
}
string ,
serverVersion:
{
Description: The fabric provider. ,
Required: False ,
}
string ,
providerVersionState:
{
Description: DRA version status. ,
Required: False ,
}
string ,
providerVersionExpiryDate:
{
Description: Expiry date of the version. ,
Format: date-time ,
Required: False ,
}
string ,
fabricFriendlyName:
{
Description: The fabric friendly name. ,
Required: False ,
}
string ,
lastHeartBeat:
{
Description: Time when last heartbeat was sent by the DRA. ,
Format: date-time ,
Required: False ,
}
string ,
connectionStatus:
{
Description: A value indicating whether DRA is responsive. ,
Required: False ,
}
string ,
protectedItemCount:
{
Description: Number of protected VMs currently managed by the DRA. ,
Format: int32 ,
Required: False ,
}
integer ,
allowedScenarios:
{
Description: The scenarios allowed on this provider. ,
Required: False ,
}
[
string ,
]
,
healthErrorDetails:
{
Description: The recovery services provider health error details. ,
Required: False ,
}
[
{
innerHealthErrors:
{
Description: 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. ,
Required: False ,
}
[
{
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
draIdentifier:
{
Description: The DRA Id. ,
Required: False ,
}
string ,
machineId:
{
Description: The machine Id. ,
Required: False ,
}
string ,
machineName:
{
Description: The machine name. ,
Required: False ,
}
string ,
biosId:
{
Description: The Bios Id. ,
Required: False ,
}
string ,
authenticationIdentityDetails:
{
Description: The authentication identity details. ,
Required: False ,
}
{
tenantId:
{
Description: The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
applicationId:
{
Description: The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
objectId:
{
Description: The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
audience:
{
Description: The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
aadAuthority:
{
Description: The base authority for Azure Active Directory authentication. ,
Required: False ,
}
string ,
}
,
resourceAccessIdentityDetails:
{
Description: The resource access identity details. ,
Required: False ,
}
{
tenantId:
{
Description: The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
applicationId:
{
Description: The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
objectId:
{
Description: The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
audience:
{
Description: The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
aadAuthority:
{
Description: The base authority for Azure Active Directory authentication. ,
Required: False ,
}
string ,
}
,
dataPlaneAuthenticationIdentityDetails:
{
Description: The data plane authentication identity details. ,
Required: False ,
}
{
tenantId:
{
Description: The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
applicationId:
{
Description: The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
objectId:
{
Description: The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
audience:
{
Description: The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
aadAuthority:
{
Description: The base authority for Azure Active Directory authentication. ,
Required: False ,
}
string ,
}
,
providerVersionDetails:
{
Description: The provider version details. ,
Required: False ,
}
{
version:
{
Description: The agent version. ,
Required: False ,
}
string ,
expiryDate:
{
Description: Version expiry date. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: A value indicating whether security update required. ,
Enum:
{
Supported: No description available. ,
NotSupported: No description available. ,
Deprecated: No description available. ,
UpdateRequired: No description available. ,
SecurityUpdateRequired: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (202)

{}
ReplicationRecoveryServicesProviders_Delete (new)
Description :  The operation to removes/delete(unregister) a recovery services provider from the vault.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationRecoveryServicesProviders/{providerName}/remove
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric name. ,
Required: True ,
}
string ,
providerName:
{
Description: Recovery services provider name. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
ReplicationStorageClassifications_ListByReplicationFabrics (new)
Description :  Lists the storage classifications available in the specified fabric.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationStorageClassifications
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Site name of interest. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The storage details. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the storage object. ,
Required: False ,
}
{
friendlyName:
{
Description: Friendly name of the Storage classification. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The value of next link. ,
Required: False ,
}
string ,
}
ReplicationStorageClassifications_Get (new)
Description :  Gets the details of the specified storage classification.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationStorageClassifications/{storageClassificationName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric name. ,
Required: True ,
}
string ,
storageClassificationName:
{
Description: Storage classification name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the storage object. ,
Required: False ,
}
{
friendlyName:
{
Description: Friendly name of the Storage classification. ,
Required: False ,
}
string ,
}
,
}
ReplicationStorageClassificationMappings_ListByReplicationStorageClassifications (new)
Description :  Lists the storage classification mappings for the fabric.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationStorageClassifications/{storageClassificationName}/replicationStorageClassificationMappings
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric name. ,
Required: True ,
}
string ,
storageClassificationName:
{
Description: Storage classification name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The storage details. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the storage mapping object. ,
Required: False ,
}
{
targetStorageClassificationId:
{
Description: Target storage object Id. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The value of next link. ,
Required: False ,
}
string ,
}
ReplicationStorageClassificationMappings_Get (new)
Description :  Gets the details of the specified storage classification mapping.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationStorageClassifications/{storageClassificationName}/replicationStorageClassificationMappings/{storageClassificationMappingName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric name. ,
Required: True ,
}
string ,
storageClassificationName:
{
Description: Storage classification name. ,
Required: True ,
}
string ,
storageClassificationMappingName:
{
Description: Storage classification mapping name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the storage mapping object. ,
Required: False ,
}
{
targetStorageClassificationId:
{
Description: Target storage object Id. ,
Required: False ,
}
string ,
}
,
}
ReplicationStorageClassificationMappings_Create (new)
Description :  The operation to create a storage classification mapping.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationStorageClassifications/{storageClassificationName}/replicationStorageClassificationMappings/{storageClassificationMappingName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric name. ,
Required: True ,
}
string ,
storageClassificationName:
{
Description: Storage classification name. ,
Required: True ,
}
string ,
storageClassificationMappingName:
{
Description: Storage classification mapping name. ,
Required: True ,
}
string ,
pairingInput:
{
Description: Pairing input. ,
Required: True ,
}
{
properties:
{
Description: Storage mapping input properties. ,
Required: False ,
}
{
targetStorageClassificationId:
{
Description: The ID of the storage object. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the storage mapping object. ,
Required: False ,
}
{
targetStorageClassificationId:
{
Description: Target storage object Id. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}
ReplicationStorageClassificationMappings_Delete (new)
Description :  The operation to delete a storage classification mapping.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationStorageClassifications/{storageClassificationName}/replicationStorageClassificationMappings/{storageClassificationMappingName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric name. ,
Required: True ,
}
string ,
storageClassificationName:
{
Description: Storage classification name. ,
Required: True ,
}
string ,
storageClassificationMappingName:
{
Description: Storage classification mapping name. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
ReplicationvCenters_ListByReplicationFabrics (new)
Description :  Lists the vCenter servers registered in a fabric.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationvCenters
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The vCenter details. ,
Required: False ,
}
[
{
properties:
{
Description: VCenter related data. ,
Required: False ,
}
{
friendlyName:
{
Description: Friendly name of the vCenter. ,
Required: False ,
}
string ,
internalId:
{
Description: VCenter internal ID. ,
Required: False ,
}
string ,
lastHeartbeat:
{
Description: The time when the last heartbeat was received by vCenter. ,
Format: date-time ,
Required: False ,
}
string ,
discoveryStatus:
{
Description: The VCenter discovery status. ,
Required: False ,
}
string ,
processServerId:
{
Description: The process server Id. ,
Required: False ,
}
string ,
ipAddress:
{
Description: The IP address of the vCenter. ,
Required: False ,
}
string ,
infrastructureId:
{
Description: The infrastructure Id of vCenter. ,
Required: False ,
}
string ,
port:
{
Description: The port number for discovery. ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: The account Id which has privileges to discover the vCenter. ,
Required: False ,
}
string ,
fabricArmResourceName:
{
Description: The ARM resource name of the fabric containing this VCenter. ,
Required: False ,
}
string ,
healthErrors:
{
Description: The health errors for this VCenter. ,
Required: False ,
}
[
{
innerHealthErrors:
{
Description: 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. ,
Required: False ,
}
[
{
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The value of next link. ,
Required: False ,
}
string ,
}
ReplicationvCenters_Get (new)
Description :  Gets the details of a registered vCenter server(Add vCenter server).
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationvCenters/{vcenterName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric name. ,
Required: True ,
}
string ,
vcenterName:
{
Description: vcenter name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: VCenter related data. ,
Required: False ,
}
{
friendlyName:
{
Description: Friendly name of the vCenter. ,
Required: False ,
}
string ,
internalId:
{
Description: VCenter internal ID. ,
Required: False ,
}
string ,
lastHeartbeat:
{
Description: The time when the last heartbeat was received by vCenter. ,
Format: date-time ,
Required: False ,
}
string ,
discoveryStatus:
{
Description: The VCenter discovery status. ,
Required: False ,
}
string ,
processServerId:
{
Description: The process server Id. ,
Required: False ,
}
string ,
ipAddress:
{
Description: The IP address of the vCenter. ,
Required: False ,
}
string ,
infrastructureId:
{
Description: The infrastructure Id of vCenter. ,
Required: False ,
}
string ,
port:
{
Description: The port number for discovery. ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: The account Id which has privileges to discover the vCenter. ,
Required: False ,
}
string ,
fabricArmResourceName:
{
Description: The ARM resource name of the fabric containing this VCenter. ,
Required: False ,
}
string ,
healthErrors:
{
Description: The health errors for this VCenter. ,
Required: False ,
}
[
{
innerHealthErrors:
{
Description: 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. ,
Required: False ,
}
[
{
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
ReplicationvCenters_Create (new)
Description :  The operation to create a vCenter object..
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationvCenters/{vcenterName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric name. ,
Required: True ,
}
string ,
vcenterName:
{
Description: vcenter name. ,
Required: True ,
}
string ,
addVCenterRequest:
{
Description: The input to the add vCenter operation. ,
Required: True ,
}
{
properties:
{
Description: The properties of an add vCenter request. ,
Required: False ,
}
{
friendlyName:
{
Description: The friendly name of the vCenter. ,
Required: False ,
}
string ,
ipAddress:
{
Description: The IP address of the vCenter to be discovered. ,
Required: False ,
}
string ,
processServerId:
{
Description: The process server Id from where the discovery is orchestrated. ,
Required: False ,
}
string ,
port:
{
Description: The port number for discovery. ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: The account Id which has privileges to discover the vCenter. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: VCenter related data. ,
Required: False ,
}
{
friendlyName:
{
Description: Friendly name of the vCenter. ,
Required: False ,
}
string ,
internalId:
{
Description: VCenter internal ID. ,
Required: False ,
}
string ,
lastHeartbeat:
{
Description: The time when the last heartbeat was received by vCenter. ,
Format: date-time ,
Required: False ,
}
string ,
discoveryStatus:
{
Description: The VCenter discovery status. ,
Required: False ,
}
string ,
processServerId:
{
Description: The process server Id. ,
Required: False ,
}
string ,
ipAddress:
{
Description: The IP address of the vCenter. ,
Required: False ,
}
string ,
infrastructureId:
{
Description: The infrastructure Id of vCenter. ,
Required: False ,
}
string ,
port:
{
Description: The port number for discovery. ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: The account Id which has privileges to discover the vCenter. ,
Required: False ,
}
string ,
fabricArmResourceName:
{
Description: The ARM resource name of the fabric containing this VCenter. ,
Required: False ,
}
string ,
healthErrors:
{
Description: The health errors for this VCenter. ,
Required: False ,
}
[
{
innerHealthErrors:
{
Description: 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. ,
Required: False ,
}
[
{
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}

⚐ Response (202)

{}
ReplicationvCenters_Delete (new)
Description :  The operation to remove(unregister) a registered vCenter server from the vault.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationvCenters/{vcenterName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric name. ,
Required: True ,
}
string ,
vcenterName:
{
Description: vcenter name. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
ReplicationvCenters_Update (new)
Description :  The operation to update a registered vCenter.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationvCenters/{vcenterName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric name. ,
Required: True ,
}
string ,
vcenterName:
{
Description: vcenter name. ,
Required: True ,
}
string ,
updateVCenterRequest:
{
Description: The input to the update vCenter operation. ,
Required: True ,
}
{
properties:
{
Description: The update VCenter Request Properties. ,
Required: False ,
}
{
friendlyName:
{
Description: The friendly name of the vCenter. ,
Required: False ,
}
string ,
ipAddress:
{
Description: The IP address of the vCenter to be discovered. ,
Required: False ,
}
string ,
processServerId:
{
Description: The process server Id from where the update can be orchestrated. ,
Required: False ,
}
string ,
port:
{
Description: The port number for discovery. ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: The CS account Id which has privileges to update the vCenter. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: VCenter related data. ,
Required: False ,
}
{
friendlyName:
{
Description: Friendly name of the vCenter. ,
Required: False ,
}
string ,
internalId:
{
Description: VCenter internal ID. ,
Required: False ,
}
string ,
lastHeartbeat:
{
Description: The time when the last heartbeat was received by vCenter. ,
Format: date-time ,
Required: False ,
}
string ,
discoveryStatus:
{
Description: The VCenter discovery status. ,
Required: False ,
}
string ,
processServerId:
{
Description: The process server Id. ,
Required: False ,
}
string ,
ipAddress:
{
Description: The IP address of the vCenter. ,
Required: False ,
}
string ,
infrastructureId:
{
Description: The infrastructure Id of vCenter. ,
Required: False ,
}
string ,
port:
{
Description: The port number for discovery. ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: The account Id which has privileges to discover the vCenter. ,
Required: False ,
}
string ,
fabricArmResourceName:
{
Description: The ARM resource name of the fabric containing this VCenter. ,
Required: False ,
}
string ,
healthErrors:
{
Description: The health errors for this VCenter. ,
Required: False ,
}
[
{
innerHealthErrors:
{
Description: 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. ,
Required: False ,
}
[
{
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}

⚐ Response (202)

{}
ReplicationJobs_List (new)
Description :  Gets the list of Azure Site Recovery Jobs for the vault.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationJobs
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
$filter:
{
Description: OData filter options. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of jobs. ,
Required: False ,
}
[
{
properties:
{
Description: The custom data. ,
Required: False ,
}
{
activityId:
{
Description: The activity id. ,
Required: False ,
}
string ,
scenarioName:
{
Description: The ScenarioName. ,
Required: False ,
}
string ,
friendlyName:
{
Description: The DisplayName. ,
Required: False ,
}
string ,
state:
{
Description: The status of the Job. It is one of these values - NotStarted, InProgress, Succeeded, Failed, Cancelled, Suspended or Other. ,
Required: False ,
}
string ,
stateDescription:
{
Description: The description of the state of the Job. For e.g. - For Succeeded state, description can be Completed, PartiallySucceeded, CompletedWithInformation or Skipped. ,
Required: False ,
}
string ,
tasks:
{
Description: The tasks. ,
Required: False ,
}
[
{
taskId:
{
Description: The Id. ,
Required: False ,
}
string ,
name:
{
Description: The unique Task name. ,
Required: False ,
}
string ,
startTime:
{
Description: The start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time. ,
Format: date-time ,
Required: False ,
}
string ,
allowedActions:
{
Description: The state/actions applicable on this task. ,
Required: False ,
}
[
string ,
]
,
friendlyName:
{
Description: The name. ,
Required: False ,
}
string ,
state:
{
Description: The State. It is one of these values - NotStarted, InProgress, Succeeded, Failed, Cancelled, Suspended or Other. ,
Required: False ,
}
string ,
stateDescription:
{
Description: The description of the task state. For example - For Succeeded state, description can be Completed, PartiallySucceeded, CompletedWithInformation or Skipped. ,
Required: False ,
}
string ,
taskType:
{
Description: The type of task. Details in CustomDetails property depend on this type. ,
Required: False ,
}
string ,
customDetails:
{
Description: The custom task details based on the task type. ,
Required: False ,
}
{
instanceType:
{
Description: The type of task details. ,
Required: True ,
}
string ,
}
,
groupTaskCustomDetails:
{
Description: The custom task details based on the task type, if the task type is GroupTaskDetails or one of the types derived from it. ,
Required: False ,
}
{
instanceType:
{
Description: The type of task details. ,
Required: True ,
}
string ,
childTasks:
{
Description: The child tasks. ,
Required: False ,
}
[
string ,
]
,
}
,
errors:
{
Description: The task error details. ,
Required: False ,
}
[
{
serviceErrorDetails:
{
Description: The Service error details. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
activityId:
{
Description: Activity Id. ,
Required: False ,
}
string ,
}
,
providerErrorDetails:
{
Description: The Provider error details. ,
Required: False ,
}
{
errorCode:
{
Description: The Error code. ,
Format: int32 ,
Required: False ,
}
integer ,
errorMessage:
{
Description: The Error message. ,
Required: False ,
}
string ,
errorId:
{
Description: The Provider error Id. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: The possible causes for the error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: The recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
errorLevel:
{
Description: Error level of error. ,
Required: False ,
}
string ,
creationTime:
{
Description: The creation time of job error. ,
Format: date-time ,
Required: False ,
}
string ,
taskId:
{
Description: The Id of the task. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
errors:
{
Description: The errors. ,
Required: False ,
}
[
{
serviceErrorDetails:
{
Description: The Service error details. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
activityId:
{
Description: Activity Id. ,
Required: False ,
}
string ,
}
,
providerErrorDetails:
{
Description: The Provider error details. ,
Required: False ,
}
{
errorCode:
{
Description: The Error code. ,
Format: int32 ,
Required: False ,
}
integer ,
errorMessage:
{
Description: The Error message. ,
Required: False ,
}
string ,
errorId:
{
Description: The Provider error Id. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: The possible causes for the error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: The recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
errorLevel:
{
Description: Error level of error. ,
Required: False ,
}
string ,
creationTime:
{
Description: The creation time of job error. ,
Format: date-time ,
Required: False ,
}
string ,
taskId:
{
Description: The Id of the task. ,
Required: False ,
}
string ,
}
,
]
,
startTime:
{
Description: The start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time. ,
Format: date-time ,
Required: False ,
}
string ,
allowedActions:
{
Description: The Allowed action the job. ,
Required: False ,
}
[
string ,
]
,
targetObjectId:
{
Description: The affected Object Id. ,
Required: False ,
}
string ,
targetObjectName:
{
Description: The name of the affected object. ,
Required: False ,
}
string ,
targetInstanceType:
{
Description: The type of the affected object which is of Microsoft.Azure.SiteRecovery.V2015_11_10.AffectedObjectType class. ,
Required: False ,
}
string ,
customDetails:
{
Description: The custom job details like test failover job details. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the type of job details (see JobDetailsTypes enum for possible values). ,
Required: True ,
}
string ,
affectedObjectDetails:
{
Description: The affected object properties like source server, source cloud, target server, target cloud etc. based on the workflow object details. ,
Required: False ,
}
object ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The value of next link. ,
Required: False ,
}
string ,
}
ReplicationJobs_Get (new)
Description :  Get the details of an Azure Site Recovery job.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationJobs/{jobName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
jobName:
{
Description: Job identifier. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The custom data. ,
Required: False ,
}
{
activityId:
{
Description: The activity id. ,
Required: False ,
}
string ,
scenarioName:
{
Description: The ScenarioName. ,
Required: False ,
}
string ,
friendlyName:
{
Description: The DisplayName. ,
Required: False ,
}
string ,
state:
{
Description: The status of the Job. It is one of these values - NotStarted, InProgress, Succeeded, Failed, Cancelled, Suspended or Other. ,
Required: False ,
}
string ,
stateDescription:
{
Description: The description of the state of the Job. For e.g. - For Succeeded state, description can be Completed, PartiallySucceeded, CompletedWithInformation or Skipped. ,
Required: False ,
}
string ,
tasks:
{
Description: The tasks. ,
Required: False ,
}
[
{
taskId:
{
Description: The Id. ,
Required: False ,
}
string ,
name:
{
Description: The unique Task name. ,
Required: False ,
}
string ,
startTime:
{
Description: The start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time. ,
Format: date-time ,
Required: False ,
}
string ,
allowedActions:
{
Description: The state/actions applicable on this task. ,
Required: False ,
}
[
string ,
]
,
friendlyName:
{
Description: The name. ,
Required: False ,
}
string ,
state:
{
Description: The State. It is one of these values - NotStarted, InProgress, Succeeded, Failed, Cancelled, Suspended or Other. ,
Required: False ,
}
string ,
stateDescription:
{
Description: The description of the task state. For example - For Succeeded state, description can be Completed, PartiallySucceeded, CompletedWithInformation or Skipped. ,
Required: False ,
}
string ,
taskType:
{
Description: The type of task. Details in CustomDetails property depend on this type. ,
Required: False ,
}
string ,
customDetails:
{
Description: The custom task details based on the task type. ,
Required: False ,
}
{
instanceType:
{
Description: The type of task details. ,
Required: True ,
}
string ,
}
,
groupTaskCustomDetails:
{
Description: The custom task details based on the task type, if the task type is GroupTaskDetails or one of the types derived from it. ,
Required: False ,
}
{
instanceType:
{
Description: The type of task details. ,
Required: True ,
}
string ,
childTasks:
{
Description: The child tasks. ,
Required: False ,
}
[
string ,
]
,
}
,
errors:
{
Description: The task error details. ,
Required: False ,
}
[
{
serviceErrorDetails:
{
Description: The Service error details. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
activityId:
{
Description: Activity Id. ,
Required: False ,
}
string ,
}
,
providerErrorDetails:
{
Description: The Provider error details. ,
Required: False ,
}
{
errorCode:
{
Description: The Error code. ,
Format: int32 ,
Required: False ,
}
integer ,
errorMessage:
{
Description: The Error message. ,
Required: False ,
}
string ,
errorId:
{
Description: The Provider error Id. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: The possible causes for the error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: The recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
errorLevel:
{
Description: Error level of error. ,
Required: False ,
}
string ,
creationTime:
{
Description: The creation time of job error. ,
Format: date-time ,
Required: False ,
}
string ,
taskId:
{
Description: The Id of the task. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
errors:
{
Description: The errors. ,
Required: False ,
}
[
{
serviceErrorDetails:
{
Description: The Service error details. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
activityId:
{
Description: Activity Id. ,
Required: False ,
}
string ,
}
,
providerErrorDetails:
{
Description: The Provider error details. ,
Required: False ,
}
{
errorCode:
{
Description: The Error code. ,
Format: int32 ,
Required: False ,
}
integer ,
errorMessage:
{
Description: The Error message. ,
Required: False ,
}
string ,
errorId:
{
Description: The Provider error Id. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: The possible causes for the error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: The recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
errorLevel:
{
Description: Error level of error. ,
Required: False ,
}
string ,
creationTime:
{
Description: The creation time of job error. ,
Format: date-time ,
Required: False ,
}
string ,
taskId:
{
Description: The Id of the task. ,
Required: False ,
}
string ,
}
,
]
,
startTime:
{
Description: The start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time. ,
Format: date-time ,
Required: False ,
}
string ,
allowedActions:
{
Description: The Allowed action the job. ,
Required: False ,
}
[
string ,
]
,
targetObjectId:
{
Description: The affected Object Id. ,
Required: False ,
}
string ,
targetObjectName:
{
Description: The name of the affected object. ,
Required: False ,
}
string ,
targetInstanceType:
{
Description: The type of the affected object which is of Microsoft.Azure.SiteRecovery.V2015_11_10.AffectedObjectType class. ,
Required: False ,
}
string ,
customDetails:
{
Description: The custom job details like test failover job details. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the type of job details (see JobDetailsTypes enum for possible values). ,
Required: True ,
}
string ,
affectedObjectDetails:
{
Description: The affected object properties like source server, source cloud, target server, target cloud etc. based on the workflow object details. ,
Required: False ,
}
object ,
}
,
}
,
}
ReplicationJobs_Cancel (new)
Description :  The operation to cancel an Azure Site Recovery job.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationJobs/{jobName}/cancel
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
jobName:
{
Description: Job identifier. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The custom data. ,
Required: False ,
}
{
activityId:
{
Description: The activity id. ,
Required: False ,
}
string ,
scenarioName:
{
Description: The ScenarioName. ,
Required: False ,
}
string ,
friendlyName:
{
Description: The DisplayName. ,
Required: False ,
}
string ,
state:
{
Description: The status of the Job. It is one of these values - NotStarted, InProgress, Succeeded, Failed, Cancelled, Suspended or Other. ,
Required: False ,
}
string ,
stateDescription:
{
Description: The description of the state of the Job. For e.g. - For Succeeded state, description can be Completed, PartiallySucceeded, CompletedWithInformation or Skipped. ,
Required: False ,
}
string ,
tasks:
{
Description: The tasks. ,
Required: False ,
}
[
{
taskId:
{
Description: The Id. ,
Required: False ,
}
string ,
name:
{
Description: The unique Task name. ,
Required: False ,
}
string ,
startTime:
{
Description: The start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time. ,
Format: date-time ,
Required: False ,
}
string ,
allowedActions:
{
Description: The state/actions applicable on this task. ,
Required: False ,
}
[
string ,
]
,
friendlyName:
{
Description: The name. ,
Required: False ,
}
string ,
state:
{
Description: The State. It is one of these values - NotStarted, InProgress, Succeeded, Failed, Cancelled, Suspended or Other. ,
Required: False ,
}
string ,
stateDescription:
{
Description: The description of the task state. For example - For Succeeded state, description can be Completed, PartiallySucceeded, CompletedWithInformation or Skipped. ,
Required: False ,
}
string ,
taskType:
{
Description: The type of task. Details in CustomDetails property depend on this type. ,
Required: False ,
}
string ,
customDetails:
{
Description: The custom task details based on the task type. ,
Required: False ,
}
{
instanceType:
{
Description: The type of task details. ,
Required: True ,
}
string ,
}
,
groupTaskCustomDetails:
{
Description: The custom task details based on the task type, if the task type is GroupTaskDetails or one of the types derived from it. ,
Required: False ,
}
{
instanceType:
{
Description: The type of task details. ,
Required: True ,
}
string ,
childTasks:
{
Description: The child tasks. ,
Required: False ,
}
[
string ,
]
,
}
,
errors:
{
Description: The task error details. ,
Required: False ,
}
[
{
serviceErrorDetails:
{
Description: The Service error details. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
activityId:
{
Description: Activity Id. ,
Required: False ,
}
string ,
}
,
providerErrorDetails:
{
Description: The Provider error details. ,
Required: False ,
}
{
errorCode:
{
Description: The Error code. ,
Format: int32 ,
Required: False ,
}
integer ,
errorMessage:
{
Description: The Error message. ,
Required: False ,
}
string ,
errorId:
{
Description: The Provider error Id. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: The possible causes for the error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: The recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
errorLevel:
{
Description: Error level of error. ,
Required: False ,
}
string ,
creationTime:
{
Description: The creation time of job error. ,
Format: date-time ,
Required: False ,
}
string ,
taskId:
{
Description: The Id of the task. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
errors:
{
Description: The errors. ,
Required: False ,
}
[
{
serviceErrorDetails:
{
Description: The Service error details. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
activityId:
{
Description: Activity Id. ,
Required: False ,
}
string ,
}
,
providerErrorDetails:
{
Description: The Provider error details. ,
Required: False ,
}
{
errorCode:
{
Description: The Error code. ,
Format: int32 ,
Required: False ,
}
integer ,
errorMessage:
{
Description: The Error message. ,
Required: False ,
}
string ,
errorId:
{
Description: The Provider error Id. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: The possible causes for the error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: The recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
errorLevel:
{
Description: Error level of error. ,
Required: False ,
}
string ,
creationTime:
{
Description: The creation time of job error. ,
Format: date-time ,
Required: False ,
}
string ,
taskId:
{
Description: The Id of the task. ,
Required: False ,
}
string ,
}
,
]
,
startTime:
{
Description: The start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time. ,
Format: date-time ,
Required: False ,
}
string ,
allowedActions:
{
Description: The Allowed action the job. ,
Required: False ,
}
[
string ,
]
,
targetObjectId:
{
Description: The affected Object Id. ,
Required: False ,
}
string ,
targetObjectName:
{
Description: The name of the affected object. ,
Required: False ,
}
string ,
targetInstanceType:
{
Description: The type of the affected object which is of Microsoft.Azure.SiteRecovery.V2015_11_10.AffectedObjectType class. ,
Required: False ,
}
string ,
customDetails:
{
Description: The custom job details like test failover job details. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the type of job details (see JobDetailsTypes enum for possible values). ,
Required: True ,
}
string ,
affectedObjectDetails:
{
Description: The affected object properties like source server, source cloud, target server, target cloud etc. based on the workflow object details. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (202)

{}
ReplicationJobs_Restart (new)
Description :  The operation to restart an Azure Site Recovery job.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationJobs/{jobName}/restart
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
jobName:
{
Description: Job identifier. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The custom data. ,
Required: False ,
}
{
activityId:
{
Description: The activity id. ,
Required: False ,
}
string ,
scenarioName:
{
Description: The ScenarioName. ,
Required: False ,
}
string ,
friendlyName:
{
Description: The DisplayName. ,
Required: False ,
}
string ,
state:
{
Description: The status of the Job. It is one of these values - NotStarted, InProgress, Succeeded, Failed, Cancelled, Suspended or Other. ,
Required: False ,
}
string ,
stateDescription:
{
Description: The description of the state of the Job. For e.g. - For Succeeded state, description can be Completed, PartiallySucceeded, CompletedWithInformation or Skipped. ,
Required: False ,
}
string ,
tasks:
{
Description: The tasks. ,
Required: False ,
}
[
{
taskId:
{
Description: The Id. ,
Required: False ,
}
string ,
name:
{
Description: The unique Task name. ,
Required: False ,
}
string ,
startTime:
{
Description: The start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time. ,
Format: date-time ,
Required: False ,
}
string ,
allowedActions:
{
Description: The state/actions applicable on this task. ,
Required: False ,
}
[
string ,
]
,
friendlyName:
{
Description: The name. ,
Required: False ,
}
string ,
state:
{
Description: The State. It is one of these values - NotStarted, InProgress, Succeeded, Failed, Cancelled, Suspended or Other. ,
Required: False ,
}
string ,
stateDescription:
{
Description: The description of the task state. For example - For Succeeded state, description can be Completed, PartiallySucceeded, CompletedWithInformation or Skipped. ,
Required: False ,
}
string ,
taskType:
{
Description: The type of task. Details in CustomDetails property depend on this type. ,
Required: False ,
}
string ,
customDetails:
{
Description: The custom task details based on the task type. ,
Required: False ,
}
{
instanceType:
{
Description: The type of task details. ,
Required: True ,
}
string ,
}
,
groupTaskCustomDetails:
{
Description: The custom task details based on the task type, if the task type is GroupTaskDetails or one of the types derived from it. ,
Required: False ,
}
{
instanceType:
{
Description: The type of task details. ,
Required: True ,
}
string ,
childTasks:
{
Description: The child tasks. ,
Required: False ,
}
[
string ,
]
,
}
,
errors:
{
Description: The task error details. ,
Required: False ,
}
[
{
serviceErrorDetails:
{
Description: The Service error details. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
activityId:
{
Description: Activity Id. ,
Required: False ,
}
string ,
}
,
providerErrorDetails:
{
Description: The Provider error details. ,
Required: False ,
}
{
errorCode:
{
Description: The Error code. ,
Format: int32 ,
Required: False ,
}
integer ,
errorMessage:
{
Description: The Error message. ,
Required: False ,
}
string ,
errorId:
{
Description: The Provider error Id. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: The possible causes for the error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: The recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
errorLevel:
{
Description: Error level of error. ,
Required: False ,
}
string ,
creationTime:
{
Description: The creation time of job error. ,
Format: date-time ,
Required: False ,
}
string ,
taskId:
{
Description: The Id of the task. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
errors:
{
Description: The errors. ,
Required: False ,
}
[
{
serviceErrorDetails:
{
Description: The Service error details. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
activityId:
{
Description: Activity Id. ,
Required: False ,
}
string ,
}
,
providerErrorDetails:
{
Description: The Provider error details. ,
Required: False ,
}
{
errorCode:
{
Description: The Error code. ,
Format: int32 ,
Required: False ,
}
integer ,
errorMessage:
{
Description: The Error message. ,
Required: False ,
}
string ,
errorId:
{
Description: The Provider error Id. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: The possible causes for the error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: The recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
errorLevel:
{
Description: Error level of error. ,
Required: False ,
}
string ,
creationTime:
{
Description: The creation time of job error. ,
Format: date-time ,
Required: False ,
}
string ,
taskId:
{
Description: The Id of the task. ,
Required: False ,
}
string ,
}
,
]
,
startTime:
{
Description: The start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time. ,
Format: date-time ,
Required: False ,
}
string ,
allowedActions:
{
Description: The Allowed action the job. ,
Required: False ,
}
[
string ,
]
,
targetObjectId:
{
Description: The affected Object Id. ,
Required: False ,
}
string ,
targetObjectName:
{
Description: The name of the affected object. ,
Required: False ,
}
string ,
targetInstanceType:
{
Description: The type of the affected object which is of Microsoft.Azure.SiteRecovery.V2015_11_10.AffectedObjectType class. ,
Required: False ,
}
string ,
customDetails:
{
Description: The custom job details like test failover job details. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the type of job details (see JobDetailsTypes enum for possible values). ,
Required: True ,
}
string ,
affectedObjectDetails:
{
Description: The affected object properties like source server, source cloud, target server, target cloud etc. based on the workflow object details. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (202)

{}
ReplicationJobs_Resume (new)
Description :  The operation to resume an Azure Site Recovery job.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationJobs/{jobName}/resume
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
jobName:
{
Description: Job identifier. ,
Required: True ,
}
string ,
resumeJobParams:
{
Description: Resume rob comments. ,
Required: True ,
}
{
properties:
{
Description: Resume job properties. ,
Required: False ,
}
{
comments:
{
Description: Resume job comments. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The custom data. ,
Required: False ,
}
{
activityId:
{
Description: The activity id. ,
Required: False ,
}
string ,
scenarioName:
{
Description: The ScenarioName. ,
Required: False ,
}
string ,
friendlyName:
{
Description: The DisplayName. ,
Required: False ,
}
string ,
state:
{
Description: The status of the Job. It is one of these values - NotStarted, InProgress, Succeeded, Failed, Cancelled, Suspended or Other. ,
Required: False ,
}
string ,
stateDescription:
{
Description: The description of the state of the Job. For e.g. - For Succeeded state, description can be Completed, PartiallySucceeded, CompletedWithInformation or Skipped. ,
Required: False ,
}
string ,
tasks:
{
Description: The tasks. ,
Required: False ,
}
[
{
taskId:
{
Description: The Id. ,
Required: False ,
}
string ,
name:
{
Description: The unique Task name. ,
Required: False ,
}
string ,
startTime:
{
Description: The start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time. ,
Format: date-time ,
Required: False ,
}
string ,
allowedActions:
{
Description: The state/actions applicable on this task. ,
Required: False ,
}
[
string ,
]
,
friendlyName:
{
Description: The name. ,
Required: False ,
}
string ,
state:
{
Description: The State. It is one of these values - NotStarted, InProgress, Succeeded, Failed, Cancelled, Suspended or Other. ,
Required: False ,
}
string ,
stateDescription:
{
Description: The description of the task state. For example - For Succeeded state, description can be Completed, PartiallySucceeded, CompletedWithInformation or Skipped. ,
Required: False ,
}
string ,
taskType:
{
Description: The type of task. Details in CustomDetails property depend on this type. ,
Required: False ,
}
string ,
customDetails:
{
Description: The custom task details based on the task type. ,
Required: False ,
}
{
instanceType:
{
Description: The type of task details. ,
Required: True ,
}
string ,
}
,
groupTaskCustomDetails:
{
Description: The custom task details based on the task type, if the task type is GroupTaskDetails or one of the types derived from it. ,
Required: False ,
}
{
instanceType:
{
Description: The type of task details. ,
Required: True ,
}
string ,
childTasks:
{
Description: The child tasks. ,
Required: False ,
}
[
string ,
]
,
}
,
errors:
{
Description: The task error details. ,
Required: False ,
}
[
{
serviceErrorDetails:
{
Description: The Service error details. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
activityId:
{
Description: Activity Id. ,
Required: False ,
}
string ,
}
,
providerErrorDetails:
{
Description: The Provider error details. ,
Required: False ,
}
{
errorCode:
{
Description: The Error code. ,
Format: int32 ,
Required: False ,
}
integer ,
errorMessage:
{
Description: The Error message. ,
Required: False ,
}
string ,
errorId:
{
Description: The Provider error Id. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: The possible causes for the error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: The recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
errorLevel:
{
Description: Error level of error. ,
Required: False ,
}
string ,
creationTime:
{
Description: The creation time of job error. ,
Format: date-time ,
Required: False ,
}
string ,
taskId:
{
Description: The Id of the task. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
errors:
{
Description: The errors. ,
Required: False ,
}
[
{
serviceErrorDetails:
{
Description: The Service error details. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
activityId:
{
Description: Activity Id. ,
Required: False ,
}
string ,
}
,
providerErrorDetails:
{
Description: The Provider error details. ,
Required: False ,
}
{
errorCode:
{
Description: The Error code. ,
Format: int32 ,
Required: False ,
}
integer ,
errorMessage:
{
Description: The Error message. ,
Required: False ,
}
string ,
errorId:
{
Description: The Provider error Id. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: The possible causes for the error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: The recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
errorLevel:
{
Description: Error level of error. ,
Required: False ,
}
string ,
creationTime:
{
Description: The creation time of job error. ,
Format: date-time ,
Required: False ,
}
string ,
taskId:
{
Description: The Id of the task. ,
Required: False ,
}
string ,
}
,
]
,
startTime:
{
Description: The start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time. ,
Format: date-time ,
Required: False ,
}
string ,
allowedActions:
{
Description: The Allowed action the job. ,
Required: False ,
}
[
string ,
]
,
targetObjectId:
{
Description: The affected Object Id. ,
Required: False ,
}
string ,
targetObjectName:
{
Description: The name of the affected object. ,
Required: False ,
}
string ,
targetInstanceType:
{
Description: The type of the affected object which is of Microsoft.Azure.SiteRecovery.V2015_11_10.AffectedObjectType class. ,
Required: False ,
}
string ,
customDetails:
{
Description: The custom job details like test failover job details. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the type of job details (see JobDetailsTypes enum for possible values). ,
Required: True ,
}
string ,
affectedObjectDetails:
{
Description: The affected object properties like source server, source cloud, target server, target cloud etc. based on the workflow object details. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (202)

{}
ReplicationJobs_Export (new)
Description :  The operation to export the details of the Azure Site Recovery jobs of the vault.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationJobs/export
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
jobQueryParameter:
{
Description: job query filter. ,
Required: True ,
}
{
startTime:
{
Description: Date time to get jobs from. ,
Required: False ,
}
string ,
endTime:
{
Description: Date time to get jobs upto. ,
Required: False ,
}
string ,
fabricId:
{
Description: The Id of the fabric to search jobs under. ,
Required: False ,
}
string ,
affectedObjectTypes:
{
Description: The type of objects. ,
Required: False ,
}
string ,
jobStatus:
{
Description: The states of the job to be filtered can be in. ,
Required: False ,
}
string ,
jobOutputType:
{
Description: The output type of the jobs. ,
Enum:
{
Json: No description available. ,
Xml: No description available. ,
Excel: No description available. ,
}
,
Required: False ,
}
enum ,
jobName:
{
Description: The job Name. ,
Required: False ,
}
string ,
timezoneOffset:
{
Description: The timezone offset for the location of the request (in minutes). ,
Format: double ,
Required: False ,
}
number ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The custom data. ,
Required: False ,
}
{
activityId:
{
Description: The activity id. ,
Required: False ,
}
string ,
scenarioName:
{
Description: The ScenarioName. ,
Required: False ,
}
string ,
friendlyName:
{
Description: The DisplayName. ,
Required: False ,
}
string ,
state:
{
Description: The status of the Job. It is one of these values - NotStarted, InProgress, Succeeded, Failed, Cancelled, Suspended or Other. ,
Required: False ,
}
string ,
stateDescription:
{
Description: The description of the state of the Job. For e.g. - For Succeeded state, description can be Completed, PartiallySucceeded, CompletedWithInformation or Skipped. ,
Required: False ,
}
string ,
tasks:
{
Description: The tasks. ,
Required: False ,
}
[
{
taskId:
{
Description: The Id. ,
Required: False ,
}
string ,
name:
{
Description: The unique Task name. ,
Required: False ,
}
string ,
startTime:
{
Description: The start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time. ,
Format: date-time ,
Required: False ,
}
string ,
allowedActions:
{
Description: The state/actions applicable on this task. ,
Required: False ,
}
[
string ,
]
,
friendlyName:
{
Description: The name. ,
Required: False ,
}
string ,
state:
{
Description: The State. It is one of these values - NotStarted, InProgress, Succeeded, Failed, Cancelled, Suspended or Other. ,
Required: False ,
}
string ,
stateDescription:
{
Description: The description of the task state. For example - For Succeeded state, description can be Completed, PartiallySucceeded, CompletedWithInformation or Skipped. ,
Required: False ,
}
string ,
taskType:
{
Description: The type of task. Details in CustomDetails property depend on this type. ,
Required: False ,
}
string ,
customDetails:
{
Description: The custom task details based on the task type. ,
Required: False ,
}
{
instanceType:
{
Description: The type of task details. ,
Required: True ,
}
string ,
}
,
groupTaskCustomDetails:
{
Description: The custom task details based on the task type, if the task type is GroupTaskDetails or one of the types derived from it. ,
Required: False ,
}
{
instanceType:
{
Description: The type of task details. ,
Required: True ,
}
string ,
childTasks:
{
Description: The child tasks. ,
Required: False ,
}
[
string ,
]
,
}
,
errors:
{
Description: The task error details. ,
Required: False ,
}
[
{
serviceErrorDetails:
{
Description: The Service error details. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
activityId:
{
Description: Activity Id. ,
Required: False ,
}
string ,
}
,
providerErrorDetails:
{
Description: The Provider error details. ,
Required: False ,
}
{
errorCode:
{
Description: The Error code. ,
Format: int32 ,
Required: False ,
}
integer ,
errorMessage:
{
Description: The Error message. ,
Required: False ,
}
string ,
errorId:
{
Description: The Provider error Id. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: The possible causes for the error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: The recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
errorLevel:
{
Description: Error level of error. ,
Required: False ,
}
string ,
creationTime:
{
Description: The creation time of job error. ,
Format: date-time ,
Required: False ,
}
string ,
taskId:
{
Description: The Id of the task. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
errors:
{
Description: The errors. ,
Required: False ,
}
[
{
serviceErrorDetails:
{
Description: The Service error details. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
activityId:
{
Description: Activity Id. ,
Required: False ,
}
string ,
}
,
providerErrorDetails:
{
Description: The Provider error details. ,
Required: False ,
}
{
errorCode:
{
Description: The Error code. ,
Format: int32 ,
Required: False ,
}
integer ,
errorMessage:
{
Description: The Error message. ,
Required: False ,
}
string ,
errorId:
{
Description: The Provider error Id. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: The possible causes for the error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: The recommended action to resolve the error. ,
Required: False ,
}
string ,
}
,
errorLevel:
{
Description: Error level of error. ,
Required: False ,
}
string ,
creationTime:
{
Description: The creation time of job error. ,
Format: date-time ,
Required: False ,
}
string ,
taskId:
{
Description: The Id of the task. ,
Required: False ,
}
string ,
}
,
]
,
startTime:
{
Description: The start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time. ,
Format: date-time ,
Required: False ,
}
string ,
allowedActions:
{
Description: The Allowed action the job. ,
Required: False ,
}
[
string ,
]
,
targetObjectId:
{
Description: The affected Object Id. ,
Required: False ,
}
string ,
targetObjectName:
{
Description: The name of the affected object. ,
Required: False ,
}
string ,
targetInstanceType:
{
Description: The type of the affected object which is of Microsoft.Azure.SiteRecovery.V2015_11_10.AffectedObjectType class. ,
Required: False ,
}
string ,
customDetails:
{
Description: The custom job details like test failover job details. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the type of job details (see JobDetailsTypes enum for possible values). ,
Required: True ,
}
string ,
affectedObjectDetails:
{
Description: The affected object properties like source server, source cloud, target server, target cloud etc. based on the workflow object details. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (202)

{}
ReplicationMigrationItems_List (new)
Description :  Gets the list of migration items in the vault.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationMigrationItems
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
skipToken:
{
Description: The pagination token. ,
Required: False ,
}
string ,
takeToken:
{
Description: The page size. ,
Required: False ,
}
string ,
$filter:
{
Description: OData filter options. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of migration items. ,
Required: False ,
}
[
{
properties:
{
Description: The migration item properties. ,
Required: False ,
}
{
machineName:
{
Description: The on-premise virtual machine name. ,
Required: False ,
}
string ,
policyId:
{
Description: The ARM Id of policy governing this item. ,
Required: False ,
}
string ,
policyFriendlyName:
{
Description: The name of policy governing this item. ,
Required: False ,
}
string ,
recoveryServicesProviderId:
{
Description: The recovery services provider ARM Id. ,
Required: False ,
}
string ,
replicationStatus:
{
Description: The replication status. ,
Required: False ,
}
string ,
migrationState:
{
Description: The migration status. ,
Enum:
{
None: No description available. ,
EnableMigrationInProgress: No description available. ,
EnableMigrationFailed: No description available. ,
DisableMigrationInProgress: No description available. ,
DisableMigrationFailed: No description available. ,
InitialSeedingInProgress: No description available. ,
InitialSeedingFailed: No description available. ,
Replicating: No description available. ,
MigrationInProgress: No description available. ,
MigrationSucceeded: No description available. ,
MigrationFailed: No description available. ,
ResumeInProgress: No description available. ,
ResumeInitiated: No description available. ,
SuspendingProtection: No description available. ,
ProtectionSuspended: No description available. ,
MigrationCompletedWithInformation: No description available. ,
MigrationPartiallySucceeded: No description available. ,
}
,
Required: False ,
}
enum ,
migrationStateDescription:
{
Description: The migration state description. ,
Required: False ,
}
string ,
lastTestMigrationTime:
{
Description: The last test migration time. ,
Format: date-time ,
Required: False ,
}
string ,
lastTestMigrationStatus:
{
Description: The status of the last test migration. ,
Required: False ,
}
string ,
lastMigrationTime:
{
Description: The last migration time. ,
Format: date-time ,
Required: False ,
}
string ,
lastMigrationStatus:
{
Description: The status of the last migration. ,
Required: False ,
}
string ,
testMigrateState:
{
Description: The test migrate state. ,
Enum:
{
None: No description available. ,
TestMigrationInProgress: No description available. ,
TestMigrationSucceeded: No description available. ,
TestMigrationFailed: No description available. ,
TestMigrationCleanupInProgress: No description available. ,
TestMigrationCompletedWithInformation: No description available. ,
TestMigrationPartiallySucceeded: No description available. ,
}
,
Required: False ,
}
enum ,
testMigrateStateDescription:
{
Description: The test migrate state description. ,
Required: False ,
}
string ,
health:
{
Description: The consolidated health. ,
Enum:
{
None: No description available. ,
Normal: No description available. ,
Warning: No description available. ,
Critical: No description available. ,
}
,
Required: False ,
}
enum ,
healthErrors:
{
Description: The list of health errors. ,
Required: False ,
}
[
{
innerHealthErrors:
{
Description: 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. ,
Required: False ,
}
[
{
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
allowedOperations:
{
Description: The allowed operations on the migration item based on the current migration state of the item. ,
Required: False ,
}
[
string ,
]
,
currentJob:
{
Description: The current job details. ,
Required: False ,
}
{
jobName:
{
Description: The job name. ,
Required: False ,
}
string ,
jobId:
{
Description: The ARM Id of the job being executed. ,
Required: False ,
}
string ,
startTime:
{
Description: The start time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
criticalJobHistory:
{
Description: The critical past job details. ,
Required: False ,
}
[
{
jobName:
{
Description: The job name. ,
Required: False ,
}
string ,
jobId:
{
Description: The ARM Id of the job being executed. ,
Required: False ,
}
string ,
startTime:
{
Description: The start time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
jobStatus:
{
Description: The job state. ,
Required: False ,
}
string ,
}
,
]
,
eventCorrelationId:
{
Description: The correlation Id for events associated with this migration item. ,
Required: False ,
}
string ,
providerSpecificDetails:
{
Description: The migration provider custom settings. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the instance type. ,
Required: True ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The value of next link. ,
Required: False ,
}
string ,
}
ReplicationNetworkMappings_List (new)
Description :  Lists all ASR network mappings in the vault.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationNetworkMappings
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Network Mappings list. ,
Required: False ,
}
[
{
properties:
{
Description: The Network Mapping Properties. ,
Required: False ,
}
{
state:
{
Description: The pairing state for network mapping. ,
Required: False ,
}
string ,
primaryNetworkFriendlyName:
{
Description: The primary network friendly name. ,
Required: False ,
}
string ,
primaryNetworkId:
{
Description: The primary network id for network mapping. ,
Required: False ,
}
string ,
primaryFabricFriendlyName:
{
Description: The primary fabric friendly name. ,
Required: False ,
}
string ,
recoveryNetworkFriendlyName:
{
Description: The recovery network friendly name. ,
Required: False ,
}
string ,
recoveryNetworkId:
{
Description: The recovery network id for network mapping. ,
Required: False ,
}
string ,
recoveryFabricArmId:
{
Description: The recovery fabric ARM id. ,
Required: False ,
}
string ,
recoveryFabricFriendlyName:
{
Description: The recovery fabric friendly name. ,
Required: False ,
}
string ,
fabricSpecificSettings:
{
Description: The fabric specific settings. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the Instance type. ,
Required: True ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The value of next link. ,
Required: False ,
}
string ,
}
ReplicationNetworks_List (new)
Description :  Lists the networks available in a vault.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationNetworks
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Networks list details. ,
Required: False ,
}
[
{
properties:
{
Description: The Network Properties. ,
Required: False ,
}
{
fabricType:
{
Description: The Fabric Type. ,
Required: False ,
}
string ,
subnets:
{
Description: The List of subnets. ,
Required: False ,
}
[
{
name:
{
Description: The subnet name. ,
Required: False ,
}
string ,
friendlyName:
{
Description: The subnet friendly name. ,
Required: False ,
}
string ,
addressList:
{
Description: The list of addresses for the subnet. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
friendlyName:
{
Description: The Friendly Name. ,
Required: False ,
}
string ,
networkType:
{
Description: The Network Type. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The value of next link. ,
Required: False ,
}
string ,
}
ReplicationPolicies_List (new)
Description :  Lists the replication policies for a vault.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationPolicies
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The policy details. ,
Required: False ,
}
[
{
properties:
{
Description: The custom data. ,
Required: False ,
}
{
friendlyName:
{
Description: The FriendlyName. ,
Required: False ,
}
string ,
providerSpecificDetails:
{
Description: The ReplicationChannelSetting. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the class type. Overridden in derived classes. ,
Required: True ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The value of next link. ,
Required: False ,
}
string ,
}
ReplicationPolicies_Get (new)
Description :  Gets the details of a replication policy.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationPolicies/{policyName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
policyName:
{
Description: Replication policy name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The custom data. ,
Required: False ,
}
{
friendlyName:
{
Description: The FriendlyName. ,
Required: False ,
}
string ,
providerSpecificDetails:
{
Description: The ReplicationChannelSetting. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the class type. Overridden in derived classes. ,
Required: True ,
}
string ,
}
,
}
,
}
ReplicationPolicies_Create (new)
Description :  The operation to create a replication policy.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationPolicies/{policyName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
policyName:
{
Description: Replication policy name. ,
Required: True ,
}
string ,
input:
{
Description: Create policy input. ,
Required: True ,
}
{
properties:
{
Description: Policy creation properties. ,
Required: False ,
}
{
providerSpecificInput:
{
Description: The ReplicationProviderSettings. ,
Required: False ,
}
{
instanceType:
{
Description: The class type. ,
Required: True ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The custom data. ,
Required: False ,
}
{
friendlyName:
{
Description: The FriendlyName. ,
Required: False ,
}
string ,
providerSpecificDetails:
{
Description: The ReplicationChannelSetting. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the class type. Overridden in derived classes. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{}
ReplicationPolicies_Delete (new)
Description :  The operation to delete a replication policy.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationPolicies/{policyName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
policyName:
{
Description: Replication policy name. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
ReplicationPolicies_Update (new)
Description :  The operation to update a replication policy.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationPolicies/{policyName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
policyName:
{
Description: Policy Id. ,
Required: True ,
}
string ,
input:
{
Description: Update Policy Input. ,
Required: True ,
}
{
properties:
{
Description: The ReplicationProviderSettings. ,
Required: False ,
}
{
replicationProviderSettings:
{
Description: The ReplicationProviderSettings. ,
Required: False ,
}
{
instanceType:
{
Description: The class type. ,
Required: True ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The custom data. ,
Required: False ,
}
{
friendlyName:
{
Description: The FriendlyName. ,
Required: False ,
}
string ,
providerSpecificDetails:
{
Description: The ReplicationChannelSetting. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the class type. Overridden in derived classes. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{}
ReplicationProtectedItems_List (new)
Description :  Gets the list of ASR replication protected items in the vault.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationProtectedItems
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
skipToken:
{
Description: The pagination token. Possible values: "FabricId" or "FabricId_CloudId" or null. ,
Required: False ,
}
string ,
$filter:
{
Description: OData filter options. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Replication protected item details. ,
Required: False ,
}
[
{
properties:
{
Description: The custom data. ,
Required: False ,
}
{
friendlyName:
{
Description: The name. ,
Required: False ,
}
string ,
protectedItemType:
{
Description: The type of protected item type. ,
Required: False ,
}
string ,
protectableItemId:
{
Description: The protected item ARM Id. ,
Required: False ,
}
string ,
recoveryServicesProviderId:
{
Description: The recovery provider ARM Id. ,
Required: False ,
}
string ,
primaryFabricFriendlyName:
{
Description: The friendly name of the primary fabric. ,
Required: False ,
}
string ,
primaryFabricProvider:
{
Description: The fabric provider of the primary fabric. ,
Required: False ,
}
string ,
recoveryFabricFriendlyName:
{
Description: The friendly name of recovery fabric. ,
Required: False ,
}
string ,
recoveryFabricId:
{
Description: The Arm Id of recovery fabric. ,
Required: False ,
}
string ,
primaryProtectionContainerFriendlyName:
{
Description: The name of primary protection container friendly name. ,
Required: False ,
}
string ,
recoveryProtectionContainerFriendlyName:
{
Description: The name of recovery container friendly name. ,
Required: False ,
}
string ,
protectionState:
{
Description: The protection status. ,
Required: False ,
}
string ,
protectionStateDescription:
{
Description: The protection state description. ,
Required: False ,
}
string ,
activeLocation:
{
Description: The Current active location of the PE. ,
Required: False ,
}
string ,
testFailoverState:
{
Description: The Test failover state. ,
Required: False ,
}
string ,
testFailoverStateDescription:
{
Description: The Test failover state description. ,
Required: False ,
}
string ,
switchProviderState:
{
Description: The switch provider state. ,
Required: False ,
}
string ,
switchProviderStateDescription:
{
Description: The switch provider state description. ,
Required: False ,
}
string ,
allowedOperations:
{
Description: The allowed operations on the Replication protected item. ,
Required: False ,
}
[
string ,
]
,
replicationHealth:
{
Description: 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. ,
Required: False ,
}
string ,
failoverHealth:
{
Description: The consolidated failover health for the VM. ,
Required: False ,
}
string ,
healthErrors:
{
Description: List of health errors. ,
Required: False ,
}
[
{
innerHealthErrors:
{
Description: 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. ,
Required: False ,
}
[
{
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
policyId:
{
Description: The ID of Policy governing this PE. ,
Required: False ,
}
string ,
policyFriendlyName:
{
Description: The name of Policy governing this PE. ,
Required: False ,
}
string ,
lastSuccessfulFailoverTime:
{
Description: The Last successful failover time. ,
Format: date-time ,
Required: False ,
}
string ,
lastSuccessfulTestFailoverTime:
{
Description: The Last successful test failover time. ,
Format: date-time ,
Required: False ,
}
string ,
currentScenario:
{
Description: The current scenario. ,
Required: False ,
}
{
scenarioName:
{
Description: Scenario name. ,
Required: False ,
}
string ,
jobId:
{
Description: ARM Id of the job being executed. ,
Required: False ,
}
string ,
startTime:
{
Description: Start time of the workflow. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
failoverRecoveryPointId:
{
Description: The recovery point ARM Id to which the Vm was failed over. ,
Required: False ,
}
string ,
providerSpecificDetails:
{
Description: The Replication provider custom settings. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the Instance type. ,
Required: True ,
}
string ,
}
,
recoveryContainerId:
{
Description: The recovery container Id. ,
Required: False ,
}
string ,
eventCorrelationId:
{
Description: The correlation Id for events associated with this protected item. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The value of next link. ,
Required: False ,
}
string ,
}
ReplicationProtectionClusters_List (new)
Description :  Gets the list of ASR replication protected clusters in the vault.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationProtectionClusters
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
skipToken:
{
Description: The pagination token. Possible values: "FabricId" or "FabricId_CloudId" or null. ,
Required: False ,
}
string ,
$filter:
{
Description: OData filter options. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Replication protection cluster details. ,
Required: False ,
}
[
{
id:
{
Description: The protection cluster Id. ,
Required: False ,
}
string ,
name:
{
Description: The name of the protection cluster. ,
Required: False ,
}
string ,
type:
{
Description: The Type of the object. ,
Required: False ,
}
string ,
properties:
{
Description: The custom data. ,
Required: False ,
}
{
protectionClusterType:
{
Description: The type of protection cluster type. ,
Required: False ,
}
string ,
primaryFabricFriendlyName:
{
Description: The friendly name of the primary fabric. ,
Required: False ,
}
string ,
primaryFabricProvider:
{
Description: The fabric provider of the primary fabric. ,
Required: False ,
}
string ,
recoveryFabricFriendlyName:
{
Description: The friendly name of recovery fabric. ,
Required: False ,
}
string ,
recoveryFabricId:
{
Description: The Arm Id of recovery fabric. ,
Format: arm-id ,
Required: False ,
}
string ,
primaryProtectionContainerFriendlyName:
{
Description: The name of primary protection container friendly name. ,
Required: False ,
}
string ,
recoveryProtectionContainerFriendlyName:
{
Description: The name of recovery container friendly name. ,
Required: False ,
}
string ,
protectionState:
{
Description: The protection status. ,
Required: False ,
}
string ,
protectionStateDescription:
{
Description: The protection state description. ,
Required: False ,
}
string ,
activeLocation:
{
Description: The Current active location of the Protection cluster. ,
Required: False ,
}
string ,
testFailoverState:
{
Description: The Test failover state. ,
Required: False ,
}
string ,
testFailoverStateDescription:
{
Description: The Test failover state description. ,
Required: False ,
}
string ,
allowedOperations:
{
Description: The allowed operations on the Replication protection cluster. ,
Required: False ,
}
[
string ,
]
,
replicationHealth:
{
Description: 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. ,
Required: False ,
}
string ,
healthErrors:
{
Description: List of health errors. ,
Required: False ,
}
[
{
innerHealthErrors:
{
Description: 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. ,
Required: False ,
}
[
{
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
lastSuccessfulFailoverTime:
{
Description: The last successful failover time. ,
Format: date-time ,
Required: False ,
}
string ,
lastSuccessfulTestFailoverTime:
{
Description: The last successful test failover time. ,
Format: date-time ,
Required: False ,
}
string ,
policyFriendlyName:
{
Description: The name of Policy governing this PE. ,
Required: False ,
}
string ,
currentScenario:
{
Description: The current scenario. ,
Required: False ,
}
{
scenarioName:
{
Description: Scenario name. ,
Required: False ,
}
string ,
jobId:
{
Description: ARM Id of the job being executed. ,
Required: False ,
}
string ,
startTime:
{
Description: Start time of the workflow. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
recoveryContainerId:
{
Description: The recovery container Id. ,
Format: arm-id ,
Required: False ,
}
string ,
agentClusterId:
{
Description: The Agent cluster Id. ,
Required: False ,
}
string ,
clusterFqdn:
{
Description: The cluster FQDN. ,
Required: False ,
}
string ,
clusterNodeFqdns:
{
Description: The List of cluster Node FQDNs. ,
Required: False ,
}
[
string ,
]
,
clusterProtectedItemIds:
{
Description: The List of Protected Item Id's. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the cluster. ,
Required: False ,
}
string ,
areAllClusterNodesRegistered:
{
Description: A value indicating whether all nodes of the cluster are registered or not. ,
Required: False ,
}
boolean ,
clusterRegisteredNodes:
{
Description: The registered node details. ,
Required: False ,
}
[
{
clusterNodeFqdn:
{
Description: The cluster node name. ,
Required: False ,
}
string ,
machineId:
{
Description: The machine ID. ,
Required: False ,
}
string ,
biosId:
{
Description: The BIOS ID. ,
Required: False ,
}
string ,
isSharedDiskVirtualNode:
{
Description: A value indicating whether this represents virtual entity hosting all the shared disks. ,
Required: False ,
}
boolean ,
}
,
]
,
providerSpecificDetails:
{
Description: The Replication cluster provider custom settings. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the Instance type. ,
Required: True ,
}
string ,
}
,
sharedDiskProperties:
{
Description: The shared disk properties. ,
Required: False ,
}
{
protectionState:
{
Description: The protection state of shared disk. ,
Required: False ,
}
string ,
testFailoverState:
{
Description: The tfo state of shared disk. ,
Required: False ,
}
string ,
activeLocation:
{
Description: The Current active location of the PE. ,
Required: False ,
}
string ,
allowedOperations:
{
Description: The allowed operations on the Replication protected item. ,
Required: False ,
}
[
string ,
]
,
replicationHealth:
{
Description: 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. ,
Required: False ,
}
string ,
healthErrors:
{
Description: List of health errors. ,
Required: False ,
}
[
{
innerHealthErrors:
{
Description: 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. ,
Required: False ,
}
[
{
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
currentScenario:
{
Description: The current scenario. ,
Required: False ,
}
{
scenarioName:
{
Description: Scenario name. ,
Required: False ,
}
string ,
jobId:
{
Description: ARM Id of the job being executed. ,
Required: False ,
}
string ,
startTime:
{
Description: Start time of the workflow. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
sharedDiskProviderSpecificDetails:
{
Description: The Replication provider custom settings. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the Instance type. ,
Required: True ,
}
string ,
}
,
}
,
policyId:
{
Description: The Policy Id. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The value of next link. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ReplicationProtectionContainerMappings_List (new)
Description :  Lists the protection container mappings in the vault.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationProtectionContainerMappings
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of container mappings. ,
Required: False ,
}
[
{
properties:
{
Description: The custom data. ,
Required: False ,
}
{
targetProtectionContainerId:
{
Description: Paired protection container ARM ID. ,
Required: False ,
}
string ,
targetProtectionContainerFriendlyName:
{
Description: Friendly name of paired container. ,
Required: False ,
}
string ,
providerSpecificDetails:
{
Description: Provider specific provider details. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the class type. Overridden in derived classes. ,
Required: True ,
}
string ,
}
,
health:
{
Description: Health of pairing. ,
Required: False ,
}
string ,
healthErrorDetails:
{
Description: Health error. ,
Required: False ,
}
[
{
innerHealthErrors:
{
Description: 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. ,
Required: False ,
}
[
{
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
policyId:
{
Description: Policy ARM Id. ,
Required: False ,
}
string ,
state:
{
Description: Association Status. ,
Required: False ,
}
string ,
sourceProtectionContainerFriendlyName:
{
Description: Friendly name of source protection container. ,
Required: False ,
}
string ,
sourceFabricFriendlyName:
{
Description: Friendly name of source fabric. ,
Required: False ,
}
string ,
targetFabricFriendlyName:
{
Description: Friendly name of target fabric. ,
Required: False ,
}
string ,
policyFriendlyName:
{
Description: Friendly name of replication policy. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to fetch rest of the data. ,
Required: False ,
}
string ,
}
ReplicationProtectionContainers_List (new)
Description :  Lists the protection containers in a vault.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationProtectionContainers
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Protection Container details. ,
Required: False ,
}
[
{
properties:
{
Description: The custom data. ,
Required: False ,
}
{
fabricFriendlyName:
{
Description: Fabric friendly name. ,
Required: False ,
}
string ,
friendlyName:
{
Description: The name. ,
Required: False ,
}
string ,
fabricType:
{
Description: The fabric type. ,
Required: False ,
}
string ,
protectedItemCount:
{
Description: Number of protected PEs. ,
Format: int32 ,
Required: False ,
}
integer ,
pairingStatus:
{
Description: The pairing status of this cloud. ,
Required: False ,
}
string ,
role:
{
Description: The role of this cloud. ,
Required: False ,
}
string ,
fabricSpecificDetails:
{
Description: Fabric specific details. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the class type. Overridden in derived classes. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The value of next link. ,
Required: False ,
}
string ,
}
ReplicationProtectionIntents_List (new)
Description :  Gets the list of ASR replication protection intent objects in the vault.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationProtectionIntents
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
skipToken:
{
Description: The pagination token. ,
Required: False ,
}
string ,
takeToken:
{
Description: The page size. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Replication protection intent details. ,
Required: False ,
}
[
{
properties:
{
Description: The custom data. ,
Required: False ,
}
{
friendlyName:
{
Description: The name. ,
Required: False ,
}
string ,
jobId:
{
Description: The job Id. ,
Required: False ,
}
string ,
jobState:
{
Description: The job state. ,
Required: False ,
}
string ,
isActive:
{
Description: A value indicating whether the intent object is active. ,
Required: False ,
}
boolean ,
creationTimeUTC:
{
Description: The creation time in UTC. ,
Required: False ,
}
string ,
providerSpecificDetails:
{
Description: The Replication provider custom settings. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the Instance type. ,
Required: True ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The value of next link. ,
Required: False ,
}
string ,
}
ReplicationProtectionIntents_Get (new)
Description :  Gets the details of an ASR replication protection intent.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationProtectionIntents/{intentObjectName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
intentObjectName:
{
Description: Replication protection intent name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The custom data. ,
Required: False ,
}
{
friendlyName:
{
Description: The name. ,
Required: False ,
}
string ,
jobId:
{
Description: The job Id. ,
Required: False ,
}
string ,
jobState:
{
Description: The job state. ,
Required: False ,
}
string ,
isActive:
{
Description: A value indicating whether the intent object is active. ,
Required: False ,
}
boolean ,
creationTimeUTC:
{
Description: The creation time in UTC. ,
Required: False ,
}
string ,
providerSpecificDetails:
{
Description: The Replication provider custom settings. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the Instance type. ,
Required: True ,
}
string ,
}
,
}
,
}
ReplicationProtectionIntents_Create (new)
Description :  The operation to create an ASR replication protection intent item.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationProtectionIntents/{intentObjectName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
intentObjectName:
{
Description: A name for the replication protection item. ,
Required: True ,
}
string ,
input:
{
Description: Create Protection Intent Input. ,
Required: True ,
}
{
properties:
{
Description: Create protection intent input properties. ,
Required: False ,
}
{
providerSpecificDetails:
{
Description: The ReplicationProviderInput. For A2A provider, it will be A2ACreateProtectionIntentInput object. ,
Required: False ,
}
{
instanceType:
{
Description: The class type. ,
Required: True ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The custom data. ,
Required: False ,
}
{
friendlyName:
{
Description: The name. ,
Required: False ,
}
string ,
jobId:
{
Description: The job Id. ,
Required: False ,
}
string ,
jobState:
{
Description: The job state. ,
Required: False ,
}
string ,
isActive:
{
Description: A value indicating whether the intent object is active. ,
Required: False ,
}
boolean ,
creationTimeUTC:
{
Description: The creation time in UTC. ,
Required: False ,
}
string ,
providerSpecificDetails:
{
Description: The Replication provider custom settings. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the Instance type. ,
Required: True ,
}
string ,
}
,
}
,
}
ReplicationRecoveryPlans_List (new)
Description :  Lists the recovery plans in the vault.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationRecoveryPlans
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of recovery plans. ,
Required: False ,
}
[
{
properties:
{
Description: The custom details. ,
Required: False ,
}
{
friendlyName:
{
Description: The friendly name. ,
Required: False ,
}
string ,
primaryFabricId:
{
Description: The primary fabric Id. ,
Required: False ,
}
string ,
primaryFabricFriendlyName:
{
Description: The primary fabric friendly name. ,
Required: False ,
}
string ,
recoveryFabricId:
{
Description: The recovery fabric Id. ,
Required: False ,
}
string ,
recoveryFabricFriendlyName:
{
Description: The recovery fabric friendly name. ,
Required: False ,
}
string ,
failoverDeploymentModel:
{
Description: The failover deployment model. ,
Required: False ,
}
string ,
replicationProviders:
{
Description: The list of replication providers. ,
Required: False ,
}
[
string ,
]
,
allowedOperations:
{
Description: The list of allowed operations. ,
Required: False ,
}
[
string ,
]
,
lastPlannedFailoverTime:
{
Description: The start time of the last planned failover. ,
Format: date-time ,
Required: False ,
}
string ,
lastUnplannedFailoverTime:
{
Description: The start time of the last unplanned failover. ,
Format: date-time ,
Required: False ,
}
string ,
lastTestFailoverTime:
{
Description: The start time of the last test failover. ,
Format: date-time ,
Required: False ,
}
string ,
currentScenario:
{
Description: The current scenario details. ,
Required: False ,
}
{
scenarioName:
{
Description: Scenario name. ,
Required: False ,
}
string ,
jobId:
{
Description: ARM Id of the job being executed. ,
Required: False ,
}
string ,
startTime:
{
Description: Start time of the workflow. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
currentScenarioStatus:
{
Description: The recovery plan status. ,
Required: False ,
}
string ,
currentScenarioStatusDescription:
{
Description: The recovery plan status description. ,
Required: False ,
}
string ,
groups:
{
Description: The recovery plan groups. ,
Required: False ,
}
[
{
groupType:
{
Description: The group type. ,
Enum:
{
Shutdown: No description available. ,
Boot: No description available. ,
Failover: No description available. ,
}
,
Required: True ,
}
enum ,
replicationProtectedItems:
{
Description: The list of protected items. ,
Required: False ,
}
[
{
id:
{
Description: The ARM Id of the recovery plan protected item. ,
Required: False ,
}
string ,
virtualMachineId:
{
Description: The virtual machine Id. ,
Required: False ,
}
string ,
}
,
]
,
startGroupActions:
{
Description: The start group actions. ,
Required: False ,
}
[
{
actionName:
{
Description: The action name. ,
Required: True ,
}
string ,
failoverTypes:
{
Description: The list of failover types. ,
Required: True ,
}
[
string ,
]
,
failoverDirections:
{
Description: The list of failover directions. ,
Required: True ,
}
[
string ,
]
,
customDetails:
{
Description: The custom details. ,
Required: True ,
}
{
instanceType:
{
Description: Gets the type of action details (see RecoveryPlanActionDetailsTypes enum for possible values). ,
Required: True ,
}
string ,
}
,
}
,
]
,
endGroupActions:
{
Description: The end group actions. ,
Required: False ,
}
[
{
actionName:
{
Description: The action name. ,
Required: True ,
}
string ,
failoverTypes:
{
Description: The list of failover types. ,
Required: True ,
}
[
string ,
]
,
failoverDirections:
{
Description: The list of failover directions. ,
Required: True ,
}
[
string ,
]
,
customDetails:
{
Description: The custom details. ,
Required: True ,
}
{
instanceType:
{
Description: Gets the type of action details (see RecoveryPlanActionDetailsTypes enum for possible values). ,
Required: True ,
}
string ,
}
,
}
,
]
,
}
,
]
,
providerSpecificDetails:
{
Description: The provider id and provider specific details. ,
Required: False ,
}
[
{
instanceType:
{
Description: Gets the Instance type. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The value of next link. ,
Required: False ,
}
string ,
}
ReplicationRecoveryPlans_Get (new)
Description :  Gets the details of the recovery plan.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationRecoveryPlans/{recoveryPlanName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
recoveryPlanName:
{
Description: Name of the recovery plan. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The custom details. ,
Required: False ,
}
{
friendlyName:
{
Description: The friendly name. ,
Required: False ,
}
string ,
primaryFabricId:
{
Description: The primary fabric Id. ,
Required: False ,
}
string ,
primaryFabricFriendlyName:
{
Description: The primary fabric friendly name. ,
Required: False ,
}
string ,
recoveryFabricId:
{
Description: The recovery fabric Id. ,
Required: False ,
}
string ,
recoveryFabricFriendlyName:
{
Description: The recovery fabric friendly name. ,
Required: False ,
}
string ,
failoverDeploymentModel:
{
Description: The failover deployment model. ,
Required: False ,
}
string ,
replicationProviders:
{
Description: The list of replication providers. ,
Required: False ,
}
[
string ,
]
,
allowedOperations:
{
Description: The list of allowed operations. ,
Required: False ,
}
[
string ,
]
,
lastPlannedFailoverTime:
{
Description: The start time of the last planned failover. ,
Format: date-time ,
Required: False ,
}
string ,
lastUnplannedFailoverTime:
{
Description: The start time of the last unplanned failover. ,
Format: date-time ,
Required: False ,
}
string ,
lastTestFailoverTime:
{
Description: The start time of the last test failover. ,
Format: date-time ,
Required: False ,
}
string ,
currentScenario:
{
Description: The current scenario details. ,
Required: False ,
}
{
scenarioName:
{
Description: Scenario name. ,
Required: False ,
}
string ,
jobId:
{
Description: ARM Id of the job being executed. ,
Required: False ,
}
string ,
startTime:
{
Description: Start time of the workflow. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
currentScenarioStatus:
{
Description: The recovery plan status. ,
Required: False ,
}
string ,
currentScenarioStatusDescription:
{
Description: The recovery plan status description. ,
Required: False ,
}
string ,
groups:
{
Description: The recovery plan groups. ,
Required: False ,
}
[
{
groupType:
{
Description: The group type. ,
Enum:
{
Shutdown: No description available. ,
Boot: No description available. ,
Failover: No description available. ,
}
,
Required: True ,
}
enum ,
replicationProtectedItems:
{
Description: The list of protected items. ,
Required: False ,
}
[
{
id:
{
Description: The ARM Id of the recovery plan protected item. ,
Required: False ,
}
string ,
virtualMachineId:
{
Description: The virtual machine Id. ,
Required: False ,
}
string ,
}
,
]
,
startGroupActions:
{
Description: The start group actions. ,
Required: False ,
}
[
{
actionName:
{
Description: The action name. ,
Required: True ,
}
string ,
failoverTypes:
{
Description: The list of failover types. ,
Required: True ,
}
[
string ,
]
,
failoverDirections:
{
Description: The list of failover directions. ,
Required: True ,
}
[
string ,
]
,
customDetails:
{
Description: The custom details. ,
Required: True ,
}
{
instanceType:
{
Description: Gets the type of action details (see RecoveryPlanActionDetailsTypes enum for possible values). ,
Required: True ,
}
string ,
}
,
}
,
]
,
endGroupActions:
{
Description: The end group actions. ,
Required: False ,
}
[
{
actionName:
{
Description: The action name. ,
Required: True ,
}
string ,
failoverTypes:
{
Description: The list of failover types. ,
Required: True ,
}
[
string ,
]
,
failoverDirections:
{
Description: The list of failover directions. ,
Required: True ,
}
[
string ,
]
,
customDetails:
{
Description: The custom details. ,
Required: True ,
}
{
instanceType:
{
Description: Gets the type of action details (see RecoveryPlanActionDetailsTypes enum for possible values). ,
Required: True ,
}
string ,
}
,
}
,
]
,
}
,
]
,
providerSpecificDetails:
{
Description: The provider id and provider specific details. ,
Required: False ,
}
[
{
instanceType:
{
Description: Gets the Instance type. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
ReplicationRecoveryPlans_Create (new)
Description :  The operation to create a recovery plan.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationRecoveryPlans/{recoveryPlanName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
recoveryPlanName:
{
Description: Recovery plan name. ,
Required: True ,
}
string ,
input:
{
Description: Recovery Plan creation input. ,
Required: True ,
}
{
properties:
{
Description: Recovery plan creation properties. ,
Required: True ,
}
{
primaryFabricId:
{
Description: The primary fabric Id. ,
Required: True ,
}
string ,
recoveryFabricId:
{
Description: The recovery fabric Id. ,
Required: True ,
}
string ,
failoverDeploymentModel:
{
Description: The failover deployment model. ,
Enum:
{
NotApplicable: No description available. ,
Classic: No description available. ,
ResourceManager: No description available. ,
}
,
Required: False ,
}
enum ,
groups:
{
Description: The recovery plan groups. ,
Required: True ,
}
[
{
groupType:
{
Description: The group type. ,
Enum:
{
Shutdown: No description available. ,
Boot: No description available. ,
Failover: No description available. ,
}
,
Required: True ,
}
enum ,
replicationProtectedItems:
{
Description: The list of protected items. ,
Required: False ,
}
[
{
id:
{
Description: The ARM Id of the recovery plan protected item. ,
Required: False ,
}
string ,
virtualMachineId:
{
Description: The virtual machine Id. ,
Required: False ,
}
string ,
}
,
]
,
startGroupActions:
{
Description: The start group actions. ,
Required: False ,
}
[
{
actionName:
{
Description: The action name. ,
Required: True ,
}
string ,
failoverTypes:
{
Description: The list of failover types. ,
Required: True ,
}
[
string ,
]
,
failoverDirections:
{
Description: The list of failover directions. ,
Required: True ,
}
[
string ,
]
,
customDetails:
{
Description: The custom details. ,
Required: True ,
}
{
instanceType:
{
Description: Gets the type of action details (see RecoveryPlanActionDetailsTypes enum for possible values). ,
Required: True ,
}
string ,
}
,
}
,
]
,
endGroupActions:
{
Description: The end group actions. ,
Required: False ,
}
[
{
actionName:
{
Description: The action name. ,
Required: True ,
}
string ,
failoverTypes:
{
Description: The list of failover types. ,
Required: True ,
}
[
string ,
]
,
failoverDirections:
{
Description: The list of failover directions. ,
Required: True ,
}
[
string ,
]
,
customDetails:
{
Description: The custom details. ,
Required: True ,
}
{
instanceType:
{
Description: Gets the type of action details (see RecoveryPlanActionDetailsTypes enum for possible values). ,
Required: True ,
}
string ,
}
,
}
,
]
,
}
,
]
,
providerSpecificInput:
{
Description: The provider specific input. ,
Required: False ,
}
[
{
instanceType:
{
Description: Gets the Instance type. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The custom details. ,
Required: False ,
}
{
friendlyName:
{
Description: The friendly name. ,
Required: False ,
}
string ,
primaryFabricId:
{
Description: The primary fabric Id. ,
Required: False ,
}
string ,
primaryFabricFriendlyName:
{
Description: The primary fabric friendly name. ,
Required: False ,
}
string ,
recoveryFabricId:
{
Description: The recovery fabric Id. ,
Required: False ,
}
string ,
recoveryFabricFriendlyName:
{
Description: The recovery fabric friendly name. ,
Required: False ,
}
string ,
failoverDeploymentModel:
{
Description: The failover deployment model. ,
Required: False ,
}
string ,
replicationProviders:
{
Description: The list of replication providers. ,
Required: False ,
}
[
string ,
]
,
allowedOperations:
{
Description: The list of allowed operations. ,
Required: False ,
}
[
string ,
]
,
lastPlannedFailoverTime:
{
Description: The start time of the last planned failover. ,
Format: date-time ,
Required: False ,
}
string ,
lastUnplannedFailoverTime:
{
Description: The start time of the last unplanned failover. ,
Format: date-time ,
Required: False ,
}
string ,
lastTestFailoverTime:
{
Description: The start time of the last test failover. ,
Format: date-time ,
Required: False ,
}
string ,
currentScenario:
{
Description: The current scenario details. ,
Required: False ,
}
{
scenarioName:
{
Description: Scenario name. ,
Required: False ,
}
string ,
jobId:
{
Description: ARM Id of the job being executed. ,
Required: False ,
}
string ,
startTime:
{
Description: Start time of the workflow. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
currentScenarioStatus:
{
Description: The recovery plan status. ,
Required: False ,
}
string ,
currentScenarioStatusDescription:
{
Description: The recovery plan status description. ,
Required: False ,
}
string ,
groups:
{
Description: The recovery plan groups. ,
Required: False ,
}
[
{
groupType:
{
Description: The group type. ,
Enum:
{
Shutdown: No description available. ,
Boot: No description available. ,
Failover: No description available. ,
}
,
Required: True ,
}
enum ,
replicationProtectedItems:
{
Description: The list of protected items. ,
Required: False ,
}
[
{
id:
{
Description: The ARM Id of the recovery plan protected item. ,
Required: False ,
}
string ,
virtualMachineId:
{
Description: The virtual machine Id. ,
Required: False ,
}
string ,
}
,
]
,
startGroupActions:
{
Description: The start group actions. ,
Required: False ,
}
[
{
actionName:
{
Description: The action name. ,
Required: True ,
}
string ,
failoverTypes:
{
Description: The list of failover types. ,
Required: True ,
}
[
string ,
]
,
failoverDirections:
{
Description: The list of failover directions. ,
Required: True ,
}
[
string ,
]
,
customDetails:
{
Description: The custom details. ,
Required: True ,
}
{
instanceType:
{
Description: Gets the type of action details (see RecoveryPlanActionDetailsTypes enum for possible values). ,
Required: True ,
}
string ,
}
,
}
,
]
,
endGroupActions:
{
Description: The end group actions. ,
Required: False ,
}
[
{
actionName:
{
Description: The action name. ,
Required: True ,
}
string ,
failoverTypes:
{
Description: The list of failover types. ,
Required: True ,
}
[
string ,
]
,
failoverDirections:
{
Description: The list of failover directions. ,
Required: True ,
}
[
string ,
]
,
customDetails:
{
Description: The custom details. ,
Required: True ,
}
{
instanceType:
{
Description: Gets the type of action details (see RecoveryPlanActionDetailsTypes enum for possible values). ,
Required: True ,
}
string ,
}
,
}
,
]
,
}
,
]
,
providerSpecificDetails:
{
Description: The provider id and provider specific details. ,
Required: False ,
}
[
{
instanceType:
{
Description: Gets the Instance type. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (202)

{}
ReplicationRecoveryPlans_Delete (new)
Description :  Delete a recovery plan.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationRecoveryPlans/{recoveryPlanName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
recoveryPlanName:
{
Description: Recovery plan name. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
ReplicationRecoveryPlans_Update (new)
Description :  The operation to update a recovery plan.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationRecoveryPlans/{recoveryPlanName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
recoveryPlanName:
{
Description: Recovery plan name. ,
Required: True ,
}
string ,
input:
{
Description: Update recovery plan input. ,
Required: True ,
}
{
properties:
{
Description: Recovery plan update properties. ,
Required: False ,
}
{
groups:
{
Description: The recovery plan groups. ,
Required: False ,
}
[
{
groupType:
{
Description: The group type. ,
Enum:
{
Shutdown: No description available. ,
Boot: No description available. ,
Failover: No description available. ,
}
,
Required: True ,
}
enum ,
replicationProtectedItems:
{
Description: The list of protected items. ,
Required: False ,
}
[
{
id:
{
Description: The ARM Id of the recovery plan protected item. ,
Required: False ,
}
string ,
virtualMachineId:
{
Description: The virtual machine Id. ,
Required: False ,
}
string ,
}
,
]
,
startGroupActions:
{
Description: The start group actions. ,
Required: False ,
}
[
{
actionName:
{
Description: The action name. ,
Required: True ,
}
string ,
failoverTypes:
{
Description: The list of failover types. ,
Required: True ,
}
[
string ,
]
,
failoverDirections:
{
Description: The list of failover directions. ,
Required: True ,
}
[
string ,
]
,
customDetails:
{
Description: The custom details. ,
Required: True ,
}
{
instanceType:
{
Description: Gets the type of action details (see RecoveryPlanActionDetailsTypes enum for possible values). ,
Required: True ,
}
string ,
}
,
}
,
]
,
endGroupActions:
{
Description: The end group actions. ,
Required: False ,
}
[
{
actionName:
{
Description: The action name. ,
Required: True ,
}
string ,
failoverTypes:
{
Description: The list of failover types. ,
Required: True ,
}
[
string ,
]
,
failoverDirections:
{
Description: The list of failover directions. ,
Required: True ,
}
[
string ,
]
,
customDetails:
{
Description: The custom details. ,
Required: True ,
}
{
instanceType:
{
Description: Gets the type of action details (see RecoveryPlanActionDetailsTypes enum for possible values). ,
Required: True ,
}
string ,
}
,
}
,
]
,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The custom details. ,
Required: False ,
}
{
friendlyName:
{
Description: The friendly name. ,
Required: False ,
}
string ,
primaryFabricId:
{
Description: The primary fabric Id. ,
Required: False ,
}
string ,
primaryFabricFriendlyName:
{
Description: The primary fabric friendly name. ,
Required: False ,
}
string ,
recoveryFabricId:
{
Description: The recovery fabric Id. ,
Required: False ,
}
string ,
recoveryFabricFriendlyName:
{
Description: The recovery fabric friendly name. ,
Required: False ,
}
string ,
failoverDeploymentModel:
{
Description: The failover deployment model. ,
Required: False ,
}
string ,
replicationProviders:
{
Description: The list of replication providers. ,
Required: False ,
}
[
string ,
]
,
allowedOperations:
{
Description: The list of allowed operations. ,
Required: False ,
}
[
string ,
]
,
lastPlannedFailoverTime:
{
Description: The start time of the last planned failover. ,
Format: date-time ,
Required: False ,
}
string ,
lastUnplannedFailoverTime:
{
Description: The start time of the last unplanned failover. ,
Format: date-time ,
Required: False ,
}
string ,
lastTestFailoverTime:
{
Description: The start time of the last test failover. ,
Format: date-time ,
Required: False ,
}
string ,
currentScenario:
{
Description: The current scenario details. ,
Required: False ,
}
{
scenarioName:
{
Description: Scenario name. ,
Required: False ,
}
string ,
jobId:
{
Description: ARM Id of the job being executed. ,
Required: False ,
}
string ,
startTime:
{
Description: Start time of the workflow. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
currentScenarioStatus:
{
Description: The recovery plan status. ,
Required: False ,
}
string ,
currentScenarioStatusDescription:
{
Description: The recovery plan status description. ,
Required: False ,
}
string ,
groups:
{
Description: The recovery plan groups. ,
Required: False ,
}
[
{
groupType:
{
Description: The group type. ,
Enum:
{
Shutdown: No description available. ,
Boot: No description available. ,
Failover: No description available. ,
}
,
Required: True ,
}
enum ,
replicationProtectedItems:
{
Description: The list of protected items. ,
Required: False ,
}
[
{
id:
{
Description: The ARM Id of the recovery plan protected item. ,
Required: False ,
}
string ,
virtualMachineId:
{
Description: The virtual machine Id. ,
Required: False ,
}
string ,
}
,
]
,
startGroupActions:
{
Description: The start group actions. ,
Required: False ,
}
[
{
actionName:
{
Description: The action name. ,
Required: True ,
}
string ,
failoverTypes:
{
Description: The list of failover types. ,
Required: True ,
}
[
string ,
]
,
failoverDirections:
{
Description: The list of failover directions. ,
Required: True ,
}
[
string ,
]
,
customDetails:
{
Description: The custom details. ,
Required: True ,
}
{
instanceType:
{
Description: Gets the type of action details (see RecoveryPlanActionDetailsTypes enum for possible values). ,
Required: True ,
}
string ,
}
,
}
,
]
,
endGroupActions:
{
Description: The end group actions. ,
Required: False ,
}
[
{
actionName:
{
Description: The action name. ,
Required: True ,
}
string ,
failoverTypes:
{
Description: The list of failover types. ,
Required: True ,
}
[
string ,
]
,
failoverDirections:
{
Description: The list of failover directions. ,
Required: True ,
}
[
string ,
]
,
customDetails:
{
Description: The custom details. ,
Required: True ,
}
{
instanceType:
{
Description: Gets the type of action details (see RecoveryPlanActionDetailsTypes enum for possible values). ,
Required: True ,
}
string ,
}
,
}
,
]
,
}
,
]
,
providerSpecificDetails:
{
Description: The provider id and provider specific details. ,
Required: False ,
}
[
{
instanceType:
{
Description: Gets the Instance type. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (202)

{}
ReplicationRecoveryPlans_FailoverCancel (new)
Description :  The operation to cancel the failover of a recovery plan.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationRecoveryPlans/{recoveryPlanName}/failoverCancel
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
recoveryPlanName:
{
Description: Recovery plan name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The custom details. ,
Required: False ,
}
{
friendlyName:
{
Description: The friendly name. ,
Required: False ,
}
string ,
primaryFabricId:
{
Description: The primary fabric Id. ,
Required: False ,
}
string ,
primaryFabricFriendlyName:
{
Description: The primary fabric friendly name. ,
Required: False ,
}
string ,
recoveryFabricId:
{
Description: The recovery fabric Id. ,
Required: False ,
}
string ,
recoveryFabricFriendlyName:
{
Description: The recovery fabric friendly name. ,
Required: False ,
}
string ,
failoverDeploymentModel:
{
Description: The failover deployment model. ,
Required: False ,
}
string ,
replicationProviders:
{
Description: The list of replication providers. ,
Required: False ,
}
[
string ,
]
,
allowedOperations:
{
Description: The list of allowed operations. ,
Required: False ,
}
[
string ,
]
,
lastPlannedFailoverTime:
{
Description: The start time of the last planned failover. ,
Format: date-time ,
Required: False ,
}
string ,
lastUnplannedFailoverTime:
{
Description: The start time of the last unplanned failover. ,
Format: date-time ,
Required: False ,
}
string ,
lastTestFailoverTime:
{
Description: The start time of the last test failover. ,
Format: date-time ,
Required: False ,
}
string ,
currentScenario:
{
Description: The current scenario details. ,
Required: False ,
}
{
scenarioName:
{
Description: Scenario name. ,
Required: False ,
}
string ,
jobId:
{
Description: ARM Id of the job being executed. ,
Required: False ,
}
string ,
startTime:
{
Description: Start time of the workflow. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
currentScenarioStatus:
{
Description: The recovery plan status. ,
Required: False ,
}
string ,
currentScenarioStatusDescription:
{
Description: The recovery plan status description. ,
Required: False ,
}
string ,
groups:
{
Description: The recovery plan groups. ,
Required: False ,
}
[
{
groupType:
{
Description: The group type. ,
Enum:
{
Shutdown: No description available. ,
Boot: No description available. ,
Failover: No description available. ,
}
,
Required: True ,
}
enum ,
replicationProtectedItems:
{
Description: The list of protected items. ,
Required: False ,
}
[
{
id:
{
Description: The ARM Id of the recovery plan protected item. ,
Required: False ,
}
string ,
virtualMachineId:
{
Description: The virtual machine Id. ,
Required: False ,
}
string ,
}
,
]
,
startGroupActions:
{
Description: The start group actions. ,
Required: False ,
}
[
{
actionName:
{
Description: The action name. ,
Required: True ,
}
string ,
failoverTypes:
{
Description: The list of failover types. ,
Required: True ,
}
[
string ,
]
,
failoverDirections:
{
Description: The list of failover directions. ,
Required: True ,
}
[
string ,
]
,
customDetails:
{
Description: The custom details. ,
Required: True ,
}
{
instanceType:
{
Description: Gets the type of action details (see RecoveryPlanActionDetailsTypes enum for possible values). ,
Required: True ,
}
string ,
}
,
}
,
]
,
endGroupActions:
{
Description: The end group actions. ,
Required: False ,
}
[
{
actionName:
{
Description: The action name. ,
Required: True ,
}
string ,
failoverTypes:
{
Description: The list of failover types. ,
Required: True ,
}
[
string ,
]
,
failoverDirections:
{
Description: The list of failover directions. ,
Required: True ,
}
[
string ,
]
,
customDetails:
{
Description: The custom details. ,
Required: True ,
}
{
instanceType:
{
Description: Gets the type of action details (see RecoveryPlanActionDetailsTypes enum for possible values). ,
Required: True ,
}
string ,
}
,
}
,
]
,
}
,
]
,
providerSpecificDetails:
{
Description: The provider id and provider specific details. ,
Required: False ,
}
[
{
instanceType:
{
Description: Gets the Instance type. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (202)

{}
ReplicationRecoveryPlans_FailoverCommit (new)
Description :  The operation to commit the failover of a recovery plan.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationRecoveryPlans/{recoveryPlanName}/failoverCommit
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
recoveryPlanName:
{
Description: Recovery plan name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The custom details. ,
Required: False ,
}
{
friendlyName:
{
Description: The friendly name. ,
Required: False ,
}
string ,
primaryFabricId:
{
Description: The primary fabric Id. ,
Required: False ,
}
string ,
primaryFabricFriendlyName:
{
Description: The primary fabric friendly name. ,
Required: False ,
}
string ,
recoveryFabricId:
{
Description: The recovery fabric Id. ,
Required: False ,
}
string ,
recoveryFabricFriendlyName:
{
Description: The recovery fabric friendly name. ,
Required: False ,
}
string ,
failoverDeploymentModel:
{
Description: The failover deployment model. ,
Required: False ,
}
string ,
replicationProviders:
{
Description: The list of replication providers. ,
Required: False ,
}
[
string ,
]
,
allowedOperations:
{
Description: The list of allowed operations. ,
Required: False ,
}
[
string ,
]
,
lastPlannedFailoverTime:
{
Description: The start time of the last planned failover. ,
Format: date-time ,
Required: False ,
}
string ,
lastUnplannedFailoverTime:
{
Description: The start time of the last unplanned failover. ,
Format: date-time ,
Required: False ,
}
string ,
lastTestFailoverTime:
{
Description: The start time of the last test failover. ,
Format: date-time ,
Required: False ,
}
string ,
currentScenario:
{
Description: The current scenario details. ,
Required: False ,
}
{
scenarioName:
{
Description: Scenario name. ,
Required: False ,
}
string ,
jobId:
{
Description: ARM Id of the job being executed. ,
Required: False ,
}
string ,
startTime:
{
Description: Start time of the workflow. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
currentScenarioStatus:
{
Description: The recovery plan status. ,
Required: False ,
}
string ,
currentScenarioStatusDescription:
{
Description: The recovery plan status description. ,
Required: False ,
}
string ,
groups:
{
Description: The recovery plan groups. ,
Required: False ,
}
[
{
groupType:
{
Description: The group type. ,
Enum:
{
Shutdown: No description available. ,
Boot: No description available. ,
Failover: No description available. ,
}
,
Required: True ,
}
enum ,
replicationProtectedItems:
{
Description: The list of protected items. ,
Required: False ,
}
[
{
id:
{
Description: The ARM Id of the recovery plan protected item. ,
Required: False ,
}
string ,
virtualMachineId:
{
Description: The virtual machine Id. ,
Required: False ,
}
string ,
}
,
]
,
startGroupActions:
{
Description: The start group actions. ,
Required: False ,
}
[
{
actionName:
{
Description: The action name. ,
Required: True ,
}
string ,
failoverTypes:
{
Description: The list of failover types. ,
Required: True ,
}
[
string ,
]
,
failoverDirections:
{
Description: The list of failover directions. ,
Required: True ,
}
[
string ,
]
,
customDetails:
{
Description: The custom details. ,
Required: True ,
}
{
instanceType:
{
Description: Gets the type of action details (see RecoveryPlanActionDetailsTypes enum for possible values). ,
Required: True ,
}
string ,
}
,
}
,
]
,
endGroupActions:
{
Description: The end group actions. ,
Required: False ,
}
[
{
actionName:
{
Description: The action name. ,
Required: True ,
}
string ,
failoverTypes:
{
Description: The list of failover types. ,
Required: True ,
}
[
string ,
]
,
failoverDirections:
{
Description: The list of failover directions. ,
Required: True ,
}
[
string ,
]
,
customDetails:
{
Description: The custom details. ,
Required: True ,
}
{
instanceType:
{
Description: Gets the type of action details (see RecoveryPlanActionDetailsTypes enum for possible values). ,
Required: True ,
}
string ,
}
,
}
,
]
,
}
,
]
,
providerSpecificDetails:
{
Description: The provider id and provider specific details. ,
Required: False ,
}
[
{
instanceType:
{
Description: Gets the Instance type. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (202)

{}
ReplicationRecoveryPlans_PlannedFailover (new)
Description :  The operation to start the planned failover of a recovery plan.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationRecoveryPlans/{recoveryPlanName}/plannedFailover
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
recoveryPlanName:
{
Description: Recovery plan name. ,
Required: True ,
}
string ,
input:
{
Description: Failover input. ,
Required: True ,
}
{
properties:
{
Description: The recovery plan planned failover input properties. ,
Required: True ,
}
{
failoverDirection:
{
Description: The failover direction. ,
Enum:
{
PrimaryToRecovery: No description available. ,
RecoveryToPrimary: No description available. ,
}
,
Required: True ,
}
enum ,
providerSpecificDetails:
{
Description: The provider specific properties. ,
Required: False ,
}
[
{
instanceType:
{
Description: The class type. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The custom details. ,
Required: False ,
}
{
friendlyName:
{
Description: The friendly name. ,
Required: False ,
}
string ,
primaryFabricId:
{
Description: The primary fabric Id. ,
Required: False ,
}
string ,
primaryFabricFriendlyName:
{
Description: The primary fabric friendly name. ,
Required: False ,
}
string ,
recoveryFabricId:
{
Description: The recovery fabric Id. ,
Required: False ,
}
string ,
recoveryFabricFriendlyName:
{
Description: The recovery fabric friendly name. ,
Required: False ,
}
string ,
failoverDeploymentModel:
{
Description: The failover deployment model. ,
Required: False ,
}
string ,
replicationProviders:
{
Description: The list of replication providers. ,
Required: False ,
}
[
string ,
]
,
allowedOperations:
{
Description: The list of allowed operations. ,
Required: False ,
}
[
string ,
]
,
lastPlannedFailoverTime:
{
Description: The start time of the last planned failover. ,
Format: date-time ,
Required: False ,
}
string ,
lastUnplannedFailoverTime:
{
Description: The start time of the last unplanned failover. ,
Format: date-time ,
Required: False ,
}
string ,
lastTestFailoverTime:
{
Description: The start time of the last test failover. ,
Format: date-time ,
Required: False ,
}
string ,
currentScenario:
{
Description: The current scenario details. ,
Required: False ,
}
{
scenarioName:
{
Description: Scenario name. ,
Required: False ,
}
string ,
jobId:
{
Description: ARM Id of the job being executed. ,
Required: False ,
}
string ,
startTime:
{
Description: Start time of the workflow. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
currentScenarioStatus:
{
Description: The recovery plan status. ,
Required: False ,
}
string ,
currentScenarioStatusDescription:
{
Description: The recovery plan status description. ,
Required: False ,
}
string ,
groups:
{
Description: The recovery plan groups. ,
Required: False ,
}
[
{
groupType:
{
Description: The group type. ,
Enum:
{
Shutdown: No description available. ,
Boot: No description available. ,
Failover: No description available. ,
}
,
Required: True ,
}
enum ,
replicationProtectedItems:
{
Description: The list of protected items. ,
Required: False ,
}
[
{
id:
{
Description: The ARM Id of the recovery plan protected item. ,
Required: False ,
}
string ,
virtualMachineId:
{
Description: The virtual machine Id. ,
Required: False ,
}
string ,
}
,
]
,
startGroupActions:
{
Description: The start group actions. ,
Required: False ,
}
[
{
actionName:
{
Description: The action name. ,
Required: True ,
}
string ,
failoverTypes:
{
Description: The list of failover types. ,
Required: True ,
}
[
string ,
]
,
failoverDirections:
{
Description: The list of failover directions. ,
Required: True ,
}
[
string ,
]
,
customDetails:
{
Description: The custom details. ,
Required: True ,
}
{
instanceType:
{
Description: Gets the type of action details (see RecoveryPlanActionDetailsTypes enum for possible values). ,
Required: True ,
}
string ,
}
,
}
,
]
,
endGroupActions:
{
Description: The end group actions. ,
Required: False ,
}
[
{
actionName:
{
Description: The action name. ,
Required: True ,
}
string ,
failoverTypes:
{
Description: The list of failover types. ,
Required: True ,
}
[
string ,
]
,
failoverDirections:
{
Description: The list of failover directions. ,
Required: True ,
}
[
string ,
]
,
customDetails:
{
Description: The custom details. ,
Required: True ,
}
{
instanceType:
{
Description: Gets the type of action details (see RecoveryPlanActionDetailsTypes enum for possible values). ,
Required: True ,
}
string ,
}
,
}
,
]
,
}
,
]
,
providerSpecificDetails:
{
Description: The provider id and provider specific details. ,
Required: False ,
}
[
{
instanceType:
{
Description: Gets the Instance type. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (202)

{}
ReplicationRecoveryPlans_Reprotect (new)
Description :  The operation to reprotect(reverse replicate) a recovery plan. This api is for deprecated scenarios and no longer works.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationRecoveryPlans/{recoveryPlanName}/reProtect
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
recoveryPlanName:
{
Description: Recovery plan name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The custom details. ,
Required: False ,
}
{
friendlyName:
{
Description: The friendly name. ,
Required: False ,
}
string ,
primaryFabricId:
{
Description: The primary fabric Id. ,
Required: False ,
}
string ,
primaryFabricFriendlyName:
{
Description: The primary fabric friendly name. ,
Required: False ,
}
string ,
recoveryFabricId:
{
Description: The recovery fabric Id. ,
Required: False ,
}
string ,
recoveryFabricFriendlyName:
{
Description: The recovery fabric friendly name. ,
Required: False ,
}
string ,
failoverDeploymentModel:
{
Description: The failover deployment model. ,
Required: False ,
}
string ,
replicationProviders:
{
Description: The list of replication providers. ,
Required: False ,
}
[
string ,
]
,
allowedOperations:
{
Description: The list of allowed operations. ,
Required: False ,
}
[
string ,
]
,
lastPlannedFailoverTime:
{
Description: The start time of the last planned failover. ,
Format: date-time ,
Required: False ,
}
string ,
lastUnplannedFailoverTime:
{
Description: The start time of the last unplanned failover. ,
Format: date-time ,
Required: False ,
}
string ,
lastTestFailoverTime:
{
Description: The start time of the last test failover. ,
Format: date-time ,
Required: False ,
}
string ,
currentScenario:
{
Description: The current scenario details. ,
Required: False ,
}
{
scenarioName:
{
Description: Scenario name. ,
Required: False ,
}
string ,
jobId:
{
Description: ARM Id of the job being executed. ,
Required: False ,
}
string ,
startTime:
{
Description: Start time of the workflow. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
currentScenarioStatus:
{
Description: The recovery plan status. ,
Required: False ,
}
string ,
currentScenarioStatusDescription:
{
Description: The recovery plan status description. ,
Required: False ,
}
string ,
groups:
{
Description: The recovery plan groups. ,
Required: False ,
}
[
{
groupType:
{
Description: The group type. ,
Enum:
{
Shutdown: No description available. ,
Boot: No description available. ,
Failover: No description available. ,
}
,
Required: True ,
}
enum ,
replicationProtectedItems:
{
Description: The list of protected items. ,
Required: False ,
}
[
{
id:
{
Description: The ARM Id of the recovery plan protected item. ,
Required: False ,
}
string ,
virtualMachineId:
{
Description: The virtual machine Id. ,
Required: False ,
}
string ,
}
,
]
,
startGroupActions:
{
Description: The start group actions. ,
Required: False ,
}
[
{
actionName:
{
Description: The action name. ,
Required: True ,
}
string ,
failoverTypes:
{
Description: The list of failover types. ,
Required: True ,
}
[
string ,
]
,
failoverDirections:
{
Description: The list of failover directions. ,
Required: True ,
}
[
string ,
]
,
customDetails:
{
Description: The custom details. ,
Required: True ,
}
{
instanceType:
{
Description: Gets the type of action details (see RecoveryPlanActionDetailsTypes enum for possible values). ,
Required: True ,
}
string ,
}
,
}
,
]
,
endGroupActions:
{
Description: The end group actions. ,
Required: False ,
}
[
{
actionName:
{
Description: The action name. ,
Required: True ,
}
string ,
failoverTypes:
{
Description: The list of failover types. ,
Required: True ,
}
[
string ,
]
,
failoverDirections:
{
Description: The list of failover directions. ,
Required: True ,
}
[
string ,
]
,
customDetails:
{
Description: The custom details. ,
Required: True ,
}
{
instanceType:
{
Description: Gets the type of action details (see RecoveryPlanActionDetailsTypes enum for possible values). ,
Required: True ,
}
string ,
}
,
}
,
]
,
}
,
]
,
providerSpecificDetails:
{
Description: The provider id and provider specific details. ,
Required: False ,
}
[
{
instanceType:
{
Description: Gets the Instance type. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (202)

{}
ReplicationRecoveryPlans_TestFailover (new)
Description :  The operation to start the test failover of a recovery plan.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationRecoveryPlans/{recoveryPlanName}/testFailover
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
recoveryPlanName:
{
Description: Recovery plan name. ,
Required: True ,
}
string ,
input:
{
Description: Recovery plan test failover input. ,
Required: True ,
}
{
properties:
{
Description: The recovery plan test failover input properties. ,
Required: True ,
}
{
failoverDirection:
{
Description: The failover direction. ,
Enum:
{
PrimaryToRecovery: No description available. ,
RecoveryToPrimary: No description available. ,
}
,
Required: True ,
}
enum ,
networkType:
{
Description: The network type to be used for test failover. ,
Required: True ,
}
string ,
networkId:
{
Description: The Id of the network to be used for test failover. ,
Required: False ,
}
string ,
providerSpecificDetails:
{
Description: The provider specific properties. ,
Required: False ,
}
[
{
instanceType:
{
Description: The class type. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The custom details. ,
Required: False ,
}
{
friendlyName:
{
Description: The friendly name. ,
Required: False ,
}
string ,
primaryFabricId:
{
Description: The primary fabric Id. ,
Required: False ,
}
string ,
primaryFabricFriendlyName:
{
Description: The primary fabric friendly name. ,
Required: False ,
}
string ,
recoveryFabricId:
{
Description: The recovery fabric Id. ,
Required: False ,
}
string ,
recoveryFabricFriendlyName:
{
Description: The recovery fabric friendly name. ,
Required: False ,
}
string ,
failoverDeploymentModel:
{
Description: The failover deployment model. ,
Required: False ,
}
string ,
replicationProviders:
{
Description: The list of replication providers. ,
Required: False ,
}
[
string ,
]
,
allowedOperations:
{
Description: The list of allowed operations. ,
Required: False ,
}
[
string ,
]
,
lastPlannedFailoverTime:
{
Description: The start time of the last planned failover. ,
Format: date-time ,
Required: False ,
}
string ,
lastUnplannedFailoverTime:
{
Description: The start time of the last unplanned failover. ,
Format: date-time ,
Required: False ,
}
string ,
lastTestFailoverTime:
{
Description: The start time of the last test failover. ,
Format: date-time ,
Required: False ,
}
string ,
currentScenario:
{
Description: The current scenario details. ,
Required: False ,
}
{
scenarioName:
{
Description: Scenario name. ,
Required: False ,
}
string ,
jobId:
{
Description: ARM Id of the job being executed. ,
Required: False ,
}
string ,
startTime:
{
Description: Start time of the workflow. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
currentScenarioStatus:
{
Description: The recovery plan status. ,
Required: False ,
}
string ,
currentScenarioStatusDescription:
{
Description: The recovery plan status description. ,
Required: False ,
}
string ,
groups:
{
Description: The recovery plan groups. ,
Required: False ,
}
[
{
groupType:
{
Description: The group type. ,
Enum:
{
Shutdown: No description available. ,
Boot: No description available. ,
Failover: No description available. ,
}
,
Required: True ,
}
enum ,
replicationProtectedItems:
{
Description: The list of protected items. ,
Required: False ,
}
[
{
id:
{
Description: The ARM Id of the recovery plan protected item. ,
Required: False ,
}
string ,
virtualMachineId:
{
Description: The virtual machine Id. ,
Required: False ,
}
string ,
}
,
]
,
startGroupActions:
{
Description: The start group actions. ,
Required: False ,
}
[
{
actionName:
{
Description: The action name. ,
Required: True ,
}
string ,
failoverTypes:
{
Description: The list of failover types. ,
Required: True ,
}
[
string ,
]
,
failoverDirections:
{
Description: The list of failover directions. ,
Required: True ,
}
[
string ,
]
,
customDetails:
{
Description: The custom details. ,
Required: True ,
}
{
instanceType:
{
Description: Gets the type of action details (see RecoveryPlanActionDetailsTypes enum for possible values). ,
Required: True ,
}
string ,
}
,
}
,
]
,
endGroupActions:
{
Description: The end group actions. ,
Required: False ,
}
[
{
actionName:
{
Description: The action name. ,
Required: True ,
}
string ,
failoverTypes:
{
Description: The list of failover types. ,
Required: True ,
}
[
string ,
]
,
failoverDirections:
{
Description: The list of failover directions. ,
Required: True ,
}
[
string ,
]
,
customDetails:
{
Description: The custom details. ,
Required: True ,
}
{
instanceType:
{
Description: Gets the type of action details (see RecoveryPlanActionDetailsTypes enum for possible values). ,
Required: True ,
}
string ,
}
,
}
,
]
,
}
,
]
,
providerSpecificDetails:
{
Description: The provider id and provider specific details. ,
Required: False ,
}
[
{
instanceType:
{
Description: Gets the Instance type. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (202)

{}
ReplicationRecoveryPlans_TestFailoverCleanup (new)
Description :  The operation to cleanup test failover of a recovery plan.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationRecoveryPlans/{recoveryPlanName}/testFailoverCleanup
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
recoveryPlanName:
{
Description: Recovery plan name. ,
Required: True ,
}
string ,
input:
{
Description: Recovery plan test failover cleanup input. ,
Required: True ,
}
{
properties:
{
Description: The recovery plan test failover cleanup input properties. ,
Required: True ,
}
{
comments:
{
Description: The test failover cleanup comments. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The custom details. ,
Required: False ,
}
{
friendlyName:
{
Description: The friendly name. ,
Required: False ,
}
string ,
primaryFabricId:
{
Description: The primary fabric Id. ,
Required: False ,
}
string ,
primaryFabricFriendlyName:
{
Description: The primary fabric friendly name. ,
Required: False ,
}
string ,
recoveryFabricId:
{
Description: The recovery fabric Id. ,
Required: False ,
}
string ,
recoveryFabricFriendlyName:
{
Description: The recovery fabric friendly name. ,
Required: False ,
}
string ,
failoverDeploymentModel:
{
Description: The failover deployment model. ,
Required: False ,
}
string ,
replicationProviders:
{
Description: The list of replication providers. ,
Required: False ,
}
[
string ,
]
,
allowedOperations:
{
Description: The list of allowed operations. ,
Required: False ,
}
[
string ,
]
,
lastPlannedFailoverTime:
{
Description: The start time of the last planned failover. ,
Format: date-time ,
Required: False ,
}
string ,
lastUnplannedFailoverTime:
{
Description: The start time of the last unplanned failover. ,
Format: date-time ,
Required: False ,
}
string ,
lastTestFailoverTime:
{
Description: The start time of the last test failover. ,
Format: date-time ,
Required: False ,
}
string ,
currentScenario:
{
Description: The current scenario details. ,
Required: False ,
}
{
scenarioName:
{
Description: Scenario name. ,
Required: False ,
}
string ,
jobId:
{
Description: ARM Id of the job being executed. ,
Required: False ,
}
string ,
startTime:
{
Description: Start time of the workflow. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
currentScenarioStatus:
{
Description: The recovery plan status. ,
Required: False ,
}
string ,
currentScenarioStatusDescription:
{
Description: The recovery plan status description. ,
Required: False ,
}
string ,
groups:
{
Description: The recovery plan groups. ,
Required: False ,
}
[
{
groupType:
{
Description: The group type. ,
Enum:
{
Shutdown: No description available. ,
Boot: No description available. ,
Failover: No description available. ,
}
,
Required: True ,
}
enum ,
replicationProtectedItems:
{
Description: The list of protected items. ,
Required: False ,
}
[
{
id:
{
Description: The ARM Id of the recovery plan protected item. ,
Required: False ,
}
string ,
virtualMachineId:
{
Description: The virtual machine Id. ,
Required: False ,
}
string ,
}
,
]
,
startGroupActions:
{
Description: The start group actions. ,
Required: False ,
}
[
{
actionName:
{
Description: The action name. ,
Required: True ,
}
string ,
failoverTypes:
{
Description: The list of failover types. ,
Required: True ,
}
[
string ,
]
,
failoverDirections:
{
Description: The list of failover directions. ,
Required: True ,
}
[
string ,
]
,
customDetails:
{
Description: The custom details. ,
Required: True ,
}
{
instanceType:
{
Description: Gets the type of action details (see RecoveryPlanActionDetailsTypes enum for possible values). ,
Required: True ,
}
string ,
}
,
}
,
]
,
endGroupActions:
{
Description: The end group actions. ,
Required: False ,
}
[
{
actionName:
{
Description: The action name. ,
Required: True ,
}
string ,
failoverTypes:
{
Description: The list of failover types. ,
Required: True ,
}
[
string ,
]
,
failoverDirections:
{
Description: The list of failover directions. ,
Required: True ,
}
[
string ,
]
,
customDetails:
{
Description: The custom details. ,
Required: True ,
}
{
instanceType:
{
Description: Gets the type of action details (see RecoveryPlanActionDetailsTypes enum for possible values). ,
Required: True ,
}
string ,
}
,
}
,
]
,
}
,
]
,
providerSpecificDetails:
{
Description: The provider id and provider specific details. ,
Required: False ,
}
[
{
instanceType:
{
Description: Gets the Instance type. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (202)

{}
ReplicationRecoveryPlans_UnplannedFailover (new)
Description :  The operation to start the unplanned failover of a recovery plan.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationRecoveryPlans/{recoveryPlanName}/unplannedFailover
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
recoveryPlanName:
{
Description: Recovery plan name. ,
Required: True ,
}
string ,
input:
{
Description: Recovery plan unplanned failover input. ,
Required: True ,
}
{
properties:
{
Description: The recovery plan unplanned failover input properties. ,
Required: True ,
}
{
failoverDirection:
{
Description: The failover direction. ,
Enum:
{
PrimaryToRecovery: No description available. ,
RecoveryToPrimary: No description available. ,
}
,
Required: True ,
}
enum ,
sourceSiteOperations:
{
Description: A value indicating whether source site operations are required. ,
Enum:
{
Required: No description available. ,
NotRequired: No description available. ,
}
,
Required: True ,
}
enum ,
providerSpecificDetails:
{
Description: The provider specific properties. ,
Required: False ,
}
[
{
instanceType:
{
Description: The class type. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The custom details. ,
Required: False ,
}
{
friendlyName:
{
Description: The friendly name. ,
Required: False ,
}
string ,
primaryFabricId:
{
Description: The primary fabric Id. ,
Required: False ,
}
string ,
primaryFabricFriendlyName:
{
Description: The primary fabric friendly name. ,
Required: False ,
}
string ,
recoveryFabricId:
{
Description: The recovery fabric Id. ,
Required: False ,
}
string ,
recoveryFabricFriendlyName:
{
Description: The recovery fabric friendly name. ,
Required: False ,
}
string ,
failoverDeploymentModel:
{
Description: The failover deployment model. ,
Required: False ,
}
string ,
replicationProviders:
{
Description: The list of replication providers. ,
Required: False ,
}
[
string ,
]
,
allowedOperations:
{
Description: The list of allowed operations. ,
Required: False ,
}
[
string ,
]
,
lastPlannedFailoverTime:
{
Description: The start time of the last planned failover. ,
Format: date-time ,
Required: False ,
}
string ,
lastUnplannedFailoverTime:
{
Description: The start time of the last unplanned failover. ,
Format: date-time ,
Required: False ,
}
string ,
lastTestFailoverTime:
{
Description: The start time of the last test failover. ,
Format: date-time ,
Required: False ,
}
string ,
currentScenario:
{
Description: The current scenario details. ,
Required: False ,
}
{
scenarioName:
{
Description: Scenario name. ,
Required: False ,
}
string ,
jobId:
{
Description: ARM Id of the job being executed. ,
Required: False ,
}
string ,
startTime:
{
Description: Start time of the workflow. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
currentScenarioStatus:
{
Description: The recovery plan status. ,
Required: False ,
}
string ,
currentScenarioStatusDescription:
{
Description: The recovery plan status description. ,
Required: False ,
}
string ,
groups:
{
Description: The recovery plan groups. ,
Required: False ,
}
[
{
groupType:
{
Description: The group type. ,
Enum:
{
Shutdown: No description available. ,
Boot: No description available. ,
Failover: No description available. ,
}
,
Required: True ,
}
enum ,
replicationProtectedItems:
{
Description: The list of protected items. ,
Required: False ,
}
[
{
id:
{
Description: The ARM Id of the recovery plan protected item. ,
Required: False ,
}
string ,
virtualMachineId:
{
Description: The virtual machine Id. ,
Required: False ,
}
string ,
}
,
]
,
startGroupActions:
{
Description: The start group actions. ,
Required: False ,
}
[
{
actionName:
{
Description: The action name. ,
Required: True ,
}
string ,
failoverTypes:
{
Description: The list of failover types. ,
Required: True ,
}
[
string ,
]
,
failoverDirections:
{
Description: The list of failover directions. ,
Required: True ,
}
[
string ,
]
,
customDetails:
{
Description: The custom details. ,
Required: True ,
}
{
instanceType:
{
Description: Gets the type of action details (see RecoveryPlanActionDetailsTypes enum for possible values). ,
Required: True ,
}
string ,
}
,
}
,
]
,
endGroupActions:
{
Description: The end group actions. ,
Required: False ,
}
[
{
actionName:
{
Description: The action name. ,
Required: True ,
}
string ,
failoverTypes:
{
Description: The list of failover types. ,
Required: True ,
}
[
string ,
]
,
failoverDirections:
{
Description: The list of failover directions. ,
Required: True ,
}
[
string ,
]
,
customDetails:
{
Description: The custom details. ,
Required: True ,
}
{
instanceType:
{
Description: Gets the type of action details (see RecoveryPlanActionDetailsTypes enum for possible values). ,
Required: True ,
}
string ,
}
,
}
,
]
,
}
,
]
,
providerSpecificDetails:
{
Description: The provider id and provider specific details. ,
Required: False ,
}
[
{
instanceType:
{
Description: Gets the Instance type. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (202)

{}
ReplicationRecoveryServicesProviders_List (new)
Description :  Lists the registered recovery services providers in the vault.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationRecoveryServicesProviders
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Servers details. ,
Required: False ,
}
[
{
properties:
{
Description: Provider properties. ,
Required: False ,
}
{
fabricType:
{
Description: Type of the site. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name of the DRA. ,
Required: False ,
}
string ,
providerVersion:
{
Description: The provider version. ,
Required: False ,
}
string ,
serverVersion:
{
Description: The fabric provider. ,
Required: False ,
}
string ,
providerVersionState:
{
Description: DRA version status. ,
Required: False ,
}
string ,
providerVersionExpiryDate:
{
Description: Expiry date of the version. ,
Format: date-time ,
Required: False ,
}
string ,
fabricFriendlyName:
{
Description: The fabric friendly name. ,
Required: False ,
}
string ,
lastHeartBeat:
{
Description: Time when last heartbeat was sent by the DRA. ,
Format: date-time ,
Required: False ,
}
string ,
connectionStatus:
{
Description: A value indicating whether DRA is responsive. ,
Required: False ,
}
string ,
protectedItemCount:
{
Description: Number of protected VMs currently managed by the DRA. ,
Format: int32 ,
Required: False ,
}
integer ,
allowedScenarios:
{
Description: The scenarios allowed on this provider. ,
Required: False ,
}
[
string ,
]
,
healthErrorDetails:
{
Description: The recovery services provider health error details. ,
Required: False ,
}
[
{
innerHealthErrors:
{
Description: 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. ,
Required: False ,
}
[
{
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
draIdentifier:
{
Description: The DRA Id. ,
Required: False ,
}
string ,
machineId:
{
Description: The machine Id. ,
Required: False ,
}
string ,
machineName:
{
Description: The machine name. ,
Required: False ,
}
string ,
biosId:
{
Description: The Bios Id. ,
Required: False ,
}
string ,
authenticationIdentityDetails:
{
Description: The authentication identity details. ,
Required: False ,
}
{
tenantId:
{
Description: The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
applicationId:
{
Description: The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
objectId:
{
Description: The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
audience:
{
Description: The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
aadAuthority:
{
Description: The base authority for Azure Active Directory authentication. ,
Required: False ,
}
string ,
}
,
resourceAccessIdentityDetails:
{
Description: The resource access identity details. ,
Required: False ,
}
{
tenantId:
{
Description: The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
applicationId:
{
Description: The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
objectId:
{
Description: The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
audience:
{
Description: The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
aadAuthority:
{
Description: The base authority for Azure Active Directory authentication. ,
Required: False ,
}
string ,
}
,
dataPlaneAuthenticationIdentityDetails:
{
Description: The data plane authentication identity details. ,
Required: False ,
}
{
tenantId:
{
Description: The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
applicationId:
{
Description: The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
objectId:
{
Description: The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
audience:
{
Description: The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
aadAuthority:
{
Description: The base authority for Azure Active Directory authentication. ,
Required: False ,
}
string ,
}
,
providerVersionDetails:
{
Description: The provider version details. ,
Required: False ,
}
{
version:
{
Description: The agent version. ,
Required: False ,
}
string ,
expiryDate:
{
Description: Version expiry date. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: A value indicating whether security update required. ,
Enum:
{
Supported: No description available. ,
NotSupported: No description available. ,
Deprecated: No description available. ,
UpdateRequired: No description available. ,
SecurityUpdateRequired: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The value of next link. ,
Required: False ,
}
string ,
}
ReplicationStorageClassificationMappings_List (new)
Description :  Lists the storage classification mappings in the vault.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationStorageClassificationMappings
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The storage details. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the storage mapping object. ,
Required: False ,
}
{
targetStorageClassificationId:
{
Description: Target storage object Id. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The value of next link. ,
Required: False ,
}
string ,
}
ReplicationStorageClassifications_List (new)
Description :  Lists the storage classifications in the vault.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationStorageClassifications
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The storage details. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the storage object. ,
Required: False ,
}
{
friendlyName:
{
Description: Friendly name of the Storage classification. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The value of next link. ,
Required: False ,
}
string ,
}
SupportedOperatingSystems_Get (new)
Description :  Gets the data of supported operating systems by SRS.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationSupportedOperatingSystems
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
instanceType:
{
Description: The instance type. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The supported operating systems properties. ,
Required: False ,
}
{
supportedOsList:
{
Description: The supported operating systems property list. ,
Required: False ,
}
[
{
instanceType:
{
Description: The replication provider type. ,
Required: False ,
}
string ,
supportedOs:
{
Description: The list of supported operating systems. ,
Required: False ,
}
[
{
osName:
{
Description: The name. ,
Required: False ,
}
string ,
osType:
{
Description: The type. ,
Required: False ,
}
string ,
osVersions:
{
Description: The list of version for operating system. ,
Required: False ,
}
[
{
version:
{
Description: The version. ,
Required: False ,
}
string ,
servicePack:
{
Description: The service pack. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
}
ReplicationVaultHealth_Get (new)
Description :  Gets the health details of the vault.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationVaultHealth
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The vault health related data. ,
Required: False ,
}
{
vaultErrors:
{
Description: The list of errors on the vault. ,
Required: False ,
}
[
{
innerHealthErrors:
{
Description: 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. ,
Required: False ,
}
[
{
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
protectedItemsHealth:
{
Description: The list of the health detail of the protected items in the vault. ,
Required: False ,
}
{
resourceCount:
{
Description: The count of total resources under the container. ,
Format: int32 ,
Required: False ,
}
integer ,
issues:
{
Description: The list of summary of health errors across the resources under the container. ,
Required: False ,
}
[
{
summaryCode:
{
Description: The code of the health error. ,
Required: False ,
}
string ,
category:
{
Description: The category of the health error. ,
Enum:
{
None: No description available. ,
Replication: No description available. ,
TestFailover: No description available. ,
Configuration: No description available. ,
FabricInfrastructure: No description available. ,
VersionExpiry: No description available. ,
AgentAutoUpdateInfra: No description available. ,
AgentAutoUpdateArtifactDeleted: No description available. ,
AgentAutoUpdateRunAsAccount: No description available. ,
AgentAutoUpdateRunAsAccountExpiry: No description available. ,
AgentAutoUpdateRunAsAccountExpired: No description available. ,
}
,
Required: False ,
}
enum ,
severity:
{
Description: Severity of error. ,
Enum:
{
NONE: No description available. ,
Warning: No description available. ,
Error: No description available. ,
Info: No description available. ,
}
,
Required: False ,
}
enum ,
summaryMessage:
{
Description: The summary message of the health error. ,
Required: False ,
}
string ,
affectedResourceType:
{
Description: The type of affected ARM resource. ,
Required: False ,
}
string ,
affectedResourceSubtype:
{
Description: The sub type of any subcomponent within the ARM resource that this might be applicable. Value remains null if not applicable. ,
Required: False ,
}
string ,
affectedResourceCorrelationIds:
{
Description: The list of affected resource correlation Ids. This can be used to uniquely identify the count of items affected by a specific category and severity as well as count of item affected by an specific issue. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
categorizedResourceCounts:
{
Description: The categorized resource counts. ,
Required: False ,
}
object ,
}
,
fabricsHealth:
{
Description: The list of the health detail of the fabrics in the vault. ,
Required: False ,
}
{
resourceCount:
{
Description: The count of total resources under the container. ,
Format: int32 ,
Required: False ,
}
integer ,
issues:
{
Description: The list of summary of health errors across the resources under the container. ,
Required: False ,
}
[
{
summaryCode:
{
Description: The code of the health error. ,
Required: False ,
}
string ,
category:
{
Description: The category of the health error. ,
Enum:
{
None: No description available. ,
Replication: No description available. ,
TestFailover: No description available. ,
Configuration: No description available. ,
FabricInfrastructure: No description available. ,
VersionExpiry: No description available. ,
AgentAutoUpdateInfra: No description available. ,
AgentAutoUpdateArtifactDeleted: No description available. ,
AgentAutoUpdateRunAsAccount: No description available. ,
AgentAutoUpdateRunAsAccountExpiry: No description available. ,
AgentAutoUpdateRunAsAccountExpired: No description available. ,
}
,
Required: False ,
}
enum ,
severity:
{
Description: Severity of error. ,
Enum:
{
NONE: No description available. ,
Warning: No description available. ,
Error: No description available. ,
Info: No description available. ,
}
,
Required: False ,
}
enum ,
summaryMessage:
{
Description: The summary message of the health error. ,
Required: False ,
}
string ,
affectedResourceType:
{
Description: The type of affected ARM resource. ,
Required: False ,
}
string ,
affectedResourceSubtype:
{
Description: The sub type of any subcomponent within the ARM resource that this might be applicable. Value remains null if not applicable. ,
Required: False ,
}
string ,
affectedResourceCorrelationIds:
{
Description: The list of affected resource correlation Ids. This can be used to uniquely identify the count of items affected by a specific category and severity as well as count of item affected by an specific issue. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
categorizedResourceCounts:
{
Description: The categorized resource counts. ,
Required: False ,
}
object ,
}
,
containersHealth:
{
Description: The list of the health detail of the containers in the vault. ,
Required: False ,
}
{
resourceCount:
{
Description: The count of total resources under the container. ,
Format: int32 ,
Required: False ,
}
integer ,
issues:
{
Description: The list of summary of health errors across the resources under the container. ,
Required: False ,
}
[
{
summaryCode:
{
Description: The code of the health error. ,
Required: False ,
}
string ,
category:
{
Description: The category of the health error. ,
Enum:
{
None: No description available. ,
Replication: No description available. ,
TestFailover: No description available. ,
Configuration: No description available. ,
FabricInfrastructure: No description available. ,
VersionExpiry: No description available. ,
AgentAutoUpdateInfra: No description available. ,
AgentAutoUpdateArtifactDeleted: No description available. ,
AgentAutoUpdateRunAsAccount: No description available. ,
AgentAutoUpdateRunAsAccountExpiry: No description available. ,
AgentAutoUpdateRunAsAccountExpired: No description available. ,
}
,
Required: False ,
}
enum ,
severity:
{
Description: Severity of error. ,
Enum:
{
NONE: No description available. ,
Warning: No description available. ,
Error: No description available. ,
Info: No description available. ,
}
,
Required: False ,
}
enum ,
summaryMessage:
{
Description: The summary message of the health error. ,
Required: False ,
}
string ,
affectedResourceType:
{
Description: The type of affected ARM resource. ,
Required: False ,
}
string ,
affectedResourceSubtype:
{
Description: The sub type of any subcomponent within the ARM resource that this might be applicable. Value remains null if not applicable. ,
Required: False ,
}
string ,
affectedResourceCorrelationIds:
{
Description: The list of affected resource correlation Ids. This can be used to uniquely identify the count of items affected by a specific category and severity as well as count of item affected by an specific issue. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
categorizedResourceCounts:
{
Description: The categorized resource counts. ,
Required: False ,
}
object ,
}
,
}
,
}
ReplicationVaultHealth_Refresh (new)
Description :  Refreshes health summary of the vault.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationVaultHealth/default/refresh
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The vault health related data. ,
Required: False ,
}
{
vaultErrors:
{
Description: The list of errors on the vault. ,
Required: False ,
}
[
{
innerHealthErrors:
{
Description: 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. ,
Required: False ,
}
[
{
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
protectedItemsHealth:
{
Description: The list of the health detail of the protected items in the vault. ,
Required: False ,
}
{
resourceCount:
{
Description: The count of total resources under the container. ,
Format: int32 ,
Required: False ,
}
integer ,
issues:
{
Description: The list of summary of health errors across the resources under the container. ,
Required: False ,
}
[
{
summaryCode:
{
Description: The code of the health error. ,
Required: False ,
}
string ,
category:
{
Description: The category of the health error. ,
Enum:
{
None: No description available. ,
Replication: No description available. ,
TestFailover: No description available. ,
Configuration: No description available. ,
FabricInfrastructure: No description available. ,
VersionExpiry: No description available. ,
AgentAutoUpdateInfra: No description available. ,
AgentAutoUpdateArtifactDeleted: No description available. ,
AgentAutoUpdateRunAsAccount: No description available. ,
AgentAutoUpdateRunAsAccountExpiry: No description available. ,
AgentAutoUpdateRunAsAccountExpired: No description available. ,
}
,
Required: False ,
}
enum ,
severity:
{
Description: Severity of error. ,
Enum:
{
NONE: No description available. ,
Warning: No description available. ,
Error: No description available. ,
Info: No description available. ,
}
,
Required: False ,
}
enum ,
summaryMessage:
{
Description: The summary message of the health error. ,
Required: False ,
}
string ,
affectedResourceType:
{
Description: The type of affected ARM resource. ,
Required: False ,
}
string ,
affectedResourceSubtype:
{
Description: The sub type of any subcomponent within the ARM resource that this might be applicable. Value remains null if not applicable. ,
Required: False ,
}
string ,
affectedResourceCorrelationIds:
{
Description: The list of affected resource correlation Ids. This can be used to uniquely identify the count of items affected by a specific category and severity as well as count of item affected by an specific issue. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
categorizedResourceCounts:
{
Description: The categorized resource counts. ,
Required: False ,
}
object ,
}
,
fabricsHealth:
{
Description: The list of the health detail of the fabrics in the vault. ,
Required: False ,
}
{
resourceCount:
{
Description: The count of total resources under the container. ,
Format: int32 ,
Required: False ,
}
integer ,
issues:
{
Description: The list of summary of health errors across the resources under the container. ,
Required: False ,
}
[
{
summaryCode:
{
Description: The code of the health error. ,
Required: False ,
}
string ,
category:
{
Description: The category of the health error. ,
Enum:
{
None: No description available. ,
Replication: No description available. ,
TestFailover: No description available. ,
Configuration: No description available. ,
FabricInfrastructure: No description available. ,
VersionExpiry: No description available. ,
AgentAutoUpdateInfra: No description available. ,
AgentAutoUpdateArtifactDeleted: No description available. ,
AgentAutoUpdateRunAsAccount: No description available. ,
AgentAutoUpdateRunAsAccountExpiry: No description available. ,
AgentAutoUpdateRunAsAccountExpired: No description available. ,
}
,
Required: False ,
}
enum ,
severity:
{
Description: Severity of error. ,
Enum:
{
NONE: No description available. ,
Warning: No description available. ,
Error: No description available. ,
Info: No description available. ,
}
,
Required: False ,
}
enum ,
summaryMessage:
{
Description: The summary message of the health error. ,
Required: False ,
}
string ,
affectedResourceType:
{
Description: The type of affected ARM resource. ,
Required: False ,
}
string ,
affectedResourceSubtype:
{
Description: The sub type of any subcomponent within the ARM resource that this might be applicable. Value remains null if not applicable. ,
Required: False ,
}
string ,
affectedResourceCorrelationIds:
{
Description: The list of affected resource correlation Ids. This can be used to uniquely identify the count of items affected by a specific category and severity as well as count of item affected by an specific issue. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
categorizedResourceCounts:
{
Description: The categorized resource counts. ,
Required: False ,
}
object ,
}
,
containersHealth:
{
Description: The list of the health detail of the containers in the vault. ,
Required: False ,
}
{
resourceCount:
{
Description: The count of total resources under the container. ,
Format: int32 ,
Required: False ,
}
integer ,
issues:
{
Description: The list of summary of health errors across the resources under the container. ,
Required: False ,
}
[
{
summaryCode:
{
Description: The code of the health error. ,
Required: False ,
}
string ,
category:
{
Description: The category of the health error. ,
Enum:
{
None: No description available. ,
Replication: No description available. ,
TestFailover: No description available. ,
Configuration: No description available. ,
FabricInfrastructure: No description available. ,
VersionExpiry: No description available. ,
AgentAutoUpdateInfra: No description available. ,
AgentAutoUpdateArtifactDeleted: No description available. ,
AgentAutoUpdateRunAsAccount: No description available. ,
AgentAutoUpdateRunAsAccountExpiry: No description available. ,
AgentAutoUpdateRunAsAccountExpired: No description available. ,
}
,
Required: False ,
}
enum ,
severity:
{
Description: Severity of error. ,
Enum:
{
NONE: No description available. ,
Warning: No description available. ,
Error: No description available. ,
Info: No description available. ,
}
,
Required: False ,
}
enum ,
summaryMessage:
{
Description: The summary message of the health error. ,
Required: False ,
}
string ,
affectedResourceType:
{
Description: The type of affected ARM resource. ,
Required: False ,
}
string ,
affectedResourceSubtype:
{
Description: The sub type of any subcomponent within the ARM resource that this might be applicable. Value remains null if not applicable. ,
Required: False ,
}
string ,
affectedResourceCorrelationIds:
{
Description: The list of affected resource correlation Ids. This can be used to uniquely identify the count of items affected by a specific category and severity as well as count of item affected by an specific issue. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
categorizedResourceCounts:
{
Description: The categorized resource counts. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (202)

{}
ReplicationVaultSetting_List (new)
Description :  Gets the list of vault setting. This includes the Migration Hub connection settings.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationVaultSettings
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of vault setting. ,
Required: False ,
}
[
{
properties:
{
Description: The vault setting properties. ,
Required: False ,
}
{
migrationSolutionId:
{
Description: The migration solution ARM Id. ,
Required: False ,
}
string ,
vmwareToAzureProviderType:
{
Description: VMware to Azure provider type. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The value of next link. ,
Required: False ,
}
string ,
}
ReplicationVaultSetting_Get (new)
Description :  Gets the vault setting. This includes the Migration Hub connection settings.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationVaultSettings/{vaultSettingName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
vaultSettingName:
{
Description: Vault setting name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The vault setting properties. ,
Required: False ,
}
{
migrationSolutionId:
{
Description: The migration solution ARM Id. ,
Required: False ,
}
string ,
vmwareToAzureProviderType:
{
Description: VMware to Azure provider type. ,
Required: False ,
}
string ,
}
,
}
ReplicationVaultSetting_Create (new)
Description :  The operation to configure vault setting.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationVaultSettings/{vaultSettingName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
vaultSettingName:
{
Description: Vault setting name. ,
Required: True ,
}
string ,
input:
{
Description: Vault setting creation input. ,
Required: True ,
}
{
properties:
{
Description: Vault setting creation input properties. ,
Required: True ,
}
{
migrationSolutionId:
{
Description: The migration solution Id. ,
Required: False ,
}
string ,
vmwareToAzureProviderType:
{
Description: VMware to Azure provider type. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The vault setting properties. ,
Required: False ,
}
{
migrationSolutionId:
{
Description: The migration solution ARM Id. ,
Required: False ,
}
string ,
vmwareToAzureProviderType:
{
Description: VMware to Azure provider type. ,
Required: False ,
}
string ,
}
,
}
ReplicationvCenters_List (new)
Description :  Lists the vCenter servers registered in the vault.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationvCenters
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The vCenter details. ,
Required: False ,
}
[
{
properties:
{
Description: VCenter related data. ,
Required: False ,
}
{
friendlyName:
{
Description: Friendly name of the vCenter. ,
Required: False ,
}
string ,
internalId:
{
Description: VCenter internal ID. ,
Required: False ,
}
string ,
lastHeartbeat:
{
Description: The time when the last heartbeat was received by vCenter. ,
Format: date-time ,
Required: False ,
}
string ,
discoveryStatus:
{
Description: The VCenter discovery status. ,
Required: False ,
}
string ,
processServerId:
{
Description: The process server Id. ,
Required: False ,
}
string ,
ipAddress:
{
Description: The IP address of the vCenter. ,
Required: False ,
}
string ,
infrastructureId:
{
Description: The infrastructure Id of vCenter. ,
Required: False ,
}
string ,
port:
{
Description: The port number for discovery. ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: The account Id which has privileges to discover the vCenter. ,
Required: False ,
}
string ,
fabricArmResourceName:
{
Description: The ARM resource name of the fabric containing this VCenter. ,
Required: False ,
}
string ,
healthErrors:
{
Description: The health errors for this VCenter. ,
Required: False ,
}
[
{
innerHealthErrors:
{
Description: 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. ,
Required: False ,
}
[
{
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCategory:
{
Description: Category of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Summary message of the entity. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Recommended action to resolve error. ,
Required: False ,
}
string ,
creationTimeUtc:
{
Description: Error creation time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
recoveryProviderErrorMessage:
{
Description: DRA error message. ,
Required: False ,
}
string ,
entityId:
{
Description: ID of the entity. ,
Required: False ,
}
string ,
errorId:
{
Description: The health error unique id. ,
Required: False ,
}
string ,
customerResolvability:
{
Description: Value indicating whether the health error is customer resolvable. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The value of next link. ,
Required: False ,
}
string ,
}