ICloudBlob.AcquireLease Method

Definition

Namespace:

Microsoft.Azure.Storage.Blob

Assembly:

Microsoft.Azure.Storage.Blob.dll

Package:

Microsoft.Azure.Storage.Blob v11.2.3

Acquires a lease on this blob.

public string AcquireLease (TimeSpan? leaseTime, string proposedLeaseId, Microsoft.Azure.Storage.AccessCondition accessCondition = default, Microsoft.Azure.Storage.Blob.BlobRequestOptions options = default, Microsoft.Azure.Storage.OperationContext operationContext = default);

abstract member AcquireLease : Nullable<TimeSpan> * string * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.Blob.BlobRequestOptions * Microsoft.Azure.Storage.OperationContext -> string

Public Function AcquireLease (leaseTime As Nullable(Of TimeSpan), proposedLeaseId As String, Optional accessCondition As AccessCondition = Nothing, Optional options As BlobRequestOptions = Nothing, Optional operationContext As OperationContext = Nothing) As String

Parameters

leaseTime

Nullable<TimeSpan>

A TimeSpan representing the span of time for which to acquire the lease, which will be rounded down to seconds.

proposedLeaseId

String

A string representing the proposed lease ID for the new lease.

accessCondition

AccessCondition

An AccessCondition object that represents the condition that must be met in order for the request to proceed.

options

BlobRequestOptions

A BlobRequestOptions object that specifies additional options for the request. If null, default options are applied to the request.

operationContext

OperationContext

An OperationContext object that represents the context for the current operation.

Returns

String

The ID of the acquired lease.