Microsoft Azure Fabric API

openapi: 3.2.0
info:
  title: Microsoft Azure Azure Site Recovery Management Service…
  description: A first party Azure service enabling the data replication.
  version: 2021-02-16-preview
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: Fabric
  description: Fabric Controller.
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationFabrics/{fabricName}
  : get:
      tags:
      - Fabric
      summary: Microsoft Azure Gets The Fabric
      description: Gets the details of the fabric.
      operationId: microsoftAzureFabricGet
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/components/parameters/FabricNameParameter'
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: Returns Fabric Model on success.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FabricModel'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Fabric_Get:
          $ref: ./examples/Fabric_Get.json
    put:
      tags:
      - Fabric
      summary: Microsoft Azure Puts The Fabric
      description: Creates the fabric.
      operationId: microsoftAzureFabricCreate
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/components/parameters/FabricNameParameter'
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: Updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FabricModel'
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FabricModel'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-examples:
        Fabric_Create:
          $ref: ./examples/Fabric_Create.json
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FabricModel'
        description: Fabric properties.
    patch:
      tags:
      - Fabric
      summary: Microsoft Azure Updates The Fabric
      description: Performs update on the fabric.
      operationId: microsoftAzureFabricUpdate
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/components/parameters/FabricNameParameter'
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FabricModel'
        '202':
          description: Returns success on update.
          headers:
            Azure-AsyncOperation:
              description: Tracking URL for long running operation.
              schema:
                type: string
            Location:
              schema:
                type: string
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-examples:
        Fabric_Update:
          $ref: ./examples/Fabric_Update.json
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FabricModelUpdate'
        description: Fabric properties.
    delete:
      tags:
      - Fabric
      summary: Microsoft Azure Deletes The Fabric
      description: Removes the fabric.
      operationId: microsoftAzureFabricDelete
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/components/parameters/FabricNameParameter'
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      responses:
        '202':
          description: Returns success on deletion.
          headers:
            Azure-AsyncOperation:
              description: Tracking URL for long running operation.
              schema:
                type: string
            Location:
              schema:
                type: string
        '204':
          description: No Content
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-examples:
        Fabric_Delete:
          $ref: ./examples/Fabric_Delete.json
  /subscriptions/{subscriptionId}/providers/Microsoft.DataReplication/replicationFabrics:
    get:
      tags:
      - Fabric
      summary: Microsoft Azure Lists The Fabrics
      description: Gets the list of fabrics in the given subscription.
      operationId: microsoftAzureFabricListbysubscription
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - in: query
        name: continuationToken
        description: Continuation token from the previous call.
        schema:
          type: string
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: Returns Fabric Model Collection on success.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FabricModelCollection'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        Fabric_ListBySubscription:
          $ref: ./examples/Fabric_ListBySubscription.json
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationFabrics:
    get:
      tags:
      - Fabric
      summary: Microsoft Azure Lists The Fabrics
      description: Gets the list of fabrics in the given subscription and resource group.
      operationId: microsoftAzureFabricList
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - in: query
        name: continuationToken
        description: Continuation token from the previous call.
        schema:
          type: string
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: Returns Fabric Model Collection on success.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FabricModelCollection'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        Fabric_List:
          $ref: ./examples/Fabric_List.json
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationFabrics/{fabricName}/operations/{operationId}
  : get:
      tags:
      - Fabric
      summary: Microsoft Azure Gets The Fabric Operation Status
      description: Tracks the results of an asynchronous operation on the fabric.
      operationId: microsoftAzureFabricoperationsstatusGet
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/components/parameters/FabricNameParameter'
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/OperationIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationStatus'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        FabricOperationsStatus_Get:
          $ref: ./examples/FabricOperationsStatus_Get.json
components:
  schemas:
    SystemDataModel:
      description: System data required to be defined for Azure resources.
      type: object
      properties:
        createdBy:
          description: Gets or sets identity that created the resource.
          type: string
        createdByType:
          description: 'Gets or sets the type of identity that created the resource: user, application,

            managedIdentity.'
          type: string
        createdAt:
          format: date-time
          description: Gets or sets the timestamp of resource creation (UTC).
          type: string
        lastModifiedBy:
          description: Gets or sets the identity that last modified the resource.
          type: string
        lastModifiedByType:
          description: 'Gets or sets the type of identity that last modified the resource: user, application,

            managedIdentity.'
          type: string
        lastModifiedAt:
          format: date-time
          description: Gets or sets the timestamp of resource last modification (UTC).
          type: string
    HealthErrorModel:
      description: Health error model.
      type: object
      properties:
        affectedResourceType:
          description: Gets or sets the type of affected resource type.
          type: string
        affectedResourceCorrelationIds:
          description: 'Gets or sets the list of affected resource correlation Ids. This can be used to

            uniquely identify the count of items affected by a specific category and severity

            as well as count of item affected by an specific issue.'
          type: array
          items:
            type: string
        childErrors:
          description: Gets or sets a list of child health errors associated with this error.
          type: array
          items:
            $ref: '#/components/schemas/InnerHealthErrorModel'
          x-ms-identifiers: []
        code:
          description: Gets or sets the error code.
          type: string
          readOnly: true
        healthCategory:
          description: Gets or sets the health category.
          type: string
          readOnly: true
        category:
          description: Gets or sets the error category.
          type: string
          readOnly: true
        severity:
          description: Gets or sets the error severity.
          type: string
          readOnly: true
        source:
          description: Gets or sets the error source.
          type: string
          readOnly: true
        creationTime:
          format: date-time
          description: Gets or sets the error creation time.
          type: string
          readOnly: true
        isCustomerResolvable:
          description: Gets or sets a value indicating whether the error is customer resolvable.
          type: boolean
          readOnly: true
        summary:
          description: Gets or sets the error summary.
          type: string
          readOnly: true
        message:
          description: Gets or sets the error message.
          type: string
          readOnly: true
        causes:
          description: Gets or sets possible causes of the error.
          type: string
          readOnly: true
        recommendation:
          description: Gets or sets recommended action to resolve the error.
          type: string
          readOnly: true
    OperationStatus:
      description: Defines the operation status.
      type: object
      properties:
        id:
          description: Gets or sets the Id.
          type: string
        name:
          description: Gets or sets the operation name.
          type: string
        status:
          description: 'Gets or sets the status of the operation. ARM expects the terminal status to be one of

            Succeeded/ Failed/ Canceled. All other values imply that the operation is still running.'
          type: string
        startTime:
          description: Gets or sets the start time.
          type: string
        endTime:
          description: Gets or sets the end time.
          type: string
    FabricModelCollection:
      description: Fabric model collection.
      type: object
      properties:
        value:
          description: Gets or sets the list of fabrics.
          type: array
          items:
            $ref: '#/components/schemas/FabricModel'
          x-ms-identifiers: []
        nextLink:
          description: Gets or sets the value of next link.
          type: string
    FabricModelProperties:
      description: Fabric model properties.
      required:
      - customProperties
      type: object
      properties:
        provisioningState:
          description: Gets or sets the provisioning state of the fabric.
          enum:
          - Canceled
          - Creating
          - Deleting
          - Deleted
          - Failed
          - Succeeded
          - Updating
          type: string
          readOnly: true
          x-ms-enum:
            name: ProvisioningState
            modelAsString: true
        serviceEndpoint:
          description: Gets or sets the service endpoint.
          type: string
          readOnly: true
        serviceResourceId:
          description: Gets or sets the service resource Id.
          type: string
          readOnly: true
        health:
          description: Gets or sets the fabric health.
          enum:
          - Normal
          - Warning
          - Critical
          type: string
          readOnly: true
          x-ms-enum:
            name: HealthStatus
            modelAsString: true
        healthErrors:
          description: Gets or sets the list of health errors.
          type: array
          items:
            $ref: '#/components/schemas/HealthErrorModel'
          readOnly: true
          x-ms-identifiers: []
        customProperties:
          $ref: '#/components/schemas/FabricModelCustomProperties'
    FabricModel:
      description: Fabric model.
      required:
      - location
      - properties
      type: object
      properties:
        location:
          description: Gets or sets the location of the fabric.
          minLength: 1
          type: string
          x-ms-mutability:
          - create
          - read
        tags:
          description: Gets or sets the resource tags.
          maxLength: 15
          type: object
          additionalProperties:
            type: string
        properties:
          $ref: '#/components/schemas/FabricModelProperties'
        id:
          description: Gets or sets the Id of the resource.
          type: string
          readOnly: true
        name:
          description: Gets or sets the name of the resource.
          type: string
          readOnly: true
        type:
          description: Gets or sets the type of the resource.
          type: string
          readOnly: true
        systemData:
          allOf:
          - $ref: '#/components/schemas/SystemDataModel'
          readOnly: true
      x-ms-azure-resource: true
    InnerHealthErrorModel:
      description: Inner health error model.
      type: object
      properties:
        code:
          description: Gets or sets the error code.
          type: string
          readOnly: true
        healthCategory:
          description: Gets or sets the health category.
          type: string
          readOnly: true
        category:
          description: Gets or sets the error category.
          type: string
          readOnly: true
        severity:
          description: Gets or sets the error severity.
          type: string
          readOnly: true
        source:
          description: Gets or sets the error source.
          type: string
          readOnly: true
        creationTime:
          format: date-time
          description: Gets or sets the error creation time.
          type: string
          readOnly: true
        isCustomerResolvable:
          description: Gets or sets a value indicating whether the error is customer resolvable.
          type: boolean
          readOnly: true
        summary:
          description: Gets or sets the error summary.
          type: string
          readOnly: true
        message:
          description: Gets or sets the error message.
          type: string
          readOnly: true
        causes:
          description: Gets or sets possible causes of the error.
          type: string
          readOnly: true
        recommendation:
          description: Gets or sets recommended action to resolve the error.
          type: string
          readOnly: true
    FabricModelUpdate:
      description: Fabric model for update.
      type: object
      properties:
        tags:
          description: Gets or sets the resource tags.
          maxLength: 15
          type: object
          additionalProperties:
            type: string
        properties:
          $ref: '#/components/schemas/FabricModelProperties'
        id:
          description: Gets or sets the Id of the resource.
          type: string
          readOnly: true
        name:
          description: Gets or sets the name of the resource.
          type: string
          readOnly: true
        type:
          description: Gets or sets the type of the resource.
          type: string
          readOnly: true
        systemData:
          allOf:
          - $ref: '#/components/schemas/SystemDataModel'
          readOnly: true
      x-ms-azure-resource: true
    FabricModelCustomProperties:
      description: Fabric model custom properties.
      required:
      - instanceType
      type: object
      properties:
        instanceType:
          description: Gets or sets the instance type.
          minLength: 1
          type: string
      discriminator:
        propertyName: instanceType
  parameters:
    FabricNameParameter:
      in: path
      name: fabricName
      description: The fabric name.
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
        pattern: ^[a-zA-Z0-9]*$
  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