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-file-shares-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: 3.2.0
info:
title: StorageManagementClient File 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: File Shares
paths:
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices/default/shares/{shareName}
: get:
operationId: FileShares_Get
tags:
- File Shares
description: Gets properties of a specified share.
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: shareName
in: path
description: The name of the file share within the specified storage account. File share names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number.
required: true
schema:
type: string
maxLength: 63
minLength: 3
- name: $expand
in: query
description: 'Optional, used to expand the properties within share''s properties. Valid values are: stats. Should be passed as a string with delimiter '',''.'
required: false
schema:
type: string
- name: x-ms-snapshot
in: header
description: Optional, used to retrieve properties of a snapshot.
required: false
schema:
type: string
responses:
'200':
description: Azure operation completed successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/FileShare'
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: '#/components/schemas/CloudError'
summary: File shares get
x-summary-source: derived
put:
operationId: FileShares_Create
tags:
- File Shares
description: Creates a new share under the specified account as described by request body. The share resource includes metadata and properties for that share. It does not include a list of the files contained by the share.
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: shareName
in: path
description: The name of the file share within the specified storage account. File share names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number.
required: true
schema:
type: string
maxLength: 63
minLength: 3
- name: $expand
in: query
description: 'Optional, used to expand the properties within share''s properties. Valid values are: snapshots. Should be passed as a string with delimiter '','''
required: false
schema:
type: string
responses:
'200':
description: Resource 'FileShare' update operation succeeded
content:
application/json:
schema:
$ref: '#/components/schemas/FileShare'
'201':
description: Resource 'FileShare' create operation succeeded
content:
application/json:
schema:
$ref: '#/components/schemas/FileShare'
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: '#/components/schemas/CloudError'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FileShare'
description: Properties of the file share to create.
required: true
summary: File shares create
x-summary-source: derived
patch:
operationId: FileShares_Update
tags:
- File Shares
description: Updates share properties as specified in request body. Properties not mentioned in the request will not be changed. Update fails if the specified share does not already exist.
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: shareName
in: path
description: The name of the file share within the specified storage account. File share names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number.
required: true
schema:
type: string
maxLength: 63
minLength: 3
responses:
'200':
description: Azure operation completed successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/FileShare'
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: '#/components/schemas/CloudError'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FileShare'
description: Properties to update for the file share.
required: true
summary: File shares update
x-summary-source: derived
delete:
operationId: FileShares_Delete
tags:
- File Shares
description: Deletes specified share under its 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]+$
- name: shareName
in: path
description: The name of the file share within the specified storage account. File share names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number.
required: true
schema:
type: string
maxLength: 63
minLength: 3
- name: x-ms-snapshot
in: header
description: Optional, used to delete a snapshot.
required: false
schema:
type: string
- name: $include
in: query
description: 'Optional. Valid values are: snapshots, leased-snapshots, none. The default value is snapshots. For ''snapshots'', the file share is deleted including all of its file share snapshots. If the file share contains leased-snapshots, the deletion fails. For ''leased-snapshots'', the file share is deleted included all of its file share snapshots (leased/unleased). For ''none'', the file share is deleted if it has no share snapshots. If the file share contains any snapshots (leased or unleased), the deletion fails.'
required: false
schema:
type: string
responses:
'200':
description: Resource deleted successfully.
'204':
description: Resource does not exist.
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: '#/components/schemas/CloudError'
summary: File shares delete
x-summary-source: derived
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices/default/shares/{shareName}/lease
: post:
operationId: FileShares_Lease
tags:
- File Shares
description: The Lease Share operation establishes and manages a lock on a share for delete operations. The lock duration can be 15 to 60 seconds, or can be infinite.
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: shareName
in: path
description: The name of the file share within the specified storage account. File share names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number.
required: true
schema:
type: string
maxLength: 63
minLength: 3
- name: x-ms-snapshot
in: header
description: Optional. Specify the snapshot time to lease a snapshot.
required: false
schema:
type: string
responses:
'200':
description: Azure operation completed successfully.
headers:
ETag:
description: The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Match or If-None-Match headers.
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/LeaseShareResponse'
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: '#/components/schemas/CloudError'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LeaseShareRequest'
description: The content of the action request
summary: File shares lease
x-summary-source: derived
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices/default/shares/{shareName}/restore
: post:
operationId: FileShares_Restore
tags:
- File Shares
description: Restore a file share within a valid retention days if share soft delete is enabled
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: shareName
in: path
description: The name of the file share within the specified storage account. File share names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number.
required: true
schema:
type: string
maxLength: 63
minLength: 3
responses:
'200':
description: The request has succeeded.
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: '#/components/schemas/CloudError'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DeletedShare'
required: true
summary: File shares restore
x-summary-source: derived
components:
schemas:
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.
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
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
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.
LeaseShareResponse:
type: object
description: Lease Share response schema.
properties:
leaseId:
type: string
description: Returned unique lease ID that must be included with any request to delete the share, or to renew, change, or release the lease.
leaseTimeSeconds:
type: string
description: Approximate time remaining in the lease period, in seconds.
LeaseShareRequest:
type: object
description: Lease Share request schema.
properties:
action:
$ref: '#/components/schemas/LeaseShareAction'
description: Specifies the lease action. Can be one of the available actions.
leaseId:
type: string
description: Identifies the lease. Can be specified in any valid GUID string format.
breakPeriod:
type: integer
format: int32
description: Optional. For a break action, proposed duration the lease should continue before it is broken, in seconds, between 0 and 60.
leaseDuration:
type: integer
format: int32
description: Required for acquire. Specifies the duration of the lease, in seconds, or negative one (-1) for a lease that never expires.
proposedLeaseId:
type: string
description: Optional for acquire, required for change. Proposed lease ID, in a GUID string format.
required:
- action
CloudError:
type: object
description: An error response from the Storage service.
properties:
error:
$ref: '#/components/schemas/CloudErrorBody'
description: An error response from the Storage service.
x-ms-external: true
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
ProxyResource:
type: object
title: Proxy Resource
description: The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
allOf:
- $ref: '#/components/schemas/Resource'
FileShare:
type: object
description: Properties of the file share, including Id, resource name, resource type, Etag.
properties:
properties:
$ref: '#/components/schemas/FileShareProperties'
description: Properties of the file share.
x-ms-client-flatten: true
x-ms-client-name: FileShareProperties
etag:
type: string
description: Resource Etag.
readOnly: true
allOf:
- $ref: '#/components/schemas/ProxyResource'
LeaseShareAction:
type: string
description: Specifies the lease action. Can be one of the available actions.
enum:
- Acquire
- Renew
- Change
- Release
- Break
x-ms-enum:
name: LeaseShareAction
modelAsString: true
values:
- name: Acquire
value: Acquire
- name: Renew
value: Renew
- name: Change
value: Change
- name: Release
value: Release
- name: Break
value: Break
CloudErrorBody:
type: object
description: An error response from the Storage service.
properties:
code:
type: string
description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
message:
type: string
description: A message describing the error, intended to be suitable for display in a user interface.
target:
type: string
description: The target of the particular error. For example, the name of the property in error.
details:
type: array
description: A list of additional details about the error.
items:
$ref: '#/components/schemas/CloudErrorBody'
x-ms-identifiers: []
x-ms-external: true
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
DeletedShare:
type: object
description: The deleted share to be restored.
properties:
deletedShareName:
type: string
description: Required. Identify the name of the deleted share that will be restored.
deletedShareVersion:
type: string
description: Required. Identify the version of the deleted share that will be restored.
required:
- deletedShareName
- deletedShareVersion
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
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
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
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: '#/components/schemas/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: '#/components/schemas/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: '#/components/schemas/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: '#/components/schemas/LeaseStatus'
description: The lease status of the share.
readOnly: true
leaseState:
$ref: '#/components/schemas/LeaseState'
description: Lease state of the share.
readOnly: true
leaseDuration:
$ref: '#/components/schemas/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: '#/components/schemas/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: '#/components/schemas/FileSharePropertiesFileSharePaidBursting'
description: File Share Paid Bursting properties.
SignedIdentifier:
type: object
properties:
id:
type: string
description: An unique identifier of the stored access policy.
accessPolicy:
$ref: '#/components/schemas/AccessPolicy'
description: Access policy
parameters:
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
ApiVersionParameter:
name: api-version
in: query
description: The API version to use for this operation.
required: true
schema:
type: string
minLength: 1
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.