Microsoft.Storage (stable:2024-01-01)

2025/02/26 • 4 updated methods

FileShares_List (updated)
Description :  Lists all shares.
Reference :  Link ¶

⚶ Changes

{
  "#id": "FileShares_List",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "#name": "nextAllowedQuotaDowngradeTime",
                "Format": {
                  "new": "date-time-rfc1123",
                  "old": "date-time"
                }
              },
              {
                "#name": "nextAllowedProvisionedIopsDowngradeTime",
                "Format": {
                  "new": "date-time-rfc1123",
                  "old": "date-time"
                }
              },
              {
                "#name": "nextAllowedProvisionedBandwidthDowngradeTime",
                "Format": {
                  "new": "date-time-rfc1123",
                  "old": "date-time"
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices/default/shares
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
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 ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
$maxpagesize:
{
Description: Optional. Specified maximum number of shares that can be included in the list. ,
Required: False ,
}
string ,
$filter:
{
Description: Optional. When specified, only share names starting with the filter will be listed. ,
Required: False ,
}
string ,
$expand:
{
Description: Optional, used to expand the properties within share's properties. Valid values are: deleted, snapshots. Should be passed as a string with delimiter ',' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of file shares returned. ,
Required: False ,
}
[
{
properties:
{
Description: The file share properties be listed out. ,
Required: False ,
}
{
lastModifiedTime:
{
Description: Returns the date and time the share was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
metadata:
{
Description: A name-value pair to associate with the share as metadata. ,
Required: False ,
}
object ,
shareQuota:
{
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. ,
Format: int32 ,
Required: False ,
}
integer ,
provisionedIops:
{
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. ,
Format: int32 ,
Required: False ,
}
integer ,
provisionedBandwidthMibps:
{
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. ,
Format: int32 ,
Required: False ,
}
integer ,
includedBurstIops:
{
Description: The calculated burst IOPS of the share. This property is only for file shares created under Files Provisioned v2 account type. ,
Format: int32 ,
Required: False ,
}
integer ,
maxBurstCreditsForIops:
{
Description: The calculated maximum burst credits for the share. This property is only for file shares created under Files Provisioned v2 account type. ,
Format: int64 ,
Required: False ,
}
integer ,
nextAllowedQuotaDowngradeTime:
{
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 ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
nextAllowedProvisionedIopsDowngradeTime:
{
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. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
nextAllowedProvisionedBandwidthDowngradeTime:
{
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. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
enabledProtocols:
{
Description: The authentication protocol that is used for the file share. Can only be specified when creating a share. ,
Enum:
{
SMB: No description available. ,
NFS: No description available. ,
}
,
Required: False ,
}
enum ,
rootSquash:
{
Description: The property is for NFS share only. The default is NoRootSquash. ,
Enum:
{
NoRootSquash: No description available. ,
RootSquash: No description available. ,
AllSquash: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: The version of the share. ,
Required: False ,
}
string ,
deleted:
{
Description: Indicates whether the share was deleted. ,
Required: False ,
}
boolean ,
deletedTime:
{
Description: The deleted time if the share was deleted. ,
Format: date-time ,
Required: False ,
}
string ,
remainingRetentionDays:
{
Description: Remaining retention days for share that was soft deleted. ,
Required: False ,
}
integer ,
accessTier:
{
Description: Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium. ,
Enum:
{
TransactionOptimized: No description available. ,
Hot: No description available. ,
Cool: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
accessTierChangeTime:
{
Description: Indicates the last modification time for share access tier. ,
Format: date-time ,
Required: False ,
}
string ,
accessTierStatus:
{
Description: Indicates if there is a pending transition for access tier. ,
Required: False ,
}
string ,
shareUsageBytes:
{
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. ,
Format: int64 ,
Required: False ,
}
integer ,
leaseStatus:
{
Description: The lease status of the share. ,
Enum:
{
Locked: No description available. ,
Unlocked: No description available. ,
}
,
Required: False ,
}
enum ,
leaseState:
{
Description: Lease state of the share. ,
Enum:
{
Available: No description available. ,
Leased: No description available. ,
Expired: No description available. ,
Breaking: No description available. ,
Broken: No description available. ,
}
,
Required: False ,
}
enum ,
leaseDuration:
{
Description: Specifies whether the lease on a share is of infinite or fixed duration, only when the share is leased. ,
Enum:
{
Infinite: No description available. ,
Fixed: No description available. ,
}
,
Required: False ,
}
enum ,
signedIdentifiers:
{
Description: List of stored access policies specified on the share. ,
Required: False ,
}
[
{
id:
{
Description: An unique identifier of the stored access policy. ,
Required: False ,
}
string ,
accessPolicy:
{
Description: Access policy ,
Required: False ,
}
{
startTime:
{
Description: Start time of the access policy ,
Format: date-time ,
Required: False ,
}
string ,
expiryTime:
{
Description: Expiry time of the access policy ,
Format: date-time ,
Required: False ,
}
string ,
permission:
{
Description: List of abbreviated permissions. ,
Required: False ,
}
string ,
}
,
}
,
]
,
snapshotTime:
{
Description: Creation time of share snapshot returned in the response of list shares with expand param "snapshots". ,
Format: date-time ,
Required: False ,
}
string ,
fileSharePaidBursting:
{
Description: File Share Paid Bursting properties. ,
Required: False ,
}
{
paidBurstingEnabled:
{
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. ,
Required: False ,
}
boolean ,
paidBurstingMaxIops:
{
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. ,
Format: int32 ,
Required: False ,
}
integer ,
paidBurstingMaxBandwidthMibps:
{
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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Request URL that can be used to query next page of shares. Returned when total number of requested shares exceed maximum page size. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error response from the Storage service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
FileShares_Create (updated)
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.
Reference :  Link ¶

⚶ Changes

{
  "#id": "FileShares_Create",
  "$parameters": {
    "fileShare": {
      "$properties": {
        "properties": [
          {
            "#name": "nextAllowedQuotaDowngradeTime",
            "Format": {
              "new": "date-time-rfc1123",
              "old": "date-time"
            }
          },
          {
            "#name": "nextAllowedProvisionedIopsDowngradeTime",
            "Format": {
              "new": "date-time-rfc1123",
              "old": "date-time"
            }
          },
          {
            "#name": "nextAllowedProvisionedBandwidthDowngradeTime",
            "Format": {
              "new": "date-time-rfc1123",
              "old": "date-time"
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "201": {
      "$properties": {
        "properties": [
          {
            "#name": "nextAllowedQuotaDowngradeTime",
            "Format": {
              "new": "date-time-rfc1123",
              "old": "date-time"
            }
          },
          {
            "#name": "nextAllowedProvisionedIopsDowngradeTime",
            "Format": {
              "new": "date-time-rfc1123",
              "old": "date-time"
            }
          },
          {
            "#name": "nextAllowedProvisionedBandwidthDowngradeTime",
            "Format": {
              "new": "date-time-rfc1123",
              "old": "date-time"
            }
          }
        ]
      }
    },
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "nextAllowedQuotaDowngradeTime",
            "Format": {
              "new": "date-time-rfc1123",
              "old": "date-time"
            }
          },
          {
            "#name": "nextAllowedProvisionedIopsDowngradeTime",
            "Format": {
              "new": "date-time-rfc1123",
              "old": "date-time"
            }
          },
          {
            "#name": "nextAllowedProvisionedBandwidthDowngradeTime",
            "Format": {
              "new": "date-time-rfc1123",
              "old": "date-time"
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices/default/shares/{shareName}
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
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 ,
}
string ,
shareName:
{
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 ,
}
string ,
fileShare:
{
Description: Properties of the file share to create. ,
Required: True ,
}
{
properties:
{
Description: Properties of the file share. ,
Required: False ,
}
{
lastModifiedTime:
{
Description: Returns the date and time the share was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
metadata:
{
Description: A name-value pair to associate with the share as metadata. ,
Required: False ,
}
object ,
shareQuota:
{
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. ,
Format: int32 ,
Required: False ,
}
integer ,
provisionedIops:
{
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. ,
Format: int32 ,
Required: False ,
}
integer ,
provisionedBandwidthMibps:
{
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. ,
Format: int32 ,
Required: False ,
}
integer ,
includedBurstIops:
{
Description: The calculated burst IOPS of the share. This property is only for file shares created under Files Provisioned v2 account type. ,
Format: int32 ,
Required: False ,
}
integer ,
maxBurstCreditsForIops:
{
Description: The calculated maximum burst credits for the share. This property is only for file shares created under Files Provisioned v2 account type. ,
Format: int64 ,
Required: False ,
}
integer ,
nextAllowedQuotaDowngradeTime:
{
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 ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
nextAllowedProvisionedIopsDowngradeTime:
{
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. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
nextAllowedProvisionedBandwidthDowngradeTime:
{
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. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
enabledProtocols:
{
Description: The authentication protocol that is used for the file share. Can only be specified when creating a share. ,
Enum:
{
SMB: No description available. ,
NFS: No description available. ,
}
,
Required: False ,
}
enum ,
rootSquash:
{
Description: The property is for NFS share only. The default is NoRootSquash. ,
Enum:
{
NoRootSquash: No description available. ,
RootSquash: No description available. ,
AllSquash: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: The version of the share. ,
Required: False ,
}
string ,
deleted:
{
Description: Indicates whether the share was deleted. ,
Required: False ,
}
boolean ,
deletedTime:
{
Description: The deleted time if the share was deleted. ,
Format: date-time ,
Required: False ,
}
string ,
remainingRetentionDays:
{
Description: Remaining retention days for share that was soft deleted. ,
Required: False ,
}
integer ,
accessTier:
{
Description: Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium. ,
Enum:
{
TransactionOptimized: No description available. ,
Hot: No description available. ,
Cool: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
accessTierChangeTime:
{
Description: Indicates the last modification time for share access tier. ,
Format: date-time ,
Required: False ,
}
string ,
accessTierStatus:
{
Description: Indicates if there is a pending transition for access tier. ,
Required: False ,
}
string ,
shareUsageBytes:
{
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. ,
Format: int64 ,
Required: False ,
}
integer ,
leaseStatus:
{
Description: The lease status of the share. ,
Enum:
{
Locked: No description available. ,
Unlocked: No description available. ,
}
,
Required: False ,
}
enum ,
leaseState:
{
Description: Lease state of the share. ,
Enum:
{
Available: No description available. ,
Leased: No description available. ,
Expired: No description available. ,
Breaking: No description available. ,
Broken: No description available. ,
}
,
Required: False ,
}
enum ,
leaseDuration:
{
Description: Specifies whether the lease on a share is of infinite or fixed duration, only when the share is leased. ,
Enum:
{
Infinite: No description available. ,
Fixed: No description available. ,
}
,
Required: False ,
}
enum ,
signedIdentifiers:
{
Description: List of stored access policies specified on the share. ,
Required: False ,
}
[
{
id:
{
Description: An unique identifier of the stored access policy. ,
Required: False ,
}
string ,
accessPolicy:
{
Description: Access policy ,
Required: False ,
}
{
startTime:
{
Description: Start time of the access policy ,
Format: date-time ,
Required: False ,
}
string ,
expiryTime:
{
Description: Expiry time of the access policy ,
Format: date-time ,
Required: False ,
}
string ,
permission:
{
Description: List of abbreviated permissions. ,
Required: False ,
}
string ,
}
,
}
,
]
,
snapshotTime:
{
Description: Creation time of share snapshot returned in the response of list shares with expand param "snapshots". ,
Format: date-time ,
Required: False ,
}
string ,
fileSharePaidBursting:
{
Description: File Share Paid Bursting properties. ,
Required: False ,
}
{
paidBurstingEnabled:
{
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. ,
Required: False ,
}
boolean ,
paidBurstingMaxIops:
{
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. ,
Format: int32 ,
Required: False ,
}
integer ,
paidBurstingMaxBandwidthMibps:
{
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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
$expand:
{
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 ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the file share. ,
Required: False ,
}
{
lastModifiedTime:
{
Description: Returns the date and time the share was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
metadata:
{
Description: A name-value pair to associate with the share as metadata. ,
Required: False ,
}
object ,
shareQuota:
{
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. ,
Format: int32 ,
Required: False ,
}
integer ,
provisionedIops:
{
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. ,
Format: int32 ,
Required: False ,
}
integer ,
provisionedBandwidthMibps:
{
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. ,
Format: int32 ,
Required: False ,
}
integer ,
includedBurstIops:
{
Description: The calculated burst IOPS of the share. This property is only for file shares created under Files Provisioned v2 account type. ,
Format: int32 ,
Required: False ,
}
integer ,
maxBurstCreditsForIops:
{
Description: The calculated maximum burst credits for the share. This property is only for file shares created under Files Provisioned v2 account type. ,
Format: int64 ,
Required: False ,
}
integer ,
nextAllowedQuotaDowngradeTime:
{
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 ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
nextAllowedProvisionedIopsDowngradeTime:
{
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. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
nextAllowedProvisionedBandwidthDowngradeTime:
{
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. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
enabledProtocols:
{
Description: The authentication protocol that is used for the file share. Can only be specified when creating a share. ,
Enum:
{
SMB: No description available. ,
NFS: No description available. ,
}
,
Required: False ,
}
enum ,
rootSquash:
{
Description: The property is for NFS share only. The default is NoRootSquash. ,
Enum:
{
NoRootSquash: No description available. ,
RootSquash: No description available. ,
AllSquash: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: The version of the share. ,
Required: False ,
}
string ,
deleted:
{
Description: Indicates whether the share was deleted. ,
Required: False ,
}
boolean ,
deletedTime:
{
Description: The deleted time if the share was deleted. ,
Format: date-time ,
Required: False ,
}
string ,
remainingRetentionDays:
{
Description: Remaining retention days for share that was soft deleted. ,
Required: False ,
}
integer ,
accessTier:
{
Description: Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium. ,
Enum:
{
TransactionOptimized: No description available. ,
Hot: No description available. ,
Cool: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
accessTierChangeTime:
{
Description: Indicates the last modification time for share access tier. ,
Format: date-time ,
Required: False ,
}
string ,
accessTierStatus:
{
Description: Indicates if there is a pending transition for access tier. ,
Required: False ,
}
string ,
shareUsageBytes:
{
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. ,
Format: int64 ,
Required: False ,
}
integer ,
leaseStatus:
{
Description: The lease status of the share. ,
Enum:
{
Locked: No description available. ,
Unlocked: No description available. ,
}
,
Required: False ,
}
enum ,
leaseState:
{
Description: Lease state of the share. ,
Enum:
{
Available: No description available. ,
Leased: No description available. ,
Expired: No description available. ,
Breaking: No description available. ,
Broken: No description available. ,
}
,
Required: False ,
}
enum ,
leaseDuration:
{
Description: Specifies whether the lease on a share is of infinite or fixed duration, only when the share is leased. ,
Enum:
{
Infinite: No description available. ,
Fixed: No description available. ,
}
,
Required: False ,
}
enum ,
signedIdentifiers:
{
Description: List of stored access policies specified on the share. ,
Required: False ,
}
[
{
id:
{
Description: An unique identifier of the stored access policy. ,
Required: False ,
}
string ,
accessPolicy:
{
Description: Access policy ,
Required: False ,
}
{
startTime:
{
Description: Start time of the access policy ,
Format: date-time ,
Required: False ,
}
string ,
expiryTime:
{
Description: Expiry time of the access policy ,
Format: date-time ,
Required: False ,
}
string ,
permission:
{
Description: List of abbreviated permissions. ,
Required: False ,
}
string ,
}
,
}
,
]
,
snapshotTime:
{
Description: Creation time of share snapshot returned in the response of list shares with expand param "snapshots". ,
Format: date-time ,
Required: False ,
}
string ,
fileSharePaidBursting:
{
Description: File Share Paid Bursting properties. ,
Required: False ,
}
{
paidBurstingEnabled:
{
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. ,
Required: False ,
}
boolean ,
paidBurstingMaxIops:
{
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. ,
Format: int32 ,
Required: False ,
}
integer ,
paidBurstingMaxBandwidthMibps:
{
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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the file share. ,
Required: False ,
}
{
lastModifiedTime:
{
Description: Returns the date and time the share was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
metadata:
{
Description: A name-value pair to associate with the share as metadata. ,
Required: False ,
}
object ,
shareQuota:
{
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. ,
Format: int32 ,
Required: False ,
}
integer ,
provisionedIops:
{
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. ,
Format: int32 ,
Required: False ,
}
integer ,
provisionedBandwidthMibps:
{
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. ,
Format: int32 ,
Required: False ,
}
integer ,
includedBurstIops:
{
Description: The calculated burst IOPS of the share. This property is only for file shares created under Files Provisioned v2 account type. ,
Format: int32 ,
Required: False ,
}
integer ,
maxBurstCreditsForIops:
{
Description: The calculated maximum burst credits for the share. This property is only for file shares created under Files Provisioned v2 account type. ,
Format: int64 ,
Required: False ,
}
integer ,
nextAllowedQuotaDowngradeTime:
{
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 ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
nextAllowedProvisionedIopsDowngradeTime:
{
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. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
nextAllowedProvisionedBandwidthDowngradeTime:
{
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. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
enabledProtocols:
{
Description: The authentication protocol that is used for the file share. Can only be specified when creating a share. ,
Enum:
{
SMB: No description available. ,
NFS: No description available. ,
}
,
Required: False ,
}
enum ,
rootSquash:
{
Description: The property is for NFS share only. The default is NoRootSquash. ,
Enum:
{
NoRootSquash: No description available. ,
RootSquash: No description available. ,
AllSquash: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: The version of the share. ,
Required: False ,
}
string ,
deleted:
{
Description: Indicates whether the share was deleted. ,
Required: False ,
}
boolean ,
deletedTime:
{
Description: The deleted time if the share was deleted. ,
Format: date-time ,
Required: False ,
}
string ,
remainingRetentionDays:
{
Description: Remaining retention days for share that was soft deleted. ,
Required: False ,
}
integer ,
accessTier:
{
Description: Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium. ,
Enum:
{
TransactionOptimized: No description available. ,
Hot: No description available. ,
Cool: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
accessTierChangeTime:
{
Description: Indicates the last modification time for share access tier. ,
Format: date-time ,
Required: False ,
}
string ,
accessTierStatus:
{
Description: Indicates if there is a pending transition for access tier. ,
Required: False ,
}
string ,
shareUsageBytes:
{
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. ,
Format: int64 ,
Required: False ,
}
integer ,
leaseStatus:
{
Description: The lease status of the share. ,
Enum:
{
Locked: No description available. ,
Unlocked: No description available. ,
}
,
Required: False ,
}
enum ,
leaseState:
{
Description: Lease state of the share. ,
Enum:
{
Available: No description available. ,
Leased: No description available. ,
Expired: No description available. ,
Breaking: No description available. ,
Broken: No description available. ,
}
,
Required: False ,
}
enum ,
leaseDuration:
{
Description: Specifies whether the lease on a share is of infinite or fixed duration, only when the share is leased. ,
Enum:
{
Infinite: No description available. ,
Fixed: No description available. ,
}
,
Required: False ,
}
enum ,
signedIdentifiers:
{
Description: List of stored access policies specified on the share. ,
Required: False ,
}
[
{
id:
{
Description: An unique identifier of the stored access policy. ,
Required: False ,
}
string ,
accessPolicy:
{
Description: Access policy ,
Required: False ,
}
{
startTime:
{
Description: Start time of the access policy ,
Format: date-time ,
Required: False ,
}
string ,
expiryTime:
{
Description: Expiry time of the access policy ,
Format: date-time ,
Required: False ,
}
string ,
permission:
{
Description: List of abbreviated permissions. ,
Required: False ,
}
string ,
}
,
}
,
]
,
snapshotTime:
{
Description: Creation time of share snapshot returned in the response of list shares with expand param "snapshots". ,
Format: date-time ,
Required: False ,
}
string ,
fileSharePaidBursting:
{
Description: File Share Paid Bursting properties. ,
Required: False ,
}
{
paidBurstingEnabled:
{
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. ,
Required: False ,
}
boolean ,
paidBurstingMaxIops:
{
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. ,
Format: int32 ,
Required: False ,
}
integer ,
paidBurstingMaxBandwidthMibps:
{
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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error response from the Storage service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
FileShares_Update (updated)
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.
Reference :  Link ¶

⚶ Changes

{
  "#id": "FileShares_Update",
  "$parameters": {
    "fileShare": {
      "$properties": {
        "properties": [
          {
            "#name": "nextAllowedQuotaDowngradeTime",
            "Format": {
              "new": "date-time-rfc1123",
              "old": "date-time"
            }
          },
          {
            "#name": "nextAllowedProvisionedIopsDowngradeTime",
            "Format": {
              "new": "date-time-rfc1123",
              "old": "date-time"
            }
          },
          {
            "#name": "nextAllowedProvisionedBandwidthDowngradeTime",
            "Format": {
              "new": "date-time-rfc1123",
              "old": "date-time"
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "nextAllowedQuotaDowngradeTime",
            "Format": {
              "new": "date-time-rfc1123",
              "old": "date-time"
            }
          },
          {
            "#name": "nextAllowedProvisionedIopsDowngradeTime",
            "Format": {
              "new": "date-time-rfc1123",
              "old": "date-time"
            }
          },
          {
            "#name": "nextAllowedProvisionedBandwidthDowngradeTime",
            "Format": {
              "new": "date-time-rfc1123",
              "old": "date-time"
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices/default/shares/{shareName}
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
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 ,
}
string ,
shareName:
{
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 ,
}
string ,
fileShare:
{
Description: Properties to update for the file share. ,
Required: True ,
}
{
properties:
{
Description: Properties of the file share. ,
Required: False ,
}
{
lastModifiedTime:
{
Description: Returns the date and time the share was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
metadata:
{
Description: A name-value pair to associate with the share as metadata. ,
Required: False ,
}
object ,
shareQuota:
{
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. ,
Format: int32 ,
Required: False ,
}
integer ,
provisionedIops:
{
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. ,
Format: int32 ,
Required: False ,
}
integer ,
provisionedBandwidthMibps:
{
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. ,
Format: int32 ,
Required: False ,
}
integer ,
includedBurstIops:
{
Description: The calculated burst IOPS of the share. This property is only for file shares created under Files Provisioned v2 account type. ,
Format: int32 ,
Required: False ,
}
integer ,
maxBurstCreditsForIops:
{
Description: The calculated maximum burst credits for the share. This property is only for file shares created under Files Provisioned v2 account type. ,
Format: int64 ,
Required: False ,
}
integer ,
nextAllowedQuotaDowngradeTime:
{
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 ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
nextAllowedProvisionedIopsDowngradeTime:
{
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. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
nextAllowedProvisionedBandwidthDowngradeTime:
{
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. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
enabledProtocols:
{
Description: The authentication protocol that is used for the file share. Can only be specified when creating a share. ,
Enum:
{
SMB: No description available. ,
NFS: No description available. ,
}
,
Required: False ,
}
enum ,
rootSquash:
{
Description: The property is for NFS share only. The default is NoRootSquash. ,
Enum:
{
NoRootSquash: No description available. ,
RootSquash: No description available. ,
AllSquash: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: The version of the share. ,
Required: False ,
}
string ,
deleted:
{
Description: Indicates whether the share was deleted. ,
Required: False ,
}
boolean ,
deletedTime:
{
Description: The deleted time if the share was deleted. ,
Format: date-time ,
Required: False ,
}
string ,
remainingRetentionDays:
{
Description: Remaining retention days for share that was soft deleted. ,
Required: False ,
}
integer ,
accessTier:
{
Description: Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium. ,
Enum:
{
TransactionOptimized: No description available. ,
Hot: No description available. ,
Cool: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
accessTierChangeTime:
{
Description: Indicates the last modification time for share access tier. ,
Format: date-time ,
Required: False ,
}
string ,
accessTierStatus:
{
Description: Indicates if there is a pending transition for access tier. ,
Required: False ,
}
string ,
shareUsageBytes:
{
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. ,
Format: int64 ,
Required: False ,
}
integer ,
leaseStatus:
{
Description: The lease status of the share. ,
Enum:
{
Locked: No description available. ,
Unlocked: No description available. ,
}
,
Required: False ,
}
enum ,
leaseState:
{
Description: Lease state of the share. ,
Enum:
{
Available: No description available. ,
Leased: No description available. ,
Expired: No description available. ,
Breaking: No description available. ,
Broken: No description available. ,
}
,
Required: False ,
}
enum ,
leaseDuration:
{
Description: Specifies whether the lease on a share is of infinite or fixed duration, only when the share is leased. ,
Enum:
{
Infinite: No description available. ,
Fixed: No description available. ,
}
,
Required: False ,
}
enum ,
signedIdentifiers:
{
Description: List of stored access policies specified on the share. ,
Required: False ,
}
[
{
id:
{
Description: An unique identifier of the stored access policy. ,
Required: False ,
}
string ,
accessPolicy:
{
Description: Access policy ,
Required: False ,
}
{
startTime:
{
Description: Start time of the access policy ,
Format: date-time ,
Required: False ,
}
string ,
expiryTime:
{
Description: Expiry time of the access policy ,
Format: date-time ,
Required: False ,
}
string ,
permission:
{
Description: List of abbreviated permissions. ,
Required: False ,
}
string ,
}
,
}
,
]
,
snapshotTime:
{
Description: Creation time of share snapshot returned in the response of list shares with expand param "snapshots". ,
Format: date-time ,
Required: False ,
}
string ,
fileSharePaidBursting:
{
Description: File Share Paid Bursting properties. ,
Required: False ,
}
{
paidBurstingEnabled:
{
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. ,
Required: False ,
}
boolean ,
paidBurstingMaxIops:
{
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. ,
Format: int32 ,
Required: False ,
}
integer ,
paidBurstingMaxBandwidthMibps:
{
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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the file share. ,
Required: False ,
}
{
lastModifiedTime:
{
Description: Returns the date and time the share was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
metadata:
{
Description: A name-value pair to associate with the share as metadata. ,
Required: False ,
}
object ,
shareQuota:
{
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. ,
Format: int32 ,
Required: False ,
}
integer ,
provisionedIops:
{
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. ,
Format: int32 ,
Required: False ,
}
integer ,
provisionedBandwidthMibps:
{
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. ,
Format: int32 ,
Required: False ,
}
integer ,
includedBurstIops:
{
Description: The calculated burst IOPS of the share. This property is only for file shares created under Files Provisioned v2 account type. ,
Format: int32 ,
Required: False ,
}
integer ,
maxBurstCreditsForIops:
{
Description: The calculated maximum burst credits for the share. This property is only for file shares created under Files Provisioned v2 account type. ,
Format: int64 ,
Required: False ,
}
integer ,
nextAllowedQuotaDowngradeTime:
{
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 ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
nextAllowedProvisionedIopsDowngradeTime:
{
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. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
nextAllowedProvisionedBandwidthDowngradeTime:
{
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. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
enabledProtocols:
{
Description: The authentication protocol that is used for the file share. Can only be specified when creating a share. ,
Enum:
{
SMB: No description available. ,
NFS: No description available. ,
}
,
Required: False ,
}
enum ,
rootSquash:
{
Description: The property is for NFS share only. The default is NoRootSquash. ,
Enum:
{
NoRootSquash: No description available. ,
RootSquash: No description available. ,
AllSquash: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: The version of the share. ,
Required: False ,
}
string ,
deleted:
{
Description: Indicates whether the share was deleted. ,
Required: False ,
}
boolean ,
deletedTime:
{
Description: The deleted time if the share was deleted. ,
Format: date-time ,
Required: False ,
}
string ,
remainingRetentionDays:
{
Description: Remaining retention days for share that was soft deleted. ,
Required: False ,
}
integer ,
accessTier:
{
Description: Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium. ,
Enum:
{
TransactionOptimized: No description available. ,
Hot: No description available. ,
Cool: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
accessTierChangeTime:
{
Description: Indicates the last modification time for share access tier. ,
Format: date-time ,
Required: False ,
}
string ,
accessTierStatus:
{
Description: Indicates if there is a pending transition for access tier. ,
Required: False ,
}
string ,
shareUsageBytes:
{
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. ,
Format: int64 ,
Required: False ,
}
integer ,
leaseStatus:
{
Description: The lease status of the share. ,
Enum:
{
Locked: No description available. ,
Unlocked: No description available. ,
}
,
Required: False ,
}
enum ,
leaseState:
{
Description: Lease state of the share. ,
Enum:
{
Available: No description available. ,
Leased: No description available. ,
Expired: No description available. ,
Breaking: No description available. ,
Broken: No description available. ,
}
,
Required: False ,
}
enum ,
leaseDuration:
{
Description: Specifies whether the lease on a share is of infinite or fixed duration, only when the share is leased. ,
Enum:
{
Infinite: No description available. ,
Fixed: No description available. ,
}
,
Required: False ,
}
enum ,
signedIdentifiers:
{
Description: List of stored access policies specified on the share. ,
Required: False ,
}
[
{
id:
{
Description: An unique identifier of the stored access policy. ,
Required: False ,
}
string ,
accessPolicy:
{
Description: Access policy ,
Required: False ,
}
{
startTime:
{
Description: Start time of the access policy ,
Format: date-time ,
Required: False ,
}
string ,
expiryTime:
{
Description: Expiry time of the access policy ,
Format: date-time ,
Required: False ,
}
string ,
permission:
{
Description: List of abbreviated permissions. ,
Required: False ,
}
string ,
}
,
}
,
]
,
snapshotTime:
{
Description: Creation time of share snapshot returned in the response of list shares with expand param "snapshots". ,
Format: date-time ,
Required: False ,
}
string ,
fileSharePaidBursting:
{
Description: File Share Paid Bursting properties. ,
Required: False ,
}
{
paidBurstingEnabled:
{
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. ,
Required: False ,
}
boolean ,
paidBurstingMaxIops:
{
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. ,
Format: int32 ,
Required: False ,
}
integer ,
paidBurstingMaxBandwidthMibps:
{
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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error response from the Storage service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
FileShares_Get (updated)
Description :  Gets properties of a specified share.
Reference :  Link ¶

⚶ Changes

{
  "#id": "FileShares_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "nextAllowedQuotaDowngradeTime",
            "Format": {
              "new": "date-time-rfc1123",
              "old": "date-time"
            }
          },
          {
            "#name": "nextAllowedProvisionedIopsDowngradeTime",
            "Format": {
              "new": "date-time-rfc1123",
              "old": "date-time"
            }
          },
          {
            "#name": "nextAllowedProvisionedBandwidthDowngradeTime",
            "Format": {
              "new": "date-time-rfc1123",
              "old": "date-time"
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices/default/shares/{shareName}
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
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 ,
}
string ,
shareName:
{
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 ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
$expand:
{
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 ,
}
string ,
x-ms-snapshot:
{
Description: Optional, used to retrieve properties of a snapshot. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the file share. ,
Required: False ,
}
{
lastModifiedTime:
{
Description: Returns the date and time the share was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
metadata:
{
Description: A name-value pair to associate with the share as metadata. ,
Required: False ,
}
object ,
shareQuota:
{
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. ,
Format: int32 ,
Required: False ,
}
integer ,
provisionedIops:
{
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. ,
Format: int32 ,
Required: False ,
}
integer ,
provisionedBandwidthMibps:
{
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. ,
Format: int32 ,
Required: False ,
}
integer ,
includedBurstIops:
{
Description: The calculated burst IOPS of the share. This property is only for file shares created under Files Provisioned v2 account type. ,
Format: int32 ,
Required: False ,
}
integer ,
maxBurstCreditsForIops:
{
Description: The calculated maximum burst credits for the share. This property is only for file shares created under Files Provisioned v2 account type. ,
Format: int64 ,
Required: False ,
}
integer ,
nextAllowedQuotaDowngradeTime:
{
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 ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
nextAllowedProvisionedIopsDowngradeTime:
{
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. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
nextAllowedProvisionedBandwidthDowngradeTime:
{
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. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
enabledProtocols:
{
Description: The authentication protocol that is used for the file share. Can only be specified when creating a share. ,
Enum:
{
SMB: No description available. ,
NFS: No description available. ,
}
,
Required: False ,
}
enum ,
rootSquash:
{
Description: The property is for NFS share only. The default is NoRootSquash. ,
Enum:
{
NoRootSquash: No description available. ,
RootSquash: No description available. ,
AllSquash: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: The version of the share. ,
Required: False ,
}
string ,
deleted:
{
Description: Indicates whether the share was deleted. ,
Required: False ,
}
boolean ,
deletedTime:
{
Description: The deleted time if the share was deleted. ,
Format: date-time ,
Required: False ,
}
string ,
remainingRetentionDays:
{
Description: Remaining retention days for share that was soft deleted. ,
Required: False ,
}
integer ,
accessTier:
{
Description: Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium. ,
Enum:
{
TransactionOptimized: No description available. ,
Hot: No description available. ,
Cool: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
accessTierChangeTime:
{
Description: Indicates the last modification time for share access tier. ,
Format: date-time ,
Required: False ,
}
string ,
accessTierStatus:
{
Description: Indicates if there is a pending transition for access tier. ,
Required: False ,
}
string ,
shareUsageBytes:
{
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. ,
Format: int64 ,
Required: False ,
}
integer ,
leaseStatus:
{
Description: The lease status of the share. ,
Enum:
{
Locked: No description available. ,
Unlocked: No description available. ,
}
,
Required: False ,
}
enum ,
leaseState:
{
Description: Lease state of the share. ,
Enum:
{
Available: No description available. ,
Leased: No description available. ,
Expired: No description available. ,
Breaking: No description available. ,
Broken: No description available. ,
}
,
Required: False ,
}
enum ,
leaseDuration:
{
Description: Specifies whether the lease on a share is of infinite or fixed duration, only when the share is leased. ,
Enum:
{
Infinite: No description available. ,
Fixed: No description available. ,
}
,
Required: False ,
}
enum ,
signedIdentifiers:
{
Description: List of stored access policies specified on the share. ,
Required: False ,
}
[
{
id:
{
Description: An unique identifier of the stored access policy. ,
Required: False ,
}
string ,
accessPolicy:
{
Description: Access policy ,
Required: False ,
}
{
startTime:
{
Description: Start time of the access policy ,
Format: date-time ,
Required: False ,
}
string ,
expiryTime:
{
Description: Expiry time of the access policy ,
Format: date-time ,
Required: False ,
}
string ,
permission:
{
Description: List of abbreviated permissions. ,
Required: False ,
}
string ,
}
,
}
,
]
,
snapshotTime:
{
Description: Creation time of share snapshot returned in the response of list shares with expand param "snapshots". ,
Format: date-time ,
Required: False ,
}
string ,
fileSharePaidBursting:
{
Description: File Share Paid Bursting properties. ,
Required: False ,
}
{
paidBurstingEnabled:
{
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. ,
Required: False ,
}
boolean ,
paidBurstingMaxIops:
{
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. ,
Format: int32 ,
Required: False ,
}
integer ,
paidBurstingMaxBandwidthMibps:
{
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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error response from the Storage service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}