@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
|
|
|
25
20
|
/** An Access policy */
|
|
26
21
|
export declare interface AccessPolicy {
|
|
@@ -225,8 +220,8 @@ export declare interface AccountSASSignatureValues {
|
|
|
225
220
|
}
|
|
226
221
|
|
|
227
222
|
/**
|
|
228
|
-
* AnonymousCredential provides a
|
|
229
|
-
*
|
|
223
|
+
* AnonymousCredential provides a credentialPolicyCreator member used to create
|
|
224
|
+
* AnonymousCredentialPolicy objects. AnonymousCredentialPolicy is used with
|
|
230
225
|
* HTTP(S) requests that read public resources or for use with Shared Access
|
|
231
226
|
* Signatures (SAS).
|
|
232
227
|
*/
|
|
@@ -237,7 +232,7 @@ export declare class AnonymousCredential extends Credential_2 {
|
|
|
237
232
|
* @param nextPolicy -
|
|
238
233
|
* @param options -
|
|
239
234
|
*/
|
|
240
|
-
create(nextPolicy: RequestPolicy, options:
|
|
235
|
+
create(nextPolicy: RequestPolicy, options: RequestPolicyOptionsLike): AnonymousCredentialPolicy;
|
|
241
236
|
}
|
|
242
237
|
|
|
243
238
|
/**
|
|
@@ -250,10 +245,52 @@ export declare class AnonymousCredentialPolicy extends CredentialPolicy {
|
|
|
250
245
|
* @param nextPolicy -
|
|
251
246
|
* @param options -
|
|
252
247
|
*/
|
|
253
|
-
constructor(nextPolicy: RequestPolicy, options:
|
|
248
|
+
constructor(nextPolicy: RequestPolicy, options: RequestPolicyOptionsLike);
|
|
254
249
|
}
|
|
255
250
|
|
|
256
|
-
|
|
251
|
+
/**
|
|
252
|
+
* The base class from which all request policies derive.
|
|
253
|
+
*/
|
|
254
|
+
export declare abstract class BaseRequestPolicy implements RequestPolicy {
|
|
255
|
+
/**
|
|
256
|
+
* The next policy in the pipeline. Each policy is responsible for executing the next one if the request is to continue through the pipeline.
|
|
257
|
+
*/
|
|
258
|
+
readonly _nextPolicy: RequestPolicy;
|
|
259
|
+
/**
|
|
260
|
+
* The options that can be passed to a given request policy.
|
|
261
|
+
*/
|
|
262
|
+
readonly _options: RequestPolicyOptionsLike;
|
|
263
|
+
/**
|
|
264
|
+
* The main method to implement that manipulates a request/response.
|
|
265
|
+
*/
|
|
266
|
+
protected constructor(
|
|
267
|
+
/**
|
|
268
|
+
* The next policy in the pipeline. Each policy is responsible for executing the next one if the request is to continue through the pipeline.
|
|
269
|
+
*/
|
|
270
|
+
_nextPolicy: RequestPolicy,
|
|
271
|
+
/**
|
|
272
|
+
* The options that can be passed to a given request policy.
|
|
273
|
+
*/
|
|
274
|
+
_options: RequestPolicyOptionsLike);
|
|
275
|
+
/**
|
|
276
|
+
* Sends a network request based on the given web resource.
|
|
277
|
+
* @param webResource - A {@link WebResourceLike} that describes a HTTP request to be made.
|
|
278
|
+
*/
|
|
279
|
+
abstract sendRequest(webResource: WebResourceLike): Promise<CompatResponse>;
|
|
280
|
+
/**
|
|
281
|
+
* Get whether or not a log with the provided log level should be logged.
|
|
282
|
+
* @param logLevel - The log level of the log that will be logged.
|
|
283
|
+
* @returns Whether or not a log with the provided log level should be logged.
|
|
284
|
+
*/
|
|
285
|
+
shouldLog(logLevel: HttpPipelineLogLevel): boolean;
|
|
286
|
+
/**
|
|
287
|
+
* Attempt to log the provided message to the provided logger. If no logger was provided or if
|
|
288
|
+
* the log level does not meat the logger's threshold, then nothing will be logged.
|
|
289
|
+
* @param logLevel - The log level of this log.
|
|
290
|
+
* @param message - The message of this log.
|
|
291
|
+
*/
|
|
292
|
+
log(logLevel: HttpPipelineLogLevel, message: string): void;
|
|
293
|
+
}
|
|
257
294
|
|
|
258
295
|
/**
|
|
259
296
|
* An interface for options common to every remote operation.
|
|
@@ -290,7 +327,7 @@ declare abstract class Credential_2 implements RequestPolicyFactory {
|
|
|
290
327
|
* @param _nextPolicy -
|
|
291
328
|
* @param _options -
|
|
292
329
|
*/
|
|
293
|
-
create(_nextPolicy: RequestPolicy, _options:
|
|
330
|
+
create(_nextPolicy: RequestPolicy, _options: RequestPolicyOptionsLike): RequestPolicy;
|
|
294
331
|
}
|
|
295
332
|
export { Credential_2 as Credential }
|
|
296
333
|
|
|
@@ -304,20 +341,20 @@ export declare abstract class CredentialPolicy extends BaseRequestPolicy {
|
|
|
304
341
|
*
|
|
305
342
|
* @param request -
|
|
306
343
|
*/
|
|
307
|
-
sendRequest(request:
|
|
344
|
+
sendRequest(request: WebResourceLike): Promise<CompatResponse>;
|
|
308
345
|
/**
|
|
309
346
|
* Child classes must implement this method with request signing. This method
|
|
310
347
|
* will be executed in {@link sendRequest}.
|
|
311
348
|
*
|
|
312
349
|
* @param request -
|
|
313
350
|
*/
|
|
314
|
-
protected signRequest(request:
|
|
351
|
+
protected signRequest(request: WebResourceLike): WebResourceLike;
|
|
315
352
|
}
|
|
316
353
|
|
|
317
354
|
/**
|
|
318
355
|
* A factory function that creates a new CredentialPolicy that uses the provided nextPolicy.
|
|
319
356
|
*/
|
|
320
|
-
export declare type CredentialPolicyCreator = (nextPolicy: RequestPolicy, options:
|
|
357
|
+
export declare type CredentialPolicyCreator = (nextPolicy: RequestPolicy, options: RequestPolicyOptionsLike) => CredentialPolicy;
|
|
321
358
|
|
|
322
359
|
/** The object returned in the QueueMessageList array when calling Get Messages on a Queue. */
|
|
323
360
|
export declare interface DequeuedMessageItem {
|
|
@@ -337,8 +374,6 @@ export declare interface DequeuedMessageItem {
|
|
|
337
374
|
messageText: string;
|
|
338
375
|
}
|
|
339
376
|
|
|
340
|
-
export { deserializationPolicy }
|
|
341
|
-
|
|
342
377
|
/** The object returned in the QueueMessageList array when calling Put Message on a Queue */
|
|
343
378
|
export declare interface EnqueuedMessage {
|
|
344
379
|
/** The Id of the Message. */
|
|
@@ -394,13 +429,32 @@ export declare interface GeoReplication {
|
|
|
394
429
|
/** Defines values for GeoReplicationStatusType. */
|
|
395
430
|
export declare type GeoReplicationStatusType = "live" | "bootstrap" | "unavailable";
|
|
396
431
|
|
|
397
|
-
|
|
398
|
-
|
|
399
|
-
|
|
400
|
-
|
|
401
|
-
|
|
432
|
+
/**
|
|
433
|
+
* A representation of an HTTP response that
|
|
434
|
+
* includes a reference to the request that
|
|
435
|
+
* originated it.
|
|
436
|
+
*/
|
|
437
|
+
export declare interface HttpResponse {
|
|
438
|
+
/**
|
|
439
|
+
* The headers from the response.
|
|
440
|
+
*/
|
|
441
|
+
headers: HttpHeadersLike;
|
|
442
|
+
/**
|
|
443
|
+
* The original request that resulted in this response.
|
|
444
|
+
*/
|
|
445
|
+
request: WebResourceLike;
|
|
446
|
+
/**
|
|
447
|
+
* The HTTP status code returned from the service.
|
|
448
|
+
*/
|
|
449
|
+
status: number;
|
|
450
|
+
}
|
|
402
451
|
|
|
403
|
-
|
|
452
|
+
/**
|
|
453
|
+
* A helper to decide if a given argument satisfies the Pipeline contract
|
|
454
|
+
* @param pipeline - An argument that may be a Pipeline
|
|
455
|
+
* @returns true when the argument satisfies the Pipeline contract
|
|
456
|
+
*/
|
|
457
|
+
export declare function isPipelineLike(pipeline: unknown): pipeline is PipelineLike;
|
|
404
458
|
|
|
405
459
|
/**
|
|
406
460
|
* Defines values for ListQueuesIncludeType.
|
|
@@ -438,6 +492,32 @@ export declare interface Logging {
|
|
|
438
492
|
retentionPolicy: RetentionPolicy;
|
|
439
493
|
}
|
|
440
494
|
|
|
495
|
+
/** Interface representing a MessageId. */
|
|
496
|
+
declare interface MessageId {
|
|
497
|
+
/**
|
|
498
|
+
* The Update operation was introduced with version 2011-08-18 of the Queue service API. The Update
|
|
499
|
+
* Message operation updates the visibility timeout of a message. You can also use this operation to
|
|
500
|
+
* update the contents of a message. A message must be in a format that can be included in an XML
|
|
501
|
+
* request with UTF-8 encoding, and the encoded message can be up to 64KB in size.
|
|
502
|
+
* @param popReceipt Required. Specifies the valid pop receipt value returned from an earlier call to
|
|
503
|
+
* the Get Messages or Update Message operation.
|
|
504
|
+
* @param visibilityTimeout Optional. Specifies the new visibility timeout value, in seconds, relative
|
|
505
|
+
* to server time. The default value is 30 seconds. A specified value must be larger than or equal to 1
|
|
506
|
+
* second, and cannot be larger than 7 days, or larger than 2 hours on REST protocol versions prior to
|
|
507
|
+
* version 2011-08-18. The visibility timeout of a message can be set to a value later than the expiry
|
|
508
|
+
* time.
|
|
509
|
+
* @param options The options parameters.
|
|
510
|
+
*/
|
|
511
|
+
update(popReceipt: string, visibilityTimeout: number, options?: MessageIdUpdateOptionalParams): Promise<MessageIdUpdateResponse_2>;
|
|
512
|
+
/**
|
|
513
|
+
* The Delete operation deletes the specified message.
|
|
514
|
+
* @param popReceipt Required. Specifies the valid pop receipt value returned from an earlier call to
|
|
515
|
+
* the Get Messages or Update Message operation.
|
|
516
|
+
* @param options The options parameters.
|
|
517
|
+
*/
|
|
518
|
+
delete(popReceipt: string, options?: MessageIdDeleteOptionalParams): Promise<MessageIdDeleteResponse_2>;
|
|
519
|
+
}
|
|
520
|
+
|
|
441
521
|
/** Defines headers for MessageId_delete operation. */
|
|
442
522
|
export declare interface MessageIdDeleteHeaders {
|
|
443
523
|
/** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
|
|
@@ -452,14 +532,19 @@ export declare interface MessageIdDeleteHeaders {
|
|
|
452
532
|
errorCode?: string;
|
|
453
533
|
}
|
|
454
534
|
|
|
535
|
+
/** Optional parameters. */
|
|
536
|
+
declare interface MessageIdDeleteOptionalParams 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
|
+
}
|
|
542
|
+
|
|
455
543
|
/** Contains response data for the delete operation. */
|
|
456
|
-
export declare type MessageIdDeleteResponse = MessageIdDeleteHeaders
|
|
457
|
-
|
|
458
|
-
|
|
459
|
-
|
|
460
|
-
parsedHeaders: MessageIdDeleteHeaders;
|
|
461
|
-
};
|
|
462
|
-
};
|
|
544
|
+
export declare type MessageIdDeleteResponse = WithResponse<MessageIdDeleteHeaders, MessageIdDeleteHeaders>;
|
|
545
|
+
|
|
546
|
+
/** Contains response data for the delete operation. */
|
|
547
|
+
declare type MessageIdDeleteResponse_2 = MessageIdDeleteHeaders;
|
|
463
548
|
|
|
464
549
|
/** Defines headers for MessageId_update operation. */
|
|
465
550
|
export declare interface MessageIdUpdateHeaders {
|
|
@@ -479,14 +564,50 @@ export declare interface MessageIdUpdateHeaders {
|
|
|
479
564
|
errorCode?: string;
|
|
480
565
|
}
|
|
481
566
|
|
|
567
|
+
/** Optional parameters. */
|
|
568
|
+
declare interface MessageIdUpdateOptionalParams extends coreClient.OperationOptions {
|
|
569
|
+
/** 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> */
|
|
570
|
+
timeoutInSeconds?: number;
|
|
571
|
+
/** 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. */
|
|
572
|
+
requestId?: string;
|
|
573
|
+
/** A Message object which can be stored in a Queue */
|
|
574
|
+
queueMessage?: QueueMessage;
|
|
575
|
+
}
|
|
576
|
+
|
|
482
577
|
/** Contains response data for the update operation. */
|
|
483
|
-
export declare type MessageIdUpdateResponse = MessageIdUpdateHeaders
|
|
484
|
-
|
|
485
|
-
|
|
486
|
-
|
|
487
|
-
|
|
488
|
-
|
|
489
|
-
|
|
578
|
+
export declare type MessageIdUpdateResponse = WithResponse<MessageIdUpdateHeaders, MessageIdUpdateHeaders>;
|
|
579
|
+
|
|
580
|
+
/** Contains response data for the update operation. */
|
|
581
|
+
declare type MessageIdUpdateResponse_2 = MessageIdUpdateHeaders;
|
|
582
|
+
|
|
583
|
+
/** Interface representing a Messages. */
|
|
584
|
+
declare interface Messages {
|
|
585
|
+
/**
|
|
586
|
+
* The Dequeue operation retrieves one or more messages from the front of the queue.
|
|
587
|
+
* @param options The options parameters.
|
|
588
|
+
*/
|
|
589
|
+
dequeue(options?: MessagesDequeueOptionalParams_2): Promise<MessagesDequeueResponse>;
|
|
590
|
+
/**
|
|
591
|
+
* The Clear operation deletes all messages from the specified queue.
|
|
592
|
+
* @param options The options parameters.
|
|
593
|
+
*/
|
|
594
|
+
clear(options?: MessagesClearOptionalParams): Promise<MessagesClearResponse_2>;
|
|
595
|
+
/**
|
|
596
|
+
* The Enqueue operation adds a new message to the back of the message queue. A visibility timeout can
|
|
597
|
+
* also be specified to make the message invisible until the visibility timeout expires. A message must
|
|
598
|
+
* be in a format that can be included in an XML request with UTF-8 encoding. The encoded message can
|
|
599
|
+
* be up to 64 KB in size for versions 2011-08-18 and newer, or 8 KB in size for previous versions.
|
|
600
|
+
* @param queueMessage A Message object which can be stored in a Queue
|
|
601
|
+
* @param options The options parameters.
|
|
602
|
+
*/
|
|
603
|
+
enqueue(queueMessage: QueueMessage, options?: MessagesEnqueueOptionalParams_2): Promise<MessagesEnqueueResponse>;
|
|
604
|
+
/**
|
|
605
|
+
* The Peek operation retrieves one or more messages from the front of the queue, but does not alter
|
|
606
|
+
* the visibility of the message.
|
|
607
|
+
* @param options The options parameters.
|
|
608
|
+
*/
|
|
609
|
+
peek(options?: MessagesPeekOptionalParams_2): Promise<MessagesPeekResponse>;
|
|
610
|
+
}
|
|
490
611
|
|
|
491
612
|
/** Defines headers for Messages_clear operation. */
|
|
492
613
|
export declare interface MessagesClearHeaders {
|
|
@@ -502,14 +623,19 @@ export declare interface MessagesClearHeaders {
|
|
|
502
623
|
errorCode?: string;
|
|
503
624
|
}
|
|
504
625
|
|
|
626
|
+
/** Optional parameters. */
|
|
627
|
+
declare interface MessagesClearOptionalParams extends coreClient.OperationOptions {
|
|
628
|
+
/** 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> */
|
|
629
|
+
timeoutInSeconds?: number;
|
|
630
|
+
/** 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. */
|
|
631
|
+
requestId?: string;
|
|
632
|
+
}
|
|
633
|
+
|
|
505
634
|
/** Contains response data for the clear operation. */
|
|
506
|
-
export declare type MessagesClearResponse = MessagesClearHeaders
|
|
507
|
-
|
|
508
|
-
|
|
509
|
-
|
|
510
|
-
parsedHeaders: MessagesClearHeaders;
|
|
511
|
-
};
|
|
512
|
-
};
|
|
635
|
+
export declare type MessagesClearResponse = WithResponse<MessagesClearHeaders, MessagesClearHeaders>;
|
|
636
|
+
|
|
637
|
+
/** Contains response data for the clear operation. */
|
|
638
|
+
declare type MessagesClearResponse_2 = MessagesClearHeaders;
|
|
513
639
|
|
|
514
640
|
/** Defines headers for Messages_dequeue operation. */
|
|
515
641
|
export declare interface MessagesDequeueHeaders {
|
|
@@ -526,7 +652,7 @@ export declare interface MessagesDequeueHeaders {
|
|
|
526
652
|
}
|
|
527
653
|
|
|
528
654
|
/** Optional parameters. */
|
|
529
|
-
export declare interface MessagesDequeueOptionalParams extends
|
|
655
|
+
export declare interface MessagesDequeueOptionalParams extends CommonOptions {
|
|
530
656
|
/** 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> */
|
|
531
657
|
timeoutInSeconds?: number;
|
|
532
658
|
/** 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. */
|
|
@@ -537,6 +663,21 @@ export declare interface MessagesDequeueOptionalParams extends RequestOptionsBas
|
|
|
537
663
|
visibilityTimeout?: number;
|
|
538
664
|
}
|
|
539
665
|
|
|
666
|
+
/** Optional parameters. */
|
|
667
|
+
declare interface MessagesDequeueOptionalParams_2 extends coreClient.OperationOptions {
|
|
668
|
+
/** 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> */
|
|
669
|
+
timeoutInSeconds?: number;
|
|
670
|
+
/** 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. */
|
|
671
|
+
requestId?: string;
|
|
672
|
+
/** 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. */
|
|
673
|
+
numberOfMessages?: number;
|
|
674
|
+
/** 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. */
|
|
675
|
+
visibilityTimeout?: number;
|
|
676
|
+
}
|
|
677
|
+
|
|
678
|
+
/** Contains response data for the dequeue operation. */
|
|
679
|
+
declare type MessagesDequeueResponse = MessagesDequeueHeaders & DequeuedMessageItem[];
|
|
680
|
+
|
|
540
681
|
/** Defines headers for Messages_enqueue operation. */
|
|
541
682
|
export declare interface MessagesEnqueueHeaders {
|
|
542
683
|
/** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
|
|
@@ -552,7 +693,7 @@ export declare interface MessagesEnqueueHeaders {
|
|
|
552
693
|
}
|
|
553
694
|
|
|
554
695
|
/** Optional parameters. */
|
|
555
|
-
export declare interface MessagesEnqueueOptionalParams extends
|
|
696
|
+
export declare interface MessagesEnqueueOptionalParams extends CommonOptions {
|
|
556
697
|
/** 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> */
|
|
557
698
|
timeoutInSeconds?: number;
|
|
558
699
|
/** 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. */
|
|
@@ -563,6 +704,21 @@ export declare interface MessagesEnqueueOptionalParams extends RequestOptionsBas
|
|
|
563
704
|
messageTimeToLive?: number;
|
|
564
705
|
}
|
|
565
706
|
|
|
707
|
+
/** Optional parameters. */
|
|
708
|
+
declare interface MessagesEnqueueOptionalParams_2 extends coreClient.OperationOptions {
|
|
709
|
+
/** 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> */
|
|
710
|
+
timeoutInSeconds?: number;
|
|
711
|
+
/** 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. */
|
|
712
|
+
requestId?: string;
|
|
713
|
+
/** 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. */
|
|
714
|
+
visibilityTimeout?: number;
|
|
715
|
+
/** 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. */
|
|
716
|
+
messageTimeToLive?: number;
|
|
717
|
+
}
|
|
718
|
+
|
|
719
|
+
/** Contains response data for the enqueue operation. */
|
|
720
|
+
declare type MessagesEnqueueResponse = MessagesEnqueueHeaders & EnqueuedMessage[];
|
|
721
|
+
|
|
566
722
|
/** Defines headers for Messages_peek operation. */
|
|
567
723
|
export declare interface MessagesPeekHeaders {
|
|
568
724
|
/** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
|
|
@@ -578,7 +734,7 @@ export declare interface MessagesPeekHeaders {
|
|
|
578
734
|
}
|
|
579
735
|
|
|
580
736
|
/** Optional parameters. */
|
|
581
|
-
export declare interface MessagesPeekOptionalParams extends
|
|
737
|
+
export declare interface MessagesPeekOptionalParams extends CommonOptions {
|
|
582
738
|
/** 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> */
|
|
583
739
|
timeoutInSeconds?: number;
|
|
584
740
|
/** 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. */
|
|
@@ -587,6 +743,19 @@ export declare interface MessagesPeekOptionalParams extends RequestOptionsBase {
|
|
|
587
743
|
numberOfMessages?: number;
|
|
588
744
|
}
|
|
589
745
|
|
|
746
|
+
/** Optional parameters. */
|
|
747
|
+
declare interface MessagesPeekOptionalParams_2 extends coreClient.OperationOptions {
|
|
748
|
+
/** 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> */
|
|
749
|
+
timeoutInSeconds?: number;
|
|
750
|
+
/** 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. */
|
|
751
|
+
requestId?: string;
|
|
752
|
+
/** 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. */
|
|
753
|
+
numberOfMessages?: number;
|
|
754
|
+
}
|
|
755
|
+
|
|
756
|
+
/** Contains response data for the peek operation. */
|
|
757
|
+
declare type MessagesPeekResponse = MessagesPeekHeaders & PeekedMessageItem[];
|
|
758
|
+
|
|
590
759
|
/**
|
|
591
760
|
* A collection of key-value string pairs.
|
|
592
761
|
*/
|
|
@@ -613,7 +782,7 @@ export declare interface Metrics {
|
|
|
613
782
|
* Creates a new Pipeline object with Credential provided.
|
|
614
783
|
*
|
|
615
784
|
* @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.
|
|
616
|
-
* @param pipelineOptions - Options.
|
|
785
|
+
* @param pipelineOptions - Optional. Options.
|
|
617
786
|
* @returns A new Pipeline object.
|
|
618
787
|
*/
|
|
619
788
|
export declare function newPipeline(credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, pipelineOptions?: StoragePipelineOptions): Pipeline;
|
|
@@ -634,12 +803,13 @@ export declare interface PeekedMessageItem {
|
|
|
634
803
|
|
|
635
804
|
/**
|
|
636
805
|
* A Pipeline class containing HTTP request policies.
|
|
637
|
-
* You can create a default Pipeline by calling newPipeline
|
|
806
|
+
* You can create a default Pipeline by calling {@link newPipeline}.
|
|
638
807
|
* Or you can create a Pipeline with your own policies by the constructor of Pipeline.
|
|
639
|
-
*
|
|
640
|
-
* implementing your
|
|
808
|
+
*
|
|
809
|
+
* Refer to {@link newPipeline} and provided policies before implementing your
|
|
810
|
+
* customized Pipeline.
|
|
641
811
|
*/
|
|
642
|
-
export declare class Pipeline {
|
|
812
|
+
export declare class Pipeline implements PipelineLike {
|
|
643
813
|
/**
|
|
644
814
|
* A list of chained request policy factories.
|
|
645
815
|
*/
|
|
@@ -656,7 +826,33 @@ export declare class Pipeline {
|
|
|
656
826
|
*/
|
|
657
827
|
constructor(factories: RequestPolicyFactory[], options?: PipelineOptions);
|
|
658
828
|
/**
|
|
659
|
-
*
|
|
829
|
+
* Transfer Pipeline object to ServiceClientOptions object which is required by
|
|
830
|
+
* ServiceClient constructor.
|
|
831
|
+
*
|
|
832
|
+
* @returns The ServiceClientOptions object from this Pipeline.
|
|
833
|
+
*/
|
|
834
|
+
toServiceClientOptions(): ServiceClientOptions;
|
|
835
|
+
}
|
|
836
|
+
|
|
837
|
+
/**
|
|
838
|
+
* An interface for the {@link Pipeline} class containing HTTP request policies.
|
|
839
|
+
* You can create a default Pipeline by calling {@link newPipeline}.
|
|
840
|
+
* Or you can create a Pipeline with your own policies by the constructor of Pipeline.
|
|
841
|
+
*
|
|
842
|
+
* Refer to {@link newPipeline} and provided policies before implementing your
|
|
843
|
+
* customized Pipeline.
|
|
844
|
+
*/
|
|
845
|
+
export declare interface PipelineLike {
|
|
846
|
+
/**
|
|
847
|
+
* A list of chained request policy factories.
|
|
848
|
+
*/
|
|
849
|
+
readonly factories: RequestPolicyFactory[];
|
|
850
|
+
/**
|
|
851
|
+
* Configures pipeline logger and HTTP client.
|
|
852
|
+
*/
|
|
853
|
+
readonly options: PipelineOptions;
|
|
854
|
+
/**
|
|
855
|
+
* Transfer Pipeline object to ServiceClientOptions object which is required by
|
|
660
856
|
* ServiceClient constructor.
|
|
661
857
|
*
|
|
662
858
|
* @returns The ServiceClientOptions object from this Pipeline.
|
|
@@ -671,7 +867,44 @@ export declare interface PipelineOptions {
|
|
|
671
867
|
/**
|
|
672
868
|
* Optional. Configures the HTTP client to send requests and receive responses.
|
|
673
869
|
*/
|
|
674
|
-
httpClient?:
|
|
870
|
+
httpClient?: RequestPolicy;
|
|
871
|
+
}
|
|
872
|
+
|
|
873
|
+
/** Interface representing a Queue. */
|
|
874
|
+
declare interface Queue {
|
|
875
|
+
/**
|
|
876
|
+
* creates a new queue under the given account.
|
|
877
|
+
* @param options The options parameters.
|
|
878
|
+
*/
|
|
879
|
+
create(options?: QueueCreateOptionalParams): Promise<QueueCreateResponse_2>;
|
|
880
|
+
/**
|
|
881
|
+
* operation permanently deletes the specified queue
|
|
882
|
+
* @param options The options parameters.
|
|
883
|
+
*/
|
|
884
|
+
delete(options?: QueueDeleteOptionalParams): Promise<QueueDeleteResponse_2>;
|
|
885
|
+
/**
|
|
886
|
+
* Retrieves user-defined metadata and queue properties on the specified queue. Metadata is associated
|
|
887
|
+
* with the queue as name-values pairs.
|
|
888
|
+
* @param options The options parameters.
|
|
889
|
+
*/
|
|
890
|
+
getProperties(options?: QueueGetPropertiesOptionalParams): Promise<QueueGetPropertiesResponse_2>;
|
|
891
|
+
/**
|
|
892
|
+
* sets user-defined metadata on the specified queue. Metadata is associated with the queue as
|
|
893
|
+
* name-value pairs.
|
|
894
|
+
* @param options The options parameters.
|
|
895
|
+
*/
|
|
896
|
+
setMetadata(options?: QueueSetMetadataOptionalParams): Promise<QueueSetMetadataResponse_2>;
|
|
897
|
+
/**
|
|
898
|
+
* returns details about any stored access policies specified on the queue that may be used with Shared
|
|
899
|
+
* Access Signatures.
|
|
900
|
+
* @param options The options parameters.
|
|
901
|
+
*/
|
|
902
|
+
getAccessPolicy(options?: QueueGetAccessPolicyOptionalParams): Promise<QueueGetAccessPolicyResponse_2>;
|
|
903
|
+
/**
|
|
904
|
+
* sets stored access policies for the queue that may be used with Shared Access Signatures
|
|
905
|
+
* @param options The options parameters.
|
|
906
|
+
*/
|
|
907
|
+
setAccessPolicy(options?: QueueSetAccessPolicyOptionalParams): Promise<QueueSetAccessPolicyResponse_2>;
|
|
675
908
|
}
|
|
676
909
|
|
|
677
910
|
/**
|
|
@@ -986,6 +1219,18 @@ export declare interface QueueCreateIfNotExistsResponse extends QueueCreateRespo
|
|
|
986
1219
|
succeeded: boolean;
|
|
987
1220
|
}
|
|
988
1221
|
|
|
1222
|
+
/** Optional parameters. */
|
|
1223
|
+
declare interface QueueCreateOptionalParams extends coreClient.OperationOptions {
|
|
1224
|
+
/** 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> */
|
|
1225
|
+
timeoutInSeconds?: number;
|
|
1226
|
+
/** 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. */
|
|
1227
|
+
requestId?: string;
|
|
1228
|
+
/** 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. */
|
|
1229
|
+
metadata?: {
|
|
1230
|
+
[propertyName: string]: string;
|
|
1231
|
+
};
|
|
1232
|
+
}
|
|
1233
|
+
|
|
989
1234
|
/**
|
|
990
1235
|
* Options to configure {@link QueueClient.create} operation
|
|
991
1236
|
*/
|
|
@@ -1002,14 +1247,13 @@ export declare interface QueueCreateOptions extends CommonOptions {
|
|
|
1002
1247
|
metadata?: Metadata;
|
|
1003
1248
|
}
|
|
1004
1249
|
|
|
1250
|
+
/**
|
|
1251
|
+
* Contains response data for the create operation.
|
|
1252
|
+
*/
|
|
1253
|
+
export declare type QueueCreateResponse = WithResponse<QueueCreateHeaders, QueueCreateHeaders>;
|
|
1254
|
+
|
|
1005
1255
|
/** Contains response data for the create operation. */
|
|
1006
|
-
|
|
1007
|
-
/** The underlying HTTP response. */
|
|
1008
|
-
_response: coreHttp.HttpResponse & {
|
|
1009
|
-
/** The parsed HTTP response headers. */
|
|
1010
|
-
parsedHeaders: QueueCreateHeaders;
|
|
1011
|
-
};
|
|
1012
|
-
};
|
|
1256
|
+
declare type QueueCreateResponse_2 = QueueCreateHeaders;
|
|
1013
1257
|
|
|
1014
1258
|
/** Defines headers for Queue_delete operation. */
|
|
1015
1259
|
export declare interface QueueDeleteHeaders {
|
|
@@ -1051,6 +1295,14 @@ export declare interface QueueDeleteMessageOptions extends CommonOptions {
|
|
|
1051
1295
|
*/
|
|
1052
1296
|
export declare type QueueDeleteMessageResponse = MessageIdDeleteResponse;
|
|
1053
1297
|
|
|
1298
|
+
/** Optional parameters. */
|
|
1299
|
+
declare interface QueueDeleteOptionalParams extends coreClient.OperationOptions {
|
|
1300
|
+
/** 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> */
|
|
1301
|
+
timeoutInSeconds?: number;
|
|
1302
|
+
/** 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. */
|
|
1303
|
+
requestId?: string;
|
|
1304
|
+
}
|
|
1305
|
+
|
|
1054
1306
|
/**
|
|
1055
1307
|
* Options to configure {@link QueueClient.delete} operation
|
|
1056
1308
|
*/
|
|
@@ -1063,13 +1315,10 @@ export declare interface QueueDeleteOptions extends CommonOptions {
|
|
|
1063
1315
|
}
|
|
1064
1316
|
|
|
1065
1317
|
/** Contains response data for the delete operation. */
|
|
1066
|
-
export declare type QueueDeleteResponse = QueueDeleteHeaders
|
|
1067
|
-
|
|
1068
|
-
|
|
1069
|
-
|
|
1070
|
-
parsedHeaders: QueueDeleteHeaders;
|
|
1071
|
-
};
|
|
1072
|
-
};
|
|
1318
|
+
export declare type QueueDeleteResponse = WithResponse<QueueDeleteHeaders, QueueDeleteHeaders>;
|
|
1319
|
+
|
|
1320
|
+
/** Contains response data for the delete operation. */
|
|
1321
|
+
declare type QueueDeleteResponse_2 = QueueDeleteHeaders;
|
|
1073
1322
|
|
|
1074
1323
|
/**
|
|
1075
1324
|
* Options to configure {@link QueueClient.exists} operation
|
|
@@ -1134,6 +1383,14 @@ export declare interface QueueGetAccessPolicyHeaders {
|
|
|
1134
1383
|
errorCode?: string;
|
|
1135
1384
|
}
|
|
1136
1385
|
|
|
1386
|
+
/** Optional parameters. */
|
|
1387
|
+
declare interface QueueGetAccessPolicyOptionalParams extends coreClient.OperationOptions {
|
|
1388
|
+
/** 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> */
|
|
1389
|
+
timeoutInSeconds?: number;
|
|
1390
|
+
/** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
|
|
1391
|
+
requestId?: string;
|
|
1392
|
+
}
|
|
1393
|
+
|
|
1137
1394
|
/**
|
|
1138
1395
|
* Options to configure {@link QueueClient.getAccessPolicy} operation
|
|
1139
1396
|
*/
|
|
@@ -1148,27 +1405,12 @@ export declare interface QueueGetAccessPolicyOptions extends CommonOptions {
|
|
|
1148
1405
|
/**
|
|
1149
1406
|
* Contains response data for the {@link QueueClient.getAccessPolicy} operation.
|
|
1150
1407
|
*/
|
|
1151
|
-
export declare type QueueGetAccessPolicyResponse = {
|
|
1408
|
+
export declare type QueueGetAccessPolicyResponse = WithResponse<{
|
|
1152
1409
|
signedIdentifiers: SignedIdentifier[];
|
|
1153
|
-
} & QueueGetAccessPolicyHeaders
|
|
1154
|
-
|
|
1155
|
-
|
|
1156
|
-
|
|
1157
|
-
_response: HttpResponse & {
|
|
1158
|
-
/**
|
|
1159
|
-
* The parsed HTTP response headers.
|
|
1160
|
-
*/
|
|
1161
|
-
parsedHeaders: QueueGetAccessPolicyHeaders;
|
|
1162
|
-
/**
|
|
1163
|
-
* The response body as text (string format)
|
|
1164
|
-
*/
|
|
1165
|
-
bodyAsText: string;
|
|
1166
|
-
/**
|
|
1167
|
-
* The response body as parsed JSON or XML
|
|
1168
|
-
*/
|
|
1169
|
-
parsedBody: SignedIdentifierModel[];
|
|
1170
|
-
};
|
|
1171
|
-
};
|
|
1410
|
+
} & QueueGetAccessPolicyHeaders, QueueGetAccessPolicyHeaders, SignedIdentifierModel[]>;
|
|
1411
|
+
|
|
1412
|
+
/** Contains response data for the getAccessPolicy operation. */
|
|
1413
|
+
declare type QueueGetAccessPolicyResponse_2 = QueueGetAccessPolicyHeaders & SignedIdentifierModel[];
|
|
1172
1414
|
|
|
1173
1415
|
/** Defines headers for Queue_getProperties operation. */
|
|
1174
1416
|
export declare interface QueueGetPropertiesHeaders {
|
|
@@ -1189,6 +1431,14 @@ export declare interface QueueGetPropertiesHeaders {
|
|
|
1189
1431
|
errorCode?: string;
|
|
1190
1432
|
}
|
|
1191
1433
|
|
|
1434
|
+
/** Optional parameters. */
|
|
1435
|
+
declare interface QueueGetPropertiesOptionalParams extends coreClient.OperationOptions {
|
|
1436
|
+
/** 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> */
|
|
1437
|
+
timeoutInSeconds?: number;
|
|
1438
|
+
/** 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. */
|
|
1439
|
+
requestId?: string;
|
|
1440
|
+
}
|
|
1441
|
+
|
|
1192
1442
|
/**
|
|
1193
1443
|
* Options to configure {@link QueueClient.getProperties} operation
|
|
1194
1444
|
*/
|
|
@@ -1201,13 +1451,10 @@ export declare interface QueueGetPropertiesOptions extends CommonOptions {
|
|
|
1201
1451
|
}
|
|
1202
1452
|
|
|
1203
1453
|
/** Contains response data for the getProperties operation. */
|
|
1204
|
-
export declare type QueueGetPropertiesResponse = QueueGetPropertiesHeaders
|
|
1205
|
-
|
|
1206
|
-
|
|
1207
|
-
|
|
1208
|
-
parsedHeaders: QueueGetPropertiesHeaders;
|
|
1209
|
-
};
|
|
1210
|
-
};
|
|
1454
|
+
export declare type QueueGetPropertiesResponse = WithResponse<QueueGetPropertiesHeaders, QueueGetPropertiesHeaders>;
|
|
1455
|
+
|
|
1456
|
+
/** Contains response data for the getProperties operation. */
|
|
1457
|
+
declare type QueueGetPropertiesResponse_2 = QueueGetPropertiesHeaders;
|
|
1211
1458
|
|
|
1212
1459
|
/** An Azure Storage Queue. */
|
|
1213
1460
|
export declare interface QueueItem {
|
|
@@ -1219,6 +1466,12 @@ export declare interface QueueItem {
|
|
|
1219
1466
|
};
|
|
1220
1467
|
}
|
|
1221
1468
|
|
|
1469
|
+
/** A Message object which can be stored in a Queue */
|
|
1470
|
+
declare interface QueueMessage {
|
|
1471
|
+
/** The content of the message */
|
|
1472
|
+
messageText: string;
|
|
1473
|
+
}
|
|
1474
|
+
|
|
1222
1475
|
/**
|
|
1223
1476
|
* Options to configure {@link QueueClient.peekMessages} operation
|
|
1224
1477
|
*/
|
|
@@ -1228,27 +1481,9 @@ export declare interface QueuePeekMessagesOptions extends MessagesPeekOptionalPa
|
|
|
1228
1481
|
/**
|
|
1229
1482
|
* Contains the response data for the {@link QueueClient.peekMessages} operation.
|
|
1230
1483
|
*/
|
|
1231
|
-
export declare type QueuePeekMessagesResponse = {
|
|
1484
|
+
export declare type QueuePeekMessagesResponse = WithResponse<{
|
|
1232
1485
|
peekedMessageItems: PeekedMessageItem[];
|
|
1233
|
-
} & MessagesPeekHeaders
|
|
1234
|
-
/**
|
|
1235
|
-
* The underlying HTTP response.
|
|
1236
|
-
*/
|
|
1237
|
-
_response: HttpResponse & {
|
|
1238
|
-
/**
|
|
1239
|
-
* The parsed HTTP response headers.
|
|
1240
|
-
*/
|
|
1241
|
-
parsedHeaders: MessagesPeekHeaders;
|
|
1242
|
-
/**
|
|
1243
|
-
* The response body as text (string format)
|
|
1244
|
-
*/
|
|
1245
|
-
bodyAsText: string;
|
|
1246
|
-
/**
|
|
1247
|
-
* The response body as parsed JSON or XML
|
|
1248
|
-
*/
|
|
1249
|
-
parsedBody: PeekedMessageItem[];
|
|
1250
|
-
};
|
|
1251
|
-
};
|
|
1486
|
+
} & MessagesPeekHeaders, MessagesPeekHeaders, PeekedMessageItem[]>;
|
|
1252
1487
|
|
|
1253
1488
|
/**
|
|
1254
1489
|
* Options to configure {@link QueueClient.receiveMessages} operation
|
|
@@ -1259,27 +1494,9 @@ export declare interface QueueReceiveMessageOptions extends MessagesDequeueOptio
|
|
|
1259
1494
|
/**
|
|
1260
1495
|
* Contains the response data for the {@link QueueClient.receiveMessages} operation.
|
|
1261
1496
|
*/
|
|
1262
|
-
export declare type QueueReceiveMessageResponse = {
|
|
1497
|
+
export declare type QueueReceiveMessageResponse = WithResponse<{
|
|
1263
1498
|
receivedMessageItems: ReceivedMessageItem[];
|
|
1264
|
-
} & MessagesDequeueHeaders
|
|
1265
|
-
/**
|
|
1266
|
-
* The underlying HTTP response.
|
|
1267
|
-
*/
|
|
1268
|
-
_response: HttpResponse & {
|
|
1269
|
-
/**
|
|
1270
|
-
* The parsed HTTP response headers.
|
|
1271
|
-
*/
|
|
1272
|
-
parsedHeaders: MessagesDequeueHeaders;
|
|
1273
|
-
/**
|
|
1274
|
-
* The response body as text (string format)
|
|
1275
|
-
*/
|
|
1276
|
-
bodyAsText: string;
|
|
1277
|
-
/**
|
|
1278
|
-
* The response body as parsed JSON or XML
|
|
1279
|
-
*/
|
|
1280
|
-
parsedBody: ReceivedMessageItem[];
|
|
1281
|
-
};
|
|
1282
|
-
};
|
|
1499
|
+
} & MessagesDequeueHeaders, MessagesDequeueHeaders, ReceivedMessageItem[]>;
|
|
1283
1500
|
|
|
1284
1501
|
/**
|
|
1285
1502
|
* ONLY AVAILABLE IN NODE.JS RUNTIME.
|
|
@@ -1377,7 +1594,7 @@ export declare interface QueueSendMessageOptions extends MessagesEnqueueOptional
|
|
|
1377
1594
|
/**
|
|
1378
1595
|
* Contains the response data for the {@link QueueClient.sendMessage} operation.
|
|
1379
1596
|
*/
|
|
1380
|
-
export declare type QueueSendMessageResponse = {
|
|
1597
|
+
export declare type QueueSendMessageResponse = WithResponse<{
|
|
1381
1598
|
/**
|
|
1382
1599
|
* The ID of the sent Message.
|
|
1383
1600
|
*/
|
|
@@ -1403,25 +1620,7 @@ export declare type QueueSendMessageResponse = {
|
|
|
1403
1620
|
* visible in the Queue.
|
|
1404
1621
|
*/
|
|
1405
1622
|
nextVisibleOn: Date;
|
|
1406
|
-
} & MessagesEnqueueHeaders
|
|
1407
|
-
/**
|
|
1408
|
-
* The underlying HTTP response.
|
|
1409
|
-
*/
|
|
1410
|
-
_response: HttpResponse & {
|
|
1411
|
-
/**
|
|
1412
|
-
* The parsed HTTP response headers.
|
|
1413
|
-
*/
|
|
1414
|
-
parsedHeaders: MessagesEnqueueHeaders;
|
|
1415
|
-
/**
|
|
1416
|
-
* The response body as text (string format)
|
|
1417
|
-
*/
|
|
1418
|
-
bodyAsText: string;
|
|
1419
|
-
/**
|
|
1420
|
-
* The response body as parsed JSON or XML
|
|
1421
|
-
*/
|
|
1422
|
-
parsedBody: EnqueuedMessage[];
|
|
1423
|
-
};
|
|
1424
|
-
};
|
|
1623
|
+
} & MessagesEnqueueHeaders, MessagesEnqueueHeaders, EnqueuedMessage[]>;
|
|
1425
1624
|
|
|
1426
1625
|
/**
|
|
1427
1626
|
* A QueueServiceClient represents a URL to the Azure Storage Queue service allowing you
|
|
@@ -1566,7 +1765,7 @@ export declare class QueueServiceClient extends StorageClient {
|
|
|
1566
1765
|
* let iterator = queueServiceClient.listQueues();
|
|
1567
1766
|
* let item = await iterator.next();
|
|
1568
1767
|
* while (!item.done) {
|
|
1569
|
-
* console.log(`Queue${i}: ${
|
|
1768
|
+
* console.log(`Queue${i}: ${item.value.name}`);
|
|
1570
1769
|
* i++;
|
|
1571
1770
|
* item = await iterator.next();
|
|
1572
1771
|
* }
|
|
@@ -1717,6 +1916,16 @@ export declare interface QueueSetAccessPolicyHeaders {
|
|
|
1717
1916
|
errorCode?: string;
|
|
1718
1917
|
}
|
|
1719
1918
|
|
|
1919
|
+
/** Optional parameters. */
|
|
1920
|
+
declare interface QueueSetAccessPolicyOptionalParams extends coreClient.OperationOptions {
|
|
1921
|
+
/** 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> */
|
|
1922
|
+
timeoutInSeconds?: number;
|
|
1923
|
+
/** 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. */
|
|
1924
|
+
requestId?: string;
|
|
1925
|
+
/** the acls for the queue */
|
|
1926
|
+
queueAcl?: SignedIdentifierModel[];
|
|
1927
|
+
}
|
|
1928
|
+
|
|
1720
1929
|
/**
|
|
1721
1930
|
* Options to configure {@link QueueClient.setAccessPolicy} operation
|
|
1722
1931
|
*/
|
|
@@ -1729,13 +1938,10 @@ export declare interface QueueSetAccessPolicyOptions extends CommonOptions {
|
|
|
1729
1938
|
}
|
|
1730
1939
|
|
|
1731
1940
|
/** Contains response data for the setAccessPolicy operation. */
|
|
1732
|
-
export declare type QueueSetAccessPolicyResponse = QueueSetAccessPolicyHeaders
|
|
1733
|
-
|
|
1734
|
-
|
|
1735
|
-
|
|
1736
|
-
parsedHeaders: QueueSetAccessPolicyHeaders;
|
|
1737
|
-
};
|
|
1738
|
-
};
|
|
1941
|
+
export declare type QueueSetAccessPolicyResponse = WithResponse<QueueSetAccessPolicyHeaders, QueueSetAccessPolicyHeaders>;
|
|
1942
|
+
|
|
1943
|
+
/** Contains response data for the setAccessPolicy operation. */
|
|
1944
|
+
declare type QueueSetAccessPolicyResponse_2 = QueueSetAccessPolicyHeaders;
|
|
1739
1945
|
|
|
1740
1946
|
/** Defines headers for Queue_setMetadata operation. */
|
|
1741
1947
|
export declare interface QueueSetMetadataHeaders {
|
|
@@ -1751,6 +1957,18 @@ export declare interface QueueSetMetadataHeaders {
|
|
|
1751
1957
|
errorCode?: string;
|
|
1752
1958
|
}
|
|
1753
1959
|
|
|
1960
|
+
/** Optional parameters. */
|
|
1961
|
+
declare interface QueueSetMetadataOptionalParams extends coreClient.OperationOptions {
|
|
1962
|
+
/** 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> */
|
|
1963
|
+
timeoutInSeconds?: number;
|
|
1964
|
+
/** 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. */
|
|
1965
|
+
requestId?: string;
|
|
1966
|
+
/** 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. */
|
|
1967
|
+
metadata?: {
|
|
1968
|
+
[propertyName: string]: string;
|
|
1969
|
+
};
|
|
1970
|
+
}
|
|
1971
|
+
|
|
1754
1972
|
/**
|
|
1755
1973
|
* Options to configure {@link QueueClient.setMetadata} operation
|
|
1756
1974
|
*/
|
|
@@ -1763,13 +1981,10 @@ export declare interface QueueSetMetadataOptions extends CommonOptions {
|
|
|
1763
1981
|
}
|
|
1764
1982
|
|
|
1765
1983
|
/** Contains response data for the setMetadata operation. */
|
|
1766
|
-
export declare type QueueSetMetadataResponse = QueueSetMetadataHeaders
|
|
1767
|
-
|
|
1768
|
-
|
|
1769
|
-
|
|
1770
|
-
parsedHeaders: QueueSetMetadataHeaders;
|
|
1771
|
-
};
|
|
1772
|
-
};
|
|
1984
|
+
export declare type QueueSetMetadataResponse = WithResponse<QueueSetMetadataHeaders, QueueSetMetadataHeaders>;
|
|
1985
|
+
|
|
1986
|
+
/** Contains response data for the setMetadata operation. */
|
|
1987
|
+
declare type QueueSetMetadataResponse_2 = QueueSetMetadataHeaders;
|
|
1773
1988
|
|
|
1774
1989
|
/**
|
|
1775
1990
|
* Options to configure {@link QueueClient.updateMessage} operation
|
|
@@ -1794,11 +2009,55 @@ export declare type QueueUpdateMessageResponse = MessageIdUpdateResponse;
|
|
|
1794
2009
|
*/
|
|
1795
2010
|
export declare type ReceivedMessageItem = DequeuedMessageItem;
|
|
1796
2011
|
|
|
1797
|
-
|
|
2012
|
+
/**
|
|
2013
|
+
* An object with a simple _response property.
|
|
2014
|
+
*/
|
|
2015
|
+
export declare interface ResponseLike {
|
|
2016
|
+
/**
|
|
2017
|
+
* The underlying HTTP response.
|
|
2018
|
+
*/
|
|
2019
|
+
_response: HttpResponse;
|
|
2020
|
+
}
|
|
1798
2021
|
|
|
1799
|
-
|
|
2022
|
+
/**
|
|
2023
|
+
* An object with a _response property that has body
|
|
2024
|
+
* and headers already parsed into known types.
|
|
2025
|
+
*/
|
|
2026
|
+
export declare interface ResponseWithBody<Headers, Body> {
|
|
2027
|
+
/**
|
|
2028
|
+
* The underlying HTTP response.
|
|
2029
|
+
*/
|
|
2030
|
+
_response: HttpResponse & {
|
|
2031
|
+
/**
|
|
2032
|
+
* The parsed HTTP response headers.
|
|
2033
|
+
*/
|
|
2034
|
+
parsedHeaders: Headers;
|
|
2035
|
+
/**
|
|
2036
|
+
* The response body as text (string format)
|
|
2037
|
+
*/
|
|
2038
|
+
bodyAsText: string;
|
|
2039
|
+
/**
|
|
2040
|
+
* The response body as parsed JSON or XML
|
|
2041
|
+
*/
|
|
2042
|
+
parsedBody: Body;
|
|
2043
|
+
};
|
|
2044
|
+
}
|
|
1800
2045
|
|
|
1801
|
-
|
|
2046
|
+
/**
|
|
2047
|
+
* An object with a _response property that has
|
|
2048
|
+
* headers already parsed into a typed object.
|
|
2049
|
+
*/
|
|
2050
|
+
export declare interface ResponseWithHeaders<Headers> {
|
|
2051
|
+
/**
|
|
2052
|
+
* The underlying HTTP response.
|
|
2053
|
+
*/
|
|
2054
|
+
_response: HttpResponse & {
|
|
2055
|
+
/**
|
|
2056
|
+
* The parsed HTTP response headers.
|
|
2057
|
+
*/
|
|
2058
|
+
parsedHeaders: Headers;
|
|
2059
|
+
};
|
|
2060
|
+
}
|
|
1802
2061
|
|
|
1803
2062
|
export { RestError }
|
|
1804
2063
|
|
|
@@ -1936,6 +2195,49 @@ export declare class SASQueryParameters {
|
|
|
1936
2195
|
private tryAppendQueryParameter;
|
|
1937
2196
|
}
|
|
1938
2197
|
|
|
2198
|
+
/** Interface representing a Service. */
|
|
2199
|
+
declare interface Service {
|
|
2200
|
+
/**
|
|
2201
|
+
* Sets properties for a storage account's Queue service endpoint, including properties for Storage
|
|
2202
|
+
* Analytics and CORS (Cross-Origin Resource Sharing) rules
|
|
2203
|
+
* @param properties The StorageService properties.
|
|
2204
|
+
* @param options The options parameters.
|
|
2205
|
+
*/
|
|
2206
|
+
setProperties(properties: QueueServiceProperties, options?: ServiceSetPropertiesOptionalParams): Promise<ServiceSetPropertiesResponse_2>;
|
|
2207
|
+
/**
|
|
2208
|
+
* gets the properties of a storage account's Queue service, including properties for Storage Analytics
|
|
2209
|
+
* and CORS (Cross-Origin Resource Sharing) rules.
|
|
2210
|
+
* @param options The options parameters.
|
|
2211
|
+
*/
|
|
2212
|
+
getProperties(options?: ServiceGetPropertiesOptionalParams): Promise<ServiceGetPropertiesResponse_2>;
|
|
2213
|
+
/**
|
|
2214
|
+
* Retrieves statistics related to replication for the Queue service. It is only available on the
|
|
2215
|
+
* secondary location endpoint when read-access geo-redundant replication is enabled for the storage
|
|
2216
|
+
* account.
|
|
2217
|
+
* @param options The options parameters.
|
|
2218
|
+
*/
|
|
2219
|
+
getStatistics(options?: ServiceGetStatisticsOptionalParams): Promise<ServiceGetStatisticsResponse_2>;
|
|
2220
|
+
/**
|
|
2221
|
+
* The List Queues Segment operation returns a list of the queues under the specified account
|
|
2222
|
+
* @param options The options parameters.
|
|
2223
|
+
*/
|
|
2224
|
+
listQueuesSegment(options?: ServiceListQueuesSegmentOptionalParams): Promise<ServiceListQueuesSegmentResponse_2>;
|
|
2225
|
+
}
|
|
2226
|
+
|
|
2227
|
+
/**
|
|
2228
|
+
* A subset of `@azure/core-http` ServiceClientOptions
|
|
2229
|
+
*/
|
|
2230
|
+
export declare interface ServiceClientOptions {
|
|
2231
|
+
/**
|
|
2232
|
+
* Optional. Configures the HTTP client to send requests and receive responses.
|
|
2233
|
+
*/
|
|
2234
|
+
httpClient?: RequestPolicy;
|
|
2235
|
+
/**
|
|
2236
|
+
* Optional. Overrides the default policy factories.
|
|
2237
|
+
*/
|
|
2238
|
+
requestPolicyFactories?: RequestPolicyFactory[] | ((defaultRequestPolicyFactories: RequestPolicyFactory[]) => void | RequestPolicyFactory[]);
|
|
2239
|
+
}
|
|
2240
|
+
|
|
1939
2241
|
/**
|
|
1940
2242
|
* Options to configure {@link QueueServiceClient.generateAccountSasUrl} operation.
|
|
1941
2243
|
*/
|
|
@@ -1971,6 +2273,14 @@ export declare interface ServiceGetPropertiesHeaders {
|
|
|
1971
2273
|
errorCode?: string;
|
|
1972
2274
|
}
|
|
1973
2275
|
|
|
2276
|
+
/** Optional parameters. */
|
|
2277
|
+
declare interface ServiceGetPropertiesOptionalParams extends coreClient.OperationOptions {
|
|
2278
|
+
/** 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> */
|
|
2279
|
+
timeoutInSeconds?: number;
|
|
2280
|
+
/** 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. */
|
|
2281
|
+
requestId?: string;
|
|
2282
|
+
}
|
|
2283
|
+
|
|
1974
2284
|
/**
|
|
1975
2285
|
* Options to configure {@link QueueServiceClient.getProperties} operation
|
|
1976
2286
|
*/
|
|
@@ -1983,17 +2293,10 @@ export declare interface ServiceGetPropertiesOptions extends CommonOptions {
|
|
|
1983
2293
|
}
|
|
1984
2294
|
|
|
1985
2295
|
/** Contains response data for the getProperties operation. */
|
|
1986
|
-
export declare type ServiceGetPropertiesResponse = ServiceGetPropertiesHeaders & QueueServiceProperties
|
|
1987
|
-
|
|
1988
|
-
|
|
1989
|
-
|
|
1990
|
-
bodyAsText: string;
|
|
1991
|
-
/** The response body as parsed JSON or XML */
|
|
1992
|
-
parsedBody: QueueServiceProperties;
|
|
1993
|
-
/** The parsed HTTP response headers. */
|
|
1994
|
-
parsedHeaders: ServiceGetPropertiesHeaders;
|
|
1995
|
-
};
|
|
1996
|
-
};
|
|
2296
|
+
export declare type ServiceGetPropertiesResponse = WithResponse<ServiceGetPropertiesHeaders & QueueServiceProperties, ServiceGetPropertiesHeaders, QueueServiceProperties>;
|
|
2297
|
+
|
|
2298
|
+
/** Contains response data for the getProperties operation. */
|
|
2299
|
+
declare type ServiceGetPropertiesResponse_2 = ServiceGetPropertiesHeaders & QueueServiceProperties;
|
|
1997
2300
|
|
|
1998
2301
|
/** Defines headers for Service_getStatistics operation. */
|
|
1999
2302
|
export declare interface ServiceGetStatisticsHeaders {
|
|
@@ -2009,6 +2312,14 @@ export declare interface ServiceGetStatisticsHeaders {
|
|
|
2009
2312
|
errorCode?: string;
|
|
2010
2313
|
}
|
|
2011
2314
|
|
|
2315
|
+
/** Optional parameters. */
|
|
2316
|
+
declare interface ServiceGetStatisticsOptionalParams extends coreClient.OperationOptions {
|
|
2317
|
+
/** 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> */
|
|
2318
|
+
timeoutInSeconds?: number;
|
|
2319
|
+
/** 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. */
|
|
2320
|
+
requestId?: string;
|
|
2321
|
+
}
|
|
2322
|
+
|
|
2012
2323
|
/**
|
|
2013
2324
|
* Options to configure {@link QueueServiceClient.getStatistics} operation
|
|
2014
2325
|
*/
|
|
@@ -2021,17 +2332,10 @@ export declare interface ServiceGetStatisticsOptions extends CommonOptions {
|
|
|
2021
2332
|
}
|
|
2022
2333
|
|
|
2023
2334
|
/** Contains response data for the getStatistics operation. */
|
|
2024
|
-
export declare type ServiceGetStatisticsResponse = ServiceGetStatisticsHeaders & QueueServiceStatistics
|
|
2025
|
-
|
|
2026
|
-
|
|
2027
|
-
|
|
2028
|
-
bodyAsText: string;
|
|
2029
|
-
/** The response body as parsed JSON or XML */
|
|
2030
|
-
parsedBody: QueueServiceStatistics;
|
|
2031
|
-
/** The parsed HTTP response headers. */
|
|
2032
|
-
parsedHeaders: ServiceGetStatisticsHeaders;
|
|
2033
|
-
};
|
|
2034
|
-
};
|
|
2335
|
+
export declare type ServiceGetStatisticsResponse = WithResponse<ServiceGetStatisticsHeaders & QueueServiceStatistics, ServiceGetStatisticsHeaders, QueueServiceStatistics>;
|
|
2336
|
+
|
|
2337
|
+
/** Contains response data for the getStatistics operation. */
|
|
2338
|
+
declare type ServiceGetStatisticsResponse_2 = ServiceGetStatisticsHeaders & QueueServiceStatistics;
|
|
2035
2339
|
|
|
2036
2340
|
/**
|
|
2037
2341
|
* Options to configure {@link QueueServiceClient.listQueues} operation
|
|
@@ -2068,18 +2372,27 @@ export declare interface ServiceListQueuesSegmentHeaders {
|
|
|
2068
2372
|
errorCode?: string;
|
|
2069
2373
|
}
|
|
2070
2374
|
|
|
2375
|
+
/** Optional parameters. */
|
|
2376
|
+
declare interface ServiceListQueuesSegmentOptionalParams extends coreClient.OperationOptions {
|
|
2377
|
+
/** 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> */
|
|
2378
|
+
timeoutInSeconds?: number;
|
|
2379
|
+
/** 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. */
|
|
2380
|
+
requestId?: string;
|
|
2381
|
+
/** Filters the results to return only queues whose name begins with the specified prefix. */
|
|
2382
|
+
prefix?: string;
|
|
2383
|
+
/** 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. */
|
|
2384
|
+
marker?: string;
|
|
2385
|
+
/** 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. */
|
|
2386
|
+
maxPageSize?: number;
|
|
2387
|
+
/** Include this parameter to specify that the queues' metadata be returned as part of the response body. */
|
|
2388
|
+
include?: string[];
|
|
2389
|
+
}
|
|
2390
|
+
|
|
2071
2391
|
/** Contains response data for the listQueuesSegment operation. */
|
|
2072
|
-
export declare type ServiceListQueuesSegmentResponse = ServiceListQueuesSegmentHeaders & ListQueuesSegmentResponse
|
|
2073
|
-
|
|
2074
|
-
|
|
2075
|
-
|
|
2076
|
-
bodyAsText: string;
|
|
2077
|
-
/** The response body as parsed JSON or XML */
|
|
2078
|
-
parsedBody: ListQueuesSegmentResponse;
|
|
2079
|
-
/** The parsed HTTP response headers. */
|
|
2080
|
-
parsedHeaders: ServiceListQueuesSegmentHeaders;
|
|
2081
|
-
};
|
|
2082
|
-
};
|
|
2392
|
+
export declare type ServiceListQueuesSegmentResponse = WithResponse<ServiceListQueuesSegmentHeaders & ListQueuesSegmentResponse, ServiceListQueuesSegmentHeaders, ListQueuesSegmentResponse>;
|
|
2393
|
+
|
|
2394
|
+
/** Contains response data for the listQueuesSegment operation. */
|
|
2395
|
+
declare type ServiceListQueuesSegmentResponse_2 = ServiceListQueuesSegmentHeaders & ListQueuesSegmentResponse;
|
|
2083
2396
|
|
|
2084
2397
|
/** Defines headers for Service_setProperties operation. */
|
|
2085
2398
|
export declare interface ServiceSetPropertiesHeaders {
|
|
@@ -2093,6 +2406,14 @@ export declare interface ServiceSetPropertiesHeaders {
|
|
|
2093
2406
|
errorCode?: string;
|
|
2094
2407
|
}
|
|
2095
2408
|
|
|
2409
|
+
/** Optional parameters. */
|
|
2410
|
+
declare interface ServiceSetPropertiesOptionalParams extends coreClient.OperationOptions {
|
|
2411
|
+
/** 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> */
|
|
2412
|
+
timeoutInSeconds?: number;
|
|
2413
|
+
/** 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. */
|
|
2414
|
+
requestId?: string;
|
|
2415
|
+
}
|
|
2416
|
+
|
|
2096
2417
|
/**
|
|
2097
2418
|
* Options to configure {@link QueueServiceClient.setProperties} operation
|
|
2098
2419
|
*/
|
|
@@ -2105,13 +2426,10 @@ export declare interface ServiceSetPropertiesOptions extends CommonOptions {
|
|
|
2105
2426
|
}
|
|
2106
2427
|
|
|
2107
2428
|
/** Contains response data for the setProperties operation. */
|
|
2108
|
-
export declare type ServiceSetPropertiesResponse = ServiceSetPropertiesHeaders
|
|
2109
|
-
|
|
2110
|
-
|
|
2111
|
-
|
|
2112
|
-
parsedHeaders: ServiceSetPropertiesHeaders;
|
|
2113
|
-
};
|
|
2114
|
-
};
|
|
2429
|
+
export declare type ServiceSetPropertiesResponse = WithResponse<ServiceSetPropertiesHeaders, ServiceSetPropertiesHeaders>;
|
|
2430
|
+
|
|
2431
|
+
/** Contains response data for the setProperties operation. */
|
|
2432
|
+
declare type ServiceSetPropertiesResponse_2 = ServiceSetPropertiesHeaders;
|
|
2115
2433
|
|
|
2116
2434
|
/**
|
|
2117
2435
|
* Signed identifier.
|
|
@@ -2166,17 +2484,17 @@ export declare class StorageBrowserPolicy extends BaseRequestPolicy {
|
|
|
2166
2484
|
* @param nextPolicy -
|
|
2167
2485
|
* @param options -
|
|
2168
2486
|
*/
|
|
2169
|
-
constructor(nextPolicy: RequestPolicy, options:
|
|
2487
|
+
constructor(nextPolicy: RequestPolicy, options: RequestPolicyOptionsLike);
|
|
2170
2488
|
/**
|
|
2171
2489
|
* Sends out request.
|
|
2172
2490
|
*
|
|
2173
2491
|
* @param request -
|
|
2174
2492
|
*/
|
|
2175
|
-
sendRequest(request:
|
|
2493
|
+
sendRequest(request: WebResourceLike): Promise<CompatResponse>;
|
|
2176
2494
|
}
|
|
2177
2495
|
|
|
2178
2496
|
/**
|
|
2179
|
-
* StorageBrowserPolicyFactory is a factory class helping generating
|
|
2497
|
+
* StorageBrowserPolicyFactory is a factory class helping generating StorageBrowserPolicy objects.
|
|
2180
2498
|
*/
|
|
2181
2499
|
export declare class StorageBrowserPolicyFactory implements RequestPolicyFactory {
|
|
2182
2500
|
/**
|
|
@@ -2185,7 +2503,7 @@ export declare class StorageBrowserPolicyFactory implements RequestPolicyFactory
|
|
|
2185
2503
|
* @param nextPolicy -
|
|
2186
2504
|
* @param options -
|
|
2187
2505
|
*/
|
|
2188
|
-
create(nextPolicy: RequestPolicy, options:
|
|
2506
|
+
create(nextPolicy: RequestPolicy, options: RequestPolicyOptionsLike): StorageBrowserPolicy;
|
|
2189
2507
|
}
|
|
2190
2508
|
|
|
2191
2509
|
/**
|
|
@@ -2203,7 +2521,7 @@ declare abstract class StorageClient {
|
|
|
2203
2521
|
* StorageClientContext is a reference to protocol layer operations entry, which is
|
|
2204
2522
|
* generated by AutoRest generator.
|
|
2205
2523
|
*/
|
|
2206
|
-
protected readonly storageClientContext:
|
|
2524
|
+
protected readonly storageClientContext: StorageClient_2;
|
|
2207
2525
|
/**
|
|
2208
2526
|
* Creates an instance of StorageClient.
|
|
2209
2527
|
* @param url -
|
|
@@ -2212,20 +2530,24 @@ declare abstract class StorageClient {
|
|
|
2212
2530
|
protected constructor(url: string, pipeline: Pipeline);
|
|
2213
2531
|
}
|
|
2214
2532
|
|
|
2215
|
-
declare class
|
|
2533
|
+
declare class StorageClient_2 extends coreHttpCompat.ExtendedServiceClient {
|
|
2216
2534
|
url: string;
|
|
2217
2535
|
version: string;
|
|
2218
2536
|
/**
|
|
2219
|
-
* Initializes a new instance of the
|
|
2537
|
+
* Initializes a new instance of the StorageClient class.
|
|
2220
2538
|
* @param url The URL of the service account, queue or message that is the target of the desired
|
|
2221
2539
|
* operation.
|
|
2222
2540
|
* @param options The parameter options
|
|
2223
2541
|
*/
|
|
2224
2542
|
constructor(url: string, options?: StorageClientOptionalParams);
|
|
2543
|
+
service: Service;
|
|
2544
|
+
queue: Queue;
|
|
2545
|
+
messages: Messages;
|
|
2546
|
+
messageId: MessageId;
|
|
2225
2547
|
}
|
|
2226
2548
|
|
|
2227
2549
|
/** Optional parameters. */
|
|
2228
|
-
declare interface StorageClientOptionalParams extends
|
|
2550
|
+
declare interface StorageClientOptionalParams extends coreHttpCompat.ExtendedServiceClientOptions {
|
|
2229
2551
|
/** Specifies the version of the operation to use for this request. */
|
|
2230
2552
|
version?: string;
|
|
2231
2553
|
/** Overrides client endpoint. */
|
|
@@ -2233,22 +2555,17 @@ declare interface StorageClientOptionalParams extends coreHttp.ServiceClientOpti
|
|
|
2233
2555
|
}
|
|
2234
2556
|
|
|
2235
2557
|
/**
|
|
2236
|
-
*
|
|
2237
|
-
*/
|
|
2238
|
-
export declare const StorageOAuthScopes: string | string[];
|
|
2239
|
-
|
|
2240
|
-
/**
|
|
2241
|
-
* Option interface for newPipeline() method.
|
|
2558
|
+
* Options interface for the {@link newPipeline} function.
|
|
2242
2559
|
*/
|
|
2243
2560
|
export declare interface StoragePipelineOptions {
|
|
2244
2561
|
/**
|
|
2245
2562
|
* Options to configure a proxy for outgoing requests.
|
|
2246
2563
|
*/
|
|
2247
|
-
proxyOptions?:
|
|
2564
|
+
proxyOptions?: ProxySettings;
|
|
2248
2565
|
/**
|
|
2249
2566
|
* Options for adding user agent details to outgoing requests.
|
|
2250
2567
|
*/
|
|
2251
|
-
userAgentOptions?:
|
|
2568
|
+
userAgentOptions?: UserAgentPolicyOptions;
|
|
2252
2569
|
/**
|
|
2253
2570
|
* Configures the built-in retry policy behavior.
|
|
2254
2571
|
*/
|
|
@@ -2260,11 +2577,15 @@ export declare interface StoragePipelineOptions {
|
|
|
2260
2577
|
/**
|
|
2261
2578
|
* Configures the HTTP client to send requests and receive responses.
|
|
2262
2579
|
*/
|
|
2263
|
-
httpClient?:
|
|
2580
|
+
httpClient?: RequestPolicy;
|
|
2581
|
+
/**
|
|
2582
|
+
* The audience used to retrieve an AAD token.
|
|
2583
|
+
*/
|
|
2584
|
+
audience?: string | string[];
|
|
2264
2585
|
}
|
|
2265
2586
|
|
|
2266
2587
|
/**
|
|
2267
|
-
* Storage
|
|
2588
|
+
* Storage Blob retry options interface.
|
|
2268
2589
|
*/
|
|
2269
2590
|
export declare interface StorageRetryOptions {
|
|
2270
2591
|
/**
|
|
@@ -2279,9 +2600,10 @@ export declare interface StorageRetryOptions {
|
|
|
2279
2600
|
readonly maxTries?: number;
|
|
2280
2601
|
/**
|
|
2281
2602
|
* Optional. Indicates the maximum time in ms allowed for any single try of an HTTP request.
|
|
2282
|
-
* A value of zero or undefined means
|
|
2603
|
+
* A value of zero or undefined means no default timeout on SDK client, Azure
|
|
2604
|
+
* Storage server's default timeout policy will be used.
|
|
2283
2605
|
*
|
|
2284
|
-
* @see https://docs.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-
|
|
2606
|
+
* @see https://docs.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-blob-service-operations
|
|
2285
2607
|
*/
|
|
2286
2608
|
readonly tryTimeoutInMs?: number;
|
|
2287
2609
|
/**
|
|
@@ -2321,25 +2643,24 @@ export declare class StorageRetryPolicy extends BaseRequestPolicy {
|
|
|
2321
2643
|
* @param options -
|
|
2322
2644
|
* @param retryOptions -
|
|
2323
2645
|
*/
|
|
2324
|
-
constructor(nextPolicy: RequestPolicy, options:
|
|
2646
|
+
constructor(nextPolicy: RequestPolicy, options: RequestPolicyOptionsLike, retryOptions?: StorageRetryOptions);
|
|
2325
2647
|
/**
|
|
2326
2648
|
* Sends request.
|
|
2327
2649
|
*
|
|
2328
2650
|
* @param request -
|
|
2329
2651
|
*/
|
|
2330
|
-
sendRequest(request:
|
|
2652
|
+
sendRequest(request: WebResourceLike): Promise<CompatResponse>;
|
|
2331
2653
|
/**
|
|
2332
2654
|
* Decide and perform next retry. Won't mutate request parameter.
|
|
2333
2655
|
*
|
|
2334
2656
|
* @param request -
|
|
2335
|
-
* @param response -
|
|
2336
2657
|
* @param secondaryHas404 - If attempt was against the secondary & it returned a StatusNotFound (404), then
|
|
2337
2658
|
* the resource was not found. This may be due to replication delay. So, in this
|
|
2338
2659
|
* case, we'll never try the secondary again for this operation.
|
|
2339
2660
|
* @param attempt - How many retries has been attempted to performed, starting from 1, which includes
|
|
2340
2661
|
* the attempt will be performed by this method call.
|
|
2341
2662
|
*/
|
|
2342
|
-
protected attemptSendRequest(request:
|
|
2663
|
+
protected attemptSendRequest(request: WebResourceLike, secondaryHas404: boolean, attempt: number): Promise<CompatResponse>;
|
|
2343
2664
|
/**
|
|
2344
2665
|
* Decide whether to retry according to last HTTP response and retry counters.
|
|
2345
2666
|
*
|
|
@@ -2348,7 +2669,7 @@ export declare class StorageRetryPolicy extends BaseRequestPolicy {
|
|
|
2348
2669
|
* @param response -
|
|
2349
2670
|
* @param err -
|
|
2350
2671
|
*/
|
|
2351
|
-
protected shouldRetry(isPrimaryRetry: boolean, attempt: number, response?:
|
|
2672
|
+
protected shouldRetry(isPrimaryRetry: boolean, attempt: number, response?: CompatResponse, err?: RestError): boolean;
|
|
2352
2673
|
/**
|
|
2353
2674
|
* Delay a calculated time between retries.
|
|
2354
2675
|
*
|
|
@@ -2370,12 +2691,12 @@ export declare class StorageRetryPolicyFactory implements RequestPolicyFactory {
|
|
|
2370
2691
|
*/
|
|
2371
2692
|
constructor(retryOptions?: StorageRetryOptions);
|
|
2372
2693
|
/**
|
|
2373
|
-
* Creates a
|
|
2694
|
+
* Creates a StorageRetryPolicy object.
|
|
2374
2695
|
*
|
|
2375
2696
|
* @param nextPolicy -
|
|
2376
2697
|
* @param options -
|
|
2377
2698
|
*/
|
|
2378
|
-
create(nextPolicy: RequestPolicy, options:
|
|
2699
|
+
create(nextPolicy: RequestPolicy, options: RequestPolicyOptionsLike): StorageRetryPolicy;
|
|
2379
2700
|
}
|
|
2380
2701
|
|
|
2381
2702
|
/**
|
|
@@ -2413,12 +2734,12 @@ export declare class StorageSharedKeyCredential extends Credential_2 {
|
|
|
2413
2734
|
*/
|
|
2414
2735
|
constructor(accountName: string, accountKey: string);
|
|
2415
2736
|
/**
|
|
2416
|
-
* Creates a
|
|
2737
|
+
* Creates a StorageSharedKeyCredentialPolicy object.
|
|
2417
2738
|
*
|
|
2418
2739
|
* @param nextPolicy -
|
|
2419
2740
|
* @param options -
|
|
2420
2741
|
*/
|
|
2421
|
-
create(nextPolicy: RequestPolicy, options:
|
|
2742
|
+
create(nextPolicy: RequestPolicy, options: RequestPolicyOptionsLike): StorageSharedKeyCredentialPolicy;
|
|
2422
2743
|
/**
|
|
2423
2744
|
* Generates a hash signature for an HTTP request or for a SAS.
|
|
2424
2745
|
*
|
|
@@ -2432,7 +2753,7 @@ export declare class StorageSharedKeyCredential extends Credential_2 {
|
|
|
2432
2753
|
*/
|
|
2433
2754
|
export declare class StorageSharedKeyCredentialPolicy extends CredentialPolicy {
|
|
2434
2755
|
/**
|
|
2435
|
-
* Reference to
|
|
2756
|
+
* Reference to StorageSharedKeyCredential which generates StorageSharedKeyCredentialPolicy
|
|
2436
2757
|
*/
|
|
2437
2758
|
private readonly factory;
|
|
2438
2759
|
/**
|
|
@@ -2441,13 +2762,13 @@ export declare class StorageSharedKeyCredentialPolicy extends CredentialPolicy {
|
|
|
2441
2762
|
* @param options -
|
|
2442
2763
|
* @param factory -
|
|
2443
2764
|
*/
|
|
2444
|
-
constructor(nextPolicy: RequestPolicy, options:
|
|
2765
|
+
constructor(nextPolicy: RequestPolicy, options: RequestPolicyOptionsLike, factory: StorageSharedKeyCredential);
|
|
2445
2766
|
/**
|
|
2446
2767
|
* Signs request.
|
|
2447
2768
|
*
|
|
2448
2769
|
* @param request -
|
|
2449
2770
|
*/
|
|
2450
|
-
protected signRequest(request:
|
|
2771
|
+
protected signRequest(request: WebResourceLike): WebResourceLike;
|
|
2451
2772
|
/**
|
|
2452
2773
|
* Retrieve header value according to shared key sign rules.
|
|
2453
2774
|
* @see https://docs.microsoft.com/en-us/rest/api/storageservices/authenticate-with-shared-key
|
|
@@ -2478,6 +2799,9 @@ export declare class StorageSharedKeyCredentialPolicy extends CredentialPolicy {
|
|
|
2478
2799
|
private getCanonicalizedResourceString;
|
|
2479
2800
|
}
|
|
2480
2801
|
|
|
2481
|
-
|
|
2802
|
+
/**
|
|
2803
|
+
* A type that represents an operation result with a known _response property.
|
|
2804
|
+
*/
|
|
2805
|
+
export declare type WithResponse<T, Headers = undefined, Body = undefined> = T & (Body extends object ? ResponseWithBody<Headers, Body> : Headers extends object ? ResponseWithHeaders<Headers> : ResponseLike);
|
|
2482
2806
|
|
|
2483
2807
|
export { }
|