index.ts

/*
 * Copyright (c) Microsoft Corporation. All rights reserved.
 * Licensed under the MIT License. See License.txt in the project root for license information.
 *
 * Code generated by Microsoft (R) AutoRest Code Generator.
 * Changes may cause incorrect behavior and will be lost if the code is regenerated.
 */


import * as coreHttp from "@azure/core-http";

/**
 * An interface representing AclFailedEntry.
 */
export interface AclFailedEntry {
  name?: string;
  type?: string;
  errorMessage?: string;
}

/**
 * An interface representing SetAccessControlRecursiveResponse.
 */
export interface SetAccessControlRecursiveResponse {
  directoriesSuccessful?: number;
  filesSuccessful?: number;
  failureCount?: number;
  failedEntries?: AclFailedEntry[];
}

/**
 * An interface representing Path.
 */
export interface Path {
  name?: string;
  /**
   * Default value: false.
   */
  isDirectory?: boolean;
  lastModified?: Date;
  etag?: string;
  contentLength?: number;
  owner?: string;
  group?: string;
  permissions?: string;
}

/**
 * An interface representing PathList.
 */
export interface PathList {
  paths?: Path[];
}

/**
 * An interface representing FileSystem.
 */
export interface FileSystem {
  name?: string;
  lastModified?: Date;
  etag?: string;
}

/**
 * An interface representing FileSystemList.
 */
export interface FileSystemList {
  filesystems?: FileSystem[];
}

/**
 * The service error response object.
 */
export interface StorageErrorError {
  /**
   * The service error code.
   */
  code?: string;
  /**
   * The service error message.
   */
  message?: string;
}

/**
 * An interface representing StorageError.
 */
export interface StorageError {
  /**
   * The service error response object.
   */
  error?: StorageErrorError;
}

/**
 * Additional parameters for a set of operations.
 */
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;
}

/**
 * Additional parameters for a set of operations, such as: Path_create, Path_update,
 * Path_flushData, Path_appendData.
 */
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;
}

/**
 * Additional parameters for a set of operations.
 */
export interface LeaseAccessConditions {
  /**
   * If specified, the operation only succeeds if the resource's lease is active and matches this
   * ID.
   */
  leaseId?: string;
}

/**
 * Additional parameters for create operation.
 */
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;
}

/**
 * Optional Parameters.
 */
export interface ServiceListFileSystemsOptionalParams extends coreHttp.RequestOptionsBase {
  /**
   * 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>
   */
  timeoutParameter?: number;
}

/**
 * Optional Parameters.
 */
export interface FileSystemCreateOptionalParams extends coreHttp.RequestOptionsBase {
  /**
   * 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;
  /**
   * 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>
   */
  timeoutParameter?: number;
}

/**
 * Optional Parameters.
 */
export interface FileSystemSetPropertiesOptionalParams extends coreHttp.RequestOptionsBase {
  /**
   * 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;
  /**
   * 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>
   */
  timeoutParameter?: number;
  /**
   * Additional parameters for the operation
   */
  modifiedAccessConditions?: ModifiedAccessConditions;
}

/**
 * Optional Parameters.
 */
export interface FileSystemGetPropertiesOptionalParams extends coreHttp.RequestOptionsBase {
  /**
   * 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>
   */
  timeoutParameter?: number;
}

/**
 * Optional Parameters.
 */
export interface FileSystemDeleteMethodOptionalParams extends coreHttp.RequestOptionsBase {
  /**
   * 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>
   */
  timeoutParameter?: number;
  /**
   * Additional parameters for the operation
   */
  modifiedAccessConditions?: ModifiedAccessConditions;
}

/**
 * Optional Parameters.
 */
export interface FileSystemListPathsOptionalParams extends coreHttp.RequestOptionsBase {
  /**
   * 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;
  /**
   * Optional.  Filters results to paths within the specified directory. An error occurs if the
   * directory does not exist.
   */
  path?: 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;
  /**
   * 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;
  /**
   * 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>
   */
  timeoutParameter?: number;
}

/**
 * Optional Parameters.
 */
export interface PathCreateOptionalParams extends coreHttp.RequestOptionsBase {
  /**
   * Required only for Create File and Create Directory. The value must be "file" or "directory".
   * Possible values include: 'directory', 'file'
   */
  resource?: PathResourceType;
  /**
   * 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;
  /**
   * 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". Possible values include: 'legacy', 'posix'
   */
  mode?: PathRenameMode;
  /**
   * 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.
   */
  renameSource?: string;
  /**
   * A lease ID for the source path. If specified, the source path must have an active lease and
   * the lease ID must match.
   */
  sourceLeaseId?: 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.
   */
  properties?: 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.
   */
  permissions?: 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).
   */
  umask?: 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.
   */
  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>
   */
  timeoutParameter?: number;
  /**
   * Additional parameters for the operation
   */
  pathHttpHeaders?: PathHttpHeaders;
  /**
   * Additional parameters for the operation
   */
  leaseAccessConditions?: LeaseAccessConditions;
  /**
   * Additional parameters for the operation
   */
  modifiedAccessConditions?: ModifiedAccessConditions;
  /**
   * Additional parameters for the operation
   */
  sourceModifiedAccessConditions?: SourceModifiedAccessConditions;
}

/**
 * Optional Parameters.
 */
export interface PathUpdateOptionalParams extends coreHttp.RequestOptionsBase {
  /**
   * Optional. Valid for "SetAccessControlRecursive" operation. It specifies the maximum number of
   * files or directories on which the acl change will be applied. If omitted or greater than
   * 2,000, the request will process up to 2,000 items
   */
  maxRecords?: number;
  /**
   * Optional. The number of paths processed with each invocation is limited. If the number of
   * paths to be processed exceeds this limit, a continuation token is returned in the response
   * header x-ms-continuation. When a continuation token is  returned in the response, it must be
   * percent-encoded and specified in a subsequent invocation of setAcessControlRecursive
   * operation.
   */
  continuation?: string;
  /**
   * This parameter allows the caller to upload data in parallel and control the order in which it
   * is appended to the file.  It is required when uploading data to be appended to the file and
   * when flushing previously uploaded data to the file.  The value must be the position where the
   * data is to be appended.  Uploaded data is not immediately flushed, or written, to the file.
   * To flush, the previously uploaded data must be contiguous, the position parameter must be
   * specified and equal to the length of the file after all data has been written, and there must
   * not be a request entity body included with the request.
   */
  position?: number;
  /**
   * Valid only for flush operations.  If "true", uncommitted data is retained after the flush
   * operation completes; otherwise, the uncommitted data is deleted after the flush operation.
   * The default is false.  Data at offsets less than the specified position are written to the
   * file when flush succeeds, but this optional parameter allows data after the flush position to
   * be retained for a future flush operation.
   */
  retainUncommittedData?: boolean;
  /**
   * Azure Storage Events allow applications to receive notifications when files change. When Azure
   * Storage Events are enabled, a file changed event is raised. This event has a property
   * indicating whether this is the final change to distinguish the difference between an
   * intermediate flush to a file stream and the final close of a file stream. The close query
   * parameter is valid only when the action is "flush" and change notifications are enabled. If
   * the value of close is "true" and the flush operation completes successfully, the service
   * raises a file change notification with a property indicating that this is the final update
   * (the file stream has been closed). If "false" a change notification is raised indicating the
   * file has changed. The default is false. This query parameter is set to true by the Hadoop ABFS
   * driver to indicate that the file stream has been closed."
   */
  close?: boolean;
  /**
   * Required for "Append Data" and "Flush Data".  Must be 0 for "Flush Data".  Must be the length
   * of the request content in bytes for "Append Data".
   */
  contentLength?: 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;
  /**
   * Optional. The owner of the blob or directory.
   */
  owner?: string;
  /**
   * Optional. The owning group of the blob or directory.
   */
  group?: 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.
   */
  permissions?: 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]".
   */
  acl?: 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.
   */
  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>
   */
  timeoutParameter?: number;
  /**
   * Additional parameters for the operation
   */
  pathHttpHeaders?: PathHttpHeaders;
  /**
   * Additional parameters for the operation
   */
  leaseAccessConditions?: LeaseAccessConditions;
  /**
   * Additional parameters for the operation
   */
  modifiedAccessConditions?: ModifiedAccessConditions;
}

/**
 * Optional Parameters.
 */
export interface PathLeaseOptionalParams extends coreHttp.RequestOptionsBase {
  /**
   * 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.
   */
  xMsLeaseDuration?: number;
  /**
   * The lease break period duration is optional to break a lease, and  specifies the break period
   * of the lease in seconds.  The lease break  duration must be between 0 and 60 seconds.
   */
  xMsLeaseBreakPeriod?: number;
  /**
   * 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;
  /**
   * 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>
   */
  timeoutParameter?: number;
  /**
   * Additional parameters for the operation
   */
  leaseAccessConditions?: LeaseAccessConditions;
  /**
   * Additional parameters for the operation
   */
  modifiedAccessConditions?: ModifiedAccessConditions;
}

/**
 * Optional Parameters.
 */
export interface PathReadOptionalParams extends coreHttp.RequestOptionsBase {
  /**
   * The HTTP Range request header specifies one or more byte ranges of the resource to be
   * retrieved.
   */
  range?: string;
  /**
   * Optional. When this header is set to "true" and specified together with the Range header, the
   * service returns the MD5 hash for the range, as long as the range is less than or equal to 4MB
   * in size. If this header is specified without the Range header, the service returns status code
   * 400 (Bad Request). If this header is set to true when the range exceeds 4 MB in size, the
   * service returns status code 400 (Bad Request).
   */
  xMsRangeGetContentMd5?: boolean;
  /**
   * 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>
   */
  timeoutParameter?: number;
  /**
   * Additional parameters for the operation
   */
  leaseAccessConditions?: LeaseAccessConditions;
  /**
   * Additional parameters for the operation
   */
  modifiedAccessConditions?: ModifiedAccessConditions;
}

/**
 * Optional Parameters.
 */
export interface PathGetPropertiesOptionalParams extends coreHttp.RequestOptionsBase {
  /**
   * Optional. If the value is "getStatus" only the system defined properties for the path are
   * returned. If the value is "getAccessControl" the access control list is returned in the
   * response headers (Hierarchical Namespace must be enabled for the account), otherwise the
   * properties are returned. Possible values include: 'getAccessControl', 'getStatus'
   */
  action?: PathGetPropertiesAction;
  /**
   * 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;
  /**
   * 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>
   */
  timeoutParameter?: number;
  /**
   * Additional parameters for the operation
   */
  leaseAccessConditions?: LeaseAccessConditions;
  /**
   * Additional parameters for the operation
   */
  modifiedAccessConditions?: ModifiedAccessConditions;
}

/**
 * Optional Parameters.
 */
export interface PathDeleteMethodOptionalParams extends coreHttp.RequestOptionsBase {
  /**
   * Required
   */
  recursive?: boolean;
  /**
   * 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-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>
   */
  timeoutParameter?: number;
  /**
   * Additional parameters for the operation
   */
  leaseAccessConditions?: LeaseAccessConditions;
  /**
   * Additional parameters for the operation
   */
  modifiedAccessConditions?: ModifiedAccessConditions;
}

/**
 * Optional Parameters.
 */
export interface PathSetAccessControlOptionalParams extends coreHttp.RequestOptionsBase {
  /**
   * 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>
   */
  timeoutParameter?: number;
  /**
   * Optional. The owner of the blob or directory.
   */
  owner?: string;
  /**
   * Optional. The owning group of the blob or directory.
   */
  group?: 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.
   */
  permissions?: 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]".
   */
  acl?: 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.
   */
  requestId?: string;
  /**
   * Additional parameters for the operation
   */
  leaseAccessConditions?: LeaseAccessConditions;
  /**
   * Additional parameters for the operation
   */
  modifiedAccessConditions?: ModifiedAccessConditions;
}

/**
 * Optional Parameters.
 */
export interface PathSetAccessControlRecursiveOptionalParams extends coreHttp.RequestOptionsBase {
  /**
   * 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>
   */
  timeoutParameter?: number;
  /**
   * 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;
  /**
   * Optional. It specifies the maximum number of files or directories on which the acl change will
   * be applied. If omitted or greater than 2,000, the request will process up to 2,000 items
   */
  maxRecords?: number;
  /**
   * 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]".
   */
  acl?: 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.
   */
  requestId?: string;
}

/**
 * Optional Parameters.
 */
export interface PathFlushDataOptionalParams extends coreHttp.RequestOptionsBase {
  /**
   * 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>
   */
  timeoutParameter?: number;
  /**
   * This parameter allows the caller to upload data in parallel and control the order in which it
   * is appended to the file.  It is required when uploading data to be appended to the file and
   * when flushing previously uploaded data to the file.  The value must be the position where the
   * data is to be appended.  Uploaded data is not immediately flushed, or written, to the file.
   * To flush, the previously uploaded data must be contiguous, the position parameter must be
   * specified and equal to the length of the file after all data has been written, and there must
   * not be a request entity body included with the request.
   */
  position?: number;
  /**
   * Valid only for flush operations.  If "true", uncommitted data is retained after the flush
   * operation completes; otherwise, the uncommitted data is deleted after the flush operation.
   * The default is false.  Data at offsets less than the specified position are written to the
   * file when flush succeeds, but this optional parameter allows data after the flush position to
   * be retained for a future flush operation.
   */
  retainUncommittedData?: boolean;
  /**
   * Azure Storage Events allow applications to receive notifications when files change. When Azure
   * Storage Events are enabled, a file changed event is raised. This event has a property
   * indicating whether this is the final change to distinguish the difference between an
   * intermediate flush to a file stream and the final close of a file stream. The close query
   * parameter is valid only when the action is "flush" and change notifications are enabled. If
   * the value of close is "true" and the flush operation completes successfully, the service
   * raises a file change notification with a property indicating that this is the final update
   * (the file stream has been closed). If "false" a change notification is raised indicating the
   * file has changed. The default is false. This query parameter is set to true by the Hadoop ABFS
   * driver to indicate that the file stream has been closed."
   */
  close?: boolean;
  /**
   * Required for "Append Data" and "Flush Data".  Must be 0 for "Flush Data".  Must be the length
   * of the request content in bytes for "Append Data".
   */
  contentLength?: 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;
  /**
   * Additional parameters for the operation
   */
  pathHttpHeaders?: PathHttpHeaders;
  /**
   * Additional parameters for the operation
   */
  leaseAccessConditions?: LeaseAccessConditions;
  /**
   * Additional parameters for the operation
   */
  modifiedAccessConditions?: ModifiedAccessConditions;
}

/**
 * Optional Parameters.
 */
export interface PathAppendDataOptionalParams extends coreHttp.RequestOptionsBase {
  /**
   * This parameter allows the caller to upload data in parallel and control the order in which it
   * is appended to the file.  It is required when uploading data to be appended to the file and
   * when flushing previously uploaded data to the file.  The value must be the position where the
   * data is to be appended.  Uploaded data is not immediately flushed, or written, to the file.
   * To flush, the previously uploaded data must be contiguous, the position parameter must be
   * specified and equal to the length of the file after all data has been written, and there must
   * not be a request entity body included with the request.
   */
  position?: number;
  /**
   * 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>
   */
  timeoutParameter?: number;
  /**
   * Required for "Append Data" and "Flush Data".  Must be 0 for "Flush Data".  Must be the length
   * of the request content in bytes for "Append Data".
   */
  contentLength?: 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;
  /**
   * Additional parameters for the operation
   */
  pathHttpHeaders?: PathHttpHeaders;
  /**
   * Additional parameters for the operation
   */
  leaseAccessConditions?: LeaseAccessConditions;
}

/**
 * Optional Parameters.
 */
export interface PathSetExpiryOptionalParams extends coreHttp.RequestOptionsBase {
  /**
   * 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>
   */
  timeoutParameter?: 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 time to set the blob to expiry
   */
  expiresOn?: string;
}

/**
 * Defines headers for 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;
  errorCode?: string;
}

/**
 * Defines headers for 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;
  errorCode?: string;
}

/**
 * Defines headers for 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;
  errorCode?: string;
}

/**
 * Defines headers for 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;
  errorCode?: string;
}

/**
 * Defines headers for 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;
  errorCode?: string;
}

/**
 * Defines headers for 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;
  errorCode?: string;
}

/**
 * Defines headers for 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;
  errorCode?: string;
}

/**
 * Defines headers for 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 "Append" operation. This
   * header is returned so that the client can check for message content integrity. The value of
   * this header is computed by the service; it is not necessarily the same value specified in the
   * request headers.
   */
  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;
  errorCode?: string;
}

/**
 * Defines headers for 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 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;
  /**
   * A successful "acquire" action returns the lease ID.
   */
  leaseId?: string;
  /**
   * The time remaining in the lease period in seconds.
   */
  leaseTime?: string;
  errorCode?: string;
}

/**
 * Defines headers for 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 read range. If the request is to read a specified range and the
   * "x-ms-range-get-content-md5" is set to true, then the request returns an MD5 hash for the
   * range, as long as the range size is less than or equal to 4 MB.
   */
  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 MD5 hash of complete file stored in storage. If the file has a MD5 hash, and if request
   * contains range header (Range or x-ms-range), this response header is returned with the value
   * of the complete file's MD5 value. This value may or may not be equal to the value returned in
   * Content-MD5 header, with the latter calculated from the requested range.
   */
  xMsContentMd5?: string;
  errorCode?: string;
}

/**
 * Defines headers for 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;
  errorCode?: string;
}

/**
 * Defines headers for 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;
  errorCode?: string;
}

/**
 * Defines headers for 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 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 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;
}

/**
 * Defines headers for 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;
}

/**
 * Defines headers for 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;
  errorCode?: string;
}

/**
 * Defines values for PathSetAccessControlRecursiveMode.
 * Possible values include: 'set', 'modify', 'remove'
 * @readonly
 * @enum {string}
 */
export enum PathSetAccessControlRecursiveMode {
  Set = 'set',
  Modify = 'modify',
  Remove = 'remove',
}

/**
 * Defines values for PathExpiryOptions.
 * Possible values include: 'NeverExpire', 'RelativeToCreation', 'RelativeToNow', 'Absolute'
 * @readonly
 * @enum {string}
 */
export enum PathExpiryOptions {
  NeverExpire = 'NeverExpire',
  RelativeToCreation = 'RelativeToCreation',
  RelativeToNow = 'RelativeToNow',
  Absolute = 'Absolute',
}

/**
 * Defines values for PathResourceType.
 * Possible values include: 'directory', 'file'
 * @readonly
 * @enum {string}
 */
export enum PathResourceType {
  Directory = 'directory',
  File = 'file',
}

/**
 * Defines values for PathRenameMode.
 * Possible values include: 'legacy', 'posix'
 * @readonly
 * @enum {string}
 */
export enum PathRenameMode {
  Legacy = 'legacy',
  Posix = 'posix',
}

/**
 * Defines values for PathUpdateAction.
 * Possible values include: 'append', 'flush', 'setProperties', 'setAccessControl',
 * 'setAccessControlRecursive'
 * @readonly
 * @enum {string}
 */
export enum PathUpdateAction {
  Append = 'append',
  Flush = 'flush',
  SetProperties = 'setProperties',
  SetAccessControl = 'setAccessControl',
  SetAccessControlRecursive = 'setAccessControlRecursive',
}

/**
 * Defines values for PathLeaseAction.
 * Possible values include: 'acquire', 'break', 'change', 'renew', 'release'
 * @readonly
 * @enum {string}
 */
export enum PathLeaseAction {
  Acquire = 'acquire',
  Break = 'break',
  Change = 'change',
  Renew = 'renew',
  Release = 'release',
}

/**
 * Defines values for PathGetPropertiesAction.
 * Possible values include: 'getAccessControl', 'getStatus'
 * @readonly
 * @enum {string}
 */
export enum PathGetPropertiesAction {
  GetAccessControl = 'getAccessControl',
  GetStatus = 'getStatus',
}

/**
 * Contains response data for the listFileSystems operation.
 */
export type ServiceListFileSystemsResponse = FileSystemList & ServiceListFileSystemsHeaders & {
  /**
   * The underlying HTTP response.
   */
  _response: coreHttp.HttpResponse & {
      /**
       * The parsed HTTP response headers.
       */
      parsedHeaders: ServiceListFileSystemsHeaders;

      /**
       * The response body as text (string format)
       */
      bodyAsText: string;

      /**
       * The response body as parsed JSON or XML
       */
      parsedBody: FileSystemList;
    };
};

/**
 * Contains response data for the create operation.
 */
export type FileSystemCreateResponse = FileSystemCreateHeaders & {
  /**
   * The underlying HTTP response.
   */
  _response: coreHttp.HttpResponse & {
      /**
       * The parsed HTTP response headers.
       */
      parsedHeaders: FileSystemCreateHeaders;
    };
};

/**
 * Contains response data for the setProperties operation.
 */
export type FileSystemSetPropertiesResponse = FileSystemSetPropertiesHeaders & {
  /**
   * The underlying HTTP response.
   */
  _response: coreHttp.HttpResponse & {
      /**
       * The parsed HTTP response headers.
       */
      parsedHeaders: FileSystemSetPropertiesHeaders;
    };
};

/**
 * Contains response data for the getProperties operation.
 */
export type FileSystemGetPropertiesResponse = FileSystemGetPropertiesHeaders & {
  /**
   * The underlying HTTP response.
   */
  _response: coreHttp.HttpResponse & {
      /**
       * The parsed HTTP response headers.
       */
      parsedHeaders: FileSystemGetPropertiesHeaders;
    };
};

/**
 * Contains response data for the deleteMethod operation.
 */
export type FileSystemDeleteResponse = FileSystemDeleteHeaders & {
  /**
   * The underlying HTTP response.
   */
  _response: coreHttp.HttpResponse & {
      /**
       * The parsed HTTP response headers.
       */
      parsedHeaders: FileSystemDeleteHeaders;
    };
};

/**
 * Contains response data for the listPaths operation.
 */
export type FileSystemListPathsResponse = PathList & FileSystemListPathsHeaders & {
  /**
   * The underlying HTTP response.
   */
  _response: coreHttp.HttpResponse & {
      /**
       * The parsed HTTP response headers.
       */
      parsedHeaders: FileSystemListPathsHeaders;

      /**
       * The response body as text (string format)
       */
      bodyAsText: string;

      /**
       * The response body as parsed JSON or XML
       */
      parsedBody: PathList;
    };
};

/**
 * Contains response data for the create operation.
 */
export type PathCreateResponse = PathCreateHeaders & {
  /**
   * The underlying HTTP response.
   */
  _response: coreHttp.HttpResponse & {
      /**
       * The parsed HTTP response headers.
       */
      parsedHeaders: PathCreateHeaders;
    };
};

/**
 * Contains response data for the update operation.
 */
export type PathUpdateResponse = SetAccessControlRecursiveResponse & PathUpdateHeaders & {
  /**
   * The underlying HTTP response.
   */
  _response: coreHttp.HttpResponse & {
      /**
       * The parsed HTTP response headers.
       */
      parsedHeaders: PathUpdateHeaders;

      /**
       * The response body as text (string format)
       */
      bodyAsText: string;

      /**
       * The response body as parsed JSON or XML
       */
      parsedBody: SetAccessControlRecursiveResponse;
    };
};

/**
 * Contains response data for the lease operation.
 */
export type PathLeaseResponse = PathLeaseHeaders & {
  /**
   * The underlying HTTP response.
   */
  _response: coreHttp.HttpResponse & {
      /**
       * The parsed HTTP response headers.
       */
      parsedHeaders: PathLeaseHeaders;
    };
};

/**
 * Contains response data for the read operation.
 */
export type PathReadResponse = PathReadHeaders & {
  /**
   * BROWSER ONLY
   *
   * The response body as a browser Blob.
   * Always undefined in node.js.
   */
  blobBody?: Promise<Blob>;

  /**
   * NODEJS ONLY
   *
   * The response body as a node.js Readable stream.
   * Always undefined in the browser.
   */
  readableStreamBody?: NodeJS.ReadableStream;

  /**
   * The underlying HTTP response.
   */
  _response: coreHttp.HttpResponse & {
      /**
       * The parsed HTTP response headers.
       */
      parsedHeaders: PathReadHeaders;
    };
};

/**
 * Contains response data for the getProperties operation.
 */
export type PathGetPropertiesResponse = PathGetPropertiesHeaders & {
  /**
   * The underlying HTTP response.
   */
  _response: coreHttp.HttpResponse & {
      /**
       * The parsed HTTP response headers.
       */
      parsedHeaders: PathGetPropertiesHeaders;
    };
};

/**
 * Contains response data for the deleteMethod operation.
 */
export type PathDeleteResponse = PathDeleteHeaders & {
  /**
   * The underlying HTTP response.
   */
  _response: coreHttp.HttpResponse & {
      /**
       * The parsed HTTP response headers.
       */
      parsedHeaders: PathDeleteHeaders;
    };
};

/**
 * Contains response data for the setAccessControl operation.
 */
export type PathSetAccessControlResponse = PathSetAccessControlHeaders & {
  /**
   * The underlying HTTP response.
   */
  _response: coreHttp.HttpResponse & {
      /**
       * The parsed HTTP response headers.
       */
      parsedHeaders: PathSetAccessControlHeaders;
    };
};

/**
 * Contains response data for the setAccessControlRecursive operation.
 */
export type PathSetAccessControlRecursiveResponse = SetAccessControlRecursiveResponse & PathSetAccessControlRecursiveHeaders & {
  /**
   * The underlying HTTP response.
   */
  _response: coreHttp.HttpResponse & {
      /**
       * The parsed HTTP response headers.
       */
      parsedHeaders: PathSetAccessControlRecursiveHeaders;

      /**
       * The response body as text (string format)
       */
      bodyAsText: string;

      /**
       * The response body as parsed JSON or XML
       */
      parsedBody: SetAccessControlRecursiveResponse;
    };
};

/**
 * Contains response data for the flushData operation.
 */
export type PathFlushDataResponse = PathFlushDataHeaders & {
  /**
   * The underlying HTTP response.
   */
  _response: coreHttp.HttpResponse & {
      /**
       * The parsed HTTP response headers.
       */
      parsedHeaders: PathFlushDataHeaders;
    };
};

/**
 * Contains response data for the appendData operation.
 */
export type PathAppendDataResponse = PathAppendDataHeaders & {
  /**
   * The underlying HTTP response.
   */
  _response: coreHttp.HttpResponse & {
      /**
       * The parsed HTTP response headers.
       */
      parsedHeaders: PathAppendDataHeaders;
    };
};

/**
 * Contains response data for the setExpiry operation.
 */
export type PathSetExpiryResponse = PathSetExpiryHeaders & {
  /**
   * The underlying HTTP response.
   */
  _response: coreHttp.HttpResponse & {
      /**
       * The parsed HTTP response headers.
       */
      parsedHeaders: PathSetExpiryHeaders;
    };
};