Microsoft Azure ReceivedShare API

The ReceivedShare API from Microsoft Azure — 3 operation(s) for receivedshare.

Documentation GitHub OpenAPI

Operations 5

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /receivedShares/{receivedShareId} Get a received data share · Microsoft Azure Get A Received Share By Unique Id #

Ask an LLM

“What are the details of a data share someone sent me?”

“Can I look up a received share by its ID?”

Tell an agent

Get received share {id}.

Show the details of the share I received with ID {id}.

PUT /receivedShares/{receivedShareId} Update a received data share · Microsoft Azure Create Or Replace A Received Share #

Ask an LLM

“How do I accept or change a data share I have received?”

“Can I attach a received share to a target by updating it?”

Tell an agent

Update received share {id} of kind {kind}.

Save changes to received share {id}.

DELETE /receivedShares/{receivedShareId} Delete a received data share · Microsoft Azure Deletes A Received Share #

Ask an LLM

“How do I delete a data share I received and no longer want?”

“Can I remove a received share by ID?”

Tell an agent destructive · confirm first

Delete received share {id}.

Remove the share I received with ID {id}.

GET /receivedShares/attached List received shares attached to a resource · Microsoft Azure Get A List Of Attached Received Shares #

Ask an LLM

“Which received shares are attached to a given target resource?”

“Can I sort or filter the received shares attached to one resource?”

Tell an agent

List received shares attached to {ref}.

Show attached received shares for {ref} ordered by {order}.

GET /receivedShares/detached List detached received shares · Microsoft Azure Get A List Of Detached Received Shares #

Ask an LLM

“Which shares have I received but not attached to anything yet?”

“Can I filter received shares that are still detached?”

Tell an agent

List my detached received shares.

Show detached received shares matching {filter}.

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/microsoft-azure:microsoft-azure-receivedshare-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Microsoft Azure Purview Share Client Received Share API
  description: Creates a data plane client for Purview Share.
  version: 2023-05-30-preview
security:
- azureAuth:
  - https://purview.azure.net/.default
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
      parameters:
      - $ref: '#/components/parameters/receivedShareId'
      - $ref: '#/components/parameters/api-version'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReceivedShare'
        default:
          description: Default error response.
          headers:
            x-ms-error-code:
              description: The error code
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PurviewShareError'
      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
      parameters:
      - $ref: '#/components/parameters/receivedShareId'
      - $ref: '#/components/parameters/api-version'
      responses:
        '200':
          description: Success
          headers:
            Operation-Location:
              description: The URL to track the status of the long running operation.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReceivedShare'
        '201':
          description: Success
          headers:
            Operation-Location:
              description: The URL to track the status of the long running operation.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReceivedShare'
        default:
          description: Default error response.
          headers:
            x-ms-error-code:
              description: The error code
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PurviewShareError'
      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
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReceivedShare'
        description: The received share to create or replace
        required: true
    delete:
      tags:
      - ReceivedShare
      summary: Microsoft Azure Deletes A Received Share
      description: Delete a received share
      operationId: microsoftAzureReceivedsharesDelete
      parameters:
      - $ref: '#/components/parameters/receivedShareId'
      - $ref: '#/components/parameters/api-version'
      responses:
        '202':
          description: Accepted
          headers:
            Operation-Location:
              description: The URL to track the status of the long running operation.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationResponse'
        default:
          description: Default error response.
          headers:
            x-ms-error-code:
              description: The error code
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PurviewShareError'
      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
      parameters:
      - $ref: '#/components/parameters/referenceName'
      - $ref: '#/components/parameters/api-version'
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/orderby'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReceivedShareList'
        default:
          description: Default error response.
          headers:
            x-ms-error-code:
              description: The error code
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PurviewShareError'
      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
      parameters:
      - $ref: '#/components/parameters/api-version'
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/orderby'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReceivedShareList'
        default:
          description: Default error response.
          headers:
            x-ms-error-code:
              description: The error code
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PurviewShareError'
      x-ms-examples:
        ReceivedShares_ListDetached:
          $ref: ./examples/ReceivedShares_ListDetached.json
      x-ms-pageable:
        nextLinkName: nextLink
components:
  parameters:
    api-version:
      in: query
      name: api-version
      description: The api version to use
      required: true
      x-ms-parameter-location: client
      schema:
        type: string
    receivedShareId:
      in: path
      name: receivedShareId
      description: Id of the received share
      required: true
      x-ms-parameter-location: method
      schema:
        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})$
    orderby:
      in: query
      name: orderby
      description: Sorts the results using OData syntax
      x-ms-parameter-location: method
      schema:
        type: string
    referenceName:
      in: query
      name: referenceName
      description: A name that references a data store.
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
    filter:
      in: query
      name: filter
      description: Filters the results using OData syntax
      x-ms-parameter-location: method
      schema:
        type: string
  schemas:
    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'
    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: '#/components/schemas/PurviewShareErrorInfo'
        message:
          description: Message of the error
          type: string
        target:
          description: Target of the error
          type: string
    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
    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
    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: '#/components/schemas/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: '#/components/schemas/OperationStatus'
    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: '#/components/schemas/ReceivedShare'
    ReceivedShare:
      description: A received share data transfer object.
      required:
      - shareKind
      type: object
      allOf:
      - $ref: '#/components/schemas/ProxyResource'
      properties:
        shareKind:
          $ref: '#/components/schemas/ShareKind'
      discriminator:
        propertyName: shareKind
    PurviewShareError:
      description: The purview share error model.
      required:
      - error
      type: object
      properties:
        error:
          $ref: '#/components/schemas/PurviewShareErrorInfo'
  securitySchemes:
    azureAuth:
      type: oauth2
      flows:
        implicit:
          scopes:
            https://purview.azure.net/.default: Purview service scope
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
      description: Azure Active Directory OAuth2 Flow.
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/components/parameters/endpoint'

Microsoft Azure ReceivedShare API

Operations 5

Documentation

Specifications

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification