FileShareCollection.GetAsync Method

  • Reference

Definition

Namespace:
Azure.ResourceManager.Storage
Assembly:
Azure.ResourceManager.Storage.dll
Package:
Azure.ResourceManager.Storage v1.3.0
Package:
Azure.ResourceManager.Storage v1.2.0-beta.2
Source:
FileShareCollection.cs
Source:
FileShareCollection.cs

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: 2023-05-01
  • Resource: FileShareResource
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Storage.FileShareResource>> GetAsync (string shareName, string expand = default, string xMsSnapshot = default, System.Threading.CancellationToken cancellationToken = default);
abstract member GetAsync : string * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Storage.FileShareResource>>
override this.GetAsync : string * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Storage.FileShareResource>>
Public Overridable Function GetAsync (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

ArgumentException

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

ArgumentNullException

shareName is null.

Applies to