FileShareCollection.GetIfExistsAsync Method

Definition

Namespace:

Azure.ResourceManager.Storage

Assembly:

Azure.ResourceManager.Storage.dll

Package:

Azure.ResourceManager.Storage v1.3.0

Source:

FileShareCollection.cs

Tries to get details for this resource from the service.

• 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.NullableResponse<Azure.ResourceManager.Storage.FileShareResource>> GetIfExistsAsync (string shareName, string expand = default, string xMsSnapshot = default, System.Threading.CancellationToken cancellationToken = default);

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

Public Overridable Function GetIfExistsAsync (shareName As String, Optional expand As String = Nothing, Optional xMsSnapshot As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of NullableResponse(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<NullableResponse<FileShareResource>>

Exceptions

ArgumentException

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

ArgumentNullException

shareName is null.