CloudBlob.BeginAcquireLease Method

Definition

Namespace:

Microsoft.Azure.Storage.Blob

Assembly:

Microsoft.Azure.Storage.Blob.dll

Package:

Microsoft.Azure.Storage.Blob v11.2.3

Overloads

BeginAcquireLease(Nullable<TimeSpan>, String, AsyncCallback, Object)	Begins an asynchronous operation to acquire a lease on this blob.
BeginAcquireLease(Nullable<TimeSpan>, String, AccessCondition, BlobRequestOptions, OperationContext, AsyncCallback, Object)	Begins an asynchronous operation to acquire a lease on this blob.

BeginAcquireLease(Nullable<TimeSpan>, String, AsyncCallback, Object)

Begins an asynchronous operation to acquire a lease on this blob.

[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual Microsoft.Azure.Storage.ICancellableAsyncResult BeginAcquireLease (TimeSpan? leaseTime, string proposedLeaseId, AsyncCallback callback, object state);

[<Microsoft.Azure.Storage.DoesServiceRequest>]
abstract member BeginAcquireLease : Nullable<TimeSpan> * string * AsyncCallback * obj -> Microsoft.Azure.Storage.ICancellableAsyncResult
override this.BeginAcquireLease : Nullable<TimeSpan> * string * AsyncCallback * obj -> Microsoft.Azure.Storage.ICancellableAsyncResult

Public Overridable Function BeginAcquireLease (leaseTime As Nullable(Of TimeSpan), proposedLeaseId As String, callback As AsyncCallback, state As Object) As ICancellableAsyncResult

Parameters

leaseTime

Nullable<TimeSpan>

A TimeSpan representing the span of time for which to acquire the lease, which will be rounded down to seconds. If null, an infinite lease will be acquired. If not null, this must be 15 to 60 seconds.

proposedLeaseId

String

A string representing the proposed lease ID for the new lease, or null if no lease ID is proposed.

callback

AsyncCallback

An optional callback delegate that will receive notification when the asynchronous operation completes.

state

Object

A user-defined object that will be passed to the callback delegate.

Returns

ICancellableAsyncResult

An ICancellableAsyncResult that references the asynchronous operation.

Attributes

DoesServiceRequestAttribute

BeginAcquireLease(Nullable<TimeSpan>, String, AccessCondition, BlobRequestOptions, OperationContext, AsyncCallback, Object)

Begins an asynchronous operation to acquire a lease on this blob.

[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual Microsoft.Azure.Storage.ICancellableAsyncResult BeginAcquireLease (TimeSpan? leaseTime, string proposedLeaseId, Microsoft.Azure.Storage.AccessCondition accessCondition, Microsoft.Azure.Storage.Blob.BlobRequestOptions options, Microsoft.Azure.Storage.OperationContext operationContext, AsyncCallback callback, object state);

[<Microsoft.Azure.Storage.DoesServiceRequest>]
abstract member BeginAcquireLease : Nullable<TimeSpan> * string * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.Blob.BlobRequestOptions * Microsoft.Azure.Storage.OperationContext * AsyncCallback * obj -> Microsoft.Azure.Storage.ICancellableAsyncResult
override this.BeginAcquireLease : Nullable<TimeSpan> * string * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.Blob.BlobRequestOptions * Microsoft.Azure.Storage.OperationContext * AsyncCallback * obj -> Microsoft.Azure.Storage.ICancellableAsyncResult

Public Overridable Function BeginAcquireLease (leaseTime As Nullable(Of TimeSpan), proposedLeaseId As String, accessCondition As AccessCondition, options As BlobRequestOptions, operationContext As OperationContext, callback As AsyncCallback, state As Object) As ICancellableAsyncResult

Parameters

leaseTime

Nullable<TimeSpan>

A TimeSpan representing the span of time for which to acquire the lease, which will be rounded down to seconds. If null, an infinite lease will be acquired. If not null, this must be 15 to 60 seconds.

proposedLeaseId

String

A string representing the proposed lease ID for the new lease, or null if no lease ID is proposed.

accessCondition

AccessCondition

An AccessCondition object that represents the condition that must be met in order for the request to proceed. If null, no condition is used.

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.

callback

AsyncCallback

An optional callback delegate that will receive notification when the asynchronous operation completes.

state

Object

A user-defined object that will be passed to the callback delegate.

Returns

ICancellableAsyncResult

An ICancellableAsyncResult that references the asynchronous operation.

Attributes

DoesServiceRequestAttribute