swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector ReplicationFabrics API
schemes:
- https
tags:
- name: ReplicationFabrics
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics
  : get:
      tags:
      - ReplicationFabrics
      summary: Microsoft Azure Gets The List Of Asr Fabrics
      description: Gets a list of the Azure Site Recovery fabrics in the vault.
      operationId: microsoftAzureReplicationfabricsList
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/ApiVersion'
      - $ref: '#/parameters/ResourceName'
      - $ref: '#/parameters/ResourceGroupName'
      - $ref: '#/parameters/SubscriptionId'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/FabricCollection'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        Gets the list of ASR fabrics.:
          $ref: ./examples/ReplicationFabrics_List.json
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}
  : get:
      tags:
      - ReplicationFabrics
      summary: Microsoft Azure Gets The Details Of An Asr Fabric
      description: Gets the details of an Azure Site Recovery fabric.
      operationId: microsoftAzureReplicationfabricsGet
      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: $filter
        in: query
        description: OData filter options.
        required: false
        type: string
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Fabric'
      x-ms-odata: '#/definitions/FabricQueryParameter'
      x-ms-examples:
        Gets the details of an ASR fabric.:
          $ref: ./examples/ReplicationFabrics_Get.json
    put:
      tags:
      - ReplicationFabrics
      summary: Microsoft Azure Creates An Azure Site Recovery Fabric
      description: The operation to create an Azure Site Recovery fabric (for e.g. Hyper-V site).
      operationId: microsoftAzureReplicationfabricsCreate
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/ApiVersion'
      - $ref: '#/parameters/ResourceName'
      - $ref: '#/parameters/ResourceGroupName'
      - $ref: '#/parameters/SubscriptionId'
      - name: fabricName
        in: path
        description: Name of the ASR fabric.
        required: true
        type: string
      - name: input
        in: body
        description: Fabric creation input.
        required: true
        schema:
          $ref: '#/definitions/FabricCreationInput'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Fabric'
        '202':
          description: Accepted
      x-ms-long-running-operation: true
      x-ms-examples:
        Creates an Azure Site Recovery fabric.:
          $ref: ./examples/ReplicationFabrics_Create.json
    delete:
      tags:
      - ReplicationFabrics
      summary: Microsoft Azure Purges The Site
      description: The operation to purge(force delete) an Azure Site Recovery fabric.
      operationId: microsoftAzureReplicationfabricsPurge
      parameters:
      - $ref: '#/parameters/ApiVersion'
      - $ref: '#/parameters/ResourceName'
      - $ref: '#/parameters/ResourceGroupName'
      - $ref: '#/parameters/SubscriptionId'
      - name: fabricName
        in: path
        description: ASR fabric to purge.
        required: true
        type: string
      responses:
        '202':
          description: Accepted
        '204':
          description: NoContent
      x-ms-long-running-operation: true
      x-ms-examples:
        Purges the site.:
          $ref: ./examples/ReplicationFabrics_Purge.json
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/checkConsistency
  : post:
      tags:
      - ReplicationFabrics
      summary: Microsoft Azure Checks The Consistency Of The Asr Fabric
      description: The operation to perform a consistency check on the fabric.
      operationId: microsoftAzureReplicationfabricsCheckconsistency
      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/Fabric'
        '202':
          description: Accepted
      x-ms-long-running-operation: true
      x-ms-examples:
        Checks the consistency of the ASR fabric.:
          $ref: ./examples/ReplicationFabrics_CheckConsistency.json
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/migratetoaad
  : post:
      tags:
      - ReplicationFabrics
      summary: Microsoft Azure Migrates The Site To Aad
      description: The operation to migrate an Azure Site Recovery fabric to AAD.
      operationId: microsoftAzureReplicationfabricsMigratetoaad
      parameters:
      - $ref: '#/parameters/ApiVersion'
      - $ref: '#/parameters/ResourceName'
      - $ref: '#/parameters/ResourceGroupName'
      - $ref: '#/parameters/SubscriptionId'
      - name: fabricName
        in: path
        description: ASR fabric to migrate.
        required: true
        type: string
      responses:
        '202':
          description: Accepted
        '204':
          description: NoContent
      x-ms-long-running-operation: true
      x-ms-examples:
        Migrates the site to AAD.:
          $ref: ./examples/ReplicationFabrics_MigrateToAad.json
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/reassociateGateway
  : post:
      tags:
      - ReplicationFabrics
      summary: Microsoft Azure Perform Failover Of The Process Server
      description: The operation to move replications from a process server to another process server.
      operationId: microsoftAzureReplicationfabricsReassociategateway
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/ApiVersion'
      - $ref: '#/parameters/ResourceName'
      - $ref: '#/parameters/ResourceGroupName'
      - $ref: '#/parameters/SubscriptionId'
      - name: fabricName
        in: path
        description: The name of the fabric containing the process server.
        required: true
        type: string
      - name: failoverProcessServerRequest
        in: body
        description: The input to the failover process server operation.
        required: true
        schema:
          $ref: '#/definitions/FailoverProcessServerRequest'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Fabric'
        '202':
          description: Accepted
      x-ms-long-running-operation: true
      x-ms-examples:
        Perform failover of the process server.:
          $ref: ./examples/ReplicationFabrics_ReassociateGateway.json
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/remove
  : post:
      tags:
      - ReplicationFabrics
      summary: Microsoft Azure Deletes The Site
      description: The operation to delete or remove an Azure Site Recovery fabric.
      operationId: microsoftAzureReplicationfabricsDelete
      parameters:
      - $ref: '#/parameters/ApiVersion'
      - $ref: '#/parameters/ResourceName'
      - $ref: '#/parameters/ResourceGroupName'
      - $ref: '#/parameters/SubscriptionId'
      - name: fabricName
        in: path
        description: ASR fabric to delete.
        required: true
        type: string
      responses:
        '202':
          description: Accepted
        '204':
          description: NoContent
      x-ms-long-running-operation: true
      x-ms-examples:
        Deletes the site.:
          $ref: ./examples/ReplicationFabrics_Delete.json
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/renewCertificate
  : post:
      tags:
      - ReplicationFabrics
      summary: Microsoft Azure Renews Certificate For The Fabric
      description: Renews the connection certificate for the ASR replication fabric.
      operationId: microsoftAzureReplicationfabricsRenewcertificate
      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 to renew certs for.
        required: true
        type: string
      - name: renewCertificate
        in: body
        description: Renew certificate input.
        required: true
        schema:
          $ref: '#/definitions/RenewCertificateInput'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Fabric'
        '202':
          description: Accepted
      x-ms-long-running-operation: true
      x-ms-examples:
        Renews certificate for the fabric.:
          $ref: ./examples/ReplicationFabrics_RenewCertificate.json
definitions:
  FabricSpecificDetails:
    description: Fabric specific details.
    required:
    - instanceType
    type: object
    properties:
      instanceType:
        description: Gets the class type. Overridden in derived classes.
        type: string
    discriminator: instanceType
  FabricCreationInputProperties:
    description: Properties of site details provided during the time of site creation.
    type: object
    properties:
      customDetails:
        $ref: '#/definitions/FabricSpecificCreationInput'
        description: Fabric provider specific creation input.
  FailoverProcessServerRequest:
    description: Request to failover a process server.
    type: object
    properties:
      properties:
        $ref: '#/definitions/FailoverProcessServerRequestProperties'
        description: The properties of the PS Failover request.
  FabricCollection:
    description: Collection of fabric details.
    type: object
    properties:
      value:
        description: The fabric details.
        type: array
        items:
          $ref: '#/definitions/Fabric'
      nextLink:
        description: The value of next link.
        type: string
  EncryptionDetails:
    description: Encryption details for the fabric.
    type: object
    properties:
      kekState:
        description: The key encryption key state for the Vmm.
        type: string
      kekCertThumbprint:
        description: The key encryption key certificate thumbprint.
        type: string
      kekCertExpiryDate:
        format: date-time
        description: The key encryption key certificate expiry date.
        type: string
  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
  RenewCertificateInput:
    description: Certificate renewal input.
    type: object
    properties:
      properties:
        $ref: '#/definitions/RenewCertificateInputProperties'
        description: Renew certificate input properties.
  Fabric:
    description: Fabric definition.
    type: object
    allOf:
    - $ref: '#/definitions/Resource'
    properties:
      properties:
        $ref: '#/definitions/FabricProperties'
        description: Fabric related data.
  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
  FabricProperties:
    description: Fabric properties.
    type: object
    properties:
      friendlyName:
        description: Friendly name of the fabric.
        type: string
      encryptionDetails:
        $ref: '#/definitions/EncryptionDetails'
        description: Encryption details for the fabric.
      rolloverEncryptionDetails:
        $ref: '#/definitions/EncryptionDetails'
        description: Rollover encryption details for the fabric.
      internalIdentifier:
        description: Dra Registration Id.
        type: string
      bcdrState:
        description: BCDR state of the fabric.
        type: string
      customDetails:
        $ref: '#/definitions/FabricSpecificDetails'
        description: Fabric specific settings.
      healthErrorDetails:
        description: Fabric health error details.
        type: array
        items:
          $ref: '#/definitions/HealthError'
      health:
        description: Health of fabric.
        type: string
  FailoverProcessServerRequestProperties:
    description: The properties of the Failover Process Server request.
    type: object
    properties:
      containerName:
        description: The container identifier.
        type: string
      sourceProcessServerId:
        description: The source process server.
        type: string
      targetProcessServerId:
        description: The new process server.
        type: string
      vmsToMigrate:
        description: The VMS to migrate.
        type: array
        items:
          type: string
      updateType:
        description: A value for failover type. It can be systemlevel/serverlevel.
        type: string
  FabricCreationInput:
    description: Site details provided during the time of site creation.
    type: object
    properties:
      properties:
        $ref: '#/definitions/FabricCreationInputProperties'
        description: Fabric creation input.
  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
  FabricSpecificCreationInput:
    description: Fabric provider specific settings.
    required:
    - instanceType
    type: object
    properties:
      instanceType:
        description: Gets the class type.
        type: string
    discriminator: instanceType
  RenewCertificateInputProperties:
    description: Renew Certificate input properties.
    type: object
    properties:
      renewCertificateType:
        description: Renew certificate type.
        type: string
parameters:
  SubscriptionId:
    name: subscriptionId
    in: path
    description: The subscription Id.
    required: true
    type: string
  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
  ApiVersion:
    name: api-version
    in: query
    description: Client Api Version.
    required: true
    type: string
  ResourceName:
    name: resourceName
    in: path
    description: The name of the recovery services vault.
    required: true
    type: string
    x-ms-parameter-location: client
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'