Microsoft.RecoveryServices (stable:2016-08-10)

2025/09/26 • 102 new, 102 deleted methods

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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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)

{
properties:
{
Description: The vault health related data. ,
Required: False ,
}
{
vaultErrors:
{
Description: The list of errors on the vault. ,
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 ,
errorCode:
{
Description: Error code. ,
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 ,
childErrors:
{
Description: The child health errors. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
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:
{
Replication: No description available. ,
TestFailover: No description available. ,
Configuration: 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 ,
]
,
}
,
]
,
}
,
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:
{
Replication: No description available. ,
TestFailover: No description available. ,
Configuration: 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 ,
]
,
}
,
]
,
}
,
}
,
}
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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 ,
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 ,
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 ,
replicationHealthErrors:
{
Description: List of replication health errors. ,
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 ,
errorCode:
{
Description: Error code. ,
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 ,
childErrors:
{
Description: The child health errors. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
failoverHealthErrors:
{
Description: List of failover health errors. ,
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 ,
errorCode:
{
Description: Error code. ,
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 ,
childErrors:
{
Description: The child health errors. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
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: False ,
}
string ,
}
,
recoveryContainerId:
{
Description: The recovery container Id. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The value of next link. ,
Required: False ,
}
string ,
}
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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 ,
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 ,
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 ,
replicationHealthErrors:
{
Description: List of replication health errors. ,
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 ,
errorCode:
{
Description: Error code. ,
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 ,
childErrors:
{
Description: The child health errors. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
failoverHealthErrors:
{
Description: List of failover health errors. ,
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 ,
errorCode:
{
Description: Error code. ,
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 ,
childErrors:
{
Description: The child health errors. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
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: False ,
}
string ,
}
,
recoveryContainerId:
{
Description: The recovery container Id. ,
Required: False ,
}
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 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: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The value of next link. ,
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The value of next link. ,
Required: False ,
}
string ,
}
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
fabricName:
{
Description: ASR fabric to migrate. ,
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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: False ,
}
string ,
}
,
healthErrorDetails:
{
Description: Fabric health error details. ,
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 ,
errorCode:
{
Description: Error code. ,
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 ,
childErrors:
{
Description: The child health errors. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
health:
{
Description: Health of fabric. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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 ,
}
,
}
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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 ,
}
,
}

⚐ 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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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 ,
}
,
}

⚐ Response (202)

{}
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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 ,
}
,
}
,
]
,
nextLink:
{
Description: The value of next link. ,
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 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 ,
}
,
}
,
]
,
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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)

{}
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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_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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 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_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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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 ,
}
,
}
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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_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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 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 ,
}
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
fabricName:
{
Description: The ARM fabric name. ,
Required: True ,
}
string ,
protectionContainerName:
{
Description: The protection container name. ,
Required: True ,
}
string ,
replicatedProtectedItemName:
{
Description: The replicated protected item's name. ,
Required: True ,
}
string ,
applyRecoveryPointInput:
{
Description: The ApplyRecoveryPointInput. ,
Required: True ,
}
{
properties:
{
Description: The input properties to apply recovery point. ,
Required: False ,
}
{
recoveryPointId:
{
Description: The recovery point Id. ,
Required: False ,
}
string ,
providerSpecificDetails:
{
Description: Provider specific input for applying recovery point. ,
Required: False ,
}
{
instanceType:
{
Description: The class type. ,
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 ,
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 ,
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 ,
replicationHealthErrors:
{
Description: List of replication health errors. ,
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 ,
errorCode:
{
Description: Error code. ,
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 ,
childErrors:
{
Description: The child health errors. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
failoverHealthErrors:
{
Description: List of failover health errors. ,
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 ,
errorCode:
{
Description: Error code. ,
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 ,
childErrors:
{
Description: The child health errors. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
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: False ,
}
string ,
}
,
recoveryContainerId:
{
Description: The recovery container Id. ,
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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 ,
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 ,
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 ,
replicationHealthErrors:
{
Description: List of replication health errors. ,
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 ,
errorCode:
{
Description: Error code. ,
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 ,
childErrors:
{
Description: The child health errors. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
failoverHealthErrors:
{
Description: List of failover health errors. ,
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 ,
errorCode:
{
Description: Error code. ,
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 ,
childErrors:
{
Description: The child health errors. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
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: False ,
}
string ,
}
,
recoveryContainerId:
{
Description: The recovery container Id. ,
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/{replicationProtectedItemName}/updateMobilityService
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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 ,
replicationProtectedItemName:
{
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 ,
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 ,
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 ,
replicationHealthErrors:
{
Description: List of replication health errors. ,
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 ,
errorCode:
{
Description: Error code. ,
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 ,
childErrors:
{
Description: The child health errors. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
failoverHealthErrors:
{
Description: List of failover health errors. ,
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 ,
errorCode:
{
Description: Error code. ,
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 ,
childErrors:
{
Description: The child health errors. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
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: False ,
}
string ,
}
,
recoveryContainerId:
{
Description: The recovery container Id. ,
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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 ,
rrInput:
{
Description: Disable protection 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: 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 ,
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 ,
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 ,
replicationHealthErrors:
{
Description: List of replication health errors. ,
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 ,
errorCode:
{
Description: Error code. ,
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 ,
childErrors:
{
Description: The child health errors. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
failoverHealthErrors:
{
Description: List of failover health errors. ,
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 ,
errorCode:
{
Description: Error code. ,
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 ,
childErrors:
{
Description: The child health errors. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
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: False ,
}
string ,
}
,
recoveryContainerId:
{
Description: The recovery container Id. ,
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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 ,
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 ,
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 ,
replicationHealthErrors:
{
Description: List of replication health errors. ,
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 ,
errorCode:
{
Description: Error code. ,
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 ,
childErrors:
{
Description: The child health errors. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
failoverHealthErrors:
{
Description: List of failover health errors. ,
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 ,
errorCode:
{
Description: Error code. ,
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 ,
childErrors:
{
Description: The child health errors. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
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: False ,
}
string ,
}
,
recoveryContainerId:
{
Description: The recovery container Id. ,
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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 ,
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 ,
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 ,
replicationHealthErrors:
{
Description: List of replication health errors. ,
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 ,
errorCode:
{
Description: Error code. ,
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 ,
childErrors:
{
Description: The child health errors. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
failoverHealthErrors:
{
Description: List of failover health errors. ,
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 ,
errorCode:
{
Description: Error code. ,
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 ,
childErrors:
{
Description: The child health errors. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
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: False ,
}
string ,
}
,
recoveryContainerId:
{
Description: The recovery container Id. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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: Test failover input. ,
Required: True ,
}
{
properties:
{
Description: Planned failover input properties ,
Required: False ,
}
{
failoverDirection:
{
Description: 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 ,
skipTestFailoverCleanup:
{
Description: A value indicating whether the test failover cleanup is to be skipped. ,
Required: False ,
}
string ,
providerSpecificDetails:
{
Description: Provider specific settings ,
Required: False ,
}
{
instanceType:
{
Description: The class type. ,
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 ,
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 ,
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 ,
replicationHealthErrors:
{
Description: List of replication health errors. ,
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 ,
errorCode:
{
Description: Error code. ,
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 ,
childErrors:
{
Description: The child health errors. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
failoverHealthErrors:
{
Description: List of failover health errors. ,
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 ,
errorCode:
{
Description: Error code. ,
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 ,
childErrors:
{
Description: The child health errors. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
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: False ,
}
string ,
}
,
recoveryContainerId:
{
Description: The recovery container Id. ,
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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: Disable protection input. ,
Required: True ,
}
{
properties:
{
Description: Planned failover input properties ,
Required: False ,
}
{
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: 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 ,
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 ,
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 ,
replicationHealthErrors:
{
Description: List of replication health errors. ,
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 ,
errorCode:
{
Description: Error code. ,
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 ,
childErrors:
{
Description: The child health errors. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
failoverHealthErrors:
{
Description: List of failover health errors. ,
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 ,
errorCode:
{
Description: Error code. ,
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 ,
childErrors:
{
Description: The child health errors. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
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: False ,
}
string ,
}
,
recoveryContainerId:
{
Description: The recovery container Id. ,
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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: Disable protection 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: 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 ,
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 ,
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 ,
replicationHealthErrors:
{
Description: List of replication health errors. ,
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 ,
errorCode:
{
Description: Error code. ,
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 ,
childErrors:
{
Description: The child health errors. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
failoverHealthErrors:
{
Description: List of failover health errors. ,
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 ,
errorCode:
{
Description: Error code. ,
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 ,
childErrors:
{
Description: The child health errors. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
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: False ,
}
string ,
}
,
recoveryContainerId:
{
Description: The recovery container Id. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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: False ,
}
{
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: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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 ,
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 ,
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 ,
replicationHealthErrors:
{
Description: List of replication health errors. ,
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 ,
errorCode:
{
Description: Error code. ,
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 ,
childErrors:
{
Description: The child health errors. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
failoverHealthErrors:
{
Description: List of failover health errors. ,
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 ,
errorCode:
{
Description: Error code. ,
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 ,
childErrors:
{
Description: The child health errors. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
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: False ,
}
string ,
}
,
recoveryContainerId:
{
Description: The recovery container Id. ,
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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: 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 ,
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 ,
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 ,
replicationHealthErrors:
{
Description: List of replication health errors. ,
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 ,
errorCode:
{
Description: Error code. ,
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 ,
childErrors:
{
Description: The child health errors. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
failoverHealthErrors:
{
Description: List of failover health errors. ,
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 ,
errorCode:
{
Description: Error code. ,
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 ,
childErrors:
{
Description: The child health errors. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
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: False ,
}
string ,
}
,
recoveryContainerId:
{
Description: The recovery container Id. ,
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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 ,
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 ,
recoveryVMSubnetName:
{
Description: Recovery VM subnet name. ,
Required: False ,
}
string ,
replicaNicStaticIPAddress:
{
Description: Replica nic static IP address. ,
Required: False ,
}
string ,
selectionType:
{
Description: Selection type for failover. ,
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: 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 ,
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 ,
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 ,
replicationHealthErrors:
{
Description: List of replication health errors. ,
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 ,
errorCode:
{
Description: Error code. ,
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 ,
childErrors:
{
Description: The child health errors. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
failoverHealthErrors:
{
Description: List of failover health errors. ,
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 ,
errorCode:
{
Description: Error code. ,
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 ,
childErrors:
{
Description: The child health errors. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
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: False ,
}
string ,
}
,
recoveryContainerId:
{
Description: The recovery container Id. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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 if the version is deprecated. ,
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 ,
}
[
{
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
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 ,
childErrors:
{
Description: The child health errors. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
draIdentifier:
{
Description: The DRA Id. ,
Required: False ,
}
string ,
identityDetails:
{
Description: The identity details. ,
Required: False ,
}
{
identityProviderType:
{
Description: The identity provider type. Value is the ToString() of a IdentityProviderType value. ,
Enum:
{
RecoveryServicesActiveDirectory: No description available. ,
CustomerActiveDirectory: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
certificateThumbprint:
{
Description: The certificate thumbprint. Applicable only if IdentityProviderType is RecoveryServicesActiveDirectory. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ 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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
fabricName:
{
Description: Fabric name. ,
Required: True ,
}
string ,
providerName:
{
Description: Recovery services provider name. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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 if the version is deprecated. ,
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 ,
}
[
{
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
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 ,
childErrors:
{
Description: The child health errors. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
draIdentifier:
{
Description: The DRA Id. ,
Required: False ,
}
string ,
identityDetails:
{
Description: The identity details. ,
Required: False ,
}
{
identityProviderType:
{
Description: The identity provider type. Value is the ToString() of a IdentityProviderType value. ,
Enum:
{
RecoveryServicesActiveDirectory: No description available. ,
CustomerActiveDirectory: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
certificateThumbprint:
{
Description: The certificate thumbprint. Applicable only if IdentityProviderType is RecoveryServicesActiveDirectory. ,
Required: False ,
}
string ,
}
,
}
,
}
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
fabricName:
{
Description: Fabric name. ,
Required: True ,
}
string ,
providerName:
{
Description: Recovery services provider name. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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 if the version is deprecated. ,
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 ,
}
[
{
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
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 ,
childErrors:
{
Description: The child health errors. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
draIdentifier:
{
Description: The DRA Id. ,
Required: False ,
}
string ,
identityDetails:
{
Description: The identity details. ,
Required: False ,
}
{
identityProviderType:
{
Description: The identity provider type. Value is the ToString() of a IdentityProviderType value. ,
Enum:
{
RecoveryServicesActiveDirectory: No description available. ,
CustomerActiveDirectory: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
certificateThumbprint:
{
Description: The certificate thumbprint. Applicable only if IdentityProviderType is RecoveryServicesActiveDirectory. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The value of next link. ,
Required: False ,
}
string ,
}
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 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 if the version is deprecated. ,
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 ,
}
[
{
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
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 ,
childErrors:
{
Description: The child health errors. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
draIdentifier:
{
Description: The DRA Id. ,
Required: False ,
}
string ,
identityDetails:
{
Description: The identity details. ,
Required: False ,
}
{
identityProviderType:
{
Description: The identity provider type. Value is the ToString() of a IdentityProviderType value. ,
Enum:
{
RecoveryServicesActiveDirectory: No description available. ,
CustomerActiveDirectory: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
certificateThumbprint:
{
Description: The certificate thumbprint. Applicable only if IdentityProviderType is RecoveryServicesActiveDirectory. ,
Required: False ,
}
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
fabricName:
{
Description: The fabric name. ,
Required: True ,
}
string ,
protectionContainerName:
{
Description: The protection container name. ,
Required: True ,
}
string ,
replicatedProtectedItemName:
{
Description: The replication protected item's name. ,
Required: True ,
}
string ,
recoveryPointName:
{
Description: The recovery point name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Recovery point related data. ,
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 ,
}
{
Type:
{
Description: Gets the provider type. ,
Required: False ,
}
string ,
}
,
}
,
}
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
fabricName:
{
Description: The fabric name. ,
Required: True ,
}
string ,
protectionContainerName:
{
Description: The protection container name. ,
Required: True ,
}
string ,
replicatedProtectedItemName:
{
Description: The replication protected item's name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The recovery point details. ,
Required: False ,
}
[
{
properties:
{
Description: Recovery point related data. ,
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 ,
}
{
Type:
{
Description: Gets the provider type. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The value of next link. ,
Required: False ,
}
string ,
}
ReplicationRecoveryPlans_Reprotect (new)
Description :  The operation to reprotect(reverse replicate) a recovery plan.
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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: False ,
}
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: False ,
}
string ,
}
,
}
,
]
,
}
,
]
,
}
,
}

⚐ Response (202)

{}
ReplicationRecoveryPlans_FailoverCommit (new)
Description :  The operation to commit the fail over 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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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: False ,
}
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: False ,
}
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
recoveryPlanName:
{
Description: Recovery plan name. ,
Required: True ,
}
string ,
input:
{
Description: 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: False ,
}
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: False ,
}
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
recoveryPlanName:
{
Description: Recovery plan name. ,
Required: True ,
}
string ,
input:
{
Description: 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 ,
skipTestFailoverCleanup:
{
Description: A value indicating whether the test failover cleanup is to be skipped. ,
Required: False ,
}
string ,
providerSpecificDetails:
{
Description: The provider specific properties. ,
Required: False ,
}
[
{
instanceType:
{
Description: The class type. ,
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: False ,
}
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: False ,
}
string ,
}
,
}
,
]
,
}
,
]
,
}
,
}

⚐ Response (202)

{}
ReplicationRecoveryPlans_UnplannedFailover (new)
Description :  The operation to start the 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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
recoveryPlanName:
{
Description: Recovery plan name. ,
Required: True ,
}
string ,
input:
{
Description: 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: 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: False ,
}
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: False ,
}
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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: 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: False ,
}
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: False ,
}
string ,
}
,
}
,
]
,
}
,
]
,
}
,
}

⚐ Response (202)

{}
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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: False ,
}
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: False ,
}
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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: False ,
}
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: 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: False ,
}
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: False ,
}
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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: False ,
}
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: 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: False ,
}
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: False ,
}
string ,
}
,
}
,
]
,
}
,
]
,
}
,
}

⚐ Response (202)

{}
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 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: False ,
}
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: False ,
}
string ,
}
,
}
,
]
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The value of next link. ,
Required: False ,
}
string ,
}
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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: 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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
fabricName:
{
Description: Unique fabric ARM name. ,
Required: True ,
}
string ,
protectionContainerName:
{
Description: Unique protection container ARM name. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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_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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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: 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_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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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_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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 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 ,
}
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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)

{}
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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: False ,
}
string ,
}
,
health:
{
Description: Health of pairing. ,
Required: False ,
}
string ,
healthErrorDetails:
{
Description: Health error. ,
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 ,
errorCode:
{
Description: Error code. ,
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 ,
childErrors:
{
Description: The child health errors. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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: False ,
}
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: False ,
}
string ,
}
,
health:
{
Description: Health of pairing. ,
Required: False ,
}
string ,
healthErrorDetails:
{
Description: Health error. ,
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 ,
errorCode:
{
Description: Error code. ,
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 ,
childErrors:
{
Description: The child health errors. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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_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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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: False ,
}
string ,
}
,
health:
{
Description: Health of pairing. ,
Required: False ,
}
string ,
healthErrorDetails:
{
Description: Health error. ,
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 ,
errorCode:
{
Description: Error code. ,
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 ,
childErrors:
{
Description: The child health errors. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
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_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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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: 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: False ,
}
string ,
}
,
health:
{
Description: Health of pairing. ,
Required: False ,
}
string ,
healthErrorDetails:
{
Description: Health error. ,
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 ,
errorCode:
{
Description: Error code. ,
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 ,
childErrors:
{
Description: The child health errors. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
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 ,
}
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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: False ,
}
string ,
}
,
}
,
}
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
fabricName:
{
Description: Fabric name. ,
Required: True ,
}
string ,
protectionContainerName:
{
Description: Protection container name. ,
Required: True ,
}
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: False ,
}
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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: False ,
}
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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: False ,
}
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: False ,
}
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
policyName:
{
Description: Protection profile Id. ,
Required: True ,
}
string ,
input:
{
Description: Update Protection Profile Input ,
Required: True ,
}
{
properties:
{
Description: The ReplicationProviderSettings. ,
Required: False ,
}
{
replicationProviderSettings:
{
Description: The ReplicationProviderSettings. ,
Required: False ,
}
{
instanceType:
{
Description: The class type. ,
Required: False ,
}
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: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{}
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 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: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The value of next link. ,
Required: False ,
}
string ,
}
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 ,
}
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 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_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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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_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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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: False ,
}
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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: False ,
}
{
recoveryFabricName:
{
Description: Recovery fabric Name. ,
Required: False ,
}
string ,
recoveryNetworkId:
{
Description: Recovery network Id. ,
Required: False ,
}
string ,
fabricSpecificDetails:
{
Description: Fabric specific input properties. ,
Required: False ,
}
{
instanceType:
{
Description: The instance type. ,
Required: False ,
}
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: False ,
}
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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: False ,
}
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: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{}
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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 ,
}
,
}
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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: False ,
}
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: False ,
}
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: False ,
}
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 ,
}
,
}
,
status:
{
Description: The status of the Job. ARM expects the terminal status to be one of (1) Succeeded, (2) Failed or (3) Canceled. All other values imply that the operation is still running / being applied. ,
Required: False ,
}
string ,
error:
{
Description: The error. ,
Required: False ,
}
{
code:
{
Description: Gets HTTP status code for the error. ,
Required: False ,
}
string ,
message:
{
Description: Gets exception message. ,
Required: False ,
}
string ,
target:
{
Description: Gets exception target. ,
Required: False ,
}
string ,
details:
{
Description: Gets service based error details. ,
Required: False ,
}
[
{
code:
{
Description: Gets service error code. ,
Required: False ,
}
string ,
message:
{
Description: Gets error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets possible cause for error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets recommended action for the error. ,
Required: False ,
}
string ,
clientRequestId:
{
Description: Gets the client request Id for the session. ,
Required: False ,
}
string ,
activityId:
{
Description: Gets the activity Id for the session. ,
Required: False ,
}
string ,
target:
{
Description: Gets exception target. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: Gets private data for service debugging. ,
Required: False ,
}
{
trace:
{
Description: Gets complete stack trace of the exception. ,
Required: False ,
}
string ,
source:
{
Description: Gets exception source. ,
Required: False ,
}
string ,
methodStatus:
{
Description: Gets data related to method which threw the exception. ,
Required: False ,
}
{
isVirtual:
{
Description: Gets a value indicating whether called method was virtual ,
Required: False ,
}
string ,
parameters:
{
Description: Gets parameter list passed to method. ,
Required: False ,
}
[
string ,
]
,
containsGenericParameters:
{
Description: Gets a value indicating whether method container generic params. ,
Required: False ,
}
string ,
}
,
cloudId:
{
Description: Gets cloud Id in exception. ,
Required: False ,
}
string ,
hVHostId:
{
Description: Gets hyperV host ID. ,
Required: False ,
}
string ,
hVClusterId:
{
Description: Gets hyperV cluster Id. ,
Required: False ,
}
string ,
networkId:
{
Description: Gets network Id. ,
Required: False ,
}
string ,
vmId:
{
Description: Gets Vm Id. ,
Required: False ,
}
string ,
fabricId:
{
Description: Gets Fabric Id. ,
Required: False ,
}
string ,
liveId:
{
Description: Gets Live Id of the caller. ,
Required: False ,
}
string ,
containerId:
{
Description: Gets container Id of the caller. ,
Required: False ,
}
string ,
resourceId:
{
Description: Gets resource id used in the call. ,
Required: False ,
}
string ,
resourceName:
{
Description: Gets caller resource name. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Gets subscription Id. ,
Required: False ,
}
string ,
serializedSRSLogContext:
{
Description: Gets serialized SRS log context. ,
Required: False ,
}
string ,
}
,
}
,
startTime:
{
Description: The start time. ,
Required: False ,
}
string ,
endTime:
{
Description: The start time. ,
Required: False ,
}
string ,
}

⚐ 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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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: False ,
}
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: False ,
}
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: False ,
}
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 ,
}
,
}
,
status:
{
Description: The status of the Job. ARM expects the terminal status to be one of (1) Succeeded, (2) Failed or (3) Canceled. All other values imply that the operation is still running / being applied. ,
Required: False ,
}
string ,
error:
{
Description: The error. ,
Required: False ,
}
{
code:
{
Description: Gets HTTP status code for the error. ,
Required: False ,
}
string ,
message:
{
Description: Gets exception message. ,
Required: False ,
}
string ,
target:
{
Description: Gets exception target. ,
Required: False ,
}
string ,
details:
{
Description: Gets service based error details. ,
Required: False ,
}
[
{
code:
{
Description: Gets service error code. ,
Required: False ,
}
string ,
message:
{
Description: Gets error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets possible cause for error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets recommended action for the error. ,
Required: False ,
}
string ,
clientRequestId:
{
Description: Gets the client request Id for the session. ,
Required: False ,
}
string ,
activityId:
{
Description: Gets the activity Id for the session. ,
Required: False ,
}
string ,
target:
{
Description: Gets exception target. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: Gets private data for service debugging. ,
Required: False ,
}
{
trace:
{
Description: Gets complete stack trace of the exception. ,
Required: False ,
}
string ,
source:
{
Description: Gets exception source. ,
Required: False ,
}
string ,
methodStatus:
{
Description: Gets data related to method which threw the exception. ,
Required: False ,
}
{
isVirtual:
{
Description: Gets a value indicating whether called method was virtual ,
Required: False ,
}
string ,
parameters:
{
Description: Gets parameter list passed to method. ,
Required: False ,
}
[
string ,
]
,
containsGenericParameters:
{
Description: Gets a value indicating whether method container generic params. ,
Required: False ,
}
string ,
}
,
cloudId:
{
Description: Gets cloud Id in exception. ,
Required: False ,
}
string ,
hVHostId:
{
Description: Gets hyperV host ID. ,
Required: False ,
}
string ,
hVClusterId:
{
Description: Gets hyperV cluster Id. ,
Required: False ,
}
string ,
networkId:
{
Description: Gets network Id. ,
Required: False ,
}
string ,
vmId:
{
Description: Gets Vm Id. ,
Required: False ,
}
string ,
fabricId:
{
Description: Gets Fabric Id. ,
Required: False ,
}
string ,
liveId:
{
Description: Gets Live Id of the caller. ,
Required: False ,
}
string ,
containerId:
{
Description: Gets container Id of the caller. ,
Required: False ,
}
string ,
resourceId:
{
Description: Gets resource id used in the call. ,
Required: False ,
}
string ,
resourceName:
{
Description: Gets caller resource name. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Gets subscription Id. ,
Required: False ,
}
string ,
serializedSRSLogContext:
{
Description: Gets serialized SRS log context. ,
Required: False ,
}
string ,
}
,
}
,
startTime:
{
Description: The start time. ,
Required: False ,
}
string ,
endTime:
{
Description: The start time. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{}
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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: False ,
}
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: False ,
}
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: False ,
}
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 ,
}
,
}
,
status:
{
Description: The status of the Job. ARM expects the terminal status to be one of (1) Succeeded, (2) Failed or (3) Canceled. All other values imply that the operation is still running / being applied. ,
Required: False ,
}
string ,
error:
{
Description: The error. ,
Required: False ,
}
{
code:
{
Description: Gets HTTP status code for the error. ,
Required: False ,
}
string ,
message:
{
Description: Gets exception message. ,
Required: False ,
}
string ,
target:
{
Description: Gets exception target. ,
Required: False ,
}
string ,
details:
{
Description: Gets service based error details. ,
Required: False ,
}
[
{
code:
{
Description: Gets service error code. ,
Required: False ,
}
string ,
message:
{
Description: Gets error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets possible cause for error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets recommended action for the error. ,
Required: False ,
}
string ,
clientRequestId:
{
Description: Gets the client request Id for the session. ,
Required: False ,
}
string ,
activityId:
{
Description: Gets the activity Id for the session. ,
Required: False ,
}
string ,
target:
{
Description: Gets exception target. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: Gets private data for service debugging. ,
Required: False ,
}
{
trace:
{
Description: Gets complete stack trace of the exception. ,
Required: False ,
}
string ,
source:
{
Description: Gets exception source. ,
Required: False ,
}
string ,
methodStatus:
{
Description: Gets data related to method which threw the exception. ,
Required: False ,
}
{
isVirtual:
{
Description: Gets a value indicating whether called method was virtual ,
Required: False ,
}
string ,
parameters:
{
Description: Gets parameter list passed to method. ,
Required: False ,
}
[
string ,
]
,
containsGenericParameters:
{
Description: Gets a value indicating whether method container generic params. ,
Required: False ,
}
string ,
}
,
cloudId:
{
Description: Gets cloud Id in exception. ,
Required: False ,
}
string ,
hVHostId:
{
Description: Gets hyperV host ID. ,
Required: False ,
}
string ,
hVClusterId:
{
Description: Gets hyperV cluster Id. ,
Required: False ,
}
string ,
networkId:
{
Description: Gets network Id. ,
Required: False ,
}
string ,
vmId:
{
Description: Gets Vm Id. ,
Required: False ,
}
string ,
fabricId:
{
Description: Gets Fabric Id. ,
Required: False ,
}
string ,
liveId:
{
Description: Gets Live Id of the caller. ,
Required: False ,
}
string ,
containerId:
{
Description: Gets container Id of the caller. ,
Required: False ,
}
string ,
resourceId:
{
Description: Gets resource id used in the call. ,
Required: False ,
}
string ,
resourceName:
{
Description: Gets caller resource name. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Gets subscription Id. ,
Required: False ,
}
string ,
serializedSRSLogContext:
{
Description: Gets serialized SRS log context. ,
Required: False ,
}
string ,
}
,
}
,
startTime:
{
Description: The start time. ,
Required: False ,
}
string ,
endTime:
{
Description: The start time. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{}
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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: False ,
}
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: False ,
}
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: False ,
}
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 ,
}
,
}
,
status:
{
Description: The status of the Job. ARM expects the terminal status to be one of (1) Succeeded, (2) Failed or (3) Canceled. All other values imply that the operation is still running / being applied. ,
Required: False ,
}
string ,
error:
{
Description: The error. ,
Required: False ,
}
{
code:
{
Description: Gets HTTP status code for the error. ,
Required: False ,
}
string ,
message:
{
Description: Gets exception message. ,
Required: False ,
}
string ,
target:
{
Description: Gets exception target. ,
Required: False ,
}
string ,
details:
{
Description: Gets service based error details. ,
Required: False ,
}
[
{
code:
{
Description: Gets service error code. ,
Required: False ,
}
string ,
message:
{
Description: Gets error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets possible cause for error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets recommended action for the error. ,
Required: False ,
}
string ,
clientRequestId:
{
Description: Gets the client request Id for the session. ,
Required: False ,
}
string ,
activityId:
{
Description: Gets the activity Id for the session. ,
Required: False ,
}
string ,
target:
{
Description: Gets exception target. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: Gets private data for service debugging. ,
Required: False ,
}
{
trace:
{
Description: Gets complete stack trace of the exception. ,
Required: False ,
}
string ,
source:
{
Description: Gets exception source. ,
Required: False ,
}
string ,
methodStatus:
{
Description: Gets data related to method which threw the exception. ,
Required: False ,
}
{
isVirtual:
{
Description: Gets a value indicating whether called method was virtual ,
Required: False ,
}
string ,
parameters:
{
Description: Gets parameter list passed to method. ,
Required: False ,
}
[
string ,
]
,
containsGenericParameters:
{
Description: Gets a value indicating whether method container generic params. ,
Required: False ,
}
string ,
}
,
cloudId:
{
Description: Gets cloud Id in exception. ,
Required: False ,
}
string ,
hVHostId:
{
Description: Gets hyperV host ID. ,
Required: False ,
}
string ,
hVClusterId:
{
Description: Gets hyperV cluster Id. ,
Required: False ,
}
string ,
networkId:
{
Description: Gets network Id. ,
Required: False ,
}
string ,
vmId:
{
Description: Gets Vm Id. ,
Required: False ,
}
string ,
fabricId:
{
Description: Gets Fabric Id. ,
Required: False ,
}
string ,
liveId:
{
Description: Gets Live Id of the caller. ,
Required: False ,
}
string ,
containerId:
{
Description: Gets container Id of the caller. ,
Required: False ,
}
string ,
resourceId:
{
Description: Gets resource id used in the call. ,
Required: False ,
}
string ,
resourceName:
{
Description: Gets caller resource name. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Gets subscription Id. ,
Required: False ,
}
string ,
serializedSRSLogContext:
{
Description: Gets serialized SRS log context. ,
Required: False ,
}
string ,
}
,
}
,
startTime:
{
Description: The start time. ,
Required: False ,
}
string ,
endTime:
{
Description: The start time. ,
Required: False ,
}
string ,
}
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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 up to. ,
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 ,
]
,
}
,
}

⚐ 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: False ,
}
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: False ,
}
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: False ,
}
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 ,
}
,
}
,
status:
{
Description: The status of the Job. ARM expects the terminal status to be one of (1) Succeeded, (2) Failed or (3) Canceled. All other values imply that the operation is still running / being applied. ,
Required: False ,
}
string ,
error:
{
Description: The error. ,
Required: False ,
}
{
code:
{
Description: Gets HTTP status code for the error. ,
Required: False ,
}
string ,
message:
{
Description: Gets exception message. ,
Required: False ,
}
string ,
target:
{
Description: Gets exception target. ,
Required: False ,
}
string ,
details:
{
Description: Gets service based error details. ,
Required: False ,
}
[
{
code:
{
Description: Gets service error code. ,
Required: False ,
}
string ,
message:
{
Description: Gets error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets possible cause for error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets recommended action for the error. ,
Required: False ,
}
string ,
clientRequestId:
{
Description: Gets the client request Id for the session. ,
Required: False ,
}
string ,
activityId:
{
Description: Gets the activity Id for the session. ,
Required: False ,
}
string ,
target:
{
Description: Gets exception target. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: Gets private data for service debugging. ,
Required: False ,
}
{
trace:
{
Description: Gets complete stack trace of the exception. ,
Required: False ,
}
string ,
source:
{
Description: Gets exception source. ,
Required: False ,
}
string ,
methodStatus:
{
Description: Gets data related to method which threw the exception. ,
Required: False ,
}
{
isVirtual:
{
Description: Gets a value indicating whether called method was virtual ,
Required: False ,
}
string ,
parameters:
{
Description: Gets parameter list passed to method. ,
Required: False ,
}
[
string ,
]
,
containsGenericParameters:
{
Description: Gets a value indicating whether method container generic params. ,
Required: False ,
}
string ,
}
,
cloudId:
{
Description: Gets cloud Id in exception. ,
Required: False ,
}
string ,
hVHostId:
{
Description: Gets hyperV host ID. ,
Required: False ,
}
string ,
hVClusterId:
{
Description: Gets hyperV cluster Id. ,
Required: False ,
}
string ,
networkId:
{
Description: Gets network Id. ,
Required: False ,
}
string ,
vmId:
{
Description: Gets Vm Id. ,
Required: False ,
}
string ,
fabricId:
{
Description: Gets Fabric Id. ,
Required: False ,
}
string ,
liveId:
{
Description: Gets Live Id of the caller. ,
Required: False ,
}
string ,
containerId:
{
Description: Gets container Id of the caller. ,
Required: False ,
}
string ,
resourceId:
{
Description: Gets resource id used in the call. ,
Required: False ,
}
string ,
resourceName:
{
Description: Gets caller resource name. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Gets subscription Id. ,
Required: False ,
}
string ,
serializedSRSLogContext:
{
Description: Gets serialized SRS log context. ,
Required: False ,
}
string ,
}
,
}
,
startTime:
{
Description: The start time. ,
Required: False ,
}
string ,
endTime:
{
Description: The start time. ,
Required: False ,
}
string ,
}

⚐ 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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
$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: False ,
}
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: False ,
}
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: False ,
}
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 ,
}
,
}
,
status:
{
Description: The status of the Job. ARM expects the terminal status to be one of (1) Succeeded, (2) Failed or (3) Canceled. All other values imply that the operation is still running / being applied. ,
Required: False ,
}
string ,
error:
{
Description: The error. ,
Required: False ,
}
{
code:
{
Description: Gets HTTP status code for the error. ,
Required: False ,
}
string ,
message:
{
Description: Gets exception message. ,
Required: False ,
}
string ,
target:
{
Description: Gets exception target. ,
Required: False ,
}
string ,
details:
{
Description: Gets service based error details. ,
Required: False ,
}
[
{
code:
{
Description: Gets service error code. ,
Required: False ,
}
string ,
message:
{
Description: Gets error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets possible cause for error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets recommended action for the error. ,
Required: False ,
}
string ,
clientRequestId:
{
Description: Gets the client request Id for the session. ,
Required: False ,
}
string ,
activityId:
{
Description: Gets the activity Id for the session. ,
Required: False ,
}
string ,
target:
{
Description: Gets exception target. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: Gets private data for service debugging. ,
Required: False ,
}
{
trace:
{
Description: Gets complete stack trace of the exception. ,
Required: False ,
}
string ,
source:
{
Description: Gets exception source. ,
Required: False ,
}
string ,
methodStatus:
{
Description: Gets data related to method which threw the exception. ,
Required: False ,
}
{
isVirtual:
{
Description: Gets a value indicating whether called method was virtual ,
Required: False ,
}
string ,
parameters:
{
Description: Gets parameter list passed to method. ,
Required: False ,
}
[
string ,
]
,
containsGenericParameters:
{
Description: Gets a value indicating whether method container generic params. ,
Required: False ,
}
string ,
}
,
cloudId:
{
Description: Gets cloud Id in exception. ,
Required: False ,
}
string ,
hVHostId:
{
Description: Gets hyperV host ID. ,
Required: False ,
}
string ,
hVClusterId:
{
Description: Gets hyperV cluster Id. ,
Required: False ,
}
string ,
networkId:
{
Description: Gets network Id. ,
Required: False ,
}
string ,
vmId:
{
Description: Gets Vm Id. ,
Required: False ,
}
string ,
fabricId:
{
Description: Gets Fabric Id. ,
Required: False ,
}
string ,
liveId:
{
Description: Gets Live Id of the caller. ,
Required: False ,
}
string ,
containerId:
{
Description: Gets container Id of the caller. ,
Required: False ,
}
string ,
resourceId:
{
Description: Gets resource id used in the call. ,
Required: False ,
}
string ,
resourceName:
{
Description: Gets caller resource name. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Gets subscription Id. ,
Required: False ,
}
string ,
serializedSRSLogContext:
{
Description: Gets serialized SRS log context. ,
Required: False ,
}
string ,
}
,
}
,
startTime:
{
Description: The start time. ,
Required: False ,
}
string ,
endTime:
{
Description: The start time. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The value of next link. ,
Required: False ,
}
string ,
}
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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: False ,
}
string ,
}
,
healthErrorDetails:
{
Description: Fabric health error details. ,
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 ,
errorCode:
{
Description: Error code. ,
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 ,
childErrors:
{
Description: The child health errors. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
health:
{
Description: Health of fabric. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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: False ,
}
string ,
}
,
healthErrorDetails:
{
Description: Fabric health error details. ,
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 ,
errorCode:
{
Description: Error code. ,
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 ,
childErrors:
{
Description: The child health errors. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
fabricName:
{
Description: ASR fabric to delete ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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: False ,
}
string ,
}
,
healthErrorDetails:
{
Description: Fabric health error details. ,
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 ,
errorCode:
{
Description: Error code. ,
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 ,
childErrors:
{
Description: The child health errors. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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: 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: False ,
}
string ,
}
,
healthErrorDetails:
{
Description: Fabric health error details. ,
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 ,
errorCode:
{
Description: Error code. ,
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 ,
childErrors:
{
Description: The child health errors. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
fabricName:
{
Description: ASR fabric to purge. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 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: False ,
}
string ,
}
,
healthErrorDetails:
{
Description: Fabric health error details. ,
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 ,
errorCode:
{
Description: Error code. ,
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 ,
childErrors:
{
Description: The child health errors. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
health:
{
Description: Health of fabric. ,
Required: False ,
}
string ,
}
,
}
,
]
,
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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 ,
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: False ,
}
string ,
}
,
eventSpecificDetails:
{
Description: The event specific settings. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the class type. Overridden in derived classes. ,
Required: False ,
}
string ,
}
,
healthErrors:
{
Description: The list of errors / warnings capturing details associated with the issue(s). ,
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 ,
errorCode:
{
Description: Error code. ,
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 ,
childErrors:
{
Description: The child health errors. ,
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
$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 ,
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: False ,
}
string ,
}
,
eventSpecificDetails:
{
Description: The event specific settings. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the class type. Overridden in derived classes. ,
Required: False ,
}
string ,
}
,
healthErrors:
{
Description: The list of errors / warnings capturing details associated with the issue(s). ,
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 ,
errorCode:
{
Description: Error code. ,
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 ,
childErrors:
{
Description: The child health errors. ,
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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 ,
}
,
}
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 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 ,
}
ReplicationVaultHealth_Get (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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)

{
properties:
{
Description: The vault health related data. ,
Required: False ,
}
{
vaultErrors:
{
Description: The list of errors on the vault. ,
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 ,
errorCode:
{
Description: Error code. ,
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 ,
childErrors:
{
Description: The child health errors. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
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:
{
Replication: No description available. ,
TestFailover: No description available. ,
Configuration: 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 ,
]
,
}
,
]
,
}
,
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:
{
Replication: No description available. ,
TestFailover: No description available. ,
Configuration: 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 ,
]
,
}
,
]
,
}
,
}
,
}
ReplicationProtectedItems_ListByReplicationProtectionContainers (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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 ,
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 ,
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 ,
replicationHealthErrors:
{
Description: List of replication health errors. ,
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 ,
errorCode:
{
Description: Error code. ,
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 ,
childErrors:
{
Description: The child health errors. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
failoverHealthErrors:
{
Description: List of failover health errors. ,
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 ,
errorCode:
{
Description: Error code. ,
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 ,
childErrors:
{
Description: The child health errors. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
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: False ,
}
string ,
}
,
recoveryContainerId:
{
Description: The recovery container Id. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The value of next link. ,
Required: False ,
}
string ,
}
ReplicationProtectedItems_List (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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 ,
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 ,
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 ,
replicationHealthErrors:
{
Description: List of replication health errors. ,
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 ,
errorCode:
{
Description: Error code. ,
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 ,
childErrors:
{
Description: The child health errors. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
failoverHealthErrors:
{
Description: List of failover health errors. ,
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 ,
errorCode:
{
Description: Error code. ,
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 ,
childErrors:
{
Description: The child health errors. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
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: False ,
}
string ,
}
,
recoveryContainerId:
{
Description: The recovery container Id. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The value of next link. ,
Required: False ,
}
string ,
}
ReplicationNetworkMappings_List (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 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: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The value of next link. ,
Required: False ,
}
string ,
}
ReplicationNetworkMappings_ListByReplicationNetworks (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The value of next link. ,
Required: False ,
}
string ,
}
ReplicationFabrics_MigrateToAad (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
fabricName:
{
Description: ASR fabric to migrate. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
ReplicationFabrics_RenewCertificate (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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: False ,
}
string ,
}
,
healthErrorDetails:
{
Description: Fabric health error details. ,
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 ,
errorCode:
{
Description: Error code. ,
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 ,
childErrors:
{
Description: The child health errors. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
health:
{
Description: Health of fabric. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}
ReplicationvCenters_Get (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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 ,
}
,
}
ReplicationvCenters_Create (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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 ,
}
,
}

⚐ Response (202)

{}
ReplicationvCenters_Delete (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
fabricName:
{
Description: Fabric name. ,
Required: True ,
}
string ,
vCenterName:
{
Description: vCenter name. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
ReplicationvCenters_Update (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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 ,
}
,
}

⚐ Response (202)

{}
ReplicationvCenters_ListByReplicationFabrics (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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 ,
}
,
}
,
]
,
nextLink:
{
Description: The value of next link. ,
Required: False ,
}
string ,
}
ReplicationvCenters_List (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 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 ,
}
,
}
,
]
,
nextLink:
{
Description: The value of next link. ,
Required: False ,
}
string ,
}
ReplicationStorageClassificationMappings_Get (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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 (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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 (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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)

{}
ReplicationStorageClassificationMappings_ListByReplicationStorageClassifications (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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_List (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 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_Get (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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 ,
}
,
}
ReplicationStorageClassifications_ListByReplicationFabrics (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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_List (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 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 ,
}
ReplicationProtectedItems_ApplyRecoveryPoint (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
fabricName:
{
Description: The ARM fabric name. ,
Required: True ,
}
string ,
protectionContainerName:
{
Description: The protection container name. ,
Required: True ,
}
string ,
replicatedProtectedItemName:
{
Description: The replicated protected item's name. ,
Required: True ,
}
string ,
applyRecoveryPointInput:
{
Description: The ApplyRecoveryPointInput. ,
Required: True ,
}
{
properties:
{
Description: The input properties to apply recovery point. ,
Required: False ,
}
{
recoveryPointId:
{
Description: The recovery point Id. ,
Required: False ,
}
string ,
providerSpecificDetails:
{
Description: Provider specific input for applying recovery point. ,
Required: False ,
}
{
instanceType:
{
Description: The class type. ,
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 ,
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 ,
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 ,
replicationHealthErrors:
{
Description: List of replication health errors. ,
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 ,
errorCode:
{
Description: Error code. ,
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 ,
childErrors:
{
Description: The child health errors. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
failoverHealthErrors:
{
Description: List of failover health errors. ,
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 ,
errorCode:
{
Description: Error code. ,
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 ,
childErrors:
{
Description: The child health errors. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
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: False ,
}
string ,
}
,
recoveryContainerId:
{
Description: The recovery container Id. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}
ReplicationProtectedItems_RepairReplication (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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 ,
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 ,
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 ,
replicationHealthErrors:
{
Description: List of replication health errors. ,
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 ,
errorCode:
{
Description: Error code. ,
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 ,
childErrors:
{
Description: The child health errors. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
failoverHealthErrors:
{
Description: List of failover health errors. ,
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 ,
errorCode:
{
Description: Error code. ,
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 ,
childErrors:
{
Description: The child health errors. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
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: False ,
}
string ,
}
,
recoveryContainerId:
{
Description: The recovery container Id. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}
ReplicationProtectedItems_UpdateMobilityService (removed)
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/{replicationProtectedItemName}/updateMobilityService
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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 ,
replicationProtectedItemName:
{
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 ,
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 ,
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 ,
replicationHealthErrors:
{
Description: List of replication health errors. ,
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 ,
errorCode:
{
Description: Error code. ,
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 ,
childErrors:
{
Description: The child health errors. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
failoverHealthErrors:
{
Description: List of failover health errors. ,
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 ,
errorCode:
{
Description: Error code. ,
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 ,
childErrors:
{
Description: The child health errors. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
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: False ,
}
string ,
}
,
recoveryContainerId:
{
Description: The recovery container Id. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}
ReplicationProtectedItems_Reprotect (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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 ,
rrInput:
{
Description: Disable protection 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: 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 ,
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 ,
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 ,
replicationHealthErrors:
{
Description: List of replication health errors. ,
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 ,
errorCode:
{
Description: Error code. ,
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 ,
childErrors:
{
Description: The child health errors. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
failoverHealthErrors:
{
Description: List of failover health errors. ,
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 ,
errorCode:
{
Description: Error code. ,
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 ,
childErrors:
{
Description: The child health errors. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
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: False ,
}
string ,
}
,
recoveryContainerId:
{
Description: The recovery container Id. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}
ReplicationProtectedItems_FailoverCommit (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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 ,
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 ,
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 ,
replicationHealthErrors:
{
Description: List of replication health errors. ,
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 ,
errorCode:
{
Description: Error code. ,
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 ,
childErrors:
{
Description: The child health errors. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
failoverHealthErrors:
{
Description: List of failover health errors. ,
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 ,
errorCode:
{
Description: Error code. ,
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 ,
childErrors:
{
Description: The child health errors. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
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: False ,
}
string ,
}
,
recoveryContainerId:
{
Description: The recovery container Id. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}
ReplicationProtectedItems_TestFailoverCleanup (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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 ,
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 ,
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 ,
replicationHealthErrors:
{
Description: List of replication health errors. ,
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 ,
errorCode:
{
Description: Error code. ,
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 ,
childErrors:
{
Description: The child health errors. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
failoverHealthErrors:
{
Description: List of failover health errors. ,
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 ,
errorCode:
{
Description: Error code. ,
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 ,
childErrors:
{
Description: The child health errors. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
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: False ,
}
string ,
}
,
recoveryContainerId:
{
Description: The recovery container Id. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}
ReplicationProtectedItems_TestFailover (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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: Test failover input. ,
Required: True ,
}
{
properties:
{
Description: Planned failover input properties ,
Required: False ,
}
{
failoverDirection:
{
Description: 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 ,
skipTestFailoverCleanup:
{
Description: A value indicating whether the test failover cleanup is to be skipped. ,
Required: False ,
}
string ,
providerSpecificDetails:
{
Description: Provider specific settings ,
Required: False ,
}
{
instanceType:
{
Description: The class type. ,
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 ,
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 ,
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 ,
replicationHealthErrors:
{
Description: List of replication health errors. ,
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 ,
errorCode:
{
Description: Error code. ,
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 ,
childErrors:
{
Description: The child health errors. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
failoverHealthErrors:
{
Description: List of failover health errors. ,
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 ,
errorCode:
{
Description: Error code. ,
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 ,
childErrors:
{
Description: The child health errors. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
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: False ,
}
string ,
}
,
recoveryContainerId:
{
Description: The recovery container Id. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}
ReplicationProtectedItems_UnplannedFailover (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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: Disable protection input. ,
Required: True ,
}
{
properties:
{
Description: Planned failover input properties ,
Required: False ,
}
{
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: 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 ,
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 ,
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 ,
replicationHealthErrors:
{
Description: List of replication health errors. ,
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 ,
errorCode:
{
Description: Error code. ,
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 ,
childErrors:
{
Description: The child health errors. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
failoverHealthErrors:
{
Description: List of failover health errors. ,
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 ,
errorCode:
{
Description: Error code. ,
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 ,
childErrors:
{
Description: The child health errors. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
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: False ,
}
string ,
}
,
recoveryContainerId:
{
Description: The recovery container Id. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}
ReplicationProtectedItems_PlannedFailover (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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: Disable protection 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: 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 ,
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 ,
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 ,
replicationHealthErrors:
{
Description: List of replication health errors. ,
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 ,
errorCode:
{
Description: Error code. ,
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 ,
childErrors:
{
Description: The child health errors. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
failoverHealthErrors:
{
Description: List of failover health errors. ,
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 ,
errorCode:
{
Description: Error code. ,
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 ,
childErrors:
{
Description: The child health errors. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
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: False ,
}
string ,
}
,
recoveryContainerId:
{
Description: The recovery container Id. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}
ReplicationProtectedItems_Delete (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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: False ,
}
{
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: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
ReplicationProtectedItems_Get (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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 ,
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 ,
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 ,
replicationHealthErrors:
{
Description: List of replication health errors. ,
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 ,
errorCode:
{
Description: Error code. ,
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 ,
childErrors:
{
Description: The child health errors. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
failoverHealthErrors:
{
Description: List of failover health errors. ,
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 ,
errorCode:
{
Description: Error code. ,
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 ,
childErrors:
{
Description: The child health errors. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
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: False ,
}
string ,
}
,
recoveryContainerId:
{
Description: The recovery container Id. ,
Required: False ,
}
string ,
}
,
}
ReplicationProtectedItems_Create (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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: 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 ,
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 ,
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 ,
replicationHealthErrors:
{
Description: List of replication health errors. ,
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 ,
errorCode:
{
Description: Error code. ,
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 ,
childErrors:
{
Description: The child health errors. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
failoverHealthErrors:
{
Description: List of failover health errors. ,
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 ,
errorCode:
{
Description: Error code. ,
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 ,
childErrors:
{
Description: The child health errors. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
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: False ,
}
string ,
}
,
recoveryContainerId:
{
Description: The recovery container Id. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}
ReplicationProtectedItems_Purge (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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 (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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 ,
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 ,
recoveryVMSubnetName:
{
Description: Recovery VM subnet name. ,
Required: False ,
}
string ,
replicaNicStaticIPAddress:
{
Description: Replica nic static IP address. ,
Required: False ,
}
string ,
selectionType:
{
Description: Selection type for failover. ,
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: 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 ,
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 ,
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 ,
replicationHealthErrors:
{
Description: List of replication health errors. ,
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 ,
errorCode:
{
Description: Error code. ,
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 ,
childErrors:
{
Description: The child health errors. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
failoverHealthErrors:
{
Description: List of failover health errors. ,
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 ,
errorCode:
{
Description: Error code. ,
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 ,
childErrors:
{
Description: The child health errors. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
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: False ,
}
string ,
}
,
recoveryContainerId:
{
Description: The recovery container Id. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}
ReplicationRecoveryServicesProviders_RefreshProvider (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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 if the version is deprecated. ,
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 ,
}
[
{
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
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 ,
childErrors:
{
Description: The child health errors. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
draIdentifier:
{
Description: The DRA Id. ,
Required: False ,
}
string ,
identityDetails:
{
Description: The identity details. ,
Required: False ,
}
{
identityProviderType:
{
Description: The identity provider type. Value is the ToString() of a IdentityProviderType value. ,
Enum:
{
RecoveryServicesActiveDirectory: No description available. ,
CustomerActiveDirectory: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
certificateThumbprint:
{
Description: The certificate thumbprint. Applicable only if IdentityProviderType is RecoveryServicesActiveDirectory. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{}
ReplicationRecoveryServicesProviders_Delete (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
fabricName:
{
Description: Fabric name. ,
Required: True ,
}
string ,
providerName:
{
Description: Recovery services provider name. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
ReplicationRecoveryServicesProviders_Get (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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 if the version is deprecated. ,
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 ,
}
[
{
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
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 ,
childErrors:
{
Description: The child health errors. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
draIdentifier:
{
Description: The DRA Id. ,
Required: False ,
}
string ,
identityDetails:
{
Description: The identity details. ,
Required: False ,
}
{
identityProviderType:
{
Description: The identity provider type. Value is the ToString() of a IdentityProviderType value. ,
Enum:
{
RecoveryServicesActiveDirectory: No description available. ,
CustomerActiveDirectory: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
certificateThumbprint:
{
Description: The certificate thumbprint. Applicable only if IdentityProviderType is RecoveryServicesActiveDirectory. ,
Required: False ,
}
string ,
}
,
}
,
}
ReplicationRecoveryServicesProviders_Purge (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
fabricName:
{
Description: Fabric name. ,
Required: True ,
}
string ,
providerName:
{
Description: Recovery services provider name. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
ReplicationRecoveryServicesProviders_ListByReplicationFabrics (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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 if the version is deprecated. ,
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 ,
}
[
{
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
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 ,
childErrors:
{
Description: The child health errors. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
draIdentifier:
{
Description: The DRA Id. ,
Required: False ,
}
string ,
identityDetails:
{
Description: The identity details. ,
Required: False ,
}
{
identityProviderType:
{
Description: The identity provider type. Value is the ToString() of a IdentityProviderType value. ,
Enum:
{
RecoveryServicesActiveDirectory: No description available. ,
CustomerActiveDirectory: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
certificateThumbprint:
{
Description: The certificate thumbprint. Applicable only if IdentityProviderType is RecoveryServicesActiveDirectory. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The value of next link. ,
Required: False ,
}
string ,
}
ReplicationRecoveryServicesProviders_List (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 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 if the version is deprecated. ,
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 ,
}
[
{
errorSource:
{
Description: Source of error. ,
Required: False ,
}
string ,
errorType:
{
Description: Type of error. ,
Required: False ,
}
string ,
errorLevel:
{
Description: Level of error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
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 ,
childErrors:
{
Description: The child health errors. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
draIdentifier:
{
Description: The DRA Id. ,
Required: False ,
}
string ,
identityDetails:
{
Description: The identity details. ,
Required: False ,
}
{
identityProviderType:
{
Description: The identity provider type. Value is the ToString() of a IdentityProviderType value. ,
Enum:
{
RecoveryServicesActiveDirectory: No description available. ,
CustomerActiveDirectory: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
certificateThumbprint:
{
Description: The certificate thumbprint. Applicable only if IdentityProviderType is RecoveryServicesActiveDirectory. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The value of next link. ,
Required: False ,
}
string ,
}
RecoveryPoints_Get (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
fabricName:
{
Description: The fabric name. ,
Required: True ,
}
string ,
protectionContainerName:
{
Description: The protection container name. ,
Required: True ,
}
string ,
replicatedProtectedItemName:
{
Description: The replication protected item's name. ,
Required: True ,
}
string ,
recoveryPointName:
{
Description: The recovery point name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Recovery point related data. ,
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 ,
}
{
Type:
{
Description: Gets the provider type. ,
Required: False ,
}
string ,
}
,
}
,
}
RecoveryPoints_ListByReplicationProtectedItems (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
fabricName:
{
Description: The fabric name. ,
Required: True ,
}
string ,
protectionContainerName:
{
Description: The protection container name. ,
Required: True ,
}
string ,
replicatedProtectedItemName:
{
Description: The replication protected item's name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The recovery point details. ,
Required: False ,
}
[
{
properties:
{
Description: Recovery point related data. ,
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 ,
}
{
Type:
{
Description: Gets the provider type. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The value of next link. ,
Required: False ,
}
string ,
}
ReplicationRecoveryPlans_Reprotect (removed)
Description :  The operation to reprotect(reverse replicate) a recovery plan.
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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: False ,
}
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: False ,
}
string ,
}
,
}
,
]
,
}
,
]
,
}
,
}

⚐ Response (202)

{}
ReplicationRecoveryPlans_FailoverCommit (removed)
Description :  The operation to commit the fail over 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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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: False ,
}
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: False ,
}
string ,
}
,
}
,
]
,
}
,
]
,
}
,
}

⚐ Response (202)

{}
ReplicationRecoveryPlans_TestFailoverCleanup (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
recoveryPlanName:
{
Description: Recovery plan name. ,
Required: True ,
}
string ,
input:
{
Description: 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: False ,
}
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: False ,
}
string ,
}
,
}
,
]
,
}
,
]
,
}
,
}

⚐ Response (202)

{}
ReplicationRecoveryPlans_TestFailover (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
recoveryPlanName:
{
Description: Recovery plan name. ,
Required: True ,
}
string ,
input:
{
Description: 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 ,
skipTestFailoverCleanup:
{
Description: A value indicating whether the test failover cleanup is to be skipped. ,
Required: False ,
}
string ,
providerSpecificDetails:
{
Description: The provider specific properties. ,
Required: False ,
}
[
{
instanceType:
{
Description: The class type. ,
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: False ,
}
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: False ,
}
string ,
}
,
}
,
]
,
}
,
]
,
}
,
}

⚐ Response (202)

{}
ReplicationRecoveryPlans_UnplannedFailover (removed)
Description :  The operation to start the 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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
recoveryPlanName:
{
Description: Recovery plan name. ,
Required: True ,
}
string ,
input:
{
Description: 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: 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: False ,
}
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: False ,
}
string ,
}
,
}
,
]
,
}
,
]
,
}
,
}

⚐ Response (202)

{}
ReplicationRecoveryPlans_PlannedFailover (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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: 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: False ,
}
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: False ,
}
string ,
}
,
}
,
]
,
}
,
]
,
}
,
}

⚐ Response (202)

{}
ReplicationRecoveryPlans_Get (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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: False ,
}
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: False ,
}
string ,
}
,
}
,
]
,
}
,
]
,
}
,
}
ReplicationRecoveryPlans_Create (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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: False ,
}
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: 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: False ,
}
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: False ,
}
string ,
}
,
}
,
]
,
}
,
]
,
}
,
}

⚐ Response (202)

{}
ReplicationRecoveryPlans_Delete (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
recoveryPlanName:
{
Description: Recovery plan name. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
ReplicationRecoveryPlans_Update (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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: False ,
}
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: 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: False ,
}
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: False ,
}
string ,
}
,
}
,
]
,
}
,
]
,
}
,
}

⚐ Response (202)

{}
ReplicationRecoveryPlans_List (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 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: False ,
}
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: False ,
}
string ,
}
,
}
,
]
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The value of next link. ,
Required: False ,
}
string ,
}
ReplicationProtectionContainers_SwitchProtection (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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: 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 (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
fabricName:
{
Description: Unique fabric ARM name. ,
Required: True ,
}
string ,
protectionContainerName:
{
Description: Unique protection container ARM name. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
ReplicationProtectionContainers_DiscoverProtectableItem (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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_Get (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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 (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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: 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_ListByReplicationFabrics (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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_List (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 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 ,
}
ReplicationProtectionContainerMappings_Delete (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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)

{}
ReplicationProtectionContainerMappings_Get (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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: False ,
}
string ,
}
,
health:
{
Description: Health of pairing. ,
Required: False ,
}
string ,
healthErrorDetails:
{
Description: Health error. ,
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 ,
errorCode:
{
Description: Error code. ,
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 ,
childErrors:
{
Description: The child health errors. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
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 (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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: False ,
}
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: False ,
}
string ,
}
,
health:
{
Description: Health of pairing. ,
Required: False ,
}
string ,
healthErrorDetails:
{
Description: Health error. ,
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 ,
errorCode:
{
Description: Error code. ,
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 ,
childErrors:
{
Description: The child health errors. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
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 (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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_ListByReplicationProtectionContainers (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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: False ,
}
string ,
}
,
health:
{
Description: Health of pairing. ,
Required: False ,
}
string ,
healthErrorDetails:
{
Description: Health error. ,
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 ,
errorCode:
{
Description: Error code. ,
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 ,
childErrors:
{
Description: The child health errors. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
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_List (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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: 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: False ,
}
string ,
}
,
health:
{
Description: Health of pairing. ,
Required: False ,
}
string ,
healthErrorDetails:
{
Description: Health error. ,
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 ,
errorCode:
{
Description: Error code. ,
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 ,
childErrors:
{
Description: The child health errors. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
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 ,
}
ReplicationProtectableItems_Get (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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: False ,
}
string ,
}
,
}
,
}
ReplicationProtectableItems_ListByReplicationProtectionContainers (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
fabricName:
{
Description: Fabric name. ,
Required: True ,
}
string ,
protectionContainerName:
{
Description: Protection container name. ,
Required: True ,
}
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: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The value of next link. ,
Required: False ,
}
string ,
}
ReplicationPolicies_Get (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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: False ,
}
string ,
}
,
}
,
}
ReplicationPolicies_Create (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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: False ,
}
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: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{}
ReplicationPolicies_Delete (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
policyName:
{
Description: Replication policy name. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
ReplicationPolicies_Update (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
policyName:
{
Description: Protection profile Id. ,
Required: True ,
}
string ,
input:
{
Description: Update Protection Profile Input ,
Required: True ,
}
{
properties:
{
Description: The ReplicationProviderSettings. ,
Required: False ,
}
{
replicationProviderSettings:
{
Description: The ReplicationProviderSettings. ,
Required: False ,
}
{
instanceType:
{
Description: The class type. ,
Required: False ,
}
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: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{}
ReplicationPolicies_List (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 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: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The value of next link. ,
Required: False ,
}
string ,
}
Operations_List (removed)
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 ,
}
ReplicationNetworks_List (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 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_ListByReplicationFabrics (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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 (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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_Get (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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: False ,
}
string ,
}
,
}
,
}
ReplicationNetworkMappings_Create (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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: False ,
}
{
recoveryFabricName:
{
Description: Recovery fabric Name. ,
Required: False ,
}
string ,
recoveryNetworkId:
{
Description: Recovery network Id. ,
Required: False ,
}
string ,
fabricSpecificDetails:
{
Description: Fabric specific input properties. ,
Required: False ,
}
{
instanceType:
{
Description: The instance type. ,
Required: False ,
}
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: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{}
ReplicationNetworkMappings_Delete (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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 (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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: False ,
}
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: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{}
ReplicationLogicalNetworks_ListByReplicationFabrics (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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 (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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 ,
}
,
}
ReplicationJobs_Resume (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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: False ,
}
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: False ,
}
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: False ,
}
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 ,
}
,
}
,
status:
{
Description: The status of the Job. ARM expects the terminal status to be one of (1) Succeeded, (2) Failed or (3) Canceled. All other values imply that the operation is still running / being applied. ,
Required: False ,
}
string ,
error:
{
Description: The error. ,
Required: False ,
}
{
code:
{
Description: Gets HTTP status code for the error. ,
Required: False ,
}
string ,
message:
{
Description: Gets exception message. ,
Required: False ,
}
string ,
target:
{
Description: Gets exception target. ,
Required: False ,
}
string ,
details:
{
Description: Gets service based error details. ,
Required: False ,
}
[
{
code:
{
Description: Gets service error code. ,
Required: False ,
}
string ,
message:
{
Description: Gets error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets possible cause for error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets recommended action for the error. ,
Required: False ,
}
string ,
clientRequestId:
{
Description: Gets the client request Id for the session. ,
Required: False ,
}
string ,
activityId:
{
Description: Gets the activity Id for the session. ,
Required: False ,
}
string ,
target:
{
Description: Gets exception target. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: Gets private data for service debugging. ,
Required: False ,
}
{
trace:
{
Description: Gets complete stack trace of the exception. ,
Required: False ,
}
string ,
source:
{
Description: Gets exception source. ,
Required: False ,
}
string ,
methodStatus:
{
Description: Gets data related to method which threw the exception. ,
Required: False ,
}
{
isVirtual:
{
Description: Gets a value indicating whether called method was virtual ,
Required: False ,
}
string ,
parameters:
{
Description: Gets parameter list passed to method. ,
Required: False ,
}
[
string ,
]
,
containsGenericParameters:
{
Description: Gets a value indicating whether method container generic params. ,
Required: False ,
}
string ,
}
,
cloudId:
{
Description: Gets cloud Id in exception. ,
Required: False ,
}
string ,
hVHostId:
{
Description: Gets hyperV host ID. ,
Required: False ,
}
string ,
hVClusterId:
{
Description: Gets hyperV cluster Id. ,
Required: False ,
}
string ,
networkId:
{
Description: Gets network Id. ,
Required: False ,
}
string ,
vmId:
{
Description: Gets Vm Id. ,
Required: False ,
}
string ,
fabricId:
{
Description: Gets Fabric Id. ,
Required: False ,
}
string ,
liveId:
{
Description: Gets Live Id of the caller. ,
Required: False ,
}
string ,
containerId:
{
Description: Gets container Id of the caller. ,
Required: False ,
}
string ,
resourceId:
{
Description: Gets resource id used in the call. ,
Required: False ,
}
string ,
resourceName:
{
Description: Gets caller resource name. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Gets subscription Id. ,
Required: False ,
}
string ,
serializedSRSLogContext:
{
Description: Gets serialized SRS log context. ,
Required: False ,
}
string ,
}
,
}
,
startTime:
{
Description: The start time. ,
Required: False ,
}
string ,
endTime:
{
Description: The start time. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{}
ReplicationJobs_Restart (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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: False ,
}
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: False ,
}
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: False ,
}
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 ,
}
,
}
,
status:
{
Description: The status of the Job. ARM expects the terminal status to be one of (1) Succeeded, (2) Failed or (3) Canceled. All other values imply that the operation is still running / being applied. ,
Required: False ,
}
string ,
error:
{
Description: The error. ,
Required: False ,
}
{
code:
{
Description: Gets HTTP status code for the error. ,
Required: False ,
}
string ,
message:
{
Description: Gets exception message. ,
Required: False ,
}
string ,
target:
{
Description: Gets exception target. ,
Required: False ,
}
string ,
details:
{
Description: Gets service based error details. ,
Required: False ,
}
[
{
code:
{
Description: Gets service error code. ,
Required: False ,
}
string ,
message:
{
Description: Gets error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets possible cause for error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets recommended action for the error. ,
Required: False ,
}
string ,
clientRequestId:
{
Description: Gets the client request Id for the session. ,
Required: False ,
}
string ,
activityId:
{
Description: Gets the activity Id for the session. ,
Required: False ,
}
string ,
target:
{
Description: Gets exception target. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: Gets private data for service debugging. ,
Required: False ,
}
{
trace:
{
Description: Gets complete stack trace of the exception. ,
Required: False ,
}
string ,
source:
{
Description: Gets exception source. ,
Required: False ,
}
string ,
methodStatus:
{
Description: Gets data related to method which threw the exception. ,
Required: False ,
}
{
isVirtual:
{
Description: Gets a value indicating whether called method was virtual ,
Required: False ,
}
string ,
parameters:
{
Description: Gets parameter list passed to method. ,
Required: False ,
}
[
string ,
]
,
containsGenericParameters:
{
Description: Gets a value indicating whether method container generic params. ,
Required: False ,
}
string ,
}
,
cloudId:
{
Description: Gets cloud Id in exception. ,
Required: False ,
}
string ,
hVHostId:
{
Description: Gets hyperV host ID. ,
Required: False ,
}
string ,
hVClusterId:
{
Description: Gets hyperV cluster Id. ,
Required: False ,
}
string ,
networkId:
{
Description: Gets network Id. ,
Required: False ,
}
string ,
vmId:
{
Description: Gets Vm Id. ,
Required: False ,
}
string ,
fabricId:
{
Description: Gets Fabric Id. ,
Required: False ,
}
string ,
liveId:
{
Description: Gets Live Id of the caller. ,
Required: False ,
}
string ,
containerId:
{
Description: Gets container Id of the caller. ,
Required: False ,
}
string ,
resourceId:
{
Description: Gets resource id used in the call. ,
Required: False ,
}
string ,
resourceName:
{
Description: Gets caller resource name. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Gets subscription Id. ,
Required: False ,
}
string ,
serializedSRSLogContext:
{
Description: Gets serialized SRS log context. ,
Required: False ,
}
string ,
}
,
}
,
startTime:
{
Description: The start time. ,
Required: False ,
}
string ,
endTime:
{
Description: The start time. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{}
ReplicationJobs_Cancel (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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: False ,
}
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: False ,
}
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: False ,
}
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 ,
}
,
}
,
status:
{
Description: The status of the Job. ARM expects the terminal status to be one of (1) Succeeded, (2) Failed or (3) Canceled. All other values imply that the operation is still running / being applied. ,
Required: False ,
}
string ,
error:
{
Description: The error. ,
Required: False ,
}
{
code:
{
Description: Gets HTTP status code for the error. ,
Required: False ,
}
string ,
message:
{
Description: Gets exception message. ,
Required: False ,
}
string ,
target:
{
Description: Gets exception target. ,
Required: False ,
}
string ,
details:
{
Description: Gets service based error details. ,
Required: False ,
}
[
{
code:
{
Description: Gets service error code. ,
Required: False ,
}
string ,
message:
{
Description: Gets error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets possible cause for error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets recommended action for the error. ,
Required: False ,
}
string ,
clientRequestId:
{
Description: Gets the client request Id for the session. ,
Required: False ,
}
string ,
activityId:
{
Description: Gets the activity Id for the session. ,
Required: False ,
}
string ,
target:
{
Description: Gets exception target. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: Gets private data for service debugging. ,
Required: False ,
}
{
trace:
{
Description: Gets complete stack trace of the exception. ,
Required: False ,
}
string ,
source:
{
Description: Gets exception source. ,
Required: False ,
}
string ,
methodStatus:
{
Description: Gets data related to method which threw the exception. ,
Required: False ,
}
{
isVirtual:
{
Description: Gets a value indicating whether called method was virtual ,
Required: False ,
}
string ,
parameters:
{
Description: Gets parameter list passed to method. ,
Required: False ,
}
[
string ,
]
,
containsGenericParameters:
{
Description: Gets a value indicating whether method container generic params. ,
Required: False ,
}
string ,
}
,
cloudId:
{
Description: Gets cloud Id in exception. ,
Required: False ,
}
string ,
hVHostId:
{
Description: Gets hyperV host ID. ,
Required: False ,
}
string ,
hVClusterId:
{
Description: Gets hyperV cluster Id. ,
Required: False ,
}
string ,
networkId:
{
Description: Gets network Id. ,
Required: False ,
}
string ,
vmId:
{
Description: Gets Vm Id. ,
Required: False ,
}
string ,
fabricId:
{
Description: Gets Fabric Id. ,
Required: False ,
}
string ,
liveId:
{
Description: Gets Live Id of the caller. ,
Required: False ,
}
string ,
containerId:
{
Description: Gets container Id of the caller. ,
Required: False ,
}
string ,
resourceId:
{
Description: Gets resource id used in the call. ,
Required: False ,
}
string ,
resourceName:
{
Description: Gets caller resource name. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Gets subscription Id. ,
Required: False ,
}
string ,
serializedSRSLogContext:
{
Description: Gets serialized SRS log context. ,
Required: False ,
}
string ,
}
,
}
,
startTime:
{
Description: The start time. ,
Required: False ,
}
string ,
endTime:
{
Description: The start time. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{}
ReplicationJobs_Get (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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: False ,
}
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: False ,
}
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: False ,
}
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 ,
}
,
}
,
status:
{
Description: The status of the Job. ARM expects the terminal status to be one of (1) Succeeded, (2) Failed or (3) Canceled. All other values imply that the operation is still running / being applied. ,
Required: False ,
}
string ,
error:
{
Description: The error. ,
Required: False ,
}
{
code:
{
Description: Gets HTTP status code for the error. ,
Required: False ,
}
string ,
message:
{
Description: Gets exception message. ,
Required: False ,
}
string ,
target:
{
Description: Gets exception target. ,
Required: False ,
}
string ,
details:
{
Description: Gets service based error details. ,
Required: False ,
}
[
{
code:
{
Description: Gets service error code. ,
Required: False ,
}
string ,
message:
{
Description: Gets error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets possible cause for error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets recommended action for the error. ,
Required: False ,
}
string ,
clientRequestId:
{
Description: Gets the client request Id for the session. ,
Required: False ,
}
string ,
activityId:
{
Description: Gets the activity Id for the session. ,
Required: False ,
}
string ,
target:
{
Description: Gets exception target. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: Gets private data for service debugging. ,
Required: False ,
}
{
trace:
{
Description: Gets complete stack trace of the exception. ,
Required: False ,
}
string ,
source:
{
Description: Gets exception source. ,
Required: False ,
}
string ,
methodStatus:
{
Description: Gets data related to method which threw the exception. ,
Required: False ,
}
{
isVirtual:
{
Description: Gets a value indicating whether called method was virtual ,
Required: False ,
}
string ,
parameters:
{
Description: Gets parameter list passed to method. ,
Required: False ,
}
[
string ,
]
,
containsGenericParameters:
{
Description: Gets a value indicating whether method container generic params. ,
Required: False ,
}
string ,
}
,
cloudId:
{
Description: Gets cloud Id in exception. ,
Required: False ,
}
string ,
hVHostId:
{
Description: Gets hyperV host ID. ,
Required: False ,
}
string ,
hVClusterId:
{
Description: Gets hyperV cluster Id. ,
Required: False ,
}
string ,
networkId:
{
Description: Gets network Id. ,
Required: False ,
}
string ,
vmId:
{
Description: Gets Vm Id. ,
Required: False ,
}
string ,
fabricId:
{
Description: Gets Fabric Id. ,
Required: False ,
}
string ,
liveId:
{
Description: Gets Live Id of the caller. ,
Required: False ,
}
string ,
containerId:
{
Description: Gets container Id of the caller. ,
Required: False ,
}
string ,
resourceId:
{
Description: Gets resource id used in the call. ,
Required: False ,
}
string ,
resourceName:
{
Description: Gets caller resource name. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Gets subscription Id. ,
Required: False ,
}
string ,
serializedSRSLogContext:
{
Description: Gets serialized SRS log context. ,
Required: False ,
}
string ,
}
,
}
,
startTime:
{
Description: The start time. ,
Required: False ,
}
string ,
endTime:
{
Description: The start time. ,
Required: False ,
}
string ,
}
ReplicationJobs_Export (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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 up to. ,
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 ,
]
,
}
,
}

⚐ 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: False ,
}
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: False ,
}
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: False ,
}
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 ,
}
,
}
,
status:
{
Description: The status of the Job. ARM expects the terminal status to be one of (1) Succeeded, (2) Failed or (3) Canceled. All other values imply that the operation is still running / being applied. ,
Required: False ,
}
string ,
error:
{
Description: The error. ,
Required: False ,
}
{
code:
{
Description: Gets HTTP status code for the error. ,
Required: False ,
}
string ,
message:
{
Description: Gets exception message. ,
Required: False ,
}
string ,
target:
{
Description: Gets exception target. ,
Required: False ,
}
string ,
details:
{
Description: Gets service based error details. ,
Required: False ,
}
[
{
code:
{
Description: Gets service error code. ,
Required: False ,
}
string ,
message:
{
Description: Gets error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets possible cause for error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets recommended action for the error. ,
Required: False ,
}
string ,
clientRequestId:
{
Description: Gets the client request Id for the session. ,
Required: False ,
}
string ,
activityId:
{
Description: Gets the activity Id for the session. ,
Required: False ,
}
string ,
target:
{
Description: Gets exception target. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: Gets private data for service debugging. ,
Required: False ,
}
{
trace:
{
Description: Gets complete stack trace of the exception. ,
Required: False ,
}
string ,
source:
{
Description: Gets exception source. ,
Required: False ,
}
string ,
methodStatus:
{
Description: Gets data related to method which threw the exception. ,
Required: False ,
}
{
isVirtual:
{
Description: Gets a value indicating whether called method was virtual ,
Required: False ,
}
string ,
parameters:
{
Description: Gets parameter list passed to method. ,
Required: False ,
}
[
string ,
]
,
containsGenericParameters:
{
Description: Gets a value indicating whether method container generic params. ,
Required: False ,
}
string ,
}
,
cloudId:
{
Description: Gets cloud Id in exception. ,
Required: False ,
}
string ,
hVHostId:
{
Description: Gets hyperV host ID. ,
Required: False ,
}
string ,
hVClusterId:
{
Description: Gets hyperV cluster Id. ,
Required: False ,
}
string ,
networkId:
{
Description: Gets network Id. ,
Required: False ,
}
string ,
vmId:
{
Description: Gets Vm Id. ,
Required: False ,
}
string ,
fabricId:
{
Description: Gets Fabric Id. ,
Required: False ,
}
string ,
liveId:
{
Description: Gets Live Id of the caller. ,
Required: False ,
}
string ,
containerId:
{
Description: Gets container Id of the caller. ,
Required: False ,
}
string ,
resourceId:
{
Description: Gets resource id used in the call. ,
Required: False ,
}
string ,
resourceName:
{
Description: Gets caller resource name. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Gets subscription Id. ,
Required: False ,
}
string ,
serializedSRSLogContext:
{
Description: Gets serialized SRS log context. ,
Required: False ,
}
string ,
}
,
}
,
startTime:
{
Description: The start time. ,
Required: False ,
}
string ,
endTime:
{
Description: The start time. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{}
ReplicationJobs_List (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
$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: False ,
}
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: False ,
}
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: False ,
}
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 ,
}
,
}
,
status:
{
Description: The status of the Job. ARM expects the terminal status to be one of (1) Succeeded, (2) Failed or (3) Canceled. All other values imply that the operation is still running / being applied. ,
Required: False ,
}
string ,
error:
{
Description: The error. ,
Required: False ,
}
{
code:
{
Description: Gets HTTP status code for the error. ,
Required: False ,
}
string ,
message:
{
Description: Gets exception message. ,
Required: False ,
}
string ,
target:
{
Description: Gets exception target. ,
Required: False ,
}
string ,
details:
{
Description: Gets service based error details. ,
Required: False ,
}
[
{
code:
{
Description: Gets service error code. ,
Required: False ,
}
string ,
message:
{
Description: Gets error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets possible cause for error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets recommended action for the error. ,
Required: False ,
}
string ,
clientRequestId:
{
Description: Gets the client request Id for the session. ,
Required: False ,
}
string ,
activityId:
{
Description: Gets the activity Id for the session. ,
Required: False ,
}
string ,
target:
{
Description: Gets exception target. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: Gets private data for service debugging. ,
Required: False ,
}
{
trace:
{
Description: Gets complete stack trace of the exception. ,
Required: False ,
}
string ,
source:
{
Description: Gets exception source. ,
Required: False ,
}
string ,
methodStatus:
{
Description: Gets data related to method which threw the exception. ,
Required: False ,
}
{
isVirtual:
{
Description: Gets a value indicating whether called method was virtual ,
Required: False ,
}
string ,
parameters:
{
Description: Gets parameter list passed to method. ,
Required: False ,
}
[
string ,
]
,
containsGenericParameters:
{
Description: Gets a value indicating whether method container generic params. ,
Required: False ,
}
string ,
}
,
cloudId:
{
Description: Gets cloud Id in exception. ,
Required: False ,
}
string ,
hVHostId:
{
Description: Gets hyperV host ID. ,
Required: False ,
}
string ,
hVClusterId:
{
Description: Gets hyperV cluster Id. ,
Required: False ,
}
string ,
networkId:
{
Description: Gets network Id. ,
Required: False ,
}
string ,
vmId:
{
Description: Gets Vm Id. ,
Required: False ,
}
string ,
fabricId:
{
Description: Gets Fabric Id. ,
Required: False ,
}
string ,
liveId:
{
Description: Gets Live Id of the caller. ,
Required: False ,
}
string ,
containerId:
{
Description: Gets container Id of the caller. ,
Required: False ,
}
string ,
resourceId:
{
Description: Gets resource id used in the call. ,
Required: False ,
}
string ,
resourceName:
{
Description: Gets caller resource name. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Gets subscription Id. ,
Required: False ,
}
string ,
serializedSRSLogContext:
{
Description: Gets serialized SRS log context. ,
Required: False ,
}
string ,
}
,
}
,
startTime:
{
Description: The start time. ,
Required: False ,
}
string ,
endTime:
{
Description: The start time. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The value of next link. ,
Required: False ,
}
string ,
}
ReplicationFabrics_ReassociateGateway (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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: False ,
}
string ,
}
,
healthErrorDetails:
{
Description: Fabric health error details. ,
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 ,
errorCode:
{
Description: Error code. ,
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 ,
childErrors:
{
Description: The child health errors. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
health:
{
Description: Health of fabric. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}
ReplicationFabrics_CheckConsistency (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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: False ,
}
string ,
}
,
healthErrorDetails:
{
Description: Fabric health error details. ,
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 ,
errorCode:
{
Description: Error code. ,
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 ,
childErrors:
{
Description: The child health errors. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
health:
{
Description: Health of fabric. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}
ReplicationFabrics_Delete (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
fabricName:
{
Description: ASR fabric to delete ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
ReplicationFabrics_Get (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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: False ,
}
string ,
}
,
healthErrorDetails:
{
Description: Fabric health error details. ,
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 ,
errorCode:
{
Description: Error code. ,
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 ,
childErrors:
{
Description: The child health errors. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
health:
{
Description: Health of fabric. ,
Required: False ,
}
string ,
}
,
}
ReplicationFabrics_Create (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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: 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: False ,
}
string ,
}
,
healthErrorDetails:
{
Description: Fabric health error details. ,
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 ,
errorCode:
{
Description: Error code. ,
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 ,
childErrors:
{
Description: The child health errors. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
health:
{
Description: Health of fabric. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}
ReplicationFabrics_Purge (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
fabricName:
{
Description: ASR fabric to purge. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
ReplicationFabrics_List (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 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: False ,
}
string ,
}
,
healthErrorDetails:
{
Description: Fabric health error details. ,
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 ,
errorCode:
{
Description: Error code. ,
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 ,
childErrors:
{
Description: The child health errors. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
health:
{
Description: Health of fabric. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The value of next link. ,
Required: False ,
}
string ,
}
ReplicationEvents_Get (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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 ,
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: False ,
}
string ,
}
,
eventSpecificDetails:
{
Description: The event specific settings. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the class type. Overridden in derived classes. ,
Required: False ,
}
string ,
}
,
healthErrors:
{
Description: The list of errors / warnings capturing details associated with the issue(s). ,
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 ,
errorCode:
{
Description: Error code. ,
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 ,
childErrors:
{
Description: The child health errors. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}
ReplicationEvents_List (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
$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 ,
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: False ,
}
string ,
}
,
eventSpecificDetails:
{
Description: The event specific settings. ,
Required: False ,
}
{
instanceType:
{
Description: Gets the class type. Overridden in derived classes. ,
Required: False ,
}
string ,
}
,
healthErrors:
{
Description: The list of errors / warnings capturing details associated with the issue(s). ,
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 ,
errorCode:
{
Description: Error code. ,
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 ,
childErrors:
{
Description: The child health errors. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The value of next link. ,
Required: False ,
}
string ,
}
ReplicationAlertSettings_Get (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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 (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 ,
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 ,
}
,
}
ReplicationAlertSettings_List (removed)
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 ,
resourceName:
{
Description: The name of the recovery services vault. ,
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 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 ,
}