File Shares - Create

Service:: Storage Resource Provider

API Version:: 2025-08-01

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.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices/default/shares/{shareName}?api-version=2025-08-01

With optional parameters:

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices/default/shares/{shareName}?api-version=2025-08-01&$expand={$expand}

URI Parameters

Name	In	Required	Type	Description
accountName	path	True	string minLength: 3 maxLength: 24 pattern: ^[a-z0-9]+$	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.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
shareName	path	True	string minLength: 3 maxLength: 63	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.
subscriptionId	path	True	string (uuid)	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string minLength: 1	The API version to use for this operation.
$expand	query		string	Optional, used to expand the properties within share's properties. Valid values are: snapshots. Should be passed as a string with delimiter ','

Request Body

Name	Type	Description
properties.accessTier	ShareAccessTier	Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium.
properties.enabledProtocols	EnabledProtocols	The authentication protocol that is used for the file share. Can only be specified when creating a share.
properties.fileSharePaidBursting	FileSharePropertiesFileSharePaidBursting	File Share Paid Bursting properties.
properties.metadata	object	A name-value pair to associate with the share as metadata.
properties.provisionedBandwidthMibps	integer (int32)	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.
properties.provisionedIops	integer (int32)	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.
properties.rootSquash	RootSquashType	The property is for NFS share only. The default is NoRootSquash.
properties.shareQuota	integer (int32)	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.
properties.signedIdentifiers	SignedIdentifier[]	List of stored access policies specified on the share.

Responses

Name	Type	Description
200 OK	FileShare	Resource 'FileShare' update operation succeeded
201 Created	FileShare	Resource 'FileShare' create operation succeeded
Other Status Codes	CloudError	An unexpected error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Create NFS Shares

PutShares

PutShares with Access Tier

PutShares with Paid Bursting

PutSharesProvisionedV2

Create NFS Shares

Sample request

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/res346/providers/Microsoft.Storage/storageAccounts/sto666/fileServices/default/shares/share1235?api-version=2025-08-01

{
  "properties": {
    "enabledProtocols": "NFS"
  }
}

Sample response

Status code:: 200

{
  "name": "share1235",
  "type": "Microsoft.Storage/storageAccounts/fileServices/shares",
  "id": "/subscriptions/{subscription-id}/resourceGroups/res346/providers/Microsoft.Storage/storageAccounts/sto666/fileServices/default/shares/share1235",
  "properties": {
    "enabledProtocols": "NFS"
  }
}

Status code:: 201

{
  "name": "share1235",
  "type": "Microsoft.Storage/storageAccounts/fileServices/shares",
  "id": "/subscriptions/{subscription-id}/resourceGroups/res346/providers/Microsoft.Storage/storageAccounts/sto666/fileServices/default/shares/share1235",
  "properties": {
    "enabledProtocols": "NFS"
  }
}

PutShares

Sample request

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/res3376/providers/Microsoft.Storage/storageAccounts/sto328/fileServices/default/shares/share6185?api-version=2025-08-01

{}

Sample response

Status code:: 200

{
  "name": "share6185",
  "type": "Microsoft.Storage/storageAccounts/fileServices/shares",
  "id": "/subscriptions/{subscription-id}/resourceGroups/res3376/providers/Microsoft.Storage/storageAccounts/sto328/fileServices/default/shares/share6185"
}

Status code:: 201

{
  "name": "share6185",
  "type": "Microsoft.Storage/storageAccounts/fileServices/shares",
  "id": "/subscriptions/{subscription-id}/resourceGroups/res3376/providers/Microsoft.Storage/storageAccounts/sto328/fileServices/default/shares/share6185"
}

PutShares with Access Tier

Sample request

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/res346/providers/Microsoft.Storage/storageAccounts/sto666/fileServices/default/shares/share1235?api-version=2025-08-01

{
  "properties": {
    "accessTier": "Hot"
  }
}

Sample response

Status code:: 200

{
  "name": "share1235",
  "type": "Microsoft.Storage/storageAccounts/fileServices/shares",
  "id": "/subscriptions/{subscription-id}/resourceGroups/res346/providers/Microsoft.Storage/storageAccounts/sto666/fileServices/default/shares/share1235",
  "properties": {
    "accessTier": "Hot"
  }
}

Status code:: 201

{
  "name": "share1235",
  "type": "Microsoft.Storage/storageAccounts/fileServices/shares",
  "id": "/subscriptions/{subscription-id}/resourceGroups/res346/providers/Microsoft.Storage/storageAccounts/sto666/fileServices/default/shares/share1235",
  "properties": {
    "accessTier": "Hot"
  }
}

PutShares with Paid Bursting

Sample request

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/res346/providers/Microsoft.Storage/storageAccounts/sto666/fileServices/default/shares/share1235?api-version=2025-08-01

{
  "properties": {
    "fileSharePaidBursting": {
      "paidBurstingEnabled": true,
      "paidBurstingMaxBandwidthMibps": 10340,
      "paidBurstingMaxIops": 102400
    }
  }
}

Sample response

Status code:: 200

{
  "name": "share1235",
  "type": "Microsoft.Storage/storageAccounts/fileServices/shares",
  "id": "/subscriptions/{subscription-id}/resourceGroups/res346/providers/Microsoft.Storage/storageAccounts/sto666/fileServices/default/shares/share1235",
  "properties": {
    "fileSharePaidBursting": {
      "paidBurstingEnabled": true,
      "paidBurstingMaxBandwidthMibps": 10340,
      "paidBurstingMaxIops": 102400
    }
  }
}

Status code:: 201

{
  "name": "share1235",
  "type": "Microsoft.Storage/storageAccounts/fileServices/shares",
  "id": "/subscriptions/{subscription-id}/resourceGroups/res346/providers/Microsoft.Storage/storageAccounts/sto666/fileServices/default/shares/share1235",
  "properties": {
    "fileSharePaidBursting": {
      "paidBurstingEnabled": true,
      "paidBurstingMaxBandwidthMibps": 10340,
      "paidBurstingMaxIops": 102400
    }
  }
}

PutSharesProvisionedV2

Sample request

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/res346/providers/Microsoft.Storage/storageAccounts/sto666/fileServices/default/shares/share1235?api-version=2025-08-01

{
  "properties": {
    "provisionedBandwidthMibps": 200,
    "provisionedIops": 5000,
    "shareQuota": 100
  }
}

Sample response

Status code:: 200

{
  "name": "share1235",
  "type": "Microsoft.Storage/storageAccounts/fileServices/shares",
  "id": "/subscriptions/{subscription-id}/resourceGroups/res346/providers/Microsoft.Storage/storageAccounts/sto666/fileServices/default/shares/share1235",
  "properties": {
    "includedBurstIops": 15000,
    "maxBurstCreditsForIops": 36000000,
    "provisionedBandwidthMibps": 200,
    "provisionedIops": 5000,
    "shareQuota": 100
  }
}

Status code:: 201

{
  "name": "share1235",
  "type": "Microsoft.Storage/storageAccounts/fileServices/shares",
  "id": "/subscriptions/{subscription-id}/resourceGroups/res346/providers/Microsoft.Storage/storageAccounts/sto666/fileServices/default/shares/share1235",
  "properties": {
    "includedBurstIops": 15000,
    "maxBurstCreditsForIops": 36000000,
    "provisionedBandwidthMibps": 200,
    "provisionedIops": 5000,
    "shareQuota": 100
  }
}

Definitions

Name	Description
AccessPolicy
CloudError	An error response from the Storage service.
CloudErrorBody	An error response from the Storage service.
EnabledProtocols	The authentication protocol that is used for the file share. Can only be specified when creating a share.
FileShare	Properties of the file share, including Id, resource name, resource type, Etag.
FileSharePropertiesFileSharePaidBursting	File Share Paid Bursting properties.
LeaseDuration	Specifies whether the lease on a container is of infinite or fixed duration, only when the container is leased.
LeaseState	Lease state of the container.
LeaseStatus	The lease status of the container.
RootSquashType	The property is for NFS share only. The default is NoRootSquash.
ShareAccessTier	Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium.
SignedIdentifier

AccessPolicy

Object

Name	Type	Description
expiryTime	string (date-time)	Expiry time of the access policy
permission	string	List of abbreviated permissions.
startTime	string (date-time)	Start time of the access policy

CloudError

Object

An error response from the Storage service.

Name	Type	Description
error	CloudErrorBody	An error response from the Storage service.

CloudErrorBody

Object

An error response from the Storage service.

Name	Type	Description
code	string	An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
details	CloudErrorBody[]	A list of additional details about the error.
message	string	A message describing the error, intended to be suitable for display in a user interface.
target	string	The target of the particular error. For example, the name of the property in error.

EnabledProtocols

Enumeration

The authentication protocol that is used for the file share. Can only be specified when creating a share.

Value	Description
SMB
NFS

FileShare

Object

Properties of the file share, including Id, resource name, resource type, Etag.

Name	Type	Description
etag	string	Resource Etag.
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	The name of the resource
properties.accessTier	ShareAccessTier	Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium.
properties.accessTierChangeTime	string (date-time)	Indicates the last modification time for share access tier.
properties.accessTierStatus	string	Indicates if there is a pending transition for access tier.
properties.deleted	boolean	Indicates whether the share was deleted.
properties.deletedTime	string (date-time)	The deleted time if the share was deleted.
properties.enabledProtocols	EnabledProtocols	The authentication protocol that is used for the file share. Can only be specified when creating a share.
properties.fileSharePaidBursting	FileSharePropertiesFileSharePaidBursting	File Share Paid Bursting properties.
properties.includedBurstIops	integer (int32)	The calculated burst IOPS of the share. This property is only for file shares created under Files Provisioned v2 account type.
properties.lastModifiedTime	string (date-time)	Returns the date and time the share was last modified.
properties.leaseDuration	LeaseDuration	Specifies whether the lease on a share is of infinite or fixed duration, only when the share is leased.
properties.leaseState	LeaseState	Lease state of the share.
properties.leaseStatus	LeaseStatus	The lease status of the share.
properties.maxBurstCreditsForIops	integer (int64)	The calculated maximum burst credits for the share. This property is only for file shares created under Files Provisioned v2 account type.
properties.metadata	object	A name-value pair to associate with the share as metadata.
properties.nextAllowedProvisionedBandwidthDowngradeTime	string (date-time-rfc7231)	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.
properties.nextAllowedProvisionedIopsDowngradeTime	string (date-time-rfc7231)	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.
properties.nextAllowedQuotaDowngradeTime	string (date-time-rfc7231)	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
properties.provisionedBandwidthMibps	integer (int32)	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.
properties.provisionedIops	integer (int32)	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.
properties.remainingRetentionDays	integer (int32)	Remaining retention days for share that was soft deleted.
properties.rootSquash	RootSquashType	The property is for NFS share only. The default is NoRootSquash.
properties.shareQuota	integer (int32)	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.
properties.shareUsageBytes	integer (int64)	The approximate size of the data stored on the share. Note that this value may not include all recently created or recently resized files.
properties.signedIdentifiers	SignedIdentifier[]	List of stored access policies specified on the share.
properties.snapshotTime	string (date-time)	Creation time of share snapshot returned in the response of list shares with expand param "snapshots".
properties.version	string	The version of the share.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

FileSharePropertiesFileSharePaidBursting

Object

File Share Paid Bursting properties.

Name	Type	Description
paidBurstingEnabled	boolean	Indicates whether paid bursting is enabled for the share. This property is only for file shares created under Files Provisioned v1 SSD account type.
paidBurstingMaxBandwidthMibps	integer (int32)	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.
paidBurstingMaxIops	integer (int32)	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.

LeaseDuration

Enumeration

Specifies whether the lease on a container is of infinite or fixed duration, only when the container is leased.

Value	Description
Infinite
Fixed

LeaseState

Enumeration

Lease state of the container.

Value	Description
Available
Leased
Expired
Breaking
Broken

LeaseStatus

Enumeration

The lease status of the container.

Value	Description
Locked
Unlocked

RootSquashType

Enumeration

The property is for NFS share only. The default is NoRootSquash.

Value	Description
NoRootSquash
RootSquash
AllSquash

ShareAccessTier

Enumeration

Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium.

Value	Description
TransactionOptimized
Hot
Cool
Premium

SignedIdentifier

Object

Name	Type	Description
accessPolicy	AccessPolicy	Access policy
id	string	An unique identifier of the stored access policy.

Share via

File Shares - Create

URI Parameters

Request Body

Responses

Security

azure_auth

Scopes

Examples

Create NFS Shares

Sample request

Sample response

PutShares

Sample request

Sample response

PutShares with Access Tier

Sample request

Sample response

PutShares with Paid Bursting

Sample request

Sample response

PutSharesProvisionedV2

Sample request

Sample response

Definitions

AccessPolicy

CloudError

CloudErrorBody

EnabledProtocols

FileShare

FileSharePropertiesFileSharePaidBursting

LeaseDuration

LeaseState

LeaseStatus

RootSquashType

ShareAccessTier

SignedIdentifier