CloudBlockBlob.AcquireLease Method

Article
05/14/2014

Acquires a lease on this blob.

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

Syntax

'Declaration
<DoesServiceRequestAttribute> _
Public Function AcquireLease ( _
    leaseTime As Nullable(Of TimeSpan), _
    proposedLeaseId As String, _
    <OptionalAttribute> Optional accessCondition As AccessCondition = Nothing, _
    <OptionalAttribute> Optional options As BlobRequestOptions = Nothing, _
    <OptionalAttribute> Optional operationContext As OperationContext = Nothing _
) As String

[DoesServiceRequestAttribute] 
public string AcquireLease (
    Nullable<TimeSpan> leaseTime,
    string proposedLeaseId,
    [OptionalAttribute] AccessCondition accessCondition,
    [OptionalAttribute] BlobRequestOptions options,
    [OptionalAttribute] OperationContext operationContext
)

[DoesServiceRequestAttribute] 
public:
virtual String^ AcquireLease (
    Nullable<TimeSpan> leaseTime, 
    String^ proposedLeaseId, 
    [OptionalAttribute] AccessCondition^ accessCondition, 
    [OptionalAttribute] BlobRequestOptions^ options, 
    [OptionalAttribute] OperationContext^ operationContext
) 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.

Return Value

A string containing the ID of the acquired lease.

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