Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PathDeleteMethodOptionalParams

Package version

Optional Parameters.

Hierarchy

  • any
    • PathDeleteMethodOptionalParams

Index

Properties

Optional continuation

continuation: undefined | string

Optional. When deleting a directory, the number of paths that are deleted with each invocation is limited. If the number of paths to be deleted exceeds this limit, a continuation token is returned in this response header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the delete operation to continue deleting the directory.

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 recursive

recursive: undefined | false | true

Required and valid only when the resource is a directory. If "true", all paths beneath the directory will be deleted. If "false" and the directory is non-empty, an error occurs.

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 xMsLeaseId

xMsLeaseId: undefined | string

The lease ID must be specified if there is an active lease.

Generated using TypeDoc