Microsoft Azure ReplicationRecoveryServicesProviders API

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector ReplicationRecoveryServicesProviders API
schemes:
- https
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 Fabric
      description: Lists the registered recovery services providers for the specified fabric.
      operationId: microsoftAzureReplicationrecoveryservicesprovidersListbyreplicationfabrics
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/ApiVersion'
      - $ref: '#/parameters/ResourceName'
      - $ref: '#/parameters/ResourceGroupName'
      - $ref: '#/parameters/SubscriptionId'
      - name: fabricName
        in: path
        description: Fabric name.
        required: true
        type: string
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/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
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/ApiVersion'
      - $ref: '#/parameters/ResourceName'
      - $ref: '#/parameters/ResourceGroupName'
      - $ref: '#/parameters/SubscriptionId'
      - name: fabricName
        in: path
        description: Fabric name.
        required: true
        type: string
      - name: providerName
        in: path
        description: Recovery services provider name.
        required: true
        type: string
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/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
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/ApiVersion'
      - $ref: '#/parameters/ResourceName'
      - $ref: '#/parameters/ResourceGroupName'
      - $ref: '#/parameters/SubscriptionId'
      - name: fabricName
        in: path
        description: Fabric name.
        required: true
        type: string
      - name: providerName
        in: path
        description: Recovery services provider name.
        required: true
        type: string
      - name: addProviderInput
        in: body
        description: Add provider input.
        required: true
        schema:
          $ref: '#/definitions/AddRecoveryServicesProviderInput'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/RecoveryServicesProvider'
        '202':
          description: Accepted
      x-ms-long-running-operation: true
      x-ms-examples:
        Adds a recovery services provider.:
          $ref: ./examples/ReplicationRecoveryServicesProviders_Create.json
    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: '#/parameters/ApiVersion'
      - $ref: '#/parameters/ResourceName'
      - $ref: '#/parameters/ResourceGroupName'
      - $ref: '#/parameters/SubscriptionId'
      - name: fabricName
        in: path
        description: Fabric name.
        required: true
        type: string
      - name: providerName
        in: path
        description: Recovery services provider name.
        required: true
        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
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/ApiVersion'
      - $ref: '#/parameters/ResourceName'
      - $ref: '#/parameters/ResourceGroupName'
      - $ref: '#/parameters/SubscriptionId'
      - name: fabricName
        in: path
        description: Fabric name.
        required: true
        type: string
      - name: providerName
        in: path
        description: Recovery services provider name.
        required: true
        type: string
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/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 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'
      description: The operation to removes/delete(unregister) a recovery services provider from the vault.
      operationId: microsoftAzureReplicationrecoveryservicesprovidersDelete
      parameters:
      - $ref: '#/parameters/ApiVersion'
      - $ref: '#/parameters/ResourceName'
      - $ref: '#/parameters/ResourceGroupName'
      - $ref: '#/parameters/SubscriptionId'
      - name: fabricName
        in: path
        description: Fabric name.
        required: true
        type: string
      - name: providerName
        in: path
        description: Recovery services provider name.
        required: true
        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 Vault This Is A View Only Api
      description: Lists the registered recovery services providers in the vault.
      operationId: microsoftAzureReplicationrecoveryservicesprovidersList
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/ApiVersion'
      - $ref: '#/parameters/ResourceName'
      - $ref: '#/parameters/ResourceGroupName'
      - $ref: '#/parameters/SubscriptionId'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/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
definitions:
  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
  AddRecoveryServicesProviderInput:
    description: Input required to add a provider.
    required:
    - properties
    type: object
    properties:
      properties:
        $ref: '#/definitions/AddRecoveryServicesProviderInputProperties'
        description: The properties of an add provider request.
  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
  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: '#/definitions/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: '#/definitions/IdentityProviderDetails'
        description: The authentication identity details.
      resourceAccessIdentityDetails:
        $ref: '#/definitions/IdentityProviderDetails'
        description: The resource access identity details.
      dataPlaneAuthenticationIdentityDetails:
        $ref: '#/definitions/IdentityProviderDetails'
        description: The data plane authentication identity details.
      providerVersionDetails:
        $ref: '#/definitions/VersionDetails'
        description: The provider version details.
  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: '#/definitions/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
  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
  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
  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: '#/definitions/IdentityProviderInput'
        description: The identity provider input for DRA authentication.
      resourceAccessIdentityInput:
        $ref: '#/definitions/IdentityProviderInput'
        description: The identity provider input for resource access.
      dataPlaneAuthenticationIdentityInput:
        $ref: '#/definitions/IdentityProviderInput'
        description: The identity provider input for data plane authentication.
  RecoveryServicesProviderCollection:
    description: Collection of providers.
    type: object
    properties:
      value:
        description: The Servers details.
        type: array
        items:
          $ref: '#/definitions/RecoveryServicesProvider'
      nextLink:
        description: The value of next link.
        type: string
  RecoveryServicesProvider:
    description: Provider details.
    type: object
    allOf:
    - $ref: '#/definitions/Resource'
    properties:
      properties:
        $ref: '#/definitions/RecoveryServicesProviderProperties'
        description: Provider properties.
  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
parameters:
  ResourceGroupName:
    name: resourceGroupName
    in: path
    description: The name of the resource group where the recovery services vault is present.
    required: true
    type: string
    x-ms-parameter-location: client
  ResourceName:
    name: resourceName
    in: path
    description: The name of the recovery services vault.
    required: true
    type: string
    x-ms-parameter-location: client
  ApiVersion:
    name: api-version
    in: query
    description: Client Api Version.
    required: true
    type: string
  SubscriptionId:
    name: subscriptionId
    in: path
    description: The subscription Id.
    required: true
    type: string
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'