File Shares - Get

Gets properties of a specified share.

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

URI Parameters

Name In Required Type Description
accountName
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.

resourceGroupName
path True
  • string

The name of the resource group within the user's subscription. The name is case insensitive.

Regex pattern: ^[-\w\._\(\)]+$

shareName
path True
  • string

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

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: stats. Should be passed as a string with delimiter ','.

Request Header

Name Required Type Description
x-ms-snapshot
  • string

Optional, used to retrieve properties of a snapshot.

Responses

Name Type Description
200 OK

OK -- Get Share 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

GetShares
GetShareStats

GetShares

Sample Request

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/res9871/providers/Microsoft.Storage/storageAccounts/sto6217/fileServices/default/shares/share1634?api-version=2022-09-01

Sample Response

{
  "id": "/subscriptions/{subscription-id}/resourceGroups/res9871/providers/Microsoft.Storage/storageAccounts/sto6217/fileServices/default/shares/share1634",
  "name": "share1634",
  "type": "Microsoft.Storage/storageAccounts/fileServices/shares",
  "etag": "\"0x8D592D74CC20EBA\"",
  "properties": {
    "lastModifiedTime": "2019-05-26T05:06:14Z",
    "shareQuota": 1024
  }
}

GetShareStats

Sample Request

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/res9871/providers/Microsoft.Storage/storageAccounts/sto6217/fileServices/default/shares/share1634?api-version=2022-09-01&$expand=stats

Sample Response

{
  "id": "/subscriptions/{subscription-id}/resourceGroups/res9871/providers/Microsoft.Storage/storageAccounts/sto6217/fileServices/default/shares/share1634",
  "name": "share1634",
  "type": "Microsoft.Storage/storageAccounts/fileServices/shares",
  "etag": "\"0x8D592D74CC20EBA\"",
  "properties": {
    "lastModifiedTime": "2019-05-26T05:06:14Z",
    "shareQuota": 1024,
    "shareUsageBytes": 652945
  }
}

Definitions

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.

LeaseDuration

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

LeaseState

Lease state of the share.

LeaseStatus

The lease status of the share.

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

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

FileShare

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

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"

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.