DataShare

A DataShare is a tracked ARM resource modeled as a sub-resource of a Storage Account.

Microsoft AzureBlob StorageCloud StorageFile StorageQueue StorageStorageTable Storage

Properties

Name Type Description
id string Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name string The name of the resource
type string The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
systemData object Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags object Resource tags.
location string The geo-location where the resource lives
properties object The properties of the Storage DataShare.
View JSON Schema on GitHub

JSON Schema

azure-storage-accounts-data-share-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/azure-storage-accounts/json-schema/azure-storage-accounts-data-share-schema.json",
  "title": "DataShare",
  "description": "A DataShare is a tracked ARM resource modeled as a sub-resource of a Storage Account.",
  "x-generated": "2026-11-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/azure-storage-accounts-datashares-api-openapi.yml#/components/schemas/DataShare",
  "type": "object",
  "properties": {
    "properties": {
      "$ref": "#/$defs/StorageDataShareProperties",
      "description": "The properties of the Storage DataShare."
    }
  },
  "required": [
    "properties"
  ],
  "allOf": [
    {
      "$ref": "#/$defs/TrackedResource"
    }
  ],
  "$defs": {
    "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
    },
    "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": "#/$defs/systemData",
          "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information.",
          "readOnly": true
        }
      },
      "x-ms-azure-resource": true
    },
    "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": "#/$defs/StorageDataShareAccessPolicyPermission",
          "description": "Allowed permissions. Currently, only supported value is Read."
        }
      },
      "required": [
        "principalId",
        "tenantId",
        "permission"
      ]
    },
    "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.\nThe 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"
      ]
    },
    "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.\nURI 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.\nFor Create - This property is required and cannot be null. If no access policies are provided at creation time, specify an empty array.\nFor Update - This property is optional. If set to null or not passed, the existing access policies are left unchanged.\nIf provided with a non-null value, the existing access policies are replaced with the specified list.",
          "items": {
            "$ref": "#/$defs/StorageDataShareAccessPolicy"
          },
          "x-ms-identifiers": []
        },
        "assets": {
          "type": "array",
          "description": "List of assets that specify the properties of the shared resources.\nFor Create - This property is required and cannot be null. If no assets are provided at creation time, specify an empty array.\nFor Update - This property is optional. If set to null or not passed, the existing assets are left unchanged.\nIf provided with a non-null value, the existing assets are replaced with the specified list.",
          "items": {
            "$ref": "#/$defs/StorageDataShareAsset"
          },
          "x-ms-identifiers": []
        },
        "provisioningState": {
          "$ref": "#/$defs/NativeDataSharingProvisioningState",
          "description": "Represents the provisioning state of the storage datashare.",
          "readOnly": true
        }
      },
      "required": [
        "accessPolicies",
        "assets"
      ]
    },
    "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": "#/$defs/Resource"
        }
      ]
    }
  }
}

Work with this as data

Every JSON Schema 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 schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • 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 JSON Schema
curl "https://apis.io/api/v1/json-schemas/azure-storage-accounts-data-share"
All schemas
curl "https://apis.io/api/v1/json-schemas?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.