FileCreateOptions interface

  • Reference
Package:
@azure/storage-file-datalake

An interface for options common to every remote operation.

Extends
PathCreateOptions

Inherited 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.
tracingOptions
umask

Inherited Property Details

abortSignal 

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

Inherited From PathCreateOptions.abortSignal

acl

Optional. POSIX access control rights on files and directories.

acl?: PathAccessControlItem[]

Property Value

PathAccessControlItem[]

Inherited From PathCreateOptions.acl

conditions 

conditions?: DataLakeRequestConditions

Property Value

DataLakeRequestConditions

Inherited From PathCreateOptions.conditions

customerProvidedKey

Customer Provided Key Info.

customerProvidedKey?: CpkInfo

Property Value

CpkInfo

Inherited From PathCreateOptions.customerProvidedKey

encryptionContext

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

encryptionContext?: string

Property Value

string

Inherited From PathCreateOptions.encryptionContext

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

Inherited From PathCreateOptions.expiresOn

group

Optional. The owning group of the blob or directory.

group?: string

Property Value

string

Inherited From PathCreateOptions.group

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

Inherited From PathCreateOptions.leaseDuration

metadata 

metadata?: Metadata

Property Value

Metadata

Inherited From PathCreateOptions.metadata

owner

Optional. The owner of the blob or directory.

owner?: string

Property Value

string

Inherited From PathCreateOptions.owner

pathHttpHeaders 

pathHttpHeaders?: PathCreateHttpHeaders

Property Value

PathCreateHttpHeaders

Inherited From PathCreateOptions.pathHttpHeaders

permissions 

permissions?: string

Property Value

string

Inherited From PathCreateOptions.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.

proposedLeaseId?: string

Property Value

string

Inherited From PathCreateOptions.proposedLeaseId

tracingOptions 

tracingOptions?: OperationTracingOptions

Property Value

OperationTracingOptions

Inherited From PathCreateOptions.tracingOptions

umask 

umask?: string

Property Value

string

Inherited From PathCreateOptions.umask