PathCreateOptions interface

Package:

@azure/storage-file-datalake

An interface for options common to every remote operation.

Extends

CommonOptions

Properties

abortSignal
acl	Optional. POSIX access control rights on files and directories.
conditions
customerProvidedKey	Customer Provided Key Info.
encryptionContext	Optional. Specifies the encryption context to set on the file.
expiresOn	Optional. Options for scheduling the deletion of a path. A number value indicates duration before file should be deleted in milliseconds. A Date value indicates the time to set for when the path will be deleted. Does not apply to directories.
group	Optional. The owning group of the blob or directory.
leaseDuration	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.
metadata
owner	Optional. The owner of the blob or directory.
pathHttpHeaders
permissions
proposedLeaseId	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.
umask

Inherited Properties

tracingOptions

Property Details

abortSignal

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

acl

Optional. POSIX access control rights on files and directories.

acl?: PathAccessControlItem[]

Property Value

PathAccessControlItem[]

conditions

conditions?: DataLakeRequestConditions

Property Value

DataLakeRequestConditions

customerProvidedKey

Customer Provided Key Info.

customerProvidedKey?: CpkInfo

Property Value

CpkInfo

encryptionContext

Optional. Specifies the encryption context to set on the file.

encryptionContext?: string

Property Value

string

expiresOn

Optional. Options for scheduling the deletion of a path. A number value indicates duration before file should be deleted in milliseconds. A Date value indicates the time to set for when the path will be deleted. Does not apply to directories.

expiresOn?: number | Date

Property Value

number | Date

group

Optional. The owning group of the blob or directory.

group?: string

Property Value

string

leaseDuration

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.

leaseDuration?: number

Property Value

number

metadata

metadata?: Metadata

Property Value

Metadata

owner

Optional. The owner of the blob or directory.

owner?: string

Property Value

string

pathHttpHeaders

pathHttpHeaders?: PathCreateHttpHeaders

Property Value

PathCreateHttpHeaders

permissions

permissions?: string

Property Value

string

proposedLeaseId

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.

proposedLeaseId?: string

Property Value

string

umask

umask?: string

Property Value

string

Inherited Property Details

tracingOptions

tracingOptions?: OperationTracingOptions

Property Value

OperationTracingOptions

Inherited From CommonOptions.tracingOptions