Azure Site Recovery Replication Recovery Services Providers API
The ReplicationRecoveryServicesProviders API from Azure Site Recovery — 5 operation(s) for replicationrecoveryservicesproviders.
The ReplicationRecoveryServicesProviders API from Azure Site Recovery — 5 operation(s) for replicationrecoveryservicesproviders.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/microsoft-azure-site-recovery:microsoft-azure-site-recovery-replicationrecoveryservicesproviders-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Microsoft Azure Site Recovery Replication Recovery Services…
version: '2026-11-01'
x-typespec-generated:
- emitter: '@azure-tools/typespec-autorest'
description: 'Operations tagged ReplicationRecoveryServicesProviders across 2 of this provider''s published API definitions: microsoft-azure-site-recovery-service-2026-11-01.json, microsoft-azure-site-recovery-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://management.azure.com
security:
- azure_auth:
- user_impersonation
tags:
- name: ReplicationRecoveryServicesProviders
paths:
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationRecoveryServicesProviders
: get:
operationId: ReplicationRecoveryServicesProviders_ListByReplicationFabrics
tags:
- ReplicationRecoveryServicesProviders
summary: Gets the list of registered recovery services providers for the fabric
description: Lists the registered recovery services providers for the specified fabric.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: resourceName
in: path
description: The name of the Vault
required: true
schema:
type: string
- name: fabricName
in: path
description: Fabric name.
required: true
schema:
type: string
responses:
'200':
description: Azure operation completed successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/RecoveryServicesProviderCollection'
x-ms-examples:
Gets the list of registered recovery services providers for the fabric.:
$ref: ./examples/ReplicationRecoveryServicesProviders_ListByReplicationFabrics.json
x-ms-pageable:
nextLinkName: nextLink
servers:
- url: https://management.azure.com
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationRecoveryServicesProviders/{providerName}
: get:
operationId: ReplicationRecoveryServicesProviders_Get
tags:
- ReplicationRecoveryServicesProviders
summary: Gets the details of a recovery services provider
description: Gets the details of registered recovery services provider.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: resourceName
in: path
description: The name of the Vault
required: true
schema:
type: string
- name: fabricName
in: path
description: Fabric name.
required: true
schema:
type: string
- name: providerName
in: path
description: Recovery services provider name.
required: true
schema:
type: string
responses:
'200':
description: Azure operation completed successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/RecoveryServicesProvider'
x-ms-examples:
Gets the details of a recovery services provider.:
$ref: ./examples/ReplicationRecoveryServicesProviders_Get.json
put:
operationId: ReplicationRecoveryServicesProviders_Create
tags:
- ReplicationRecoveryServicesProviders
summary: Adds a recovery services provider
description: The operation to add a recovery services provider.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: resourceName
in: path
description: The name of the Vault
required: true
schema:
type: string
- name: fabricName
in: path
description: Fabric name.
required: true
schema:
type: string
- name: providerName
in: path
description: Recovery services provider name.
required: true
schema:
type: string
responses:
'200':
description: Resource 'RecoveryServicesProvider' update operation succeeded
content:
application/json:
schema:
$ref: '#/components/schemas/RecoveryServicesProvider'
'202':
description: Resource operation accepted.
headers:
Location:
description: The Location header contains the URL where the status of the long running operation can be checked.
schema:
type: string
Retry-After:
description: The Retry-After header can indicate how long the client should wait before polling the operation status.
schema:
type: integer
format: int32
x-ms-examples:
Adds a recovery services provider.:
$ref: ./examples/ReplicationRecoveryServicesProviders_Create.json
x-ms-long-running-operation-options:
final-state-via: location
final-state-schema: '#/definitions/RecoveryServicesProvider'
x-ms-long-running-operation: true
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AddRecoveryServicesProviderInput'
description: Add provider input.
required: true
delete:
operationId: ReplicationRecoveryServicesProviders_Purge
tags:
- ReplicationRecoveryServicesProviders
summary: Purges recovery service provider from fabric
description: The operation to purge(force delete) a recovery services provider from the vault.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: resourceName
in: path
description: The name of the Vault
required: true
schema:
type: string
- name: fabricName
in: path
description: Fabric name.
required: true
schema:
type: string
- name: providerName
in: path
description: Recovery services provider name.
required: true
schema:
type: string
responses:
'202':
description: Resource deletion accepted.
headers:
Location:
description: The Location header contains the URL where the status of the long running operation can be checked.
schema:
type: string
Retry-After:
description: The Retry-After header can indicate how long the client should wait before polling the operation status.
schema:
type: integer
format: int32
'204':
description: Resource does not exist.
x-ms-examples:
Purges recovery service provider from fabric.:
$ref: ./examples/ReplicationRecoveryServicesProviders_Purge.json
x-ms-long-running-operation-options:
final-state-via: location
x-ms-long-running-operation: true
servers:
- url: https://management.azure.com
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationRecoveryServicesProviders/{providerName}/refreshProvider
: post:
operationId: ReplicationRecoveryServicesProviders_RefreshProvider
tags:
- ReplicationRecoveryServicesProviders
summary: Refresh details from the recovery services provider
description: The operation to refresh the information from the recovery services provider.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: resourceName
in: path
description: The name of the Vault
required: true
schema:
type: string
- name: fabricName
in: path
description: Fabric name.
required: true
schema:
type: string
- name: providerName
in: path
description: Recovery services provider name.
required: true
schema:
type: string
responses:
'200':
description: Azure operation completed successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/RecoveryServicesProvider'
'202':
description: Resource operation accepted.
headers:
Location:
description: The Location header contains the URL where the status of the long running operation can be checked.
schema:
type: string
Retry-After:
description: The Retry-After header can indicate how long the client should wait before polling the operation status.
schema:
type: integer
format: int32
x-ms-examples:
Refresh details from the recovery services provider.:
$ref: ./examples/ReplicationRecoveryServicesProviders_RefreshProvider.json
x-ms-long-running-operation-options:
final-state-via: location
final-state-schema: '#/definitions/RecoveryServicesProvider'
x-ms-long-running-operation: true
servers:
- url: https://management.azure.com
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationRecoveryServicesProviders/{providerName}/remove
: post:
operationId: ReplicationRecoveryServicesProviders_Delete
tags:
- ReplicationRecoveryServicesProviders
summary: Deletes provider from fabric.
description: The operation to removes/delete(unregister) a recovery services provider from the vault.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: resourceName
in: path
description: The name of the Vault
required: true
schema:
type: string
- name: fabricName
in: path
description: Fabric name.
required: true
schema:
type: string
- name: providerName
in: path
description: Recovery services provider name.
required: true
schema:
type: string
responses:
'202':
description: Resource operation accepted.
headers:
Location:
description: The Location header contains the URL where the status of the long running operation can be checked.
schema:
type: string
Retry-After:
description: The Retry-After header can indicate how long the client should wait before polling the operation status.
schema:
type: integer
format: int32
'204':
description: There is no content to send for this request, but the headers may be useful.
x-ms-examples:
? 'Deletes provider from fabric. Note: Deleting provider for any fabric other than SingleHost is unsupported. To maintain backward compatibility for released clients the object "deleteRspInput" is used (if the object is empty we assume that it is old client and continue the old behavior).'
: $ref: ./examples/ReplicationRecoveryServicesProviders_Delete.json
x-ms-long-running-operation-options:
final-state-via: location
x-ms-long-running-operation: true
servers:
- url: https://management.azure.com
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationRecoveryServicesProviders
: get:
operationId: ReplicationRecoveryServicesProviders_List
tags:
- ReplicationRecoveryServicesProviders
summary: Gets the list of registered recovery services providers in the vault.
description: Lists the registered recovery services providers in the vault.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: resourceName
in: path
description: The name of the recovery services vault.
required: true
schema:
type: string
responses:
'200':
description: The request has succeeded.
content:
application/json:
schema:
$ref: '#/components/schemas/RecoveryServicesProviderCollection'
x-ms-examples:
Gets the list of registered recovery services providers in the vault. This is a view only api.:
$ref: ./examples/ReplicationRecoveryServicesProviders_List.json
x-ms-pageable:
nextLinkName: nextLink
servers:
- url: https://management.azure.com
components:
schemas:
RecoveryServicesProviderCollection:
type: object
description: Collection of providers.
properties:
value:
type: array
description: The RecoveryServicesProvider items on this page
items:
$ref: '#/components/schemas/RecoveryServicesProvider'
nextLink:
type: string
format: uri
description: The link to the next page of items
required:
- value
RecoveryServicesProvider:
type: object
description: Provider details.
properties:
properties:
$ref: '#/components/schemas/RecoveryServicesProviderProperties'
description: Provider properties.
location:
type: string
description: Resource Location
allOf:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
IdentityProviderDetails:
type: object
description: Identity provider details.
properties:
tenantId:
type: string
description: The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services.
applicationId:
type: string
description: The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services.
objectId:
type: string
description: The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services.
audience:
type: string
description: The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services.
aadAuthority:
type: string
description: The base authority for Azure Active Directory authentication.
VersionDetails:
type: object
description: Version related details.
properties:
version:
type: string
description: The agent version.
expiryDate:
type: string
format: date-time
description: Version expiry date.
status:
$ref: '#/components/schemas/AgentVersionStatus'
description: A value indicating whether security update required.
InnerHealthError:
type: object
description: Implements InnerHealthError class. HealthError object has a list of InnerHealthErrors as child errors. InnerHealthError is used because this will prevent an infinite loop of structures when Hydra tries to auto-generate the contract. We are exposing the related health errors as inner health errors and all API consumers can utilize this in the same fashion as Exception -> InnerException.
properties:
errorSource:
type: string
description: Source of error.
errorType:
type: string
description: Type of error.
errorLevel:
type: string
description: Level of error.
errorCategory:
type: string
description: Category of error.
errorCode:
type: string
description: Error code.
summaryMessage:
type: string
description: Summary message of the entity.
errorMessage:
type: string
description: Error message.
possibleCauses:
type: string
description: Possible causes of error.
recommendedAction:
type: string
description: Recommended action to resolve error.
creationTimeUtc:
type: string
format: date-time
description: Error creation time (UTC).
recoveryProviderErrorMessage:
type: string
description: DRA error message.
entityId:
type: string
description: ID of the entity.
errorId:
type: string
description: The health error unique id.
customerResolvability:
$ref: '#/components/schemas/HealthErrorCustomerResolvability'
description: Value indicating whether the health error is customer resolvable.
AddRecoveryServicesProviderInput:
type: object
description: Input required to add a provider.
properties:
properties:
$ref: '#/components/schemas/AddRecoveryServicesProviderInputProperties'
description: The properties of an add provider request.
required:
- properties
AddRecoveryServicesProviderInputProperties:
type: object
description: The properties of an add provider request.
properties:
machineName:
type: string
description: The name of the machine where the provider is getting added.
machineId:
type: string
description: The Id of the machine where the provider is getting added.
biosId:
type: string
description: The Bios Id of the machine.
authenticationIdentityInput:
$ref: '#/components/schemas/IdentityProviderInput'
description: The identity provider input for DRA authentication.
resourceAccessIdentityInput:
$ref: '#/components/schemas/IdentityProviderInput'
description: The identity provider input for resource access.
dataPlaneAuthenticationIdentityInput:
$ref: '#/components/schemas/IdentityProviderInput'
description: The identity provider input for data plane authentication.
required:
- machineName
- authenticationIdentityInput
- resourceAccessIdentityInput
AgentVersionStatus:
type: string
description: A value indicating whether security update required.
enum:
- Supported
- NotSupported
- Deprecated
- UpdateRequired
- SecurityUpdateRequired
x-ms-enum:
name: AgentVersionStatus
modelAsString: true
values:
- name: Supported
value: Supported
description: Supported
- name: NotSupported
value: NotSupported
description: NotSupported
- name: Deprecated
value: Deprecated
description: Deprecated
- name: UpdateRequired
value: UpdateRequired
description: UpdateRequired
- name: SecurityUpdateRequired
value: SecurityUpdateRequired
description: SecurityUpdateRequired
HealthErrorCustomerResolvability:
type: string
description: Value indicating whether the health error is customer resolvable.
enum:
- Allowed
- NotAllowed
x-ms-enum:
name: HealthErrorCustomerResolvability
modelAsString: true
values:
- name: Allowed
value: Allowed
description: Allowed
- name: NotAllowed
value: NotAllowed
description: NotAllowed
IdentityProviderInput:
type: object
description: Identity provider input.
properties:
tenantId:
type: string
description: The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services.
applicationId:
type: string
description: The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services.
objectId:
type: string
description: The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services.
audience:
type: string
description: The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services.
aadAuthority:
type: string
description: The base authority for Azure Active Directory authentication.
required:
- tenantId
- applicationId
- objectId
- audience
- aadAuthority
RecoveryServicesProviderProperties:
type: object
description: Recovery services provider properties.
properties:
fabricType:
type: string
description: Type of the site.
friendlyName:
type: string
description: Friendly name of the DRA.
providerVersion:
type: string
description: The provider version.
serverVersion:
type: string
description: The fabric provider.
providerVersionState:
type: string
description: DRA version status.
providerVersionExpiryDate:
type: string
format: date-time
description: Expiry date of the version.
fabricFriendlyName:
type: string
description: The fabric friendly name.
lastHeartBeat:
type: string
format: date-time
description: Time when last heartbeat was sent by the DRA.
connectionStatus:
type: string
description: A value indicating whether DRA is responsive.
protectedItemCount:
type: integer
format: int32
description: Number of protected VMs currently managed by the DRA.
allowedScenarios:
type: array
description: The scenarios allowed on this provider.
items:
type: string
healthErrorDetails:
type: array
description: The recovery services provider health error details.
items:
$ref: '#/components/schemas/HealthError'
draIdentifier:
type: string
description: The DRA Id.
machineId:
type: string
description: The machine Id.
machineName:
type: string
description: The machine name.
biosId:
type: string
description: The Bios Id.
authenticationIdentityDetails:
$ref: '#/components/schemas/IdentityProviderDetails'
description: The authentication identity details.
resourceAccessIdentityDetails:
$ref: '#/components/schemas/IdentityProviderDetails'
description: The resource access identity details.
dataPlaneAuthenticationIdentityDetails:
$ref: '#/components/schemas/IdentityProviderDetails'
description: The data plane authentication identity details.
providerVersionDetails:
$ref: '#/components/schemas/VersionDetails'
description: The provider version details.
HealthError:
type: object
description: Health Error.
properties:
innerHealthErrors:
type: array
description: The inner health errors. HealthError having a list of HealthError as child errors is problematic. InnerHealthError is used because this will prevent an infinite loop of structures when Hydra tries to auto-generate the contract. We are exposing the related health errors as inner health errors and all API consumers can utilize this in the same fashion as Exception -> InnerException.
items:
$ref: '#/components/schemas/InnerHealthError'
errorSource:
type: string
description: Source of error.
errorType:
type: string
description: Type of error.
errorLevel:
type: string
description: Level of error.
errorCategory:
type: string
description: Category of error.
errorCode:
type: string
description: Error code.
summaryMessage:
type: string
description: Summary message of the entity.
errorMessage:
type: string
description: Error message.
possibleCauses:
type: string
description: Possible causes of error.
recommendedAction:
type: string
description: Recommended action to resolve error.
creationTimeUtc:
type: string
format: date-time
description: Error creation time (UTC).
recoveryProviderErrorMessage:
type: string
description: DRA error message.
entityId:
type: string
description: ID of the entity.
errorId:
type: string
description: The health error unique id.
customerResolvability:
$ref: '#/components/schemas/HealthErrorCustomerResolvability'
description: Value indicating whether the health error is customer resolvable.
securitySchemes:
azure_auth:
type: oauth2
flows:
implicit:
scopes:
user_impersonation: impersonate your user account
authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
description: Azure Active Directory OAuth2 Flow.
x-refined-from:
- microsoft-azure-site-recovery-service-2026-11-01.json
- microsoft-azure-site-recovery-openapi.yml