ContainerBreakLeaseOptionalParams interface

Package:

@azure/storage-blob

Optional parameters.

Extends

OperationOptions

Properties

abortSignal	The signal which can be used to abort requests.
breakPeriod	For a break operation, proposed duration the lease should continue before it is broken, in seconds, between 0 and 60. This break period is only used if it is shorter than the time remaining on the lease. If longer, the time remaining on the lease is used. A new lease will not be available before the break period has expired, but the lease may be held for longer than the break period. If this header does not appear with a break operation, a fixed-duration lease breaks after the remaining lease period elapses, and an infinite lease breaks immediately.
modifiedAccessConditions	Parameter group
requestId	Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled.
requestOptions	Options used when creating and sending HTTP requests for this operation.
timeoutInSeconds	The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.
tracingOptions	Options used when tracing is enabled.

Property Details

abortSignal

The signal which can be used to abort requests.

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

breakPeriod

For a break operation, proposed duration the lease should continue before it is broken, in seconds, between 0 and 60. This break period is only used if it is shorter than the time remaining on the lease. If longer, the time remaining on the lease is used. A new lease will not be available before the break period has expired, but the lease may be held for longer than the break period. If this header does not appear with a break operation, a fixed-duration lease breaks after the remaining lease period elapses, and an infinite lease breaks immediately.

breakPeriod?: number

Property Value

number

modifiedAccessConditions

Parameter group

modifiedAccessConditions?: ModifiedAccessConditionsModel

Property Value

ModifiedAccessConditionsModel

requestId

Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled.

requestId?: string

Property Value

string

requestOptions

Options used when creating and sending HTTP requests for this operation.

requestOptions?: OperationRequestOptions

Property Value

OperationRequestOptions

timeoutInSeconds

The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.

timeoutInSeconds?: number

Property Value

number

tracingOptions

Options used when tracing is enabled.

tracingOptions?: OperationTracingOptions

Property Value

OperationTracingOptions