FileSharesOperationsExtensions.LeaseAsync Method

Definition

Namespace:

Microsoft.Azure.Management.Storage

Assembly:

Microsoft.Azure.Management.Storage.dll

Package:

Microsoft.Azure.Management.Storage v25.0.0

The Lease Share operation establishes and manages a lock on a share for delete operations. The lock duration can be 15 to 60 seconds, or can be infinite.

public static System.Threading.Tasks.Task<Microsoft.Azure.Management.Storage.Models.LeaseShareResponse> LeaseAsync (this Microsoft.Azure.Management.Storage.IFileSharesOperations operations, string resourceGroupName, string accountName, string shareName, Microsoft.Azure.Management.Storage.Models.LeaseShareRequest parameters = default, string xMsSnapshot = default, System.Threading.CancellationToken cancellationToken = default);

static member LeaseAsync : Microsoft.Azure.Management.Storage.IFileSharesOperations * string * string * string * Microsoft.Azure.Management.Storage.Models.LeaseShareRequest * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Management.Storage.Models.LeaseShareResponse>

<Extension()>
Public Function LeaseAsync (operations As IFileSharesOperations, resourceGroupName As String, accountName As String, shareName As String, Optional parameters As LeaseShareRequest = Nothing, Optional xMsSnapshot As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of LeaseShareResponse)

Parameters

operations

IFileSharesOperations

The operations group for this extension method.

resourceGroupName

String

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

accountName

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.

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.

parameters

LeaseShareRequest

Lease Share request body.

xMsSnapshot

String

Optional. Specify the snapshot time to lease a snapshot.

cancellationToken

CancellationToken

The cancellation token.

Returns

Task<LeaseShareResponse>