Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ShareBreakLeaseOptionalParams

Package version

Optional parameters.

Hierarchy

  • any
    • ShareBreakLeaseOptionalParams

Index

Properties

Optional breakPeriod

breakPeriod: undefined | number

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.

Optional leaseAccessConditions

leaseAccessConditions: LeaseAccessConditions

Parameter group

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 shareSnapshot

shareSnapshot: undefined | string

The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query.

Optional timeoutInSeconds

timeoutInSeconds: undefined | number

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

Generated using TypeDoc