File Shares - List
Lists all shares.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices/default/shares?api-version=2023-05-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices/default/shares?api-version=2023-05-01&$maxpagesize={$maxpagesize}&$filter={$filter}&$expand={$expand}
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
account
|
path | True |
string |
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. Regex pattern: |
resource
|
path | True |
string |
The name of the resource group within the user's subscription. The name is case insensitive. Regex pattern: |
subscription
|
path | True |
string |
The ID of the target subscription. |
api-version
|
query | True |
string |
The API version to use for this operation. |
$expand
|
query |
string |
Optional, used to expand the properties within share's properties. Valid values are: deleted, snapshots. Should be passed as a string with delimiter ',' |
|
$filter
|
query |
string |
Optional. When specified, only share names starting with the filter will be listed. |
|
$maxpagesize
|
query |
string |
Optional. Specified maximum number of shares that can be included in the list. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
OK -- List Shares operation completed successfully. |
|
Other Status Codes |
Error response describing why the operation failed. |
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
List |
List |
List |
ListDeletedShares
Sample request
Sample response
{
"value": [
{
"id": "/subscriptions/{subscription-id}/resourceGroups/res9290/providers/Microsoft.Storage/storageAccounts/sto1590/fileServices/default/shares/share1644_1234567890",
"name": "share1644",
"type": "Microsoft.Storage/storageAccounts/fileServices/shares",
"etag": "\"0x8D589847D51C7DE\"",
"properties": {
"lastModifiedTime": "2019-05-14T08:20:47Z",
"shareQuota": 1024,
"version": "1234567890",
"deleted": true,
"deletedTime": "2019-12-14T08:20:47Z",
"remainingRetentionDays": 30
}
},
{
"id": "/subscriptions/{subscription-id}/resourceGroups/res9290/providers/Microsoft.Storage/storageAccounts/sto1590/fileServices/default/shares/share4052",
"name": "share4052",
"type": "Microsoft.Storage/storageAccounts/fileServices/shares",
"etag": "\"0x8D589847DAB5AF9\"",
"properties": {
"lastModifiedTime": "2019-05-14T08:20:47Z",
"shareQuota": 1024
}
}
]
}
ListShares
Sample request
Sample response
{
"value": [
{
"id": "/subscriptions/{subscription-id}/resourceGroups/res9290/providers/Microsoft.Storage/storageAccounts/sto1590/fileServices/default/shares/share1644",
"name": "share1644",
"type": "Microsoft.Storage/storageAccounts/fileServices/shares",
"etag": "\"0x8D589847D51C7DE\"",
"properties": {
"lastModifiedTime": "2019-05-14T08:20:47Z",
"shareQuota": 1024
}
},
{
"id": "/subscriptions/{subscription-id}/resourceGroups/res9290/providers/Microsoft.Storage/storageAccounts/sto1590/fileServices/default/shares/share4052",
"name": "share4052",
"type": "Microsoft.Storage/storageAccounts/fileServices/shares",
"etag": "\"0x8D589847DAB5AF9\"",
"properties": {
"lastModifiedTime": "2019-05-14T08:20:47Z",
"shareQuota": 1024
}
}
],
"nextLink": "https://sto1590endpoint/subscriptions/{subscription-id}/resourceGroups/res9290/providers/Microsoft.Storage/storageAccounts/sto1590/fileServices/default/shares?api-version=2022-09-01&$maxpagesize=2&$skipToken=/sto1590/share5103"
}
ListShareSnapshots
Sample request
Sample response
{
"value": [
{
"id": "/subscriptions/{subscription-id}/resourceGroups/res9290/providers/Microsoft.Storage/storageAccounts/sto1590/fileServices/default/shares/share4052",
"name": "share4052",
"type": "Microsoft.Storage/storageAccounts/fileServices/shares",
"etag": "\"0x8D589847DAB5AF9\"",
"properties": {
"lastModifiedTime": "2020-10-26T05:47:05.0000000Z",
"shareQuota": 1024
}
},
{
"id": "/subscriptions/{subscription-id}/resourceGroups/res9290/providers/Microsoft.Storage/storageAccounts/sto1590/fileServices/default/shares/share4052",
"name": "share4052",
"type": "Microsoft.Storage/storageAccounts/fileServices/shares",
"etag": "\"0x8D589847DAB5AF9\"",
"properties": {
"lastModifiedTime": "2020-10-26T05:47:05.0000000Z",
"shareQuota": 1024,
"snapshotTime": "2020-10-26T05:48:07.0000000Z"
}
}
]
}
Definitions
Name | Description |
---|---|
Access |
|
Cloud |
An error response from the Storage service. |
Cloud |
An error response from the Storage service. |
Enabled |
The authentication protocol that is used for the file share. Can only be specified when creating a share. |
File |
The file share properties be listed out. |
File |
Response schema. Contains list of shares returned, and if paging is requested or required, a URL to next page of shares. |
Lease |
Specifies whether the lease on a share is of infinite or fixed duration, only when the share is leased. |
Lease |
Lease state of the share. |
Lease |
The lease status of the share. |
Root |
The property is for NFS share only. The default is NoRootSquash. |
Share |
Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium. |
Signed |
AccessPolicy
Name | Type | Description |
---|---|---|
expiryTime |
string |
Expiry time of the access policy |
permission |
string |
List of abbreviated permissions. |
startTime |
string |
Start time of the access policy |
CloudError
An error response from the Storage service.
Name | Type | Description |
---|---|---|
error |
An error response from the Storage service. |
CloudErrorBody
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 |
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
The authentication protocol that is used for the file share. Can only be specified when creating a share.
Name | Type | Description |
---|---|---|
NFS |
string |
|
SMB |
string |
FileShareItem
The file share properties be listed out.
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 |
Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium. |
|
properties.accessTierChangeTime |
string |
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 |
The deleted time if the share was deleted. |
properties.enabledProtocols |
The authentication protocol that is used for the file share. Can only be specified when creating a share. |
|
properties.lastModifiedTime |
string |
Returns the date and time the share was last modified. |
properties.leaseDuration |
Specifies whether the lease on a share is of infinite or fixed duration, only when the share is leased. |
|
properties.leaseState |
Lease state of the share. |
|
properties.leaseStatus |
The lease status of the share. |
|
properties.metadata |
object |
A name-value pair to associate with the share as metadata. |
properties.remainingRetentionDays |
integer |
Remaining retention days for share that was soft deleted. |
properties.rootSquash |
The property is for NFS share only. The default is NoRootSquash. |
|
properties.shareQuota |
integer |
The maximum size of the share, in gigabytes. Must be greater than 0, and less than or equal to 5TB (5120). For Large File Shares, the maximum size is 102400. |
properties.shareUsageBytes |
integer |
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 |
List of stored access policies specified on the share. |
|
properties.snapshotTime |
string |
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" |
FileShareItems
Response schema. Contains list of shares returned, and if paging is requested or required, a URL to next page of shares.
Name | Type | Description |
---|---|---|
nextLink |
string |
Request URL that can be used to query next page of shares. Returned when total number of requested shares exceed maximum page size. |
value |
List of file shares returned. |
LeaseDuration
Specifies whether the lease on a share is of infinite or fixed duration, only when the share is leased.
Name | Type | Description |
---|---|---|
Fixed |
string |
|
Infinite |
string |
LeaseState
Lease state of the share.
Name | Type | Description |
---|---|---|
Available |
string |
|
Breaking |
string |
|
Broken |
string |
|
Expired |
string |
|
Leased |
string |
LeaseStatus
The lease status of the share.
Name | Type | Description |
---|---|---|
Locked |
string |
|
Unlocked |
string |
RootSquashType
The property is for NFS share only. The default is NoRootSquash.
Name | Type | Description |
---|---|---|
AllSquash |
string |
|
NoRootSquash |
string |
|
RootSquash |
string |
ShareAccessTier
Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium.
Name | Type | Description |
---|---|---|
Cool |
string |
|
Hot |
string |
|
Premium |
string |
|
TransactionOptimized |
string |
SignedIdentifier
Name | Type | Description |
---|---|---|
accessPolicy |
Access policy |
|
id |
string |
An unique identifier of the stored access policy. |