Azure Storage Accounts Data Shares API

The DataShares API from Azure Storage Accounts — 2 operation(s) for datashares.

GitHub OpenAPI

Operations 5

GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/dataShares Data shares list by storage account #
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/dataShares/{dataShareName} Data shares get #
PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/dataShares/{dataShareName} Data shares create #
PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/dataShares/{dataShareName} Data shares update #
DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/dataShares/{dataShareName} Data shares delete #

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/azure-storage-accounts:azure-storage-accounts-datashares-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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.

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

OpenAPI Specification

azure-storage-accounts-datashares-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: StorageManagementClient Data Shares API
  version: '2026-09-01'
  description: The Azure Storage Management API.
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: DataShares
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/dataShares
  : get:
      operationId: DataShares_ListByStorageAccount
      tags:
      - DataShares
      description: List all Storage DataShares in a Storage Account.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: accountName
        in: path
        description: The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 3
          pattern: ^[a-z0-9]+$
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataShareListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TypesErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Data shares list by storage account
      x-summary-source: derived
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/dataShares/{dataShareName}
  : get:
      operationId: DataShares_Get
      tags:
      - DataShares
      description: Get the specified Storage DataShare.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: accountName
        in: path
        description: The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 3
          pattern: ^[a-z0-9]+$
      - name: dataShareName
        in: path
        description: The name of the Storage DataShare.
        required: true
        schema:
          type: string
          maxLength: 63
          minLength: 3
          pattern: ^[a-z0-9](?!.*--)[a-z0-9-]{1,61}[a-z0-9]$
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataShare'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TypesErrorResponse'
      summary: Data shares get
      x-summary-source: derived
    put:
      operationId: DataShares_Create
      tags:
      - DataShares
      description: Create a Storage DataShare if it does not already exist; otherwise, error out. This API will not allow you to replace an already existing resource.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: accountName
        in: path
        description: The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 3
          pattern: ^[a-z0-9]+$
      - name: dataShareName
        in: path
        description: The name of the Storage DataShare.
        required: true
        schema:
          type: string
          maxLength: 63
          minLength: 3
          pattern: ^[a-z0-9](?!.*--)[a-z0-9-]{1,61}[a-z0-9]$
      responses:
        '200':
          description: Resource 'DataShare' update operation succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataShare'
        '201':
          description: Resource 'DataShare' create operation succeeded
          headers:
            Azure-AsyncOperation:
              description: A link to the status monitor
              schema:
                type: string
            Retry-After:
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
              schema:
                type: integer
                format: int32
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataShare'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TypesErrorResponse'
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
        final-state-schema: '#/definitions/DataShare'
      x-ms-long-running-operation: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataShare'
        description: Create a Storage DataShare if it does not already exist; otherwise, error out. This API will not allow you to replace an already existing resource.
        required: true
      summary: Data shares create
      x-summary-source: derived
    patch:
      operationId: DataShares_Update
      tags:
      - DataShares
      description: Update a Storage DataShare.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: accountName
        in: path
        description: The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 3
          pattern: ^[a-z0-9]+$
      - name: dataShareName
        in: path
        description: The name of the Storage DataShare.
        required: true
        schema:
          type: string
          maxLength: 63
          minLength: 3
          pattern: ^[a-z0-9](?!.*--)[a-z0-9-]{1,61}[a-z0-9]$
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataShare'
        '202':
          description: Resource update request accepted.
          headers:
            Location:
              description: The Location header contains the URL where the status of the long running operation can be checked.
              schema:
                type: string
            Retry-After:
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
              schema:
                type: integer
                format: int32
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TypesErrorResponse'
      x-ms-long-running-operation-options:
        final-state-via: location
        final-state-schema: '#/definitions/DataShare'
      x-ms-long-running-operation: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataShareUpdate'
        description: The updated properties of the Storage DataShare.
        required: true
      summary: Data shares update
      x-summary-source: derived
    delete:
      operationId: DataShares_Delete
      tags:
      - DataShares
      description: Delete a Storage DataShare.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: accountName
        in: path
        description: The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 3
          pattern: ^[a-z0-9]+$
      - name: dataShareName
        in: path
        description: The name of the Storage DataShare.
        required: true
        schema:
          type: string
          maxLength: 63
          minLength: 3
          pattern: ^[a-z0-9](?!.*--)[a-z0-9-]{1,61}[a-z0-9]$
      responses:
        '202':
          description: Resource deletion accepted.
          headers:
            Location:
              description: The Location header contains the URL where the status of the long running operation can be checked.
              schema:
                type: string
            Retry-After:
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
              schema:
                type: integer
                format: int32
        '204':
          description: Resource does not exist.
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TypesErrorResponse'
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-long-running-operation: true
      summary: Data shares delete
      x-summary-source: derived
components:
  parameters:
    ApiVersionParameter:
      name: api-version
      in: query
      description: The API version to use for this operation.
      required: true
      schema:
        type: string
        minLength: 1
    ResourceGroupNameParameter:
      name: resourceGroupName
      in: path
      description: The name of the resource group. The name is case insensitive.
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
        maxLength: 90
        minLength: 1
    SubscriptionIdParameter:
      name: subscriptionId
      in: path
      description: The ID of the target subscription. The value must be an UUID.
      required: true
      schema:
        type: string
        format: uuid
  schemas:
    TypesErrorResponse:
      type: object
      title: Error response
      description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).
      properties:
        error:
          $ref: '#/components/schemas/ErrorDetail'
          description: The error object.
    StorageDataShareAccessPolicyPermission:
      type: string
      description: The permissions supported in access policies for storage data share
      enum:
      - None
      - Read
      x-ms-enum:
        name: StorageDataShareAccessPolicyPermission
        modelAsString: true
        values:
        - name: None
          value: None
          description: No permission
        - name: Read
          value: Read
          description: Read permission
    StorageDataShareAsset:
      type: object
      description: Properties of a shared resource.
      properties:
        assetPath:
          type: string
          description: 'Source Path to be shared. It can be a folder or a blob.

            The asset path should contain container name followed by path within the container, e.g. /container1/logs/external.'
        displayName:
          type: string
          description: Consumer visible name of the original path.
      required:
      - assetPath
      - displayName
    StorageDataShareAccessPolicy:
      type: object
      description: Policy that specify the permission allowed to a managed identity
      properties:
        principalId:
          type: string
          description: The AAD principal ID of the Managed Identity.
          pattern: ^[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}$
        tenantId:
          type: string
          description: The AAD tenant ID of the Managed Identity.
          pattern: ^[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}$
        permission:
          $ref: '#/components/schemas/StorageDataShareAccessPolicyPermission'
          description: Allowed permissions. Currently, only supported value is Read.
      required:
      - principalId
      - tenantId
      - permission
    StorageDataSharePropertiesUpdate:
      type: object
      description: The storage datashare properties
      properties:
        description:
          type: string
          description: Arbitrary description of this Data Share. Max 250 characters.
          maxLength: 250
        accessPolicies:
          type: array
          description: 'List of access policies that specify the permission allowed to a managed identity.

            For Create - This property is required and cannot be null. If no access policies are provided at creation time, specify an empty array.

            For Update - This property is optional. If set to null or not passed, the existing access policies are left unchanged.

            If provided with a non-null value, the existing access policies are replaced with the specified list.'
          items:
            $ref: '#/components/schemas/StorageDataShareAccessPolicy'
          x-ms-identifiers: []
        assets:
          type: array
          description: 'List of assets that specify the properties of the shared resources.

            For Create - This property is required and cannot be null. If no assets are provided at creation time, specify an empty array.

            For Update - This property is optional. If set to null or not passed, the existing assets are left unchanged.

            If provided with a non-null value, the existing assets are replaced with the specified list.'
          items:
            $ref: '#/components/schemas/StorageDataShareAsset'
          x-ms-identifiers: []
    NativeDataSharingProvisioningState:
      type: string
      description: Provisioning state of the resource at the time the operation was called.
      enum:
      - Accepted
      - Creating
      - Succeeded
      - Deleting
      - Canceled
      - Failed
      x-ms-enum:
        name: NativeDataSharingProvisioningState
        modelAsString: true
        values:
        - name: Accepted
          value: Accepted
          description: The request has been accepted for processing.
        - name: Creating
          value: Creating
          description: The resource is being created.
        - name: Succeeded
          value: Succeeded
          description: The resource has been successfully created.
        - name: Deleting
          value: Deleting
          description: The resource is being deleted.
        - name: Canceled
          value: Canceled
          description: The request has been canceled.
        - name: Failed
          value: Failed
          description: The resource creation or deletion has failed.
      readOnly: true
    StorageDataShareProperties:
      type: object
      description: The storage datashare properties
      properties:
        dataShareIdentifier:
          type: string
          description: System-generated GUID identifier for the Storage DataShare. Not a valid input parameter when creating.
          pattern: ^[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}$
          readOnly: true
        description:
          type: string
          description: Arbitrary description of this Data Share. Max 250 characters.
          maxLength: 250
        dataShareUri:
          type: string
          description: 'The DataShare URI to be shared with the consumer.

            URI Format - ''azds://<location>:<dataShareName>:<dataShareIdentifier>''.'
          pattern: ^azds://[a-zA-Z0-9-]+:[a-zA-Z0-9-_]+:[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}$
          readOnly: true
        accessPolicies:
          type: array
          description: 'List of access policies that specify the permission allowed to a managed identity.

            For Create - This property is required and cannot be null. If no access policies are provided at creation time, specify an empty array.

            For Update - This property is optional. If set to null or not passed, the existing access policies are left unchanged.

            If provided with a non-null value, the existing access policies are replaced with the specified list.'
          items:
            $ref: '#/components/schemas/StorageDataShareAccessPolicy'
          x-ms-identifiers: []
        assets:
          type: array
          description: 'List of assets that specify the properties of the shared resources.

            For Create - This property is required and cannot be null. If no assets are provided at creation time, specify an empty array.

            For Update - This property is optional. If set to null or not passed, the existing assets are left unchanged.

            If provided with a non-null value, the existing assets are replaced with the specified list.'
          items:
            $ref: '#/components/schemas/StorageDataShareAsset'
          x-ms-identifiers: []
        provisioningState:
          $ref: '#/components/schemas/NativeDataSharingProvisioningState'
          description: Represents the provisioning state of the storage datashare.
          readOnly: true
      required:
      - accessPolicies
      - assets
    DataShareUpdate:
      type: object
      description: A DataShare is a tracked ARM resource modeled as a sub-resource of a Storage Account.
      properties:
        properties:
          $ref: '#/components/schemas/StorageDataSharePropertiesUpdate'
          description: The properties of the Storage DataShare.
      allOf:
      - $ref: '#/components/schemas/TrackedResourceUpdate'
    TrackedResourceUpdate:
      type: object
      description: The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'
      properties:
        tags:
          type: object
          description: Resource tags.
          additionalProperties:
            type: string
      allOf:
      - $ref: '#/components/schemas/Resource'
    DataShareListResult:
      type: object
      description: The response of a DataShare list operation.
      properties:
        value:
          type: array
          description: The DataShare items on this page
          items:
            $ref: '#/components/schemas/DataShare'
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
      required:
      - value
    Resource:
      type: object
      title: Resource
      description: Common fields that are returned in the response for all Azure Resource Manager resources
      properties:
        id:
          type: string
          format: arm-id
          description: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
          readOnly: true
        name:
          type: string
          description: The name of the resource
          readOnly: true
        type:
          type: string
          description: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
          readOnly: true
        systemData:
          $ref: '#/components/schemas/systemData'
          description: Azure Resource Manager metadata containing createdBy and modifiedBy information.
          readOnly: true
      x-ms-azure-resource: true
    TrackedResource:
      type: object
      title: Tracked Resource
      description: The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'
      properties:
        tags:
          type: object
          description: Resource tags.
          additionalProperties:
            type: string
          x-ms-mutability:
          - read
          - create
          - update
        location:
          type: string
          description: The geo-location where the resource lives
          x-ms-mutability:
          - read
          - create
      required:
      - location
      allOf:
      - $ref: '#/components/schemas/Resource'
    DataShare:
      type: object
      description: A DataShare is a tracked ARM resource modeled as a sub-resource of a Storage Account.
      properties:
        properties:
          $ref: '#/components/schemas/StorageDataShareProperties'
          description: The properties of the Storage DataShare.
      required:
      - properties
      allOf:
      - $ref: '#/components/schemas/TrackedResource'
  securitySchemes:
    azure_auth:
      type: oauth2
      flows:
        implicit:
          scopes:
            user_impersonation: impersonate your user account
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
      description: Azure Active Directory OAuth2 Flow.