@azure/storage-file-datalake

import * as coreClient from "@azure/core-client"; import * as coreHttpCompat from "@azure/core-http-compat"; export interface FileSystemList { filesystems?: FileSystem[]; } export interface FileSystem { name?: string; lastModified?: Date; etag?: string; } export interface StorageError { /** The service error response object. */ error?: StorageErrorError; code?: string; authenticationErrorDetail?: string; } /** The service error response object. */ export interface StorageErrorError { /** The service error code. */ code?: string; /** The service error message. */ message?: string; } export interface PathList { paths?: Path[]; } export interface Path { name?: string; isDirectory?: boolean; lastModified?: Date; etag?: string; contentLength?: number; owner?: string; group?: string; permissions?: string; /** The name of the encryption scope under which the blob is encrypted. */ encryptionScope?: string; creationTime?: string; expiryTime?: string; encryptionContext?: string; } /** An enumeration of blobs */ export interface ListBlobsHierarchySegmentResponse { serviceEndpoint: string; containerName: string; prefix?: string; marker?: string; maxResults?: number; delimiter?: string; segment: BlobHierarchyListSegment; nextMarker?: string; } export interface BlobHierarchyListSegment { blobPrefixes?: BlobPrefix[]; blobItems: BlobItemModel[]; } export interface BlobPrefix { name: string; } /** An Azure Storage blob */ export interface BlobItemModel { name: string; deleted: boolean; snapshot: string; versionId?: string; isCurrentVersion?: boolean; /** Properties of a blob */ properties: BlobPropertiesModel; deletionId?: string; } /** Properties of a blob */ export interface BlobPropertiesModel { creationTime?: Date; lastModified: Date; etag: string; /** Size in bytes */ contentLength?: number; contentType?: string; contentEncoding?: string; contentLanguage?: string; contentMD5?: Uint8Array; contentDisposition?: string; cacheControl?: string; blobSequenceNumber?: number; copyId?: string; copySource?: string; copyProgress?: string; copyCompletionTime?: Date; copyStatusDescription?: string; serverEncrypted?: boolean; incrementalCopy?: boolean; destinationSnapshot?: string; deletedTime?: Date; remainingRetentionDays?: number; accessTierInferred?: boolean; customerProvidedKeySha256?: string; /** The name of the encryption scope under which the blob is encrypted. */ encryptionScope?: string; accessTierChangeTime?: Date; tagCount?: number; expiresOn?: Date; sealed?: boolean; lastAccessedOn?: Date; } export interface SetAccessControlRecursiveResponse { directoriesSuccessful?: number; filesSuccessful?: number; failureCount?: number; failedEntries?: AclFailedEntry[]; } export interface AclFailedEntry { name?: string; type?: string; errorMessage?: string; } /** Defines headers for Service_listFileSystems operation. */ export interface ServiceListFileSystemsHeaders { /** A UTC date/time value generated by the service that indicates the time at which the response was initiated. */ date?: Date; /** A server-generated UUID recorded in the analytics logs for troubleshooting and correlation. */ requestId?: string; /** The version of the REST protocol used to process the request. */ version?: string; /** If the number of filesystems to be listed exceeds the maxResults 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 list operation to continue listing the filesystems. */ continuation?: string; /** The content type of list filesystem response. The default content type is application/json. */ contentType?: string; } /** Defines headers for Service_listFileSystems operation. */ export interface ServiceListFileSystemsExceptionHeaders { errorCode?: string; } /** Defines headers for FileSystem_create operation. */ export interface FileSystemCreateHeaders { /** A UTC date/time value generated by the service that indicates the time at which the response was initiated. */ date?: Date; /** An HTTP entity tag associated with the FileSystem. */ etag?: string; /** The data and time the filesystem was last modified. Operations on files and directories do not affect the last modified time. */ lastModified?: Date; /** A server-generated UUID recorded in the analytics logs for troubleshooting and correlation. */ clientRequestId?: string; /** The version of the REST protocol used to process the request. */ version?: string; /** A bool string indicates whether the namespace feature is enabled. If "true", the namespace is enabled for the filesystem. */ namespaceEnabled?: string; } /** Defines headers for FileSystem_create operation. */ export interface FileSystemCreateExceptionHeaders { errorCode?: string; } /** Defines headers for FileSystem_setProperties operation. */ export interface FileSystemSetPropertiesHeaders { /** A UTC date/time value generated by the service that indicates the time at which the response was initiated. */ date?: Date; /** An HTTP entity tag associated with the filesystem. Changes to filesystem properties affect the entity tag, but operations on files and directories do not. */ etag?: string; /** The data and time the filesystem was last modified. Changes to filesystem properties update the last modified time, but operations on files and directories do not. */ lastModified?: Date; /** A server-generated UUID recorded in the analytics logs for troubleshooting and correlation. */ requestId?: string; /** The version of the REST protocol used to process the request. */ version?: string; } /** Defines headers for FileSystem_setProperties operation. */ export interface FileSystemSetPropertiesExceptionHeaders { errorCode?: string; } /** Defines headers for FileSystem_getProperties operation. */ export interface FileSystemGetPropertiesHeaders { /** A UTC date/time value generated by the service that indicates the time at which the response was initiated. */ date?: Date; /** An HTTP entity tag associated with the filesystem. Changes to filesystem properties affect the entity tag, but operations on files and directories do not. */ etag?: string; /** The data and time the filesystem was last modified. Changes to filesystem properties update the last modified time, but operations on files and directories do not. */ lastModified?: Date; /** A server-generated UUID recorded in the analytics logs for troubleshooting and correlation. */ requestId?: string; /** The version of the REST protocol used to process the request. */ version?: string; /** The user-defined properties associated with the filesystem. A comma-separated list of name and value pairs in the format "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. */ properties?: string; /** A bool string indicates whether the namespace feature is enabled. If "true", the namespace is enabled for the filesystem. */ namespaceEnabled?: string; } /** Defines headers for FileSystem_getProperties operation. */ export interface FileSystemGetPropertiesExceptionHeaders { errorCode?: string; } /** Defines headers for FileSystem_delete operation. */ export interface FileSystemDeleteHeaders { /** A server-generated UUID recorded in the analytics logs for troubleshooting and correlation. */ requestId?: string; /** The version of the REST protocol used to process the request. */ version?: string; /** A UTC date/time value generated by the service that indicates the time at which the response was initiated. */ date?: Date; } /** Defines headers for FileSystem_delete operation. */ export interface FileSystemDeleteExceptionHeaders { errorCode?: string; } /** Defines headers for FileSystem_listPaths operation. */ export interface FileSystemListPathsHeaders { /** A UTC date/time value generated by the service that indicates the time at which the response was initiated. */ date?: Date; /** An HTTP entity tag associated with the filesystem. Changes to filesystem properties affect the entity tag, but operations on files and directories do not. */ etag?: string; /** The data and time the filesystem was last modified. Changes to filesystem properties update the last modified time, but operations on files and directories do not. */ lastModified?: Date; /** A server-generated UUID recorded in the analytics logs for troubleshooting and correlation. */ requestId?: string; /** The version of the REST protocol used to process the request. */ version?: string; /** If the number of paths to be listed exceeds the maxResults 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 list operation to continue listing the paths. */ continuation?: string; /** Error Code */ errorCode?: string; } /** Defines headers for FileSystem_listPaths operation. */ export interface FileSystemListPathsExceptionHeaders { errorCode?: string; } /** Defines headers for FileSystem_listBlobHierarchySegment operation. */ export interface FileSystemListBlobHierarchySegmentHeaders { /** The media type of the body of the response. For List Blobs this is 'application/xml' */ contentType?: string; /** If a client request id header is sent in the request, this header will be present in the response with the same value. */ clientRequestId?: string; /** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */ requestId?: string; /** Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. */ version?: string; /** UTC date/time value generated by the service that indicates the time at which the response was initiated */ date?: Date; /** Error Code */ errorCode?: string; } /** Defines headers for FileSystem_listBlobHierarchySegment operation. */ export interface FileSystemListBlobHierarchySegmentExceptionHeaders { errorCode?: string; } /** Defines headers for Path_create operation. */ export interface PathCreateHeaders { /** A UTC date/time value generated by the service that indicates the time at which the response was initiated. */ date?: Date; /** An HTTP entity tag associated with the file or directory. */ etag?: string; /** The data and time the file or directory was last modified. Write operations on the file or directory update the last modified time. */ lastModified?: Date; /** A server-generated UUID recorded in the analytics logs for troubleshooting and correlation. */ requestId?: string; /** The version of the REST protocol used to process the request. */ version?: 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. */ continuation?: string; /** The size of the resource in bytes. */ contentLength?: number; /** The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise. */ isServerEncrypted?: boolean; /** The SHA-256 hash of the encryption key used to encrypt the blob. This header is only returned when the blob was encrypted with a customer-provided key. */ encryptionKeySha256?: string; /** Error Code */ errorCode?: string; } /** Defines headers for Path_create operation. */ export interface PathCreateExceptionHeaders { errorCode?: string; } /** Defines headers for Path_update operation. */ export interface PathUpdateHeaders { /** A UTC date/time value generated by the service that indicates the time at which the response was initiated. */ date?: Date; /** An HTTP entity tag associated with the file or directory. */ etag?: string; /** The data and time the file or directory was last modified. Write operations on the file or directory update the last modified time. */ lastModified?: Date; /** Indicates that the service supports requests for partial file content. */ acceptRanges?: string; /** If the Cache-Control request header has previously been set for the resource, that value is returned in this header. */ cacheControl?: string; /** If the Content-Disposition request header has previously been set for the resource, that value is returned in this header. */ contentDisposition?: string; /** If the Content-Encoding request header has previously been set for the resource, that value is returned in this header. */ contentEncoding?: string; /** If the Content-Language request header has previously been set for the resource, that value is returned in this header. */ contentLanguage?: string; /** The size of the resource in bytes. */ contentLength?: number; /** Indicates the range of bytes returned in the event that the client requested a subset of the file by setting the Range request header. */ contentRange?: string; /** The content type specified for the resource. If no content type was specified, the default content type is application/octet-stream. */ contentType?: string; /** An MD5 hash of the request content. This header is only returned for "Flush" operation. This header is returned so that the client can check for message content integrity. This header refers to the content of the request, not actual file content. */ contentMD5?: string; /** User-defined properties associated 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 a base64 encoded string. Note that the string may only contain ASCII characters in the ISO-8859-1 character set. */ properties?: string; /** When performing setAccessControlRecursive on a directory, the number of paths that are processed with each invocation is limited. If the number of paths to be processed 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 setAccessControlRecursive operation to continue the setAccessControlRecursive operation on the directory. */ xMsContinuation?: string; /** A server-generated UUID recorded in the analytics logs for troubleshooting and correlation. */ requestId?: string; /** The version of the REST protocol used to process the request. */ version?: string; /** Error Code */ errorCode?: string; } /** Defines headers for Path_update operation. */ export interface PathUpdateExceptionHeaders { errorCode?: string; } /** Defines headers for Path_lease operation. */ export interface PathLeaseHeaders { /** A UTC date/time value generated by the service that indicates the time at which the response was initiated. */ date?: Date; /** An HTTP entity tag associated with the file. */ etag?: string; /** The data and time the file was last modified. Write operations on the file update the last modified time. */ lastModified?: Date; /** A server-generated UUID recorded in the analytics logs for troubleshooting and correlation. */ requestId?: string; /** The version of the REST protocol used to process the request. */ version?: string; /** A successful "renew" action returns the lease ID. */ leaseId?: string; } /** Defines headers for Path_lease operation. */ export interface PathLeaseExceptionHeaders { errorCode?: string; } /** Defines headers for Path_read operation. */ export interface PathReadHeaders { /** Indicates that the service supports requests for partial file content. */ acceptRanges?: string; /** If the Cache-Control request header has previously been set for the resource, that value is returned in this header. */ cacheControl?: string; /** If the Content-Disposition request header has previously been set for the resource, that value is returned in this header. */ contentDisposition?: string; /** If the Content-Encoding request header has previously been set for the resource, that value is returned in this header. */ contentEncoding?: string; /** If the Content-Language request header has previously been set for the resource, that value is returned in this header. */ contentLanguage?: string; /** The size of the resource in bytes. */ contentLength?: number; /** Indicates the range of bytes returned in the event that the client requested a subset of the file by setting the Range request header. */ contentRange?: string; /** The content type specified for the resource. If no content type was specified, the default content type is application/octet-stream. */ contentType?: string; /** The MD5 hash of complete file. If the file has an MD5 hash and this read operation is to read the complete file, this response header is returned so that the client can check for message content integrity. */ contentMD5?: string; /** A UTC date/time value generated by the service that indicates the time at which the response was initiated. */ date?: Date; /** An HTTP entity tag associated with the file or directory. */ etag?: string; /** The data and time the file or directory was last modified. Write operations on the file or directory update the last modified time. */ lastModified?: Date; /** A server-generated UUID recorded in the analytics logs for troubleshooting and correlation. */ requestId?: string; /** The version of the REST protocol used to process the request. */ version?: string; /** The type of the resource. The value may be "file" or "directory". If not set, the value is "file". */ resourceType?: string; /** The user-defined properties associated 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 a base64 encoded string. Note that the string may only contain ASCII characters in the ISO-8859-1 character set. */ properties?: string; /** When a resource is leased, specifies whether the lease is of infinite or fixed duration. */ leaseDuration?: string; /** Lease state of the resource. */ leaseState?: string; /** The lease status of the resource. */ leaseStatus?: string; /** The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise. */ isServerEncrypted?: boolean; /** The SHA-256 hash of the encryption key used to encrypt the blob. This header is only returned when the blob was encrypted with a customer-provided key. */ encryptionKeySha256?: string; } /** Defines headers for Path_read operation. */ export interface PathReadExceptionHeaders { errorCode?: string; } /** Defines headers for Path_getProperties operation. */ export interface PathGetPropertiesHeaders { /** Indicates that the service supports requests for partial file content. */ acceptRanges?: string; /** If the Cache-Control request header has previously been set for the resource, that value is returned in this header. */ cacheControl?: string; /** If the Content-Disposition request header has previously been set for the resource, that value is returned in this header. */ contentDisposition?: string; /** If the Content-Encoding request header has previously been set for the resource, that value is returned in this header. */ contentEncoding?: string; /** If the Content-Language request header has previously been set for the resource, that value is returned in this header. */ contentLanguage?: string; /** The size of the resource in bytes. */ contentLength?: number; /** Indicates the range of bytes returned in the event that the client requested a subset of the file by setting the Range request header. */ contentRange?: string; /** The content type specified for the resource. If no content type was specified, the default content type is application/octet-stream. */ contentType?: string; /** The MD5 hash of complete file stored in storage. This header is returned only for "GetProperties" operation. If the Content-MD5 header has been set for the file, this response header is returned for GetProperties call so that the client can check for message content integrity. */ contentMD5?: string; /** A UTC date/time value generated by the service that indicates the time at which the response was initiated. */ date?: Date; /** An HTTP entity tag associated with the file or directory. */ etag?: string; /** The data and time the file or directory was last modified. Write operations on the file or directory update the last modified time. */ lastModified?: Date; /** A server-generated UUID recorded in the analytics logs for troubleshooting and correlation. */ requestId?: string; /** The version of the REST protocol used to process the request. */ version?: string; /** The type of the resource. The value may be "file" or "directory". If not set, the value is "file". */ resourceType?: string; /** The user-defined properties associated 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 a base64 encoded string. Note that the string may only contain ASCII characters in the ISO-8859-1 character set. */ properties?: string; /** The owner of the file or directory. Included in the response if Hierarchical Namespace is enabled for the account. */ owner?: string; /** The owning group of the file or directory. Included in the response if Hierarchical Namespace is enabled for the account. */ group?: string; /** The POSIX access permissions for the file owner, the file owning group, and others. Included in the response if Hierarchical Namespace is enabled for the account. */ permissions?: string; /** The POSIX access control list for the file or directory. Included in the response only if the action is "getAccessControl" and Hierarchical Namespace is enabled for the account. */ acl?: string; /** When a resource is leased, specifies whether the lease is of infinite or fixed duration. */ leaseDuration?: string; /** Lease state of the resource. */ leaseState?: string; /** The lease status of the resource. */ leaseStatus?: string; /** Error Code */ errorCode?: string; } /** Defines headers for Path_getProperties operation. */ export interface PathGetPropertiesExceptionHeaders { errorCode?: string; } /** Defines headers for Path_delete operation. */ export interface PathDeleteHeaders { /** A UTC date/time value generated by the service that indicates the time at which the response was initiated. */ date?: Date; /** A server-generated UUID recorded in the analytics logs for troubleshooting and correlation. */ requestId?: string; /** The version of the REST protocol used to process the request. */ version?: string; /** 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. */ continuation?: string; /** Returned only for hierarchical namespace space enabled accounts when soft delete is enabled. A unique identifier for the entity that can be used to restore it. See the Undelete REST API for more information. */ deletionId?: string; /** Error Code */ errorCode?: string; } /** Defines headers for Path_delete operation. */ export interface PathDeleteExceptionHeaders { errorCode?: string; } /** Defines headers for Path_setAccessControl operation. */ export interface PathSetAccessControlHeaders { /** A UTC date/time value generated by the service that indicates the time at which the response was initiated. */ date?: Date; /** An HTTP entity tag associated with the file or directory. */ etag?: string; /** The data and time the file or directory was last modified. Write operations on the file or directory update the last modified time. */ lastModified?: Date; /** If a client request id header is sent in the request, this header will be present in the response with the same value. */ clientRequestId?: string; /** A server-generated UUID recorded in the analytics logs for troubleshooting and correlation. */ requestId?: string; /** The version of the REST protocol used to process the request. */ version?: string; } /** Defines headers for Path_setAccessControl operation. */ export interface PathSetAccessControlExceptionHeaders { /** If a client request id header is sent in the request, this header will be present in the response with the same value. */ clientRequestId?: string; /** A server-generated UUID recorded in the analytics logs for troubleshooting and correlation. */ requestId?: string; /** The version of the REST protocol used to process the request. */ version?: string; } /** Defines headers for Path_setAccessControlRecursive operation. */ export interface PathSetAccessControlRecursiveHeaders { /** A UTC date/time value generated by the service that indicates the time at which the response was initiated. */ date?: Date; /** If a client request id header is sent in the request, this header will be present in the response with the same value. */ clientRequestId?: string; /** When performing setAccessControlRecursive on a directory, the number of paths that are processed with each invocation is limited. If the number of paths to be processed 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 setAccessControlRecursive operation to continue the setAccessControlRecursive operation on the directory. */ continuation?: string; /** A server-generated UUID recorded in the analytics logs for troubleshooting and correlation. */ requestId?: string; /** The version of the REST protocol used to process the request. */ version?: string; } /** Defines headers for Path_setAccessControlRecursive operation. */ export interface PathSetAccessControlRecursiveExceptionHeaders { /** If a client request id header is sent in the request, this header will be present in the response with the same value. */ clientRequestId?: string; /** A server-generated UUID recorded in the analytics logs for troubleshooting and correlation. */ requestId?: string; /** The version of the REST protocol used to process the request. */ version?: string; } /** Defines headers for Path_flushData operation. */ export interface PathFlushDataHeaders { /** A UTC date/time value generated by the service that indicates the time at which the response was initiated. */ date?: Date; /** An HTTP entity tag associated with the file or directory. */ etag?: string; /** The data and time the file or directory was last modified. Write operations on the file or directory update the last modified time. */ lastModified?: Date; /** The size of the resource in bytes. */ contentLength?: number; /** If a client request id header is sent in the request, this header will be present in the response with the same value. */ clientRequestId?: string; /** A server-generated UUID recorded in the analytics logs for troubleshooting and correlation. */ requestId?: string; /** The version of the REST protocol used to process the request. */ version?: string; /** The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise. */ isServerEncrypted?: boolean; /** The SHA-256 hash of the encryption key used to encrypt the blob. This header is only returned when the blob was encrypted with a customer-provided key. */ encryptionKeySha256?: string; /** If the lease was auto-renewed with this request */ leaseRenewed?: boolean; } /** Defines headers for Path_flushData operation. */ export interface PathFlushDataExceptionHeaders { /** If a client request id header is sent in the request, this header will be present in the response with the same value. */ clientRequestId?: string; /** A server-generated UUID recorded in the analytics logs for troubleshooting and correlation. */ requestId?: string; /** The version of the REST protocol used to process the request. */ version?: string; } /** Defines headers for Path_appendData operation. */ export interface PathAppendDataHeaders { /** A UTC date/time value generated by the service that indicates the time at which the response was initiated. */ date?: Date; /** A server-generated UUID recorded in the analytics logs for troubleshooting and correlation. */ requestId?: string; /** If a client request id header is sent in the request, this header will be present in the response with the same value. */ clientRequestId?: string; /** The version of the REST protocol used to process the request. */ version?: string; /** An HTTP entity tag associated with the file or directory. */ etag?: string; /** If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity. */ contentMD5?: Uint8Array; /** This header is returned so that the client can check for message content integrity. The value of this header is computed by the Blob service; it is not necessarily the same value specified in the request headers. */ xMsContentCrc64?: Uint8Array; /** The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise. */ isServerEncrypted?: boolean; /** The SHA-256 hash of the encryption key used to encrypt the blob. This header is only returned when the blob was encrypted with a customer-provided key. */ encryptionKeySha256?: string; /** If the lease was auto-renewed with this request */ leaseRenewed?: boolean; } /** Defines headers for Path_appendData operation. */ export interface PathAppendDataExceptionHeaders { /** If a client request id header is sent in the request, this header will be present in the response with the same value. */ clientRequestId?: string; /** A server-generated UUID recorded in the analytics logs for troubleshooting and correlation. */ requestId?: string; /** The version of the REST protocol used to process the request. */ version?: string; } /** Defines headers for Path_setExpiry operation. */ export interface PathSetExpiryHeaders { /** The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. */ etag?: string; /** Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob. */ lastModified?: Date; /** If a client request id header is sent in the request, this header will be present in the response with the same value. */ clientRequestId?: string; /** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */ requestId?: string; /** Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. */ version?: string; /** UTC date/time value generated by the service that indicates the time at which the response was initiated. */ date?: Date; /** Error Code */ errorCode?: string; } /** Defines headers for Path_setExpiry operation. */ export interface PathSetExpiryExceptionHeaders { errorCode?: string; } /** Defines headers for Path_undelete operation. */ export interface PathUndeleteHeaders { /** If a client request id header is sent in the request, this header will be present in the response with the same value. */ clientRequestId?: string; /** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */ requestId?: string; /** The type of the resource. The value may be "file" or "directory". If not set, the value is "file". */ resourceType?: string; /** Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. */ version?: string; /** UTC date/time value generated by the service that indicates the time at which the response was initiated. */ date?: Date; } /** Defines headers for Path_undelete operation. */ export interface PathUndeleteExceptionHeaders { errorCode?: string; } /** Parameter group */ export interface ModifiedAccessConditions { /** Specify this header value to operate only on a blob if it has been modified since the specified date/time. */ ifModifiedSince?: Date; /** Specify this header value to operate only on a blob if it has not been modified since the specified date/time. */ ifUnmodifiedSince?: Date; /** Specify an ETag value to operate only on blobs with a matching value. */ ifMatch?: string; /** Specify an ETag value to operate only on blobs without a matching value. */ ifNoneMatch?: string; } /** Parameter group */ export interface PathHttpHeaders { /** Optional. Sets the blob's cache control. If specified, this property is stored with the blob and returned with a read request. */ cacheControl?: string; /** Optional. Sets the blob's content encoding. If specified, this property is stored with the blob and returned with a read request. */ contentEncoding?: string; /** Optional. Set the blob's content language. If specified, this property is stored with the blob and returned with a read request. */ contentLanguage?: string; /** Optional. Sets the blob's Content-Disposition header. */ contentDisposition?: string; /** Optional. Sets the blob's content type. If specified, this property is stored with the blob and returned with a read request. */ contentType?: string; /** Specify the transactional md5 for the body, to be validated by the service. */ contentMD5?: Uint8Array; /** Specify the transactional md5 for the body, to be validated by the service. */ transactionalContentHash?: Uint8Array; } /** Parameter group */ export interface LeaseAccessConditions { /** If specified, the operation only succeeds if the resource's lease is active and matches this ID. */ leaseId?: string; } /** Parameter group */ export interface SourceModifiedAccessConditions { /** Specify an ETag value to operate only on blobs with a matching value. */ sourceIfMatch?: string; /** Specify an ETag value to operate only on blobs without a matching value. */ sourceIfNoneMatch?: string; /** Specify this header value to operate only on a blob if it has been modified since the specified date/time. */ sourceIfModifiedSince?: Date; /** Specify this header value to operate only on a blob if it has not been modified since the specified date/time. */ sourceIfUnmodifiedSince?: Date; } /** Parameter group */ export interface CpkInfo { /** Optional. Specifies the encryption key to use to encrypt the data provided in the request. If not specified, encryption is performed with the root account encryption key. For more information, see Encryption at Rest for Azure Storage Services. */ encryptionKey?: string; /** The SHA-256 hash of the provided encryption key. Must be provided if the x-ms-encryption-key header is provided. */ encryptionKeySha256?: string; /** The algorithm used to produce the encryption key hash. Currently, the only accepted value is "AES256". Must be provided if the x-ms-encryption-key header is provided. */ encryptionAlgorithm?: EncryptionAlgorithmType; } /** Known values of {@link EncryptionAlgorithmType} that the service accepts. */ export declare enum KnownEncryptionAlgorithmType { /** None */ None = "None", /** AES256 */ AES256 = "AES256" } /** * Defines values for EncryptionAlgorithmType. \ * {@link KnownEncryptionAlgorithmType} can be used interchangeably with EncryptionAlgorithmType, * this enum contains the known values that the service supports. * ### Known values supported by the service * **None** \ * **AES256** */ export type EncryptionAlgorithmType = string; /** Defines values for ListBlobsIncludeItem. */ export type ListBlobsIncludeItem = "copy" | "deleted" | "metadata" | "snapshots" | "uncommittedblobs" | "versions" | "tags"; /** Defines values for PathResourceType. */ export type PathResourceType = "directory" | "file"; /** Defines values for PathRenameMode. */ export type PathRenameMode = "legacy" | "posix"; /** Defines values for PathExpiryOptions. */ export type PathExpiryOptions = "NeverExpire" | "RelativeToCreation" | "RelativeToNow" | "Absolute"; /** Defines values for PathUpdateAction. */ export type PathUpdateAction = "append" | "flush" | "setProperties" | "setAccessControl" | "setAccessControlRecursive"; /** Defines values for PathSetAccessControlRecursiveMode. */ export type PathSetAccessControlRecursiveMode = "set" | "modify" | "remove"; /** Defines values for PathLeaseAction. */ export type PathLeaseAction = "acquire" | "break" | "change" | "renew" | "release"; /** Defines values for PathGetPropertiesAction. */ export type PathGetPropertiesAction = "getAccessControl" | "getStatus"; /** Defines values for LeaseAction. */ export type LeaseAction = "acquire" | "auto-renew" | "release" | "acquire-release"; /** Optional parameters. */ export interface ServiceListFileSystemsOptionalParams extends coreClient.OperationOptions { /** Filters results to filesystems within the specified prefix. */ prefix?: 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. */ continuation?: string; /** An optional value that specifies the maximum number of items to return. If omitted or greater than 5,000, the response will include up to 5,000 items. */ maxResults?: number; /** 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. */ requestId?: string; /** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations">Setting Timeouts for Blob Service Operations.</a> */ timeout?: number; } /** Contains response data for the listFileSystems operation. */ export type ServiceListFileSystemsResponse = ServiceListFileSystemsHeaders & FileSystemList; /** Optional parameters. */ export interface FileSystemCreateOptionalParams extends coreClient.OperationOptions { /** 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. */ requestId?: string; /** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations">Setting Timeouts for Blob Service Operations.</a> */ timeout?: number; /** 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. */ properties?: string; } /** Contains response data for the create operation. */ export type FileSystemCreateResponse = FileSystemCreateHeaders; /** Optional parameters. */ export interface FileSystemSetPropertiesOptionalParams extends coreClient.OperationOptions { /** Parameter group */ modifiedAccessConditions?: ModifiedAccessConditions; /** 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. */ requestId?: string; /** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations">Setting Timeouts for Blob Service Operations.</a> */ timeout?: number; /** 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. */ properties?: string; } /** Contains response data for the setProperties operation. */ export type FileSystemSetPropertiesResponse = FileSystemSetPropertiesHeaders; /** Optional parameters. */ export interface FileSystemGetPropertiesOptionalParams extends coreClient.OperationOptions { /** 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. */ requestId?: string; /** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations">Setting Timeouts for Blob Service Operations.</a> */ timeout?: number; } /** Contains response data for the getProperties operation. */ export type FileSystemGetPropertiesResponse = FileSystemGetPropertiesHeaders; /** Optional parameters. */ export interface FileSystemDeleteOptionalParams extends coreClient.OperationOptions { /** Parameter group */ modifiedAccessConditions?: ModifiedAccessConditions; /** 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. */ requestId?: string; /** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations">Setting Timeouts for Blob Service Operations.</a> */ timeout?: number; } /** Contains response data for the delete operation. */ export type FileSystemDeleteResponse = FileSystemDeleteHeaders; /** Optional parameters. */ export interface FileSystemListPathsOptionalParams extends coreClient.OperationOptions { /** 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. */ continuation?: string; /** An optional value that specifies the maximum number of items to return. If omitted or greater than 5,000, the response will include up to 5,000 items. */ maxResults?: number; /** 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. */ requestId?: string; /** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations">Setting Timeouts for Blob Service Operations.</a> */ timeout?: number; /** Optional. Filters results to paths within the specified directory. An error occurs if the directory does not exist. */ path?: string; /** 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. */ upn?: boolean; } /** Contains response data for the listPaths operation. */ export type FileSystemListPathsResponse = FileSystemListPathsHeaders & PathList; /** Optional parameters. */ export interface FileSystemListBlobHierarchySegmentOptionalParams extends coreClient.OperationOptions { /** Filters results to filesystems within the specified prefix. */ prefix?: string; /** An optional value that specifies the maximum number of items to return. If omitted or greater than 5,000, the response will include up to 5,000 items. */ maxResults?: number; /** 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. */ requestId?: string; /** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations">Setting Timeouts for Blob Service Operations.</a> */ timeout?: number; /** When the request includes this parameter, the operation returns a BlobPrefix element in the response body that acts as a placeholder for all blobs whose names begin with the same substring up to the appearance of the delimiter character. The delimiter may be a single character or a string. */ delimiter?: string; /** A string value that identifies the portion of the list of containers to be returned with the next listing operation. The operation returns the NextMarker value within the response body if the listing operation did not return all containers remaining to be listed with the current page. The NextMarker value can be used as the value for the marker parameter in a subsequent call to request the next page of list items. The marker value is opaque to the client. */ marker?: string; /** Include this parameter to specify one or more datasets to include in the response. */ include?: ListBlobsIncludeItem[]; } /** Contains response data for the listBlobHierarchySegment operation. */ export type FileSystemListBlobHierarchySegmentResponse = FileSystemListBlobHierarchySegmentHeaders & ListBlobsHierarchySegmentResponse; /** Optional parameters. */ export interface PathCreateOptionalParams extends coreClient.OperationOptions { /** Parameter group */ modifiedAccessConditions?: ModifiedAccessConditions; /** Parameter group */ pathHttpHeaders?: PathHttpHeaders; /** Parameter group */ leaseAccessConditions?: LeaseAccessConditions; /** Parameter group */ sourceModifiedAccessConditions?: SourceModifiedAccessConditions; /** Parameter group */ cpkInfo?: CpkInfo; /** 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. */ continuation?: string; /** Provides a client-generate