@azure/storage-queue 12.13.0 → 12.20.0-alpha.20230616.2
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 +1323 -1057
- 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 +1 -1
- package/dist-esm/storage-blob/src/StorageRetryPolicyFactory.js.map +1 -0
- package/dist-esm/{src → storage-blob/src}/credentials/AnonymousCredential.js +2 -2
- 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/storage-blob/src/generated/src/operationsInterfaces/blob.js +9 -0
- 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.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 +5 -4
- 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/{src → storage-blob/src}/policies/StorageSharedKeyCredentialPolicy.js +4 -2
- 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.map +1 -0
- package/dist-esm/storage-blob/src/utils/Batch.js +122 -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-queue/src/AccountSASPermissions.js.map +1 -0
- package/dist-esm/storage-queue/src/AccountSASResourceTypes.js +72 -0
- package/dist-esm/storage-queue/src/AccountSASResourceTypes.js.map +1 -0
- package/dist-esm/storage-queue/src/AccountSASServices.js +80 -0
- package/dist-esm/storage-queue/src/AccountSASServices.js.map +1 -0
- package/dist-esm/storage-queue/src/AccountSASSignatureValues.js.map +1 -0
- package/dist-esm/{src → storage-queue/src}/QueueClient.js +108 -290
- package/dist-esm/storage-queue/src/QueueClient.js.map +1 -0
- package/dist-esm/storage-queue/src/QueueSASPermissions.js.map +1 -0
- package/dist-esm/storage-queue/src/QueueSASSignatureValues.js.map +1 -0
- package/dist-esm/{src → storage-queue/src}/QueueServiceClient.js +60 -135
- package/dist-esm/storage-queue/src/QueueServiceClient.js.map +1 -0
- package/dist-esm/{src → storage-queue/src}/SASQueryParameters.js +14 -14
- package/dist-esm/storage-queue/src/SASQueryParameters.js.map +1 -0
- package/dist-esm/storage-queue/src/SasIPRange.js +13 -0
- package/dist-esm/storage-queue/src/SasIPRange.js.map +1 -0
- package/dist-esm/storage-queue/src/StorageClient.js +53 -0
- package/dist-esm/storage-queue/src/StorageClient.js.map +1 -0
- package/dist-esm/storage-queue/src/StorageContextClient.js +18 -0
- package/dist-esm/storage-queue/src/StorageContextClient.js.map +1 -0
- package/dist-esm/storage-queue/src/generated/src/index.js +11 -0
- package/dist-esm/storage-queue/src/generated/src/index.js.map +1 -0
- package/dist-esm/{src → storage-queue/src}/generated/src/models/index.js +57 -0
- package/dist-esm/storage-queue/src/generated/src/models/index.js.map +1 -0
- package/dist-esm/{src → storage-queue/src}/generated/src/models/mappers.js +2 -2
- package/dist-esm/storage-queue/src/generated/src/models/mappers.js.map +1 -0
- package/dist-esm/{src → storage-queue/src}/generated/src/models/parameters.js +4 -5
- package/dist-esm/storage-queue/src/generated/src/models/parameters.js.map +1 -0
- package/dist-esm/storage-queue/src/generated/src/operations/index.js.map +1 -0
- package/dist-esm/{src → storage-queue/src}/generated/src/operations/messageId.js +6 -15
- package/dist-esm/storage-queue/src/generated/src/operations/messageId.js.map +1 -0
- package/dist-esm/{src → storage-queue/src}/generated/src/operations/messages.js +8 -21
- package/dist-esm/storage-queue/src/generated/src/operations/messages.js.map +1 -0
- package/dist-esm/{src → storage-queue/src}/generated/src/operations/queue.js +10 -28
- package/dist-esm/storage-queue/src/generated/src/operations/queue.js.map +1 -0
- package/dist-esm/{src → storage-queue/src}/generated/src/operations/service.js +8 -21
- package/dist-esm/storage-queue/src/generated/src/operations/service.js.map +1 -0
- package/dist-esm/storage-queue/src/generated/src/operationsInterfaces/index.js +12 -0
- package/dist-esm/storage-queue/src/generated/src/operationsInterfaces/index.js.map +1 -0
- package/dist-esm/storage-queue/src/generated/src/operationsInterfaces/messageId.js +9 -0
- package/dist-esm/storage-queue/src/generated/src/operationsInterfaces/messageId.js.map +1 -0
- package/dist-esm/storage-queue/src/generated/src/operationsInterfaces/messages.js +9 -0
- package/dist-esm/storage-queue/src/generated/src/operationsInterfaces/messages.js.map +1 -0
- package/dist-esm/storage-queue/src/generated/src/operationsInterfaces/queue.js +9 -0
- package/dist-esm/storage-queue/src/generated/src/operationsInterfaces/queue.js.map +1 -0
- package/dist-esm/storage-queue/src/generated/src/operationsInterfaces/service.js +9 -0
- package/dist-esm/storage-queue/src/generated/src/operationsInterfaces/service.js.map +1 -0
- package/dist-esm/storage-queue/src/generated/src/storageClient.js +47 -0
- package/dist-esm/storage-queue/src/generated/src/storageClient.js.map +1 -0
- package/dist-esm/storage-queue/src/generatedModels.js +4 -0
- package/dist-esm/storage-queue/src/generatedModels.js.map +1 -0
- package/dist-esm/storage-queue/src/index.browser.js +18 -0
- package/dist-esm/storage-queue/src/index.browser.js.map +1 -0
- package/dist-esm/storage-queue/src/index.js +26 -0
- package/dist-esm/storage-queue/src/index.js.map +1 -0
- package/dist-esm/storage-queue/src/log.js.map +1 -0
- package/dist-esm/storage-queue/src/models.js.map +1 -0
- package/dist-esm/{src → storage-queue/src}/utils/constants.js +2 -2
- package/dist-esm/storage-queue/src/utils/constants.js.map +1 -0
- package/dist-esm/storage-queue/src/utils/tracing.js +14 -0
- package/dist-esm/storage-queue/src/utils/tracing.js.map +1 -0
- package/dist-esm/{src → storage-queue/src}/utils/utils.common.js +69 -47
- package/dist-esm/storage-queue/src/utils/utils.common.js.map +1 -0
- package/package.json +26 -19
- package/types/3.1/storage-queue.d.ts +544 -255
- package/types/latest/storage-queue.d.ts +583 -259
- 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/Pipeline.js +0 -85
- package/dist-esm/src/Pipeline.js.map +0 -1
- package/dist-esm/src/QueueClient.js.map +0 -1
- package/dist-esm/src/QueueSASPermissions.js.map +0 -1
- package/dist-esm/src/QueueSASSignatureValues.js.map +0 -1
- package/dist-esm/src/QueueServiceClient.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/StorageBrowserPolicyFactory.js.map +0 -1
- package/dist-esm/src/StorageClient.js +0 -44
- 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/index.js.map +0 -1
- package/dist-esm/src/generated/src/operations/messageId.js.map +0 -1
- package/dist-esm/src/generated/src/operations/messages.js.map +0 -1
- package/dist-esm/src/generated/src/operations/queue.js.map +0 -1
- package/dist-esm/src/generated/src/operations/service.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 -39
- package/dist-esm/src/generated/src/storageClientContext.js.map +0 -1
- 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 -25
- 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/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.common.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}/generatedModels.js +0 -0
- /package/dist-esm/{src → storage-blob/src}/policies/AnonymousCredentialPolicy.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/sas}/SasIPRange.js +0 -0
- /package/dist-esm/{src → storage-queue/src}/AccountSASPermissions.js +0 -0
- /package/dist-esm/{src → storage-queue/src}/AccountSASSignatureValues.js +0 -0
- /package/dist-esm/{src → storage-queue/src}/QueueSASPermissions.js +0 -0
- /package/dist-esm/{src → storage-queue/src}/QueueSASSignatureValues.js +0 -0
- /package/dist-esm/{src → storage-queue/src}/generated/src/operations/index.js +0 -0
- /package/dist-esm/{src → storage-queue/src}/log.js +0 -0
- /package/dist-esm/{src → storage-queue/src}/models.js +0 -0
|
@@ -1,26 +1,21 @@
|
|
|
1
1
|
import { AbortSignalLike } from '@azure/abort-controller';
|
|
2
2
|
import { AzureLogger } from '@azure/logger';
|
|
3
|
-
import {
|
|
4
|
-
import * as
|
|
5
|
-
import
|
|
6
|
-
import {
|
|
7
|
-
import {
|
|
8
|
-
import {
|
|
9
|
-
import { HttpResponse } from '@azure/core-http';
|
|
10
|
-
import { HttpClient as IHttpClient } from '@azure/core-http';
|
|
11
|
-
import { KeepAliveOptions } from '@azure/core-http';
|
|
3
|
+
import { CompatResponse } from '@azure/core-http-compat';
|
|
4
|
+
import * as coreClient from '@azure/core-client';
|
|
5
|
+
import * as coreHttpCompat from '@azure/core-http-compat';
|
|
6
|
+
import { HttpHeadersLike } from '@azure/core-http-compat';
|
|
7
|
+
import { HttpPipelineLogLevel } from '@azure/core-http-compat';
|
|
8
|
+
import { KeepAliveOptions } from '@azure/core-http-compat';
|
|
12
9
|
import { OperationTracingOptions } from '@azure/core-tracing';
|
|
13
10
|
import { PagedAsyncIterableIterator } from '@azure/core-paging';
|
|
14
|
-
import {
|
|
15
|
-
import {
|
|
16
|
-
import {
|
|
17
|
-
import {
|
|
18
|
-
import {
|
|
19
|
-
import {
|
|
20
|
-
import {
|
|
21
|
-
import {
|
|
22
|
-
import { UserAgentOptions } from '@azure/core-http';
|
|
23
|
-
import { WebResource } from '@azure/core-http';
|
|
11
|
+
import { ProxySettings } from '@azure/core-rest-pipeline';
|
|
12
|
+
import { RequestPolicy } from '@azure/core-http-compat';
|
|
13
|
+
import { RequestPolicyFactory } from '@azure/core-http-compat';
|
|
14
|
+
import { RequestPolicyOptionsLike } from '@azure/core-http-compat';
|
|
15
|
+
import { RestError } from '@azure/core-rest-pipeline';
|
|
16
|
+
import { TokenCredential } from '@azure/core-auth';
|
|
17
|
+
import { UserAgentPolicyOptions } from '@azure/core-rest-pipeline';
|
|
18
|
+
import { WebResourceLike } from '@azure/core-http-compat';
|
|
24
19
|
/** An Access policy */
|
|
25
20
|
export declare interface AccessPolicy {
|
|
26
21
|
/** the date-time the policy is active */
|
|
@@ -219,8 +214,8 @@ export declare interface AccountSASSignatureValues {
|
|
|
219
214
|
resourceTypes: string;
|
|
220
215
|
}
|
|
221
216
|
/**
|
|
222
|
-
* AnonymousCredential provides a
|
|
223
|
-
*
|
|
217
|
+
* AnonymousCredential provides a credentialPolicyCreator member used to create
|
|
218
|
+
* AnonymousCredentialPolicy objects. AnonymousCredentialPolicy is used with
|
|
224
219
|
* HTTP(S) requests that read public resources or for use with Shared Access
|
|
225
220
|
* Signatures (SAS).
|
|
226
221
|
*/
|
|
@@ -231,7 +226,7 @@ export declare class AnonymousCredential extends Credential_2 {
|
|
|
231
226
|
* @param nextPolicy -
|
|
232
227
|
* @param options -
|
|
233
228
|
*/
|
|
234
|
-
create(nextPolicy: RequestPolicy, options:
|
|
229
|
+
create(nextPolicy: RequestPolicy, options: RequestPolicyOptionsLike): AnonymousCredentialPolicy;
|
|
235
230
|
}
|
|
236
231
|
/**
|
|
237
232
|
* AnonymousCredentialPolicy is used with HTTP(S) requests that read public resources
|
|
@@ -243,9 +238,51 @@ export declare class AnonymousCredentialPolicy extends CredentialPolicy {
|
|
|
243
238
|
* @param nextPolicy -
|
|
244
239
|
* @param options -
|
|
245
240
|
*/
|
|
246
|
-
constructor(nextPolicy: RequestPolicy, options:
|
|
241
|
+
constructor(nextPolicy: RequestPolicy, options: RequestPolicyOptionsLike);
|
|
242
|
+
}
|
|
243
|
+
/**
|
|
244
|
+
* The base class from which all request policies derive.
|
|
245
|
+
*/
|
|
246
|
+
export declare abstract class BaseRequestPolicy implements RequestPolicy {
|
|
247
|
+
/**
|
|
248
|
+
* The next policy in the pipeline. Each policy is responsible for executing the next one if the request is to continue through the pipeline.
|
|
249
|
+
*/
|
|
250
|
+
readonly _nextPolicy: RequestPolicy;
|
|
251
|
+
/**
|
|
252
|
+
* The options that can be passed to a given request policy.
|
|
253
|
+
*/
|
|
254
|
+
readonly _options: RequestPolicyOptionsLike;
|
|
255
|
+
/**
|
|
256
|
+
* The main method to implement that manipulates a request/response.
|
|
257
|
+
*/
|
|
258
|
+
protected constructor(
|
|
259
|
+
/**
|
|
260
|
+
* The next policy in the pipeline. Each policy is responsible for executing the next one if the request is to continue through the pipeline.
|
|
261
|
+
*/
|
|
262
|
+
_nextPolicy: RequestPolicy,
|
|
263
|
+
/**
|
|
264
|
+
* The options that can be passed to a given request policy.
|
|
265
|
+
*/
|
|
266
|
+
_options: RequestPolicyOptionsLike);
|
|
267
|
+
/**
|
|
268
|
+
* Sends a network request based on the given web resource.
|
|
269
|
+
* @param webResource - A {@link WebResourceLike} that describes a HTTP request to be made.
|
|
270
|
+
*/
|
|
271
|
+
abstract sendRequest(webResource: WebResourceLike): Promise<CompatResponse>;
|
|
272
|
+
/**
|
|
273
|
+
* Get whether or not a log with the provided log level should be logged.
|
|
274
|
+
* @param logLevel - The log level of the log that will be logged.
|
|
275
|
+
* @returns Whether or not a log with the provided log level should be logged.
|
|
276
|
+
*/
|
|
277
|
+
shouldLog(logLevel: HttpPipelineLogLevel): boolean;
|
|
278
|
+
/**
|
|
279
|
+
* Attempt to log the provided message to the provided logger. If no logger was provided or if
|
|
280
|
+
* the log level does not meat the logger's threshold, then nothing will be logged.
|
|
281
|
+
* @param logLevel - The log level of this log.
|
|
282
|
+
* @param message - The message of this log.
|
|
283
|
+
*/
|
|
284
|
+
log(logLevel: HttpPipelineLogLevel, message: string): void;
|
|
247
285
|
}
|
|
248
|
-
export { BaseRequestPolicy };
|
|
249
286
|
/**
|
|
250
287
|
* An interface for options common to every remote operation.
|
|
251
288
|
*/
|
|
@@ -279,7 +316,7 @@ declare abstract class Credential_2 implements RequestPolicyFactory {
|
|
|
279
316
|
* @param _nextPolicy -
|
|
280
317
|
* @param _options -
|
|
281
318
|
*/
|
|
282
|
-
create(_nextPolicy: RequestPolicy, _options:
|
|
319
|
+
create(_nextPolicy: RequestPolicy, _options: RequestPolicyOptionsLike): RequestPolicy;
|
|
283
320
|
}
|
|
284
321
|
export { Credential_2 as Credential };
|
|
285
322
|
/**
|
|
@@ -292,19 +329,19 @@ export declare abstract class CredentialPolicy extends BaseRequestPolicy {
|
|
|
292
329
|
*
|
|
293
330
|
* @param request -
|
|
294
331
|
*/
|
|
295
|
-
sendRequest(request:
|
|
332
|
+
sendRequest(request: WebResourceLike): Promise<CompatResponse>;
|
|
296
333
|
/**
|
|
297
334
|
* Child classes must implement this method with request signing. This method
|
|
298
335
|
* will be executed in {@link sendRequest}.
|
|
299
336
|
*
|
|
300
337
|
* @param request -
|
|
301
338
|
*/
|
|
302
|
-
protected signRequest(request:
|
|
339
|
+
protected signRequest(request: WebResourceLike): WebResourceLike;
|
|
303
340
|
}
|
|
304
341
|
/**
|
|
305
342
|
* A factory function that creates a new CredentialPolicy that uses the provided nextPolicy.
|
|
306
343
|
*/
|
|
307
|
-
export declare type CredentialPolicyCreator = (nextPolicy: RequestPolicy, options:
|
|
344
|
+
export declare type CredentialPolicyCreator = (nextPolicy: RequestPolicy, options: RequestPolicyOptionsLike) => CredentialPolicy;
|
|
308
345
|
/** The object returned in the QueueMessageList array when calling Get Messages on a Queue. */
|
|
309
346
|
export declare interface DequeuedMessageItem {
|
|
310
347
|
/** The Id of the Message. */
|
|
@@ -322,7 +359,6 @@ export declare interface DequeuedMessageItem {
|
|
|
322
359
|
/** The content of the Message. */
|
|
323
360
|
messageText: string;
|
|
324
361
|
}
|
|
325
|
-
export { deserializationPolicy };
|
|
326
362
|
/** The object returned in the QueueMessageList array when calling Put Message on a Queue */
|
|
327
363
|
export declare interface EnqueuedMessage {
|
|
328
364
|
/** The Id of the Message. */
|
|
@@ -373,10 +409,31 @@ export declare interface GeoReplication {
|
|
|
373
409
|
}
|
|
374
410
|
/** Defines values for GeoReplicationStatusType. */
|
|
375
411
|
export declare type GeoReplicationStatusType = "live" | "bootstrap" | "unavailable";
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
|
|
412
|
+
/**
|
|
413
|
+
* A representation of an HTTP response that
|
|
414
|
+
* includes a reference to the request that
|
|
415
|
+
* originated it.
|
|
416
|
+
*/
|
|
417
|
+
export declare interface HttpResponse {
|
|
418
|
+
/**
|
|
419
|
+
* The headers from the response.
|
|
420
|
+
*/
|
|
421
|
+
headers: HttpHeadersLike;
|
|
422
|
+
/**
|
|
423
|
+
* The original request that resulted in this response.
|
|
424
|
+
*/
|
|
425
|
+
request: WebResourceLike;
|
|
426
|
+
/**
|
|
427
|
+
* The HTTP status code returned from the service.
|
|
428
|
+
*/
|
|
429
|
+
status: number;
|
|
430
|
+
}
|
|
431
|
+
/**
|
|
432
|
+
* A helper to decide if a given argument satisfies the Pipeline contract
|
|
433
|
+
* @param pipeline - An argument that may be a Pipeline
|
|
434
|
+
* @returns true when the argument satisfies the Pipeline contract
|
|
435
|
+
*/
|
|
436
|
+
export declare function isPipelineLike(pipeline: unknown): pipeline is PipelineLike;
|
|
380
437
|
/**
|
|
381
438
|
* Defines values for ListQueuesIncludeType.
|
|
382
439
|
* Possible values include: 'metadata'
|
|
@@ -409,6 +466,31 @@ export declare interface Logging {
|
|
|
409
466
|
/** the retention policy */
|
|
410
467
|
retentionPolicy: RetentionPolicy;
|
|
411
468
|
}
|
|
469
|
+
/** Interface representing a MessageId. */
|
|
470
|
+
declare interface MessageId {
|
|
471
|
+
/**
|
|
472
|
+
* The Update operation was introduced with version 2011-08-18 of the Queue service API. The Update
|
|
473
|
+
* Message operation updates the visibility timeout of a message. You can also use this operation to
|
|
474
|
+
* update the contents of a message. A message must be in a format that can be included in an XML
|
|
475
|
+
* request with UTF-8 encoding, and the encoded message can be up to 64KB in size.
|
|
476
|
+
* @param popReceipt Required. Specifies the valid pop receipt value returned from an earlier call to
|
|
477
|
+
* the Get Messages or Update Message operation.
|
|
478
|
+
* @param visibilityTimeout Optional. Specifies the new visibility timeout value, in seconds, relative
|
|
479
|
+
* to server time. The default value is 30 seconds. A specified value must be larger than or equal to 1
|
|
480
|
+
* second, and cannot be larger than 7 days, or larger than 2 hours on REST protocol versions prior to
|
|
481
|
+
* version 2011-08-18. The visibility timeout of a message can be set to a value later than the expiry
|
|
482
|
+
* time.
|
|
483
|
+
* @param options The options parameters.
|
|
484
|
+
*/
|
|
485
|
+
update(popReceipt: string, visibilityTimeout: number, options?: MessageIdUpdateOptionalParams): Promise<MessageIdUpdateResponse_2>;
|
|
486
|
+
/**
|
|
487
|
+
* The Delete operation deletes the specified message.
|
|
488
|
+
* @param popReceipt Required. Specifies the valid pop receipt value returned from an earlier call to
|
|
489
|
+
* the Get Messages or Update Message operation.
|
|
490
|
+
* @param options The options parameters.
|
|
491
|
+
*/
|
|
492
|
+
delete(popReceipt: string, options?: MessageIdDeleteOptionalParams): Promise<MessageIdDeleteResponse_2>;
|
|
493
|
+
}
|
|
412
494
|
/** Defines headers for MessageId_delete operation. */
|
|
413
495
|
export declare interface MessageIdDeleteHeaders {
|
|
414
496
|
/** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
|
|
@@ -422,14 +504,17 @@ export declare interface MessageIdDeleteHeaders {
|
|
|
422
504
|
/** Error Code */
|
|
423
505
|
errorCode?: string;
|
|
424
506
|
}
|
|
507
|
+
/** Optional parameters. */
|
|
508
|
+
declare interface MessageIdDeleteOptionalParams extends coreClient.OperationOptions {
|
|
509
|
+
/** The 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-queue-service-operations>Setting Timeouts for Queue Service Operations.</a> */
|
|
510
|
+
timeoutInSeconds?: number;
|
|
511
|
+
/** 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. */
|
|
512
|
+
requestId?: string;
|
|
513
|
+
}
|
|
425
514
|
/** Contains response data for the delete operation. */
|
|
426
|
-
export declare type MessageIdDeleteResponse = MessageIdDeleteHeaders
|
|
427
|
-
|
|
428
|
-
|
|
429
|
-
/** The parsed HTTP response headers. */
|
|
430
|
-
parsedHeaders: MessageIdDeleteHeaders;
|
|
431
|
-
};
|
|
432
|
-
};
|
|
515
|
+
export declare type MessageIdDeleteResponse = WithResponse<MessageIdDeleteHeaders, MessageIdDeleteHeaders>;
|
|
516
|
+
/** Contains response data for the delete operation. */
|
|
517
|
+
declare type MessageIdDeleteResponse_2 = MessageIdDeleteHeaders;
|
|
433
518
|
/** Defines headers for MessageId_update operation. */
|
|
434
519
|
export declare interface MessageIdUpdateHeaders {
|
|
435
520
|
/** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
|
|
@@ -447,14 +532,47 @@ export declare interface MessageIdUpdateHeaders {
|
|
|
447
532
|
/** Error Code */
|
|
448
533
|
errorCode?: string;
|
|
449
534
|
}
|
|
535
|
+
/** Optional parameters. */
|
|
536
|
+
declare interface MessageIdUpdateOptionalParams extends coreClient.OperationOptions {
|
|
537
|
+
/** The 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-queue-service-operations>Setting Timeouts for Queue Service Operations.</a> */
|
|
538
|
+
timeoutInSeconds?: number;
|
|
539
|
+
/** 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. */
|
|
540
|
+
requestId?: string;
|
|
541
|
+
/** A Message object which can be stored in a Queue */
|
|
542
|
+
queueMessage?: QueueMessage;
|
|
543
|
+
}
|
|
450
544
|
/** Contains response data for the update operation. */
|
|
451
|
-
export declare type MessageIdUpdateResponse = MessageIdUpdateHeaders
|
|
452
|
-
|
|
453
|
-
|
|
454
|
-
|
|
455
|
-
|
|
456
|
-
|
|
457
|
-
|
|
545
|
+
export declare type MessageIdUpdateResponse = WithResponse<MessageIdUpdateHeaders, MessageIdUpdateHeaders>;
|
|
546
|
+
/** Contains response data for the update operation. */
|
|
547
|
+
declare type MessageIdUpdateResponse_2 = MessageIdUpdateHeaders;
|
|
548
|
+
/** Interface representing a Messages. */
|
|
549
|
+
declare interface Messages {
|
|
550
|
+
/**
|
|
551
|
+
* The Dequeue operation retrieves one or more messages from the front of the queue.
|
|
552
|
+
* @param options The options parameters.
|
|
553
|
+
*/
|
|
554
|
+
dequeue(options?: MessagesDequeueOptionalParams_2): Promise<MessagesDequeueResponse>;
|
|
555
|
+
/**
|
|
556
|
+
* The Clear operation deletes all messages from the specified queue.
|
|
557
|
+
* @param options The options parameters.
|
|
558
|
+
*/
|
|
559
|
+
clear(options?: MessagesClearOptionalParams): Promise<MessagesClearResponse_2>;
|
|
560
|
+
/**
|
|
561
|
+
* The Enqueue operation adds a new message to the back of the message queue. A visibility timeout can
|
|
562
|
+
* also be specified to make the message invisible until the visibility timeout expires. A message must
|
|
563
|
+
* be in a format that can be included in an XML request with UTF-8 encoding. The encoded message can
|
|
564
|
+
* be up to 64 KB in size for versions 2011-08-18 and newer, or 8 KB in size for previous versions.
|
|
565
|
+
* @param queueMessage A Message object which can be stored in a Queue
|
|
566
|
+
* @param options The options parameters.
|
|
567
|
+
*/
|
|
568
|
+
enqueue(queueMessage: QueueMessage, options?: MessagesEnqueueOptionalParams_2): Promise<MessagesEnqueueResponse>;
|
|
569
|
+
/**
|
|
570
|
+
* The Peek operation retrieves one or more messages from the front of the queue, but does not alter
|
|
571
|
+
* the visibility of the message.
|
|
572
|
+
* @param options The options parameters.
|
|
573
|
+
*/
|
|
574
|
+
peek(options?: MessagesPeekOptionalParams_2): Promise<MessagesPeekResponse>;
|
|
575
|
+
}
|
|
458
576
|
/** Defines headers for Messages_clear operation. */
|
|
459
577
|
export declare interface MessagesClearHeaders {
|
|
460
578
|
/** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
|
|
@@ -468,14 +586,17 @@ export declare interface MessagesClearHeaders {
|
|
|
468
586
|
/** Error Code */
|
|
469
587
|
errorCode?: string;
|
|
470
588
|
}
|
|
589
|
+
/** Optional parameters. */
|
|
590
|
+
declare interface MessagesClearOptionalParams extends coreClient.OperationOptions {
|
|
591
|
+
/** The 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-queue-service-operations>Setting Timeouts for Queue Service Operations.</a> */
|
|
592
|
+
timeoutInSeconds?: number;
|
|
593
|
+
/** 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. */
|
|
594
|
+
requestId?: string;
|
|
595
|
+
}
|
|
471
596
|
/** Contains response data for the clear operation. */
|
|
472
|
-
export declare type MessagesClearResponse = MessagesClearHeaders
|
|
473
|
-
|
|
474
|
-
|
|
475
|
-
/** The parsed HTTP response headers. */
|
|
476
|
-
parsedHeaders: MessagesClearHeaders;
|
|
477
|
-
};
|
|
478
|
-
};
|
|
597
|
+
export declare type MessagesClearResponse = WithResponse<MessagesClearHeaders, MessagesClearHeaders>;
|
|
598
|
+
/** Contains response data for the clear operation. */
|
|
599
|
+
declare type MessagesClearResponse_2 = MessagesClearHeaders;
|
|
479
600
|
/** Defines headers for Messages_dequeue operation. */
|
|
480
601
|
export declare interface MessagesDequeueHeaders {
|
|
481
602
|
/** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
|
|
@@ -490,7 +611,7 @@ export declare interface MessagesDequeueHeaders {
|
|
|
490
611
|
errorCode?: string;
|
|
491
612
|
}
|
|
492
613
|
/** Optional parameters. */
|
|
493
|
-
export declare interface MessagesDequeueOptionalParams extends
|
|
614
|
+
export declare interface MessagesDequeueOptionalParams extends CommonOptions {
|
|
494
615
|
/** The 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-queue-service-operations">Setting Timeouts for Queue Service Operations.</a> */
|
|
495
616
|
timeoutInSeconds?: number;
|
|
496
617
|
/** 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. */
|
|
@@ -500,6 +621,19 @@ export declare interface MessagesDequeueOptionalParams extends RequestOptionsBas
|
|
|
500
621
|
/** Optional. Specifies the new visibility timeout value, in seconds, relative to server time. The default value is 30 seconds. A specified value must be larger than or equal to 1 second, and cannot be larger than 7 days, or larger than 2 hours on REST protocol versions prior to version 2011-08-18. The visibility timeout of a message can be set to a value later than the expiry time. */
|
|
501
622
|
visibilityTimeout?: number;
|
|
502
623
|
}
|
|
624
|
+
/** Optional parameters. */
|
|
625
|
+
declare interface MessagesDequeueOptionalParams_2 extends coreClient.OperationOptions {
|
|
626
|
+
/** The 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-queue-service-operations>Setting Timeouts for Queue Service Operations.</a> */
|
|
627
|
+
timeoutInSeconds?: number;
|
|
628
|
+
/** 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. */
|
|
629
|
+
requestId?: string;
|
|
630
|
+
/** Optional. A nonzero integer value that specifies the number of messages to retrieve from the queue, up to a maximum of 32. If fewer are visible, the visible messages are returned. By default, a single message is retrieved from the queue with this operation. */
|
|
631
|
+
numberOfMessages?: number;
|
|
632
|
+
/** Optional. Specifies the new visibility timeout value, in seconds, relative to server time. The default value is 30 seconds. A specified value must be larger than or equal to 1 second, and cannot be larger than 7 days, or larger than 2 hours on REST protocol versions prior to version 2011-08-18. The visibility timeout of a message can be set to a value later than the expiry time. */
|
|
633
|
+
visibilityTimeout?: number;
|
|
634
|
+
}
|
|
635
|
+
/** Contains response data for the dequeue operation. */
|
|
636
|
+
declare type MessagesDequeueResponse = MessagesDequeueHeaders & DequeuedMessageItem[];
|
|
503
637
|
/** Defines headers for Messages_enqueue operation. */
|
|
504
638
|
export declare interface MessagesEnqueueHeaders {
|
|
505
639
|
/** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
|
|
@@ -514,7 +648,7 @@ export declare interface MessagesEnqueueHeaders {
|
|
|
514
648
|
errorCode?: string;
|
|
515
649
|
}
|
|
516
650
|
/** Optional parameters. */
|
|
517
|
-
export declare interface MessagesEnqueueOptionalParams extends
|
|
651
|
+
export declare interface MessagesEnqueueOptionalParams extends CommonOptions {
|
|
518
652
|
/** The 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-queue-service-operations">Setting Timeouts for Queue Service Operations.</a> */
|
|
519
653
|
timeoutInSeconds?: number;
|
|
520
654
|
/** 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. */
|
|
@@ -524,6 +658,19 @@ export declare interface MessagesEnqueueOptionalParams extends RequestOptionsBas
|
|
|
524
658
|
/** Optional. Specifies the time-to-live interval for the message, in seconds. Prior to version 2017-07-29, the maximum time-to-live allowed is 7 days. For version 2017-07-29 or later, the maximum time-to-live can be any positive number, as well as -1 indicating that the message does not expire. If this parameter is omitted, the default time-to-live is 7 days. */
|
|
525
659
|
messageTimeToLive?: number;
|
|
526
660
|
}
|
|
661
|
+
/** Optional parameters. */
|
|
662
|
+
declare interface MessagesEnqueueOptionalParams_2 extends coreClient.OperationOptions {
|
|
663
|
+
/** The 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-queue-service-operations>Setting Timeouts for Queue Service Operations.</a> */
|
|
664
|
+
timeoutInSeconds?: number;
|
|
665
|
+
/** 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. */
|
|
666
|
+
requestId?: string;
|
|
667
|
+
/** Optional. If specified, the request must be made using an x-ms-version of 2011-08-18 or later. If not specified, the default value is 0. Specifies the new visibility timeout value, in seconds, relative to server time. The new value must be larger than or equal to 0, and cannot be larger than 7 days. The visibility timeout of a message cannot be set to a value later than the expiry time. visibilitytimeout should be set to a value smaller than the time-to-live value. */
|
|
668
|
+
visibilityTimeout?: number;
|
|
669
|
+
/** Optional. Specifies the time-to-live interval for the message, in seconds. Prior to version 2017-07-29, the maximum time-to-live allowed is 7 days. For version 2017-07-29 or later, the maximum time-to-live can be any positive number, as well as -1 indicating that the message does not expire. If this parameter is omitted, the default time-to-live is 7 days. */
|
|
670
|
+
messageTimeToLive?: number;
|
|
671
|
+
}
|
|
672
|
+
/** Contains response data for the enqueue operation. */
|
|
673
|
+
declare type MessagesEnqueueResponse = MessagesEnqueueHeaders & EnqueuedMessage[];
|
|
527
674
|
/** Defines headers for Messages_peek operation. */
|
|
528
675
|
export declare interface MessagesPeekHeaders {
|
|
529
676
|
/** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
|
|
@@ -538,7 +685,7 @@ export declare interface MessagesPeekHeaders {
|
|
|
538
685
|
errorCode?: string;
|
|
539
686
|
}
|
|
540
687
|
/** Optional parameters. */
|
|
541
|
-
export declare interface MessagesPeekOptionalParams extends
|
|
688
|
+
export declare interface MessagesPeekOptionalParams extends CommonOptions {
|
|
542
689
|
/** The 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-queue-service-operations">Setting Timeouts for Queue Service Operations.</a> */
|
|
543
690
|
timeoutInSeconds?: number;
|
|
544
691
|
/** 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. */
|
|
@@ -546,6 +693,17 @@ export declare interface MessagesPeekOptionalParams extends RequestOptionsBase {
|
|
|
546
693
|
/** Optional. A nonzero integer value that specifies the number of messages to retrieve from the queue, up to a maximum of 32. If fewer are visible, the visible messages are returned. By default, a single message is retrieved from the queue with this operation. */
|
|
547
694
|
numberOfMessages?: number;
|
|
548
695
|
}
|
|
696
|
+
/** Optional parameters. */
|
|
697
|
+
declare interface MessagesPeekOptionalParams_2 extends coreClient.OperationOptions {
|
|
698
|
+
/** The 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-queue-service-operations>Setting Timeouts for Queue Service Operations.</a> */
|
|
699
|
+
timeoutInSeconds?: number;
|
|
700
|
+
/** 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. */
|
|
701
|
+
requestId?: string;
|
|
702
|
+
/** Optional. A nonzero integer value that specifies the number of messages to retrieve from the queue, up to a maximum of 32. If fewer are visible, the visible messages are returned. By default, a single message is retrieved from the queue with this operation. */
|
|
703
|
+
numberOfMessages?: number;
|
|
704
|
+
}
|
|
705
|
+
/** Contains response data for the peek operation. */
|
|
706
|
+
declare type MessagesPeekResponse = MessagesPeekHeaders & PeekedMessageItem[];
|
|
549
707
|
/**
|
|
550
708
|
* A collection of key-value string pairs.
|
|
551
709
|
*/
|
|
@@ -570,7 +728,7 @@ export declare interface Metrics {
|
|
|
570
728
|
* Creates a new Pipeline object with Credential provided.
|
|
571
729
|
*
|
|
572
730
|
* @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.
|
|
573
|
-
* @param pipelineOptions - Options.
|
|
731
|
+
* @param pipelineOptions - Optional. Options.
|
|
574
732
|
* @returns A new Pipeline object.
|
|
575
733
|
*/
|
|
576
734
|
export declare function newPipeline(credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, pipelineOptions?: StoragePipelineOptions): Pipeline;
|
|
@@ -589,12 +747,13 @@ export declare interface PeekedMessageItem {
|
|
|
589
747
|
}
|
|
590
748
|
/**
|
|
591
749
|
* A Pipeline class containing HTTP request policies.
|
|
592
|
-
* You can create a default Pipeline by calling newPipeline
|
|
750
|
+
* You can create a default Pipeline by calling {@link newPipeline}.
|
|
593
751
|
* Or you can create a Pipeline with your own policies by the constructor of Pipeline.
|
|
594
|
-
*
|
|
595
|
-
* implementing your
|
|
752
|
+
*
|
|
753
|
+
* Refer to {@link newPipeline} and provided policies before implementing your
|
|
754
|
+
* customized Pipeline.
|
|
596
755
|
*/
|
|
597
|
-
export declare class Pipeline {
|
|
756
|
+
export declare class Pipeline implements PipelineLike {
|
|
598
757
|
/**
|
|
599
758
|
* A list of chained request policy factories.
|
|
600
759
|
*/
|
|
@@ -611,7 +770,32 @@ export declare class Pipeline {
|
|
|
611
770
|
*/
|
|
612
771
|
constructor(factories: RequestPolicyFactory[], options?: PipelineOptions);
|
|
613
772
|
/**
|
|
614
|
-
*
|
|
773
|
+
* Transfer Pipeline object to ServiceClientOptions object which is required by
|
|
774
|
+
* ServiceClient constructor.
|
|
775
|
+
*
|
|
776
|
+
* @returns The ServiceClientOptions object from this Pipeline.
|
|
777
|
+
*/
|
|
778
|
+
toServiceClientOptions(): ServiceClientOptions;
|
|
779
|
+
}
|
|
780
|
+
/**
|
|
781
|
+
* An interface for the {@link Pipeline} class containing HTTP request policies.
|
|
782
|
+
* You can create a default Pipeline by calling {@link newPipeline}.
|
|
783
|
+
* Or you can create a Pipeline with your own policies by the constructor of Pipeline.
|
|
784
|
+
*
|
|
785
|
+
* Refer to {@link newPipeline} and provided policies before implementing your
|
|
786
|
+
* customized Pipeline.
|
|
787
|
+
*/
|
|
788
|
+
export declare interface PipelineLike {
|
|
789
|
+
/**
|
|
790
|
+
* A list of chained request policy factories.
|
|
791
|
+
*/
|
|
792
|
+
readonly factories: RequestPolicyFactory[];
|
|
793
|
+
/**
|
|
794
|
+
* Configures pipeline logger and HTTP client.
|
|
795
|
+
*/
|
|
796
|
+
readonly options: PipelineOptions;
|
|
797
|
+
/**
|
|
798
|
+
* Transfer Pipeline object to ServiceClientOptions object which is required by
|
|
615
799
|
* ServiceClient constructor.
|
|
616
800
|
*
|
|
617
801
|
* @returns The ServiceClientOptions object from this Pipeline.
|
|
@@ -625,7 +809,43 @@ export declare interface PipelineOptions {
|
|
|
625
809
|
/**
|
|
626
810
|
* Optional. Configures the HTTP client to send requests and receive responses.
|
|
627
811
|
*/
|
|
628
|
-
httpClient?:
|
|
812
|
+
httpClient?: RequestPolicy;
|
|
813
|
+
}
|
|
814
|
+
/** Interface representing a Queue. */
|
|
815
|
+
declare interface Queue {
|
|
816
|
+
/**
|
|
817
|
+
* creates a new queue under the given account.
|
|
818
|
+
* @param options The options parameters.
|
|
819
|
+
*/
|
|
820
|
+
create(options?: QueueCreateOptionalParams): Promise<QueueCreateResponse_2>;
|
|
821
|
+
/**
|
|
822
|
+
* operation permanently deletes the specified queue
|
|
823
|
+
* @param options The options parameters.
|
|
824
|
+
*/
|
|
825
|
+
delete(options?: QueueDeleteOptionalParams): Promise<QueueDeleteResponse_2>;
|
|
826
|
+
/**
|
|
827
|
+
* Retrieves user-defined metadata and queue properties on the specified queue. Metadata is associated
|
|
828
|
+
* with the queue as name-values pairs.
|
|
829
|
+
* @param options The options parameters.
|
|
830
|
+
*/
|
|
831
|
+
getProperties(options?: QueueGetPropertiesOptionalParams): Promise<QueueGetPropertiesResponse_2>;
|
|
832
|
+
/**
|
|
833
|
+
* sets user-defined metadata on the specified queue. Metadata is associated with the queue as
|
|
834
|
+
* name-value pairs.
|
|
835
|
+
* @param options The options parameters.
|
|
836
|
+
*/
|
|
837
|
+
setMetadata(options?: QueueSetMetadataOptionalParams): Promise<QueueSetMetadataResponse_2>;
|
|
838
|
+
/**
|
|
839
|
+
* returns details about any stored access policies specified on the queue that may be used with Shared
|
|
840
|
+
* Access Signatures.
|
|
841
|
+
* @param options The options parameters.
|
|
842
|
+
*/
|
|
843
|
+
getAccessPolicy(options?: QueueGetAccessPolicyOptionalParams): Promise<QueueGetAccessPolicyResponse_2>;
|
|
844
|
+
/**
|
|
845
|
+
* sets stored access policies for the queue that may be used with Shared Access Signatures
|
|
846
|
+
* @param options The options parameters.
|
|
847
|
+
*/
|
|
848
|
+
setAccessPolicy(options?: QueueSetAccessPolicyOptionalParams): Promise<QueueSetAccessPolicyResponse_2>;
|
|
629
849
|
}
|
|
630
850
|
/**
|
|
631
851
|
* Options to configure {@link QueueClient.clearMessages} operation
|
|
@@ -934,6 +1154,17 @@ export declare interface QueueCreateIfNotExistsResponse extends QueueCreateRespo
|
|
|
934
1154
|
*/
|
|
935
1155
|
succeeded: boolean;
|
|
936
1156
|
}
|
|
1157
|
+
/** Optional parameters. */
|
|
1158
|
+
declare interface QueueCreateOptionalParams extends coreClient.OperationOptions {
|
|
1159
|
+
/** The 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-queue-service-operations>Setting Timeouts for Queue Service Operations.</a> */
|
|
1160
|
+
timeoutInSeconds?: number;
|
|
1161
|
+
/** 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. */
|
|
1162
|
+
requestId?: string;
|
|
1163
|
+
/** Optional. Include this parameter to specify that the queue's metadata be returned as part of the response body. Note that metadata requested with this parameter must be stored in accordance with the naming restrictions imposed by the 2009-09-19 version of the Queue service. Beginning with this version, all metadata names must adhere to the naming conventions for C# identifiers. */
|
|
1164
|
+
metadata?: {
|
|
1165
|
+
[propertyName: string]: string;
|
|
1166
|
+
};
|
|
1167
|
+
}
|
|
937
1168
|
/**
|
|
938
1169
|
* Options to configure {@link QueueClient.create} operation
|
|
939
1170
|
*/
|
|
@@ -949,14 +1180,12 @@ export declare interface QueueCreateOptions extends CommonOptions {
|
|
|
949
1180
|
*/
|
|
950
1181
|
metadata?: Metadata;
|
|
951
1182
|
}
|
|
1183
|
+
/**
|
|
1184
|
+
* Contains response data for the create operation.
|
|
1185
|
+
*/
|
|
1186
|
+
export declare type QueueCreateResponse = WithResponse<QueueCreateHeaders, QueueCreateHeaders>;
|
|
952
1187
|
/** Contains response data for the create operation. */
|
|
953
|
-
|
|
954
|
-
/** The underlying HTTP response. */
|
|
955
|
-
_response: coreHttp.HttpResponse & {
|
|
956
|
-
/** The parsed HTTP response headers. */
|
|
957
|
-
parsedHeaders: QueueCreateHeaders;
|
|
958
|
-
};
|
|
959
|
-
};
|
|
1188
|
+
declare type QueueCreateResponse_2 = QueueCreateHeaders;
|
|
960
1189
|
/** Defines headers for Queue_delete operation. */
|
|
961
1190
|
export declare interface QueueDeleteHeaders {
|
|
962
1191
|
/** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
|
|
@@ -993,6 +1222,13 @@ export declare interface QueueDeleteMessageOptions extends CommonOptions {
|
|
|
993
1222
|
* Contains response data for the {@link QueueClient.deleteMessage} operation.
|
|
994
1223
|
*/
|
|
995
1224
|
export declare type QueueDeleteMessageResponse = MessageIdDeleteResponse;
|
|
1225
|
+
/** Optional parameters. */
|
|
1226
|
+
declare interface QueueDeleteOptionalParams extends coreClient.OperationOptions {
|
|
1227
|
+
/** The 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-queue-service-operations>Setting Timeouts for Queue Service Operations.</a> */
|
|
1228
|
+
timeoutInSeconds?: number;
|
|
1229
|
+
/** 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. */
|
|
1230
|
+
requestId?: string;
|
|
1231
|
+
}
|
|
996
1232
|
/**
|
|
997
1233
|
* Options to configure {@link QueueClient.delete} operation
|
|
998
1234
|
*/
|
|
@@ -1004,13 +1240,9 @@ export declare interface QueueDeleteOptions extends CommonOptions {
|
|
|
1004
1240
|
abortSignal?: AbortSignalLike;
|
|
1005
1241
|
}
|
|
1006
1242
|
/** Contains response data for the delete operation. */
|
|
1007
|
-
export declare type QueueDeleteResponse = QueueDeleteHeaders
|
|
1008
|
-
|
|
1009
|
-
|
|
1010
|
-
/** The parsed HTTP response headers. */
|
|
1011
|
-
parsedHeaders: QueueDeleteHeaders;
|
|
1012
|
-
};
|
|
1013
|
-
};
|
|
1243
|
+
export declare type QueueDeleteResponse = WithResponse<QueueDeleteHeaders, QueueDeleteHeaders>;
|
|
1244
|
+
/** Contains response data for the delete operation. */
|
|
1245
|
+
declare type QueueDeleteResponse_2 = QueueDeleteHeaders;
|
|
1014
1246
|
/**
|
|
1015
1247
|
* Options to configure {@link QueueClient.exists} operation
|
|
1016
1248
|
*/
|
|
@@ -1071,6 +1303,13 @@ export declare interface QueueGetAccessPolicyHeaders {
|
|
|
1071
1303
|
/** Error Code */
|
|
1072
1304
|
errorCode?: string;
|
|
1073
1305
|
}
|
|
1306
|
+
/** Optional parameters. */
|
|
1307
|
+
declare interface QueueGetAccessPolicyOptionalParams extends coreClient.OperationOptions {
|
|
1308
|
+
/** The 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-queue-service-operations>Setting Timeouts for Queue Service Operations.</a> */
|
|
1309
|
+
timeoutInSeconds?: number;
|
|
1310
|
+
/** 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. */
|
|
1311
|
+
requestId?: string;
|
|
1312
|
+
}
|
|
1074
1313
|
/**
|
|
1075
1314
|
* Options to configure {@link QueueClient.getAccessPolicy} operation
|
|
1076
1315
|
*/
|
|
@@ -1084,27 +1323,11 @@ export declare interface QueueGetAccessPolicyOptions extends CommonOptions {
|
|
|
1084
1323
|
/**
|
|
1085
1324
|
* Contains response data for the {@link QueueClient.getAccessPolicy} operation.
|
|
1086
1325
|
*/
|
|
1087
|
-
export declare type QueueGetAccessPolicyResponse = {
|
|
1326
|
+
export declare type QueueGetAccessPolicyResponse = WithResponse<{
|
|
1088
1327
|
signedIdentifiers: SignedIdentifier[];
|
|
1089
|
-
} & QueueGetAccessPolicyHeaders
|
|
1090
|
-
|
|
1091
|
-
|
|
1092
|
-
*/
|
|
1093
|
-
_response: HttpResponse & {
|
|
1094
|
-
/**
|
|
1095
|
-
* The parsed HTTP response headers.
|
|
1096
|
-
*/
|
|
1097
|
-
parsedHeaders: QueueGetAccessPolicyHeaders;
|
|
1098
|
-
/**
|
|
1099
|
-
* The response body as text (string format)
|
|
1100
|
-
*/
|
|
1101
|
-
bodyAsText: string;
|
|
1102
|
-
/**
|
|
1103
|
-
* The response body as parsed JSON or XML
|
|
1104
|
-
*/
|
|
1105
|
-
parsedBody: SignedIdentifierModel[];
|
|
1106
|
-
};
|
|
1107
|
-
};
|
|
1328
|
+
} & QueueGetAccessPolicyHeaders, QueueGetAccessPolicyHeaders, SignedIdentifierModel[]>;
|
|
1329
|
+
/** Contains response data for the getAccessPolicy operation. */
|
|
1330
|
+
declare type QueueGetAccessPolicyResponse_2 = QueueGetAccessPolicyHeaders & SignedIdentifierModel[];
|
|
1108
1331
|
/** Defines headers for Queue_getProperties operation. */
|
|
1109
1332
|
export declare interface QueueGetPropertiesHeaders {
|
|
1110
1333
|
metadata?: {
|
|
@@ -1123,6 +1346,13 @@ export declare interface QueueGetPropertiesHeaders {
|
|
|
1123
1346
|
/** Error Code */
|
|
1124
1347
|
errorCode?: string;
|
|
1125
1348
|
}
|
|
1349
|
+
/** Optional parameters. */
|
|
1350
|
+
declare interface QueueGetPropertiesOptionalParams extends coreClient.OperationOptions {
|
|
1351
|
+
/** The 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-queue-service-operations>Setting Timeouts for Queue Service Operations.</a> */
|
|
1352
|
+
timeoutInSeconds?: number;
|
|
1353
|
+
/** 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. */
|
|
1354
|
+
requestId?: string;
|
|
1355
|
+
}
|
|
1126
1356
|
/**
|
|
1127
1357
|
* Options to configure {@link QueueClient.getProperties} operation
|
|
1128
1358
|
*/
|
|
@@ -1134,13 +1364,9 @@ export declare interface QueueGetPropertiesOptions extends CommonOptions {
|
|
|
1134
1364
|
abortSignal?: AbortSignalLike;
|
|
1135
1365
|
}
|
|
1136
1366
|
/** Contains response data for the getProperties operation. */
|
|
1137
|
-
export declare type QueueGetPropertiesResponse = QueueGetPropertiesHeaders
|
|
1138
|
-
|
|
1139
|
-
|
|
1140
|
-
/** The parsed HTTP response headers. */
|
|
1141
|
-
parsedHeaders: QueueGetPropertiesHeaders;
|
|
1142
|
-
};
|
|
1143
|
-
};
|
|
1367
|
+
export declare type QueueGetPropertiesResponse = WithResponse<QueueGetPropertiesHeaders, QueueGetPropertiesHeaders>;
|
|
1368
|
+
/** Contains response data for the getProperties operation. */
|
|
1369
|
+
declare type QueueGetPropertiesResponse_2 = QueueGetPropertiesHeaders;
|
|
1144
1370
|
/** An Azure Storage Queue. */
|
|
1145
1371
|
export declare interface QueueItem {
|
|
1146
1372
|
/** The name of the Queue. */
|
|
@@ -1150,6 +1376,11 @@ export declare interface QueueItem {
|
|
|
1150
1376
|
[propertyName: string]: string;
|
|
1151
1377
|
};
|
|
1152
1378
|
}
|
|
1379
|
+
/** A Message object which can be stored in a Queue */
|
|
1380
|
+
declare interface QueueMessage {
|
|
1381
|
+
/** The content of the message */
|
|
1382
|
+
messageText: string;
|
|
1383
|
+
}
|
|
1153
1384
|
/**
|
|
1154
1385
|
* Options to configure {@link QueueClient.peekMessages} operation
|
|
1155
1386
|
*/
|
|
@@ -1158,27 +1389,9 @@ export declare interface QueuePeekMessagesOptions extends MessagesPeekOptionalPa
|
|
|
1158
1389
|
/**
|
|
1159
1390
|
* Contains the response data for the {@link QueueClient.peekMessages} operation.
|
|
1160
1391
|
*/
|
|
1161
|
-
export declare type QueuePeekMessagesResponse = {
|
|
1392
|
+
export declare type QueuePeekMessagesResponse = WithResponse<{
|
|
1162
1393
|
peekedMessageItems: PeekedMessageItem[];
|
|
1163
|
-
} & MessagesPeekHeaders
|
|
1164
|
-
/**
|
|
1165
|
-
* The underlying HTTP response.
|
|
1166
|
-
*/
|
|
1167
|
-
_response: HttpResponse & {
|
|
1168
|
-
/**
|
|
1169
|
-
* The parsed HTTP response headers.
|
|
1170
|
-
*/
|
|
1171
|
-
parsedHeaders: MessagesPeekHeaders;
|
|
1172
|
-
/**
|
|
1173
|
-
* The response body as text (string format)
|
|
1174
|
-
*/
|
|
1175
|
-
bodyAsText: string;
|
|
1176
|
-
/**
|
|
1177
|
-
* The response body as parsed JSON or XML
|
|
1178
|
-
*/
|
|
1179
|
-
parsedBody: PeekedMessageItem[];
|
|
1180
|
-
};
|
|
1181
|
-
};
|
|
1394
|
+
} & MessagesPeekHeaders, MessagesPeekHeaders, PeekedMessageItem[]>;
|
|
1182
1395
|
/**
|
|
1183
1396
|
* Options to configure {@link QueueClient.receiveMessages} operation
|
|
1184
1397
|
*/
|
|
@@ -1187,27 +1400,9 @@ export declare interface QueueReceiveMessageOptions extends MessagesDequeueOptio
|
|
|
1187
1400
|
/**
|
|
1188
1401
|
* Contains the response data for the {@link QueueClient.receiveMessages} operation.
|
|
1189
1402
|
*/
|
|
1190
|
-
export declare type QueueReceiveMessageResponse = {
|
|
1403
|
+
export declare type QueueReceiveMessageResponse = WithResponse<{
|
|
1191
1404
|
receivedMessageItems: ReceivedMessageItem[];
|
|
1192
|
-
} & MessagesDequeueHeaders
|
|
1193
|
-
/**
|
|
1194
|
-
* The underlying HTTP response.
|
|
1195
|
-
*/
|
|
1196
|
-
_response: HttpResponse & {
|
|
1197
|
-
/**
|
|
1198
|
-
* The parsed HTTP response headers.
|
|
1199
|
-
*/
|
|
1200
|
-
parsedHeaders: MessagesDequeueHeaders;
|
|
1201
|
-
/**
|
|
1202
|
-
* The response body as text (string format)
|
|
1203
|
-
*/
|
|
1204
|
-
bodyAsText: string;
|
|
1205
|
-
/**
|
|
1206
|
-
* The response body as parsed JSON or XML
|
|
1207
|
-
*/
|
|
1208
|
-
parsedBody: ReceivedMessageItem[];
|
|
1209
|
-
};
|
|
1210
|
-
};
|
|
1405
|
+
} & MessagesDequeueHeaders, MessagesDequeueHeaders, ReceivedMessageItem[]>;
|
|
1211
1406
|
/**
|
|
1212
1407
|
* ONLY AVAILABLE IN NODE.JS RUNTIME.
|
|
1213
1408
|
*
|
|
@@ -1301,7 +1496,7 @@ export declare interface QueueSendMessageOptions extends MessagesEnqueueOptional
|
|
|
1301
1496
|
/**
|
|
1302
1497
|
* Contains the response data for the {@link QueueClient.sendMessage} operation.
|
|
1303
1498
|
*/
|
|
1304
|
-
export declare type QueueSendMessageResponse = {
|
|
1499
|
+
export declare type QueueSendMessageResponse = WithResponse<{
|
|
1305
1500
|
/**
|
|
1306
1501
|
* The ID of the sent Message.
|
|
1307
1502
|
*/
|
|
@@ -1327,25 +1522,7 @@ export declare type QueueSendMessageResponse = {
|
|
|
1327
1522
|
* visible in the Queue.
|
|
1328
1523
|
*/
|
|
1329
1524
|
nextVisibleOn: Date;
|
|
1330
|
-
} & MessagesEnqueueHeaders
|
|
1331
|
-
/**
|
|
1332
|
-
* The underlying HTTP response.
|
|
1333
|
-
*/
|
|
1334
|
-
_response: HttpResponse & {
|
|
1335
|
-
/**
|
|
1336
|
-
* The parsed HTTP response headers.
|
|
1337
|
-
*/
|
|
1338
|
-
parsedHeaders: MessagesEnqueueHeaders;
|
|
1339
|
-
/**
|
|
1340
|
-
* The response body as text (string format)
|
|
1341
|
-
*/
|
|
1342
|
-
bodyAsText: string;
|
|
1343
|
-
/**
|
|
1344
|
-
* The response body as parsed JSON or XML
|
|
1345
|
-
*/
|
|
1346
|
-
parsedBody: EnqueuedMessage[];
|
|
1347
|
-
};
|
|
1348
|
-
};
|
|
1525
|
+
} & MessagesEnqueueHeaders, MessagesEnqueueHeaders, EnqueuedMessage[]>;
|
|
1349
1526
|
/**
|
|
1350
1527
|
* A QueueServiceClient represents a URL to the Azure Storage Queue service allowing you
|
|
1351
1528
|
* to manipulate queues.
|
|
@@ -1489,7 +1666,7 @@ export declare class QueueServiceClient extends StorageClient {
|
|
|
1489
1666
|
* let iterator = queueServiceClient.listQueues();
|
|
1490
1667
|
* let item = await iterator.next();
|
|
1491
1668
|
* while (!item.done) {
|
|
1492
|
-
* console.log(`Queue${i}: ${
|
|
1669
|
+
* console.log(`Queue${i}: ${item.value.name}`);
|
|
1493
1670
|
* i++;
|
|
1494
1671
|
* item = await iterator.next();
|
|
1495
1672
|
* }
|
|
@@ -1636,6 +1813,15 @@ export declare interface QueueSetAccessPolicyHeaders {
|
|
|
1636
1813
|
/** Error Code */
|
|
1637
1814
|
errorCode?: string;
|
|
1638
1815
|
}
|
|
1816
|
+
/** Optional parameters. */
|
|
1817
|
+
declare interface QueueSetAccessPolicyOptionalParams extends coreClient.OperationOptions {
|
|
1818
|
+
/** The 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-queue-service-operations>Setting Timeouts for Queue Service Operations.</a> */
|
|
1819
|
+
timeoutInSeconds?: number;
|
|
1820
|
+
/** 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. */
|
|
1821
|
+
requestId?: string;
|
|
1822
|
+
/** the acls for the queue */
|
|
1823
|
+
queueAcl?: SignedIdentifierModel[];
|
|
1824
|
+
}
|
|
1639
1825
|
/**
|
|
1640
1826
|
* Options to configure {@link QueueClient.setAccessPolicy} operation
|
|
1641
1827
|
*/
|
|
@@ -1647,13 +1833,9 @@ export declare interface QueueSetAccessPolicyOptions extends CommonOptions {
|
|
|
1647
1833
|
abortSignal?: AbortSignalLike;
|
|
1648
1834
|
}
|
|
1649
1835
|
/** Contains response data for the setAccessPolicy operation. */
|
|
1650
|
-
export declare type QueueSetAccessPolicyResponse = QueueSetAccessPolicyHeaders
|
|
1651
|
-
|
|
1652
|
-
|
|
1653
|
-
/** The parsed HTTP response headers. */
|
|
1654
|
-
parsedHeaders: QueueSetAccessPolicyHeaders;
|
|
1655
|
-
};
|
|
1656
|
-
};
|
|
1836
|
+
export declare type QueueSetAccessPolicyResponse = WithResponse<QueueSetAccessPolicyHeaders, QueueSetAccessPolicyHeaders>;
|
|
1837
|
+
/** Contains response data for the setAccessPolicy operation. */
|
|
1838
|
+
declare type QueueSetAccessPolicyResponse_2 = QueueSetAccessPolicyHeaders;
|
|
1657
1839
|
/** Defines headers for Queue_setMetadata operation. */
|
|
1658
1840
|
export declare interface QueueSetMetadataHeaders {
|
|
1659
1841
|
/** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
|
|
@@ -1667,6 +1849,17 @@ export declare interface QueueSetMetadataHeaders {
|
|
|
1667
1849
|
/** Error Code */
|
|
1668
1850
|
errorCode?: string;
|
|
1669
1851
|
}
|
|
1852
|
+
/** Optional parameters. */
|
|
1853
|
+
declare interface QueueSetMetadataOptionalParams extends coreClient.OperationOptions {
|
|
1854
|
+
/** The 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-queue-service-operations>Setting Timeouts for Queue Service Operations.</a> */
|
|
1855
|
+
timeoutInSeconds?: number;
|
|
1856
|
+
/** 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. */
|
|
1857
|
+
requestId?: string;
|
|
1858
|
+
/** Optional. Include this parameter to specify that the queue's metadata be returned as part of the response body. Note that metadata requested with this parameter must be stored in accordance with the naming restrictions imposed by the 2009-09-19 version of the Queue service. Beginning with this version, all metadata names must adhere to the naming conventions for C# identifiers. */
|
|
1859
|
+
metadata?: {
|
|
1860
|
+
[propertyName: string]: string;
|
|
1861
|
+
};
|
|
1862
|
+
}
|
|
1670
1863
|
/**
|
|
1671
1864
|
* Options to configure {@link QueueClient.setMetadata} operation
|
|
1672
1865
|
*/
|
|
@@ -1678,13 +1871,9 @@ export declare interface QueueSetMetadataOptions extends CommonOptions {
|
|
|
1678
1871
|
abortSignal?: AbortSignalLike;
|
|
1679
1872
|
}
|
|
1680
1873
|
/** Contains response data for the setMetadata operation. */
|
|
1681
|
-
export declare type QueueSetMetadataResponse = QueueSetMetadataHeaders
|
|
1682
|
-
|
|
1683
|
-
|
|
1684
|
-
/** The parsed HTTP response headers. */
|
|
1685
|
-
parsedHeaders: QueueSetMetadataHeaders;
|
|
1686
|
-
};
|
|
1687
|
-
};
|
|
1874
|
+
export declare type QueueSetMetadataResponse = WithResponse<QueueSetMetadataHeaders, QueueSetMetadataHeaders>;
|
|
1875
|
+
/** Contains response data for the setMetadata operation. */
|
|
1876
|
+
declare type QueueSetMetadataResponse_2 = QueueSetMetadataHeaders;
|
|
1688
1877
|
/**
|
|
1689
1878
|
* Options to configure {@link QueueClient.updateMessage} operation
|
|
1690
1879
|
*/
|
|
@@ -1705,9 +1894,53 @@ export declare type QueueUpdateMessageResponse = MessageIdUpdateResponse;
|
|
|
1705
1894
|
* See: {@link QueueReceiveMessageResponse}
|
|
1706
1895
|
*/
|
|
1707
1896
|
export declare type ReceivedMessageItem = DequeuedMessageItem;
|
|
1708
|
-
|
|
1709
|
-
|
|
1710
|
-
|
|
1897
|
+
/**
|
|
1898
|
+
* An object with a simple _response property.
|
|
1899
|
+
*/
|
|
1900
|
+
export declare interface ResponseLike {
|
|
1901
|
+
/**
|
|
1902
|
+
* The underlying HTTP response.
|
|
1903
|
+
*/
|
|
1904
|
+
_response: HttpResponse;
|
|
1905
|
+
}
|
|
1906
|
+
/**
|
|
1907
|
+
* An object with a _response property that has body
|
|
1908
|
+
* and headers already parsed into known types.
|
|
1909
|
+
*/
|
|
1910
|
+
export declare interface ResponseWithBody<Headers, Body> {
|
|
1911
|
+
/**
|
|
1912
|
+
* The underlying HTTP response.
|
|
1913
|
+
*/
|
|
1914
|
+
_response: HttpResponse & {
|
|
1915
|
+
/**
|
|
1916
|
+
* The parsed HTTP response headers.
|
|
1917
|
+
*/
|
|
1918
|
+
parsedHeaders: Headers;
|
|
1919
|
+
/**
|
|
1920
|
+
* The response body as text (string format)
|
|
1921
|
+
*/
|
|
1922
|
+
bodyAsText: string;
|
|
1923
|
+
/**
|
|
1924
|
+
* The response body as parsed JSON or XML
|
|
1925
|
+
*/
|
|
1926
|
+
parsedBody: Body;
|
|
1927
|
+
};
|
|
1928
|
+
}
|
|
1929
|
+
/**
|
|
1930
|
+
* An object with a _response property that has
|
|
1931
|
+
* headers already parsed into a typed object.
|
|
1932
|
+
*/
|
|
1933
|
+
export declare interface ResponseWithHeaders<Headers> {
|
|
1934
|
+
/**
|
|
1935
|
+
* The underlying HTTP response.
|
|
1936
|
+
*/
|
|
1937
|
+
_response: HttpResponse & {
|
|
1938
|
+
/**
|
|
1939
|
+
* The parsed HTTP response headers.
|
|
1940
|
+
*/
|
|
1941
|
+
parsedHeaders: Headers;
|
|
1942
|
+
};
|
|
1943
|
+
}
|
|
1711
1944
|
export { RestError };
|
|
1712
1945
|
/** the retention policy */
|
|
1713
1946
|
export declare interface RetentionPolicy {
|
|
@@ -1839,6 +2072,47 @@ export declare class SASQueryParameters {
|
|
|
1839
2072
|
*/
|
|
1840
2073
|
private tryAppendQueryParameter;
|
|
1841
2074
|
}
|
|
2075
|
+
/** Interface representing a Service. */
|
|
2076
|
+
declare interface Service {
|
|
2077
|
+
/**
|
|
2078
|
+
* Sets properties for a storage account's Queue service endpoint, including properties for Storage
|
|
2079
|
+
* Analytics and CORS (Cross-Origin Resource Sharing) rules
|
|
2080
|
+
* @param properties The StorageService properties.
|
|
2081
|
+
* @param options The options parameters.
|
|
2082
|
+
*/
|
|
2083
|
+
setProperties(properties: QueueServiceProperties, options?: ServiceSetPropertiesOptionalParams): Promise<ServiceSetPropertiesResponse_2>;
|
|
2084
|
+
/**
|
|
2085
|
+
* gets the properties of a storage account's Queue service, including properties for Storage Analytics
|
|
2086
|
+
* and CORS (Cross-Origin Resource Sharing) rules.
|
|
2087
|
+
* @param options The options parameters.
|
|
2088
|
+
*/
|
|
2089
|
+
getProperties(options?: ServiceGetPropertiesOptionalParams): Promise<ServiceGetPropertiesResponse_2>;
|
|
2090
|
+
/**
|
|
2091
|
+
* Retrieves statistics related to replication for the Queue service. It is only available on the
|
|
2092
|
+
* secondary location endpoint when read-access geo-redundant replication is enabled for the storage
|
|
2093
|
+
* account.
|
|
2094
|
+
* @param options The options parameters.
|
|
2095
|
+
*/
|
|
2096
|
+
getStatistics(options?: ServiceGetStatisticsOptionalParams): Promise<ServiceGetStatisticsResponse_2>;
|
|
2097
|
+
/**
|
|
2098
|
+
* The List Queues Segment operation returns a list of the queues under the specified account
|
|
2099
|
+
* @param options The options parameters.
|
|
2100
|
+
*/
|
|
2101
|
+
listQueuesSegment(options?: ServiceListQueuesSegmentOptionalParams): Promise<ServiceListQueuesSegmentResponse_2>;
|
|
2102
|
+
}
|
|
2103
|
+
/**
|
|
2104
|
+
* A subset of `@azure/core-http` ServiceClientOptions
|
|
2105
|
+
*/
|
|
2106
|
+
export declare interface ServiceClientOptions {
|
|
2107
|
+
/**
|
|
2108
|
+
* Optional. Configures the HTTP client to send requests and receive responses.
|
|
2109
|
+
*/
|
|
2110
|
+
httpClient?: RequestPolicy;
|
|
2111
|
+
/**
|
|
2112
|
+
* Optional. Overrides the default policy factories.
|
|
2113
|
+
*/
|
|
2114
|
+
requestPolicyFactories?: RequestPolicyFactory[] | ((defaultRequestPolicyFactories: RequestPolicyFactory[]) => void | RequestPolicyFactory[]);
|
|
2115
|
+
}
|
|
1842
2116
|
/**
|
|
1843
2117
|
* Options to configure {@link QueueServiceClient.generateAccountSasUrl} operation.
|
|
1844
2118
|
*/
|
|
@@ -1872,6 +2146,13 @@ export declare interface ServiceGetPropertiesHeaders {
|
|
|
1872
2146
|
/** Error Code */
|
|
1873
2147
|
errorCode?: string;
|
|
1874
2148
|
}
|
|
2149
|
+
/** Optional parameters. */
|
|
2150
|
+
declare interface ServiceGetPropertiesOptionalParams extends coreClient.OperationOptions {
|
|
2151
|
+
/** The 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-queue-service-operations>Setting Timeouts for Queue Service Operations.</a> */
|
|
2152
|
+
timeoutInSeconds?: number;
|
|
2153
|
+
/** 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. */
|
|
2154
|
+
requestId?: string;
|
|
2155
|
+
}
|
|
1875
2156
|
/**
|
|
1876
2157
|
* Options to configure {@link QueueServiceClient.getProperties} operation
|
|
1877
2158
|
*/
|
|
@@ -1883,17 +2164,9 @@ export declare interface ServiceGetPropertiesOptions extends CommonOptions {
|
|
|
1883
2164
|
abortSignal?: AbortSignalLike;
|
|
1884
2165
|
}
|
|
1885
2166
|
/** Contains response data for the getProperties operation. */
|
|
1886
|
-
export declare type ServiceGetPropertiesResponse = ServiceGetPropertiesHeaders & QueueServiceProperties
|
|
1887
|
-
|
|
1888
|
-
|
|
1889
|
-
/** The response body as text (string format) */
|
|
1890
|
-
bodyAsText: string;
|
|
1891
|
-
/** The response body as parsed JSON or XML */
|
|
1892
|
-
parsedBody: QueueServiceProperties;
|
|
1893
|
-
/** The parsed HTTP response headers. */
|
|
1894
|
-
parsedHeaders: ServiceGetPropertiesHeaders;
|
|
1895
|
-
};
|
|
1896
|
-
};
|
|
2167
|
+
export declare type ServiceGetPropertiesResponse = WithResponse<ServiceGetPropertiesHeaders & QueueServiceProperties, ServiceGetPropertiesHeaders, QueueServiceProperties>;
|
|
2168
|
+
/** Contains response data for the getProperties operation. */
|
|
2169
|
+
declare type ServiceGetPropertiesResponse_2 = ServiceGetPropertiesHeaders & QueueServiceProperties;
|
|
1897
2170
|
/** Defines headers for Service_getStatistics operation. */
|
|
1898
2171
|
export declare interface ServiceGetStatisticsHeaders {
|
|
1899
2172
|
/** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
|
|
@@ -1907,6 +2180,13 @@ export declare interface ServiceGetStatisticsHeaders {
|
|
|
1907
2180
|
/** Error Code */
|
|
1908
2181
|
errorCode?: string;
|
|
1909
2182
|
}
|
|
2183
|
+
/** Optional parameters. */
|
|
2184
|
+
declare interface ServiceGetStatisticsOptionalParams extends coreClient.OperationOptions {
|
|
2185
|
+
/** The 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-queue-service-operations>Setting Timeouts for Queue Service Operations.</a> */
|
|
2186
|
+
timeoutInSeconds?: number;
|
|
2187
|
+
/** 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. */
|
|
2188
|
+
requestId?: string;
|
|
2189
|
+
}
|
|
1910
2190
|
/**
|
|
1911
2191
|
* Options to configure {@link QueueServiceClient.getStatistics} operation
|
|
1912
2192
|
*/
|
|
@@ -1918,17 +2198,9 @@ export declare interface ServiceGetStatisticsOptions extends CommonOptions {
|
|
|
1918
2198
|
abortSignal?: AbortSignalLike;
|
|
1919
2199
|
}
|
|
1920
2200
|
/** Contains response data for the getStatistics operation. */
|
|
1921
|
-
export declare type ServiceGetStatisticsResponse = ServiceGetStatisticsHeaders & QueueServiceStatistics
|
|
1922
|
-
|
|
1923
|
-
|
|
1924
|
-
/** The response body as text (string format) */
|
|
1925
|
-
bodyAsText: string;
|
|
1926
|
-
/** The response body as parsed JSON or XML */
|
|
1927
|
-
parsedBody: QueueServiceStatistics;
|
|
1928
|
-
/** The parsed HTTP response headers. */
|
|
1929
|
-
parsedHeaders: ServiceGetStatisticsHeaders;
|
|
1930
|
-
};
|
|
1931
|
-
};
|
|
2201
|
+
export declare type ServiceGetStatisticsResponse = WithResponse<ServiceGetStatisticsHeaders & QueueServiceStatistics, ServiceGetStatisticsHeaders, QueueServiceStatistics>;
|
|
2202
|
+
/** Contains response data for the getStatistics operation. */
|
|
2203
|
+
declare type ServiceGetStatisticsResponse_2 = ServiceGetStatisticsHeaders & QueueServiceStatistics;
|
|
1932
2204
|
/**
|
|
1933
2205
|
* Options to configure {@link QueueServiceClient.listQueues} operation
|
|
1934
2206
|
*/
|
|
@@ -1962,18 +2234,25 @@ export declare interface ServiceListQueuesSegmentHeaders {
|
|
|
1962
2234
|
/** Error Code */
|
|
1963
2235
|
errorCode?: string;
|
|
1964
2236
|
}
|
|
2237
|
+
/** Optional parameters. */
|
|
2238
|
+
declare interface ServiceListQueuesSegmentOptionalParams extends coreClient.OperationOptions {
|
|
2239
|
+
/** The 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-queue-service-operations>Setting Timeouts for Queue Service Operations.</a> */
|
|
2240
|
+
timeoutInSeconds?: number;
|
|
2241
|
+
/** 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. */
|
|
2242
|
+
requestId?: string;
|
|
2243
|
+
/** Filters the results to return only queues whose name begins with the specified prefix. */
|
|
2244
|
+
prefix?: string;
|
|
2245
|
+
/** A string value that identifies the portion of the list of queues to be returned with the next listing operation. The operation returns the ContinuationToken value within the response body if the listing operation did not return all queues remaining to be listed with the current page. The NextMarker value can be used as the value for the marker parameter in a subsequent call to request the next page of list items. The marker value is opaque to the client. */
|
|
2246
|
+
marker?: string;
|
|
2247
|
+
/** Specifies the maximum number of queues to return. If the request does not specify maxresults, or specifies a value greater than 5000, the server will return up to 5000 items. Note that if the listing operation crosses a partition boundary, then the service will return a continuation token for retrieving the remainder of the results. For this reason, it is possible that the service will return fewer results than specified by maxresults, or than the default of 5000. */
|
|
2248
|
+
maxPageSize?: number;
|
|
2249
|
+
/** Include this parameter to specify that the queues' metadata be returned as part of the response body. */
|
|
2250
|
+
include?: string[];
|
|
2251
|
+
}
|
|
1965
2252
|
/** Contains response data for the listQueuesSegment operation. */
|
|
1966
|
-
export declare type ServiceListQueuesSegmentResponse = ServiceListQueuesSegmentHeaders & ListQueuesSegmentResponse
|
|
1967
|
-
|
|
1968
|
-
|
|
1969
|
-
/** The response body as text (string format) */
|
|
1970
|
-
bodyAsText: string;
|
|
1971
|
-
/** The response body as parsed JSON or XML */
|
|
1972
|
-
parsedBody: ListQueuesSegmentResponse;
|
|
1973
|
-
/** The parsed HTTP response headers. */
|
|
1974
|
-
parsedHeaders: ServiceListQueuesSegmentHeaders;
|
|
1975
|
-
};
|
|
1976
|
-
};
|
|
2253
|
+
export declare type ServiceListQueuesSegmentResponse = WithResponse<ServiceListQueuesSegmentHeaders & ListQueuesSegmentResponse, ServiceListQueuesSegmentHeaders, ListQueuesSegmentResponse>;
|
|
2254
|
+
/** Contains response data for the listQueuesSegment operation. */
|
|
2255
|
+
declare type ServiceListQueuesSegmentResponse_2 = ServiceListQueuesSegmentHeaders & ListQueuesSegmentResponse;
|
|
1977
2256
|
/** Defines headers for Service_setProperties operation. */
|
|
1978
2257
|
export declare interface ServiceSetPropertiesHeaders {
|
|
1979
2258
|
/** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
|
|
@@ -1985,6 +2264,13 @@ export declare interface ServiceSetPropertiesHeaders {
|
|
|
1985
2264
|
/** Error Code */
|
|
1986
2265
|
errorCode?: string;
|
|
1987
2266
|
}
|
|
2267
|
+
/** Optional parameters. */
|
|
2268
|
+
declare interface ServiceSetPropertiesOptionalParams extends coreClient.OperationOptions {
|
|
2269
|
+
/** The 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-queue-service-operations>Setting Timeouts for Queue Service Operations.</a> */
|
|
2270
|
+
timeoutInSeconds?: number;
|
|
2271
|
+
/** 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. */
|
|
2272
|
+
requestId?: string;
|
|
2273
|
+
}
|
|
1988
2274
|
/**
|
|
1989
2275
|
* Options to configure {@link QueueServiceClient.setProperties} operation
|
|
1990
2276
|
*/
|
|
@@ -1996,13 +2282,9 @@ export declare interface ServiceSetPropertiesOptions extends CommonOptions {
|
|
|
1996
2282
|
abortSignal?: AbortSignalLike;
|
|
1997
2283
|
}
|
|
1998
2284
|
/** Contains response data for the setProperties operation. */
|
|
1999
|
-
export declare type ServiceSetPropertiesResponse = ServiceSetPropertiesHeaders
|
|
2000
|
-
|
|
2001
|
-
|
|
2002
|
-
/** The parsed HTTP response headers. */
|
|
2003
|
-
parsedHeaders: ServiceSetPropertiesHeaders;
|
|
2004
|
-
};
|
|
2005
|
-
};
|
|
2285
|
+
export declare type ServiceSetPropertiesResponse = WithResponse<ServiceSetPropertiesHeaders, ServiceSetPropertiesHeaders>;
|
|
2286
|
+
/** Contains response data for the setProperties operation. */
|
|
2287
|
+
declare type ServiceSetPropertiesResponse_2 = ServiceSetPropertiesHeaders;
|
|
2006
2288
|
/**
|
|
2007
2289
|
* Signed identifier.
|
|
2008
2290
|
*/
|
|
@@ -2054,16 +2336,16 @@ export declare class StorageBrowserPolicy extends BaseRequestPolicy {
|
|
|
2054
2336
|
* @param nextPolicy -
|
|
2055
2337
|
* @param options -
|
|
2056
2338
|
*/
|
|
2057
|
-
constructor(nextPolicy: RequestPolicy, options:
|
|
2339
|
+
constructor(nextPolicy: RequestPolicy, options: RequestPolicyOptionsLike);
|
|
2058
2340
|
/**
|
|
2059
2341
|
* Sends out request.
|
|
2060
2342
|
*
|
|
2061
2343
|
* @param request -
|
|
2062
2344
|
*/
|
|
2063
|
-
sendRequest(request:
|
|
2345
|
+
sendRequest(request: WebResourceLike): Promise<CompatResponse>;
|
|
2064
2346
|
}
|
|
2065
2347
|
/**
|
|
2066
|
-
* StorageBrowserPolicyFactory is a factory class helping generating
|
|
2348
|
+
* StorageBrowserPolicyFactory is a factory class helping generating StorageBrowserPolicy objects.
|
|
2067
2349
|
*/
|
|
2068
2350
|
export declare class StorageBrowserPolicyFactory implements RequestPolicyFactory {
|
|
2069
2351
|
/**
|
|
@@ -2072,7 +2354,7 @@ export declare class StorageBrowserPolicyFactory implements RequestPolicyFactory
|
|
|
2072
2354
|
* @param nextPolicy -
|
|
2073
2355
|
* @param options -
|
|
2074
2356
|
*/
|
|
2075
|
-
create(nextPolicy: RequestPolicy, options:
|
|
2357
|
+
create(nextPolicy: RequestPolicy, options: RequestPolicyOptionsLike): StorageBrowserPolicy;
|
|
2076
2358
|
}
|
|
2077
2359
|
/**
|
|
2078
2360
|
* A StorageClient represents a based client class for {@link QueueServiceClient}, {@link QueueClient} and etc.
|
|
@@ -2089,7 +2371,7 @@ declare abstract class StorageClient {
|
|
|
2089
2371
|
* StorageClientContext is a reference to protocol layer operations entry, which is
|
|
2090
2372
|
* generated by AutoRest generator.
|
|
2091
2373
|
*/
|
|
2092
|
-
protected readonly storageClientContext:
|
|
2374
|
+
protected readonly storageClientContext: StorageClient_2;
|
|
2093
2375
|
/**
|
|
2094
2376
|
* Creates an instance of StorageClient.
|
|
2095
2377
|
* @param url -
|
|
@@ -2097,40 +2379,40 @@ declare abstract class StorageClient {
|
|
|
2097
2379
|
*/
|
|
2098
2380
|
protected constructor(url: string, pipeline: Pipeline);
|
|
2099
2381
|
}
|
|
2100
|
-
declare class
|
|
2382
|
+
declare class StorageClient_2 extends coreHttpCompat.ExtendedServiceClient {
|
|
2101
2383
|
url: string;
|
|
2102
2384
|
version: string;
|
|
2103
2385
|
/**
|
|
2104
|
-
* Initializes a new instance of the
|
|
2386
|
+
* Initializes a new instance of the StorageClient class.
|
|
2105
2387
|
* @param url The URL of the service account, queue or message that is the target of the desired
|
|
2106
2388
|
* operation.
|
|
2107
2389
|
* @param options The parameter options
|
|
2108
2390
|
*/
|
|
2109
2391
|
constructor(url: string, options?: StorageClientOptionalParams);
|
|
2392
|
+
service: Service;
|
|
2393
|
+
queue: Queue;
|
|
2394
|
+
messages: Messages;
|
|
2395
|
+
messageId: MessageId;
|
|
2110
2396
|
}
|
|
2111
2397
|
/** Optional parameters. */
|
|
2112
|
-
declare interface StorageClientOptionalParams extends
|
|
2398
|
+
declare interface StorageClientOptionalParams extends coreHttpCompat.ExtendedServiceClientOptions {
|
|
2113
2399
|
/** Specifies the version of the operation to use for this request. */
|
|
2114
2400
|
version?: string;
|
|
2115
2401
|
/** Overrides client endpoint. */
|
|
2116
2402
|
endpoint?: string;
|
|
2117
2403
|
}
|
|
2118
2404
|
/**
|
|
2119
|
-
*
|
|
2120
|
-
*/
|
|
2121
|
-
export declare const StorageOAuthScopes: string | string[];
|
|
2122
|
-
/**
|
|
2123
|
-
* Option interface for newPipeline() method.
|
|
2405
|
+
* Options interface for the {@link newPipeline} function.
|
|
2124
2406
|
*/
|
|
2125
2407
|
export declare interface StoragePipelineOptions {
|
|
2126
2408
|
/**
|
|
2127
2409
|
* Options to configure a proxy for outgoing requests.
|
|
2128
2410
|
*/
|
|
2129
|
-
proxyOptions?:
|
|
2411
|
+
proxyOptions?: ProxySettings;
|
|
2130
2412
|
/**
|
|
2131
2413
|
* Options for adding user agent details to outgoing requests.
|
|
2132
2414
|
*/
|
|
2133
|
-
userAgentOptions?:
|
|
2415
|
+
userAgentOptions?: UserAgentPolicyOptions;
|
|
2134
2416
|
/**
|
|
2135
2417
|
* Configures the built-in retry policy behavior.
|
|
2136
2418
|
*/
|
|
@@ -2142,10 +2424,14 @@ export declare interface StoragePipelineOptions {
|
|
|
2142
2424
|
/**
|
|
2143
2425
|
* Configures the HTTP client to send requests and receive responses.
|
|
2144
2426
|
*/
|
|
2145
|
-
httpClient?:
|
|
2427
|
+
httpClient?: RequestPolicy;
|
|
2428
|
+
/**
|
|
2429
|
+
* The audience used to retrieve an AAD token.
|
|
2430
|
+
*/
|
|
2431
|
+
audience?: string | string[];
|
|
2146
2432
|
}
|
|
2147
2433
|
/**
|
|
2148
|
-
* Storage
|
|
2434
|
+
* Storage Blob retry options interface.
|
|
2149
2435
|
*/
|
|
2150
2436
|
export declare interface StorageRetryOptions {
|
|
2151
2437
|
/**
|
|
@@ -2160,9 +2446,10 @@ export declare interface StorageRetryOptions {
|
|
|
2160
2446
|
readonly maxTries?: number;
|
|
2161
2447
|
/**
|
|
2162
2448
|
* Optional. Indicates the maximum time in ms allowed for any single try of an HTTP request.
|
|
2163
|
-
* A value of zero or undefined means
|
|
2449
|
+
* A value of zero or undefined means no default timeout on SDK client, Azure
|
|
2450
|
+
* Storage server's default timeout policy will be used.
|
|
2164
2451
|
*
|
|
2165
|
-
* @see https://docs.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-
|
|
2452
|
+
* @see https://docs.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-blob-service-operations
|
|
2166
2453
|
*/
|
|
2167
2454
|
readonly tryTimeoutInMs?: number;
|
|
2168
2455
|
/**
|
|
@@ -2201,25 +2488,24 @@ export declare class StorageRetryPolicy extends BaseRequestPolicy {
|
|
|
2201
2488
|
* @param options -
|
|
2202
2489
|
* @param retryOptions -
|
|
2203
2490
|
*/
|
|
2204
|
-
constructor(nextPolicy: RequestPolicy, options:
|
|
2491
|
+
constructor(nextPolicy: RequestPolicy, options: RequestPolicyOptionsLike, retryOptions?: StorageRetryOptions);
|
|
2205
2492
|
/**
|
|
2206
2493
|
* Sends request.
|
|
2207
2494
|
*
|
|
2208
2495
|
* @param request -
|
|
2209
2496
|
*/
|
|
2210
|
-
sendRequest(request:
|
|
2497
|
+
sendRequest(request: WebResourceLike): Promise<CompatResponse>;
|
|
2211
2498
|
/**
|
|
2212
2499
|
* Decide and perform next retry. Won't mutate request parameter.
|
|
2213
2500
|
*
|
|
2214
2501
|
* @param request -
|
|
2215
|
-
* @param response -
|
|
2216
2502
|
* @param secondaryHas404 - If attempt was against the secondary & it returned a StatusNotFound (404), then
|
|
2217
2503
|
* the resource was not found. This may be due to replication delay. So, in this
|
|
2218
2504
|
* case, we'll never try the secondary again for this operation.
|
|
2219
2505
|
* @param attempt - How many retries has been attempted to performed, starting from 1, which includes
|
|
2220
2506
|
* the attempt will be performed by this method call.
|
|
2221
2507
|
*/
|
|
2222
|
-
protected attemptSendRequest(request:
|
|
2508
|
+
protected attemptSendRequest(request: WebResourceLike, secondaryHas404: boolean, attempt: number): Promise<CompatResponse>;
|
|
2223
2509
|
/**
|
|
2224
2510
|
* Decide whether to retry according to last HTTP response and retry counters.
|
|
2225
2511
|
*
|
|
@@ -2228,7 +2514,7 @@ export declare class StorageRetryPolicy extends BaseRequestPolicy {
|
|
|
2228
2514
|
* @param response -
|
|
2229
2515
|
* @param err -
|
|
2230
2516
|
*/
|
|
2231
|
-
protected shouldRetry(isPrimaryRetry: boolean, attempt: number, response?:
|
|
2517
|
+
protected shouldRetry(isPrimaryRetry: boolean, attempt: number, response?: CompatResponse, err?: RestError): boolean;
|
|
2232
2518
|
/**
|
|
2233
2519
|
* Delay a calculated time between retries.
|
|
2234
2520
|
*
|
|
@@ -2249,12 +2535,12 @@ export declare class StorageRetryPolicyFactory implements RequestPolicyFactory {
|
|
|
2249
2535
|
*/
|
|
2250
2536
|
constructor(retryOptions?: StorageRetryOptions);
|
|
2251
2537
|
/**
|
|
2252
|
-
* Creates a
|
|
2538
|
+
* Creates a StorageRetryPolicy object.
|
|
2253
2539
|
*
|
|
2254
2540
|
* @param nextPolicy -
|
|
2255
2541
|
* @param options -
|
|
2256
2542
|
*/
|
|
2257
|
-
create(nextPolicy: RequestPolicy, options:
|
|
2543
|
+
create(nextPolicy: RequestPolicy, options: RequestPolicyOptionsLike): StorageRetryPolicy;
|
|
2258
2544
|
}
|
|
2259
2545
|
/**
|
|
2260
2546
|
* RetryPolicy types.
|
|
@@ -2290,12 +2576,12 @@ export declare class StorageSharedKeyCredential extends Credential_2 {
|
|
|
2290
2576
|
*/
|
|
2291
2577
|
constructor(accountName: string, accountKey: string);
|
|
2292
2578
|
/**
|
|
2293
|
-
* Creates a
|
|
2579
|
+
* Creates a StorageSharedKeyCredentialPolicy object.
|
|
2294
2580
|
*
|
|
2295
2581
|
* @param nextPolicy -
|
|
2296
2582
|
* @param options -
|
|
2297
2583
|
*/
|
|
2298
|
-
create(nextPolicy: RequestPolicy, options:
|
|
2584
|
+
create(nextPolicy: RequestPolicy, options: RequestPolicyOptionsLike): StorageSharedKeyCredentialPolicy;
|
|
2299
2585
|
/**
|
|
2300
2586
|
* Generates a hash signature for an HTTP request or for a SAS.
|
|
2301
2587
|
*
|
|
@@ -2308,7 +2594,7 @@ export declare class StorageSharedKeyCredential extends Credential_2 {
|
|
|
2308
2594
|
*/
|
|
2309
2595
|
export declare class StorageSharedKeyCredentialPolicy extends CredentialPolicy {
|
|
2310
2596
|
/**
|
|
2311
|
-
* Reference to
|
|
2597
|
+
* Reference to StorageSharedKeyCredential which generates StorageSharedKeyCredentialPolicy
|
|
2312
2598
|
*/
|
|
2313
2599
|
private readonly factory;
|
|
2314
2600
|
/**
|
|
@@ -2317,13 +2603,13 @@ export declare class StorageSharedKeyCredentialPolicy extends CredentialPolicy {
|
|
|
2317
2603
|
* @param options -
|
|
2318
2604
|
* @param factory -
|
|
2319
2605
|
*/
|
|
2320
|
-
constructor(nextPolicy: RequestPolicy, options:
|
|
2606
|
+
constructor(nextPolicy: RequestPolicy, options: RequestPolicyOptionsLike, factory: StorageSharedKeyCredential);
|
|
2321
2607
|
/**
|
|
2322
2608
|
* Signs request.
|
|
2323
2609
|
*
|
|
2324
2610
|
* @param request -
|
|
2325
2611
|
*/
|
|
2326
|
-
protected signRequest(request:
|
|
2612
|
+
protected signRequest(request: WebResourceLike): WebResourceLike;
|
|
2327
2613
|
/**
|
|
2328
2614
|
* Retrieve header value according to shared key sign rules.
|
|
2329
2615
|
* @see https://docs.microsoft.com/en-us/rest/api/storageservices/authenticate-with-shared-key
|
|
@@ -2353,5 +2639,8 @@ export declare class StorageSharedKeyCredentialPolicy extends CredentialPolicy {
|
|
|
2353
2639
|
*/
|
|
2354
2640
|
private getCanonicalizedResourceString;
|
|
2355
2641
|
}
|
|
2356
|
-
|
|
2642
|
+
/**
|
|
2643
|
+
* A type that represents an operation result with a known _response property.
|
|
2644
|
+
*/
|
|
2645
|
+
export declare type WithResponse<T, Headers = undefined, Body = undefined> = T & (Body extends object ? ResponseWithBody<Headers, Body> : Headers extends object ? ResponseWithHeaders<Headers> : ResponseLike);
|
|
2357
2646
|
export {};
|