CloudBlockBlob.BeginAcquireLease Method (Nullable, String, AccessCondition, BlobRequestOptions, OperationContext, AsyncCallback, Object)

Article
05/14/2014

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

Namespace: Microsoft.WindowsAzure.Storage.Blob
Assembly: Microsoft.WindowsAzure.Storage (in Microsoft.WindowsAzure.Storage.dll)

Syntax

'Declaration
<DoesServiceRequestAttribute> _
Public 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

[DoesServiceRequestAttribute] 
public ICancellableAsyncResult BeginAcquireLease (
    Nullable<TimeSpan> leaseTime,
    string proposedLeaseId,
    AccessCondition accessCondition,
    BlobRequestOptions options,
    OperationContext operationContext,
    AsyncCallback callback,
    Object state
)

[DoesServiceRequestAttribute] 
public:
virtual ICancellableAsyncResult^ BeginAcquireLease (
    Nullable<TimeSpan> leaseTime, 
    String^ proposedLeaseId, 
    AccessCondition^ accessCondition, 
    BlobRequestOptions^ options, 
    OperationContext^ operationContext, 
    AsyncCallback^ callback, 
    Object^ state
) sealed

Parameters

leaseTime
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 greater than zero.

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

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
A BlobRequestOptions object that specifies additional options for the request. If null, default options are applied to the request.

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

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

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

Return Value

An ICancellableAsyncResult that references the asynchronous operation.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

Windows Vista, Windows 7 and Windows Server 2008