PathGetPropertiesOptionalParams | @azure/storage-datalake

Optional Parameters.

Hierarchy

any
- PathGetPropertiesOptionalParams

Index

Properties

Optional action

Optional. If the value is "getStatus" only the system defined properties for the path are returned. If the value is "getAccessControl" the access control list is returned in the response headers (Hierarchical Namespace must be enabled for the account), otherwise the properties are returned. Possible values include: 'getAccessControl', 'getStatus'

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 upn

upn: undefined | false | true

Optional. Valid only when Hierarchical Namespace is enabled for the account. If "true", the user identity values returned in the x-ms-owner, x-ms-group, and x-ms-acl response headers will be transformed from Azure Active Directory Object IDs to User Principal Names. If "false", the values will be returned as Azure Active Directory Object IDs. The default value is false. Note that group and application Object IDs are not translated because they do not have unique friendly names.

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

Optional. If this header is specified, the operation will be performed only if both of the following conditions are met: i) the path's lease is currently active and ii) the lease ID specified in the request matches that of the path.