Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PathLeaseOptionalParams

Package version

Optional Parameters.

Hierarchy

  • any
    • PathLeaseOptionalParams

Index

Properties

Optional ifMatch

ifMatch: undefined | string

Optional. An ETag value. Specify this header to perform the operation only if the resource's ETag matches the value specified. The ETag must be specified in quotes.

Optional ifModifiedSince

ifModifiedSince: undefined | string

Optional. A date and time value. Specify this header to perform the operation only if the resource has been modified since the specified date and time.

Optional ifNoneMatch

ifNoneMatch: undefined | string

Optional. An ETag value or the special wildcard ("*") value. Specify this header to perform the operation only if the resource's ETag does not match the value specified. The ETag must be specified in quotes.

Optional ifUnmodifiedSince

ifUnmodifiedSince: undefined | string

Optional. A date and time value. Specify this header to perform the operation only if the resource has not been modified since the specified date and time.

Optional timeoutParameter

timeoutParameter: undefined | number

An optional operation timeout value in seconds. The period begins when the request is received by the service. If the timeout value elapses before the operation completes, the operation fails.

Optional xMsClientRequestId

xMsClientRequestId: undefined | string

A UUID recorded in the analytics logs for troubleshooting and correlation.

Optional xMsDate

xMsDate: undefined | string

Specifies the Coordinated Universal Time (UTC) for the request. This is required when using shared key authorization.

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.

Optional xMsLeaseId

xMsLeaseId: undefined | string

Required when "x-ms-lease-action" is "renew", "change" or "release". For the renew and release actions, this must match the current lease ID.

Optional xMsProposedLeaseId

xMsProposedLeaseId: undefined | string

Required when "x-ms-lease-action" is "acquire" or "change". A lease will be acquired with this lease ID if the operation is successful.

Generated using TypeDoc