@azure/storage-file-share 12.15.0-beta.1 → 12.20.0-alpha.20230608.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.js +5967 -6568
- package/dist/index.js.map +1 -1
- package/dist-esm/storage-blob/src/BatchResponse.js +4 -0
- package/dist-esm/storage-blob/src/BatchResponse.js.map +1 -0
- package/dist-esm/storage-blob/src/BatchResponseParser.js +137 -0
- package/dist-esm/storage-blob/src/BatchResponseParser.js.map +1 -0
- package/dist-esm/storage-blob/src/BatchUtils.browser.js +11 -0
- package/dist-esm/storage-blob/src/BatchUtils.browser.js.map +1 -0
- package/dist-esm/storage-blob/src/BatchUtils.js +15 -0
- package/dist-esm/storage-blob/src/BatchUtils.js.map +1 -0
- package/dist-esm/storage-blob/src/BlobBatch.js +267 -0
- package/dist-esm/storage-blob/src/BlobBatch.js.map +1 -0
- package/dist-esm/storage-blob/src/BlobBatchClient.js +140 -0
- package/dist-esm/storage-blob/src/BlobBatchClient.js.map +1 -0
- package/dist-esm/storage-blob/src/BlobDownloadResponse.browser.js +7 -0
- package/dist-esm/storage-blob/src/BlobDownloadResponse.browser.js.map +1 -0
- package/dist-esm/storage-blob/src/BlobDownloadResponse.js +455 -0
- package/dist-esm/storage-blob/src/BlobDownloadResponse.js.map +1 -0
- package/dist-esm/storage-blob/src/BlobLeaseClient.js +192 -0
- package/dist-esm/storage-blob/src/BlobLeaseClient.js.map +1 -0
- package/dist-esm/storage-blob/src/BlobQueryResponse.browser.js +362 -0
- package/dist-esm/storage-blob/src/BlobQueryResponse.browser.js.map +1 -0
- package/dist-esm/storage-blob/src/BlobQueryResponse.js +367 -0
- package/dist-esm/storage-blob/src/BlobQueryResponse.js.map +1 -0
- package/dist-esm/storage-blob/src/BlobServiceClient.js +702 -0
- package/dist-esm/storage-blob/src/BlobServiceClient.js.map +1 -0
- package/dist-esm/storage-blob/src/Clients.js +2527 -0
- package/dist-esm/storage-blob/src/Clients.js.map +1 -0
- package/dist-esm/storage-blob/src/ContainerClient.js +1161 -0
- package/dist-esm/storage-blob/src/ContainerClient.js.map +1 -0
- package/dist-esm/storage-blob/src/PageBlobRangeResponse.js +24 -0
- package/dist-esm/storage-blob/src/PageBlobRangeResponse.js.map +1 -0
- package/dist-esm/storage-blob/src/Pipeline.js +259 -0
- package/dist-esm/storage-blob/src/Pipeline.js.map +1 -0
- package/dist-esm/storage-blob/src/Range.js +21 -0
- package/dist-esm/storage-blob/src/Range.js.map +1 -0
- package/dist-esm/{src → storage-blob/src}/StorageBrowserPolicyFactory.js +1 -1
- package/dist-esm/storage-blob/src/StorageBrowserPolicyFactory.js.map +1 -0
- package/dist-esm/storage-blob/src/StorageClient.js +29 -0
- package/dist-esm/storage-blob/src/StorageClient.js.map +1 -0
- package/dist-esm/storage-blob/src/StorageContextClient.js +17 -0
- package/dist-esm/storage-blob/src/StorageContextClient.js.map +1 -0
- package/dist-esm/{src → storage-blob/src}/StorageRetryPolicyFactory.js +2 -1
- package/dist-esm/storage-blob/src/StorageRetryPolicyFactory.js.map +1 -0
- package/dist-esm/{src → storage-blob/src}/credentials/AnonymousCredential.js +1 -1
- package/dist-esm/storage-blob/src/credentials/AnonymousCredential.js.map +1 -0
- package/dist-esm/storage-blob/src/credentials/Credential.js.map +1 -0
- package/dist-esm/storage-blob/src/credentials/StorageSharedKeyCredential.browser.js.map +1 -0
- package/dist-esm/{src → storage-blob/src}/credentials/StorageSharedKeyCredential.js +1 -1
- package/dist-esm/storage-blob/src/credentials/StorageSharedKeyCredential.js.map +1 -0
- package/dist-esm/storage-blob/src/credentials/UserDelegationKeyCredential.browser.js +5 -0
- package/dist-esm/storage-blob/src/credentials/UserDelegationKeyCredential.browser.js.map +1 -0
- package/dist-esm/storage-blob/src/credentials/UserDelegationKeyCredential.js +31 -0
- package/dist-esm/storage-blob/src/credentials/UserDelegationKeyCredential.js.map +1 -0
- package/dist-esm/{src → storage-blob/src}/generated/src/index.js +1 -1
- package/dist-esm/storage-blob/src/generated/src/index.js.map +1 -0
- package/dist-esm/storage-blob/src/generated/src/models/index.js +256 -0
- package/dist-esm/storage-blob/src/generated/src/models/index.js.map +1 -0
- package/dist-esm/storage-blob/src/generated/src/models/mappers.js +8196 -0
- package/dist-esm/storage-blob/src/generated/src/models/mappers.js.map +1 -0
- package/dist-esm/storage-blob/src/generated/src/models/parameters.js +1610 -0
- package/dist-esm/storage-blob/src/generated/src/models/parameters.js.map +1 -0
- package/dist-esm/storage-blob/src/generated/src/operations/appendBlob.js +221 -0
- package/dist-esm/storage-blob/src/generated/src/operations/appendBlob.js.map +1 -0
- package/dist-esm/storage-blob/src/generated/src/operations/blob.js +997 -0
- package/dist-esm/storage-blob/src/generated/src/operations/blob.js.map +1 -0
- package/dist-esm/storage-blob/src/generated/src/operations/blockBlob.js +365 -0
- package/dist-esm/storage-blob/src/generated/src/operations/blockBlob.js.map +1 -0
- package/dist-esm/storage-blob/src/generated/src/operations/container.js +705 -0
- package/dist-esm/storage-blob/src/generated/src/operations/container.js.map +1 -0
- package/dist-esm/storage-blob/src/generated/src/operations/index.js +14 -0
- package/dist-esm/storage-blob/src/generated/src/operations/index.js.map +1 -0
- package/dist-esm/storage-blob/src/generated/src/operations/pageBlob.js +456 -0
- package/dist-esm/storage-blob/src/generated/src/operations/pageBlob.js.map +1 -0
- package/dist-esm/storage-blob/src/generated/src/operations/service.js +315 -0
- package/dist-esm/storage-blob/src/generated/src/operations/service.js.map +1 -0
- package/dist-esm/storage-blob/src/generated/src/operationsInterfaces/appendBlob.js +9 -0
- package/dist-esm/storage-blob/src/generated/src/operationsInterfaces/appendBlob.js.map +1 -0
- package/dist-esm/{src/generated/src/models/index.js → storage-blob/src/generated/src/operationsInterfaces/blob.js} +1 -1
- package/dist-esm/storage-blob/src/generated/src/operationsInterfaces/blob.js.map +1 -0
- package/dist-esm/storage-blob/src/generated/src/operationsInterfaces/blockBlob.js +9 -0
- package/dist-esm/storage-blob/src/generated/src/operationsInterfaces/blockBlob.js.map +1 -0
- package/dist-esm/storage-blob/src/generated/src/operationsInterfaces/container.js +9 -0
- package/dist-esm/storage-blob/src/generated/src/operationsInterfaces/container.js.map +1 -0
- package/dist-esm/storage-blob/src/generated/src/operationsInterfaces/index.js +14 -0
- package/dist-esm/storage-blob/src/generated/src/operationsInterfaces/index.js.map +1 -0
- package/dist-esm/storage-blob/src/generated/src/operationsInterfaces/pageBlob.js +9 -0
- package/dist-esm/storage-blob/src/generated/src/operationsInterfaces/pageBlob.js.map +1 -0
- package/dist-esm/storage-blob/src/generated/src/operationsInterfaces/service.js +9 -0
- package/dist-esm/storage-blob/src/generated/src/operationsInterfaces/service.js.map +1 -0
- package/dist-esm/storage-blob/src/generated/src/storageClient.js +49 -0
- package/dist-esm/storage-blob/src/generated/src/storageClient.js.map +1 -0
- package/dist-esm/storage-blob/src/generatedModels.js +4 -0
- package/dist-esm/storage-blob/src/generatedModels.js.map +1 -0
- package/dist-esm/storage-blob/src/index.browser.js +23 -0
- package/dist-esm/storage-blob/src/index.browser.js.map +1 -0
- package/dist-esm/storage-blob/src/index.js +33 -0
- package/dist-esm/storage-blob/src/index.js.map +1 -0
- package/dist-esm/storage-blob/src/log.js +8 -0
- package/dist-esm/storage-blob/src/log.js.map +1 -0
- package/dist-esm/storage-blob/src/models.js +108 -0
- package/dist-esm/storage-blob/src/models.js.map +1 -0
- package/dist-esm/storage-blob/src/policies/AnonymousCredentialPolicy.js.map +1 -0
- package/dist-esm/{src → storage-blob/src}/policies/CredentialPolicy.js +1 -1
- package/dist-esm/storage-blob/src/policies/CredentialPolicy.js.map +1 -0
- package/dist-esm/storage-blob/src/policies/RequestPolicy.js +40 -0
- package/dist-esm/storage-blob/src/policies/RequestPolicy.js.map +1 -0
- package/dist-esm/{src → storage-blob/src}/policies/StorageBrowserPolicy.js +2 -1
- package/dist-esm/{src → storage-blob/src}/policies/StorageBrowserPolicy.js.map +1 -1
- package/dist-esm/storage-blob/src/policies/StorageBrowserPolicyV2.js +31 -0
- package/dist-esm/storage-blob/src/policies/StorageBrowserPolicyV2.js.map +1 -0
- package/dist-esm/{src → storage-blob/src}/policies/StorageRetryPolicy.js +15 -6
- package/dist-esm/storage-blob/src/policies/StorageRetryPolicy.js.map +1 -0
- package/dist-esm/storage-blob/src/policies/StorageRetryPolicyV2.js +165 -0
- package/dist-esm/storage-blob/src/policies/StorageRetryPolicyV2.js.map +1 -0
- package/dist-esm/storage-blob/src/policies/StorageSharedKeyCredentialPolicy.js.map +1 -0
- package/dist-esm/storage-blob/src/policies/StorageSharedKeyCredentialPolicyV2.browser.js +18 -0
- package/dist-esm/storage-blob/src/policies/StorageSharedKeyCredentialPolicyV2.browser.js.map +1 -0
- package/dist-esm/storage-blob/src/policies/StorageSharedKeyCredentialPolicyV2.js +131 -0
- package/dist-esm/storage-blob/src/policies/StorageSharedKeyCredentialPolicyV2.js.map +1 -0
- package/dist-esm/storage-blob/src/pollers/BlobStartCopyFromUrlPoller.js +130 -0
- package/dist-esm/storage-blob/src/pollers/BlobStartCopyFromUrlPoller.js.map +1 -0
- package/dist-esm/storage-blob/src/sas/AccountSASPermissions.js +227 -0
- package/dist-esm/storage-blob/src/sas/AccountSASPermissions.js.map +1 -0
- package/dist-esm/storage-blob/src/sas/AccountSASResourceTypes.js.map +1 -0
- package/dist-esm/storage-blob/src/sas/AccountSASServices.js.map +1 -0
- package/dist-esm/storage-blob/src/sas/AccountSASSignatureValues.js +93 -0
- package/dist-esm/storage-blob/src/sas/AccountSASSignatureValues.js.map +1 -0
- package/dist-esm/storage-blob/src/sas/BlobSASPermissions.js +195 -0
- package/dist-esm/storage-blob/src/sas/BlobSASPermissions.js.map +1 -0
- package/dist-esm/storage-blob/src/sas/BlobSASSignatureValues.js +555 -0
- package/dist-esm/storage-blob/src/sas/BlobSASSignatureValues.js.map +1 -0
- package/dist-esm/storage-blob/src/sas/ContainerSASPermissions.js +221 -0
- package/dist-esm/storage-blob/src/sas/ContainerSASPermissions.js.map +1 -0
- package/dist-esm/storage-blob/src/sas/SASQueryParameters.js +234 -0
- package/dist-esm/storage-blob/src/sas/SASQueryParameters.js.map +1 -0
- package/dist-esm/storage-blob/src/sas/SasIPRange.js +13 -0
- package/dist-esm/storage-blob/src/sas/SasIPRange.js.map +1 -0
- package/dist-esm/storage-blob/src/utils/Batch.js.map +1 -0
- package/dist-esm/storage-blob/src/utils/BlobQuickQueryStream.js +111 -0
- package/dist-esm/storage-blob/src/utils/BlobQuickQueryStream.js.map +1 -0
- package/dist-esm/storage-blob/src/utils/Mutex.js +66 -0
- package/dist-esm/storage-blob/src/utils/Mutex.js.map +1 -0
- package/dist-esm/storage-blob/src/utils/RetriableReadableStream.js +119 -0
- package/dist-esm/storage-blob/src/utils/RetriableReadableStream.js.map +1 -0
- package/dist-esm/storage-blob/src/utils/cache.js +11 -0
- package/dist-esm/storage-blob/src/utils/cache.js.map +1 -0
- package/dist-esm/storage-blob/src/utils/constants.js +223 -0
- package/dist-esm/storage-blob/src/utils/constants.js.map +1 -0
- package/dist-esm/storage-blob/src/utils/tracing.js +14 -0
- package/dist-esm/storage-blob/src/utils/tracing.js.map +1 -0
- package/dist-esm/storage-blob/src/utils/utils.browser.js +48 -0
- package/dist-esm/storage-blob/src/utils/utils.browser.js.map +1 -0
- package/dist-esm/storage-blob/src/utils/utils.common.js +754 -0
- package/dist-esm/storage-blob/src/utils/utils.common.js.map +1 -0
- package/dist-esm/storage-blob/src/utils/utils.node.js +132 -0
- package/dist-esm/storage-blob/src/utils/utils.node.js.map +1 -0
- package/dist-esm/storage-file-share/src/AccountSASPermissions.js.map +1 -0
- package/dist-esm/storage-file-share/src/AccountSASResourceTypes.js +72 -0
- package/dist-esm/storage-file-share/src/AccountSASResourceTypes.js.map +1 -0
- package/dist-esm/storage-file-share/src/AccountSASServices.js +80 -0
- package/dist-esm/storage-file-share/src/AccountSASServices.js.map +1 -0
- package/dist-esm/storage-file-share/src/AccountSASSignatureValues.js.map +1 -0
- package/dist-esm/{src → storage-file-share/src}/Clients.js +476 -1253
- package/dist-esm/storage-file-share/src/Clients.js.map +1 -0
- package/dist-esm/storage-file-share/src/FileDownloadResponse.browser.js.map +1 -0
- package/dist-esm/{src → storage-file-share/src}/FileDownloadResponse.js +15 -14
- package/dist-esm/storage-file-share/src/FileDownloadResponse.js.map +1 -0
- package/dist-esm/storage-file-share/src/FileSASPermissions.js.map +1 -0
- package/dist-esm/storage-file-share/src/FileSASSignatureValues.js.map +1 -0
- package/dist-esm/storage-file-share/src/FileSystemAttributes.js.map +1 -0
- package/dist-esm/storage-file-share/src/Range.js.map +1 -0
- package/dist-esm/{src → storage-file-share/src}/SASQueryParameters.js +14 -14
- package/dist-esm/storage-file-share/src/SASQueryParameters.js.map +1 -0
- package/dist-esm/storage-file-share/src/SasIPRange.js.map +1 -0
- package/dist-esm/{src → storage-file-share/src}/ShareClientInternal.js +1 -2
- package/dist-esm/storage-file-share/src/ShareClientInternal.js.map +1 -0
- package/dist-esm/storage-file-share/src/ShareSASPermissions.js.map +1 -0
- package/dist-esm/{src → storage-file-share/src}/ShareServiceClient.js +58 -121
- package/dist-esm/storage-file-share/src/ShareServiceClient.js.map +1 -0
- package/dist-esm/{src → storage-file-share/src}/StorageClient.js +8 -14
- package/dist-esm/storage-file-share/src/StorageClient.js.map +1 -0
- package/dist-esm/storage-file-share/src/StorageContextClient.js +18 -0
- package/dist-esm/storage-file-share/src/StorageContextClient.js.map +1 -0
- package/dist-esm/storage-file-share/src/generated/src/index.js +11 -0
- package/dist-esm/storage-file-share/src/generated/src/index.js.map +1 -0
- package/dist-esm/storage-file-share/src/generated/src/models/index.js +144 -0
- package/dist-esm/storage-file-share/src/generated/src/models/index.js.map +1 -0
- package/dist-esm/{src → storage-file-share/src}/generated/src/models/mappers.js +16 -64
- package/dist-esm/storage-file-share/src/generated/src/models/mappers.js.map +1 -0
- package/dist-esm/{src → storage-file-share/src}/generated/src/models/parameters.js +17 -37
- package/dist-esm/storage-file-share/src/generated/src/models/parameters.js.map +1 -0
- package/dist-esm/{src → storage-file-share/src}/generated/src/operations/directory.js +17 -73
- package/dist-esm/storage-file-share/src/generated/src/operations/directory.js.map +1 -0
- package/dist-esm/{src → storage-file-share/src}/generated/src/operations/file.js +33 -142
- package/dist-esm/storage-file-share/src/generated/src/operations/file.js.map +1 -0
- package/dist-esm/storage-file-share/src/generated/src/operations/index.js.map +1 -0
- package/dist-esm/{src → storage-file-share/src}/generated/src/operations/service.js +7 -17
- package/dist-esm/storage-file-share/src/generated/src/operations/service.js.map +1 -0
- package/dist-esm/{src → storage-file-share/src}/generated/src/operations/share.js +26 -85
- package/dist-esm/storage-file-share/src/generated/src/operations/share.js.map +1 -0
- package/dist-esm/storage-file-share/src/generated/src/operationsInterfaces/directory.js +9 -0
- package/dist-esm/storage-file-share/src/generated/src/operationsInterfaces/directory.js.map +1 -0
- package/dist-esm/storage-file-share/src/generated/src/operationsInterfaces/file.js +9 -0
- package/dist-esm/storage-file-share/src/generated/src/operationsInterfaces/file.js.map +1 -0
- package/dist-esm/storage-file-share/src/generated/src/operationsInterfaces/index.js +12 -0
- package/dist-esm/storage-file-share/src/generated/src/operationsInterfaces/index.js.map +1 -0
- package/dist-esm/storage-file-share/src/generated/src/operationsInterfaces/service.js +9 -0
- package/dist-esm/storage-file-share/src/generated/src/operationsInterfaces/service.js.map +1 -0
- package/dist-esm/storage-file-share/src/generated/src/operationsInterfaces/share.js +9 -0
- package/dist-esm/storage-file-share/src/generated/src/operationsInterfaces/share.js.map +1 -0
- package/dist-esm/storage-file-share/src/generated/src/storageClient.js +48 -0
- package/dist-esm/storage-file-share/src/generated/src/storageClient.js.map +1 -0
- package/dist-esm/storage-file-share/src/generatedModels.js +4 -0
- package/dist-esm/storage-file-share/src/generatedModels.js.map +1 -0
- package/dist-esm/storage-file-share/src/index.browser.js +18 -0
- package/dist-esm/storage-file-share/src/index.browser.js.map +1 -0
- package/dist-esm/storage-file-share/src/index.js +28 -0
- package/dist-esm/storage-file-share/src/index.js.map +1 -0
- package/dist-esm/storage-file-share/src/log.js.map +1 -0
- package/dist-esm/storage-file-share/src/models.js.map +1 -0
- package/dist-esm/storage-file-share/src/utils/Batch.js +122 -0
- package/dist-esm/storage-file-share/src/utils/Batch.js.map +1 -0
- package/dist-esm/storage-file-share/src/utils/BufferScheduler.js.map +1 -0
- package/dist-esm/{src → storage-file-share/src}/utils/RetriableReadableStream.js +51 -48
- package/dist-esm/storage-file-share/src/utils/RetriableReadableStream.js.map +1 -0
- package/dist-esm/{src → storage-file-share/src}/utils/constants.js +2 -6
- package/dist-esm/storage-file-share/src/utils/constants.js.map +1 -0
- package/dist-esm/storage-file-share/src/utils/tracing.js +14 -0
- package/dist-esm/storage-file-share/src/utils/tracing.js.map +1 -0
- package/dist-esm/storage-file-share/src/utils/utils.browser.js.map +1 -0
- package/dist-esm/{src → storage-file-share/src}/utils/utils.common.js +77 -94
- package/dist-esm/storage-file-share/src/utils/utils.common.js.map +1 -0
- package/dist-esm/storage-file-share/src/utils/utils.node.js.map +1 -0
- package/package.json +36 -31
- package/types/3.1/storage-file-share.d.ts +1454 -532
- package/types/latest/storage-file-share.d.ts +1571 -544
- package/dist-esm/src/AccountSASPermissions.js.map +0 -1
- package/dist-esm/src/AccountSASResourceTypes.js.map +0 -1
- package/dist-esm/src/AccountSASServices.js.map +0 -1
- package/dist-esm/src/AccountSASSignatureValues.js.map +0 -1
- package/dist-esm/src/Clients.js.map +0 -1
- package/dist-esm/src/FileDownloadResponse.browser.js.map +0 -1
- package/dist-esm/src/FileDownloadResponse.js.map +0 -1
- package/dist-esm/src/FileSASPermissions.js.map +0 -1
- package/dist-esm/src/FileSASSignatureValues.js.map +0 -1
- package/dist-esm/src/FileSystemAttributes.js.map +0 -1
- package/dist-esm/src/Pipeline.js +0 -88
- package/dist-esm/src/Pipeline.js.map +0 -1
- package/dist-esm/src/Range.js.map +0 -1
- package/dist-esm/src/SASQueryParameters.js.map +0 -1
- package/dist-esm/src/SasIPRange.js.map +0 -1
- package/dist-esm/src/ShareClientInternal.js.map +0 -1
- package/dist-esm/src/ShareSASPermissions.js.map +0 -1
- package/dist-esm/src/ShareServiceClient.js.map +0 -1
- package/dist-esm/src/StorageBrowserPolicyFactory.js.map +0 -1
- package/dist-esm/src/StorageClient.js.map +0 -1
- package/dist-esm/src/StorageRetryPolicyFactory.js.map +0 -1
- package/dist-esm/src/TelemetryPolicyFactory.js +0 -50
- package/dist-esm/src/TelemetryPolicyFactory.js.map +0 -1
- package/dist-esm/src/credentials/AnonymousCredential.js.map +0 -1
- package/dist-esm/src/credentials/Credential.js.map +0 -1
- package/dist-esm/src/credentials/StorageSharedKeyCredential.browser.js.map +0 -1
- package/dist-esm/src/credentials/StorageSharedKeyCredential.js.map +0 -1
- package/dist-esm/src/generated/src/index.js.map +0 -1
- package/dist-esm/src/generated/src/models/index.js.map +0 -1
- package/dist-esm/src/generated/src/models/mappers.js.map +0 -1
- package/dist-esm/src/generated/src/models/parameters.js.map +0 -1
- package/dist-esm/src/generated/src/operations/directory.js.map +0 -1
- package/dist-esm/src/generated/src/operations/file.js.map +0 -1
- package/dist-esm/src/generated/src/operations/index.js.map +0 -1
- package/dist-esm/src/generated/src/operations/service.js.map +0 -1
- package/dist-esm/src/generated/src/operations/share.js.map +0 -1
- package/dist-esm/src/generated/src/storageClient.js +0 -25
- package/dist-esm/src/generated/src/storageClient.js.map +0 -1
- package/dist-esm/src/generated/src/storageClientContext.js +0 -40
- package/dist-esm/src/generated/src/storageClientContext.js.map +0 -1
- package/dist-esm/src/generatedModels.js +0 -8
- package/dist-esm/src/generatedModels.js.map +0 -1
- package/dist-esm/src/index.browser.js +0 -17
- package/dist-esm/src/index.browser.js.map +0 -1
- package/dist-esm/src/index.js +0 -27
- package/dist-esm/src/index.js.map +0 -1
- package/dist-esm/src/log.js.map +0 -1
- package/dist-esm/src/models.js.map +0 -1
- package/dist-esm/src/policies/AnonymousCredentialPolicy.js.map +0 -1
- package/dist-esm/src/policies/CredentialPolicy.js.map +0 -1
- package/dist-esm/src/policies/StorageRetryPolicy.js.map +0 -1
- package/dist-esm/src/policies/StorageSharedKeyCredentialPolicy.js.map +0 -1
- package/dist-esm/src/policies/TelemetryPolicy.js +0 -36
- package/dist-esm/src/policies/TelemetryPolicy.js.map +0 -1
- package/dist-esm/src/utils/Batch.js.map +0 -1
- package/dist-esm/src/utils/BufferScheduler.js.map +0 -1
- package/dist-esm/src/utils/RetriableReadableStream.js.map +0 -1
- package/dist-esm/src/utils/cache.js +0 -8
- package/dist-esm/src/utils/cache.js.map +0 -1
- package/dist-esm/src/utils/constants.js.map +0 -1
- package/dist-esm/src/utils/tracing.js +0 -27
- package/dist-esm/src/utils/tracing.js.map +0 -1
- package/dist-esm/src/utils/utils.browser.js.map +0 -1
- package/dist-esm/src/utils/utils.common.js.map +0 -1
- package/dist-esm/src/utils/utils.node.js.map +0 -1
- /package/dist-esm/{src → storage-blob/src}/credentials/Credential.js +0 -0
- /package/dist-esm/{src → storage-blob/src}/credentials/StorageSharedKeyCredential.browser.js +0 -0
- /package/dist-esm/{src → storage-blob/src}/policies/AnonymousCredentialPolicy.js +0 -0
- /package/dist-esm/{src → storage-blob/src}/policies/StorageSharedKeyCredentialPolicy.js +0 -0
- /package/dist-esm/{src → storage-blob/src/sas}/AccountSASResourceTypes.js +0 -0
- /package/dist-esm/{src → storage-blob/src/sas}/AccountSASServices.js +0 -0
- /package/dist-esm/{src → storage-blob/src}/utils/Batch.js +0 -0
- /package/dist-esm/{src → storage-file-share/src}/AccountSASPermissions.js +0 -0
- /package/dist-esm/{src → storage-file-share/src}/AccountSASSignatureValues.js +0 -0
- /package/dist-esm/{src → storage-file-share/src}/FileDownloadResponse.browser.js +0 -0
- /package/dist-esm/{src → storage-file-share/src}/FileSASPermissions.js +0 -0
- /package/dist-esm/{src → storage-file-share/src}/FileSASSignatureValues.js +0 -0
- /package/dist-esm/{src → storage-file-share/src}/FileSystemAttributes.js +0 -0
- /package/dist-esm/{src → storage-file-share/src}/Range.js +0 -0
- /package/dist-esm/{src → storage-file-share/src}/SasIPRange.js +0 -0
- /package/dist-esm/{src → storage-file-share/src}/ShareSASPermissions.js +0 -0
- /package/dist-esm/{src → storage-file-share/src}/generated/src/operations/index.js +0 -0
- /package/dist-esm/{src → storage-file-share/src}/log.js +0 -0
- /package/dist-esm/{src → storage-file-share/src}/models.js +0 -0
- /package/dist-esm/{src → storage-file-share/src}/utils/BufferScheduler.js +0 -0
- /package/dist-esm/{src → storage-file-share/src}/utils/utils.browser.js +0 -0
- /package/dist-esm/{src → storage-file-share/src}/utils/utils.node.js +0 -0
@@ -2,28 +2,26 @@
|
|
2
2
|
|
3
3
|
import { AbortSignalLike } from '@azure/abort-controller';
|
4
4
|
import { AzureLogger } from '@azure/logger';
|
5
|
-
import {
|
6
|
-
import * as
|
7
|
-
import
|
8
|
-
import
|
9
|
-
import {
|
10
|
-
import {
|
11
|
-
import {
|
12
|
-
import { HttpClient as IHttpClient } from '@azure/core-http';
|
13
|
-
import { KeepAliveOptions } from '@azure/core-http';
|
5
|
+
import { CompatResponse } from '@azure/core-http-compat';
|
6
|
+
import * as coreClient from '@azure/core-client';
|
7
|
+
import * as coreHttpCompat from '@azure/core-http-compat';
|
8
|
+
import * as coreRestPipeline from '@azure/core-rest-pipeline';
|
9
|
+
import { HttpHeadersLike } from '@azure/core-http-compat';
|
10
|
+
import { HttpPipelineLogLevel } from '@azure/core-http-compat';
|
11
|
+
import { KeepAliveOptions } from '@azure/core-http-compat';
|
14
12
|
import { OperationTracingOptions } from '@azure/core-tracing';
|
15
13
|
import { PagedAsyncIterableIterator } from '@azure/core-paging';
|
16
|
-
import {
|
14
|
+
import { ProxySettings } from '@azure/core-rest-pipeline';
|
17
15
|
import { Readable } from 'stream';
|
18
|
-
import {
|
19
|
-
import {
|
20
|
-
import {
|
21
|
-
import {
|
22
|
-
import {
|
23
|
-
import { TokenCredential } from '@azure/core-
|
24
|
-
import { TransferProgressEvent } from '@azure/core-
|
25
|
-
import {
|
26
|
-
import {
|
16
|
+
import { RequestBodyType } from '@azure/core-rest-pipeline';
|
17
|
+
import { RequestPolicy } from '@azure/core-http-compat';
|
18
|
+
import { RequestPolicyFactory } from '@azure/core-http-compat';
|
19
|
+
import { RequestPolicyOptionsLike } from '@azure/core-http-compat';
|
20
|
+
import { RestError } from '@azure/core-rest-pipeline';
|
21
|
+
import { TokenCredential } from '@azure/core-auth';
|
22
|
+
import { TransferProgressEvent } from '@azure/core-rest-pipeline';
|
23
|
+
import { UserAgentPolicyOptions } from '@azure/core-rest-pipeline';
|
24
|
+
import { WebResourceLike } from '@azure/core-http-compat';
|
27
25
|
|
28
26
|
/** An Access policy. */
|
29
27
|
export declare interface AccessPolicy {
|
@@ -229,7 +227,7 @@ export declare interface AccountSASSignatureValues {
|
|
229
227
|
|
230
228
|
/**
|
231
229
|
* AnonymousCredential provides a credentialPolicyCreator member used to create
|
232
|
-
*
|
230
|
+
* AnonymousCredentialPolicy objects. AnonymousCredentialPolicy is used with
|
233
231
|
* HTTP(S) requests that read public resources or for use with Shared Access
|
234
232
|
* Signatures (SAS).
|
235
233
|
*/
|
@@ -240,7 +238,7 @@ export declare class AnonymousCredential extends Credential_2 {
|
|
240
238
|
* @param nextPolicy -
|
241
239
|
* @param options -
|
242
240
|
*/
|
243
|
-
create(nextPolicy: RequestPolicy, options:
|
241
|
+
create(nextPolicy: RequestPolicy, options: RequestPolicyOptionsLike): AnonymousCredentialPolicy;
|
244
242
|
}
|
245
243
|
|
246
244
|
/**
|
@@ -253,10 +251,52 @@ export declare class AnonymousCredentialPolicy extends CredentialPolicy {
|
|
253
251
|
* @param nextPolicy -
|
254
252
|
* @param options -
|
255
253
|
*/
|
256
|
-
constructor(nextPolicy: RequestPolicy, options:
|
254
|
+
constructor(nextPolicy: RequestPolicy, options: RequestPolicyOptionsLike);
|
257
255
|
}
|
258
256
|
|
259
|
-
|
257
|
+
/**
|
258
|
+
* The base class from which all request policies derive.
|
259
|
+
*/
|
260
|
+
export declare abstract class BaseRequestPolicy implements RequestPolicy {
|
261
|
+
/**
|
262
|
+
* The next policy in the pipeline. Each policy is responsible for executing the next one if the request is to continue through the pipeline.
|
263
|
+
*/
|
264
|
+
readonly _nextPolicy: RequestPolicy;
|
265
|
+
/**
|
266
|
+
* The options that can be passed to a given request policy.
|
267
|
+
*/
|
268
|
+
readonly _options: RequestPolicyOptionsLike;
|
269
|
+
/**
|
270
|
+
* The main method to implement that manipulates a request/response.
|
271
|
+
*/
|
272
|
+
protected constructor(
|
273
|
+
/**
|
274
|
+
* The next policy in the pipeline. Each policy is responsible for executing the next one if the request is to continue through the pipeline.
|
275
|
+
*/
|
276
|
+
_nextPolicy: RequestPolicy,
|
277
|
+
/**
|
278
|
+
* The options that can be passed to a given request policy.
|
279
|
+
*/
|
280
|
+
_options: RequestPolicyOptionsLike);
|
281
|
+
/**
|
282
|
+
* Sends a network request based on the given web resource.
|
283
|
+
* @param webResource - A {@link WebResourceLike} that describes a HTTP request to be made.
|
284
|
+
*/
|
285
|
+
abstract sendRequest(webResource: WebResourceLike): Promise<CompatResponse>;
|
286
|
+
/**
|
287
|
+
* Get whether or not a log with the provided log level should be logged.
|
288
|
+
* @param logLevel - The log level of the log that will be logged.
|
289
|
+
* @returns Whether or not a log with the provided log level should be logged.
|
290
|
+
*/
|
291
|
+
shouldLog(logLevel: HttpPipelineLogLevel): boolean;
|
292
|
+
/**
|
293
|
+
* Attempt to log the provided message to the provided logger. If no logger was provided or if
|
294
|
+
* the log level does not meat the logger's threshold, then nothing will be logged.
|
295
|
+
* @param logLevel - The log level of this log.
|
296
|
+
* @param message - The message of this log.
|
297
|
+
*/
|
298
|
+
log(logLevel: HttpPipelineLogLevel, message: string): void;
|
299
|
+
}
|
260
300
|
|
261
301
|
export declare interface ClearRange {
|
262
302
|
start: number;
|
@@ -380,7 +420,7 @@ declare abstract class Credential_2 implements RequestPolicyFactory {
|
|
380
420
|
* @param _nextPolicy -
|
381
421
|
* @param _options -
|
382
422
|
*/
|
383
|
-
create(_nextPolicy: RequestPolicy, _options:
|
423
|
+
create(_nextPolicy: RequestPolicy, _options: RequestPolicyOptionsLike): RequestPolicy;
|
384
424
|
}
|
385
425
|
export { Credential_2 as Credential }
|
386
426
|
|
@@ -394,25 +434,89 @@ export declare abstract class CredentialPolicy extends BaseRequestPolicy {
|
|
394
434
|
*
|
395
435
|
* @param request -
|
396
436
|
*/
|
397
|
-
sendRequest(request:
|
437
|
+
sendRequest(request: WebResourceLike): Promise<CompatResponse>;
|
398
438
|
/**
|
399
439
|
* Child classes must implement this method with request signing. This method
|
400
440
|
* will be executed in {@link sendRequest}.
|
401
441
|
*
|
402
442
|
* @param request -
|
403
443
|
*/
|
404
|
-
protected signRequest(request:
|
444
|
+
protected signRequest(request: WebResourceLike): WebResourceLike;
|
405
445
|
}
|
406
446
|
|
407
447
|
/**
|
408
448
|
* A factory function that creates a new CredentialPolicy that uses the provided nextPolicy.
|
409
449
|
*/
|
410
|
-
export declare type CredentialPolicyCreator = (nextPolicy: RequestPolicy, options:
|
450
|
+
export declare type CredentialPolicyCreator = (nextPolicy: RequestPolicy, options: RequestPolicyOptionsLike) => CredentialPolicy;
|
411
451
|
|
412
452
|
/** Defines values for DeleteSnapshotsOptionType. */
|
413
453
|
export declare type DeleteSnapshotsOptionType = "include" | "include-leased";
|
414
454
|
|
415
|
-
|
455
|
+
/** Parameter group */
|
456
|
+
declare interface DestinationLeaseAccessConditions {
|
457
|
+
/** Required if the destination file has an active infinite lease. The lease ID specified for this header must match the lease ID of the destination file. If the request does not include the lease ID or it is not valid, the operation fails with status code 412 (Precondition Failed). If this header is specified and the destination file does not currently have an active lease, the operation will also fail with status code 412 (Precondition Failed). */
|
458
|
+
destinationLeaseId?: string;
|
459
|
+
}
|
460
|
+
|
461
|
+
/** Interface representing a Directory. */
|
462
|
+
declare interface Directory {
|
463
|
+
/**
|
464
|
+
* Creates a new directory under the specified share or parent directory.
|
465
|
+
* @param fileAttributes If specified, the provided file attributes shall be set. Default value:
|
466
|
+
* ‘Archive’ for file and ‘Directory’ for directory. ‘None’ can also be specified as default.
|
467
|
+
* @param options The options parameters.
|
468
|
+
*/
|
469
|
+
create(fileAttributes: string, options?: DirectoryCreateOptionalParams): Promise<DirectoryCreateResponse_2>;
|
470
|
+
/**
|
471
|
+
* Returns all system properties for the specified directory, and can also be used to check the
|
472
|
+
* existence of a directory. The data returned does not include the files in the directory or any
|
473
|
+
* subdirectories.
|
474
|
+
* @param options The options parameters.
|
475
|
+
*/
|
476
|
+
getProperties(options?: DirectoryGetPropertiesOptionalParams): Promise<DirectoryGetPropertiesResponse_2>;
|
477
|
+
/**
|
478
|
+
* Removes the specified empty directory. Note that the directory must be empty before it can be
|
479
|
+
* deleted.
|
480
|
+
* @param options The options parameters.
|
481
|
+
*/
|
482
|
+
delete(options?: DirectoryDeleteOptionalParams): Promise<DirectoryDeleteResponse_2>;
|
483
|
+
/**
|
484
|
+
* Sets properties on the directory.
|
485
|
+
* @param fileAttributes If specified, the provided file attributes shall be set. Default value:
|
486
|
+
* ‘Archive’ for file and ‘Directory’ for directory. ‘None’ can also be specified as default.
|
487
|
+
* @param options The options parameters.
|
488
|
+
*/
|
489
|
+
setProperties(fileAttributes: string, options?: DirectorySetPropertiesOptionalParams): Promise<DirectorySetPropertiesResponse_2>;
|
490
|
+
/**
|
491
|
+
* Updates user defined metadata for the specified directory.
|
492
|
+
* @param options The options parameters.
|
493
|
+
*/
|
494
|
+
setMetadata(options?: DirectorySetMetadataOptionalParams): Promise<DirectorySetMetadataResponse_2>;
|
495
|
+
/**
|
496
|
+
* Returns a list of files or directories under the specified share or directory. It lists the contents
|
497
|
+
* only for a single level of the directory hierarchy.
|
498
|
+
* @param options The options parameters.
|
499
|
+
*/
|
500
|
+
listFilesAndDirectoriesSegment(options?: DirectoryListFilesAndDirectoriesSegmentOptionalParams): Promise<DirectoryListFilesAndDirectoriesSegmentResponse_2>;
|
501
|
+
/**
|
502
|
+
* Lists handles for directory.
|
503
|
+
* @param options The options parameters.
|
504
|
+
*/
|
505
|
+
listHandles(options?: DirectoryListHandlesOptionalParams): Promise<DirectoryListHandlesResponse_2>;
|
506
|
+
/**
|
507
|
+
* Closes all handles open for given directory.
|
508
|
+
* @param handleId Specifies handle ID opened on the file or directory to be closed. Asterisk (‘*’) is
|
509
|
+
* a wildcard that specifies all handles.
|
510
|
+
* @param options The options parameters.
|
511
|
+
*/
|
512
|
+
forceCloseHandles(handleId: string, options?: DirectoryForceCloseHandlesOptionalParams): Promise<DirectoryForceCloseHandlesResponse_2>;
|
513
|
+
/**
|
514
|
+
* Renames a directory
|
515
|
+
* @param renameSource Required. Specifies the URI-style path of the source file, up to 2 KB in length.
|
516
|
+
* @param options The options parameters.
|
517
|
+
*/
|
518
|
+
rename(renameSource: string, options?: DirectoryRenameOptionalParams): Promise<DirectoryRenameResponse_2>;
|
519
|
+
}
|
416
520
|
|
417
521
|
/**
|
418
522
|
* Additional response header values for close handles request.
|
@@ -481,6 +585,26 @@ export declare interface DirectoryCreateIfNotExistsResponse extends DirectoryCre
|
|
481
585
|
succeeded: boolean;
|
482
586
|
}
|
483
587
|
|
588
|
+
/** Optional parameters. */
|
589
|
+
declare interface DirectoryCreateOptionalParams extends coreClient.OperationOptions {
|
590
|
+
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN">Setting Timeouts for File Service Operations.</a> */
|
591
|
+
timeoutInSeconds?: number;
|
592
|
+
/** A name-value pair to associate with a file storage object. */
|
593
|
+
metadata?: {
|
594
|
+
[propertyName: string]: string;
|
595
|
+
};
|
596
|
+
/** If specified the permission (security descriptor) shall be set for the directory/file. This header can be used if Permission size is <= 8KB, else x-ms-file-permission-key header shall be used. Default value: Inherit. If SDDL is specified as input, it must have owner, group and dacl. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. */
|
597
|
+
filePermission?: string;
|
598
|
+
/** Key of the permission to be set for the directory/file. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. */
|
599
|
+
filePermissionKey?: string;
|
600
|
+
/** Creation time for the file/directory. Default value: Now. */
|
601
|
+
fileCreatedOn?: string;
|
602
|
+
/** Last write time for the file/directory. Default value: Now. */
|
603
|
+
fileLastWriteOn?: string;
|
604
|
+
/** Change time for the file/directory. Default value: Now. */
|
605
|
+
fileChangeOn?: string;
|
606
|
+
}
|
607
|
+
|
484
608
|
/**
|
485
609
|
* Options to configure {@link ShareDirectoryClient.create} operation.
|
486
610
|
*/
|
@@ -497,13 +621,10 @@ export declare interface DirectoryCreateOptions extends FileAndDirectoryCreateCo
|
|
497
621
|
}
|
498
622
|
|
499
623
|
/** Contains response data for the create operation. */
|
500
|
-
export declare type DirectoryCreateResponse = DirectoryCreateHeaders
|
501
|
-
|
502
|
-
|
503
|
-
|
504
|
-
parsedHeaders: DirectoryCreateHeaders;
|
505
|
-
};
|
506
|
-
};
|
624
|
+
export declare type DirectoryCreateResponse = WithResponse<DirectoryCreateHeaders, DirectoryCreateHeaders>;
|
625
|
+
|
626
|
+
/** Contains response data for the create operation. */
|
627
|
+
declare type DirectoryCreateResponse_2 = DirectoryCreateHeaders;
|
507
628
|
|
508
629
|
/** Defines headers for Directory_delete operation. */
|
509
630
|
export declare interface DirectoryDeleteHeaders {
|
@@ -527,6 +648,12 @@ export declare interface DirectoryDeleteIfExistsResponse extends DirectoryDelete
|
|
527
648
|
succeeded: boolean;
|
528
649
|
}
|
529
650
|
|
651
|
+
/** Optional parameters. */
|
652
|
+
declare interface DirectoryDeleteOptionalParams extends coreClient.OperationOptions {
|
653
|
+
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN">Setting Timeouts for File Service Operations.</a> */
|
654
|
+
timeoutInSeconds?: number;
|
655
|
+
}
|
656
|
+
|
530
657
|
/**
|
531
658
|
* Options to configure the {@link ShareDirectoryClient.delete} operation.
|
532
659
|
*/
|
@@ -539,13 +666,10 @@ export declare interface DirectoryDeleteOptions extends CommonOptions {
|
|
539
666
|
}
|
540
667
|
|
541
668
|
/** Contains response data for the delete operation. */
|
542
|
-
export declare type DirectoryDeleteResponse = DirectoryDeleteHeaders
|
543
|
-
|
544
|
-
|
545
|
-
|
546
|
-
parsedHeaders: DirectoryDeleteHeaders;
|
547
|
-
};
|
548
|
-
};
|
669
|
+
export declare type DirectoryDeleteResponse = WithResponse<DirectoryDeleteHeaders, DirectoryDeleteHeaders>;
|
670
|
+
|
671
|
+
/** Contains response data for the delete operation. */
|
672
|
+
declare type DirectoryDeleteResponse_2 = DirectoryDeleteHeaders;
|
549
673
|
|
550
674
|
/**
|
551
675
|
* Options to configure the {@link ShareDirectoryClient.exists} operation.
|
@@ -576,6 +700,18 @@ export declare interface DirectoryForceCloseHandlesHeaders {
|
|
576
700
|
errorCode?: string;
|
577
701
|
}
|
578
702
|
|
703
|
+
/** Optional parameters. */
|
704
|
+
declare interface DirectoryForceCloseHandlesOptionalParams extends coreClient.OperationOptions {
|
705
|
+
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN">Setting Timeouts for File Service Operations.</a> */
|
706
|
+
timeoutInSeconds?: number;
|
707
|
+
/** A string value that identifies the portion of the list to be returned with the next list operation. The operation returns a marker value within the response body if the list returned was not complete. The marker value may then be used in a subsequent call to request the next set of list items. The marker value is opaque to the client. */
|
708
|
+
marker?: string;
|
709
|
+
/** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
|
710
|
+
shareSnapshot?: string;
|
711
|
+
/** Specifies operation should apply to the directory specified in the URI, its files, its subdirectories and their files. */
|
712
|
+
recursive?: boolean;
|
713
|
+
}
|
714
|
+
|
579
715
|
/**
|
580
716
|
* Options to configure {@link ShareDirectoryClient.forceCloseHandle}.
|
581
717
|
*/
|
@@ -590,17 +726,10 @@ export declare interface DirectoryForceCloseHandlesOptions extends CommonOptions
|
|
590
726
|
/**
|
591
727
|
* Response type for {@link ShareDirectoryClient.forceCloseHandle}.
|
592
728
|
*/
|
593
|
-
export declare type DirectoryForceCloseHandlesResponse = CloseHandlesInfo & DirectoryCloseHandlesHeaders
|
594
|
-
|
595
|
-
|
596
|
-
|
597
|
-
_response: HttpResponse & {
|
598
|
-
/**
|
599
|
-
* The parsed HTTP response headers.
|
600
|
-
*/
|
601
|
-
parsedHeaders: DirectoryForceCloseHandlesHeaders;
|
602
|
-
};
|
603
|
-
};
|
729
|
+
export declare type DirectoryForceCloseHandlesResponse = WithResponse<CloseHandlesInfo & DirectoryCloseHandlesHeaders, DirectoryForceCloseHandlesHeaders>;
|
730
|
+
|
731
|
+
/** Contains response data for the forceCloseHandles operation. */
|
732
|
+
declare type DirectoryForceCloseHandlesResponse_2 = DirectoryForceCloseHandlesHeaders;
|
604
733
|
|
605
734
|
/**
|
606
735
|
* Options to configure Directory - Force Close Handles Segment operations.
|
@@ -658,6 +787,14 @@ export declare interface DirectoryGetPropertiesHeaders {
|
|
658
787
|
errorCode?: string;
|
659
788
|
}
|
660
789
|
|
790
|
+
/** Optional parameters. */
|
791
|
+
declare interface DirectoryGetPropertiesOptionalParams extends coreClient.OperationOptions {
|
792
|
+
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN">Setting Timeouts for File Service Operations.</a> */
|
793
|
+
timeoutInSeconds?: number;
|
794
|
+
/** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
|
795
|
+
shareSnapshot?: string;
|
796
|
+
}
|
797
|
+
|
661
798
|
/**
|
662
799
|
* Options to configure the {@link ShareDirectoryClient.getProperties} operation.
|
663
800
|
*/
|
@@ -670,13 +807,10 @@ export declare interface DirectoryGetPropertiesOptions extends CommonOptions {
|
|
670
807
|
}
|
671
808
|
|
672
809
|
/** Contains response data for the getProperties operation. */
|
673
|
-
export declare type DirectoryGetPropertiesResponse = DirectoryGetPropertiesHeaders
|
674
|
-
|
675
|
-
|
676
|
-
|
677
|
-
parsedHeaders: DirectoryGetPropertiesHeaders;
|
678
|
-
};
|
679
|
-
};
|
810
|
+
export declare type DirectoryGetPropertiesResponse = WithResponse<DirectoryGetPropertiesHeaders, DirectoryGetPropertiesHeaders>;
|
811
|
+
|
812
|
+
/** Contains response data for the getProperties operation. */
|
813
|
+
declare type DirectoryGetPropertiesResponse_2 = DirectoryGetPropertiesHeaders;
|
680
814
|
|
681
815
|
/** A listed directory item. */
|
682
816
|
export declare interface DirectoryItem {
|
@@ -727,18 +861,29 @@ export declare interface DirectoryListFilesAndDirectoriesSegmentHeaders {
|
|
727
861
|
errorCode?: string;
|
728
862
|
}
|
729
863
|
|
864
|
+
/** Optional parameters. */
|
865
|
+
declare interface DirectoryListFilesAndDirectoriesSegmentOptionalParams extends coreClient.OperationOptions {
|
866
|
+
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN">Setting Timeouts for File Service Operations.</a> */
|
867
|
+
timeoutInSeconds?: number;
|
868
|
+
/** Filters the results to return only entries whose name begins with the specified prefix. */
|
869
|
+
prefix?: string;
|
870
|
+
/** A string value that identifies the portion of the list to be returned with the next list operation. The operation returns a marker value within the response body if the list returned was not complete. The marker value may then be used in a subsequent call to request the next set of list items. The marker value is opaque to the client. */
|
871
|
+
marker?: string;
|
872
|
+
/** Specifies the maximum number of entries to return. If the request does not specify maxresults, or specifies a value greater than 5,000, the server will return up to 5,000 items. */
|
873
|
+
maxResults?: number;
|
874
|
+
/** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
|
875
|
+
shareSnapshot?: string;
|
876
|
+
/** Include this parameter to specify one or more datasets to include in the response. */
|
877
|
+
include?: ListFilesIncludeType[];
|
878
|
+
/** Include extended information. */
|
879
|
+
includeExtendedInfo?: boolean;
|
880
|
+
}
|
881
|
+
|
730
882
|
/** Contains response data for the listFilesAndDirectoriesSegment operation. */
|
731
|
-
export declare type DirectoryListFilesAndDirectoriesSegmentResponse = DirectoryListFilesAndDirectoriesSegmentHeaders & ListFilesAndDirectoriesSegmentResponse
|
732
|
-
|
733
|
-
|
734
|
-
|
735
|
-
bodyAsText: string;
|
736
|
-
/** The response body as parsed JSON or XML */
|
737
|
-
parsedBody: ListFilesAndDirectoriesSegmentResponse;
|
738
|
-
/** The parsed HTTP response headers. */
|
739
|
-
parsedHeaders: DirectoryListFilesAndDirectoriesSegmentHeaders;
|
740
|
-
};
|
741
|
-
};
|
883
|
+
export declare type DirectoryListFilesAndDirectoriesSegmentResponse = WithResponse<DirectoryListFilesAndDirectoriesSegmentHeaders & ListFilesAndDirectoriesSegmentResponse, DirectoryListFilesAndDirectoriesSegmentHeaders, ListFilesAndDirectoriesSegmentResponse>;
|
884
|
+
|
885
|
+
/** Contains response data for the listFilesAndDirectoriesSegment operation. */
|
886
|
+
declare type DirectoryListFilesAndDirectoriesSegmentResponse_2 = DirectoryListFilesAndDirectoriesSegmentHeaders & ListFilesAndDirectoriesSegmentResponse;
|
742
887
|
|
743
888
|
/** Defines headers for Directory_listHandles operation. */
|
744
889
|
export declare interface DirectoryListHandlesHeaders {
|
@@ -754,6 +899,20 @@ export declare interface DirectoryListHandlesHeaders {
|
|
754
899
|
errorCode?: string;
|
755
900
|
}
|
756
901
|
|
902
|
+
/** Optional parameters. */
|
903
|
+
declare interface DirectoryListHandlesOptionalParams extends coreClient.OperationOptions {
|
904
|
+
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN">Setting Timeouts for File Service Operations.</a> */
|
905
|
+
timeoutInSeconds?: number;
|
906
|
+
/** A string value that identifies the portion of the list to be returned with the next list operation. The operation returns a marker value within the response body if the list returned was not complete. The marker value may then be used in a subsequent call to request the next set of list items. The marker value is opaque to the client. */
|
907
|
+
marker?: string;
|
908
|
+
/** Specifies the maximum number of entries to return. If the request does not specify maxresults, or specifies a value greater than 5,000, the server will return up to 5,000 items. */
|
909
|
+
maxResults?: number;
|
910
|
+
/** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
|
911
|
+
shareSnapshot?: string;
|
912
|
+
/** Specifies operation should apply to the directory specified in the URI, its files, its subdirectories and their files. */
|
913
|
+
recursive?: boolean;
|
914
|
+
}
|
915
|
+
|
757
916
|
/**
|
758
917
|
* Options to configure the {@link ShareDirectoryClient.listHandles} operation.
|
759
918
|
*/
|
@@ -771,17 +930,10 @@ export declare interface DirectoryListHandlesOptions extends CommonOptions {
|
|
771
930
|
}
|
772
931
|
|
773
932
|
/** Contains response data for the listHandles operation. */
|
774
|
-
export declare type DirectoryListHandlesResponse = DirectoryListHandlesHeaders & ListHandlesResponse
|
775
|
-
|
776
|
-
|
777
|
-
|
778
|
-
bodyAsText: string;
|
779
|
-
/** The response body as parsed JSON or XML */
|
780
|
-
parsedBody: ListHandlesResponse;
|
781
|
-
/** The parsed HTTP response headers. */
|
782
|
-
parsedHeaders: DirectoryListHandlesHeaders;
|
783
|
-
};
|
784
|
-
};
|
933
|
+
export declare type DirectoryListHandlesResponse = WithResponse<DirectoryListHandlesHeaders & ListHandlesResponse, DirectoryListHandlesHeaders, ListHandlesResponse>;
|
934
|
+
|
935
|
+
/** Contains response data for the listHandles operation. */
|
936
|
+
declare type DirectoryListHandlesResponse_2 = DirectoryListHandlesHeaders & ListHandlesResponse;
|
785
937
|
|
786
938
|
/**
|
787
939
|
* Options to configure Directory - List Handles Segment operations.
|
@@ -848,6 +1000,30 @@ export declare interface DirectoryRenameHeaders {
|
|
848
1000
|
fileParentId?: string;
|
849
1001
|
}
|
850
1002
|
|
1003
|
+
/** Optional parameters. */
|
1004
|
+
declare interface DirectoryRenameOptionalParams extends coreClient.OperationOptions {
|
1005
|
+
/** Parameter group */
|
1006
|
+
sourceLeaseAccessConditions?: SourceLeaseAccessConditions;
|
1007
|
+
/** Parameter group */
|
1008
|
+
destinationLeaseAccessConditions?: DestinationLeaseAccessConditions;
|
1009
|
+
/** Parameter group */
|
1010
|
+
copyFileSmbInfo?: CopyFileSmbInfo;
|
1011
|
+
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN">Setting Timeouts for File Service Operations.</a> */
|
1012
|
+
timeoutInSeconds?: number;
|
1013
|
+
/** A name-value pair to associate with a file storage object. */
|
1014
|
+
metadata?: {
|
1015
|
+
[propertyName: string]: string;
|
1016
|
+
};
|
1017
|
+
/** If specified the permission (security descriptor) shall be set for the directory/file. This header can be used if Permission size is <= 8KB, else x-ms-file-permission-key header shall be used. Default value: Inherit. If SDDL is specified as input, it must have owner, group and dacl. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. */
|
1018
|
+
filePermission?: string;
|
1019
|
+
/** Key of the permission to be set for the directory/file. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. */
|
1020
|
+
filePermissionKey?: string;
|
1021
|
+
/** Optional. A boolean value for if the destination file already exists, whether this request will overwrite the file or not. If true, the rename will succeed and will overwrite the destination file. If not provided or if false and the destination file does exist, the request will not overwrite the destination file. If provided and the destination file doesn’t exist, the rename will succeed. Note: This value does not override the x-ms-file-copy-ignore-read-only header value. */
|
1022
|
+
replaceIfExists?: boolean;
|
1023
|
+
/** Optional. A boolean value that specifies whether the ReadOnly attribute on a preexisting destination file should be respected. If true, the rename will succeed, otherwise, a previous file at the destination with the ReadOnly attribute set will cause the rename to fail. */
|
1024
|
+
ignoreReadOnly?: boolean;
|
1025
|
+
}
|
1026
|
+
|
851
1027
|
/**
|
852
1028
|
* Options to configure the {@link ShareDirectoryClient.rename} operation.
|
853
1029
|
*/
|
@@ -903,13 +1079,10 @@ export declare interface DirectoryRenameOptions extends CommonOptions {
|
|
903
1079
|
}
|
904
1080
|
|
905
1081
|
/** Contains response data for the rename operation. */
|
906
|
-
export declare type DirectoryRenameResponse = DirectoryRenameHeaders
|
907
|
-
|
908
|
-
|
909
|
-
|
910
|
-
parsedHeaders: DirectoryRenameHeaders;
|
911
|
-
};
|
912
|
-
};
|
1082
|
+
export declare type DirectoryRenameResponse = WithResponse<DirectoryRenameHeaders, DirectoryRenameHeaders>;
|
1083
|
+
|
1084
|
+
/** Contains response data for the rename operation. */
|
1085
|
+
declare type DirectoryRenameResponse_2 = DirectoryRenameHeaders;
|
913
1086
|
|
914
1087
|
/** Defines headers for Directory_setMetadata operation. */
|
915
1088
|
export declare interface DirectorySetMetadataHeaders {
|
@@ -927,6 +1100,16 @@ export declare interface DirectorySetMetadataHeaders {
|
|
927
1100
|
errorCode?: string;
|
928
1101
|
}
|
929
1102
|
|
1103
|
+
/** Optional parameters. */
|
1104
|
+
declare interface DirectorySetMetadataOptionalParams extends coreClient.OperationOptions {
|
1105
|
+
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN">Setting Timeouts for File Service Operations.</a> */
|
1106
|
+
timeoutInSeconds?: number;
|
1107
|
+
/** A name-value pair to associate with a file storage object. */
|
1108
|
+
metadata?: {
|
1109
|
+
[propertyName: string]: string;
|
1110
|
+
};
|
1111
|
+
}
|
1112
|
+
|
930
1113
|
/**
|
931
1114
|
* Options to configure the {@link ShareDirectoryClient.setMetadata} operation.
|
932
1115
|
*/
|
@@ -939,13 +1122,10 @@ export declare interface DirectorySetMetadataOptions extends CommonOptions {
|
|
939
1122
|
}
|
940
1123
|
|
941
1124
|
/** Contains response data for the setMetadata operation. */
|
942
|
-
export declare type DirectorySetMetadataResponse = DirectorySetMetadataHeaders
|
943
|
-
|
944
|
-
|
945
|
-
|
946
|
-
parsedHeaders: DirectorySetMetadataHeaders;
|
947
|
-
};
|
948
|
-
};
|
1125
|
+
export declare type DirectorySetMetadataResponse = WithResponse<DirectorySetMetadataHeaders, DirectorySetMetadataHeaders>;
|
1126
|
+
|
1127
|
+
/** Contains response data for the setMetadata operation. */
|
1128
|
+
declare type DirectorySetMetadataResponse_2 = DirectorySetMetadataHeaders;
|
949
1129
|
|
950
1130
|
/** Defines headers for Directory_setProperties operation. */
|
951
1131
|
export declare interface DirectorySetPropertiesHeaders {
|
@@ -979,14 +1159,166 @@ export declare interface DirectorySetPropertiesHeaders {
|
|
979
1159
|
errorCode?: string;
|
980
1160
|
}
|
981
1161
|
|
1162
|
+
/** Optional parameters. */
|
1163
|
+
declare interface DirectorySetPropertiesOptionalParams extends coreClient.OperationOptions {
|
1164
|
+
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN">Setting Timeouts for File Service Operations.</a> */
|
1165
|
+
timeoutInSeconds?: number;
|
1166
|
+
/** If specified the permission (security descriptor) shall be set for the directory/file. This header can be used if Permission size is <= 8KB, else x-ms-file-permission-key header shall be used. Default value: Inherit. If SDDL is specified as input, it must have owner, group and dacl. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. */
|
1167
|
+
filePermission?: string;
|
1168
|
+
/** Key of the permission to be set for the directory/file. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. */
|
1169
|
+
filePermissionKey?: string;
|
1170
|
+
/** Creation time for the file/directory. Default value: Now. */
|
1171
|
+
fileCreatedOn?: string;
|
1172
|
+
/** Last write time for the file/directory. Default value: Now. */
|
1173
|
+
fileLastWriteOn?: string;
|
1174
|
+
/** Change time for the file/directory. Default value: Now. */
|
1175
|
+
fileChangeOn?: string;
|
1176
|
+
}
|
1177
|
+
|
982
1178
|
/** Contains response data for the setProperties operation. */
|
983
|
-
export declare type DirectorySetPropertiesResponse = DirectorySetPropertiesHeaders
|
984
|
-
|
985
|
-
|
986
|
-
|
987
|
-
|
988
|
-
|
989
|
-
|
1179
|
+
export declare type DirectorySetPropertiesResponse = WithResponse<DirectorySetPropertiesHeaders, DirectorySetPropertiesHeaders>;
|
1180
|
+
|
1181
|
+
/** Contains response data for the setProperties operation. */
|
1182
|
+
declare type DirectorySetPropertiesResponse_2 = DirectorySetPropertiesHeaders;
|
1183
|
+
|
1184
|
+
/** Interface representing a File. */
|
1185
|
+
declare interface File_2 {
|
1186
|
+
/**
|
1187
|
+
* Creates a new file or replaces a file. Note it only initializes the file with no content.
|
1188
|
+
* @param fileContentLength Specifies the maximum size for the file, up to 4 TB.
|
1189
|
+
* @param fileAttributes If specified, the provided file attributes shall be set. Default value:
|
1190
|
+
* ‘Archive’ for file and ‘Directory’ for directory. ‘None’ can also be specified as default.
|
1191
|
+
* @param options The options parameters.
|
1192
|
+
*/
|
1193
|
+
create(fileContentLength: number, fileAttributes: string, options?: FileCreateOptionalParams): Promise<FileCreateResponse_2>;
|
1194
|
+
/**
|
1195
|
+
* Reads or downloads a file from the system, including its metadata and properties.
|
1196
|
+
* @param options The options parameters.
|
1197
|
+
*/
|
1198
|
+
download(options?: FileDownloadOptionalParams): Promise<RawFileDownloadResponse>;
|
1199
|
+
/**
|
1200
|
+
* Returns all user-defined metadata, standard HTTP properties, and system properties for the file. It
|
1201
|
+
* does not return the content of the file.
|
1202
|
+
* @param options The options parameters.
|
1203
|
+
*/
|
1204
|
+
getProperties(options?: FileGetPropertiesOptionalParams): Promise<FileGetPropertiesResponse_2>;
|
1205
|
+
/**
|
1206
|
+
* removes the file from the storage account.
|
1207
|
+
* @param options The options parameters.
|
1208
|
+
*/
|
1209
|
+
delete(options?: FileDeleteOptionalParams): Promise<FileDeleteResponse_2>;
|
1210
|
+
/**
|
1211
|
+
* Sets HTTP headers on the file.
|
1212
|
+
* @param fileAttributes If specified, the provided file attributes shall be set. Default value:
|
1213
|
+
* ‘Archive’ for file and ‘Directory’ for directory. ‘None’ can also be specified as default.
|
1214
|
+
* @param options The options parameters.
|
1215
|
+
*/
|
1216
|
+
setHttpHeaders(fileAttributes: string, options?: FileSetHttpHeadersOptionalParams): Promise<FileSetHttpHeadersResponse>;
|
1217
|
+
/**
|
1218
|
+
* Updates user-defined metadata for the specified file.
|
1219
|
+
* @param options The options parameters.
|
1220
|
+
*/
|
1221
|
+
setMetadata(options?: FileSetMetadataOptionalParams): Promise<FileSetMetadataResponse_2>;
|
1222
|
+
/**
|
1223
|
+
* [Update] The Lease File operation establishes and manages a lock on a file for write and delete
|
1224
|
+
* operations
|
1225
|
+
* @param options The options parameters.
|
1226
|
+
*/
|
1227
|
+
acquireLease(options?: FileAcquireLeaseOptionalParams): Promise<FileAcquireLeaseResponse>;
|
1228
|
+
/**
|
1229
|
+
* [Update] The Lease File operation establishes and manages a lock on a file for write and delete
|
1230
|
+
* operations
|
1231
|
+
* @param leaseId Specifies the current lease ID on the resource.
|
1232
|
+
* @param options The options parameters.
|
1233
|
+
*/
|
1234
|
+
releaseLease(leaseId: string, options?: FileReleaseLeaseOptionalParams): Promise<FileReleaseLeaseResponse>;
|
1235
|
+
/**
|
1236
|
+
* [Update] The Lease File operation establishes and manages a lock on a file for write and delete
|
1237
|
+
* operations
|
1238
|
+
* @param leaseId Specifies the current lease ID on the resource.
|
1239
|
+
* @param options The options parameters.
|
1240
|
+
*/
|
1241
|
+
changeLease(leaseId: string, options?: FileChangeLeaseOptionalParams): Promise<FileChangeLeaseResponse>;
|
1242
|
+
/**
|
1243
|
+
* [Update] The Lease File operation establishes and manages a lock on a file for write and delete
|
1244
|
+
* operations
|
1245
|
+
* @param options The options parameters.
|
1246
|
+
*/
|
1247
|
+
breakLease(options?: FileBreakLeaseOptionalParams): Promise<FileBreakLeaseResponse>;
|
1248
|
+
/**
|
1249
|
+
* Upload a range of bytes to a file.
|
1250
|
+
* @param range Specifies the range of bytes to be written. Both the start and end of the range must be
|
1251
|
+
* specified. For an update operation, the range can be up to 4 MB in size. For a clear operation, the
|
1252
|
+
* range can be up to the value of the file's full size. The File service accepts only a single byte
|
1253
|
+
* range for the Range and 'x-ms-range' headers, and the byte range must be specified in the following
|
1254
|
+
* format: bytes=startByte-endByte.
|
1255
|
+
* @param fileRangeWrite Specify one of the following options: - Update: Writes the bytes specified by
|
1256
|
+
* the request body into the specified range. The Range and Content-Length headers must match to
|
1257
|
+
* perform the update. - Clear: Clears the specified range and releases the space used in storage for
|
1258
|
+
* that range. To clear a range, set the Content-Length header to zero, and set the Range header to a
|
1259
|
+
* value that indicates the range to clear, up to maximum file size.
|
1260
|
+
* @param contentLength Specifies the number of bytes being transmitted in the request body. When the
|
1261
|
+
* x-ms-write header is set to clear, the value of this header must be set to zero.
|
1262
|
+
* @param options The options parameters.
|
1263
|
+
*/
|
1264
|
+
uploadRange(range: string, fileRangeWrite: FileRangeWriteType, contentLength: number, options?: FileUploadRangeOptionalParams): Promise<FileUploadRangeResponse_2>;
|
1265
|
+
/**
|
1266
|
+
* Upload a range of bytes to a file where the contents are read from a URL.
|
1267
|
+
* @param range Writes data to the specified byte range in the file.
|
1268
|
+
* @param copySource Specifies the URL of the source file or blob, up to 2 KB in length. To copy a file
|
1269
|
+
* to another file within the same storage account, you may use Shared Key to authenticate the source
|
1270
|
+
* file. If you are copying a file from another storage account, or if you are copying a blob from the
|
1271
|
+
* same storage account or another storage account, then you must authenticate the source file or blob
|
1272
|
+
* using a shared access signature. If the source is a public blob, no authentication is required to
|
1273
|
+
* perform the copy operation. A file in a share snapshot can also be specified as a copy source.
|
1274
|
+
* @param contentLength Specifies the number of bytes being transmitted in the request body. When the
|
1275
|
+
* x-ms-write header is set to clear, the value of this header must be set to zero.
|
1276
|
+
* @param options The options parameters.
|
1277
|
+
*/
|
1278
|
+
uploadRangeFromURL(range: string, copySource: string, contentLength: number, options?: FileUploadRangeFromURLOptionalParams): Promise<FileUploadRangeFromURLResponse_2>;
|
1279
|
+
/**
|
1280
|
+
* Returns the list of valid ranges for a file.
|
1281
|
+
* @param options The options parameters.
|
1282
|
+
*/
|
1283
|
+
getRangeList(options?: FileGetRangeListOptionalParams): Promise<FileGetRangeListResponse_2>;
|
1284
|
+
/**
|
1285
|
+
* Copies a blob or file to a destination file within the storage account.
|
1286
|
+
* @param copySource Specifies the URL of the source file or blob, up to 2 KB in length. To copy a file
|
1287
|
+
* to another file within the same storage account, you may use Shared Key to authenticate the source
|
1288
|
+
* file. If you are copying a file from another storage account, or if you are copying a blob from the
|
1289
|
+
* same storage account or another storage account, then you must authenticate the source file or blob
|
1290
|
+
* using a shared access signature. If the source is a public blob, no authentication is required to
|
1291
|
+
* perform the copy operation. A file in a share snapshot can also be specified as a copy source.
|
1292
|
+
* @param options The options parameters.
|
1293
|
+
*/
|
1294
|
+
startCopy(copySource: string, options?: FileStartCopyOptionalParams): Promise<FileStartCopyResponse_2>;
|
1295
|
+
/**
|
1296
|
+
* Aborts a pending Copy File operation, and leaves a destination file with zero length and full
|
1297
|
+
* metadata.
|
1298
|
+
* @param copyId The copy identifier provided in the x-ms-copy-id header of the original Copy File
|
1299
|
+
* operation.
|
1300
|
+
* @param options The options parameters.
|
1301
|
+
*/
|
1302
|
+
abortCopy(copyId: string, options?: FileAbortCopyOptionalParams): Promise<FileAbortCopyResponse_2>;
|
1303
|
+
/**
|
1304
|
+
* Lists handles for file
|
1305
|
+
* @param options The options parameters.
|
1306
|
+
*/
|
1307
|
+
listHandles(options?: FileListHandlesOptionalParams): Promise<FileListHandlesResponse_2>;
|
1308
|
+
/**
|
1309
|
+
* Closes all handles open for given file
|
1310
|
+
* @param handleId Specifies handle ID opened on the file or directory to be closed. Asterisk (‘*’) is
|
1311
|
+
* a wildcard that specifies all handles.
|
1312
|
+
* @param options The options parameters.
|
1313
|
+
*/
|
1314
|
+
forceCloseHandles(handleId: string, options?: FileForceCloseHandlesOptionalParams): Promise<FileForceCloseHandlesResponse_2>;
|
1315
|
+
/**
|
1316
|
+
* Renames a file
|
1317
|
+
* @param renameSource Required. Specifies the URI-style path of the source file, up to 2 KB in length.
|
1318
|
+
* @param options The options parameters.
|
1319
|
+
*/
|
1320
|
+
rename(renameSource: string, options?: FileRenameOptionalParams): Promise<FileRenameResponse_2>;
|
1321
|
+
}
|
990
1322
|
|
991
1323
|
/**
|
992
1324
|
* Options to configure the {@link ShareFileClient.abortCopyFromURL} operation.
|
@@ -1015,14 +1347,52 @@ export declare interface FileAbortCopyHeaders {
|
|
1015
1347
|
errorCode?: string;
|
1016
1348
|
}
|
1017
1349
|
|
1350
|
+
/** Optional parameters. */
|
1351
|
+
declare interface FileAbortCopyOptionalParams extends coreClient.OperationOptions {
|
1352
|
+
/** Parameter group */
|
1353
|
+
leaseAccessConditions?: LeaseAccessConditions;
|
1354
|
+
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN">Setting Timeouts for File Service Operations.</a> */
|
1355
|
+
timeoutInSeconds?: number;
|
1356
|
+
}
|
1357
|
+
|
1018
1358
|
/** Contains response data for the abortCopy operation. */
|
1019
|
-
export declare type FileAbortCopyResponse = FileAbortCopyHeaders
|
1020
|
-
|
1021
|
-
|
1022
|
-
|
1023
|
-
|
1024
|
-
|
1025
|
-
|
1359
|
+
export declare type FileAbortCopyResponse = WithResponse<FileAbortCopyHeaders, FileAbortCopyHeaders>;
|
1360
|
+
|
1361
|
+
/** Contains response data for the abortCopy operation. */
|
1362
|
+
declare type FileAbortCopyResponse_2 = FileAbortCopyHeaders;
|
1363
|
+
|
1364
|
+
/** Defines headers for File_acquireLease operation. */
|
1365
|
+
declare interface FileAcquireLeaseHeaders {
|
1366
|
+
/** 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. */
|
1367
|
+
etag?: string;
|
1368
|
+
/** Returns the date and time the file was last modified. Any operation that modifies the file, including an update of the file's metadata or properties, changes the last-modified time of the file. */
|
1369
|
+
lastModified?: Date;
|
1370
|
+
/** Uniquely identifies a file's lease */
|
1371
|
+
leaseId?: string;
|
1372
|
+
/** If a client request id header is sent in the request, this header will be present in the response with the same value. */
|
1373
|
+
clientRequestId?: string;
|
1374
|
+
/** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
|
1375
|
+
requestId?: string;
|
1376
|
+
/** Indicates the version of the File service used to execute the request. */
|
1377
|
+
version?: string;
|
1378
|
+
/** UTC date/time value generated by the service that indicates the time at which the response was initiated */
|
1379
|
+
date?: Date;
|
1380
|
+
}
|
1381
|
+
|
1382
|
+
/** Optional parameters. */
|
1383
|
+
declare interface FileAcquireLeaseOptionalParams extends coreClient.OperationOptions {
|
1384
|
+
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN">Setting Timeouts for File Service Operations.</a> */
|
1385
|
+
timeoutInSeconds?: number;
|
1386
|
+
/** Specifies the duration of the lease, in seconds, or negative one (-1) for a lease that never expires. A non-infinite lease can be between 15 and 60 seconds. A lease duration cannot be changed using renew or change. */
|
1387
|
+
duration?: number;
|
1388
|
+
/** Proposed lease ID, in a GUID string format. The File 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. */
|
1389
|
+
proposedLeaseId?: string;
|
1390
|
+
/** 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. */
|
1391
|
+
requestId?: string;
|
1392
|
+
}
|
1393
|
+
|
1394
|
+
/** Contains response data for the acquireLease operation. */
|
1395
|
+
declare type FileAcquireLeaseResponse = FileAcquireLeaseHeaders;
|
1026
1396
|
|
1027
1397
|
export declare interface FileAndDirectoryCreateCommonOptions {
|
1028
1398
|
/**
|
@@ -1112,29 +1482,91 @@ export declare interface FileAndDirectorySetPropertiesCommonOptions {
|
|
1112
1482
|
*/
|
1113
1483
|
export declare type FileAttributesPreserveType = "preserve";
|
1114
1484
|
|
1115
|
-
/**
|
1116
|
-
|
1117
|
-
*/
|
1118
|
-
|
1119
|
-
/**
|
1120
|
-
|
1121
|
-
|
1122
|
-
|
1123
|
-
|
1124
|
-
|
1125
|
-
|
1126
|
-
|
1127
|
-
|
1128
|
-
|
1129
|
-
|
1130
|
-
|
1131
|
-
|
1132
|
-
|
1133
|
-
|
1134
|
-
|
1135
|
-
|
1136
|
-
|
1137
|
-
/**
|
1485
|
+
/** Defines headers for File_breakLease operation. */
|
1486
|
+
declare interface FileBreakLeaseHeaders {
|
1487
|
+
/** 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. */
|
1488
|
+
etag?: string;
|
1489
|
+
/** Returns the date and time the file was last modified. Any operation that modifies the file, including an update of the file's metadata or properties, changes the last-modified time of the file. */
|
1490
|
+
lastModified?: Date;
|
1491
|
+
/** Uniquely identifies a file's lease */
|
1492
|
+
leaseId?: string;
|
1493
|
+
/** If a client request id header is sent in the request, this header will be present in the response with the same value. */
|
1494
|
+
clientRequestId?: string;
|
1495
|
+
/** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
|
1496
|
+
requestId?: string;
|
1497
|
+
/** Indicates the version of the File service used to execute the request. */
|
1498
|
+
version?: string;
|
1499
|
+
/** UTC date/time value generated by the service that indicates the time at which the response was initiated */
|
1500
|
+
date?: Date;
|
1501
|
+
}
|
1502
|
+
|
1503
|
+
/** Optional parameters. */
|
1504
|
+
declare interface FileBreakLeaseOptionalParams extends coreClient.OperationOptions {
|
1505
|
+
/** Parameter group */
|
1506
|
+
leaseAccessConditions?: LeaseAccessConditions;
|
1507
|
+
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN">Setting Timeouts for File Service Operations.</a> */
|
1508
|
+
timeoutInSeconds?: number;
|
1509
|
+
/** 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. */
|
1510
|
+
requestId?: string;
|
1511
|
+
}
|
1512
|
+
|
1513
|
+
/** Contains response data for the breakLease operation. */
|
1514
|
+
declare type FileBreakLeaseResponse = FileBreakLeaseHeaders;
|
1515
|
+
|
1516
|
+
/** Defines headers for File_changeLease operation. */
|
1517
|
+
declare interface FileChangeLeaseHeaders {
|
1518
|
+
/** 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. */
|
1519
|
+
etag?: string;
|
1520
|
+
/** Returns the date and time the file was last modified. Any operation that modifies the file, including an update of the file's metadata or properties, changes the last-modified time of the file. */
|
1521
|
+
lastModified?: Date;
|
1522
|
+
/** Uniquely identifies a file's lease */
|
1523
|
+
leaseId?: string;
|
1524
|
+
/** If a client request id header is sent in the request, this header will be present in the response with the same value. */
|
1525
|
+
clientRequestId?: string;
|
1526
|
+
/** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
|
1527
|
+
requestId?: string;
|
1528
|
+
/** Indicates the version of the File service used to execute the request. */
|
1529
|
+
version?: string;
|
1530
|
+
/** UTC date/time value generated by the service that indicates the time at which the response was initiated */
|
1531
|
+
date?: Date;
|
1532
|
+
}
|
1533
|
+
|
1534
|
+
/** Optional parameters. */
|
1535
|
+
declare interface FileChangeLeaseOptionalParams extends coreClient.OperationOptions {
|
1536
|
+
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN">Setting Timeouts for File Service Operations.</a> */
|
1537
|
+
timeoutInSeconds?: number;
|
1538
|
+
/** Proposed lease ID, in a GUID string format. The File 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. */
|
1539
|
+
proposedLeaseId?: string;
|
1540
|
+
/** 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. */
|
1541
|
+
requestId?: string;
|
1542
|
+
}
|
1543
|
+
|
1544
|
+
/** Contains response data for the changeLease operation. */
|
1545
|
+
declare type FileChangeLeaseResponse = FileChangeLeaseHeaders;
|
1546
|
+
|
1547
|
+
/**
|
1548
|
+
* Options to configure the {@link ShareFileClient.clearRange} operation.
|
1549
|
+
*/
|
1550
|
+
export declare interface FileClearRangeOptions extends CommonOptions {
|
1551
|
+
/**
|
1552
|
+
* An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
|
1553
|
+
* For example, use the @azure/abort-controller to create an `AbortSignal`.
|
1554
|
+
*/
|
1555
|
+
abortSignal?: AbortSignalLike;
|
1556
|
+
/**
|
1557
|
+
* Lease access conditions.
|
1558
|
+
*/
|
1559
|
+
leaseAccessConditions?: LeaseAccessConditions;
|
1560
|
+
/**
|
1561
|
+
* The last write time for the file.
|
1562
|
+
* A value of preserve may be passed to keep an existing value unchanged.
|
1563
|
+
* A value of now may be used to indicate the time of the request.
|
1564
|
+
* By default, the value will be set as now.
|
1565
|
+
*/
|
1566
|
+
fileLastWrittenMode?: FileLastWrittenMode;
|
1567
|
+
}
|
1568
|
+
|
1569
|
+
/**
|
1138
1570
|
* Additional response header values for close handles request.
|
1139
1571
|
*/
|
1140
1572
|
export declare interface FileCloseHandlesHeaders {
|
@@ -1191,6 +1623,30 @@ export declare interface FileCreateHeaders {
|
|
1191
1623
|
errorCode?: string;
|
1192
1624
|
}
|
1193
1625
|
|
1626
|
+
/** Optional parameters. */
|
1627
|
+
declare interface FileCreateOptionalParams extends coreClient.OperationOptions {
|
1628
|
+
/** Parameter group */
|
1629
|
+
leaseAccessConditions?: LeaseAccessConditions;
|
1630
|
+
/** Parameter group */
|
1631
|
+
fileHttpHeaders?: FileHttpHeaders_2;
|
1632
|
+
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN">Setting Timeouts for File Service Operations.</a> */
|
1633
|
+
timeoutInSeconds?: number;
|
1634
|
+
/** A name-value pair to associate with a file storage object. */
|
1635
|
+
metadata?: {
|
1636
|
+
[propertyName: string]: string;
|
1637
|
+
};
|
1638
|
+
/** If specified the permission (security descriptor) shall be set for the directory/file. This header can be used if Permission size is <= 8KB, else x-ms-file-permission-key header shall be used. Default value: Inherit. If SDDL is specified as input, it must have owner, group and dacl. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. */
|
1639
|
+
filePermission?: string;
|
1640
|
+
/** Key of the permission to be set for the directory/file. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. */
|
1641
|
+
filePermissionKey?: string;
|
1642
|
+
/** Creation time for the file/directory. Default value: Now. */
|
1643
|
+
fileCreatedOn?: string;
|
1644
|
+
/** Last write time for the file/directory. Default value: Now. */
|
1645
|
+
fileLastWriteOn?: string;
|
1646
|
+
/** Change time for the file/directory. Default value: Now. */
|
1647
|
+
fileChangeOn?: string;
|
1648
|
+
}
|
1649
|
+
|
1194
1650
|
/**
|
1195
1651
|
* Options to configure the {@link ShareFileClient.create} operation.
|
1196
1652
|
*/
|
@@ -1215,13 +1671,10 @@ export declare interface FileCreateOptions extends FileAndDirectoryCreateCommonO
|
|
1215
1671
|
}
|
1216
1672
|
|
1217
1673
|
/** Contains response data for the create operation. */
|
1218
|
-
export declare type FileCreateResponse = FileCreateHeaders
|
1219
|
-
|
1220
|
-
|
1221
|
-
|
1222
|
-
parsedHeaders: FileCreateHeaders;
|
1223
|
-
};
|
1224
|
-
};
|
1674
|
+
export declare type FileCreateResponse = WithResponse<FileCreateHeaders, FileCreateHeaders>;
|
1675
|
+
|
1676
|
+
/** Contains response data for the create operation. */
|
1677
|
+
declare type FileCreateResponse_2 = FileCreateHeaders;
|
1225
1678
|
|
1226
1679
|
/** Defines headers for File_delete operation. */
|
1227
1680
|
export declare interface FileDeleteHeaders {
|
@@ -1245,6 +1698,14 @@ export declare interface FileDeleteIfExistsResponse extends FileDeleteResponse {
|
|
1245
1698
|
succeeded: boolean;
|
1246
1699
|
}
|
1247
1700
|
|
1701
|
+
/** Optional parameters. */
|
1702
|
+
declare interface FileDeleteOptionalParams extends coreClient.OperationOptions {
|
1703
|
+
/** Parameter group */
|
1704
|
+
leaseAccessConditions?: LeaseAccessConditions;
|
1705
|
+
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN">Setting Timeouts for File Service Operations.</a> */
|
1706
|
+
timeoutInSeconds?: number;
|
1707
|
+
}
|
1708
|
+
|
1248
1709
|
/**
|
1249
1710
|
* Options to configure the {@link ShareFileClient.delete} operation.
|
1250
1711
|
*/
|
@@ -1261,13 +1722,10 @@ export declare interface FileDeleteOptions extends CommonOptions {
|
|
1261
1722
|
}
|
1262
1723
|
|
1263
1724
|
/** Contains response data for the delete operation. */
|
1264
|
-
export declare type FileDeleteResponse = FileDeleteHeaders
|
1265
|
-
|
1266
|
-
|
1267
|
-
|
1268
|
-
parsedHeaders: FileDeleteHeaders;
|
1269
|
-
};
|
1270
|
-
};
|
1725
|
+
export declare type FileDeleteResponse = WithResponse<FileDeleteHeaders, FileDeleteHeaders>;
|
1726
|
+
|
1727
|
+
/** Contains response data for the delete operation. */
|
1728
|
+
declare type FileDeleteResponse_2 = FileDeleteHeaders;
|
1271
1729
|
|
1272
1730
|
/** Defines headers for File_download operation. */
|
1273
1731
|
export declare interface FileDownloadHeaders {
|
@@ -1344,15 +1802,11 @@ export declare interface FileDownloadHeaders {
|
|
1344
1802
|
}
|
1345
1803
|
|
1346
1804
|
/** Optional parameters. */
|
1347
|
-
export declare interface FileDownloadOptionalParams extends
|
1805
|
+
export declare interface FileDownloadOptionalParams extends coreClient.OperationOptions {
|
1348
1806
|
/** Parameter group */
|
1349
1807
|
leaseAccessConditions?: LeaseAccessConditions;
|
1350
1808
|
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN">Setting Timeouts for File Service Operations.</a> */
|
1351
1809
|
timeoutInSeconds?: number;
|
1352
|
-
/** Valid value is backup */
|
1353
|
-
fileRequestIntent?: ShareTokenIntent;
|
1354
|
-
/** If true, the trailing dot will not be trimmed from the target URI. */
|
1355
|
-
allowTrailingDot?: boolean;
|
1356
1810
|
/** Return file data only from the specified byte range. */
|
1357
1811
|
range?: string;
|
1358
1812
|
/** 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 4 MB in size. */
|
@@ -1402,27 +1856,7 @@ export declare interface FileDownloadOptions extends CommonOptions {
|
|
1402
1856
|
}
|
1403
1857
|
|
1404
1858
|
/** Contains response data for the download operation. */
|
1405
|
-
export declare type FileDownloadResponseModel = FileDownloadHeaders
|
1406
|
-
/**
|
1407
|
-
* BROWSER ONLY
|
1408
|
-
*
|
1409
|
-
* The response body as a browser Blob.
|
1410
|
-
* Always `undefined` in node.js.
|
1411
|
-
*/
|
1412
|
-
blobBody?: Promise<Blob>;
|
1413
|
-
/**
|
1414
|
-
* NODEJS ONLY
|
1415
|
-
*
|
1416
|
-
* The response body as a node.js Readable stream.
|
1417
|
-
* Always `undefined` in the browser.
|
1418
|
-
*/
|
1419
|
-
readableStreamBody?: NodeJS.ReadableStream;
|
1420
|
-
/** The underlying HTTP response. */
|
1421
|
-
_response: coreHttp.HttpResponse & {
|
1422
|
-
/** The parsed HTTP response headers. */
|
1423
|
-
parsedHeaders: FileDownloadHeaders;
|
1424
|
-
};
|
1425
|
-
};
|
1859
|
+
export declare type FileDownloadResponseModel = WithResponse<RawFileDownloadResponse, FileDownloadHeaders>;
|
1426
1860
|
|
1427
1861
|
/**
|
1428
1862
|
* Option interface for the {@link ShareFileClient.downloadToBuffer} operation.
|
@@ -1498,6 +1932,16 @@ export declare interface FileForceCloseHandlesHeaders {
|
|
1498
1932
|
errorCode?: string;
|
1499
1933
|
}
|
1500
1934
|
|
1935
|
+
/** Optional parameters. */
|
1936
|
+
declare interface FileForceCloseHandlesOptionalParams extends coreClient.OperationOptions {
|
1937
|
+
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN">Setting Timeouts for File Service Operations.</a> */
|
1938
|
+
timeoutInSeconds?: number;
|
1939
|
+
/** A string value that identifies the portion of the list to be returned with the next list operation. The operation returns a marker value within the response body if the list returned was not complete. The marker value may then be used in a subsequent call to request the next set of list items. The marker value is opaque to the client. */
|
1940
|
+
marker?: string;
|
1941
|
+
/** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
|
1942
|
+
shareSnapshot?: string;
|
1943
|
+
}
|
1944
|
+
|
1501
1945
|
/**
|
1502
1946
|
* Options to configure File - Force Close Handles operations.
|
1503
1947
|
*
|
@@ -1517,17 +1961,10 @@ export declare interface FileForceCloseHandlesOptions extends CommonOptions {
|
|
1517
1961
|
/**
|
1518
1962
|
* Response type for {@link ShareFileClient.forceCloseHandle}.
|
1519
1963
|
*/
|
1520
|
-
export declare type FileForceCloseHandlesResponse = CloseHandlesInfo & FileCloseHandlesHeaders
|
1521
|
-
|
1522
|
-
|
1523
|
-
|
1524
|
-
_response: HttpResponse & {
|
1525
|
-
/**
|
1526
|
-
* The parsed HTTP response headers.
|
1527
|
-
*/
|
1528
|
-
parsedHeaders: FileForceCloseHandlesHeaders;
|
1529
|
-
};
|
1530
|
-
};
|
1964
|
+
export declare type FileForceCloseHandlesResponse = WithResponse<CloseHandlesInfo & FileCloseHandlesHeaders, FileForceCloseHandlesHeaders>;
|
1965
|
+
|
1966
|
+
/** Contains response data for the forceCloseHandles operation. */
|
1967
|
+
declare type FileForceCloseHandlesResponse_2 = FileForceCloseHandlesHeaders;
|
1531
1968
|
|
1532
1969
|
/**
|
1533
1970
|
* Options to configure {@link ShareFileClient.generateSasUrl} operation.
|
@@ -1609,6 +2046,16 @@ export declare interface FileGetPropertiesHeaders {
|
|
1609
2046
|
errorCode?: string;
|
1610
2047
|
}
|
1611
2048
|
|
2049
|
+
/** Optional parameters. */
|
2050
|
+
declare interface FileGetPropertiesOptionalParams extends coreClient.OperationOptions {
|
2051
|
+
/** Parameter group */
|
2052
|
+
leaseAccessConditions?: LeaseAccessConditions;
|
2053
|
+
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN">Setting Timeouts for File Service Operations.</a> */
|
2054
|
+
timeoutInSeconds?: number;
|
2055
|
+
/** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
|
2056
|
+
shareSnapshot?: string;
|
2057
|
+
}
|
2058
|
+
|
1612
2059
|
/**
|
1613
2060
|
* Options to configure the {@link ShareFileClient.getProperties} operation.
|
1614
2061
|
*/
|
@@ -1625,26 +2072,13 @@ export declare interface FileGetPropertiesOptions extends CommonOptions {
|
|
1625
2072
|
}
|
1626
2073
|
|
1627
2074
|
/** Contains response data for the getProperties operation. */
|
1628
|
-
export declare type FileGetPropertiesResponse = FileGetPropertiesHeaders
|
1629
|
-
|
1630
|
-
|
1631
|
-
|
1632
|
-
parsedHeaders: FileGetPropertiesHeaders;
|
1633
|
-
};
|
1634
|
-
};
|
2075
|
+
export declare type FileGetPropertiesResponse = WithResponse<FileGetPropertiesHeaders, FileGetPropertiesHeaders>;
|
2076
|
+
|
2077
|
+
/** Contains response data for the getProperties operation. */
|
2078
|
+
declare type FileGetPropertiesResponse_2 = FileGetPropertiesHeaders;
|
1635
2079
|
|
1636
2080
|
/** Contains response data for the getRangeList operation. */
|
1637
|
-
export declare type FileGetRangeListDiffResponse = FileGetRangeListHeaders & ShareFileRangeList
|
1638
|
-
/** The underlying HTTP response. */
|
1639
|
-
_response: coreHttp.HttpResponse & {
|
1640
|
-
/** The response body as text (string format) */
|
1641
|
-
bodyAsText: string;
|
1642
|
-
/** The response body as parsed JSON or XML */
|
1643
|
-
parsedBody: ShareFileRangeList;
|
1644
|
-
/** The parsed HTTP response headers. */
|
1645
|
-
parsedHeaders: FileGetRangeListHeaders;
|
1646
|
-
};
|
1647
|
-
};
|
2081
|
+
export declare type FileGetRangeListDiffResponse = WithResponse<FileGetRangeListHeaders & ShareFileRangeList, FileGetRangeListHeaders, ShareFileRangeList>;
|
1648
2082
|
|
1649
2083
|
/** Defines headers for File_getRangeList operation. */
|
1650
2084
|
export declare interface FileGetRangeListHeaders {
|
@@ -1664,6 +2098,20 @@ export declare interface FileGetRangeListHeaders {
|
|
1664
2098
|
errorCode?: string;
|
1665
2099
|
}
|
1666
2100
|
|
2101
|
+
/** Optional parameters. */
|
2102
|
+
declare interface FileGetRangeListOptionalParams extends coreClient.OperationOptions {
|
2103
|
+
/** Parameter group */
|
2104
|
+
leaseAccessConditions?: LeaseAccessConditions;
|
2105
|
+
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN">Setting Timeouts for File Service Operations.</a> */
|
2106
|
+
timeoutInSeconds?: number;
|
2107
|
+
/** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
|
2108
|
+
shareSnapshot?: string;
|
2109
|
+
/** Specifies the range of bytes over which to list ranges, inclusively. */
|
2110
|
+
range?: string;
|
2111
|
+
/** The previous snapshot parameter is an opaque DateTime value that, when present, specifies the previous snapshot. */
|
2112
|
+
prevsharesnapshot?: string;
|
2113
|
+
}
|
2114
|
+
|
1667
2115
|
/**
|
1668
2116
|
* The option is defined as parity to REST definition.
|
1669
2117
|
* While it's not ready to be used now, considering Crc64 of source content is
|
@@ -1691,29 +2139,15 @@ export declare interface FileGetRangeListOptions extends CommonOptions {
|
|
1691
2139
|
/**
|
1692
2140
|
* Contains response data for the {@link ShareFileClient.getRangeList} operation.
|
1693
2141
|
*/
|
1694
|
-
export declare type FileGetRangeListResponse = FileGetRangeListHeaders & {
|
2142
|
+
export declare type FileGetRangeListResponse = WithResponse<FileGetRangeListHeaders & {
|
1695
2143
|
/**
|
1696
2144
|
* Range list for an Azure file.
|
1697
2145
|
*/
|
1698
2146
|
rangeList: RangeModel[];
|
1699
|
-
|
1700
|
-
|
1701
|
-
|
1702
|
-
|
1703
|
-
/**
|
1704
|
-
* The parsed HTTP response headers.
|
1705
|
-
*/
|
1706
|
-
parsedHeaders: FileGetRangeListHeaders;
|
1707
|
-
/**
|
1708
|
-
* The response body as text (string format)
|
1709
|
-
*/
|
1710
|
-
bodyAsText: string;
|
1711
|
-
/**
|
1712
|
-
* The response body as parsed JSON or XML
|
1713
|
-
*/
|
1714
|
-
parsedBody: RangeModel[];
|
1715
|
-
};
|
1716
|
-
};
|
2147
|
+
}, FileGetRangeListHeaders, RangeModel[]>;
|
2148
|
+
|
2149
|
+
/** Contains response data for the getRangeList operation. */
|
2150
|
+
declare type FileGetRangeListResponse_2 = FileGetRangeListHeaders & ShareFileRangeList;
|
1717
2151
|
|
1718
2152
|
export declare interface FileHttpHeaders {
|
1719
2153
|
/**
|
@@ -1753,6 +2187,22 @@ export declare interface FileHttpHeaders {
|
|
1753
2187
|
fileContentDisposition?: string;
|
1754
2188
|
}
|
1755
2189
|
|
2190
|
+
/** Parameter group */
|
2191
|
+
declare interface FileHttpHeaders_2 {
|
2192
|
+
/** Sets the MIME content type of the file. The default type is 'application/octet-stream'. */
|
2193
|
+
fileContentType?: string;
|
2194
|
+
/** Specifies which content encodings have been applied to the file. */
|
2195
|
+
fileContentEncoding?: string;
|
2196
|
+
/** Specifies the natural languages used by this resource. */
|
2197
|
+
fileContentLanguage?: string;
|
2198
|
+
/** Sets the file's cache control. The File service stores this value but does not use or modify it. */
|
2199
|
+
fileCacheControl?: string;
|
2200
|
+
/** Sets the file's MD5 hash. */
|
2201
|
+
fileContentMD5?: Uint8Array;
|
2202
|
+
/** Sets the file's Content-Disposition header. */
|
2203
|
+
fileContentDisposition?: string;
|
2204
|
+
}
|
2205
|
+
|
1756
2206
|
/** A listed file item. */
|
1757
2207
|
export declare interface FileItem {
|
1758
2208
|
name: string;
|
@@ -1780,6 +2230,18 @@ export declare interface FileListHandlesHeaders {
|
|
1780
2230
|
errorCode?: string;
|
1781
2231
|
}
|
1782
2232
|
|
2233
|
+
/** Optional parameters. */
|
2234
|
+
declare interface FileListHandlesOptionalParams extends coreClient.OperationOptions {
|
2235
|
+
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN">Setting Timeouts for File Service Operations.</a> */
|
2236
|
+
timeoutInSeconds?: number;
|
2237
|
+
/** A string value that identifies the portion of the list to be returned with the next list operation. The operation returns a marker value within the response body if the list returned was not complete. The marker value may then be used in a subsequent call to request the next set of list items. The marker value is opaque to the client. */
|
2238
|
+
marker?: string;
|
2239
|
+
/** Specifies the maximum number of entries to return. If the request does not specify maxresults, or specifies a value greater than 5,000, the server will return up to 5,000 items. */
|
2240
|
+
maxResults?: number;
|
2241
|
+
/** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
|
2242
|
+
shareSnapshot?: string;
|
2243
|
+
}
|
2244
|
+
|
1783
2245
|
export declare interface FileListHandlesOptions extends CommonOptions {
|
1784
2246
|
/**
|
1785
2247
|
* An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
|
@@ -1789,17 +2251,10 @@ export declare interface FileListHandlesOptions extends CommonOptions {
|
|
1789
2251
|
}
|
1790
2252
|
|
1791
2253
|
/** Contains response data for the listHandles operation. */
|
1792
|
-
export declare type FileListHandlesResponse = FileListHandlesHeaders & ListHandlesResponse
|
1793
|
-
|
1794
|
-
|
1795
|
-
|
1796
|
-
bodyAsText: string;
|
1797
|
-
/** The response body as parsed JSON or XML */
|
1798
|
-
parsedBody: ListHandlesResponse;
|
1799
|
-
/** The parsed HTTP response headers. */
|
1800
|
-
parsedHeaders: FileListHandlesHeaders;
|
1801
|
-
};
|
1802
|
-
};
|
2254
|
+
export declare type FileListHandlesResponse = WithResponse<FileListHandlesHeaders & ListHandlesResponse, FileListHandlesHeaders, ListHandlesResponse>;
|
2255
|
+
|
2256
|
+
/** Contains response data for the listHandles operation. */
|
2257
|
+
declare type FileListHandlesResponse_2 = FileListHandlesHeaders & ListHandlesResponse;
|
1803
2258
|
|
1804
2259
|
/**
|
1805
2260
|
* Options to configure File - List Handles Segment operations.
|
@@ -1901,6 +2356,36 @@ export declare interface FileProperty {
|
|
1901
2356
|
etag?: string;
|
1902
2357
|
}
|
1903
2358
|
|
2359
|
+
/** Defines values for FileRangeWriteType. */
|
2360
|
+
declare type FileRangeWriteType = "update" | "clear";
|
2361
|
+
|
2362
|
+
/** Defines headers for File_releaseLease operation. */
|
2363
|
+
declare interface FileReleaseLeaseHeaders {
|
2364
|
+
/** 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. */
|
2365
|
+
etag?: string;
|
2366
|
+
/** Returns the date and time the file was last modified. Any operation that modifies the file, including an update of the file's metadata or properties, changes the last-modified time of the file. */
|
2367
|
+
lastModified?: Date;
|
2368
|
+
/** If a client request id header is sent in the request, this header will be present in the response with the same value. */
|
2369
|
+
clientRequestId?: string;
|
2370
|
+
/** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
|
2371
|
+
requestId?: string;
|
2372
|
+
/** Indicates the version of the File service used to execute the request. */
|
2373
|
+
version?: string;
|
2374
|
+
/** UTC date/time value generated by the service that indicates the time at which the response was initiated */
|
2375
|
+
date?: Date;
|
2376
|
+
}
|
2377
|
+
|
2378
|
+
/** Optional parameters. */
|
2379
|
+
declare interface FileReleaseLeaseOptionalParams extends coreClient.OperationOptions {
|
2380
|
+
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN">Setting Timeouts for File Service Operations.</a> */
|
2381
|
+
timeoutInSeconds?: number;
|
2382
|
+
/** 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. */
|
2383
|
+
requestId?: string;
|
2384
|
+
}
|
2385
|
+
|
2386
|
+
/** Contains response data for the releaseLease operation. */
|
2387
|
+
declare type FileReleaseLeaseResponse = FileReleaseLeaseHeaders;
|
2388
|
+
|
1904
2389
|
/** Defines headers for File_rename operation. */
|
1905
2390
|
export declare interface FileRenameHeaders {
|
1906
2391
|
/** The ETag contains a value which represents the version of the file, in quotes. */
|
@@ -1931,6 +2416,32 @@ export declare interface FileRenameHeaders {
|
|
1931
2416
|
fileParentId?: string;
|
1932
2417
|
}
|
1933
2418
|
|
2419
|
+
/** Optional parameters. */
|
2420
|
+
declare interface FileRenameOptionalParams extends coreClient.OperationOptions {
|
2421
|
+
/** Parameter group */
|
2422
|
+
sourceLeaseAccessConditions?: SourceLeaseAccessConditions;
|
2423
|
+
/** Parameter group */
|
2424
|
+
destinationLeaseAccessConditions?: DestinationLeaseAccessConditions;
|
2425
|
+
/** Parameter group */
|
2426
|
+
copyFileSmbInfo?: CopyFileSmbInfo;
|
2427
|
+
/** Parameter group */
|
2428
|
+
fileHttpHeaders?: FileHttpHeaders_2;
|
2429
|
+
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN">Setting Timeouts for File Service Operations.</a> */
|
2430
|
+
timeoutInSeconds?: number;
|
2431
|
+
/** A name-value pair to associate with a file storage object. */
|
2432
|
+
metadata?: {
|
2433
|
+
[propertyName: string]: string;
|
2434
|
+
};
|
2435
|
+
/** If specified the permission (security descriptor) shall be set for the directory/file. This header can be used if Permission size is <= 8KB, else x-ms-file-permission-key header shall be used. Default value: Inherit. If SDDL is specified as input, it must have owner, group and dacl. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. */
|
2436
|
+
filePermission?: string;
|
2437
|
+
/** Key of the permission to be set for the directory/file. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. */
|
2438
|
+
filePermissionKey?: string;
|
2439
|
+
/** Optional. A boolean value for if the destination file already exists, whether this request will overwrite the file or not. If true, the rename will succeed and will overwrite the destination file. If not provided or if false and the destination file does exist, the request will not overwrite the destination file. If provided and the destination file doesn’t exist, the rename will succeed. Note: This value does not override the x-ms-file-copy-ignore-read-only header value. */
|
2440
|
+
replaceIfExists?: boolean;
|
2441
|
+
/** Optional. A boolean value that specifies whether the ReadOnly attribute on a preexisting destination file should be respected. If true, the rename will succeed, otherwise, a previous file at the destination with the ReadOnly attribute set will cause the rename to fail. */
|
2442
|
+
ignoreReadOnly?: boolean;
|
2443
|
+
}
|
2444
|
+
|
1934
2445
|
/**
|
1935
2446
|
* Options to configure the {@link ShareFileClient.rename} operation.
|
1936
2447
|
*/
|
@@ -1990,13 +2501,10 @@ export declare interface FileRenameOptions extends CommonOptions {
|
|
1990
2501
|
}
|
1991
2502
|
|
1992
2503
|
/** Contains response data for the rename operation. */
|
1993
|
-
export declare type FileRenameResponse = FileRenameHeaders
|
1994
|
-
|
1995
|
-
|
1996
|
-
|
1997
|
-
parsedHeaders: FileRenameHeaders;
|
1998
|
-
};
|
1999
|
-
};
|
2504
|
+
export declare type FileRenameResponse = WithResponse<FileRenameHeaders, FileRenameHeaders>;
|
2505
|
+
|
2506
|
+
/** Contains response data for the rename operation. */
|
2507
|
+
declare type FileRenameResponse_2 = FileRenameHeaders;
|
2000
2508
|
|
2001
2509
|
/**
|
2002
2510
|
* Options to configure the {@link ShareFileClient.resize} operation.
|
@@ -2174,6 +2682,28 @@ export declare interface FileSetHTTPHeadersHeaders {
|
|
2174
2682
|
errorCode?: string;
|
2175
2683
|
}
|
2176
2684
|
|
2685
|
+
/** Optional parameters. */
|
2686
|
+
declare interface FileSetHttpHeadersOptionalParams extends coreClient.OperationOptions {
|
2687
|
+
/** Parameter group */
|
2688
|
+
leaseAccessConditions?: LeaseAccessConditions;
|
2689
|
+
/** Parameter group */
|
2690
|
+
fileHttpHeaders?: FileHttpHeaders_2;
|
2691
|
+
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN">Setting Timeouts for File Service Operations.</a> */
|
2692
|
+
timeoutInSeconds?: number;
|
2693
|
+
/** If specified the permission (security descriptor) shall be set for the directory/file. This header can be used if Permission size is <= 8KB, else x-ms-file-permission-key header shall be used. Default value: Inherit. If SDDL is specified as input, it must have owner, group and dacl. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. */
|
2694
|
+
filePermission?: string;
|
2695
|
+
/** Key of the permission to be set for the directory/file. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. */
|
2696
|
+
filePermissionKey?: string;
|
2697
|
+
/** Creation time for the file/directory. Default value: Now. */
|
2698
|
+
fileCreatedOn?: string;
|
2699
|
+
/** Last write time for the file/directory. Default value: Now. */
|
2700
|
+
fileLastWriteOn?: string;
|
2701
|
+
/** Change time for the file/directory. Default value: Now. */
|
2702
|
+
fileChangeOn?: string;
|
2703
|
+
/** Resizes a file to the specified size. If the specified byte value is less than the current size of the file, then all ranges above the specified byte value are cleared. */
|
2704
|
+
fileContentLength?: number;
|
2705
|
+
}
|
2706
|
+
|
2177
2707
|
/**
|
2178
2708
|
* Options to configure the {@link ShareFileClient.setHttpHeaders} operation.
|
2179
2709
|
*/
|
@@ -2190,13 +2720,10 @@ export declare interface FileSetHttpHeadersOptions extends FileAndDirectorySetPr
|
|
2190
2720
|
}
|
2191
2721
|
|
2192
2722
|
/** Contains response data for the setHttpHeaders operation. */
|
2193
|
-
export declare type FileSetHTTPHeadersResponse = FileSetHTTPHeadersHeaders
|
2194
|
-
|
2195
|
-
|
2196
|
-
|
2197
|
-
parsedHeaders: FileSetHTTPHeadersHeaders;
|
2198
|
-
};
|
2199
|
-
};
|
2723
|
+
export declare type FileSetHTTPHeadersResponse = WithResponse<FileSetHTTPHeadersHeaders, FileSetHTTPHeadersHeaders>;
|
2724
|
+
|
2725
|
+
/** Contains response data for the setHttpHeaders operation. */
|
2726
|
+
declare type FileSetHttpHeadersResponse = FileSetHTTPHeadersHeaders;
|
2200
2727
|
|
2201
2728
|
/** Defines headers for File_setMetadata operation. */
|
2202
2729
|
export declare interface FileSetMetadataHeaders {
|
@@ -2214,6 +2741,18 @@ export declare interface FileSetMetadataHeaders {
|
|
2214
2741
|
errorCode?: string;
|
2215
2742
|
}
|
2216
2743
|
|
2744
|
+
/** Optional parameters. */
|
2745
|
+
declare interface FileSetMetadataOptionalParams extends coreClient.OperationOptions {
|
2746
|
+
/** Parameter group */
|
2747
|
+
leaseAccessConditions?: LeaseAccessConditions;
|
2748
|
+
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN">Setting Timeouts for File Service Operations.</a> */
|
2749
|
+
timeoutInSeconds?: number;
|
2750
|
+
/** A name-value pair to associate with a file storage object. */
|
2751
|
+
metadata?: {
|
2752
|
+
[propertyName: string]: string;
|
2753
|
+
};
|
2754
|
+
}
|
2755
|
+
|
2217
2756
|
/**
|
2218
2757
|
* Options to configure the {@link ShareFileClient.setMetadata} operation.
|
2219
2758
|
*/
|
@@ -2230,13 +2769,10 @@ export declare interface FileSetMetadataOptions extends CommonOptions {
|
|
2230
2769
|
}
|
2231
2770
|
|
2232
2771
|
/** Contains response data for the setMetadata operation. */
|
2233
|
-
export declare type FileSetMetadataResponse = FileSetMetadataHeaders
|
2234
|
-
|
2235
|
-
|
2236
|
-
|
2237
|
-
parsedHeaders: FileSetMetadataHeaders;
|
2238
|
-
};
|
2239
|
-
};
|
2772
|
+
export declare type FileSetMetadataResponse = WithResponse<FileSetMetadataHeaders, FileSetMetadataHeaders>;
|
2773
|
+
|
2774
|
+
/** Contains response data for the setMetadata operation. */
|
2775
|
+
declare type FileSetMetadataResponse_2 = FileSetMetadataHeaders;
|
2240
2776
|
|
2241
2777
|
/** Defines headers for File_startCopy operation. */
|
2242
2778
|
export declare interface FileStartCopyHeaders {
|
@@ -2258,11 +2794,29 @@ export declare interface FileStartCopyHeaders {
|
|
2258
2794
|
errorCode?: string;
|
2259
2795
|
}
|
2260
2796
|
|
2261
|
-
/**
|
2262
|
-
|
2263
|
-
*/
|
2264
|
-
|
2265
|
-
/**
|
2797
|
+
/** Optional parameters. */
|
2798
|
+
declare interface FileStartCopyOptionalParams extends coreClient.OperationOptions {
|
2799
|
+
/** Parameter group */
|
2800
|
+
leaseAccessConditions?: LeaseAccessConditions;
|
2801
|
+
/** Parameter group */
|
2802
|
+
copyFileSmbInfo?: CopyFileSmbInfo;
|
2803
|
+
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN">Setting Timeouts for File Service Operations.</a> */
|
2804
|
+
timeoutInSeconds?: number;
|
2805
|
+
/** A name-value pair to associate with a file storage object. */
|
2806
|
+
metadata?: {
|
2807
|
+
[propertyName: string]: string;
|
2808
|
+
};
|
2809
|
+
/** If specified the permission (security descriptor) shall be set for the directory/file. This header can be used if Permission size is <= 8KB, else x-ms-file-permission-key header shall be used. Default value: Inherit. If SDDL is specified as input, it must have owner, group and dacl. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. */
|
2810
|
+
filePermission?: string;
|
2811
|
+
/** Key of the permission to be set for the directory/file. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. */
|
2812
|
+
filePermissionKey?: string;
|
2813
|
+
}
|
2814
|
+
|
2815
|
+
/**
|
2816
|
+
* Options to configure the {@link ShareFileClient.startCopyFromURL} operation.
|
2817
|
+
*/
|
2818
|
+
export declare interface FileStartCopyOptions extends CommonOptions {
|
2819
|
+
/**
|
2266
2820
|
* An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
|
2267
2821
|
* For example, use the @azure/abort-controller to create an `AbortSignal`.
|
2268
2822
|
*/
|
@@ -2295,13 +2849,10 @@ export declare interface FileStartCopyOptions extends CommonOptions {
|
|
2295
2849
|
}
|
2296
2850
|
|
2297
2851
|
/** Contains response data for the startCopy operation. */
|
2298
|
-
export declare type FileStartCopyResponse = FileStartCopyHeaders
|
2299
|
-
|
2300
|
-
|
2301
|
-
|
2302
|
-
parsedHeaders: FileStartCopyHeaders;
|
2303
|
-
};
|
2304
|
-
};
|
2852
|
+
export declare type FileStartCopyResponse = WithResponse<FileStartCopyHeaders, FileStartCopyHeaders>;
|
2853
|
+
|
2854
|
+
/** Contains response data for the startCopy operation. */
|
2855
|
+
declare type FileStartCopyResponse_2 = FileStartCopyHeaders;
|
2305
2856
|
|
2306
2857
|
/**
|
2307
2858
|
* This is a helper class to construct a string representing the NTFS attributes to a file or directory.
|
@@ -2389,17 +2940,13 @@ export declare interface FileUploadRangeFromURLHeaders {
|
|
2389
2940
|
}
|
2390
2941
|
|
2391
2942
|
/** Optional parameters. */
|
2392
|
-
export declare interface FileUploadRangeFromURLOptionalParams extends
|
2943
|
+
export declare interface FileUploadRangeFromURLOptionalParams extends coreClient.OperationOptions {
|
2393
2944
|
/** Parameter group */
|
2394
2945
|
leaseAccessConditions?: LeaseAccessConditions;
|
2395
2946
|
/** Parameter group */
|
2396
2947
|
sourceModifiedAccessConditions?: SourceModifiedAccessConditions;
|
2397
2948
|
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN">Setting Timeouts for File Service Operations.</a> */
|
2398
2949
|
timeoutInSeconds?: number;
|
2399
|
-
/** If true, the trailing dot will not be trimmed from the target URI. */
|
2400
|
-
allowTrailingDot?: boolean;
|
2401
|
-
/** If true, the trailing dot will not be trimmed from the source URI. */
|
2402
|
-
allowSourceTrailingDot?: boolean;
|
2403
2950
|
/** If the file last write time should be preserved or overwritten */
|
2404
2951
|
fileLastWrittenMode?: FileLastWrittenMode;
|
2405
2952
|
/** Bytes of source data in the specified range. */
|
@@ -2451,13 +2998,10 @@ export declare interface FileUploadRangeFromURLOptions extends CommonOptions {
|
|
2451
2998
|
}
|
2452
2999
|
|
2453
3000
|
/** Contains response data for the uploadRangeFromURL operation. */
|
2454
|
-
export declare type FileUploadRangeFromURLResponse = FileUploadRangeFromURLHeaders
|
2455
|
-
|
2456
|
-
|
2457
|
-
|
2458
|
-
parsedHeaders: FileUploadRangeFromURLHeaders;
|
2459
|
-
};
|
2460
|
-
};
|
3001
|
+
export declare type FileUploadRangeFromURLResponse = WithResponse<FileUploadRangeFromURLHeaders, FileUploadRangeFromURLHeaders>;
|
3002
|
+
|
3003
|
+
/** Contains response data for the uploadRangeFromURL operation. */
|
3004
|
+
declare type FileUploadRangeFromURLResponse_2 = FileUploadRangeFromURLHeaders;
|
2461
3005
|
|
2462
3006
|
/** Defines headers for File_uploadRange operation. */
|
2463
3007
|
export declare interface FileUploadRangeHeaders {
|
@@ -2481,6 +3025,20 @@ export declare interface FileUploadRangeHeaders {
|
|
2481
3025
|
errorCode?: string;
|
2482
3026
|
}
|
2483
3027
|
|
3028
|
+
/** Optional parameters. */
|
3029
|
+
declare interface FileUploadRangeOptionalParams extends coreClient.OperationOptions {
|
3030
|
+
/** Parameter group */
|
3031
|
+
leaseAccessConditions?: LeaseAccessConditions;
|
3032
|
+
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN">Setting Timeouts for File Service Operations.</a> */
|
3033
|
+
timeoutInSeconds?: number;
|
3034
|
+
/** Initial data. */
|
3035
|
+
body?: coreRestPipeline.RequestBodyType;
|
3036
|
+
/** An MD5 hash of the content. This hash is used to verify the integrity of the data during transport. When the Content-MD5 header is specified, the File service compares the hash of the content that has arrived with the header value that was sent. If the two hashes do not match, the operation will fail with error code 400 (Bad Request). */
|
3037
|
+
contentMD5?: Uint8Array;
|
3038
|
+
/** If the file last write time should be preserved or overwritten */
|
3039
|
+
fileLastWrittenMode?: FileLastWrittenMode;
|
3040
|
+
}
|
3041
|
+
|
2484
3042
|
/**
|
2485
3043
|
* Options to configure the {@link ShareFileClient.uploadRange} operation.
|
2486
3044
|
*/
|
@@ -2517,13 +3075,10 @@ export declare interface FileUploadRangeOptions extends CommonOptions {
|
|
2517
3075
|
}
|
2518
3076
|
|
2519
3077
|
/** Contains response data for the uploadRange operation. */
|
2520
|
-
export declare type FileUploadRangeResponse = FileUploadRangeHeaders
|
2521
|
-
|
2522
|
-
|
2523
|
-
|
2524
|
-
parsedHeaders: FileUploadRangeHeaders;
|
2525
|
-
};
|
2526
|
-
};
|
3078
|
+
export declare type FileUploadRangeResponse = WithResponse<FileUploadRangeHeaders, FileUploadRangeHeaders>;
|
3079
|
+
|
3080
|
+
/** Contains response data for the uploadRange operation. */
|
3081
|
+
declare type FileUploadRangeResponse_2 = FileUploadRangeHeaders;
|
2527
3082
|
|
2528
3083
|
/**
|
2529
3084
|
* Option interface for ShareFileClient.uploadStream().
|
@@ -2599,7 +3154,6 @@ export declare interface HandleItem {
|
|
2599
3154
|
openTime: Date;
|
2600
3155
|
/** Time handle was last connected to (UTC) */
|
2601
3156
|
lastReconnectTime?: Date;
|
2602
|
-
accessRightList?: ShareFileHandleAccessRights[];
|
2603
3157
|
}
|
2604
3158
|
|
2605
3159
|
/**
|
@@ -2617,19 +3171,33 @@ export declare interface HttpAuthorization {
|
|
2617
3171
|
value: string;
|
2618
3172
|
}
|
2619
3173
|
|
2620
|
-
|
2621
|
-
|
2622
|
-
|
2623
|
-
|
2624
|
-
|
2625
|
-
|
2626
|
-
|
2627
|
-
|
2628
|
-
|
2629
|
-
|
2630
|
-
|
3174
|
+
/**
|
3175
|
+
* A representation of an HTTP response that
|
3176
|
+
* includes a reference to the request that
|
3177
|
+
* originated it.
|
3178
|
+
*/
|
3179
|
+
export declare interface HttpResponse {
|
3180
|
+
/**
|
3181
|
+
* The headers from the response.
|
3182
|
+
*/
|
3183
|
+
headers: HttpHeadersLike;
|
3184
|
+
/**
|
3185
|
+
* The original request that resulted in this response.
|
3186
|
+
*/
|
3187
|
+
request: WebResourceLike;
|
3188
|
+
/**
|
3189
|
+
* The HTTP status code returned from the service.
|
3190
|
+
*/
|
3191
|
+
status: number;
|
2631
3192
|
}
|
2632
3193
|
|
3194
|
+
/**
|
3195
|
+
* A helper to decide if a given argument satisfies the Pipeline contract
|
3196
|
+
* @param pipeline - An argument that may be a Pipeline
|
3197
|
+
* @returns true when the argument satisfies the Pipeline contract
|
3198
|
+
*/
|
3199
|
+
export declare function isPipelineLike(pipeline: unknown): pipeline is PipelineLike;
|
3200
|
+
|
2633
3201
|
/** Parameter group */
|
2634
3202
|
export declare interface LeaseAccessConditions {
|
2635
3203
|
/** If specified, the operation only succeeds if the resource's lease is active and matches this ID. */
|
@@ -2655,17 +3223,7 @@ export declare interface LeaseOperationOptions extends CommonOptions {
|
|
2655
3223
|
*
|
2656
3224
|
* See {@link ShareLeaseClient}.
|
2657
3225
|
*/
|
2658
|
-
export declare type LeaseOperationResponse = LeaseOperationResponseHeaders
|
2659
|
-
/**
|
2660
|
-
* The underlying HTTP response.
|
2661
|
-
*/
|
2662
|
-
_response: HttpResponse & {
|
2663
|
-
/**
|
2664
|
-
* The parsed HTTP response headers.
|
2665
|
-
*/
|
2666
|
-
parsedHeaders: LeaseOperationResponseHeaders;
|
2667
|
-
};
|
2668
|
-
};
|
3226
|
+
export declare type LeaseOperationResponse = WithResponse<LeaseOperationResponseHeaders, LeaseOperationResponseHeaders>;
|
2669
3227
|
|
2670
3228
|
/**
|
2671
3229
|
* The details of the response for a specific lease operation.
|
@@ -2729,6 +3287,9 @@ export declare interface ListFilesAndDirectoriesSegmentResponse {
|
|
2729
3287
|
directoryId?: string;
|
2730
3288
|
}
|
2731
3289
|
|
3290
|
+
/** Defines values for ListFilesIncludeType. */
|
3291
|
+
declare type ListFilesIncludeType = "Timestamps" | "Etag" | "Attributes" | "PermissionKey";
|
3292
|
+
|
2732
3293
|
/** An enumeration of handles. */
|
2733
3294
|
export declare interface ListHandlesResponse {
|
2734
3295
|
handleList?: HandleItem[];
|
@@ -2782,13 +3343,13 @@ export declare interface Metrics {
|
|
2782
3343
|
}
|
2783
3344
|
|
2784
3345
|
/**
|
2785
|
-
* Creates a new
|
3346
|
+
* Creates a new Pipeline object with Credential provided.
|
2786
3347
|
*
|
2787
|
-
* @param credential -
|
3348
|
+
* @param credential - Such as AnonymousCredential, StorageSharedKeyCredential or any credential from the `@azure/identity` package to authenticate requests to the service. You can also provide an object that implements the TokenCredential interface. If not specified, AnonymousCredential is used.
|
2788
3349
|
* @param pipelineOptions - Optional. Options.
|
2789
3350
|
* @returns A new Pipeline object.
|
2790
3351
|
*/
|
2791
|
-
export declare function newPipeline(credential?:
|
3352
|
+
export declare function newPipeline(credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, pipelineOptions?: StoragePipelineOptions): Pipeline;
|
2792
3353
|
|
2793
3354
|
/** Defines values for PermissionCopyModeType. */
|
2794
3355
|
export declare type PermissionCopyModeType = "source" | "override";
|
@@ -2798,10 +3359,10 @@ export declare type PermissionCopyModeType = "source" | "override";
|
|
2798
3359
|
* You can create a default Pipeline by calling {@link newPipeline}.
|
2799
3360
|
* Or you can create a Pipeline with your own policies by the constructor of Pipeline.
|
2800
3361
|
*
|
2801
|
-
* Refer to {@link newPipeline} and provided policies
|
2802
|
-
*
|
3362
|
+
* Refer to {@link newPipeline} and provided policies before implementing your
|
3363
|
+
* customized Pipeline.
|
2803
3364
|
*/
|
2804
|
-
export declare class Pipeline {
|
3365
|
+
export declare class Pipeline implements PipelineLike {
|
2805
3366
|
/**
|
2806
3367
|
* A list of chained request policy factories.
|
2807
3368
|
*/
|
@@ -2818,7 +3379,33 @@ export declare class Pipeline {
|
|
2818
3379
|
*/
|
2819
3380
|
constructor(factories: RequestPolicyFactory[], options?: PipelineOptions);
|
2820
3381
|
/**
|
2821
|
-
* Transfer Pipeline object to ServiceClientOptions object which required by
|
3382
|
+
* Transfer Pipeline object to ServiceClientOptions object which is required by
|
3383
|
+
* ServiceClient constructor.
|
3384
|
+
*
|
3385
|
+
* @returns The ServiceClientOptions object from this Pipeline.
|
3386
|
+
*/
|
3387
|
+
toServiceClientOptions(): ServiceClientOptions;
|
3388
|
+
}
|
3389
|
+
|
3390
|
+
/**
|
3391
|
+
* An interface for the {@link Pipeline} class containing HTTP request policies.
|
3392
|
+
* You can create a default Pipeline by calling {@link newPipeline}.
|
3393
|
+
* Or you can create a Pipeline with your own policies by the constructor of Pipeline.
|
3394
|
+
*
|
3395
|
+
* Refer to {@link newPipeline} and provided policies before implementing your
|
3396
|
+
* customized Pipeline.
|
3397
|
+
*/
|
3398
|
+
export declare interface PipelineLike {
|
3399
|
+
/**
|
3400
|
+
* A list of chained request policy factories.
|
3401
|
+
*/
|
3402
|
+
readonly factories: RequestPolicyFactory[];
|
3403
|
+
/**
|
3404
|
+
* Configures pipeline logger and HTTP client.
|
3405
|
+
*/
|
3406
|
+
readonly options: PipelineOptions;
|
3407
|
+
/**
|
3408
|
+
* Transfer Pipeline object to ServiceClientOptions object which is required by
|
2822
3409
|
* ServiceClient constructor.
|
2823
3410
|
*
|
2824
3411
|
* @returns The ServiceClientOptions object from this Pipeline.
|
@@ -2833,11 +3420,7 @@ export declare interface PipelineOptions {
|
|
2833
3420
|
/**
|
2834
3421
|
* Optional. Configures the HTTP client to send requests and receive responses.
|
2835
3422
|
*/
|
2836
|
-
httpClient?:
|
2837
|
-
/**
|
2838
|
-
* Intent of using TokenCredential in file requests.
|
2839
|
-
*/
|
2840
|
-
shareTokenIntent?: ShareTokenIntent;
|
3423
|
+
httpClient?: RequestPolicy;
|
2841
3424
|
}
|
2842
3425
|
|
2843
3426
|
/**
|
@@ -2865,11 +3448,73 @@ export declare interface RangeModel {
|
|
2865
3448
|
end: number;
|
2866
3449
|
}
|
2867
3450
|
|
2868
|
-
|
3451
|
+
/** Contains response data for the download operation. */
|
3452
|
+
export declare type RawFileDownloadResponse = FileDownloadHeaders & {
|
3453
|
+
/**
|
3454
|
+
* BROWSER ONLY
|
3455
|
+
*
|
3456
|
+
* The response body as a browser Blob.
|
3457
|
+
* Always `undefined` in node.js.
|
3458
|
+
*/
|
3459
|
+
blobBody?: Promise<Blob>;
|
3460
|
+
/**
|
3461
|
+
* NODEJS ONLY
|
3462
|
+
*
|
3463
|
+
* The response body as a node.js Readable stream.
|
3464
|
+
* Always `undefined` in the browser.
|
3465
|
+
*/
|
3466
|
+
readableStreamBody?: NodeJS.ReadableStream;
|
3467
|
+
};
|
2869
3468
|
|
2870
|
-
|
3469
|
+
/**
|
3470
|
+
* An object with a simple _response property.
|
3471
|
+
*/
|
3472
|
+
export declare interface ResponseLike {
|
3473
|
+
/**
|
3474
|
+
* The underlying HTTP response.
|
3475
|
+
*/
|
3476
|
+
_response: HttpResponse;
|
3477
|
+
}
|
2871
3478
|
|
2872
|
-
|
3479
|
+
/**
|
3480
|
+
* An object with a _response property that has body
|
3481
|
+
* and headers already parsed into known types.
|
3482
|
+
*/
|
3483
|
+
export declare interface ResponseWithBody<Headers, Body> {
|
3484
|
+
/**
|
3485
|
+
* The underlying HTTP response.
|
3486
|
+
*/
|
3487
|
+
_response: HttpResponse & {
|
3488
|
+
/**
|
3489
|
+
* The parsed HTTP response headers.
|
3490
|
+
*/
|
3491
|
+
parsedHeaders: Headers;
|
3492
|
+
/**
|
3493
|
+
* The response body as text (string format)
|
3494
|
+
*/
|
3495
|
+
bodyAsText: string;
|
3496
|
+
/**
|
3497
|
+
* The response body as parsed JSON or XML
|
3498
|
+
*/
|
3499
|
+
parsedBody: Body;
|
3500
|
+
};
|
3501
|
+
}
|
3502
|
+
|
3503
|
+
/**
|
3504
|
+
* An object with a _response property that has
|
3505
|
+
* headers already parsed into a typed object.
|
3506
|
+
*/
|
3507
|
+
export declare interface ResponseWithHeaders<Headers> {
|
3508
|
+
/**
|
3509
|
+
* The underlying HTTP response.
|
3510
|
+
*/
|
3511
|
+
_response: HttpResponse & {
|
3512
|
+
/**
|
3513
|
+
* The parsed HTTP response headers.
|
3514
|
+
*/
|
3515
|
+
parsedHeaders: Headers;
|
3516
|
+
};
|
3517
|
+
}
|
2873
3518
|
|
2874
3519
|
export { RestError }
|
2875
3520
|
|
@@ -3033,6 +3678,43 @@ export declare class SASQueryParameters {
|
|
3033
3678
|
private tryAppendQueryParameter;
|
3034
3679
|
}
|
3035
3680
|
|
3681
|
+
/** Interface representing a Service. */
|
3682
|
+
declare interface Service {
|
3683
|
+
/**
|
3684
|
+
* Sets properties for a storage account's File service endpoint, including properties for Storage
|
3685
|
+
* Analytics metrics and CORS (Cross-Origin Resource Sharing) rules.
|
3686
|
+
* @param properties The StorageService properties.
|
3687
|
+
* @param options The options parameters.
|
3688
|
+
*/
|
3689
|
+
setProperties(properties: FileServiceProperties, options?: ServiceSetPropertiesOptionalParams): Promise<ServiceSetPropertiesResponse_2>;
|
3690
|
+
/**
|
3691
|
+
* Gets the properties of a storage account's File service, including properties for Storage Analytics
|
3692
|
+
* metrics and CORS (Cross-Origin Resource Sharing) rules.
|
3693
|
+
* @param options The options parameters.
|
3694
|
+
*/
|
3695
|
+
getProperties(options?: ServiceGetPropertiesOptionalParams): Promise<ServiceGetPropertiesResponse_2>;
|
3696
|
+
/**
|
3697
|
+
* The List Shares Segment operation returns a list of the shares and share snapshots under the
|
3698
|
+
* specified account.
|
3699
|
+
* @param options The options parameters.
|
3700
|
+
*/
|
3701
|
+
listSharesSegment(options?: ServiceListSharesSegmentOptionalParams): Promise<ServiceListSharesSegmentResponse_2>;
|
3702
|
+
}
|
3703
|
+
|
3704
|
+
/**
|
3705
|
+
* A subset of `@azure/core-http` ServiceClientOptions
|
3706
|
+
*/
|
3707
|
+
export declare interface ServiceClientOptions {
|
3708
|
+
/**
|
3709
|
+
* Optional. Configures the HTTP client to send requests and receive responses.
|
3710
|
+
*/
|
3711
|
+
httpClient?: RequestPolicy;
|
3712
|
+
/**
|
3713
|
+
* Optional. Overrides the default policy factories.
|
3714
|
+
*/
|
3715
|
+
requestPolicyFactories?: RequestPolicyFactory[] | ((defaultRequestPolicyFactories: RequestPolicyFactory[]) => void | RequestPolicyFactory[]);
|
3716
|
+
}
|
3717
|
+
|
3036
3718
|
/**
|
3037
3719
|
* Options to configure {@link ShareServiceClient.generateAccountSasUrl} operation.
|
3038
3720
|
*/
|
@@ -3066,6 +3748,12 @@ export declare interface ServiceGetPropertiesHeaders {
|
|
3066
3748
|
errorCode?: string;
|
3067
3749
|
}
|
3068
3750
|
|
3751
|
+
/** Optional parameters. */
|
3752
|
+
declare interface ServiceGetPropertiesOptionalParams extends coreClient.OperationOptions {
|
3753
|
+
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN">Setting Timeouts for File Service Operations.</a> */
|
3754
|
+
timeoutInSeconds?: number;
|
3755
|
+
}
|
3756
|
+
|
3069
3757
|
/**
|
3070
3758
|
* Options to configure the {@link ShareServiceClient.getProperties} operation.
|
3071
3759
|
*/
|
@@ -3078,17 +3766,10 @@ export declare interface ServiceGetPropertiesOptions extends CommonOptions {
|
|
3078
3766
|
}
|
3079
3767
|
|
3080
3768
|
/** Contains response data for the getProperties operation. */
|
3081
|
-
export declare type ServiceGetPropertiesResponse = ServiceGetPropertiesHeaders & FileServiceProperties
|
3082
|
-
|
3083
|
-
|
3084
|
-
|
3085
|
-
bodyAsText: string;
|
3086
|
-
/** The response body as parsed JSON or XML */
|
3087
|
-
parsedBody: FileServiceProperties;
|
3088
|
-
/** The parsed HTTP response headers. */
|
3089
|
-
parsedHeaders: ServiceGetPropertiesHeaders;
|
3090
|
-
};
|
3091
|
-
};
|
3769
|
+
export declare type ServiceGetPropertiesResponse = WithResponse<ServiceGetPropertiesHeaders & FileServiceProperties, ServiceGetPropertiesHeaders, FileServiceProperties>;
|
3770
|
+
|
3771
|
+
/** Contains response data for the getProperties operation. */
|
3772
|
+
declare type ServiceGetPropertiesResponse_2 = ServiceGetPropertiesHeaders & FileServiceProperties;
|
3092
3773
|
|
3093
3774
|
/**
|
3094
3775
|
* Options to configure the {@link ShareServiceClient.listShares} operation.
|
@@ -3128,28 +3809,27 @@ export declare interface ServiceListSharesSegmentHeaders {
|
|
3128
3809
|
errorCode?: string;
|
3129
3810
|
}
|
3130
3811
|
|
3812
|
+
/** Optional parameters. */
|
3813
|
+
declare interface ServiceListSharesSegmentOptionalParams extends coreClient.OperationOptions {
|
3814
|
+
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN">Setting Timeouts for File Service Operations.</a> */
|
3815
|
+
timeoutInSeconds?: number;
|
3816
|
+
/** Filters the results to return only entries whose name begins with the specified prefix. */
|
3817
|
+
prefix?: string;
|
3818
|
+
/** A string value that identifies the portion of the list to be returned with the next list operation. The operation returns a marker value within the response body if the list returned was not complete. The marker value may then be used in a subsequent call to request the next set of list items. The marker value is opaque to the client. */
|
3819
|
+
marker?: string;
|
3820
|
+
/** Specifies the maximum number of entries to return. If the request does not specify maxresults, or specifies a value greater than 5,000, the server will return up to 5,000 items. */
|
3821
|
+
maxResults?: number;
|
3822
|
+
/** Include this parameter to specify one or more datasets to include in the response. */
|
3823
|
+
include?: ListSharesIncludeType[];
|
3824
|
+
}
|
3825
|
+
|
3131
3826
|
/**
|
3132
3827
|
* Contains response data for the {@link ShareServiceClient.listShares} operation.
|
3133
3828
|
*/
|
3134
|
-
export declare type ServiceListSharesSegmentResponse = ListSharesResponse & ServiceListSharesSegmentHeaders
|
3135
|
-
|
3136
|
-
|
3137
|
-
|
3138
|
-
_response: HttpResponse & {
|
3139
|
-
/**
|
3140
|
-
* The parsed HTTP response headers.
|
3141
|
-
*/
|
3142
|
-
parsedHeaders: ServiceListSharesSegmentHeaders;
|
3143
|
-
/**
|
3144
|
-
* The response body as text (string format)
|
3145
|
-
*/
|
3146
|
-
bodyAsText: string;
|
3147
|
-
/**
|
3148
|
-
* The response body as parsed JSON or XML
|
3149
|
-
*/
|
3150
|
-
parsedBody: ListSharesResponseModel;
|
3151
|
-
};
|
3152
|
-
};
|
3829
|
+
export declare type ServiceListSharesSegmentResponse = WithResponse<ListSharesResponse & ServiceListSharesSegmentHeaders, ServiceListSharesSegmentHeaders, ListSharesResponseModel>;
|
3830
|
+
|
3831
|
+
/** Contains response data for the listSharesSegment operation. */
|
3832
|
+
declare type ServiceListSharesSegmentResponse_2 = ServiceListSharesSegmentHeaders & ListSharesResponseModel;
|
3153
3833
|
|
3154
3834
|
/** Defines headers for Service_setProperties operation. */
|
3155
3835
|
export declare interface ServiceSetPropertiesHeaders {
|
@@ -3161,6 +3841,12 @@ export declare interface ServiceSetPropertiesHeaders {
|
|
3161
3841
|
errorCode?: string;
|
3162
3842
|
}
|
3163
3843
|
|
3844
|
+
/** Optional parameters. */
|
3845
|
+
declare interface ServiceSetPropertiesOptionalParams extends coreClient.OperationOptions {
|
3846
|
+
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN">Setting Timeouts for File Service Operations.</a> */
|
3847
|
+
timeoutInSeconds?: number;
|
3848
|
+
}
|
3849
|
+
|
3164
3850
|
/**
|
3165
3851
|
* Options to configure the {@link ShareServiceClient.setProperties} operation.
|
3166
3852
|
*/
|
@@ -3173,13 +3859,10 @@ export declare interface ServiceSetPropertiesOptions extends CommonOptions {
|
|
3173
3859
|
}
|
3174
3860
|
|
3175
3861
|
/** Contains response data for the setProperties operation. */
|
3176
|
-
export declare type ServiceSetPropertiesResponse = ServiceSetPropertiesHeaders
|
3177
|
-
|
3178
|
-
|
3179
|
-
|
3180
|
-
parsedHeaders: ServiceSetPropertiesHeaders;
|
3181
|
-
};
|
3182
|
-
};
|
3862
|
+
export declare type ServiceSetPropertiesResponse = WithResponse<ServiceSetPropertiesHeaders, ServiceSetPropertiesHeaders>;
|
3863
|
+
|
3864
|
+
/** Contains response data for the setProperties operation. */
|
3865
|
+
declare type ServiceSetPropertiesResponse_2 = ServiceSetPropertiesHeaders;
|
3183
3866
|
|
3184
3867
|
/**
|
3185
3868
|
* Options to configure the {@link ShareServiceClient.undelete} operation.
|
@@ -3192,11 +3875,218 @@ export declare interface ServiceUndeleteShareOptions extends CommonOptions {
|
|
3192
3875
|
abortSignal?: AbortSignalLike;
|
3193
3876
|
}
|
3194
3877
|
|
3195
|
-
export declare interface SetPropertiesResponse extends FileSetHTTPHeadersResponse {
|
3878
|
+
export declare interface SetPropertiesResponse extends FileSetHTTPHeadersResponse {
|
3879
|
+
}
|
3880
|
+
|
3881
|
+
/** Interface representing a Share. */
|
3882
|
+
declare interface Share {
|
3883
|
+
/**
|
3884
|
+
* Creates a new share under the specified account. If the share with the same name already exists, the
|
3885
|
+
* operation fails.
|
3886
|
+
* @param options The options parameters.
|
3887
|
+
*/
|
3888
|
+
create(options?: ShareCreateOptionalParams): Promise<ShareCreateResponse_2>;
|
3889
|
+
/**
|
3890
|
+
* Returns all user-defined metadata and system properties for the specified share or share snapshot.
|
3891
|
+
* The data returned does not include the share's list of files.
|
3892
|
+
* @param options The options parameters.
|
3893
|
+
*/
|
3894
|
+
getProperties(options?: ShareGetPropertiesOptionalParams): Promise<ShareGetPropertiesResponse_2>;
|
3895
|
+
/**
|
3896
|
+
* Operation marks the specified share or share snapshot for deletion. The share or share snapshot and
|
3897
|
+
* any files contained within it are later deleted during garbage collection.
|
3898
|
+
* @param options The options parameters.
|
3899
|
+
*/
|
3900
|
+
delete(options?: ShareDeleteOptionalParams): Promise<ShareDeleteResponse_2>;
|
3901
|
+
/**
|
3902
|
+
* The Lease Share operation establishes and manages a lock on a share, or the specified snapshot for
|
3903
|
+
* set and delete share operations.
|
3904
|
+
* @param options The options parameters.
|
3905
|
+
*/
|
3906
|
+
acquireLease(options?: ShareAcquireLeaseOptionalParams): Promise<ShareAcquireLeaseResponse>;
|
3907
|
+
/**
|
3908
|
+
* The Lease Share operation establishes and manages a lock on a share, or the specified snapshot for
|
3909
|
+
* set and delete share operations.
|
3910
|
+
* @param leaseId Specifies the current lease ID on the resource.
|
3911
|
+
* @param options The options parameters.
|
3912
|
+
*/
|
3913
|
+
releaseLease(leaseId: string, options?: ShareReleaseLeaseOptionalParams): Promise<ShareReleaseLeaseResponse>;
|
3914
|
+
/**
|
3915
|
+
* The Lease Share operation establishes and manages a lock on a share, or the specified snapshot for
|
3916
|
+
* set and delete share operations.
|
3917
|
+
* @param leaseId Specifies the current lease ID on the resource.
|
3918
|
+
* @param options The options parameters.
|
3919
|
+
*/
|
3920
|
+
changeLease(leaseId: string, options?: ShareChangeLeaseOptionalParams): Promise<ShareChangeLeaseResponse>;
|
3921
|
+
/**
|
3922
|
+
* The Lease Share operation establishes and manages a lock on a share, or the specified snapshot for
|
3923
|
+
* set and delete share operations.
|
3924
|
+
* @param leaseId Specifies the current lease ID on the resource.
|
3925
|
+
* @param options The options parameters.
|
3926
|
+
*/
|
3927
|
+
renewLease(leaseId: string, options?: ShareRenewLeaseOptionalParams): Promise<ShareRenewLeaseResponse>;
|
3928
|
+
/**
|
3929
|
+
* The Lease Share operation establishes and manages a lock on a share, or the specified snapshot for
|
3930
|
+
* set and delete share operations.
|
3931
|
+
* @param options The options parameters.
|
3932
|
+
*/
|
3933
|
+
breakLease(options?: ShareBreakLeaseOptionalParams): Promise<ShareBreakLeaseResponse>;
|
3934
|
+
/**
|
3935
|
+
* Creates a read-only snapshot of a share.
|
3936
|
+
* @param options The options parameters.
|
3937
|
+
*/
|
3938
|
+
createSnapshot(options?: ShareCreateSnapshotOptionalParams): Promise<ShareCreateSnapshotResponse_2>;
|
3939
|
+
/**
|
3940
|
+
* Create a permission (a security descriptor).
|
3941
|
+
* @param sharePermission A permission (a security descriptor) at the share level.
|
3942
|
+
* @param options The options parameters.
|
3943
|
+
*/
|
3944
|
+
createPermission(sharePermission: SharePermission, options?: ShareCreatePermissionOptionalParams): Promise<ShareCreatePermissionResponse_2>;
|
3945
|
+
/**
|
3946
|
+
* Returns the permission (security descriptor) for a given key
|
3947
|
+
* @param filePermissionKey Key of the permission to be set for the directory/file.
|
3948
|
+
* @param options The options parameters.
|
3949
|
+
*/
|
3950
|
+
getPermission(filePermissionKey: string, options?: ShareGetPermissionOptionalParams): Promise<ShareGetPermissionResponse_2>;
|
3951
|
+
/**
|
3952
|
+
* Sets properties for the specified share.
|
3953
|
+
* @param options The options parameters.
|
3954
|
+
*/
|
3955
|
+
setProperties(options?: ShareSetPropertiesOptionalParams): Promise<ShareSetPropertiesResponse_2>;
|
3956
|
+
/**
|
3957
|
+
* Sets one or more user-defined name-value pairs for the specified share.
|
3958
|
+
* @param options The options parameters.
|
3959
|
+
*/
|
3960
|
+
setMetadata(options?: ShareSetMetadataOptionalParams): Promise<ShareSetMetadataResponse_2>;
|
3961
|
+
/**
|
3962
|
+
* Returns information about stored access policies specified on the share.
|
3963
|
+
* @param options The options parameters.
|
3964
|
+
*/
|
3965
|
+
getAccessPolicy(options?: ShareGetAccessPolicyOptionalParams): Promise<ShareGetAccessPolicyResponse_2>;
|
3966
|
+
/**
|
3967
|
+
* Sets a stored access policy for use with shared access signatures.
|
3968
|
+
* @param options The options parameters.
|
3969
|
+
*/
|
3970
|
+
setAccessPolicy(options?: ShareSetAccessPolicyOptionalParams): Promise<ShareSetAccessPolicyResponse_2>;
|
3971
|
+
/**
|
3972
|
+
* Retrieves statistics related to the share.
|
3973
|
+
* @param options The options parameters.
|
3974
|
+
*/
|
3975
|
+
getStatistics(options?: ShareGetStatisticsOptionalParams): Promise<ShareGetStatisticsResponse_2>;
|
3976
|
+
/**
|
3977
|
+
* Restores a previously deleted Share.
|
3978
|
+
* @param options The options parameters.
|
3979
|
+
*/
|
3980
|
+
restore(options?: ShareRestoreOptionalParams): Promise<ShareRestoreResponse>;
|
3981
|
+
}
|
3982
|
+
|
3983
|
+
/** Defines values for ShareAccessTier. */
|
3984
|
+
export declare type ShareAccessTier = "TransactionOptimized" | "Hot" | "Cool";
|
3985
|
+
|
3986
|
+
/** Defines headers for Share_acquireLease operation. */
|
3987
|
+
declare interface ShareAcquireLeaseHeaders {
|
3988
|
+
/** The ETag contains a value that you can use to perform operations conditionally, in quotes. */
|
3989
|
+
etag?: string;
|
3990
|
+
/** Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share. */
|
3991
|
+
lastModified?: Date;
|
3992
|
+
/** Uniquely identifies a share's lease */
|
3993
|
+
leaseId?: string;
|
3994
|
+
/** If a client request id header is sent in the request, this header will be present in the response with the same value. */
|
3995
|
+
clientRequestId?: string;
|
3996
|
+
/** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
|
3997
|
+
requestId?: string;
|
3998
|
+
/** Indicates the version of the File service used to execute the request. */
|
3999
|
+
version?: string;
|
4000
|
+
/** UTC date/time value generated by the service that indicates the time at which the response was initiated */
|
4001
|
+
date?: Date;
|
4002
|
+
}
|
4003
|
+
|
4004
|
+
/** Optional parameters. */
|
4005
|
+
declare interface ShareAcquireLeaseOptionalParams extends coreClient.OperationOptions {
|
4006
|
+
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN">Setting Timeouts for File Service Operations.</a> */
|
4007
|
+
timeoutInSeconds?: number;
|
4008
|
+
/** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
|
4009
|
+
shareSnapshot?: string;
|
4010
|
+
/** Specifies the duration of the lease, in seconds, or negative one (-1) for a lease that never expires. A non-infinite lease can be between 15 and 60 seconds. A lease duration cannot be changed using renew or change. */
|
4011
|
+
duration?: number;
|
4012
|
+
/** Proposed lease ID, in a GUID string format. The File 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. */
|
4013
|
+
proposedLeaseId?: string;
|
4014
|
+
/** 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. */
|
4015
|
+
requestId?: string;
|
4016
|
+
}
|
4017
|
+
|
4018
|
+
/** Contains response data for the acquireLease operation. */
|
4019
|
+
declare type ShareAcquireLeaseResponse = ShareAcquireLeaseHeaders;
|
4020
|
+
|
4021
|
+
/** Defines headers for Share_breakLease operation. */
|
4022
|
+
declare interface ShareBreakLeaseHeaders {
|
4023
|
+
/** The ETag contains a value that you can use to perform operations conditionally, in quotes. */
|
4024
|
+
etag?: string;
|
4025
|
+
/** Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share. */
|
4026
|
+
lastModified?: Date;
|
4027
|
+
/** Approximate time remaining in the lease period, in seconds. */
|
4028
|
+
leaseTimeInSeconds?: number;
|
4029
|
+
/** Uniquely identifies a share's lease */
|
4030
|
+
leaseId?: string;
|
4031
|
+
/** If a client request id header is sent in the request, this header will be present in the response with the same value. */
|
4032
|
+
clientRequestId?: string;
|
4033
|
+
/** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
|
4034
|
+
requestId?: string;
|
4035
|
+
/** Indicates the version of the File service used to execute the request. */
|
4036
|
+
version?: string;
|
4037
|
+
/** UTC date/time value generated by the service that indicates the time at which the response was initiated */
|
4038
|
+
date?: Date;
|
4039
|
+
}
|
4040
|
+
|
4041
|
+
/** Optional parameters. */
|
4042
|
+
declare interface ShareBreakLeaseOptionalParams extends coreClient.OperationOptions {
|
4043
|
+
/** Parameter group */
|
4044
|
+
leaseAccessConditions?: LeaseAccessConditions;
|
4045
|
+
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN">Setting Timeouts for File Service Operations.</a> */
|
4046
|
+
timeoutInSeconds?: number;
|
4047
|
+
/** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
|
4048
|
+
shareSnapshot?: string;
|
4049
|
+
/** 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. */
|
4050
|
+
requestId?: string;
|
4051
|
+
/** For a break operation, proposed duration the lease should continue before it is broken, in seconds, between 0 and 60. This break period is only used if it is shorter than the time remaining on the lease. If longer, the time remaining on the lease is used. A new lease will not be available before the break period has expired, but the lease may be held for longer than the break period. If this header does not appear with a break operation, a fixed-duration lease breaks after the remaining lease period elapses, and an infinite lease breaks immediately. */
|
4052
|
+
breakPeriod?: number;
|
4053
|
+
}
|
4054
|
+
|
4055
|
+
/** Contains response data for the breakLease operation. */
|
4056
|
+
declare type ShareBreakLeaseResponse = ShareBreakLeaseHeaders;
|
4057
|
+
|
4058
|
+
/** Defines headers for Share_changeLease operation. */
|
4059
|
+
declare interface ShareChangeLeaseHeaders {
|
4060
|
+
/** The ETag contains a value that you can use to perform operations conditionally, in quotes. */
|
4061
|
+
etag?: string;
|
4062
|
+
/** Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share. */
|
4063
|
+
lastModified?: Date;
|
4064
|
+
/** Uniquely identifies a share's lease */
|
4065
|
+
leaseId?: string;
|
4066
|
+
/** If a client request id header is sent in the request, this header will be present in the response with the same value. */
|
4067
|
+
clientRequestId?: string;
|
4068
|
+
/** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
|
4069
|
+
requestId?: string;
|
4070
|
+
/** Indicates the version of the File service used to execute the request. */
|
4071
|
+
version?: string;
|
4072
|
+
/** UTC date/time value generated by the service that indicates the time at which the response was initiated */
|
4073
|
+
date?: Date;
|
3196
4074
|
}
|
3197
4075
|
|
3198
|
-
/**
|
3199
|
-
|
4076
|
+
/** Optional parameters. */
|
4077
|
+
declare interface ShareChangeLeaseOptionalParams extends coreClient.OperationOptions {
|
4078
|
+
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN">Setting Timeouts for File Service Operations.</a> */
|
4079
|
+
timeoutInSeconds?: number;
|
4080
|
+
/** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
|
4081
|
+
shareSnapshot?: string;
|
4082
|
+
/** Proposed lease ID, in a GUID string format. The File 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. */
|
4083
|
+
proposedLeaseId?: string;
|
4084
|
+
/** 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. */
|
4085
|
+
requestId?: string;
|
4086
|
+
}
|
4087
|
+
|
4088
|
+
/** Contains response data for the changeLease operation. */
|
4089
|
+
declare type ShareChangeLeaseResponse = ShareChangeLeaseHeaders;
|
3200
4090
|
|
3201
4091
|
/**
|
3202
4092
|
* A ShareClient represents a URL to the Azure Storage share allowing you to manipulate its directories and files.
|
@@ -3207,7 +4097,6 @@ export declare class ShareClient extends StorageClient {
|
|
3207
4097
|
*/
|
3208
4098
|
private context;
|
3209
4099
|
private _name;
|
3210
|
-
private shareClientConfig?;
|
3211
4100
|
/**
|
3212
4101
|
* The name of the share
|
3213
4102
|
*/
|
@@ -3222,7 +4111,7 @@ export declare class ShareClient extends StorageClient {
|
|
3222
4111
|
* @param name - Share name.
|
3223
4112
|
* @param options - Optional. Options to configure the HTTP pipeline.
|
3224
4113
|
*/
|
3225
|
-
constructor(connectionString: string, name: string, options?:
|
4114
|
+
constructor(connectionString: string, name: string, options?: StoragePipelineOptions);
|
3226
4115
|
/**
|
3227
4116
|
* Creates an instance of ShareClient.
|
3228
4117
|
*
|
@@ -3234,7 +4123,7 @@ export declare class ShareClient extends StorageClient {
|
|
3234
4123
|
* If not specified, AnonymousCredential is used.
|
3235
4124
|
* @param options - Optional. Options to configure the HTTP pipeline.
|
3236
4125
|
*/
|
3237
|
-
constructor(url: string, credential?:
|
4126
|
+
constructor(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential, options?: StoragePipelineOptions);
|
3238
4127
|
/**
|
3239
4128
|
* Creates an instance of ShareClient.
|
3240
4129
|
*
|
@@ -3245,7 +4134,7 @@ export declare class ShareClient extends StorageClient {
|
|
3245
4134
|
* @param pipeline - Call newPipeline() to create a default
|
3246
4135
|
* pipeline, or provide a customized pipeline.
|
3247
4136
|
*/
|
3248
|
-
constructor(url: string, pipeline: Pipeline
|
4137
|
+
constructor(url: string, pipeline: Pipeline);
|
3249
4138
|
/**
|
3250
4139
|
* Creates a new ShareClient object identical to the source but with the specified snapshot timestamp.
|
3251
4140
|
* Provide "" will remove the snapshot and return a URL to the base share.
|
@@ -3488,26 +4377,6 @@ export declare class ShareClient extends StorageClient {
|
|
3488
4377
|
generateSasUrl(options: ShareGenerateSasUrlOptions): string;
|
3489
4378
|
}
|
3490
4379
|
|
3491
|
-
export declare interface ShareClientConfig {
|
3492
|
-
/**
|
3493
|
-
* The Files OAuth over REST feature requires special permissions to be included in the role definition to use
|
3494
|
-
* These special permissions will give privileged access to file share data -
|
3495
|
-
* It will allow users to bypass file/directory level ACL/NTFS permissions and get read/write access to file share data
|
3496
|
-
* Since this additional permission can be unintended and to prevent unintended and over privileged access,
|
3497
|
-
* additional checks has been implemented that requires users to explicitly indicate their intent to use these additional permissions.
|
3498
|
-
* This is done using the fileRequestIntent option.
|
3499
|
-
* Currently, the only value that the header supports is 'backup'
|
3500
|
-
* Any user who wishes to use Files OAuth over REST feature has to call the API with the intent header. If the API is not called with the intent header, any subsequent data operation requests will be denied.
|
3501
|
-
*/
|
3502
|
-
fileRequestIntent?: ShareTokenIntent;
|
3503
|
-
/** If true, the trailing dot will not be trimmed from the target URI. */
|
3504
|
-
allowTrailingDot?: boolean;
|
3505
|
-
/** If true, the trailing dot will not be trimmed from the source URI. */
|
3506
|
-
allowSourceTrailingDot?: boolean;
|
3507
|
-
}
|
3508
|
-
|
3509
|
-
export declare type ShareClientOptions = StoragePipelineOptions & ShareClientConfig;
|
3510
|
-
|
3511
4380
|
/** Defines headers for Share_create operation. */
|
3512
4381
|
export declare interface ShareCreateHeaders {
|
3513
4382
|
/** The ETag contains a value which represents the version of the share, in quotes. */
|
@@ -3534,6 +4403,24 @@ export declare interface ShareCreateIfNotExistsResponse extends ShareCreateRespo
|
|
3534
4403
|
succeeded: boolean;
|
3535
4404
|
}
|
3536
4405
|
|
4406
|
+
/** Optional parameters. */
|
4407
|
+
declare interface ShareCreateOptionalParams extends coreClient.OperationOptions {
|
4408
|
+
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN">Setting Timeouts for File Service Operations.</a> */
|
4409
|
+
timeoutInSeconds?: number;
|
4410
|
+
/** A name-value pair to associate with a file storage object. */
|
4411
|
+
metadata?: {
|
4412
|
+
[propertyName: string]: string;
|
4413
|
+
};
|
4414
|
+
/** Specifies the maximum size of the share, in gigabytes. */
|
4415
|
+
quota?: number;
|
4416
|
+
/** Specifies the access tier of the share. */
|
4417
|
+
accessTier?: ShareAccessTier;
|
4418
|
+
/** Protocols to enable on the share. */
|
4419
|
+
enabledProtocols?: string;
|
4420
|
+
/** Root squash to set on the share. Only valid for NFS shares. */
|
4421
|
+
rootSquash?: ShareRootSquash;
|
4422
|
+
}
|
4423
|
+
|
3537
4424
|
/**
|
3538
4425
|
* Options to configure the {@link ShareClient.create} operation.
|
3539
4426
|
*/
|
@@ -3584,6 +4471,12 @@ export declare interface ShareCreatePermissionHeaders {
|
|
3584
4471
|
errorCode?: string;
|
3585
4472
|
}
|
3586
4473
|
|
4474
|
+
/** Optional parameters. */
|
4475
|
+
declare interface ShareCreatePermissionOptionalParams extends coreClient.OperationOptions {
|
4476
|
+
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN">Setting Timeouts for File Service Operations.</a> */
|
4477
|
+
timeoutInSeconds?: number;
|
4478
|
+
}
|
4479
|
+
|
3587
4480
|
/**
|
3588
4481
|
* Options to configure the {@link ShareClient.createPermission} operation.
|
3589
4482
|
*/
|
@@ -3596,22 +4489,16 @@ export declare interface ShareCreatePermissionOptions extends CommonOptions {
|
|
3596
4489
|
}
|
3597
4490
|
|
3598
4491
|
/** Contains response data for the createPermission operation. */
|
3599
|
-
export declare type ShareCreatePermissionResponse = ShareCreatePermissionHeaders
|
3600
|
-
|
3601
|
-
|
3602
|
-
|
3603
|
-
parsedHeaders: ShareCreatePermissionHeaders;
|
3604
|
-
};
|
3605
|
-
};
|
4492
|
+
export declare type ShareCreatePermissionResponse = WithResponse<ShareCreatePermissionHeaders, ShareCreatePermissionHeaders>;
|
4493
|
+
|
4494
|
+
/** Contains response data for the createPermission operation. */
|
4495
|
+
declare type ShareCreatePermissionResponse_2 = ShareCreatePermissionHeaders;
|
3606
4496
|
|
3607
4497
|
/** Contains response data for the create operation. */
|
3608
|
-
export declare type ShareCreateResponse = ShareCreateHeaders
|
3609
|
-
|
3610
|
-
|
3611
|
-
|
3612
|
-
parsedHeaders: ShareCreateHeaders;
|
3613
|
-
};
|
3614
|
-
};
|
4498
|
+
export declare type ShareCreateResponse = WithResponse<ShareCreateHeaders, ShareCreateHeaders>;
|
4499
|
+
|
4500
|
+
/** Contains response data for the create operation. */
|
4501
|
+
declare type ShareCreateResponse_2 = ShareCreateHeaders;
|
3615
4502
|
|
3616
4503
|
/** Defines headers for Share_createSnapshot operation. */
|
3617
4504
|
export declare interface ShareCreateSnapshotHeaders {
|
@@ -3631,6 +4518,16 @@ export declare interface ShareCreateSnapshotHeaders {
|
|
3631
4518
|
errorCode?: string;
|
3632
4519
|
}
|
3633
4520
|
|
4521
|
+
/** Optional parameters. */
|
4522
|
+
declare interface ShareCreateSnapshotOptionalParams extends coreClient.OperationOptions {
|
4523
|
+
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN">Setting Timeouts for File Service Operations.</a> */
|
4524
|
+
timeoutInSeconds?: number;
|
4525
|
+
/** A name-value pair to associate with a file storage object. */
|
4526
|
+
metadata?: {
|
4527
|
+
[propertyName: string]: string;
|
4528
|
+
};
|
4529
|
+
}
|
4530
|
+
|
3634
4531
|
/**
|
3635
4532
|
* Options to configure the {@link ShareClient.createSnapshot} operation.
|
3636
4533
|
*/
|
@@ -3649,13 +4546,10 @@ export declare interface ShareCreateSnapshotOptions extends CommonOptions {
|
|
3649
4546
|
}
|
3650
4547
|
|
3651
4548
|
/** Contains response data for the createSnapshot operation. */
|
3652
|
-
export declare type ShareCreateSnapshotResponse = ShareCreateSnapshotHeaders
|
3653
|
-
|
3654
|
-
|
3655
|
-
|
3656
|
-
parsedHeaders: ShareCreateSnapshotHeaders;
|
3657
|
-
};
|
3658
|
-
};
|
4549
|
+
export declare type ShareCreateSnapshotResponse = WithResponse<ShareCreateSnapshotHeaders, ShareCreateSnapshotHeaders>;
|
4550
|
+
|
4551
|
+
/** Contains response data for the createSnapshot operation. */
|
4552
|
+
declare type ShareCreateSnapshotResponse_2 = ShareCreateSnapshotHeaders;
|
3659
4553
|
|
3660
4554
|
/** Defines headers for Share_delete operation. */
|
3661
4555
|
export declare interface ShareDeleteHeaders {
|
@@ -3700,14 +4594,23 @@ export declare interface ShareDeleteMethodOptions extends CommonOptions {
|
|
3700
4594
|
leaseAccessConditions?: LeaseAccessConditions;
|
3701
4595
|
}
|
3702
4596
|
|
4597
|
+
/** Optional parameters. */
|
4598
|
+
declare interface ShareDeleteOptionalParams extends coreClient.OperationOptions {
|
4599
|
+
/** Parameter group */
|
4600
|
+
leaseAccessConditions?: LeaseAccessConditions;
|
4601
|
+
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN">Setting Timeouts for File Service Operations.</a> */
|
4602
|
+
timeoutInSeconds?: number;
|
4603
|
+
/** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
|
4604
|
+
shareSnapshot?: string;
|
4605
|
+
/** Specifies the option include to delete the base share and all of its snapshots. */
|
4606
|
+
deleteSnapshots?: DeleteSnapshotsOptionType;
|
4607
|
+
}
|
4608
|
+
|
3703
4609
|
/** Contains response data for the delete operation. */
|
3704
|
-
export declare type ShareDeleteResponse = ShareDeleteHeaders
|
3705
|
-
|
3706
|
-
|
3707
|
-
|
3708
|
-
parsedHeaders: ShareDeleteHeaders;
|
3709
|
-
};
|
3710
|
-
};
|
4610
|
+
export declare type ShareDeleteResponse = WithResponse<ShareDeleteHeaders, ShareDeleteHeaders>;
|
4611
|
+
|
4612
|
+
/** Contains response data for the delete operation. */
|
4613
|
+
declare type ShareDeleteResponse_2 = ShareDeleteHeaders;
|
3711
4614
|
|
3712
4615
|
/**
|
3713
4616
|
* A ShareDirectoryClient represents a URL to the Azure Storage directory allowing you to manipulate its files and directories.
|
@@ -3720,7 +4623,6 @@ export declare class ShareDirectoryClient extends StorageClient {
|
|
3720
4623
|
private _shareName;
|
3721
4624
|
private _path;
|
3722
4625
|
private _name;
|
3723
|
-
private shareClientConfig?;
|
3724
4626
|
/**
|
3725
4627
|
* The share name corresponding to this directory client
|
3726
4628
|
*/
|
@@ -3748,7 +4650,7 @@ export declare class ShareDirectoryClient extends StorageClient {
|
|
3748
4650
|
* If not specified, AnonymousCredential is used.
|
3749
4651
|
* @param options - Optional. Options to configure the HTTP pipeline.
|
3750
4652
|
*/
|
3751
|
-
constructor(url: string, credential?:
|
4653
|
+
constructor(url: string, credential?: AnonymousCredential | StorageSharedKeyCredential, options?: StoragePipelineOptions);
|
3752
4654
|
/**
|
3753
4655
|
* Creates an instance of DirectoryClient.
|
3754
4656
|
*
|
@@ -3763,7 +4665,7 @@ export declare class ShareDirectoryClient extends StorageClient {
|
|
3763
4665
|
* @param pipeline - Call newPipeline() to create a default
|
3764
4666
|
* pipeline, or provide a customized pipeline.
|
3765
4667
|
*/
|
3766
|
-
constructor(url: string, pipeline: Pipeline
|
4668
|
+
constructor(url: string, pipeline: Pipeline);
|
3767
4669
|
/**
|
3768
4670
|
* Creates a new directory under the specified share or parent directory.
|
3769
4671
|
* @see https://docs.microsoft.com/en-us/rest/api/storageservices/create-directory
|
@@ -4233,7 +5135,6 @@ export declare class ShareFileClient extends StorageClient {
|
|
4233
5135
|
private _shareName;
|
4234
5136
|
private _path;
|
4235
5137
|
private _name;
|
4236
|
-
private shareClientConfig?;
|
4237
5138
|
/**
|
4238
5139
|
* The share name corresponding to this file client
|
4239
5140
|
*/
|
@@ -4257,11 +5158,11 @@ export declare class ShareFileClient extends StorageClient {
|
|
4257
5158
|
* Encoded URL string will NOT be escaped twice, only special characters in URL path will be escaped.
|
4258
5159
|
* However, if a file or directory name includes %, file or directory name must be encoded in the URL.
|
4259
5160
|
* Such as a file named "myfile%", the URL should be "https://myaccount.file.core.windows.net/myshare/mydirectory/myfile%25".
|
4260
|
-
* @param credential - Such as AnonymousCredential
|
5161
|
+
* @param credential - Such as AnonymousCredential or StorageSharedKeyCredential.
|
4261
5162
|
* If not specified, AnonymousCredential is used.
|
4262
5163
|
* @param options - Optional. Options to configure the HTTP pipeline.
|
4263
5164
|
*/
|
4264
|
-
constructor(url: string, credential?:
|
5165
|
+
constructor(url: string, credential?: AnonymousCredential | StorageSharedKeyCredential, options?: StoragePipelineOptions);
|
4265
5166
|
/**
|
4266
5167
|
* Creates an instance of ShareFileClient.
|
4267
5168
|
*
|
@@ -4276,7 +5177,7 @@ export declare class ShareFileClient extends StorageClient {
|
|
4276
5177
|
* @param pipeline - Call newPipeline() to create a default
|
4277
5178
|
* pipeline, or provide a customized pipeline.
|
4278
5179
|
*/
|
4279
|
-
constructor(url: string, pipeline: Pipeline
|
5180
|
+
constructor(url: string, pipeline: Pipeline);
|
4280
5181
|
/**
|
4281
5182
|
* Creates a new ShareFileClient object identical to the source but with the specified share snapshot timestamp.
|
4282
5183
|
* Provide "" will remove the snapshot and return a URL to the base ShareFileClient.
|
@@ -4498,7 +5399,7 @@ export declare class ShareFileClient extends StorageClient {
|
|
4498
5399
|
* console.log("Updated file successfully!")
|
4499
5400
|
* ```
|
4500
5401
|
*/
|
4501
|
-
uploadRange(body:
|
5402
|
+
uploadRange(body: RequestBodyType, offset: number, contentLength: number, options?: FileUploadRangeOptions): Promise<FileUploadRangeResponse>;
|
4502
5403
|
/**
|
4503
5404
|
* Upload a range of bytes to a file where the contents are read from a another file's URL.
|
4504
5405
|
* The range can be up to 4 MB in size.
|
@@ -4784,9 +5685,6 @@ export declare class ShareFileClient extends StorageClient {
|
|
4784
5685
|
}>;
|
4785
5686
|
}
|
4786
5687
|
|
4787
|
-
/** Defines values for AccessRight. */
|
4788
|
-
export declare type ShareFileHandleAccessRights = "Read" | "Write" | "Delete";
|
4789
|
-
|
4790
5688
|
/** The list of file ranges */
|
4791
5689
|
export declare interface ShareFileRangeList {
|
4792
5690
|
ranges?: RangeModel[];
|
@@ -4819,6 +5717,14 @@ export declare interface ShareGetAccessPolicyHeaders {
|
|
4819
5717
|
errorCode?: string;
|
4820
5718
|
}
|
4821
5719
|
|
5720
|
+
/** Optional parameters. */
|
5721
|
+
declare interface ShareGetAccessPolicyOptionalParams extends coreClient.OperationOptions {
|
5722
|
+
/** Parameter group */
|
5723
|
+
leaseAccessConditions?: LeaseAccessConditions;
|
5724
|
+
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN">Setting Timeouts for File Service Operations.</a> */
|
5725
|
+
timeoutInSeconds?: number;
|
5726
|
+
}
|
5727
|
+
|
4822
5728
|
/**
|
4823
5729
|
* Options to configure the {@link ShareClient.getAccessPolicy} operation.
|
4824
5730
|
*/
|
@@ -4834,27 +5740,12 @@ export declare interface ShareGetAccessPolicyOptions extends CommonOptions {
|
|
4834
5740
|
leaseAccessConditions?: LeaseAccessConditions;
|
4835
5741
|
}
|
4836
5742
|
|
4837
|
-
export declare type ShareGetAccessPolicyResponse = {
|
5743
|
+
export declare type ShareGetAccessPolicyResponse = WithResponse<{
|
4838
5744
|
signedIdentifiers: SignedIdentifier[];
|
4839
|
-
} & ShareGetAccessPolicyHeaders
|
4840
|
-
|
4841
|
-
|
4842
|
-
|
4843
|
-
_response: HttpResponse & {
|
4844
|
-
/**
|
4845
|
-
* The parsed HTTP response headers.
|
4846
|
-
*/
|
4847
|
-
parsedHeaders: ShareGetAccessPolicyHeaders;
|
4848
|
-
/**
|
4849
|
-
* The response body as text (string format)
|
4850
|
-
*/
|
4851
|
-
bodyAsText: string;
|
4852
|
-
/**
|
4853
|
-
* The response body as parsed JSON or XML
|
4854
|
-
*/
|
4855
|
-
parsedBody: SignedIdentifierModel[];
|
4856
|
-
};
|
4857
|
-
};
|
5745
|
+
} & ShareGetAccessPolicyHeaders, ShareGetAccessPolicyHeaders, SignedIdentifierModel[]>;
|
5746
|
+
|
5747
|
+
/** Contains response data for the getAccessPolicy operation. */
|
5748
|
+
declare type ShareGetAccessPolicyResponse_2 = ShareGetAccessPolicyHeaders & SignedIdentifierModel[];
|
4858
5749
|
|
4859
5750
|
/** Defines headers for Share_getPermission operation. */
|
4860
5751
|
export declare interface ShareGetPermissionHeaders {
|
@@ -4868,6 +5759,12 @@ export declare interface ShareGetPermissionHeaders {
|
|
4868
5759
|
errorCode?: string;
|
4869
5760
|
}
|
4870
5761
|
|
5762
|
+
/** Optional parameters. */
|
5763
|
+
declare interface ShareGetPermissionOptionalParams extends coreClient.OperationOptions {
|
5764
|
+
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN">Setting Timeouts for File Service Operations.</a> */
|
5765
|
+
timeoutInSeconds?: number;
|
5766
|
+
}
|
5767
|
+
|
4871
5768
|
/**
|
4872
5769
|
* Options to configure the {@link ShareClient.getPermission} operation.
|
4873
5770
|
*/
|
@@ -4880,17 +5777,10 @@ export declare interface ShareGetPermissionOptions extends CommonOptions {
|
|
4880
5777
|
}
|
4881
5778
|
|
4882
5779
|
/** Contains response data for the getPermission operation. */
|
4883
|
-
export declare type ShareGetPermissionResponse = ShareGetPermissionHeaders & SharePermission
|
4884
|
-
|
4885
|
-
|
4886
|
-
|
4887
|
-
bodyAsText: string;
|
4888
|
-
/** The response body as parsed JSON or XML */
|
4889
|
-
parsedBody: SharePermission;
|
4890
|
-
/** The parsed HTTP response headers. */
|
4891
|
-
parsedHeaders: ShareGetPermissionHeaders;
|
4892
|
-
};
|
4893
|
-
};
|
5780
|
+
export declare type ShareGetPermissionResponse = WithResponse<ShareGetPermissionHeaders & SharePermission, ShareGetPermissionHeaders, SharePermission>;
|
5781
|
+
|
5782
|
+
/** Contains response data for the getPermission operation. */
|
5783
|
+
declare type ShareGetPermissionResponse_2 = ShareGetPermissionHeaders & SharePermission;
|
4894
5784
|
|
4895
5785
|
/** Defines headers for Share_getProperties operation. */
|
4896
5786
|
export declare interface ShareGetPropertiesHeaders {
|
@@ -4940,6 +5830,16 @@ export declare interface ShareGetPropertiesHeaders {
|
|
4940
5830
|
errorCode?: string;
|
4941
5831
|
}
|
4942
5832
|
|
5833
|
+
/** Optional parameters. */
|
5834
|
+
declare interface ShareGetPropertiesOptionalParams extends coreClient.OperationOptions {
|
5835
|
+
/** Parameter group */
|
5836
|
+
leaseAccessConditions?: LeaseAccessConditions;
|
5837
|
+
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN">Setting Timeouts for File Service Operations.</a> */
|
5838
|
+
timeoutInSeconds?: number;
|
5839
|
+
/** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
|
5840
|
+
shareSnapshot?: string;
|
5841
|
+
}
|
5842
|
+
|
4943
5843
|
/**
|
4944
5844
|
* Options to configure the {@link ShareClient.getProperties} operation.
|
4945
5845
|
*/
|
@@ -4966,13 +5866,10 @@ export declare type ShareGetPropertiesResponse = ShareGetPropertiesResponseModel
|
|
4966
5866
|
};
|
4967
5867
|
|
4968
5868
|
/** Contains response data for the getProperties operation. */
|
4969
|
-
|
4970
|
-
|
4971
|
-
|
4972
|
-
|
4973
|
-
parsedHeaders: ShareGetPropertiesHeaders;
|
4974
|
-
};
|
4975
|
-
};
|
5869
|
+
declare type ShareGetPropertiesResponse_2 = ShareGetPropertiesHeaders;
|
5870
|
+
|
5871
|
+
/** Contains response data for the getProperties operation. */
|
5872
|
+
export declare type ShareGetPropertiesResponseModel = WithResponse<ShareGetPropertiesHeaders, ShareGetPropertiesHeaders>;
|
4976
5873
|
|
4977
5874
|
/** Defines headers for Share_getStatistics operation. */
|
4978
5875
|
export declare interface ShareGetStatisticsHeaders {
|
@@ -4990,6 +5887,14 @@ export declare interface ShareGetStatisticsHeaders {
|
|
4990
5887
|
errorCode?: string;
|
4991
5888
|
}
|
4992
5889
|
|
5890
|
+
/** Optional parameters. */
|
5891
|
+
declare interface ShareGetStatisticsOptionalParams extends coreClient.OperationOptions {
|
5892
|
+
/** Parameter group */
|
5893
|
+
leaseAccessConditions?: LeaseAccessConditions;
|
5894
|
+
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN">Setting Timeouts for File Service Operations.</a> */
|
5895
|
+
timeoutInSeconds?: number;
|
5896
|
+
}
|
5897
|
+
|
4993
5898
|
/**
|
4994
5899
|
* Options to configure the {@link ShareClient.getStatistics} operation.
|
4995
5900
|
*/
|
@@ -5019,17 +5924,10 @@ export declare type ShareGetStatisticsResponse = ShareGetStatisticsResponseModel
|
|
5019
5924
|
};
|
5020
5925
|
|
5021
5926
|
/** Contains response data for the getStatistics operation. */
|
5022
|
-
|
5023
|
-
|
5024
|
-
|
5025
|
-
|
5026
|
-
bodyAsText: string;
|
5027
|
-
/** The response body as parsed JSON or XML */
|
5028
|
-
parsedBody: ShareStats;
|
5029
|
-
/** The parsed HTTP response headers. */
|
5030
|
-
parsedHeaders: ShareGetStatisticsHeaders;
|
5031
|
-
};
|
5032
|
-
};
|
5927
|
+
declare type ShareGetStatisticsResponse_2 = ShareGetStatisticsHeaders & ShareStats;
|
5928
|
+
|
5929
|
+
/** Contains response data for the getStatistics operation. */
|
5930
|
+
export declare type ShareGetStatisticsResponseModel = WithResponse<ShareGetStatisticsHeaders & ShareStats, ShareGetStatisticsHeaders, ShareStats>;
|
5033
5931
|
|
5034
5932
|
/**
|
5035
5933
|
* A listed Azure Storage share item.
|
@@ -5069,7 +5967,6 @@ export declare class ShareLeaseClient {
|
|
5069
5967
|
private _leaseId;
|
5070
5968
|
private _url;
|
5071
5969
|
private fileOrShare;
|
5072
|
-
private isShare;
|
5073
5970
|
/**
|
5074
5971
|
* Gets the lease Id.
|
5075
5972
|
*
|
@@ -5191,6 +6088,97 @@ export declare interface ShareProtocolSettings {
|
|
5191
6088
|
smb?: ShareSmbSettings;
|
5192
6089
|
}
|
5193
6090
|
|
6091
|
+
/** Defines headers for Share_releaseLease operation. */
|
6092
|
+
declare interface ShareReleaseLeaseHeaders {
|
6093
|
+
/** The ETag contains a value that you can use to perform operations conditionally, in quotes. */
|
6094
|
+
etag?: string;
|
6095
|
+
/** Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share. */
|
6096
|
+
lastModified?: Date;
|
6097
|
+
/** If a client request id header is sent in the request, this header will be present in the response with the same value. */
|
6098
|
+
clientRequestId?: string;
|
6099
|
+
/** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
|
6100
|
+
requestId?: string;
|
6101
|
+
/** Indicates the version of the File service used to execute the request. */
|
6102
|
+
version?: string;
|
6103
|
+
/** UTC date/time value generated by the service that indicates the time at which the response was initiated */
|
6104
|
+
date?: Date;
|
6105
|
+
}
|
6106
|
+
|
6107
|
+
/** Optional parameters. */
|
6108
|
+
declare interface ShareReleaseLeaseOptionalParams extends coreClient.OperationOptions {
|
6109
|
+
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN">Setting Timeouts for File Service Operations.</a> */
|
6110
|
+
timeoutInSeconds?: number;
|
6111
|
+
/** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
|
6112
|
+
shareSnapshot?: string;
|
6113
|
+
/** 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. */
|
6114
|
+
requestId?: string;
|
6115
|
+
}
|
6116
|
+
|
6117
|
+
/** Contains response data for the releaseLease operation. */
|
6118
|
+
declare type ShareReleaseLeaseResponse = ShareReleaseLeaseHeaders;
|
6119
|
+
|
6120
|
+
/** Defines headers for Share_renewLease operation. */
|
6121
|
+
declare interface ShareRenewLeaseHeaders {
|
6122
|
+
/** The ETag contains a value that you can use to perform operations conditionally, in quotes. */
|
6123
|
+
etag?: string;
|
6124
|
+
/** Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share. */
|
6125
|
+
lastModified?: Date;
|
6126
|
+
/** Uniquely identifies a share's lease */
|
6127
|
+
leaseId?: string;
|
6128
|
+
/** If a client request id header is sent in the request, this header will be present in the response with the same value. */
|
6129
|
+
clientRequestId?: string;
|
6130
|
+
/** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
|
6131
|
+
requestId?: string;
|
6132
|
+
/** Indicates the version of the File service used to execute the request. */
|
6133
|
+
version?: string;
|
6134
|
+
/** Returns the current share next allowed quota downgrade time. */
|
6135
|
+
date?: Date;
|
6136
|
+
}
|
6137
|
+
|
6138
|
+
/** Optional parameters. */
|
6139
|
+
declare interface ShareRenewLeaseOptionalParams extends coreClient.OperationOptions {
|
6140
|
+
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN">Setting Timeouts for File Service Operations.</a> */
|
6141
|
+
timeoutInSeconds?: number;
|
6142
|
+
/** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
|
6143
|
+
shareSnapshot?: string;
|
6144
|
+
/** 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. */
|
6145
|
+
requestId?: string;
|
6146
|
+
}
|
6147
|
+
|
6148
|
+
/** Contains response data for the renewLease operation. */
|
6149
|
+
declare type ShareRenewLeaseResponse = ShareRenewLeaseHeaders;
|
6150
|
+
|
6151
|
+
/** Defines headers for Share_restore operation. */
|
6152
|
+
declare interface ShareRestoreHeaders {
|
6153
|
+
/** The ETag contains a value that you can use to perform operations conditionally, in quotes. */
|
6154
|
+
etag?: string;
|
6155
|
+
/** Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share. */
|
6156
|
+
lastModified?: Date;
|
6157
|
+
/** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
|
6158
|
+
requestId?: string;
|
6159
|
+
/** If a client request id header is sent in the request, this header will be present in the response with the same value. */
|
6160
|
+
clientRequestId?: string;
|
6161
|
+
/** Indicates the version of the File service used to execute the request. */
|
6162
|
+
version?: string;
|
6163
|
+
/** A UTC date/time value generated by the service that indicates the time at which the response was initiated. */
|
6164
|
+
date?: Date;
|
6165
|
+
}
|
6166
|
+
|
6167
|
+
/** Optional parameters. */
|
6168
|
+
declare interface ShareRestoreOptionalParams extends coreClient.OperationOptions {
|
6169
|
+
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN">Setting Timeouts for File Service Operations.</a> */
|
6170
|
+
timeoutInSeconds?: number;
|
6171
|
+
/** 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. */
|
6172
|
+
requestId?: string;
|
6173
|
+
/** Specifies the name of the previously-deleted share. */
|
6174
|
+
deletedShareName?: string;
|
6175
|
+
/** Specifies the version of the previously-deleted share. */
|
6176
|
+
deletedShareVersion?: string;
|
6177
|
+
}
|
6178
|
+
|
6179
|
+
/** Contains response data for the restore operation. */
|
6180
|
+
declare type ShareRestoreResponse = ShareRestoreHeaders;
|
6181
|
+
|
5194
6182
|
/** Defines values for ShareRootSquash. */
|
5195
6183
|
export declare type ShareRootSquash = "NoRootSquash" | "RootSquash" | "AllSquash";
|
5196
6184
|
|
@@ -5249,7 +6237,6 @@ export declare class ShareServiceClient extends StorageClient {
|
|
5249
6237
|
* serviceContext provided by protocol layer.
|
5250
6238
|
*/
|
5251
6239
|
private serviceContext;
|
5252
|
-
private shareClientConfig?;
|
5253
6240
|
/**
|
5254
6241
|
*
|
5255
6242
|
* Creates an instance of ShareServiceClient from connection string.
|
@@ -5263,18 +6250,18 @@ export declare class ShareServiceClient extends StorageClient {
|
|
5263
6250
|
* @param options - Options to configure the HTTP pipeline.
|
5264
6251
|
* @returns A new ShareServiceClient from the given connection string.
|
5265
6252
|
*/
|
5266
|
-
static fromConnectionString(connectionString: string, options?:
|
6253
|
+
static fromConnectionString(connectionString: string, options?: StoragePipelineOptions): ShareServiceClient;
|
5267
6254
|
/**
|
5268
6255
|
* Creates an instance of ShareServiceClient.
|
5269
6256
|
*
|
5270
6257
|
* @param url - A URL string pointing to Azure Storage file service, such as
|
5271
6258
|
* "https://myaccount.file.core.windows.net". You can Append a SAS
|
5272
6259
|
* if using AnonymousCredential, such as "https://myaccount.file.core.windows.net?sasString".
|
5273
|
-
* @param credential - Such as AnonymousCredential
|
6260
|
+
* @param credential - Such as AnonymousCredential or StorageSharedKeyCredential.
|
5274
6261
|
* If not specified, AnonymousCredential is used.
|
5275
6262
|
* @param options - Optional. Options to configure the HTTP pipeline.
|
5276
6263
|
*/
|
5277
|
-
constructor(url: string, credential?:
|
6264
|
+
constructor(url: string, credential?: AnonymousCredential | StorageSharedKeyCredential, options?: StoragePipelineOptions);
|
5278
6265
|
/**
|
5279
6266
|
* Creates an instance of ShareServiceClient.
|
5280
6267
|
*
|
@@ -5283,10 +6270,8 @@ export declare class ShareServiceClient extends StorageClient {
|
|
5283
6270
|
* if using AnonymousCredential, such as "https://myaccount.file.core.windows.net?sasString".
|
5284
6271
|
* @param pipeline - Call newPipeline() to create a default
|
5285
6272
|
* pipeline, or provide a customized pipeline.
|
5286
|
-
* @param options - Optional. Options to configure the HTTP pipeline.
|
5287
|
-
* @param fileRequestIntent - Optional. File request intent.
|
5288
6273
|
*/
|
5289
|
-
constructor(url: string, pipeline: Pipeline
|
6274
|
+
constructor(url: string, pipeline: Pipeline);
|
5290
6275
|
/**
|
5291
6276
|
* Creates a ShareClient object.
|
5292
6277
|
*
|
@@ -5492,6 +6477,16 @@ export declare interface ShareSetAccessPolicyHeaders {
|
|
5492
6477
|
errorCode?: string;
|
5493
6478
|
}
|
5494
6479
|
|
6480
|
+
/** Optional parameters. */
|
6481
|
+
declare interface ShareSetAccessPolicyOptionalParams extends coreClient.OperationOptions {
|
6482
|
+
/** Parameter group */
|
6483
|
+
leaseAccessConditions?: LeaseAccessConditions;
|
6484
|
+
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN">Setting Timeouts for File Service Operations.</a> */
|
6485
|
+
timeoutInSeconds?: number;
|
6486
|
+
/** The ACL for the share. */
|
6487
|
+
shareAcl?: SignedIdentifierModel[];
|
6488
|
+
}
|
6489
|
+
|
5495
6490
|
/**
|
5496
6491
|
* Options to configure the {@link ShareClient.setAccessPolicy} operation.
|
5497
6492
|
*/
|
@@ -5508,13 +6503,10 @@ export declare interface ShareSetAccessPolicyOptions extends CommonOptions {
|
|
5508
6503
|
}
|
5509
6504
|
|
5510
6505
|
/** Contains response data for the setAccessPolicy operation. */
|
5511
|
-
export declare type ShareSetAccessPolicyResponse = ShareSetAccessPolicyHeaders
|
5512
|
-
|
5513
|
-
|
5514
|
-
|
5515
|
-
parsedHeaders: ShareSetAccessPolicyHeaders;
|
5516
|
-
};
|
5517
|
-
};
|
6506
|
+
export declare type ShareSetAccessPolicyResponse = WithResponse<ShareSetAccessPolicyHeaders, ShareGetAccessPolicyHeaders>;
|
6507
|
+
|
6508
|
+
/** Contains response data for the setAccessPolicy operation. */
|
6509
|
+
declare type ShareSetAccessPolicyResponse_2 = ShareSetAccessPolicyHeaders;
|
5518
6510
|
|
5519
6511
|
/** Defines headers for Share_setMetadata operation. */
|
5520
6512
|
export declare interface ShareSetMetadataHeaders {
|
@@ -5532,6 +6524,18 @@ export declare interface ShareSetMetadataHeaders {
|
|
5532
6524
|
errorCode?: string;
|
5533
6525
|
}
|
5534
6526
|
|
6527
|
+
/** Optional parameters. */
|
6528
|
+
declare interface ShareSetMetadataOptionalParams extends coreClient.OperationOptions {
|
6529
|
+
/** Parameter group */
|
6530
|
+
leaseAccessConditions?: LeaseAccessConditions;
|
6531
|
+
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN">Setting Timeouts for File Service Operations.</a> */
|
6532
|
+
timeoutInSeconds?: number;
|
6533
|
+
/** A name-value pair to associate with a file storage object. */
|
6534
|
+
metadata?: {
|
6535
|
+
[propertyName: string]: string;
|
6536
|
+
};
|
6537
|
+
}
|
6538
|
+
|
5535
6539
|
/**
|
5536
6540
|
* Options to configure the {@link ShareClient.setMetadata} operation.
|
5537
6541
|
*/
|
@@ -5548,13 +6552,10 @@ export declare interface ShareSetMetadataOptions extends CommonOptions {
|
|
5548
6552
|
}
|
5549
6553
|
|
5550
6554
|
/** Contains response data for the setMetadata operation. */
|
5551
|
-
export declare type ShareSetMetadataResponse = ShareSetMetadataHeaders
|
5552
|
-
|
5553
|
-
|
5554
|
-
|
5555
|
-
parsedHeaders: ShareSetMetadataHeaders;
|
5556
|
-
};
|
5557
|
-
};
|
6555
|
+
export declare type ShareSetMetadataResponse = WithResponse<ShareSetMetadataHeaders, ShareSetMetadataHeaders>;
|
6556
|
+
|
6557
|
+
/** Contains response data for the setMetadata operation. */
|
6558
|
+
declare type ShareSetMetadataResponse_2 = ShareSetMetadataHeaders;
|
5558
6559
|
|
5559
6560
|
/** Defines headers for Share_setProperties operation. */
|
5560
6561
|
export declare interface ShareSetPropertiesHeaders {
|
@@ -5572,6 +6573,20 @@ export declare interface ShareSetPropertiesHeaders {
|
|
5572
6573
|
errorCode?: string;
|
5573
6574
|
}
|
5574
6575
|
|
6576
|
+
/** Optional parameters. */
|
6577
|
+
declare interface ShareSetPropertiesOptionalParams extends coreClient.OperationOptions {
|
6578
|
+
/** Parameter group */
|
6579
|
+
leaseAccessConditions?: LeaseAccessConditions;
|
6580
|
+
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN">Setting Timeouts for File Service Operations.</a> */
|
6581
|
+
timeoutInSeconds?: number;
|
6582
|
+
/** Specifies the maximum size of the share, in gigabytes. */
|
6583
|
+
quota?: number;
|
6584
|
+
/** Specifies the access tier of the share. */
|
6585
|
+
accessTier?: ShareAccessTier;
|
6586
|
+
/** Root squash to set on the share. Only valid for NFS shares. */
|
6587
|
+
rootSquash?: ShareRootSquash;
|
6588
|
+
}
|
6589
|
+
|
5575
6590
|
/**
|
5576
6591
|
* Options to configure the {@link ShareClient.setProperties} operation.
|
5577
6592
|
*/
|
@@ -5602,13 +6617,10 @@ export declare interface ShareSetPropertiesOptions extends CommonOptions {
|
|
5602
6617
|
}
|
5603
6618
|
|
5604
6619
|
/** Contains response data for the setProperties operation. */
|
5605
|
-
export declare type ShareSetPropertiesResponse = ShareSetPropertiesHeaders
|
5606
|
-
|
5607
|
-
|
5608
|
-
|
5609
|
-
parsedHeaders: ShareSetPropertiesHeaders;
|
5610
|
-
};
|
5611
|
-
};
|
6620
|
+
export declare type ShareSetPropertiesResponse = WithResponse<ShareSetPropertiesHeaders, ShareSetPropertiesHeaders>;
|
6621
|
+
|
6622
|
+
/** Contains response data for the setProperties operation. */
|
6623
|
+
declare type ShareSetPropertiesResponse_2 = ShareSetPropertiesHeaders;
|
5612
6624
|
|
5613
6625
|
/**
|
5614
6626
|
* Defines headers for setQuota operation.
|
@@ -5633,7 +6645,7 @@ export declare interface ShareSetQuotaOptions extends CommonOptions {
|
|
5633
6645
|
/**
|
5634
6646
|
* Contains response data for the setQuota operation.
|
5635
6647
|
*/
|
5636
|
-
export declare type ShareSetQuotaResponse =
|
6648
|
+
export declare type ShareSetQuotaResponse = WithResponse<ShareSetQuotaHeaders, ShareSetQuotaHeaders>;
|
5637
6649
|
|
5638
6650
|
/** Settings for SMB protocol. */
|
5639
6651
|
export declare interface ShareSmbSettings {
|
@@ -5647,15 +6659,6 @@ export declare interface ShareStats {
|
|
5647
6659
|
shareUsageBytes: number;
|
5648
6660
|
}
|
5649
6661
|
|
5650
|
-
/**
|
5651
|
-
* Defines values for ShareTokenIntent. \
|
5652
|
-
* {@link KnownShareTokenIntent} can be used interchangeably with ShareTokenIntent,
|
5653
|
-
* this enum contains the known values that the service supports.
|
5654
|
-
* ### Know values supported by the service
|
5655
|
-
* **backup**
|
5656
|
-
*/
|
5657
|
-
export declare type ShareTokenIntent = string;
|
5658
|
-
|
5659
6662
|
/**
|
5660
6663
|
* Signed Identifier
|
5661
6664
|
*/
|
@@ -5698,6 +6701,12 @@ export declare interface SmbMultichannel {
|
|
5698
6701
|
enabled?: boolean;
|
5699
6702
|
}
|
5700
6703
|
|
6704
|
+
/** Parameter group */
|
6705
|
+
declare interface SourceLeaseAccessConditions {
|
6706
|
+
/** Required if the source file has an active infinite lease. */
|
6707
|
+
sourceLeaseId?: string;
|
6708
|
+
}
|
6709
|
+
|
5701
6710
|
/** Parameter group */
|
5702
6711
|
export declare interface SourceModifiedAccessConditions {
|
5703
6712
|
/** Specify the crc64 value to operate only on range with a matching crc64 checksum. */
|
@@ -5723,17 +6732,17 @@ export declare class StorageBrowserPolicy extends BaseRequestPolicy {
|
|
5723
6732
|
* @param nextPolicy -
|
5724
6733
|
* @param options -
|
5725
6734
|
*/
|
5726
|
-
constructor(nextPolicy: RequestPolicy, options:
|
6735
|
+
constructor(nextPolicy: RequestPolicy, options: RequestPolicyOptionsLike);
|
5727
6736
|
/**
|
5728
6737
|
* Sends out request.
|
5729
6738
|
*
|
5730
6739
|
* @param request -
|
5731
6740
|
*/
|
5732
|
-
sendRequest(request:
|
6741
|
+
sendRequest(request: WebResourceLike): Promise<CompatResponse>;
|
5733
6742
|
}
|
5734
6743
|
|
5735
6744
|
/**
|
5736
|
-
* StorageBrowserPolicyFactory is a factory class helping generating
|
6745
|
+
* StorageBrowserPolicyFactory is a factory class helping generating StorageBrowserPolicy objects.
|
5737
6746
|
*/
|
5738
6747
|
export declare class StorageBrowserPolicyFactory implements RequestPolicyFactory {
|
5739
6748
|
/**
|
@@ -5742,7 +6751,7 @@ export declare class StorageBrowserPolicyFactory implements RequestPolicyFactory
|
|
5742
6751
|
* @param nextPolicy -
|
5743
6752
|
* @param options -
|
5744
6753
|
*/
|
5745
|
-
create(nextPolicy: RequestPolicy, options:
|
6754
|
+
create(nextPolicy: RequestPolicy, options: RequestPolicyOptionsLike): StorageBrowserPolicy;
|
5746
6755
|
}
|
5747
6756
|
|
5748
6757
|
/**
|
@@ -5760,7 +6769,7 @@ declare abstract class StorageClient {
|
|
5760
6769
|
* StorageClient is a reference to protocol layer operations entry, which is
|
5761
6770
|
* generated by AutoRest generator.
|
5762
6771
|
*/
|
5763
|
-
protected readonly storageClientContext:
|
6772
|
+
protected readonly storageClientContext: StorageClient_2;
|
5764
6773
|
/**
|
5765
6774
|
* Creates an instance of StorageClient.
|
5766
6775
|
* @param url -
|
@@ -5769,21 +6778,25 @@ declare abstract class StorageClient {
|
|
5769
6778
|
protected constructor(url: string, pipeline: Pipeline);
|
5770
6779
|
}
|
5771
6780
|
|
5772
|
-
declare class
|
6781
|
+
declare class StorageClient_2 extends coreHttpCompat.ExtendedServiceClient {
|
5773
6782
|
url: string;
|
5774
6783
|
version: string;
|
5775
6784
|
fileRangeWriteFromUrl: string;
|
5776
6785
|
/**
|
5777
|
-
* Initializes a new instance of the
|
6786
|
+
* Initializes a new instance of the StorageClient class.
|
5778
6787
|
* @param url The URL of the service account, share, directory or file that is the target of the
|
5779
6788
|
* desired operation.
|
5780
6789
|
* @param options The parameter options
|
5781
6790
|
*/
|
5782
6791
|
constructor(url: string, options?: StorageClientOptionalParams);
|
6792
|
+
service: Service;
|
6793
|
+
share: Share;
|
6794
|
+
directory: Directory;
|
6795
|
+
file: File_2;
|
5783
6796
|
}
|
5784
6797
|
|
5785
6798
|
/** Optional parameters. */
|
5786
|
-
declare interface StorageClientOptionalParams extends
|
6799
|
+
declare interface StorageClientOptionalParams extends coreHttpCompat.ExtendedServiceClientOptions {
|
5787
6800
|
/** Specifies the version of the operation to use for this request. */
|
5788
6801
|
version?: string;
|
5789
6802
|
/** Only update is supported: - Update: Writes the bytes downloaded from the source url into the specified range. */
|
@@ -5793,17 +6806,17 @@ declare interface StorageClientOptionalParams extends coreHttp.ServiceClientOpti
|
|
5793
6806
|
}
|
5794
6807
|
|
5795
6808
|
/**
|
5796
|
-
*
|
6809
|
+
* Options interface for the {@link newPipeline} function.
|
5797
6810
|
*/
|
5798
6811
|
export declare interface StoragePipelineOptions {
|
5799
6812
|
/**
|
5800
6813
|
* Options to configure a proxy for outgoing requests.
|
5801
6814
|
*/
|
5802
|
-
proxyOptions?:
|
6815
|
+
proxyOptions?: ProxySettings;
|
5803
6816
|
/**
|
5804
6817
|
* Options for adding user agent details to outgoing requests.
|
5805
6818
|
*/
|
5806
|
-
userAgentOptions?:
|
6819
|
+
userAgentOptions?: UserAgentPolicyOptions;
|
5807
6820
|
/**
|
5808
6821
|
* Configures the built-in retry policy behavior.
|
5809
6822
|
*/
|
@@ -5815,11 +6828,15 @@ export declare interface StoragePipelineOptions {
|
|
5815
6828
|
/**
|
5816
6829
|
* Configures the HTTP client to send requests and receive responses.
|
5817
6830
|
*/
|
5818
|
-
httpClient?:
|
6831
|
+
httpClient?: RequestPolicy;
|
6832
|
+
/**
|
6833
|
+
* The audience used to retrieve an AAD token.
|
6834
|
+
*/
|
6835
|
+
audience?: string | string[];
|
5819
6836
|
}
|
5820
6837
|
|
5821
6838
|
/**
|
5822
|
-
*
|
6839
|
+
* Storage Blob retry options interface.
|
5823
6840
|
*/
|
5824
6841
|
export declare interface StorageRetryOptions {
|
5825
6842
|
/**
|
@@ -5834,12 +6851,10 @@ export declare interface StorageRetryOptions {
|
|
5834
6851
|
readonly maxTries?: number;
|
5835
6852
|
/**
|
5836
6853
|
* Optional. Indicates the maximum time in ms allowed for any single try of an HTTP request.
|
5837
|
-
* A value of zero or undefined means
|
6854
|
+
* A value of zero or undefined means no default timeout on SDK client, Azure
|
6855
|
+
* Storage server's default timeout policy will be used.
|
5838
6856
|
*
|
5839
|
-
*
|
5840
|
-
* not be sufficient. You should override this value based on the bandwidth available to
|
5841
|
-
* the host machine and proximity to the Storage service. A good starting point may be something
|
5842
|
-
* like (60 seconds per MB of anticipated-payload-size)
|
6857
|
+
* @see https://docs.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-blob-service-operations
|
5843
6858
|
*/
|
5844
6859
|
readonly tryTimeoutInMs?: number;
|
5845
6860
|
/**
|
@@ -5853,6 +6868,15 @@ export declare interface StorageRetryOptions {
|
|
5853
6868
|
* If you specify 0, then you must also specify 0 for retryDelayInMs.
|
5854
6869
|
*/
|
5855
6870
|
readonly maxRetryDelayInMs?: number;
|
6871
|
+
/**
|
6872
|
+
* If a secondaryHost is specified, retries will be tried against this host. If secondaryHost is undefined
|
6873
|
+
* (the default) then operations are not retried against another host.
|
6874
|
+
*
|
6875
|
+
* NOTE: Before setting this field, make sure you understand the issues around
|
6876
|
+
* reading stale and potentially-inconsistent data at
|
6877
|
+
* {@link https://docs.microsoft.com/en-us/azure/storage/common/storage-designing-ha-apps-with-ragrs}
|
6878
|
+
*/
|
6879
|
+
readonly secondaryHost?: string;
|
5856
6880
|
}
|
5857
6881
|
|
5858
6882
|
/**
|
@@ -5870,25 +6894,24 @@ export declare class StorageRetryPolicy extends BaseRequestPolicy {
|
|
5870
6894
|
* @param options -
|
5871
6895
|
* @param retryOptions -
|
5872
6896
|
*/
|
5873
|
-
constructor(nextPolicy: RequestPolicy, options:
|
6897
|
+
constructor(nextPolicy: RequestPolicy, options: RequestPolicyOptionsLike, retryOptions?: StorageRetryOptions);
|
5874
6898
|
/**
|
5875
6899
|
* Sends request.
|
5876
6900
|
*
|
5877
6901
|
* @param request -
|
5878
6902
|
*/
|
5879
|
-
sendRequest(request:
|
6903
|
+
sendRequest(request: WebResourceLike): Promise<CompatResponse>;
|
5880
6904
|
/**
|
5881
6905
|
* Decide and perform next retry. Won't mutate request parameter.
|
5882
6906
|
*
|
5883
6907
|
* @param request -
|
5884
|
-
* @param response -
|
5885
6908
|
* @param secondaryHas404 - If attempt was against the secondary & it returned a StatusNotFound (404), then
|
5886
6909
|
* the resource was not found. This may be due to replication delay. So, in this
|
5887
6910
|
* case, we'll never try the secondary again for this operation.
|
5888
6911
|
* @param attempt - How many retries has been attempted to performed, starting from 1, which includes
|
5889
6912
|
* the attempt will be performed by this method call.
|
5890
6913
|
*/
|
5891
|
-
protected attemptSendRequest(request:
|
6914
|
+
protected attemptSendRequest(request: WebResourceLike, secondaryHas404: boolean, attempt: number): Promise<CompatResponse>;
|
5892
6915
|
/**
|
5893
6916
|
* Decide whether to retry according to last HTTP response and retry counters.
|
5894
6917
|
*
|
@@ -5897,7 +6920,7 @@ export declare class StorageRetryPolicy extends BaseRequestPolicy {
|
|
5897
6920
|
* @param response -
|
5898
6921
|
* @param err -
|
5899
6922
|
*/
|
5900
|
-
protected shouldRetry(isPrimaryRetry: boolean, attempt: number, response?:
|
6923
|
+
protected shouldRetry(isPrimaryRetry: boolean, attempt: number, response?: CompatResponse, err?: RestError): boolean;
|
5901
6924
|
/**
|
5902
6925
|
* Delay a calculated time between retries.
|
5903
6926
|
*
|
@@ -5909,7 +6932,7 @@ export declare class StorageRetryPolicy extends BaseRequestPolicy {
|
|
5909
6932
|
}
|
5910
6933
|
|
5911
6934
|
/**
|
5912
|
-
* StorageRetryPolicyFactory is a factory class helping generating StorageRetryPolicy objects.
|
6935
|
+
* StorageRetryPolicyFactory is a factory class helping generating {@link StorageRetryPolicy} objects.
|
5913
6936
|
*/
|
5914
6937
|
export declare class StorageRetryPolicyFactory implements RequestPolicyFactory {
|
5915
6938
|
private retryOptions?;
|
@@ -5920,10 +6943,11 @@ export declare class StorageRetryPolicyFactory implements RequestPolicyFactory {
|
|
5920
6943
|
constructor(retryOptions?: StorageRetryOptions);
|
5921
6944
|
/**
|
5922
6945
|
* Creates a StorageRetryPolicy object.
|
6946
|
+
*
|
5923
6947
|
* @param nextPolicy -
|
5924
6948
|
* @param options -
|
5925
6949
|
*/
|
5926
|
-
create(nextPolicy: RequestPolicy, options:
|
6950
|
+
create(nextPolicy: RequestPolicy, options: RequestPolicyOptionsLike): StorageRetryPolicy;
|
5927
6951
|
}
|
5928
6952
|
|
5929
6953
|
/**
|
@@ -5961,12 +6985,12 @@ export declare class StorageSharedKeyCredential extends Credential_2 {
|
|
5961
6985
|
*/
|
5962
6986
|
constructor(accountName: string, accountKey: string);
|
5963
6987
|
/**
|
5964
|
-
* Creates a
|
6988
|
+
* Creates a StorageSharedKeyCredentialPolicy object.
|
5965
6989
|
*
|
5966
6990
|
* @param nextPolicy -
|
5967
6991
|
* @param options -
|
5968
6992
|
*/
|
5969
|
-
create(nextPolicy: RequestPolicy, options:
|
6993
|
+
create(nextPolicy: RequestPolicy, options: RequestPolicyOptionsLike): StorageSharedKeyCredentialPolicy;
|
5970
6994
|
/**
|
5971
6995
|
* Generates a hash signature for an HTTP request or for a SAS.
|
5972
6996
|
*
|
@@ -5980,7 +7004,7 @@ export declare class StorageSharedKeyCredential extends Credential_2 {
|
|
5980
7004
|
*/
|
5981
7005
|
export declare class StorageSharedKeyCredentialPolicy extends CredentialPolicy {
|
5982
7006
|
/**
|
5983
|
-
* Reference to
|
7007
|
+
* Reference to StorageSharedKeyCredential which generates StorageSharedKeyCredentialPolicy
|
5984
7008
|
*/
|
5985
7009
|
private readonly factory;
|
5986
7010
|
/**
|
@@ -5989,13 +7013,13 @@ export declare class StorageSharedKeyCredentialPolicy extends CredentialPolicy {
|
|
5989
7013
|
* @param options -
|
5990
7014
|
* @param factory -
|
5991
7015
|
*/
|
5992
|
-
constructor(nextPolicy: RequestPolicy, options:
|
7016
|
+
constructor(nextPolicy: RequestPolicy, options: RequestPolicyOptionsLike, factory: StorageSharedKeyCredential);
|
5993
7017
|
/**
|
5994
7018
|
* Signs request.
|
5995
7019
|
*
|
5996
7020
|
* @param request -
|
5997
7021
|
*/
|
5998
|
-
protected signRequest(request:
|
7022
|
+
protected signRequest(request: WebResourceLike): WebResourceLike;
|
5999
7023
|
/**
|
6000
7024
|
* Retrieve header value according to shared key sign rules.
|
6001
7025
|
* @see https://docs.microsoft.com/en-us/rest/api/storageservices/authenticate-with-shared-key
|
@@ -6036,6 +7060,9 @@ export declare type TimeNowType = "now";
|
|
6036
7060
|
*/
|
6037
7061
|
export declare type TimePreserveType = "preserve";
|
6038
7062
|
|
6039
|
-
|
7063
|
+
/**
|
7064
|
+
* A type that represents an operation result with a known _response property.
|
7065
|
+
*/
|
7066
|
+
export declare type WithResponse<T, Headers = undefined, Body = undefined> = T & (Body extends object ? ResponseWithBody<Headers, Body> : Headers extends object ? ResponseWithHeaders<Headers> : ResponseLike);
|
6040
7067
|
|
6041
7068
|
export { }
|