Azure Site Recovery Replicationv Centers API

openapi: 3.2.0
info:
  title: Microsoft Azure Site Recovery Replicationv Centers API
  version: '2026-11-01'
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
  description: 'Operations tagged ReplicationvCenters 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: ReplicationvCenters
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationvCenters
  : get:
      operationId: ReplicationvCenters_ListByReplicationFabrics
      tags:
      - ReplicationvCenters
      summary: Gets the list of vCenter registered under a fabric
      description: Lists the vCenter servers registered in a 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/VCenterCollection'
      x-ms-examples:
        Gets the list of vCenter registered under a fabric.:
          $ref: ./examples/ReplicationvCenters_ListByReplicationFabrics.json
      x-ms-pageable:
        nextLinkName: nextLink
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationvCenters/{vcenterName}
  : get:
      operationId: ReplicationvCenters_Get
      tags:
      - ReplicationvCenters
      summary: Gets the details of a vCenter
      description: Gets the details of a registered vCenter server(Add vCenter server).
      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: vcenterName
        in: path
        description: vcenter name.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VCenter'
      x-ms-examples:
        Gets the details of a vCenter.:
          $ref: ./examples/ReplicationvCenters_Get.json
    put:
      operationId: ReplicationvCenters_Create
      tags:
      - ReplicationvCenters
      summary: Add vCenter
      description: The operation to create a vCenter object..
      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: vcenterName
        in: path
        description: vcenter name.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Resource 'VCenter' update operation succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VCenter'
        '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:
        Add vCenter.:
          $ref: ./examples/ReplicationvCenters_Create.json
      x-ms-long-running-operation-options:
        final-state-via: location
        final-state-schema: '#/definitions/VCenter'
      x-ms-long-running-operation: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddVCenterRequest'
        description: The input to the add vCenter operation.
        required: true
    patch:
      operationId: ReplicationvCenters_Update
      tags:
      - ReplicationvCenters
      summary: Update vCenter operation
      description: The operation to update a registered vCenter.
      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: vcenterName
        in: path
        description: vcenter name.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VCenter'
        '202':
          description: Resource update request 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:
        Update vCenter operation.:
          $ref: ./examples/ReplicationvCenters_Update.json
      x-ms-long-running-operation-options:
        final-state-via: location
        final-state-schema: '#/definitions/VCenter'
      x-ms-long-running-operation: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateVCenterRequest'
        description: The input to the update vCenter operation.
        required: true
    delete:
      operationId: ReplicationvCenters_Delete
      tags:
      - ReplicationvCenters
      summary: Remove vcenter operation
      description: The operation to remove(unregister) a registered vCenter server 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: vcenterName
        in: path
        description: vcenter 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:
        Remove vCenter operation.:
          $ref: ./examples/ReplicationvCenters_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}/replicationvCenters
  : get:
      operationId: ReplicationvCenters_List
      tags:
      - ReplicationvCenters
      summary: Gets the list of vCenter registered under the vault
      description: Lists the vCenter servers registered 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/VCenterCollection'
      x-ms-examples:
        Gets the list of vCenter registered under the vault.:
          $ref: ./examples/ReplicationvCenters_List.json
      x-ms-pageable:
        nextLinkName: nextLink
    servers:
    - url: https://management.azure.com
components:
  schemas:
    AddVCenterRequest:
      type: object
      description: Input required to add vCenter.
      properties:
        properties:
          $ref: '#/components/schemas/AddVCenterRequestProperties'
          description: The properties of an add vCenter request.
    UpdateVCenterRequest:
      type: object
      description: Input required to update vCenter.
      properties:
        properties:
          $ref: '#/components/schemas/UpdateVCenterRequestProperties'
          description: The update VCenter Request Properties.
    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.
    VCenterProperties:
      type: object
      description: vCenter properties.
      properties:
        friendlyName:
          type: string
          description: Friendly name of the vCenter.
        internalId:
          type: string
          description: VCenter internal ID.
        lastHeartbeat:
          type: string
          format: date-time
          description: The time when the last heartbeat was received by vCenter.
        discoveryStatus:
          type: string
          description: The VCenter discovery status.
        processServerId:
          type: string
          description: The process server Id.
        ipAddress:
          type: string
          description: The IP address of the vCenter.
        infrastructureId:
          type: string
          description: The infrastructure Id of vCenter.
        port:
          type: string
          description: The port number for discovery.
        runAsAccountId:
          type: string
          description: The account Id which has privileges to discover the vCenter.
        fabricArmResourceName:
          type: string
          description: The ARM resource name of the fabric containing this VCenter.
        healthErrors:
          type: array
          description: The health errors for this VCenter.
          items:
            $ref: '#/components/schemas/HealthError'
    VCenter:
      type: object
      description: vCenter definition.
      properties:
        properties:
          $ref: '#/components/schemas/VCenterProperties'
          description: VCenter related data.
        location:
          type: string
          description: Resource Location
      allOf:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
    AddVCenterRequestProperties:
      type: object
      description: The properties of an add vCenter request.
      properties:
        friendlyName:
          type: string
          description: The friendly name of the vCenter.
        ipAddress:
          type: string
          description: The IP address of the vCenter to be discovered.
        processServerId:
          type: string
          description: The process server Id from where the discovery is orchestrated.
        port:
          type: string
          description: The port number for discovery.
        runAsAccountId:
          type: string
          description: The account Id which has privileges to discover the vCenter.
    VCenterCollection:
      type: object
      description: Collection of vCenter details.
      properties:
        value:
          type: array
          description: The VCenter items on this page
          items:
            $ref: '#/components/schemas/VCenter'
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
      required:
      - value
    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
    UpdateVCenterRequestProperties:
      type: object
      description: The properties of an update vCenter request.
      properties:
        friendlyName:
          type: string
          description: The friendly name of the vCenter.
        ipAddress:
          type: string
          description: The IP address of the vCenter to be discovered.
        processServerId:
          type: string
          description: The process server Id from where the update can be orchestrated.
        port:
          type: string
          description: The port number for discovery.
        runAsAccountId:
          type: string
          description: The CS account Id which has privileges to update the vCenter.
    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