CloudBlockBlob.AcquireLeaseAsync Method (Nullable, String, CancellationToken)

Article
05/14/2014

Initiates 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 AcquireLeaseAsync ( _
    leaseTime As Nullable(Of TimeSpan), _
    proposedLeaseId As String, _
    cancellationToken As CancellationToken _
) As Task(Of String)

[DoesServiceRequestAttribute] 
public Task<string> AcquireLeaseAsync (
    Nullable<TimeSpan> leaseTime,
    string proposedLeaseId,
    CancellationToken cancellationToken
)

[DoesServiceRequestAttribute] 
public:
virtual Task<String^>^ AcquireLeaseAsync (
    Nullable<TimeSpan> leaseTime, 
    String^ proposedLeaseId, 
    CancellationToken cancellationToken
) 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.

cancellationToken
A CancellationToken to observe while waiting for a task to complete.

Return Value

A Task object of type string that represents 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