Storage Client Library for Windows Phone (Version 7.0)

Initiates an asynchronous operation that acquires a lease on this container.

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,
	CancellationToken cancellationToken
)

C++

Copy Code

 

public:
[DoesServiceRequestAttribute]
virtual Task<String^>^ AcquireLeaseAsync(
	Nullable<TimeSpan> leaseTime,
	String^ proposedLeaseId,
	CancellationToken cancellationToken
)

F#

Copy Code

 

[<DoesServiceRequestAttribute>]
abstract AcquireLeaseAsync : 
        leaseTime:Nullable<TimeSpan> *
        proposedLeaseId:string *
        cancellationToken:CancellationToken -> Task<string>
[<DoesServiceRequestAttribute>]
override AcquireLeaseAsync : 
        leaseTime:Nullable<TimeSpan> *
        proposedLeaseId:string *
        cancellationToken:CancellationToken -> Task<string>

VB

Copy Code

 

<DoesServiceRequestAttribute>
Public Overridable Function AcquireLeaseAsync (
	leaseTime As Nullable(Of TimeSpan),
	proposedLeaseId As String,
	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.

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 that represents the asynchronous operation.

See Also

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

Return to top