Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DirectoryRenameOptionalParams

Package version

Optional Parameters.

Hierarchy

  • any
    • DirectoryRenameOptionalParams

Index

Properties

Properties

Optional directoryHttpHeaders

directoryHttpHeaders: DirectoryHttpHeaders

Additional parameters for the operation

Optional directoryProperties

directoryProperties: undefined | string

Optional. User-defined properties to be stored with the file or directory, in the format of a comma-separated list of name and value pairs "n1=v1, n2=v2, ...", where each value is base64 encoded.

Optional leaseAccessConditions

leaseAccessConditions: LeaseAccessConditions

Additional parameters for the operation

Optional marker

marker: undefined | string

When renaming a directory, the number of paths that are renamed with each invocation is limited. If the number of paths to be renamed 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 rename operation to continue renaming the directory.

Optional modifiedAccessConditions

modifiedAccessConditions: ModifiedAccessConditions

Additional parameters for the operation

Optional pathRenameMode

pathRenameMode: PathRenameMode

Determines the behavior of the rename operation. Possible values include: 'legacy', 'posix'

Optional posixPermissions

posixPermissions: 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 posixUmask

posixUmask: undefined | string

Only valid if Hierarchical Namespace is enabled for the account. This umask restricts permission settings for file and directory, and will only be applied when default Acl does not exist in parent directory. If the umask bit has set, it means that the corresponding permission will be disabled. Otherwise the corresponding permission will be determined by the permission. A 4-digit octal notation (e.g. 0022) is supported here. If no umask was specified, a default umask - 0027 will be used.

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 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

Additional parameters for the operation

Optional timeoutInSeconds

timeoutInSeconds: undefined | number

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

Generated using TypeDoc