Azure Site Recovery Replication Fabrics API

openapi: 3.2.0
info:
  title: Microsoft Azure Site Recovery Replication Fabrics API
  version: '2026-11-01'
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
  description: 'Operations tagged ReplicationFabrics 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: ReplicationFabrics
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics
  : get:
      operationId: ReplicationFabrics_List
      tags:
      - ReplicationFabrics
      summary: Gets the list of ASR fabrics
      description: Gets a list of the Azure Site Recovery fabrics 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 Vault
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FabricCollection'
      x-ms-examples:
        Gets the list of ASR fabrics.:
          $ref: ./examples/ReplicationFabrics_List.json
      x-ms-pageable:
        nextLinkName: nextLink
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}
  : get:
      operationId: ReplicationFabrics_Get
      tags:
      - ReplicationFabrics
      summary: Gets the details of an ASR fabric
      description: Gets the details of an Azure Site Recovery 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
      - name: $filter
        in: query
        description: OData filter options.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Fabric'
      x-ms-examples:
        Gets the details of an ASR fabric.:
          $ref: ./examples/ReplicationFabrics_Get.json
    put:
      operationId: ReplicationFabrics_Create
      tags:
      - ReplicationFabrics
      summary: Creates an Azure Site Recovery fabric
      description: The operation to create an Azure Site Recovery fabric (for e.g. Hyper-V site).
      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: Resource 'Fabric' update operation succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Fabric'
        '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:
        Creates an Azure Site Recovery fabric.:
          $ref: ./examples/ReplicationFabrics_Create.json
      x-ms-long-running-operation-options:
        final-state-via: location
        final-state-schema: '#/definitions/Fabric'
      x-ms-long-running-operation: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FabricCreationInput'
        description: Fabric creation input.
        required: true
    delete:
      operationId: ReplicationFabrics_Purge
      tags:
      - ReplicationFabrics
      summary: Purges the site
      description: The operation to purge(force delete) an Azure Site Recovery 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:
        '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 the site.:
          $ref: ./examples/ReplicationFabrics_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}/checkConsistency
  : post:
      operationId: ReplicationFabrics_CheckConsistency
      tags:
      - ReplicationFabrics
      summary: Checks the consistency of the ASR fabric
      description: The operation to perform a consistency check on the 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/Fabric'
        '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:
        Checks the consistency of the ASR fabric.:
          $ref: ./examples/ReplicationFabrics_CheckConsistency.json
      x-ms-long-running-operation-options:
        final-state-via: location
        final-state-schema: '#/definitions/Fabric'
      x-ms-long-running-operation: true
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/migratetoaad
  : post:
      operationId: ReplicationFabrics_MigrateToAad
      tags:
      - ReplicationFabrics
      summary: Migrates the site to AAD
      description: The operation to migrate an Azure Site Recovery fabric to AAD.
      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:
        '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:
        Migrates the site to AAD.:
          $ref: ./examples/ReplicationFabrics_MigrateToAad.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}/reassociateGateway
  : post:
      operationId: ReplicationFabrics_ReassociateGateway
      tags:
      - ReplicationFabrics
      summary: Perform failover of the process server
      description: The operation to move replications from a process server to another process 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
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Fabric'
        '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:
        Perform failover of the process server.:
          $ref: ./examples/ReplicationFabrics_ReassociateGateway.json
      x-ms-long-running-operation-options:
        final-state-via: location
        final-state-schema: '#/definitions/Fabric'
      x-ms-long-running-operation: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FailoverProcessServerRequest'
        description: The input to the failover process server operation.
        required: true
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/remove
  : post:
      operationId: ReplicationFabrics_Delete
      tags:
      - ReplicationFabrics
      summary: Deletes the site
      description: The operation to delete or remove an Azure Site Recovery 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:
        '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 the site.:
          $ref: ./examples/ReplicationFabrics_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}/replicationFabrics/{fabricName}/removeInfra
  : post:
      operationId: ReplicationFabrics_RemoveInfra
      tags:
      - ReplicationFabrics
      summary: Removes the appliance's infrastructure under the fabric
      description: Removes the appliance's infrastructure under the 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 recovery services vault.
        required: true
        schema:
          type: string
          pattern: ^[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9]$
      - name: fabricName
        in: path
        description: Fabric name.
        required: true
        schema:
          type: string
          pattern: ^[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9]$
      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
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Removes the appliance's infrastructure under the fabric.:
          $ref: ./examples/ReplicationInfrastructure_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}/replicationFabrics/{fabricName}/renewCertificate
  : post:
      operationId: ReplicationFabrics_RenewCertificate
      tags:
      - ReplicationFabrics
      summary: Renews certificate for the fabric
      description: Renews the connection certificate for the ASR replication 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/Fabric'
        '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:
        Renews certificate for the fabric.:
          $ref: ./examples/ReplicationFabrics_RenewCertificate.json
      x-ms-long-running-operation-options:
        final-state-via: location
        final-state-schema: '#/definitions/Fabric'
      x-ms-long-running-operation: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RenewCertificateInput'
        description: Renew certificate input.
        required: true
    servers:
    - url: https://management.azure.com
components:
  schemas:
    FailoverProcessServerRequest:
      type: object
      description: Request to failover a process server.
      properties:
        properties:
          $ref: '#/components/schemas/FailoverProcessServerRequestProperties'
          description: The properties of the PS Failover request.
    FabricProperties:
      type: object
      description: Fabric properties.
      properties:
        friendlyName:
          type: string
          description: Friendly name of the fabric.
        encryptionDetails:
          $ref: '#/components/schemas/EncryptionDetails'
          description: Encryption details for the fabric.
        rolloverEncryptionDetails:
          $ref: '#/components/schemas/EncryptionDetails'
          description: Rollover encryption details for the fabric.
        internalIdentifier:
          type: string
          description: Dra Registration Id.
        bcdrState:
          type: string
          description: BCDR state of the fabric.
        customDetails:
          $ref: '#/components/schemas/FabricSpecificDetails'
          description: Fabric specific settings.
        healthErrorDetails:
          type: array
          description: Fabric health error details.
          items:
            $ref: '#/components/schemas/HealthError'
        health:
          type: string
          description: Health of fabric.
    EncryptionDetails:
      type: object
      description: Encryption details for the fabric.
      properties:
        kekState:
          type: string
          description: The key encryption key state for the Vmm.
        kekCertThumbprint:
          type: string
          description: The key encryption key certificate thumbprint.
        kekCertExpiryDate:
          type: string
          format: date-time
          description: The key encryption key certificate expiry date.
    Fabric:
      type: object
      description: Fabric definition.
      properties:
        properties:
          $ref: '#/components/schemas/FabricProperties'
          description: Fabric related data.
        location:
          type: string
          description: Resource Location
      allOf:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
    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.
    FabricCollection:
      type: object
      description: Collection of fabric details.
      properties:
        value:
          type: array
          description: The Fabric items on this page
          items:
            $ref: '#/components/schemas/Fabric'
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
      required:
      - value
    RenewCertificateInput:
      type: object
      description: Certificate renewal input.
      properties:
        properties:
          $ref: '#/components/schemas/RenewCertificateInputProperties'
          description: Renew certificate input properties.
    FabricCreationInputProperties:
      type: object
      description: Properties of site details provided during the time of site creation.
      properties:
        customDetails:
          $ref: '#/components/schemas/FabricSpecificCreationInput'
          description: Fabric provider specific creation input.
    FabricCreationInput:
      type: object
      description: Site details provided during the time of site creation.
      properties:
        properties:
          $ref: '#/components/schemas/FabricCreationInputProperties'
          description: Fabric creation input.
    FabricSpecificDetails:
      type: object
      description: Fabric specific details.
      properties:
        instanceType:
          type: string
          description: Gets the class type. Overridden in derived classes.
      discriminator:
        propertyName: instanceType
      required:
      - instanceType
    RenewCertificateInputProperties:
      type: object
      description: Renew Certificate input properties.
      properties:
        renewCertificateType:
          type: string
          description: Renew certificate type.
    FailoverProcessServerRequestProperties:
      type: object
      description: The properties of the Failover Process Server request.
      properties:
        containerName:
          type: string
          description: The container identifier.
        sourceProcessServerId:
          type: string
          description: The source process server.
        targetProcessServerId:
          type: string
          description: The new process server.
        vmsToMigrate:
          type: array
          description: The VMS to migrate.
          items:
            type: string
        updateType:
          type: string
          description: A value for failover type. It can be systemlevel/serverlevel.
    FabricSpecificCreationInput:
      type: object
      description: Fabric provider specific settings.
      properties:
        instanceType:
          type: string
          description: Gets the class type.
      discriminator:
        propertyName: instanceType
      required:
      - instanceType
    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
    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