Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PathCreateOptionalParams

Package version

Optional parameters.

Hierarchy

  • any
    • PathCreateOptionalParams

Index

Properties

Optional acl

acl: undefined | string

Sets POSIX access control rights on files and directories. The value is a comma-separated list of access control entries. Each access control entry (ACE) consists of a scope, a type, a user or group identifier, and permissions in the format "[scope:][type]:[id]:[permissions]".

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 cpkInfo

cpkInfo: CpkInfo

Parameter group

Optional expiresOn

expiresOn: undefined | string

The time to set the blob to expiry

Optional expiryOptions

expiryOptions: PathExpiryOptions

Required. Indicates mode of the expiry time

Optional group

group: undefined | string

Optional. The owning group of the blob or directory.

Optional leaseAccessConditions

leaseAccessConditions: LeaseAccessConditions

Parameter group

Optional leaseDuration

leaseDuration: 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 mode

Optional. Valid only when namespace is enabled. This parameter determines the behavior of the rename operation. The value must be "legacy" or "posix", and the default value will be "posix".

Optional modifiedAccessConditions

modifiedAccessConditions: ModifiedAccessConditions

Parameter group

Optional owner

owner: undefined | string

Optional. The owner of the blob or directory.

Optional pathHttpHeaders

pathHttpHeaders: PathHttpHeaders

Parameter group

Optional permissions

permissions: undefined | string

Optional and only valid if Hierarchical Namespace is enabled for the account. Sets POSIX access permissions for the file owner, the file owning group, and others. Each class may be granted read, write, or execute permission. The sticky bit is also supported. Both symbolic (rwxrw-rw-) and 4-digit octal notation (e.g. 0766) are supported.

Optional properties

properties: undefined | string

Optional. User-defined properties to be stored with the filesystem, in the format of a comma-separated list of name and value pairs "n1=v1, n2=v2, ...", where each value is a base64 encoded string. Note that the string may only contain ASCII characters in the ISO-8859-1 character set. If the filesystem exists, any properties not included in the list will be removed. All properties are removed if the header is omitted. To merge new and existing properties, first get all existing properties and the current E-Tag, then make a conditional request with the E-Tag and include values for all properties.

Optional proposedLeaseId

proposedLeaseId: undefined | string

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.

Optional renameSource

renameSource: undefined | string

An optional file or directory to be renamed. The value must have the following format: "/{filesystem}/{path}". If "x-ms-properties" is specified, the properties will overwrite the existing properties; otherwise, the existing properties will be preserved. This value must be a URL percent-encoded string. Note that the string may only contain ASCII characters in the ISO-8859-1 character set.

Optional requestId

requestId: undefined | string

Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled.

Optional resource

Required only for Create File and Create Directory. The value must be "file" or "directory".

Optional sourceLeaseId

sourceLeaseId: undefined | string

A lease ID for the source path. If specified, the source path must have an active lease and the lease ID must match.

Optional sourceModifiedAccessConditions

sourceModifiedAccessConditions: SourceModifiedAccessConditions

Parameter group

Optional timeout

timeout: undefined | number

The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.

Optional umask

umask: undefined | string

Optional and only valid if Hierarchical Namespace is enabled for the account. When creating a file or directory and the parent folder does not have a default ACL, the umask restricts the permissions of the file or directory to be created. The resulting permission is given by p bitwise and not u, where p is the permission and u is the umask. For example, if p is 0777 and u is 0057, then the resulting permission is 0720. The default permission is 0777 for a directory and 0666 for a file. The default umask is 0027. The umask must be specified in 4-digit octal notation (e.g. 0766).

Generated using TypeDoc