swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Volumes Replication API
schemes:
- https
tags:
- name: Volumes Replication
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/breakReplication
  : post:
      tags:
      - Volumes Replication
      summary: Microsoft Azure Break Volume Replication
      description: Break the replication connection on the destination volume
      operationId: microsoftAzureVolumesBreakreplication
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/AccountName'
      - $ref: '#/parameters/PoolName'
      - $ref: '#/parameters/VolumeName'
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - name: body
        description: Optional body to force break the replication.
        in: body
        required: false
        schema:
          $ref: '#/definitions/breakReplicationRequest'
      responses:
        '200':
          description: OK - terminal state
        '202':
          description: Accepted
        default:
          description: Error response describing why the operation failed.
          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:
        Volumes_BreakReplication:
          $ref: examples/Volumes_BreakReplication.json
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/reestablishReplication
  : post:
      tags:
      - Volumes Replication
      summary: Microsoft Azure Re Establish Volume Replication
      description: Re-establish a previously deleted replication between 2 volumes that have a common ad-hoc or policy-based snapshots
      operationId: microsoftAzureVolumesReestablishreplication
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/AccountName'
      - $ref: '#/parameters/PoolName'
      - $ref: '#/parameters/VolumeName'
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - name: body
        description: body for the id of the source volume.
        in: body
        required: true
        schema:
          $ref: '#/definitions/reestablishReplicationRequest'
      responses:
        '202':
          description: Accepted
        default:
          description: Error response describing why the operation failed.
          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:
        Volumes_ReestablishReplication:
          $ref: examples/Volumes_ReestablishReplication.json
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/replicationStatus
  : get:
      tags:
      - Volumes Replication
      summary: Microsoft Azure Get Volume Replication Status
      description: Get the status of the replication
      operationId: microsoftAzureVolumesReplicationstatus
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/AccountName'
      - $ref: '#/parameters/PoolName'
      - $ref: '#/parameters/VolumeName'
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/replicationStatus'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Volumes_ReplicationStatus:
          $ref: examples/Volumes_ReplicationStatus.json
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/listReplications
  : post:
      tags:
      - Volumes Replication
      summary: Microsoft Azure List Replications For Volume
      description: List all replications for a specified volume
      operationId: microsoftAzureVolumesListreplications
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/AccountName'
      - $ref: '#/parameters/PoolName'
      - $ref: '#/parameters/VolumeName'
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      x-ms-pageable:
        nextLinkName: null
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/listReplications'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Volumes_ListReplications:
          $ref: examples/Volumes_ListReplications.json
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/resyncReplication
  : post:
      tags:
      - Volumes Replication
      summary: Microsoft Azure Resync Volume Replication
      description: Resync the connection on the destination volume. If the operation is ran on the source volume it will reverse-resync the connection and sync from destination to source.
      operationId: microsoftAzureVolumesResyncreplication
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/AccountName'
      - $ref: '#/parameters/PoolName'
      - $ref: '#/parameters/VolumeName'
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK - terminal state
        '202':
          description: Accepted
        default:
          description: Error response describing why the operation failed.
          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:
        Volumes_ResyncReplication:
          $ref: examples/Volumes_ResyncReplication.json
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/deleteReplication
  : post:
      tags:
      - Volumes Replication
      summary: Microsoft Azure Delete Volume Replication
      description: Delete the replication connection on the destination volume, and send release to the source replication
      operationId: microsoftAzureVolumesDeletereplication
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/AccountName'
      - $ref: '#/parameters/PoolName'
      - $ref: '#/parameters/VolumeName'
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK - terminal state
        '202':
          description: Accepted
        default:
          description: Error response describing why the operation failed.
          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:
        Volumes_DeleteReplication:
          $ref: examples/Volumes_DeleteReplication.json
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/authorizeReplication
  : post:
      tags:
      - Volumes Replication
      summary: Microsoft Azure Authorize Source Volume Replication
      description: Authorize the replication connection on the source volume
      operationId: microsoftAzureVolumesAuthorizereplication
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/AccountName'
      - $ref: '#/parameters/PoolName'
      - $ref: '#/parameters/VolumeName'
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - name: body
        description: Authorize request object supplied in the body of the operation.
        in: body
        required: true
        schema:
          $ref: '#/definitions/authorizeRequest'
      responses:
        '200':
          description: OK - terminal state
        '202':
          description: Accepted
        default:
          description: Error response describing why the operation failed.
          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:
        Volumes_AuthorizeReplication:
          $ref: examples/Volumes_AuthorizeReplication.json
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/reinitializeReplication
  : post:
      tags:
      - Volumes Replication
      summary: Microsoft Azure Reinitialize Volume Replication
      description: Re-Initializes the replication connection on the destination volume
      operationId: microsoftAzureVolumesReinitializereplication
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/AccountName'
      - $ref: '#/parameters/PoolName'
      - $ref: '#/parameters/VolumeName'
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK - terminal state
        '202':
          description: Accepted
        default:
          description: Error response describing why the operation failed.
          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:
        Volumes_ReInitializeReplication:
          $ref: examples/Volumes_ReInitializeReplication.json
definitions:
  replication:
    description: Replication properties
    type: object
    required:
    - remoteVolumeResourceId
    properties:
      endpointType:
        type: string
        description: Indicates whether the local volume is the source or destination for the Volume Replication
        enum:
        - src
        - dst
        x-ms-enum:
          name: EndpointType
          modelAsString: true
      replicationSchedule:
        type: string
        description: Schedule
        enum:
        - _10minutely
        - hourly
        - daily
        x-ms-enum:
          name: ReplicationSchedule
          modelAsString: true
      remoteVolumeResourceId:
        type: string
        description: The resource ID of the remote volume.
      remoteVolumeRegion:
        type: string
        description: The remote region for the other end of the Volume Replication.
  reestablishReplicationRequest:
    description: Re-establish request object supplied in the body of the operation.
    type: object
    properties:
      sourceVolumeId:
        type: string
        description: Resource id of the source volume for the replication
  replicationStatus:
    description: Replication status
    type: object
    properties:
      healthy:
        type: boolean
        description: Replication health check
      relationshipStatus:
        type: string
        description: Status of the mirror relationship
        enum:
        - Idle
        - Transferring
        x-ms-enum:
          name: RelationshipStatus
          modelAsString: true
      mirrorState:
        type: string
        description: The status of the replication
        enum:
        - Uninitialized
        - Mirrored
        - Broken
        x-ms-enum:
          name: MirrorState
          modelAsString: true
      totalProgress:
        type: string
        description: The progress of the replication
      errorMessage:
        type: string
        description: Displays error message if the replication is in an error state
  authorizeRequest:
    description: Authorize request
    type: object
    properties:
      remoteVolumeResourceId:
        type: string
        description: Resource id of the remote volume
  listReplications:
    description: List Replications
    type: object
    properties:
      value:
        description: A list of replications
        type: array
        items:
          $ref: '#/definitions/replication'
        x-ms-identifiers: []
  breakReplicationRequest:
    description: Break replication request
    type: object
    properties:
      forceBreakReplication:
        type: boolean
        description: If replication is in status transferring and you want to force break the replication, set to true
parameters:
  AccountName:
    name: accountName
    type: string
    pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]{0,127}$
    in: path
    required: true
    description: The name of the NetApp account
    x-ms-parameter-location: method
  PoolName:
    name: poolName
    type: string
    in: path
    required: true
    pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]{0,63}$
    minLength: 1
    maxLength: 64
    description: The name of the capacity pool
    x-ms-parameter-location: method
  VolumeName:
    name: volumeName
    type: string
    in: path
    required: true
    pattern: ^[a-zA-Z][a-zA-Z0-9\-_]{0,63}$
    minLength: 1
    maxLength: 64
    description: The name of the volume
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'