swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector ReceivedShare API
schemes:
- https
tags:
- name: ReceivedShare
paths:
  /receivedShares/{receivedShareId}:
    get:
      tags:
      - ReceivedShare
      summary: Microsoft Azure Get A Received Share By Unique Id
      description: Get a received share
      operationId: microsoftAzureReceivedsharesGet
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/receivedShareId'
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/ReceivedShare'
        default:
          description: Default error response.
          schema:
            $ref: '#/definitions/PurviewShareError'
          headers:
            x-ms-error-code:
              description: The error code
              type: string
      x-ms-examples:
        ReceivedShares_Get:
          $ref: ./examples/ReceivedShares_Get.json
        ReceivedShares_GetAdlsGen2Account:
          $ref: ./examples/ReceivedShares_GetAdlsGen2Account.json
        ReceivedShares_GetBlobAccount:
          $ref: ./examples/ReceivedShares_GetBlobAccount.json
    put:
      tags:
      - ReceivedShare
      summary: Microsoft Azure Create Or Replace A Received Share
      description: Update changes to a received share
      operationId: microsoftAzureReceivedsharesCreateorreplace
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/receivedShareId'
      - $ref: '#/parameters/api-version'
      - in: body
        name: receivedShare
        description: The received share to create or replace
        required: true
        schema:
          $ref: '#/definitions/ReceivedShare'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/ReceivedShare'
          headers:
            Operation-Location:
              description: The URL to track the status of the long running operation.
              type: string
        '201':
          description: Success
          schema:
            $ref: '#/definitions/ReceivedShare'
          headers:
            Operation-Location:
              description: The URL to track the status of the long running operation.
              type: string
        default:
          description: Default error response.
          schema:
            $ref: '#/definitions/PurviewShareError'
          headers:
            x-ms-error-code:
              description: The error code
              type: string
      x-ms-examples:
        ReceivedShares_CreateOrReplace:
          $ref: ./examples/ReceivedShares_CreateOrReplace.json
        ReceivedShares_CreateOrReplaceAdlsGen2Account:
          $ref: ./examples/ReceivedShares_CreateOrReplaceAdlsGen2Account.json
        ReceivedShares_CreateOrReplaceBlobAccount:
          $ref: ./examples/ReceivedShares_CreateOrReplaceBlobAccount.json
      x-ms-long-running-operation: true
    delete:
      tags:
      - ReceivedShare
      summary: Microsoft Azure Deletes A Received Share
      description: Delete a received share
      operationId: microsoftAzureReceivedsharesDelete
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/receivedShareId'
      - $ref: '#/parameters/api-version'
      responses:
        '202':
          description: Accepted
          schema:
            $ref: '#/definitions/OperationResponse'
          headers:
            Operation-Location:
              description: The URL to track the status of the long running operation.
              type: string
        default:
          description: Default error response.
          schema:
            $ref: '#/definitions/PurviewShareError'
          headers:
            x-ms-error-code:
              description: The error code
              type: string
      x-ms-examples:
        ReceivedShares_Delete:
          $ref: ./examples/ReceivedShares_Delete.json
      x-ms-long-running-operation: true
  /receivedShares/attached:
    get:
      tags:
      - ReceivedShare
      summary: Microsoft Azure Get A List Of Attached Received Shares
      description: List attached received shares
      operationId: microsoftAzureReceivedsharesListattached
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/referenceName'
      - $ref: '#/parameters/api-version'
      - $ref: '#/parameters/filter'
      - $ref: '#/parameters/orderby'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/ReceivedShareList'
        default:
          description: Default error response.
          schema:
            $ref: '#/definitions/PurviewShareError'
          headers:
            x-ms-error-code:
              description: The error code
              type: string
      x-ms-examples:
        ReceivedShares_ListAttached:
          $ref: ./examples/ReceivedShares_ListAttached.json
      x-ms-pageable:
        nextLinkName: nextLink
  /receivedShares/detached:
    get:
      tags:
      - ReceivedShare
      summary: Microsoft Azure Get A List Of Detached Received Shares
      description: List detached received shares
      operationId: microsoftAzureReceivedsharesListdetached
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/api-version'
      - $ref: '#/parameters/filter'
      - $ref: '#/parameters/orderby'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/ReceivedShareList'
        default:
          description: Default error response.
          schema:
            $ref: '#/definitions/PurviewShareError'
          headers:
            x-ms-error-code:
              description: The error code
              type: string
      x-ms-examples:
        ReceivedShares_ListDetached:
          $ref: ./examples/ReceivedShares_ListDetached.json
      x-ms-pageable:
        nextLinkName: nextLink
definitions:
  ReceivedShare:
    description: A received share data transfer object.
    required:
    - shareKind
    type: object
    allOf:
    - $ref: '#/definitions/ProxyResource'
    properties:
      shareKind:
        $ref: '#/definitions/ShareKind'
    discriminator: shareKind
  OperationStatus:
    description: States for long running operations.
    enum:
    - Running
    - TransientFailure
    - Succeeded
    - Failed
    - NotStarted
    type: string
    x-ms-enum:
      name: OperationStatus
      modelAsString: true
      values:
      - value: Running
        description: The long running operation is in 'Running' state
        name: Long running operation state is 'Running'
      - value: TransientFailure
        description: The long running operation hit a transient failure
        name: Long running operation state is 'TransientFailure'
      - value: Succeeded
        description: The long running operation is in 'Succeeded' state
        name: Long running operation state is 'Succeeded'
      - value: Failed
        description: The long running operation is in 'Failed' state
        name: Long running operation state is 'Failed'
      - value: NotStarted
        description: The long running operation has not started
        name: Long running operation state is 'NotStarted'
  PurviewShareError:
    description: The purview share error model.
    required:
    - error
    type: object
    properties:
      error:
        $ref: '#/definitions/PurviewShareErrorInfo'
  ProxyResource:
    description: Base data transfer object implementation for proxy resources.
    type: object
    properties:
      id:
        description: The unique id of the resource.
        type: string
        readOnly: true
      type:
        description: Type of the resource.
        type: string
        readOnly: true
  ReceivedShareList:
    description: List of received shares.
    required:
    - value
    type: object
    properties:
      nextLink:
        format: url
        description: The Url of next result page.
        type: string
      value:
        description: Collection of items of type ReceivedShare
        type: array
        items:
          $ref: '#/definitions/ReceivedShare'
  ShareKind:
    description: Defines the supported types for share.
    enum:
    - InPlace
    type: string
    x-ms-enum:
      name: ShareKind
      modelAsString: true
      values:
      - value: InPlace
        description: The type of share is in-place sharing
        name: In place share kind
  PurviewShareErrorInfo:
    description: The purview share error body model.
    required:
    - code
    - message
    type: object
    properties:
      code:
        description: Code of the error
        type: string
      details:
        description: Nested details of the error model
        type: array
        items:
          $ref: '#/definitions/PurviewShareErrorInfo'
      message:
        description: Message of the error
        type: string
      target:
        description: Target of the error
        type: string
  OperationResponse:
    description: Response for long running operation.
    required:
    - status
    type: object
    properties:
      endTime:
        format: date-time
        description: End time of the long running operation. Represented in the standard date-time format as defined by [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339)
        type: string
      error:
        $ref: '#/definitions/PurviewShareErrorInfo'
      id:
        description: Job id of the long running operation
        type: string
      startTime:
        format: date-time
        description: Start time of the long running operation. Represented in the standard date-time format as defined by [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339)
        type: string
      status:
        $ref: '#/definitions/OperationStatus'
parameters:
  referenceName:
    in: query
    name: referenceName
    description: A name that references a data store.
    required: true
    type: string
    x-ms-parameter-location: method
  receivedShareId:
    in: path
    name: receivedShareId
    description: Id of the received share
    required: true
    type: string
    maxLength: 36
    pattern: ^(?:\{{0,1}(?:[0-9a-fA-F]){8}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){12}\}{0,1})$
    x-ms-parameter-location: method
  filter:
    in: query
    name: filter
    description: Filters the results using OData syntax
    type: string
    x-ms-parameter-location: method
  orderby:
    in: query
    name: orderby
    description: Sorts the results using OData syntax
    type: string
    x-ms-parameter-location: method
  api-version:
    in: query
    name: api-version
    description: The api version to use
    required: true
    type: string
    x-ms-parameter-location: client
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'