PathLeaseOptionalParams | @azure/storage-file-datalake

Optional Parameters.

Hierarchy

any
- PathLeaseOptionalParams

Index

Properties

Optional leaseAccessConditions

leaseAccessConditions: LeaseAccessConditions

Additional parameters for the operation

Optional modifiedAccessConditions

modifiedAccessConditions: ModifiedAccessConditions

Additional parameters for the operation

Optional proposedLeaseId

proposedLeaseId: undefined | string

Proposed lease ID, in a GUID string format. The Blob service returns 400 (Invalid request) if the proposed lease ID is not in the correct format. See Guid Constructor (String) for a list of valid GUID string formats.

Optional requestId

requestId: undefined | string

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.

Optional timeoutParameter

timeoutParameter: undefined | number

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

Optional xMsLeaseBreakPeriod

xMsLeaseBreakPeriod: undefined | number

The lease break period duration is optional to break a lease, and specifies the break period of the lease in seconds. The lease break duration must be between 0 and 60 seconds.

Optional xMsLeaseDuration

xMsLeaseDuration: undefined | number

The lease duration is required to acquire a lease, and specifies the duration of the lease in seconds. The lease duration must be between 15 and 60 seconds or -1 for infinite lease.