swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Vault API
  description: Vault Controller.
schemes:
- https
tags:
- name: Vault
  description: Vault Controller.
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}
  : get:
      tags:
      - Vault
      summary: Microsoft Azure Gets The Vault
      description: Gets the details of the vault.
      operationId: microsoftAzureVaultGet
      produces:
      - application/json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/VaultNameParameter'
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: Returns Vault Model on success.
          schema:
            $ref: '#/definitions/VaultModel'
        default:
          description: Error
          schema:
            $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Vault_Get:
          $ref: ./examples/Vault_Get.json
    put:
      tags:
      - Vault
      summary: Microsoft Azure Puts The Vault
      description: Creates the vault.
      operationId: microsoftAzureVaultCreate
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/VaultNameParameter'
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - in: body
        name: body
        description: Vault properties.
        schema:
          $ref: '#/definitions/VaultModel'
      responses:
        '200':
          description: Updated
          schema:
            $ref: '#/definitions/VaultModel'
        '201':
          description: Created
          schema:
            $ref: '#/definitions/VaultModel'
        default:
          description: Error
          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:
        Vault_Create:
          $ref: ./examples/Vault_Create.json
    patch:
      tags:
      - Vault
      summary: Microsoft Azure Updates The Vault
      description: Performs update on the vault.
      operationId: microsoftAzureVaultUpdate
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/VaultNameParameter'
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - in: body
        name: body
        description: Vault properties.
        schema:
          $ref: '#/definitions/VaultModelUpdate'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/VaultModel'
        '202':
          description: Returns success on update.
          headers:
            Azure-AsyncOperation:
              description: Tracking URL for long running operation.
              type: string
            Location:
              type: string
        default:
          description: Error
          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:
        Vault_Update:
          $ref: ./examples/Vault_Update.json
    delete:
      tags:
      - Vault
      summary: Microsoft Azure Deletes The Vault
      description: Removes the vault.
      operationId: microsoftAzureVaultDelete
      produces:
      - application/json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/VaultNameParameter'
      - $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.
              type: string
            Location:
              type: string
        '204':
          description: No Content
        default:
          description: Error
          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:
        Vault_Delete:
          $ref: ./examples/Vault_Delete.json
  /subscriptions/{subscriptionId}/providers/Microsoft.DataReplication/replicationVaults:
    get:
      tags:
      - Vault
      summary: Microsoft Azure Lists The Vaults
      description: Gets the list of vaults in the given subscription.
      operationId: microsoftAzureVaultListbysubscription
      produces:
      - application/json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - in: query
        name: continuationToken
        description: Continuation token from the previous call.
        type: string
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: Returns Vault Model Collection on success.
          schema:
            $ref: '#/definitions/VaultModelCollection'
        default:
          description: Error
          schema:
            $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        Vault_ListBySubscription:
          $ref: ./examples/Vault_ListBySubscription.json
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults:
    get:
      tags:
      - Vault
      summary: Microsoft Azure Lists The Vaults
      description: Gets the list of vaults in the given subscription and resource group.
      operationId: microsoftAzureVaultList
      produces:
      - application/json
      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.
        type: string
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: Returns Vault Model Collection on success.
          schema:
            $ref: '#/definitions/VaultModelCollection'
        default:
          description: Error
          schema:
            $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        Vault_List:
          $ref: ./examples/Vault_List.json
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}/operations/{operationId}
  : get:
      tags:
      - Vault
      summary: Microsoft Azure Gets The Vault Operation Status
      description: Tracks the results of an asynchronous operation on the vault.
      operationId: microsoftAzureVaultoperationstatusGet
      produces:
      - application/json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/VaultNameParameter'
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/OperationIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/OperationStatus'
        default:
          description: Error
          schema:
            $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        VaultOperationStatus_Get:
          $ref: ./examples/VaultOperationStatus_Get.json
definitions:
  VaultModelCollection:
    description: Vault model collection.
    type: object
    properties:
      value:
        description: Gets or sets the list of vaults.
        type: array
        items:
          $ref: '#/definitions/VaultModel'
        x-ms-identifiers: []
      nextLink:
        description: Gets or sets the value of next link.
        type: string
  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\r\nSucceeded/ 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
  VaultModelUpdate:
    description: Vault model for update.
    type: object
    properties:
      tags:
        description: Gets or sets the resource tags.
        maxLength: 15
        type: object
        additionalProperties:
          type: string
      properties:
        $ref: '#/definitions/VaultModelProperties'
      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: '#/definitions/SystemDataModel'
        readOnly: true
    x-ms-azure-resource: true
  VaultModelProperties:
    description: Vault properties.
    type: object
    properties:
      provisioningState:
        description: Gets or sets the provisioning state of the vault.
        enum:
        - Canceled
        - Creating
        - Deleting
        - Deleted
        - Failed
        - Succeeded
        - Updating
        type: string
        readOnly: true
        x-ms-enum:
          name: ProvisioningState
          modelAsString: true
      serviceResourceId:
        description: Gets or sets the service resource Id.
        type: string
        readOnly: true
      vaultType:
        description: Gets or sets the type of vault.
        enum:
        - DisasterRecovery
        - Migrate
        type: string
        x-ms-enum:
          name: ReplicationVaultType
          modelAsString: true
  VaultModel:
    description: Vault model.
    required:
    - location
    type: object
    properties:
      location:
        description: Gets or sets the location of the vault.
        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: '#/definitions/VaultModelProperties'
      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: '#/definitions/SystemDataModel'
        readOnly: true
    x-ms-azure-resource: true
  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,\r\nmanagedIdentity."
        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,\r\nmanagedIdentity."
        type: string
      lastModifiedAt:
        format: date-time
        description: Gets or sets the timestamp of resource last modification (UTC).
        type: string
parameters:
  VaultNameParameter:
    in: path
    name: vaultName
    description: The vault name.
    required: true
    type: string
    pattern: ^[a-zA-Z0-9]*$
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'