swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector ShareResource API
schemes:
- https
tags:
- name: ShareResource
paths:
  /shareResources:
    get:
      tags:
      - ShareResource
      summary: Microsoft Azure Api Operation To List Shareresources
      description: List share resources
      operationId: microsoftAzureShareresourcesList
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/api-version'
      - $ref: '#/parameters/filter'
      - $ref: '#/parameters/orderby'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/ShareResourceList'
        default:
          description: Default error response.
          schema:
            $ref: '#/definitions/PurviewShareError'
          headers:
            x-ms-error-code:
              description: The error code
              type: string
      x-ms-examples:
        ShareResources_List:
          $ref: ./examples/ShareResources_List.json
      x-ms-pageable:
        nextLinkName: nextLink
definitions:
  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
  StoreReference:
    description: A Store Reference for an artifact or sink.
    type: object
    properties:
      referenceName:
        description: Reference name for resource associated with the sink or artifact.
        type: string
      type:
        $ref: '#/definitions/ReferenceNameType'
  ShareResource:
    description: A share resource.
    type: object
    allOf:
    - $ref: '#/definitions/ProxyResource'
    properties:
      receivedSharesCount:
        format: int32
        description: A count of Received Shares associated with the Microsoft.Azure.Purview.Share.ApiService.V3.DataTransferObjects.ShareResource.
        type: integer
      sentSharesCount:
        format: int32
        description: A count of Sent Shares associated with the Microsoft.Azure.Purview.Share.ApiService.V3.DataTransferObjects.ShareResource.
        type: integer
      storeKind:
        $ref: '#/definitions/StoreKind'
      storeReference:
        $ref: '#/definitions/StoreReference'
  ReferenceNameType:
    description: Defines the type of resource being shared
    enum:
    - ArmResourceReference
    type: string
    x-ms-enum:
      name: ReferenceNameType
      modelAsString: true
      values:
      - value: ArmResourceReference
        description: The type of reference is an ARM resource
        name: Arm resource reference
  StoreKind:
    description: The types of asset.
    enum:
    - AdlsGen2Account
    - BlobAccount
    type: string
    x-ms-enum:
      name: StoreKind
      modelAsString: true
      values:
      - value: AdlsGen2Account
        description: The store kind is a Adls Gen 2 storage account
        name: Adls gen 2 storage account store kind
      - value: BlobAccount
        description: The store kind is a Blob storage account
        name: Blob storage account store 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
  ShareResourceList:
    description: A page of ShareResource results.
    required:
    - value
    type: object
    properties:
      nextLink:
        format: url
        description: The Url of next result page.
        type: string
      value:
        description: Collection of items of type ShareResource
        type: array
        items:
          $ref: '#/definitions/ShareResource'
parameters:
  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'