@azure/storage-file-share 12.32.0 → 12.33.0-beta.1

package/dist/esm/generated/models/models.d.ts

@@ -0,0 +1,942 @@
+import { NodeReadableStream } from "../static-helpers/platform-types.js";
+import { XmlSerializedObject } from "../static-helpers/serialization/xml-helpers.js";
+/**
+ * This file contains only generated model types and their (de)serializers.
+ * Disable the following rules for internal models with '_' prefix and deserializers which require 'any' for raw JSON input.
+ */
+/**
+ * The error response.
+ *
+ * This defines the wire format only. Language SDKs wrap this in idiomatic error types.
+ */
+export interface ErrorModel {
+    /** The error code. */
+    code?: StorageErrorCode;
+    /** The error message. */
+    message?: string;
+    /** Copy source status code */
+    copySourceStatusCode?: number;
+    /** Copy source error code */
+    copySourceErrorCode?: string;
+    /** Copy source error message */
+    copySourceErrorMessage?: string;
+    errorCode?: string;
+}
+export declare function errorDeserializer(item: any): ErrorModel;
+export declare function errorXmlDeserializer(xmlString: string): ErrorModel;
+/** Error codes returned by the service */
+export declare enum KnownStorageErrorCode {
+    /** AccountAlreadyExists */
+    AccountAlreadyExists = "AccountAlreadyExists",
+    /** AccountBeingCreated */
+    AccountBeingCreated = "AccountBeingCreated",
+    /** AccountIsDisabled */
+    AccountIsDisabled = "AccountIsDisabled",
+    /** AuthenticationFailed */
+    AuthenticationFailed = "AuthenticationFailed",
+    /** AuthorizationFailure */
+    AuthorizationFailure = "AuthorizationFailure",
+    /** ConditionHeadersNotSupported */
+    ConditionHeadersNotSupported = "ConditionHeadersNotSupported",
+    /** ConditionNotMet */
+    ConditionNotMet = "ConditionNotMet",
+    /** EmptyMetadataKey */
+    EmptyMetadataKey = "EmptyMetadataKey",
+    /** FileShareProvisionedBandwidthDowngradeNotAllowed */
+    FileShareProvisionedBandwidthDowngradeNotAllowed = "FileShareProvisionedBandwidthDowngradeNotAllowed",
+    /** FileShareProvisionedIopsDowngradeNotAllowed */
+    FileShareProvisionedIopsDowngradeNotAllowed = "FileShareProvisionedIopsDowngradeNotAllowed",
+    /** InsufficientAccountPermissions */
+    InsufficientAccountPermissions = "InsufficientAccountPermissions",
+    /** InternalError */
+    InternalError = "InternalError",
+    /** InvalidAuthenticationInfo */
+    InvalidAuthenticationInfo = "InvalidAuthenticationInfo",
+    /** InvalidHeaderValue */
+    InvalidHeaderValue = "InvalidHeaderValue",
+    /** InvalidHttpVerb */
+    InvalidHttpVerb = "InvalidHttpVerb",
+    /** InvalidInput */
+    InvalidInput = "InvalidInput",
+    /** InvalidMd5 */
+    InvalidMd5 = "InvalidMd5",
+    /** InvalidMetadata */
+    InvalidMetadata = "InvalidMetadata",
+    /** InvalidQueryParameterValue */
+    InvalidQueryParameterValue = "InvalidQueryParameterValue",
+    /** InvalidRange */
+    InvalidRange = "InvalidRange",
+    /** InvalidResourceName */
+    InvalidResourceName = "InvalidResourceName",
+    /** InvalidUri */
+    InvalidUri = "InvalidUri",
+    /** InvalidXmlDocument */
+    InvalidXmlDocument = "InvalidXmlDocument",
+    /** InvalidXmlNodeValue */
+    InvalidXmlNodeValue = "InvalidXmlNodeValue",
+    /** Md5Mismatch */
+    Md5Mismatch = "Md5Mismatch",
+    /** MetadataTooLarge */
+    MetadataTooLarge = "MetadataTooLarge",
+    /** MissingContentLengthHeader */
+    MissingContentLengthHeader = "MissingContentLengthHeader",
+    /** MissingRequiredQueryParameter */
+    MissingRequiredQueryParameter = "MissingRequiredQueryParameter",
+    /** MissingRequiredHeader */
+    MissingRequiredHeader = "MissingRequiredHeader",
+    /** MissingRequiredXmlNode */
+    MissingRequiredXmlNode = "MissingRequiredXmlNode",
+    /** MultipleConditionHeadersNotSupported */
+    MultipleConditionHeadersNotSupported = "MultipleConditionHeadersNotSupported",
+    /** OperationTimedOut */
+    OperationTimedOut = "OperationTimedOut",
+    /** OutOfRangeInput */
+    OutOfRangeInput = "OutOfRangeInput",
+    /** OutOfRangeQueryParameterValue */
+    OutOfRangeQueryParameterValue = "OutOfRangeQueryParameterValue",
+    /** RequestBodyTooLarge */
+    RequestBodyTooLarge = "RequestBodyTooLarge",
+    /** ResourceTypeMismatch */
+    ResourceTypeMismatch = "ResourceTypeMismatch",
+    /** RequestUrlFailedToParse */
+    RequestUrlFailedToParse = "RequestUrlFailedToParse",
+    /** ResourceAlreadyExists */
+    ResourceAlreadyExists = "ResourceAlreadyExists",
+    /** ResourceNotFound */
+    ResourceNotFound = "ResourceNotFound",
+    /** ServerBusy */
+    ServerBusy = "ServerBusy",
+    /** UnsupportedHeader */
+    UnsupportedHeader = "UnsupportedHeader",
+    /** UnsupportedXmlNode */
+    UnsupportedXmlNode = "UnsupportedXmlNode",
+    /** UnsupportedQueryParameter */
+    UnsupportedQueryParameter = "UnsupportedQueryParameter",
+    /** UnsupportedHttpVerb */
+    UnsupportedHttpVerb = "UnsupportedHttpVerb",
+    /** CannotDeleteFileOrDirectory */
+    CannotDeleteFileOrDirectory = "CannotDeleteFileOrDirectory",
+    /** ClientCacheFlushDelay */
+    ClientCacheFlushDelay = "ClientCacheFlushDelay",
+    /** DeletePending */
+    DeletePending = "DeletePending",
+    /** DirectoryNotEmpty */
+    DirectoryNotEmpty = "DirectoryNotEmpty",
+    /** FileLockConflict */
+    FileLockConflict = "FileLockConflict",
+    /** InvalidFileOrDirectoryPathName */
+    InvalidFileOrDirectoryPathName = "InvalidFileOrDirectoryPathName",
+    /** ParentNotFound */
+    ParentNotFound = "ParentNotFound",
+    /** ReadOnlyAttribute */
+    ReadOnlyAttribute = "ReadOnlyAttribute",
+    /** ShareAlreadyExists */
+    ShareAlreadyExists = "ShareAlreadyExists",
+    /** ShareBeingDeleted */
+    ShareBeingDeleted = "ShareBeingDeleted",
+    /** ShareDisabled */
+    ShareDisabled = "ShareDisabled",
+    /** ShareNotFound */
+    ShareNotFound = "ShareNotFound",
+    /** SharingViolation */
+    SharingViolation = "SharingViolation",
+    /** ShareSnapshotInProgress */
+    ShareSnapshotInProgress = "ShareSnapshotInProgress",
+    /** ShareSnapshotCountExceeded */
+    ShareSnapshotCountExceeded = "ShareSnapshotCountExceeded",
+    /** ShareSnapshotOperationNotSupported */
+    ShareSnapshotOperationNotSupported = "ShareSnapshotOperationNotSupported",
+    /** ShareHasSnapshots */
+    ShareHasSnapshots = "ShareHasSnapshots",
+    /** PreviousSnapshotNotFound */
+    PreviousSnapshotNotFound = "PreviousSnapshotNotFound",
+    /** ContainerQuotaDowngradeNotAllowed */
+    ContainerQuotaDowngradeNotAllowed = "ContainerQuotaDowngradeNotAllowed",
+    /** AuthorizationSourceIPMismatch */
+    AuthorizationSourceIPMismatch = "AuthorizationSourceIPMismatch",
+    /** AuthorizationProtocolMismatch */
+    AuthorizationProtocolMismatch = "AuthorizationProtocolMismatch",
+    /** AuthorizationPermissionMismatch */
+    AuthorizationPermissionMismatch = "AuthorizationPermissionMismatch",
+    /** AuthorizationServiceMismatch */
+    AuthorizationServiceMismatch = "AuthorizationServiceMismatch",
+    /** AuthorizationResourceTypeMismatch */
+    AuthorizationResourceTypeMismatch = "AuthorizationResourceTypeMismatch",
+    /** FeatureVersionMismatch */
+    FeatureVersionMismatch = "FeatureVersionMismatch",
+    /** ShareSnapshotNotFound */
+    ShareSnapshotNotFound = "ShareSnapshotNotFound",
+    /** FileShareProvisionedIopsInvalid */
+    FileShareProvisionedIopsInvalid = "FileShareProvisionedIopsInvalid",
+    /** FileShareProvisionedBandwidthInvalid */
+    FileShareProvisionedBandwidthInvalid = "FileShareProvisionedBandwidthInvalid",
+    /** FileShareProvisionedStorageInvalid */
+    FileShareProvisionedStorageInvalid = "FileShareProvisionedStorageInvalid",
+    /** TotalSharesProvisionedCapacityExceedsAccountLimit */
+    TotalSharesProvisionedCapacityExceedsAccountLimit = "TotalSharesProvisionedCapacityExceedsAccountLimit",
+    /** TotalSharesProvisionedIopsExceedsAccountLimit */
+    TotalSharesProvisionedIopsExceedsAccountLimit = "TotalSharesProvisionedIopsExceedsAccountLimit",
+    /** TotalSharesProvisionedBandwidthExceedsAccountLimit */
+    TotalSharesProvisionedBandwidthExceedsAccountLimit = "TotalSharesProvisionedBandwidthExceedsAccountLimit",
+    /** TotalSharesCountExceedsAccountLimit */
+    TotalSharesCountExceedsAccountLimit = "TotalSharesCountExceedsAccountLimit"
+}
+/**
+ * Error codes returned by the service \
+ * {@link KnownStorageErrorCode} can be used interchangeably with StorageErrorCode,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **AccountAlreadyExists**: AccountAlreadyExists \
+ * **AccountBeingCreated**: AccountBeingCreated \
+ * **AccountIsDisabled**: AccountIsDisabled \
+ * **AuthenticationFailed**: AuthenticationFailed \
+ * **AuthorizationFailure**: AuthorizationFailure \
+ * **ConditionHeadersNotSupported**: ConditionHeadersNotSupported \
+ * **ConditionNotMet**: ConditionNotMet \
+ * **EmptyMetadataKey**: EmptyMetadataKey \
+ * **FileShareProvisionedBandwidthDowngradeNotAllowed**: FileShareProvisionedBandwidthDowngradeNotAllowed \
+ * **FileShareProvisionedIopsDowngradeNotAllowed**: FileShareProvisionedIopsDowngradeNotAllowed \
+ * **InsufficientAccountPermissions**: InsufficientAccountPermissions \
+ * **InternalError**: InternalError \
+ * **InvalidAuthenticationInfo**: InvalidAuthenticationInfo \
+ * **InvalidHeaderValue**: InvalidHeaderValue \
+ * **InvalidHttpVerb**: InvalidHttpVerb \
+ * **InvalidInput**: InvalidInput \
+ * **InvalidMd5**: InvalidMd5 \
+ * **InvalidMetadata**: InvalidMetadata \
+ * **InvalidQueryParameterValue**: InvalidQueryParameterValue \
+ * **InvalidRange**: InvalidRange \
+ * **InvalidResourceName**: InvalidResourceName \
+ * **InvalidUri**: InvalidUri \
+ * **InvalidXmlDocument**: InvalidXmlDocument \
+ * **InvalidXmlNodeValue**: InvalidXmlNodeValue \
+ * **Md5Mismatch**: Md5Mismatch \
+ * **MetadataTooLarge**: MetadataTooLarge \
+ * **MissingContentLengthHeader**: MissingContentLengthHeader \
+ * **MissingRequiredQueryParameter**: MissingRequiredQueryParameter \
+ * **MissingRequiredHeader**: MissingRequiredHeader \
+ * **MissingRequiredXmlNode**: MissingRequiredXmlNode \
+ * **MultipleConditionHeadersNotSupported**: MultipleConditionHeadersNotSupported \
+ * **OperationTimedOut**: OperationTimedOut \
+ * **OutOfRangeInput**: OutOfRangeInput \
+ * **OutOfRangeQueryParameterValue**: OutOfRangeQueryParameterValue \
+ * **RequestBodyTooLarge**: RequestBodyTooLarge \
+ * **ResourceTypeMismatch**: ResourceTypeMismatch \
+ * **RequestUrlFailedToParse**: RequestUrlFailedToParse \
+ * **ResourceAlreadyExists**: ResourceAlreadyExists \
+ * **ResourceNotFound**: ResourceNotFound \
+ * **ServerBusy**: ServerBusy \
+ * **UnsupportedHeader**: UnsupportedHeader \
+ * **UnsupportedXmlNode**: UnsupportedXmlNode \
+ * **UnsupportedQueryParameter**: UnsupportedQueryParameter \
+ * **UnsupportedHttpVerb**: UnsupportedHttpVerb \
+ * **CannotDeleteFileOrDirectory**: CannotDeleteFileOrDirectory \
+ * **ClientCacheFlushDelay**: ClientCacheFlushDelay \
+ * **DeletePending**: DeletePending \
+ * **DirectoryNotEmpty**: DirectoryNotEmpty \
+ * **FileLockConflict**: FileLockConflict \
+ * **InvalidFileOrDirectoryPathName**: InvalidFileOrDirectoryPathName \
+ * **ParentNotFound**: ParentNotFound \
+ * **ReadOnlyAttribute**: ReadOnlyAttribute \
+ * **ShareAlreadyExists**: ShareAlreadyExists \
+ * **ShareBeingDeleted**: ShareBeingDeleted \
+ * **ShareDisabled**: ShareDisabled \
+ * **ShareNotFound**: ShareNotFound \
+ * **SharingViolation**: SharingViolation \
+ * **ShareSnapshotInProgress**: ShareSnapshotInProgress \
+ * **ShareSnapshotCountExceeded**: ShareSnapshotCountExceeded \
+ * **ShareSnapshotOperationNotSupported**: ShareSnapshotOperationNotSupported \
+ * **ShareHasSnapshots**: ShareHasSnapshots \
+ * **PreviousSnapshotNotFound**: PreviousSnapshotNotFound \
+ * **ContainerQuotaDowngradeNotAllowed**: ContainerQuotaDowngradeNotAllowed \
+ * **AuthorizationSourceIPMismatch**: AuthorizationSourceIPMismatch \
+ * **AuthorizationProtocolMismatch**: AuthorizationProtocolMismatch \
+ * **AuthorizationPermissionMismatch**: AuthorizationPermissionMismatch \
+ * **AuthorizationServiceMismatch**: AuthorizationServiceMismatch \
+ * **AuthorizationResourceTypeMismatch**: AuthorizationResourceTypeMismatch \
+ * **FeatureVersionMismatch**: FeatureVersionMismatch \
+ * **ShareSnapshotNotFound**: ShareSnapshotNotFound \
+ * **FileShareProvisionedIopsInvalid**: FileShareProvisionedIopsInvalid \
+ * **FileShareProvisionedBandwidthInvalid**: FileShareProvisionedBandwidthInvalid \
+ * **FileShareProvisionedStorageInvalid**: FileShareProvisionedStorageInvalid \
+ * **TotalSharesProvisionedCapacityExceedsAccountLimit**: TotalSharesProvisionedCapacityExceedsAccountLimit \
+ * **TotalSharesProvisionedIopsExceedsAccountLimit**: TotalSharesProvisionedIopsExceedsAccountLimit \
+ * **TotalSharesProvisionedBandwidthExceedsAccountLimit**: TotalSharesProvisionedBandwidthExceedsAccountLimit \
+ * **TotalSharesCountExceedsAccountLimit**: TotalSharesCountExceedsAccountLimit
+ */
+export type StorageErrorCode = string;
+/** An enumeration of directories and files. */
+export interface ListFilesAndDirectoriesSegmentResponse {
+    /** The service endpoint. */
+    serviceEndpoint: string;
+    /** The share name. */
+    shareName: string;
+    /** The share snapshot. */
+    shareSnapshot?: string;
+    /** Whether the listing is encoded. */
+    encoded?: boolean;
+    /** The directory path. */
+    directoryPath: string;
+    /** The prefix. */
+    prefix: StringEncoded;
+    /** The marker. */
+    marker?: string;
+    /** The max results. */
+    maxResults?: number;
+    /** Abstract for entries that can be listed from Directory. */
+    segment: FilesAndDirectoriesListSegment;
+    /** The next marker. */
+    continuationToken: string;
+    /** The directory ID. */
+    directoryId?: string;
+}
+export declare function listFilesAndDirectoriesSegmentResponseDeserializer(item: any): ListFilesAndDirectoriesSegmentResponse;
+export declare function listFilesAndDirectoriesSegmentResponseXmlDeserializer(xmlString: string): ListFilesAndDirectoriesSegmentResponse;
+/** An encoded string value. */
+export interface StringEncoded {
+    /** Whether the value is encoded. */
+    encoded?: boolean;
+    /** The string content. */
+    content?: string;
+}
+export declare function stringEncodedDeserializer(item: any): StringEncoded;
+export declare function stringEncodedXmlDeserializer(xmlString: string): StringEncoded;
+export declare function stringEncodedXmlObjectDeserializer(xmlObject: Record<string, unknown>): StringEncoded;
+/** Abstract for entries that can be listed from Directory. */
+export interface FilesAndDirectoriesListSegment {
+    /** The directory items. */
+    directoryItems: DirectoryItem[];
+    /** The file items. */
+    fileItems: FileItem[];
+}
+export declare function filesAndDirectoriesListSegmentDeserializer(item: any): FilesAndDirectoriesListSegment;
+export declare function filesAndDirectoriesListSegmentXmlDeserializer(xmlString: string): FilesAndDirectoriesListSegment;
+export declare function filesAndDirectoriesListSegmentXmlObjectDeserializer(xmlObject: Record<string, unknown>): FilesAndDirectoriesListSegment;
+export declare function directoryItemArrayDeserializer(result: Array<DirectoryItem>): any[];
+/** A listed directory item. */
+export interface DirectoryItem {
+    /** The directory name. */
+    name: StringEncoded;
+    /** The file ID. */
+    fileId?: string;
+    /** File properties. */
+    properties?: FileProperty;
+    /** The file attributes. */
+    attributes?: string;
+    /** The permission key. */
+    permissionKey?: string;
+}
+export declare function directoryItemDeserializer(item: any): DirectoryItem;
+export declare function directoryItemXmlDeserializer(xmlString: string): DirectoryItem;
+export declare function directoryItemXmlObjectDeserializer(xmlObject: Record<string, unknown>): DirectoryItem;
+/** File properties. */
+export interface FileProperty {
+    /**
+     * Content length of the file. This value may not be up-to-date since an SMB
+     * client may have modified the file locally. The value of Content-Length may not
+     * reflect that fact until the handle is closed or the op-lock is broken. To
+     * retrieve current property values, call Get File Properties.
+     */
+    contentLength: number;
+    /** The creation time. */
+    creationTime?: Date;
+    /** The last access time. */
+    lastAccessTime?: Date;
+    /** The last write time. */
+    lastWriteTime?: Date;
+    /** The change time. */
+    changeTime?: Date;
+    /** The last modified time. */
+    lastModified?: Date;
+    /** The ETag of the file. */
+    etag?: string;
+}
+export declare function filePropertyDeserializer(item: any): FileProperty;
+export declare function filePropertyXmlDeserializer(xmlString: string): FileProperty;
+export declare function filePropertyXmlObjectDeserializer(xmlObject: Record<string, unknown>): FileProperty;
+export declare function fileItemArrayDeserializer(result: Array<FileItem>): any[];
+/** A listed file item. */
+export interface FileItem {
+    /** The file name. */
+    name: StringEncoded;
+    /** The file ID. */
+    fileId?: string;
+    /** File properties. */
+    properties: FileProperty;
+    /** The file attributes. */
+    attributes?: string;
+    /** The permission key. */
+    permissionKey?: string;
+}
+export declare function fileItemDeserializer(item: any): FileItem;
+export declare function fileItemXmlDeserializer(xmlString: string): FileItem;
+export declare function fileItemXmlObjectDeserializer(xmlObject: Record<string, unknown>): FileItem;
+/** An enumeration of handles. */
+export interface ListHandlesResponse {
+    /** The handle list. */
+    handleList?: HandleItem[];
+    /** The next marker. */
+    continuationToken: string;
+}
+export declare function listHandlesResponseDeserializer(item: any): ListHandlesResponse;
+export declare function listHandlesResponseXmlDeserializer(xmlString: string): ListHandlesResponse;
+export declare function handleItemArrayDeserializer(result: Array<HandleItem>): any[];
+/** A listed Azure Storage handle item. */
+export interface HandleItem {
+    /** XSMB service handle ID */
+    handleId: string;
+    /** The path. */
+    path: StringEncoded;
+    /** FileId uniquely identifies the file or directory. */
+    fileId: string;
+    /** ParentId uniquely identifies the parent directory of the object. */
+    parentId?: string;
+    /** SMB session ID in context of which the file handle was opened */
+    sessionId: string;
+    /** Client IP that opened the handle */
+    clientIp: string;
+    /** Name of the client machine where the share is being mounted */
+    clientName: string;
+    /**
+     * Time when the session that previously opened the handle has last been
+     * reconnected. (UTC)
+     */
+    openTime: Date;
+    /** Time handle was last connected to (UTC) */
+    lastReconnectTime?: Date;
+    /** The access rights. */
+    accessRightList?: AccessRight[];
+}
+export declare function handleItemDeserializer(item: any): HandleItem;
+export declare function handleItemXmlDeserializer(xmlString: string): HandleItem;
+export declare function handleItemXmlObjectDeserializer(xmlObject: Record<string, unknown>): HandleItem;
+/** Access rights of the access policy. */
+export type AccessRight = "Read" | "Write" | "Delete";
+/** The list of file ranges */
+export interface ShareFileRangeList {
+    /** The file ranges. */
+    ranges?: FileRange[];
+    /** The clear ranges. */
+    clearRanges?: ClearRange[];
+}
+export declare function shareFileRangeListDeserializer(item: any): ShareFileRangeList;
+export declare function shareFileRangeListXmlDeserializer(xmlString: string): ShareFileRangeList;
+export declare function fileRangeArrayDeserializer(result: Array<FileRange>): any[];
+/** An Azure Storage file range. */
+export interface FileRange {
+    /** Start of the range. */
+    start: number;
+    /** End of the range. */
+    end: number;
+}
+export declare function fileRangeDeserializer(item: any): FileRange;
+export declare function fileRangeXmlDeserializer(xmlString: string): FileRange;
+export declare function fileRangeXmlObjectDeserializer(xmlObject: Record<string, unknown>): FileRange;
+export declare function clearRangeArrayDeserializer(result: Array<ClearRange>): any[];
+/** A clear range. */
+export interface ClearRange {
+    /** Start of the range. */
+    start: number;
+    /** End of the range. */
+    end: number;
+}
+export declare function clearRangeDeserializer(item: any): ClearRange;
+export declare function clearRangeXmlDeserializer(xmlString: string): ClearRange;
+export declare function clearRangeXmlObjectDeserializer(xmlObject: Record<string, unknown>): ClearRange;
+/** The paginated list of file ranges */
+export interface ShareFileRangeListSegment {
+    /** The file ranges. */
+    ranges?: FileRange[];
+    /** The clear ranges. */
+    clearRanges?: ClearRange[];
+    /** The next marker. */
+    nextMarker?: string;
+}
+export declare function shareFileRangeListSegmentDeserializer(item: any): ShareFileRangeListSegment;
+export declare function shareFileRangeListSegmentXmlDeserializer(xmlString: string): ShareFileRangeListSegment;
+/** Storage service properties. */
+export interface FileServiceProperties {
+    /** A summary of request statistics grouped by API in hourly aggregates for files. */
+    hourMetrics?: Metrics;
+    /** A summary of request statistics grouped by API in minute aggregates for files. */
+    minuteMetrics?: Metrics;
+    /** Protocol settings */
+    protocol?: ShareProtocolSettings;
+    /** The set of CORS rules. */
+    cors?: CorsRule[];
+}
+export declare function fileServicePropertiesSerializer(item: FileServiceProperties): any;
+export declare function fileServicePropertiesDeserializer(item: any): FileServiceProperties;
+export declare function fileServicePropertiesXmlSerializer(item: FileServiceProperties): string;
+export declare function fileServicePropertiesXmlDeserializer(xmlString: string): FileServiceProperties;
+/** Storage Analytics metrics for file service. */
+export interface Metrics {
+    /** The version of Storage Analytics to configure. */
+    version: string;
+    /** Indicates whether metrics are enabled for the File service. */
+    enabled: boolean;
+    /**
+     * Indicates whether metrics should generate summary statistics for called API
+     * operations.
+     */
+    includeAPIs?: boolean;
+    /** The retention policy. */
+    retentionPolicy?: RetentionPolicy;
+}
+export declare function metricsSerializer(item: Metrics): any;
+export declare function metricsDeserializer(item: any): Metrics;
+export declare function metricsXmlSerializer(item: Metrics): string;
+export declare function metricsXmlDeserializer(xmlString: string): Metrics;
+export declare function metricsXmlObjectSerializer(item: Metrics): XmlSerializedObject;
+export declare function metricsXmlObjectDeserializer(xmlObject: Record<string, unknown>): Metrics;
+/** The retention policy. */
+export interface RetentionPolicy {
+    /**
+     * Indicates whether a retention policy is enabled for the File service. If false,
+     * metrics data is retained, and the user is responsible for deleting it.
+     */
+    enabled: boolean;
+    /**
+     * Indicates the number of days that metrics data should be retained. All data
+     * older than this value will be deleted. Metrics data is deleted on a best-effort
+     * basis after the retention period expires.
+     */
+    days?: number;
+}
+export declare function retentionPolicySerializer(item: RetentionPolicy): any;
+export declare function retentionPolicyDeserializer(item: any): RetentionPolicy;
+export declare function retentionPolicyXmlSerializer(item: RetentionPolicy): string;
+export declare function retentionPolicyXmlDeserializer(xmlString: string): RetentionPolicy;
+export declare function retentionPolicyXmlObjectSerializer(item: RetentionPolicy): XmlSerializedObject;
+export declare function retentionPolicyXmlObjectDeserializer(xmlObject: Record<string, unknown>): RetentionPolicy;
+/** Protocol settings */
+export interface ShareProtocolSettings {
+    /** Settings for SMB protocol. */
+    smb?: ShareSmbSettings;
+    /** Settings for NFS protocol. */
+    nfs?: ShareNfsSettings;
+}
+export declare function shareProtocolSettingsSerializer(item: ShareProtocolSettings): any;
+export declare function shareProtocolSettingsDeserializer(item: any): ShareProtocolSettings;
+export declare function shareProtocolSettingsXmlSerializer(item: ShareProtocolSettings): string;
+export declare function shareProtocolSettingsXmlDeserializer(xmlString: string): ShareProtocolSettings;
+export declare function shareProtocolSettingsXmlObjectSerializer(item: ShareProtocolSettings): XmlSerializedObject;
+export declare function shareProtocolSettingsXmlObjectDeserializer(xmlObject: Record<string, unknown>): ShareProtocolSettings;
+/** Settings for SMB protocol. */
+export interface ShareSmbSettings {
+    /** Settings for SMB Multichannel. */
+    multichannel?: SmbMultichannel;
+    /** Enable or disable encryption in transit. */
+    encryptionInTransit?: ShareSmbSettingsEncryptionInTransit;
+}
+export declare function shareSmbSettingsSerializer(item: ShareSmbSettings): any;
+export declare function shareSmbSettingsDeserializer(item: any): ShareSmbSettings;
+export declare function shareSmbSettingsXmlSerializer(item: ShareSmbSettings): string;
+export declare function shareSmbSettingsXmlDeserializer(xmlString: string): ShareSmbSettings;
+export declare function shareSmbSettingsXmlObjectSerializer(item: ShareSmbSettings): XmlSerializedObject;
+export declare function shareSmbSettingsXmlObjectDeserializer(xmlObject: Record<string, unknown>): ShareSmbSettings;
+/** Settings for SMB multichannel */
+export interface SmbMultichannel {
+    /** If SMB multichannel is enabled. */
+    enabled?: boolean;
+}
+export declare function smbMultichannelSerializer(item: SmbMultichannel): any;
+export declare function smbMultichannelDeserializer(item: any): SmbMultichannel;
+export declare function smbMultichannelXmlSerializer(item: SmbMultichannel): string;
+export declare function smbMultichannelXmlDeserializer(xmlString: string): SmbMultichannel;
+export declare function smbMultichannelXmlObjectSerializer(item: SmbMultichannel): XmlSerializedObject;
+export declare function smbMultichannelXmlObjectDeserializer(xmlObject: Record<string, unknown>): SmbMultichannel;
+/** Enable or disable encryption in transit. */
+export interface ShareSmbSettingsEncryptionInTransit {
+    /** If encryption in transit is required */
+    required?: boolean;
+}
+export declare function shareSmbSettingsEncryptionInTransitSerializer(item: ShareSmbSettingsEncryptionInTransit): any;
+export declare function shareSmbSettingsEncryptionInTransitDeserializer(item: any): ShareSmbSettingsEncryptionInTransit;
+export declare function shareSmbSettingsEncryptionInTransitXmlSerializer(item: ShareSmbSettingsEncryptionInTransit): string;
+export declare function shareSmbSettingsEncryptionInTransitXmlDeserializer(xmlString: string): ShareSmbSettingsEncryptionInTransit;
+export declare function shareSmbSettingsEncryptionInTransitXmlObjectSerializer(item: ShareSmbSettingsEncryptionInTransit): XmlSerializedObject;
+export declare function shareSmbSettingsEncryptionInTransitXmlObjectDeserializer(xmlObject: Record<string, unknown>): ShareSmbSettingsEncryptionInTransit;
+/** Settings for SMB protocol. */
+export interface ShareNfsSettings {
+    /** Enable or disable encryption in transit. */
+    encryptionInTransit?: ShareNfsSettingsEncryptionInTransit;
+}
+export declare function shareNfsSettingsSerializer(item: ShareNfsSettings): any;
+export declare function shareNfsSettingsDeserializer(item: any): ShareNfsSettings;
+export declare function shareNfsSettingsXmlSerializer(item: ShareNfsSettings): string;
+export declare function shareNfsSettingsXmlDeserializer(xmlString: string): ShareNfsSettings;
+export declare function shareNfsSettingsXmlObjectSerializer(item: ShareNfsSettings): XmlSerializedObject;
+export declare function shareNfsSettingsXmlObjectDeserializer(xmlObject: Record<string, unknown>): ShareNfsSettings;
+/** Enable or disable encryption in transit. */
+export interface ShareNfsSettingsEncryptionInTransit {
+    /** If encryption in transit is required */
+    required?: boolean;
+}
+export declare function shareNfsSettingsEncryptionInTransitSerializer(item: ShareNfsSettingsEncryptionInTransit): any;
+export declare function shareNfsSettingsEncryptionInTransitDeserializer(item: any): ShareNfsSettingsEncryptionInTransit;
+export declare function shareNfsSettingsEncryptionInTransitXmlSerializer(item: ShareNfsSettingsEncryptionInTransit): string;
+export declare function shareNfsSettingsEncryptionInTransitXmlDeserializer(xmlString: string): ShareNfsSettingsEncryptionInTransit;
+export declare function shareNfsSettingsEncryptionInTransitXmlObjectSerializer(item: ShareNfsSettingsEncryptionInTransit): XmlSerializedObject;
+export declare function shareNfsSettingsEncryptionInTransitXmlObjectDeserializer(xmlObject: Record<string, unknown>): ShareNfsSettingsEncryptionInTransit;
+export declare function corsRuleArraySerializer(result: Array<CorsRule>): any[];
+export declare function corsRuleArrayDeserializer(result: Array<CorsRule>): any[];
+/**
+ * CORS is an HTTP feature that enables a web application running under one domain
+ * to access resources in another domain. Web browsers implement a security
+ * restriction known as same-origin policy that prevents a web page from calling
+ * APIs in a different domain; CORS provides a secure way to allow one domain (the
+ * origin domain) to call APIs in another domain.
+ */
+export interface CorsRule {
+    /**
+     * The origin domains that are permitted to make a request against the storage
+     * service via CORS. The origin domain is the domain from which the request
+     * originates. Note that the origin must be an exact case-sensitive match with the
+     * origin that the user age sends to the service. You can also use the wildcard
+     * character '*' to allow all origin domains to make requests via CORS.
+     */
+    allowedOrigins: string;
+    /**
+     * The methods (HTTP request verbs) that the origin domain may use for a CORS
+     * request. (comma separated)
+     */
+    allowedMethods: string;
+    /** The request headers that the origin domain may specify on the CORS request. */
+    allowedHeaders: string;
+    /**
+     * The response headers that may be sent in the response to the CORS request and
+     * exposed by the browser to the request issuer.
+     */
+    exposedHeaders: string;
+    /**
+     * The maximum amount time that a browser should cache the preflight OPTIONS
+     * request.
+     */
+    maxAgeInSeconds: number;
+}
+export declare function corsRuleSerializer(item: CorsRule): any;
+export declare function corsRuleDeserializer(item: any): CorsRule;
+export declare function corsRuleXmlSerializer(item: CorsRule): string;
+export declare function corsRuleXmlDeserializer(xmlString: string): CorsRule;
+export declare function corsRuleXmlObjectSerializer(item: CorsRule): XmlSerializedObject;
+export declare function corsRuleXmlObjectDeserializer(xmlObject: Record<string, unknown>): CorsRule;
+/** An enumeration of shares. */
+export interface ListSharesResponse {
+    /** The service endpoint. */
+    serviceEndpoint: string;
+    /** The prefix. */
+    prefix?: string;
+    /** The marker. */
+    marker?: string;
+    /** The max results. */
+    maxResults?: number;
+    /** The share items. */
+    shareItems?: ShareItemInternal[];
+    /** The next marker. */
+    continuationToken: string;
+}
+export declare function listSharesResponseDeserializer(item: any): ListSharesResponse;
+export declare function listSharesResponseXmlDeserializer(xmlString: string): ListSharesResponse;
+export declare function shareItemInternalArrayDeserializer(result: Array<ShareItemInternal>): any[];
+/** A listed Azure Storage share item. */
+export interface ShareItemInternal {
+    /** The share name. */
+    name: string;
+    /** The share snapshot. */
+    snapshot?: string;
+    /** Whether the share is deleted. */
+    deleted?: boolean;
+    /** The share version. */
+    version?: string;
+    /** Properties of a share. */
+    properties: SharePropertiesInternal;
+    /** Dictionary of <string> */
+    metadata?: Record<string, string>;
+}
+export declare function shareItemInternalDeserializer(item: any): ShareItemInternal;
+export declare function shareItemInternalXmlDeserializer(xmlString: string): ShareItemInternal;
+export declare function shareItemInternalXmlObjectDeserializer(xmlObject: Record<string, unknown>): ShareItemInternal;
+/** Properties of a share. */
+export interface SharePropertiesInternal {
+    /** The last modified time. */
+    lastModified: Date;
+    /** The ETag of the share. */
+    etag: string;
+    /** The share quota. */
+    quota: number;
+    /** The provisioned IOPS. */
+    provisionedIops?: number;
+    /** The provisioned ingress in MBps. */
+    provisionedIngressMBps?: number;
+    /** The provisioned egress in MBps. */
+    provisionedEgressMBps?: number;
+    /** The provisioned bandwidth in MiBps. */
+    provisionedBandwidthMiBps?: number;
+    /** The next allowed quota downgrade time. */
+    nextAllowedQuotaDowngradeTime?: Date;
+    /** The deleted time. */
+    deletedTime?: Date;
+    /** The remaining retention days. */
+    remainingRetentionDays?: number;
+    /** The access tier. */
+    accessTier?: string;
+    /** The access tier change time. */
+    accessTierChangeTime?: Date;
+    /** The access tier transition state. */
+    accessTierTransitionState?: string;
+    /** The current lease status of the share. */
+    leaseStatus?: LeaseStatusType;
+    /** Lease state of the share. */
+    leaseState?: LeaseStateType;
+    /**
+     * When a share is leased, specifies whether the lease is of infinite or fixed
+     * duration.
+     */
+    leaseDuration?: LeaseDurationType;
+    /** The enabled protocols. */
+    enabledProtocols?: string;
+    /** The root squash setting. */
+    rootSquash?: ShareRootSquash;
+    /** Whether snapshot virtual directory access is enabled. */
+    enableSnapshotVirtualDirectoryAccess?: boolean;
+    /** Whether paid bursting is enabled. */
+    paidBurstingEnabled?: boolean;
+    /** The maximum IOPS for paid bursting. */
+    paidBurstingMaxIops?: number;
+    /** The maximum bandwidth for paid bursting in MiBps. */
+    paidBurstingMaxBandwidthMibps?: number;
+    /** The included burst IOPS. */
+    includedBurstIops?: number;
+    /** The maximum burst credits for IOPS. */
+    maxBurstCreditsForIops?: number;
+    /** The next allowed provisioned IOPS downgrade time. */
+    nextAllowedProvisionedIopsDowngradeTime?: Date;
+    /** The next allowed provisioned bandwidth downgrade time. */
+    nextAllowedProvisionedBandwidthDowngradeTime?: Date;
+    /** Whether SMB directory lease is enabled. */
+    enableSmbDirectoryLease?: boolean;
+}
+export declare function sharePropertiesInternalDeserializer(item: any): SharePropertiesInternal;
+export declare function sharePropertiesInternalXmlDeserializer(xmlString: string): SharePropertiesInternal;
+export declare function sharePropertiesInternalXmlObjectDeserializer(xmlObject: Record<string, unknown>): SharePropertiesInternal;
+/** The current lease status of the share. */
+export type LeaseStatusType = "locked" | "unlocked";
+/** Lease state of the share. */
+export type LeaseStateType = "available" | "leased" | "expired" | "breaking" | "broken";
+/**
+ * When a share is leased, specifies whether the lease is of infinite or fixed
+ * duration.
+ */
+export type LeaseDurationType = "infinite" | "fixed";
+/** The root squash setting for the share. */
+export type ShareRootSquash = "NoRootSquash" | "RootSquash" | "AllSquash";
+/** Key information */
+export interface KeyInfo {
+    /** The date-time the key is active in ISO 8601 UTC time */
+    start?: string;
+    /** The date-time the key expires in ISO 8601 UTC time */
+    expiry: string;
+    /** The delegated user tenant id in Azure AD */
+    delegatedUserTid?: string;
+}
+export declare function keyInfoSerializer(item: KeyInfo): any;
+export declare function keyInfoXmlSerializer(item: KeyInfo): string;
+/** A user delegation key */
+export interface UserDelegationKey {
+    /** The Azure Active Directory object ID in GUID format. */
+    signedObjectId: string;
+    /** The Azure Active Directory tenant ID in GUID format */
+    signedTenantId: string;
+    /** The date-time the key is active */
+    signedStartsOn: string;
+    /** The date-time the key expires */
+    signedExpiresOn: string;
+    /** Abbreviation of the Azure Storage service that accepts the key */
+    signedService: string;
+    /** The service version that created the key */
+    signedVersion: string;
+    /**
+     * The delegated user tenant id in Azure AD. Return if DelegatedUserTid is
+     * specified.
+     */
+    signedDelegatedUserTenantId?: string;
+    /** The key as a base64 string */
+    value: string;
+}
+export declare function userDelegationKeyDeserializer(item: any): UserDelegationKey;
+export declare function userDelegationKeyXmlDeserializer(xmlString: string): UserDelegationKey;
+/** A permission (a security descriptor) at the share level. */
+export interface SharePermission {
+    /** The permission in the Security Descriptor Definition Language (SDDL). */
+    permission: string;
+    /** The permission format. */
+    format?: FilePermissionFormat;
+}
+export declare function sharePermissionSerializer(item: SharePermission): any;
+export declare function sharePermissionDeserializer(item: any): SharePermission;
+/** The file permission format. */
+export type FilePermissionFormat = "Sddl" | "Binary";
+/** Represents an array of signed identifiers */
+export interface SignedIdentifiers {
+    /** The array of signed identifiers. */
+    items: SignedIdentifier[];
+}
+export declare function signedIdentifiersSerializer(item: SignedIdentifiers): any;
+export declare function signedIdentifiersDeserializer(item: any): SignedIdentifiers;
+export declare function signedIdentifiersXmlSerializer(item: SignedIdentifiers): string;
+export declare function signedIdentifiersXmlDeserializer(xmlString: string): SignedIdentifiers;
+export declare function signedIdentifierArraySerializer(result: Array<SignedIdentifier>): any[];
+export declare function signedIdentifierArrayDeserializer(result: Array<SignedIdentifier>): any[];
+/** Signed identifier. */
+export interface SignedIdentifier {
+    /** A unique id. */
+    id: string;
+    /** The access policy. */
+    accessPolicy?: AccessPolicy;
+}
+export declare function signedIdentifierSerializer(item: SignedIdentifier): any;
+export declare function signedIdentifierDeserializer(item: any): SignedIdentifier;
+export declare function signedIdentifierXmlSerializer(item: SignedIdentifier): string;
+export declare function signedIdentifierXmlDeserializer(xmlString: string): SignedIdentifier;
+export declare function signedIdentifierXmlObjectSerializer(item: SignedIdentifier): XmlSerializedObject;
+export declare function signedIdentifierXmlObjectDeserializer(xmlObject: Record<string, unknown>): SignedIdentifier;
+/** An Access policy. */
+export interface AccessPolicy {
+    /** The date-time the policy is active. */
+    startsOn?: string;
+    /** The date-time the policy expires. */
+    expiresOn?: string;
+    /** The permissions for the ACL policy. */
+    permissions?: string;
+}
+export declare function accessPolicySerializer(item: AccessPolicy): any;
+export declare function accessPolicyDeserializer(item: any): AccessPolicy;
+export declare function accessPolicyXmlSerializer(item: AccessPolicy): string;
+export declare function accessPolicyXmlDeserializer(xmlString: string): AccessPolicy;
+export declare function accessPolicyXmlObjectSerializer(item: AccessPolicy): XmlSerializedObject;
+export declare function accessPolicyXmlObjectDeserializer(xmlObject: Record<string, unknown>): AccessPolicy;
+/** Stats for the share. */
+export interface ShareStats {
+    /**
+     * The approximate size of the data stored in bytes. Note that this value may not
+     * include all recently created or recently resized files.
+     */
+    shareUsageBytes: number;
+}
+export declare function shareStatsDeserializer(item: any): ShareStats;
+export declare function shareStatsXmlDeserializer(xmlString: string): ShareStats;
+/** The share token intent. */
+export declare enum KnownShareTokenIntent {
+    /** backup */
+    Backup = "backup"
+}
+/**
+ * The share token intent. \
+ * {@link KnownShareTokenIntent} can be used interchangeably with ShareTokenIntent,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **backup**: backup
+ */
+export type ShareTokenIntent = string;
+/** The file property semantics. */
+export declare enum KnownFilePropertySemantics {
+    /** New */
+    New = "New",
+    /** Restore */
+    Restore = "Restore"
+}
+/**
+ * The file property semantics. \
+ * {@link KnownFilePropertySemantics} can be used interchangeably with FilePropertySemantics,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **New**: New \
+ * **Restore**: Restore
+ */
+export type FilePropertySemantics = string;
+/** The NFS file type. */
+export declare enum KnownNfsFileType {
+    /** Regular */
+    Regular = "Regular",
+    /** Directory */
+    Directory = "Directory",
+    /** SymLink */
+    SymLink = "SymLink"
+}
+/**
+ * The NFS file type. \
+ * {@link KnownNfsFileType} can be used interchangeably with NfsFileType,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **Regular**: Regular \
+ * **Directory**: Directory \
+ * **SymLink**: SymLink
+ */
+export type NfsFileType = string;
+/** The type of file information to include in the listing. */
+export type ListFilesIncludeType = "Timestamps" | "Etag" | "Attributes" | "PermissionKey";
+/** The copy status. */
+export type CopyStatus = "pending" | "success" | "aborted" | "failed";
+/** Specify one of the following options: - Update: Writes the bytes specified by the request body into the specified range. - Clear: Clears the specified range and releases the space used in storage for that range. */
+export type FileRangeWriteType = "update" | "clear";
+/** The file last written mode. */
+export type FileLastWrittenMode = "Now" | "Preserve";
+/** Only update is supported: - Update: Writes the bytes downloaded from the source url into the specified range. */
+export type FileRangeWriteFromUrlType = "update";
+/** The permission copy mode type. */
+export type PermissionCopyModeType = "source" | "override";
+/** The mode copy mode. */
+export type ModeCopyMode = "source" | "override";
+/** The owner copy mode. */
+export type OwnerCopyMode = "source" | "override";
+/** The type of share information to include in the listing. */
+export type ListSharesIncludeType = "snapshots" | "metadata" | "deleted";
+/** The access tier of the share. */
+export declare enum KnownShareAccessTier {
+    /** TransactionOptimized */
+    TransactionOptimized = "TransactionOptimized",
+    /** Hot */
+    Hot = "Hot",
+    /** Cool */
+    Cool = "Cool",
+    /** Premium */
+    Premium = "Premium"
+}
+/**
+ * The access tier of the share. \
+ * {@link KnownShareAccessTier} can be used interchangeably with ShareAccessTier,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **TransactionOptimized**: TransactionOptimized \
+ * **Hot**: Hot \
+ * **Cool**: Cool \
+ * **Premium**: Premium
+ */
+export type ShareAccessTier = string;
+/** The delete snapshots option type. */
+export type DeleteSnapshotsOptionType = "include" | "include-leased";
+/** The available API versions */
+export declare enum KnownVersions {
+    /** API Version 2026-06-06 */
+    V20260606 = "2026-06-06",
+    /** API Version 2026-10-06 */
+    V20261006 = "2026-10-06"
+}
+export type FileDownloadResponse = {
+    /**
+     * 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?: NodeReadableStream;
+};
+//# sourceMappingURL=models.d.ts.map