Storage Client Library for Windows Phone (Version 7.0)

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

C#

Copy Code

 

[DoesServiceRequestAttribute]
public virtual Task<string> AcquireLeaseAsync(
	Nullable<TimeSpan> leaseTime,
	string proposedLeaseId,
	AccessCondition accessCondition,
	BlobRequestOptions options,
	OperationContext operationContext,
	CancellationToken cancellationToken
)

C++

Copy Code

 

public:
[DoesServiceRequestAttribute]
virtual Task<String^>^ AcquireLeaseAsync(
	Nullable<TimeSpan> leaseTime,
	String^ proposedLeaseId,
	AccessCondition^ accessCondition,
	BlobRequestOptions^ options,
	OperationContext^ operationContext,
	CancellationToken cancellationToken
)

F#

Copy Code

 

[<DoesServiceRequestAttribute>]
abstract AcquireLeaseAsync : 
        leaseTime:Nullable<TimeSpan> *
        proposedLeaseId:string *
        accessCondition:AccessCondition *
        options:BlobRequestOptions *
        operationContext:OperationContext *
        cancellationToken:CancellationToken -> Task<string>
[<DoesServiceRequestAttribute>]
override AcquireLeaseAsync : 
        leaseTime:Nullable<TimeSpan> *
        proposedLeaseId:string *
        accessCondition:AccessCondition *
        options:BlobRequestOptions *
        operationContext:OperationContext *
        cancellationToken:CancellationToken -> Task<string>

VB

Copy Code

 

<DoesServiceRequestAttribute>
Public Overridable Function AcquireLeaseAsync (
	leaseTime As Nullable(Of TimeSpan),
	proposedLeaseId As String,
	accessCondition As AccessCondition,
	options As BlobRequestOptions,
	operationContext As OperationContext,
	cancellationToken As CancellationToken
) As Task(Of String)

Parameters

leaseTime

Type: System.Nullable<TimeSpan>System::Nullable<TimeSpan>System.Nullable<TimeSpan>System.Nullable(Of 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 greater than zero.

proposedLeaseId

Type: System.StringSystem::String^System.StringSystem.String

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

accessCondition

Type: Microsoft.WindowsAzure.Storage.AccessConditionMicrosoft.WindowsAzure.Storage::AccessCondition^Microsoft.WindowsAzure.Storage.AccessConditionMicrosoft.WindowsAzure.Storage.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

Type: Microsoft.WindowsAzure.Storage.Blob.BlobRequestOptionsMicrosoft.WindowsAzure.Storage.Blob::BlobRequestOptions^Microsoft.WindowsAzure.Storage.Blob.BlobRequestOptionsMicrosoft.WindowsAzure.Storage.Blob.BlobRequestOptions

A BlobRequestOptions object that specifies additional options for the request.

operationContext

Type: Microsoft.WindowsAzure.Storage.OperationContextMicrosoft.WindowsAzure.Storage::OperationContext^Microsoft.WindowsAzure.Storage.OperationContextMicrosoft.WindowsAzure.Storage.OperationContext

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

cancellationToken

Type: System.Threading.CancellationTokenSystem.Threading::CancellationTokenSystem.Threading.CancellationTokenSystem.Threading.CancellationToken

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

Return Value

Type: System.Threading.Tasks.Task<String>System.Threading.Tasks::Task<String^>^System.Threading.Tasks.Task<String>System.Threading.Tasks.Task(Of String)

A Task<TResult><TResult><'TResult>(Of TResult) object of type string that represents the asynchronous operation.

See Also

AcquireLeaseAsync Overload
CloudBlob Class
Microsoft.WindowsAzure.Storage.Blob Namespace

Return to top