FileServiceResource.GetFileShareAsync Method

Reference

Definition

Namespace:: Azure.ResourceManager.Storage

Assembly:: Azure.ResourceManager.Storage.dll

Package:: Azure.ResourceManager.Storage v1.2.3

Package:: Azure.ResourceManager.Storage v1.2.0-beta.2

Source:: FileServiceResource.cs

Source:: FileServiceResource.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets properties of a specified share.

Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices/default/shares/{shareName}
Operation Id: FileShares_Get
Default Api Version: 2022-09-01
Resource: FileShareResource

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Storage.FileShareResource>> GetFileShareAsync (string shareName, string expand = default, string xMsSnapshot = default, System.Threading.CancellationToken cancellationToken = default);

abstract member GetFileShareAsync : string * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Storage.FileShareResource>>
override this.GetFileShareAsync : string * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Storage.FileShareResource>>

Public Overridable Function GetFileShareAsync (shareName As String, Optional expand As String = Nothing, Optional xMsSnapshot As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of FileShareResource))

Parameters

shareName: 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.

expand: String

Optional, used to expand the properties within share's properties. Valid values are: stats. Should be passed as a string with delimiter ','.

xMsSnapshot: String

Optional, used to retrieve properties of a snapshot.

cancellationToken: CancellationToken

The cancellation token to use.

Returns

Task<Response<FileShareResource>>

Exceptions

ArgumentNullException

shareName is null.

ArgumentException

shareName is an empty string, and was expected to be non-empty.

Applies to

Share via