Microsoft Azure ReplicationRecoveryServicesProviders API

openapi: 3.2.0
info:
  version: '2023-06-01'
  title: Microsoft Azure SiteRecoveryManagementClient Replication…
  x-ms-code-generation-settings:
    header: MICROSOFT_MIT_NO_VERSION
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:
      tags:
      - ReplicationRecoveryServicesProviders
      summary: Microsoft Azure Gets The List Of Registered Recovery Services Providers For The…
      description: Lists the registered recovery services providers for the specified fabric.
      operationId: microsoftAzureReplicationrecoveryservicesprovidersListbyreplicationfabrics
      parameters:
      - $ref: '#/components/parameters/ApiVersion'
      - $ref: '#/components/parameters/ResourceName'
      - $ref: '#/components/parameters/ResourceGroupName'
      - $ref: '#/components/parameters/SubscriptionId'
      - name: fabricName
        in: path
        description: Fabric name.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecoveryServicesProviderCollection'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        Gets the list of registered recovery services providers for the fabric.:
          $ref: ./examples/ReplicationRecoveryServicesProviders_ListByReplicationFabrics.json
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationRecoveryServicesProviders/{providerName}
  : get:
      tags:
      - ReplicationRecoveryServicesProviders
      summary: Microsoft Azure Gets The Details Of A Recovery Services Provider
      description: Gets the details of registered recovery services provider.
      operationId: microsoftAzureReplicationrecoveryservicesprovidersGet
      parameters:
      - $ref: '#/components/parameters/ApiVersion'
      - $ref: '#/components/parameters/ResourceName'
      - $ref: '#/components/parameters/ResourceGroupName'
      - $ref: '#/components/parameters/SubscriptionId'
      - 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: OK
          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:
      tags:
      - ReplicationRecoveryServicesProviders
      summary: Microsoft Azure Adds A Recovery Services Provider
      description: The operation to add a recovery services provider.
      operationId: microsoftAzureReplicationrecoveryservicesprovidersCreate
      parameters:
      - $ref: '#/components/parameters/ApiVersion'
      - $ref: '#/components/parameters/ResourceName'
      - $ref: '#/components/parameters/ResourceGroupName'
      - $ref: '#/components/parameters/SubscriptionId'
      - 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: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecoveryServicesProvider'
        '202':
          description: Accepted
      x-ms-long-running-operation: true
      x-ms-examples:
        Adds a recovery services provider.:
          $ref: ./examples/ReplicationRecoveryServicesProviders_Create.json
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddRecoveryServicesProviderInput'
        description: Add provider input.
        required: true
    delete:
      tags:
      - ReplicationRecoveryServicesProviders
      summary: Microsoft Azure Purges Recovery Service Provider From Fabric
      description: The operation to purge(force delete) a recovery services provider from the vault.
      operationId: microsoftAzureReplicationrecoveryservicesprovidersPurge
      parameters:
      - $ref: '#/components/parameters/ApiVersion'
      - $ref: '#/components/parameters/ResourceName'
      - $ref: '#/components/parameters/ResourceGroupName'
      - $ref: '#/components/parameters/SubscriptionId'
      - 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: Accepted
        '204':
          description: NoContent
      x-ms-long-running-operation: true
      x-ms-examples:
        Purges recovery service provider from fabric.:
          $ref: ./examples/ReplicationRecoveryServicesProviders_Purge.json
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationRecoveryServicesProviders/{providerName}/refreshProvider
  : post:
      tags:
      - ReplicationRecoveryServicesProviders
      summary: Microsoft Azure Refresh Details From The Recovery Services Provider
      description: The operation to refresh the information from the recovery services provider.
      operationId: microsoftAzureReplicationrecoveryservicesprovidersRefreshprovider
      parameters:
      - $ref: '#/components/parameters/ApiVersion'
      - $ref: '#/components/parameters/ResourceName'
      - $ref: '#/components/parameters/ResourceGroupName'
      - $ref: '#/components/parameters/SubscriptionId'
      - 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: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecoveryServicesProvider'
        '202':
          description: Accepted
      x-ms-long-running-operation: true
      x-ms-examples:
        Refresh details from the recovery services provider.:
          $ref: ./examples/ReplicationRecoveryServicesProviders_RefreshProvider.json
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationRecoveryServicesProviders/{providerName}/remove
  : post:
      tags:
      - ReplicationRecoveryServicesProviders
      summary: 'Microsoft Azure Deletes Provider From Fabric Note: Deleting Provider For Any…'
      description: The operation to removes/delete(unregister) a recovery services provider from the vault.
      operationId: microsoftAzureReplicationrecoveryservicesprovidersDelete
      parameters:
      - $ref: '#/components/parameters/ApiVersion'
      - $ref: '#/components/parameters/ResourceName'
      - $ref: '#/components/parameters/ResourceGroupName'
      - $ref: '#/components/parameters/SubscriptionId'
      - 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: Accepted
        '204':
          description: NoContent
      x-ms-long-running-operation: true
      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
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationRecoveryServicesProviders
  : get:
      tags:
      - ReplicationRecoveryServicesProviders
      summary: Microsoft Azure Gets The List Of Registered Recovery Services Providers In The…
      description: Lists the registered recovery services providers in the vault.
      operationId: microsoftAzureReplicationrecoveryservicesprovidersList
      parameters:
      - $ref: '#/components/parameters/ApiVersion'
      - $ref: '#/components/parameters/ResourceName'
      - $ref: '#/components/parameters/ResourceGroupName'
      - $ref: '#/components/parameters/SubscriptionId'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecoveryServicesProviderCollection'
      x-ms-pageable:
        nextLinkName: nextLink
      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
components:
  schemas:
    RecoveryServicesProviderCollection:
      description: Collection of providers.
      type: object
      properties:
        value:
          description: The Servers details.
          type: array
          items:
            $ref: '#/components/schemas/RecoveryServicesProvider'
        nextLink:
          description: The value of next link.
          type: string
    IdentityProviderDetails:
      description: Identity provider details.
      type: object
      properties:
        tenantId:
          description: The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services.
          type: 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.
          type: 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.
          type: 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.
          type: string
        aadAuthority:
          description: The base authority for Azure Active Directory authentication.
          type: string
    InnerHealthError:
      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.
      type: object
      properties:
        errorSource:
          description: Source of error.
          type: string
        errorType:
          description: Type of error.
          type: string
        errorLevel:
          description: Level of error.
          type: string
        errorCategory:
          description: Category of error.
          type: string
        errorCode:
          description: Error code.
          type: string
        summaryMessage:
          description: Summary message of the entity.
          type: string
        errorMessage:
          description: Error message.
          type: string
        possibleCauses:
          description: Possible causes of error.
          type: string
        recommendedAction:
          description: Recommended action to resolve error.
          type: string
        creationTimeUtc:
          format: date-time
          description: Error creation time (UTC).
          type: string
        recoveryProviderErrorMessage:
          description: DRA error message.
          type: string
        entityId:
          description: ID of the entity.
          type: string
        errorId:
          description: The health error unique id.
          type: string
        customerResolvability:
          description: Value indicating whether the health error is customer resolvable.
          enum:
          - Allowed
          - NotAllowed
          type: string
          x-ms-enum:
            name: HealthErrorCustomerResolvability
            modelAsString: true
    HealthError:
      description: Health Error.
      type: object
      properties:
        innerHealthErrors:
          description: The inner health errors. HealthError having a list of HealthError as child errors is problematic. InnerHealthError is used because this will prevent an infinite loop of structures when Hydra tries to auto-generate the contract. We are exposing the related health errors as inner health errors and all API consumers can utilize this in the same fashion as Exception -> InnerException.
          type: array
          items:
            $ref: '#/components/schemas/InnerHealthError'
        errorSource:
          description: Source of error.
          type: string
        errorType:
          description: Type of error.
          type: string
        errorLevel:
          description: Level of error.
          type: string
        errorCategory:
          description: Category of error.
          type: string
        errorCode:
          description: Error code.
          type: string
        summaryMessage:
          description: Summary message of the entity.
          type: string
        errorMessage:
          description: Error message.
          type: string
        possibleCauses:
          description: Possible causes of error.
          type: string
        recommendedAction:
          description: Recommended action to resolve error.
          type: string
        creationTimeUtc:
          format: date-time
          description: Error creation time (UTC).
          type: string
        recoveryProviderErrorMessage:
          description: DRA error message.
          type: string
        entityId:
          description: ID of the entity.
          type: string
        errorId:
          description: The health error unique id.
          type: string
        customerResolvability:
          description: Value indicating whether the health error is customer resolvable.
          enum:
          - Allowed
          - NotAllowed
          type: string
          x-ms-enum:
            name: HealthErrorCustomerResolvability
            modelAsString: true
    AddRecoveryServicesProviderInput:
      description: Input required to add a provider.
      required:
      - properties
      type: object
      properties:
        properties:
          $ref: '#/components/schemas/AddRecoveryServicesProviderInputProperties'
          description: The properties of an add provider request.
    AddRecoveryServicesProviderInputProperties:
      description: The properties of an add provider request.
      required:
      - machineName
      - authenticationIdentityInput
      - resourceAccessIdentityInput
      type: object
      properties:
        machineName:
          description: The name of the machine where the provider is getting added.
          type: string
        machineId:
          description: The Id of the machine where the provider is getting added.
          type: string
        biosId:
          description: The Bios Id of the machine.
          type: string
        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.
    RecoveryServicesProvider:
      description: Provider details.
      type: object
      allOf:
      - $ref: '#/components/schemas/Resource'
      properties:
        properties:
          $ref: '#/components/schemas/RecoveryServicesProviderProperties'
          description: Provider properties.
    IdentityProviderInput:
      description: Identity provider input.
      required:
      - tenantId
      - applicationId
      - objectId
      - audience
      - aadAuthority
      type: object
      properties:
        tenantId:
          description: The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services.
          type: 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.
          type: 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.
          type: 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.
          type: string
        aadAuthority:
          description: The base authority for Azure Active Directory authentication.
          type: string
    RecoveryServicesProviderProperties:
      description: Recovery services provider properties.
      type: object
      properties:
        fabricType:
          description: Type of the site.
          type: string
        friendlyName:
          description: Friendly name of the DRA.
          type: string
        providerVersion:
          description: The provider version.
          type: string
        serverVersion:
          description: The fabric provider.
          type: string
        providerVersionState:
          description: DRA version status.
          type: string
        providerVersionExpiryDate:
          format: date-time
          description: Expiry date of the version.
          type: string
        fabricFriendlyName:
          description: The fabric friendly name.
          type: string
        lastHeartBeat:
          format: date-time
          description: Time when last heartbeat was sent by the DRA.
          type: string
        connectionStatus:
          description: A value indicating whether DRA is responsive.
          type: string
        protectedItemCount:
          format: int32
          description: Number of protected VMs currently managed by the DRA.
          type: integer
        allowedScenarios:
          description: The scenarios allowed on this provider.
          type: array
          items:
            type: string
        healthErrorDetails:
          description: The recovery services provider health error details.
          type: array
          items:
            $ref: '#/components/schemas/HealthError'
        draIdentifier:
          description: The DRA Id.
          type: string
        machineId:
          description: The machine Id.
          type: string
        machineName:
          description: The machine name.
          type: string
        biosId:
          description: The Bios Id.
          type: string
        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.
    Resource:
      description: Azure resource.
      type: object
      properties:
        id:
          description: Resource Id
          type: string
          readOnly: true
        name:
          description: Resource Name
          type: string
          readOnly: true
        type:
          description: Resource Type
          type: string
          readOnly: true
        location:
          description: Resource Location
          type: string
      x-ms-azure-resource: true
    VersionDetails:
      description: Version related details.
      type: object
      properties:
        version:
          description: The agent version.
          type: string
        expiryDate:
          format: date-time
          description: Version expiry date.
          type: string
        status:
          description: A value indicating whether security update required.
          enum:
          - Supported
          - NotSupported
          - Deprecated
          - UpdateRequired
          - SecurityUpdateRequired
          type: string
          x-ms-enum:
            name: AgentVersionStatus
            modelAsString: true
  parameters:
    ResourceGroupName:
      name: resourceGroupName
      in: path
      description: The name of the resource group where the recovery services vault is present.
      required: true
      x-ms-parameter-location: client
      schema:
        type: string
    ResourceName:
      name: resourceName
      in: path
      description: The name of the recovery services vault.
      required: true
      x-ms-parameter-location: client
      schema:
        type: string
    ApiVersion:
      name: api-version
      in: query
      description: Client Api Version.
      required: true
      schema:
        type: string
    SubscriptionId:
      name: subscriptionId
      in: path
      description: The subscription Id.
      required: true
      schema:
        type: string
  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