CloudBlobContainer.BreakLease Method

Definition

Namespace:

Microsoft.Azure.Storage.Blob

Assembly:

Microsoft.Azure.Storage.Blob.dll

Package:

Microsoft.Azure.Storage.Blob v11.2.3

Breaks the current lease on this container.

[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual TimeSpan BreakLease (TimeSpan? breakPeriod = default, Microsoft.Azure.Storage.AccessCondition accessCondition = default, Microsoft.Azure.Storage.Blob.BlobRequestOptions options = default, Microsoft.Azure.Storage.OperationContext operationContext = default);

[<Microsoft.Azure.Storage.DoesServiceRequest>]
abstract member BreakLease : Nullable<TimeSpan> * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.Blob.BlobRequestOptions * Microsoft.Azure.Storage.OperationContext -> TimeSpan
override this.BreakLease : Nullable<TimeSpan> * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.Blob.BlobRequestOptions * Microsoft.Azure.Storage.OperationContext -> TimeSpan

Public Overridable Function BreakLease (Optional breakPeriod As Nullable(Of TimeSpan) = Nothing, Optional accessCondition As AccessCondition = Nothing, Optional options As BlobRequestOptions = Nothing, Optional operationContext As OperationContext = Nothing) As TimeSpan

Parameters

breakPeriod

Nullable<TimeSpan>

A TimeSpan representing the amount of time to allow the lease to remain, which will be rounded down to seconds. If null, the break period is the remainder of the current lease, or zero for infinite leases.

accessCondition

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

BlobRequestOptions

A BlobRequestOptions object that specifies additional options for the request. If null, default options are applied to the request.

operationContext

OperationContext

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

Returns

TimeSpan

A TimeSpan representing the amount of time before the lease ends, to the second.

Attributes

DoesServiceRequestAttribute