FileShareItems

Response schema. Contains list of shares returned, and if paging is requested or required, a URL to next page of shares.

Microsoft AzureBlob StorageCloud StorageFile StorageQueue StorageStorageTable Storage

Properties

Name Type Description
value array The FileShareItem items on this page
nextLink string The link to the next page of items
View JSON Schema on GitHub

JSON Schema

azure-storage-accounts-file-share-items-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-file-share-items-schema.json",
  "title": "FileShareItems",
  "description": "Response schema. Contains list of shares returned, and if paging is requested or required, a URL to next page of shares.",
  "x-generated": "2026-11-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/azure-storage-accounts-fileservices-api-openapi.yml#/components/schemas/FileShareItems",
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "description": "The FileShareItem items on this page",
      "items": {
        "$ref": "#/$defs/FileShareItem"
      },
      "readOnly": true
    },
    "nextLink": {
      "type": "string",
      "format": "uri",
      "description": "The link to the next page of items"
    }
  },
  "required": [
    "value"
  ],
  "$defs": {
    "AccessPolicy": {
      "type": "object",
      "properties": {
        "startTime": {
          "type": "string",
          "format": "date-time",
          "description": "Start time of the access policy"
        },
        "expiryTime": {
          "type": "string",
          "format": "date-time",
          "description": "Expiry time of the access policy"
        },
        "permission": {
          "type": "string",
          "description": "List of abbreviated permissions."
        }
      }
    },
    "AzureEntityResource": {
      "type": "object",
      "title": "Entity Resource",
      "description": "The resource model definition for an Azure Resource Manager resource with an etag.",
      "properties": {
        "etag": {
          "type": "string",
          "description": "Resource Etag.",
          "readOnly": true
        }
      },
      "allOf": [
        {
          "$ref": "#/$defs/Resource"
        }
      ]
    },
    "EnabledProtocols": {
      "type": "string",
      "description": "The authentication protocol that is used for the file share. Can only be specified when creating a share.",
      "enum": [
        "SMB",
        "NFS"
      ],
      "x-ms-enum": {
        "name": "EnabledProtocols",
        "modelAsString": true,
        "values": [
          {
            "name": "SMB",
            "value": "SMB"
          },
          {
            "name": "NFS",
            "value": "NFS"
          }
        ]
      }
    },
    "FileShareItem": {
      "type": "object",
      "description": "The file share properties be listed out.",
      "properties": {
        "properties": {
          "$ref": "#/$defs/FileShareProperties",
          "description": "The file share properties be listed out.",
          "x-ms-client-flatten": true
        }
      },
      "allOf": [
        {
          "$ref": "#/$defs/AzureEntityResource"
        }
      ]
    },
    "FileShareProperties": {
      "type": "object",
      "description": "The properties of the file share.",
      "properties": {
        "lastModifiedTime": {
          "type": "string",
          "format": "date-time",
          "description": "Returns the date and time the share was last modified.",
          "readOnly": true
        },
        "metadata": {
          "type": "object",
          "description": "A name-value pair to associate with the share as metadata.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "shareQuota": {
          "type": "integer",
          "format": "int32",
          "description": "The provisioned size of the share, in gibibytes. Must be greater than 0, and less than or equal to 5TB (5120). For Large File Shares, the maximum size is 102400. For file shares created under Files Provisioned v2 account type, please refer to the GetFileServiceUsage API response for the minimum and maximum allowed provisioned storage size."
        },
        "provisionedIops": {
          "type": "integer",
          "format": "int32",
          "description": "The provisioned IOPS of the share. This property is only for file shares created under Files Provisioned v2 account type. Please refer to the GetFileServiceUsage API response for the minimum and maximum allowed value for provisioned IOPS."
        },
        "provisionedBandwidthMibps": {
          "type": "integer",
          "format": "int32",
          "description": "The provisioned bandwidth of the share, in mebibytes per second. This property is only for file shares created under Files Provisioned v2 account type. Please refer to the GetFileServiceUsage API response for the minimum and maximum allowed value for provisioned bandwidth."
        },
        "includedBurstIops": {
          "type": "integer",
          "format": "int32",
          "description": "The calculated burst IOPS of the share. This property is only for file shares created under Files Provisioned v2 account type.",
          "readOnly": true
        },
        "maxBurstCreditsForIops": {
          "type": "integer",
          "format": "int64",
          "description": "The calculated maximum burst credits for the share. This property is only for file shares created under Files Provisioned v2 account type.",
          "readOnly": true
        },
        "nextAllowedQuotaDowngradeTime": {
          "type": "string",
          "format": "date-time-rfc7231",
          "description": "Returns the next allowed provisioned storage size downgrade time for the share. This property is only for file shares created under Files Provisioned v1 SSD and Files Provisioned v2 account type",
          "readOnly": true
        },
        "nextAllowedProvisionedIopsDowngradeTime": {
          "type": "string",
          "format": "date-time-rfc7231",
          "description": "Returns the next allowed provisioned IOPS downgrade time for the share. This property is only for file shares created under Files Provisioned v2 account type.",
          "readOnly": true
        },
        "nextAllowedProvisionedBandwidthDowngradeTime": {
          "type": "string",
          "format": "date-time-rfc7231",
          "description": "Returns the next allowed provisioned bandwidth downgrade time for the share. This property is only for file shares created under Files Provisioned v2 account type.",
          "readOnly": true
        },
        "enabledProtocols": {
          "$ref": "#/$defs/EnabledProtocols",
          "description": "The authentication protocol that is used for the file share. Can only be specified when creating a share.",
          "x-ms-mutability": [
            "read",
            "create"
          ]
        },
        "rootSquash": {
          "$ref": "#/$defs/RootSquashType",
          "description": "The property is for NFS share only. The default is NoRootSquash."
        },
        "version": {
          "type": "string",
          "description": "The version of the share.",
          "readOnly": true
        },
        "deleted": {
          "type": "boolean",
          "description": "Indicates whether the share was deleted.",
          "readOnly": true
        },
        "deletedTime": {
          "type": "string",
          "format": "date-time",
          "description": "The deleted time if the share was deleted.",
          "readOnly": true
        },
        "remainingRetentionDays": {
          "type": "integer",
          "format": "int32",
          "description": "Remaining retention days for share that was soft deleted.",
          "readOnly": true
        },
        "accessTier": {
          "$ref": "#/$defs/ShareAccessTier",
          "description": "Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium."
        },
        "accessTierChangeTime": {
          "type": "string",
          "format": "date-time",
          "description": "Indicates the last modification time for share access tier.",
          "readOnly": true
        },
        "accessTierStatus": {
          "type": "string",
          "description": "Indicates if there is a pending transition for access tier.",
          "readOnly": true
        },
        "shareUsageBytes": {
          "type": "integer",
          "format": "int64",
          "description": "The approximate size of the data stored on the share. Note that this value may not include all recently created or recently resized files.",
          "readOnly": true
        },
        "leaseStatus": {
          "$ref": "#/$defs/LeaseStatus",
          "description": "The lease status of the share.",
          "readOnly": true
        },
        "leaseState": {
          "$ref": "#/$defs/LeaseState",
          "description": "Lease state of the share.",
          "readOnly": true
        },
        "leaseDuration": {
          "$ref": "#/$defs/LeaseDuration",
          "description": "Specifies whether the lease on a share is of infinite or fixed duration, only when the share is leased.",
          "readOnly": true
        },
        "signedIdentifiers": {
          "type": "array",
          "description": "List of stored access policies specified on the share.",
          "items": {
            "$ref": "#/$defs/SignedIdentifier"
          }
        },
        "snapshotTime": {
          "type": "string",
          "format": "date-time",
          "description": "Creation time of share snapshot returned in the response of list shares with expand param \"snapshots\".",
          "readOnly": true
        },
        "fileSharePaidBursting": {
          "$ref": "#/$defs/FileSharePropertiesFileSharePaidBursting",
          "description": "File Share Paid Bursting properties."
        }
      }
    },
    "FileSharePropertiesFileSharePaidBursting": {
      "type": "object",
      "description": "File Share Paid Bursting properties.",
      "properties": {
        "paidBurstingEnabled": {
          "type": "boolean",
          "description": "Indicates whether paid bursting is enabled for the share. This property is only for file shares created under Files Provisioned v1 SSD account type."
        },
        "paidBurstingMaxIops": {
          "type": "integer",
          "format": "int32",
          "description": "The maximum paid bursting IOPS for the share. This property is only for file shares created under Files Provisioned v1 SSD account type. The maximum allowed value is 102400 which is the maximum allowed IOPS for a share."
        },
        "paidBurstingMaxBandwidthMibps": {
          "type": "integer",
          "format": "int32",
          "description": "The maximum paid bursting bandwidth for the share, in mebibytes per second. This property is only for file shares created under Files Provisioned v1 SSD account type. The maximum allowed value is 10340 which is the maximum allowed bandwidth for a share."
        }
      }
    },
    "LeaseDuration": {
      "type": "string",
      "description": "Specifies whether the lease on a container is of infinite or fixed duration, only when the container is leased.",
      "enum": [
        "Infinite",
        "Fixed"
      ],
      "x-ms-enum": {
        "name": "LeaseDuration",
        "modelAsString": true,
        "values": [
          {
            "name": "Infinite",
            "value": "Infinite"
          },
          {
            "name": "Fixed",
            "value": "Fixed"
          }
        ]
      }
    },
    "LeaseState": {
      "type": "string",
      "description": "Lease state of the container.",
      "enum": [
        "Available",
        "Leased",
        "Expired",
        "Breaking",
        "Broken"
      ],
      "x-ms-enum": {
        "name": "LeaseState",
        "modelAsString": true,
        "values": [
          {
            "name": "Available",
            "value": "Available"
          },
          {
            "name": "Leased",
            "value": "Leased"
          },
          {
            "name": "Expired",
            "value": "Expired"
          },
          {
            "name": "Breaking",
            "value": "Breaking"
          },
          {
            "name": "Broken",
            "value": "Broken"
          }
        ]
      }
    },
    "LeaseStatus": {
      "type": "string",
      "description": "The lease status of the container.",
      "enum": [
        "Locked",
        "Unlocked"
      ],
      "x-ms-enum": {
        "name": "LeaseStatus",
        "modelAsString": true,
        "values": [
          {
            "name": "Locked",
            "value": "Locked"
          },
          {
            "name": "Unlocked",
            "value": "Unlocked"
          }
        ]
      }
    },
    "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
    },
    "RootSquashType": {
      "type": "string",
      "description": "The property is for NFS share only. The default is NoRootSquash.",
      "enum": [
        "NoRootSquash",
        "RootSquash",
        "AllSquash"
      ],
      "x-ms-enum": {
        "name": "RootSquashType",
        "modelAsString": true,
        "values": [
          {
            "name": "NoRootSquash",
            "value": "NoRootSquash"
          },
          {
            "name": "RootSquash",
            "value": "RootSquash"
          },
          {
            "name": "AllSquash",
            "value": "AllSquash"
          }
        ]
      }
    },
    "ShareAccessTier": {
      "type": "string",
      "description": "Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium.",
      "enum": [
        "TransactionOptimized",
        "Hot",
        "Cool",
        "Premium"
      ],
      "x-ms-enum": {
        "name": "ShareAccessTier",
        "modelAsString": true,
        "values": [
          {
            "name": "TransactionOptimized",
            "value": "TransactionOptimized"
          },
          {
            "name": "Hot",
            "value": "Hot"
          },
          {
            "name": "Cool",
            "value": "Cool"
          },
          {
            "name": "Premium",
            "value": "Premium"
          }
        ]
      }
    },
    "SignedIdentifier": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "An unique identifier of the stored access policy."
        },
        "accessPolicy": {
          "$ref": "#/$defs/AccessPolicy",
          "description": "Access policy"
        }
      }
    }
  }
}

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-file-share-items"
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.