@azure/storage-queue 12.26.0 → 12.27.0-alpha.20250520.6
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/README.md +92 -136
- package/dist/browser/AccountSASPermissions.d.ts +61 -0
- package/dist/browser/AccountSASPermissions.d.ts.map +1 -0
- package/dist/browser/AccountSASPermissions.js.map +1 -0
- package/dist/browser/AccountSASResourceTypes.d.ts +38 -0
- package/dist/browser/AccountSASResourceTypes.d.ts.map +1 -0
- package/dist/browser/AccountSASResourceTypes.js.map +1 -0
- package/dist/browser/AccountSASServices.d.ts +40 -0
- package/dist/browser/AccountSASServices.d.ts.map +1 -0
- package/dist/browser/AccountSASServices.js.map +1 -0
- package/dist/browser/AccountSASSignatureValues.d.ts +74 -0
- package/dist/browser/AccountSASSignatureValues.d.ts.map +1 -0
- package/{dist-esm/storage-queue/src → dist/browser}/AccountSASSignatureValues.js +7 -7
- package/dist/browser/AccountSASSignatureValues.js.map +1 -0
- package/dist/browser/Pipeline.d.ts +136 -0
- package/dist/browser/Pipeline.d.ts.map +1 -0
- package/{dist-esm/storage-queue/src → dist/browser}/Pipeline.js +11 -11
- package/dist/browser/Pipeline.js.map +1 -0
- package/dist/browser/QueueClient.d.ts +667 -0
- package/dist/browser/QueueClient.d.ts.map +1 -0
- package/{dist-esm/storage-queue/src → dist/browser}/QueueClient.js +78 -22
- package/dist/browser/QueueClient.js.map +1 -0
- package/dist/browser/QueueSASPermissions.d.ts +42 -0
- package/dist/browser/QueueSASPermissions.d.ts.map +1 -0
- package/dist/browser/QueueSASPermissions.js.map +1 -0
- package/dist/browser/QueueSASSignatureValues.d.ts +70 -0
- package/dist/browser/QueueSASSignatureValues.d.ts.map +1 -0
- package/{dist-esm/storage-queue/src → dist/browser}/QueueSASSignatureValues.js +5 -5
- package/dist/browser/QueueSASSignatureValues.js.map +1 -0
- package/dist/browser/QueueServiceClient.d.ts +411 -0
- package/dist/browser/QueueServiceClient.d.ts.map +1 -0
- package/{dist-esm/storage-queue/src → dist/browser}/QueueServiceClient.js +88 -50
- package/dist/browser/QueueServiceClient.js.map +1 -0
- package/dist/browser/SASQueryParameters.d.ts +110 -0
- package/dist/browser/SASQueryParameters.d.ts.map +1 -0
- package/{dist-esm/storage-queue/src → dist/browser}/SASQueryParameters.js +2 -2
- package/dist/browser/SASQueryParameters.js.map +1 -0
- package/dist/browser/SasIPRange.d.ts +24 -0
- package/dist/browser/SasIPRange.d.ts.map +1 -0
- package/dist/browser/SasIPRange.js.map +1 -0
- package/dist/browser/StorageClient.d.ts +60 -0
- package/dist/browser/StorageClient.d.ts.map +1 -0
- package/{dist-esm/storage-queue/src → dist/browser}/StorageClient.js +3 -3
- package/dist/browser/StorageClient.js.map +1 -0
- package/dist/browser/StorageContextClient.d.ts +9 -0
- package/dist/browser/StorageContextClient.d.ts.map +1 -0
- package/{dist-esm/storage-queue/src → dist/browser}/StorageContextClient.js +1 -1
- package/dist/browser/StorageContextClient.js.map +1 -0
- package/dist/browser/generated/src/index.d.ts +4 -0
- package/dist/browser/generated/src/index.d.ts.map +1 -0
- package/dist/browser/generated/src/index.js +11 -0
- package/dist/browser/generated/src/index.js.map +1 -0
- package/dist/browser/generated/src/models/index.d.ts +830 -0
- package/dist/browser/generated/src/models/index.d.ts.map +1 -0
- package/dist/browser/generated/src/models/index.js.map +1 -0
- package/dist/browser/generated/src/models/mappers.d.ts +50 -0
- package/dist/browser/generated/src/models/mappers.d.ts.map +1 -0
- package/dist/browser/generated/src/models/mappers.js.map +1 -0
- package/dist/browser/generated/src/models/parameters.d.ts +30 -0
- package/dist/browser/generated/src/models/parameters.d.ts.map +1 -0
- package/{dist-esm/storage-queue/src → dist/browser}/generated/src/models/parameters.js +2 -2
- package/{dist-esm/storage-queue/src → dist/browser}/generated/src/models/parameters.js.map +1 -1
- package/dist/browser/generated/src/operations/index.d.ts +5 -0
- package/dist/browser/generated/src/operations/index.d.ts.map +1 -0
- package/{dist-esm/storage-queue/src/generated/src → dist/browser/generated/src/operations}/index.js +4 -3
- package/dist/browser/generated/src/operations/index.js.map +1 -0
- package/dist/browser/generated/src/operations/messageId.d.ts +35 -0
- package/dist/browser/generated/src/operations/messageId.d.ts.map +1 -0
- package/{dist-esm/storage-queue/src → dist/browser}/generated/src/operations/messageId.js +2 -2
- package/dist/browser/generated/src/operations/messageId.js.map +1 -0
- package/dist/browser/generated/src/operations/messages.d.ts +38 -0
- package/dist/browser/generated/src/operations/messages.d.ts.map +1 -0
- package/{dist-esm/storage-queue/src → dist/browser}/generated/src/operations/messages.js +2 -2
- package/dist/browser/generated/src/operations/messages.js.map +1 -0
- package/dist/browser/generated/src/operations/queue.d.ts +46 -0
- package/dist/browser/generated/src/operations/queue.d.ts.map +1 -0
- package/{dist-esm/storage-queue/src → dist/browser}/generated/src/operations/queue.js +2 -2
- package/dist/browser/generated/src/operations/queue.js.map +1 -0
- package/dist/browser/generated/src/operations/service.d.ts +38 -0
- package/dist/browser/generated/src/operations/service.d.ts.map +1 -0
- package/{dist-esm/storage-queue/src → dist/browser}/generated/src/operations/service.js +2 -2
- package/dist/browser/generated/src/operations/service.js.map +1 -0
- package/dist/browser/generated/src/operationsInterfaces/index.d.ts +5 -0
- package/dist/browser/generated/src/operationsInterfaces/index.d.ts.map +1 -0
- package/{dist-esm/storage-queue/src/generated/src/operations → dist/browser/generated/src/operationsInterfaces}/index.js +4 -4
- package/dist/browser/generated/src/operationsInterfaces/index.js.map +1 -0
- package/dist/browser/generated/src/operationsInterfaces/messageId.d.ts +27 -0
- package/dist/browser/generated/src/operationsInterfaces/messageId.d.ts.map +1 -0
- package/dist/browser/generated/src/operationsInterfaces/messageId.js.map +1 -0
- package/dist/browser/generated/src/operationsInterfaces/messages.d.ts +30 -0
- package/dist/browser/generated/src/operationsInterfaces/messages.d.ts.map +1 -0
- package/dist/browser/generated/src/operationsInterfaces/messages.js.map +1 -0
- package/dist/browser/generated/src/operationsInterfaces/queue.d.ts +38 -0
- package/dist/browser/generated/src/operationsInterfaces/queue.d.ts.map +1 -0
- package/dist/browser/generated/src/operationsInterfaces/queue.js.map +1 -0
- package/dist/browser/generated/src/operationsInterfaces/service.d.ts +30 -0
- package/dist/browser/generated/src/operationsInterfaces/service.d.ts.map +1 -0
- package/dist/browser/generated/src/operationsInterfaces/service.js.map +1 -0
- package/dist/browser/generated/src/storageClient.d.ts +19 -0
- package/dist/browser/generated/src/storageClient.d.ts.map +1 -0
- package/{dist-esm/storage-queue/src → dist/browser}/generated/src/storageClient.js +3 -3
- package/dist/browser/generated/src/storageClient.js.map +1 -0
- package/dist/browser/generatedModels.d.ts +30 -0
- package/dist/browser/generatedModels.d.ts.map +1 -0
- package/dist/browser/generatedModels.js.map +1 -0
- package/dist/browser/index-browser.d.mts.map +1 -0
- package/dist/browser/index-browser.mjs.map +1 -0
- package/dist/browser/index.d.ts +20 -0
- package/dist/browser/index.js +18 -0
- package/dist/browser/log.d.ts +5 -0
- package/dist/browser/log.d.ts.map +1 -0
- package/dist/browser/log.js.map +1 -0
- package/dist/browser/models.d.ts +23 -0
- package/dist/browser/models.d.ts.map +1 -0
- package/dist/browser/models.js.map +1 -0
- package/dist/browser/package.json +3 -0
- package/dist/browser/utils/constants.d.ts +47 -0
- package/dist/browser/utils/constants.d.ts.map +1 -0
- package/{dist-esm/storage-queue/src → dist/browser}/utils/constants.js +2 -2
- package/dist/browser/utils/constants.js.map +1 -0
- package/dist/browser/utils/tracing.d.ts +6 -0
- package/dist/browser/utils/tracing.d.ts.map +1 -0
- package/{dist-esm/storage-queue/src → dist/browser}/utils/tracing.js +1 -1
- package/dist/browser/utils/tracing.js.map +1 -0
- package/dist/browser/utils/utils.common.d.ts +198 -0
- package/dist/browser/utils/utils.common.d.ts.map +1 -0
- package/{dist-esm/storage-queue/src → dist/browser}/utils/utils.common.js +1 -1
- package/dist/browser/utils/utils.common.js.map +1 -0
- package/dist/commonjs/AccountSASPermissions.d.ts +61 -0
- package/dist/commonjs/AccountSASPermissions.d.ts.map +1 -0
- package/dist/commonjs/AccountSASPermissions.js +132 -0
- package/dist/commonjs/AccountSASPermissions.js.map +1 -0
- package/dist/commonjs/AccountSASResourceTypes.d.ts +38 -0
- package/dist/commonjs/AccountSASResourceTypes.d.ts.map +1 -0
- package/dist/commonjs/AccountSASResourceTypes.js +76 -0
- package/dist/commonjs/AccountSASResourceTypes.js.map +1 -0
- package/dist/commonjs/AccountSASServices.d.ts +40 -0
- package/dist/commonjs/AccountSASServices.d.ts.map +1 -0
- package/dist/commonjs/AccountSASServices.js +84 -0
- package/dist/commonjs/AccountSASServices.js.map +1 -0
- package/dist/commonjs/AccountSASSignatureValues.d.ts +74 -0
- package/dist/commonjs/AccountSASSignatureValues.d.ts.map +1 -0
- package/dist/commonjs/AccountSASSignatureValues.js +76 -0
- package/dist/commonjs/AccountSASSignatureValues.js.map +1 -0
- package/dist/commonjs/Pipeline.d.ts +136 -0
- package/dist/commonjs/Pipeline.d.ts.map +1 -0
- package/dist/commonjs/Pipeline.js +267 -0
- package/dist/commonjs/Pipeline.js.map +1 -0
- package/dist/commonjs/QueueClient.d.ts +667 -0
- package/dist/commonjs/QueueClient.d.ts.map +1 -0
- package/dist/commonjs/QueueClient.js +626 -0
- package/dist/commonjs/QueueClient.js.map +1 -0
- package/dist/commonjs/QueueSASPermissions.d.ts +42 -0
- package/dist/commonjs/QueueSASPermissions.d.ts.map +1 -0
- package/dist/commonjs/QueueSASPermissions.js +86 -0
- package/dist/commonjs/QueueSASPermissions.js.map +1 -0
- package/dist/commonjs/QueueSASSignatureValues.d.ts +70 -0
- package/dist/commonjs/QueueSASSignatureValues.d.ts.map +1 -0
- package/dist/commonjs/QueueSASSignatureValues.js +69 -0
- package/dist/commonjs/QueueSASSignatureValues.js.map +1 -0
- package/dist/commonjs/QueueServiceClient.d.ts +411 -0
- package/dist/commonjs/QueueServiceClient.d.ts.map +1 -0
- package/dist/commonjs/QueueServiceClient.js +443 -0
- package/dist/commonjs/QueueServiceClient.js.map +1 -0
- package/dist/commonjs/SASQueryParameters.d.ts +110 -0
- package/dist/commonjs/SASQueryParameters.d.ts.map +1 -0
- package/dist/commonjs/SASQueryParameters.js +139 -0
- package/dist/commonjs/SASQueryParameters.js.map +1 -0
- package/dist/commonjs/SasIPRange.d.ts +24 -0
- package/dist/commonjs/SasIPRange.d.ts.map +1 -0
- package/dist/commonjs/SasIPRange.js +16 -0
- package/dist/commonjs/SasIPRange.js.map +1 -0
- package/dist/commonjs/StorageClient.d.ts +60 -0
- package/dist/commonjs/StorageClient.d.ts.map +1 -0
- package/dist/commonjs/StorageClient.js +46 -0
- package/dist/commonjs/StorageClient.js.map +1 -0
- package/dist/commonjs/StorageContextClient.d.ts +9 -0
- package/dist/commonjs/StorageContextClient.d.ts.map +1 -0
- package/dist/commonjs/StorageContextClient.js +22 -0
- package/dist/commonjs/StorageContextClient.js.map +1 -0
- package/dist/commonjs/generated/src/index.d.ts +4 -0
- package/dist/commonjs/generated/src/index.d.ts.map +1 -0
- package/dist/commonjs/generated/src/index.js +16 -0
- package/dist/commonjs/generated/src/index.js.map +1 -0
- package/dist/commonjs/generated/src/models/index.d.ts +830 -0
- package/dist/commonjs/generated/src/models/index.d.ts.map +1 -0
- package/dist/commonjs/generated/src/models/index.js +129 -0
- package/dist/commonjs/generated/src/models/index.js.map +1 -0
- package/dist/commonjs/generated/src/models/mappers.d.ts +50 -0
- package/dist/commonjs/generated/src/models/mappers.d.ts.map +1 -0
- package/dist/commonjs/generated/src/models/mappers.js +1721 -0
- package/dist/commonjs/generated/src/models/mappers.js.map +1 -0
- package/dist/commonjs/generated/src/models/parameters.d.ts +30 -0
- package/dist/commonjs/generated/src/models/parameters.d.ts.map +1 -0
- package/dist/commonjs/generated/src/models/parameters.js +328 -0
- package/dist/commonjs/generated/src/models/parameters.js.map +1 -0
- package/dist/commonjs/generated/src/operations/index.d.ts +5 -0
- package/dist/commonjs/generated/src/operations/index.d.ts.map +1 -0
- package/dist/commonjs/generated/src/operations/index.js +15 -0
- package/dist/commonjs/generated/src/operations/index.js.map +1 -0
- package/dist/commonjs/generated/src/operations/messageId.d.ts +35 -0
- package/dist/commonjs/generated/src/operations/messageId.d.ts.map +1 -0
- package/dist/commonjs/generated/src/operations/messageId.js +106 -0
- package/dist/commonjs/generated/src/operations/messageId.js.map +1 -0
- package/dist/commonjs/generated/src/operations/messages.d.ts +38 -0
- package/dist/commonjs/generated/src/operations/messages.d.ts.map +1 -0
- package/dist/commonjs/generated/src/operations/messages.js +199 -0
- package/dist/commonjs/generated/src/operations/messages.js.map +1 -0
- package/dist/commonjs/generated/src/operations/queue.d.ts +46 -0
- package/dist/commonjs/generated/src/operations/queue.d.ts.map +1 -0
- package/dist/commonjs/generated/src/operations/queue.js +226 -0
- package/dist/commonjs/generated/src/operations/queue.js.map +1 -0
- package/dist/commonjs/generated/src/operations/service.d.ts +38 -0
- package/dist/commonjs/generated/src/operations/service.d.ts.map +1 -0
- package/dist/commonjs/generated/src/operations/service.js +175 -0
- package/dist/commonjs/generated/src/operations/service.js.map +1 -0
- package/dist/commonjs/generated/src/operationsInterfaces/index.d.ts +5 -0
- package/dist/commonjs/generated/src/operationsInterfaces/index.d.ts.map +1 -0
- package/dist/commonjs/generated/src/operationsInterfaces/index.js +15 -0
- package/dist/commonjs/generated/src/operationsInterfaces/index.js.map +1 -0
- package/dist/commonjs/generated/src/operationsInterfaces/messageId.d.ts +27 -0
- package/dist/commonjs/generated/src/operationsInterfaces/messageId.d.ts.map +1 -0
- package/dist/commonjs/generated/src/operationsInterfaces/messageId.js +10 -0
- package/dist/commonjs/generated/src/operationsInterfaces/messageId.js.map +1 -0
- package/dist/commonjs/generated/src/operationsInterfaces/messages.d.ts +30 -0
- package/dist/commonjs/generated/src/operationsInterfaces/messages.d.ts.map +1 -0
- package/dist/commonjs/generated/src/operationsInterfaces/messages.js +10 -0
- package/dist/commonjs/generated/src/operationsInterfaces/messages.js.map +1 -0
- package/dist/commonjs/generated/src/operationsInterfaces/queue.d.ts +38 -0
- package/dist/commonjs/generated/src/operationsInterfaces/queue.d.ts.map +1 -0
- package/{dist-esm/storage-blob/src/generated/src/operationsInterfaces/appendBlob.js → dist/commonjs/generated/src/operationsInterfaces/queue.js} +3 -2
- package/dist/commonjs/generated/src/operationsInterfaces/queue.js.map +1 -0
- package/dist/commonjs/generated/src/operationsInterfaces/service.d.ts +30 -0
- package/dist/commonjs/generated/src/operationsInterfaces/service.d.ts.map +1 -0
- package/dist/commonjs/generated/src/operationsInterfaces/service.js +10 -0
- package/dist/commonjs/generated/src/operationsInterfaces/service.js.map +1 -0
- package/dist/commonjs/generated/src/storageClient.d.ts +19 -0
- package/dist/commonjs/generated/src/storageClient.d.ts.map +1 -0
- package/dist/commonjs/generated/src/storageClient.js +52 -0
- package/dist/commonjs/generated/src/storageClient.js.map +1 -0
- package/dist/commonjs/generatedModels.d.ts +30 -0
- package/dist/commonjs/generatedModels.d.ts.map +1 -0
- package/dist/commonjs/generatedModels.js +5 -0
- package/dist/commonjs/generatedModels.js.map +1 -0
- package/dist/commonjs/index.d.ts +28 -0
- package/dist/commonjs/index.d.ts.map +1 -0
- package/dist/commonjs/index.js +49 -0
- package/dist/commonjs/index.js.map +1 -0
- package/dist/commonjs/log.d.ts +5 -0
- package/dist/commonjs/log.d.ts.map +1 -0
- package/dist/commonjs/log.js +11 -0
- package/dist/commonjs/log.js.map +1 -0
- package/dist/commonjs/models.d.ts +23 -0
- package/dist/commonjs/models.d.ts.map +1 -0
- package/dist/commonjs/models.js +23 -0
- package/dist/commonjs/models.js.map +1 -0
- package/dist/commonjs/package.json +3 -0
- package/dist/commonjs/tsdoc-metadata.json +11 -0
- package/dist/commonjs/utils/constants.d.ts +47 -0
- package/dist/commonjs/utils/constants.d.ts.map +1 -0
- package/dist/commonjs/utils/constants.js +122 -0
- package/dist/commonjs/utils/constants.js.map +1 -0
- package/dist/commonjs/utils/tracing.d.ts +6 -0
- package/dist/commonjs/utils/tracing.d.ts.map +1 -0
- package/dist/commonjs/utils/tracing.js +17 -0
- package/dist/commonjs/utils/tracing.js.map +1 -0
- package/dist/commonjs/utils/utils.common.d.ts +198 -0
- package/dist/commonjs/utils/utils.common.d.ts.map +1 -0
- package/dist/commonjs/utils/utils.common.js +381 -0
- package/dist/commonjs/utils/utils.common.js.map +1 -0
- package/dist/esm/AccountSASPermissions.d.ts +61 -0
- package/dist/esm/AccountSASPermissions.d.ts.map +1 -0
- package/{dist-esm/storage-blob/src/sas → dist/esm}/AccountSASPermissions.js +4 -103
- package/dist/esm/AccountSASPermissions.js.map +1 -0
- package/dist/esm/AccountSASResourceTypes.d.ts +38 -0
- package/dist/esm/AccountSASResourceTypes.d.ts.map +1 -0
- package/dist/esm/AccountSASResourceTypes.js.map +1 -0
- package/dist/esm/AccountSASServices.d.ts +40 -0
- package/dist/esm/AccountSASServices.d.ts.map +1 -0
- package/dist/esm/AccountSASServices.js.map +1 -0
- package/dist/esm/AccountSASSignatureValues.d.ts +74 -0
- package/dist/esm/AccountSASSignatureValues.d.ts.map +1 -0
- package/{dist-esm/storage-blob/src/sas → dist/esm}/AccountSASSignatureValues.js +12 -40
- package/dist/esm/AccountSASSignatureValues.js.map +1 -0
- package/dist/esm/Pipeline.d.ts +136 -0
- package/dist/esm/Pipeline.d.ts.map +1 -0
- package/{dist-esm/storage-blob/src → dist/esm}/Pipeline.js +13 -13
- package/dist/esm/Pipeline.js.map +1 -0
- package/dist/esm/QueueClient.d.ts +667 -0
- package/dist/esm/QueueClient.d.ts.map +1 -0
- package/dist/esm/QueueClient.js +622 -0
- package/dist/esm/QueueClient.js.map +1 -0
- package/dist/esm/QueueSASPermissions.d.ts +42 -0
- package/dist/esm/QueueSASPermissions.d.ts.map +1 -0
- package/dist/esm/QueueSASPermissions.js +82 -0
- package/dist/esm/QueueSASPermissions.js.map +1 -0
- package/dist/esm/QueueSASSignatureValues.d.ts +70 -0
- package/dist/esm/QueueSASSignatureValues.d.ts.map +1 -0
- package/dist/esm/QueueSASSignatureValues.js +65 -0
- package/dist/esm/QueueSASSignatureValues.js.map +1 -0
- package/dist/esm/QueueServiceClient.d.ts +411 -0
- package/dist/esm/QueueServiceClient.d.ts.map +1 -0
- package/dist/esm/QueueServiceClient.js +439 -0
- package/dist/esm/QueueServiceClient.js.map +1 -0
- package/dist/esm/SASQueryParameters.d.ts +110 -0
- package/dist/esm/SASQueryParameters.d.ts.map +1 -0
- package/dist/esm/SASQueryParameters.js +135 -0
- package/dist/esm/SASQueryParameters.js.map +1 -0
- package/dist/esm/SasIPRange.d.ts +24 -0
- package/dist/esm/SasIPRange.d.ts.map +1 -0
- package/dist/esm/SasIPRange.js.map +1 -0
- package/dist/esm/StorageClient.d.ts +60 -0
- package/dist/esm/StorageClient.d.ts.map +1 -0
- package/dist/esm/StorageClient.js +41 -0
- package/dist/esm/StorageClient.js.map +1 -0
- package/dist/esm/StorageContextClient.d.ts +9 -0
- package/dist/esm/StorageContextClient.d.ts.map +1 -0
- package/{dist-esm/storage-blob/src → dist/esm}/StorageContextClient.js +4 -3
- package/dist/esm/StorageContextClient.js.map +1 -0
- package/dist/esm/generated/src/index.d.ts +4 -0
- package/dist/esm/generated/src/index.d.ts.map +1 -0
- package/dist/esm/generated/src/index.js +11 -0
- package/dist/esm/generated/src/index.js.map +1 -0
- package/dist/esm/generated/src/models/index.d.ts +830 -0
- package/dist/esm/generated/src/models/index.d.ts.map +1 -0
- package/dist/esm/generated/src/models/index.js +126 -0
- package/dist/esm/generated/src/models/index.js.map +1 -0
- package/dist/esm/generated/src/models/mappers.d.ts +50 -0
- package/dist/esm/generated/src/models/mappers.d.ts.map +1 -0
- package/dist/esm/generated/src/models/mappers.js +1718 -0
- package/dist/esm/generated/src/models/mappers.js.map +1 -0
- package/dist/esm/generated/src/models/parameters.d.ts +30 -0
- package/dist/esm/generated/src/models/parameters.d.ts.map +1 -0
- package/dist/esm/generated/src/models/parameters.js +325 -0
- package/dist/esm/generated/src/models/parameters.js.map +1 -0
- package/dist/esm/generated/src/operations/index.d.ts +5 -0
- package/dist/esm/generated/src/operations/index.d.ts.map +1 -0
- package/{dist-esm/storage-blob/src/generated/src → dist/esm/generated/src/operations}/index.js +4 -3
- package/dist/esm/generated/src/operations/index.js.map +1 -0
- package/dist/esm/generated/src/operations/messageId.d.ts +35 -0
- package/dist/esm/generated/src/operations/messageId.d.ts.map +1 -0
- package/dist/esm/generated/src/operations/messageId.js +101 -0
- package/dist/esm/generated/src/operations/messageId.js.map +1 -0
- package/dist/esm/generated/src/operations/messages.d.ts +38 -0
- package/dist/esm/generated/src/operations/messages.d.ts.map +1 -0
- package/dist/esm/generated/src/operations/messages.js +194 -0
- package/dist/esm/generated/src/operations/messages.js.map +1 -0
- package/dist/esm/generated/src/operations/queue.d.ts +46 -0
- package/dist/esm/generated/src/operations/queue.d.ts.map +1 -0
- package/dist/esm/generated/src/operations/queue.js +221 -0
- package/dist/esm/generated/src/operations/queue.js.map +1 -0
- package/dist/esm/generated/src/operations/service.d.ts +38 -0
- package/dist/esm/generated/src/operations/service.d.ts.map +1 -0
- package/dist/esm/generated/src/operations/service.js +170 -0
- package/dist/esm/generated/src/operations/service.js.map +1 -0
- package/dist/esm/generated/src/operationsInterfaces/index.d.ts +5 -0
- package/dist/esm/generated/src/operationsInterfaces/index.d.ts.map +1 -0
- package/{dist-esm/storage-queue/src → dist/esm}/generated/src/operationsInterfaces/index.js +4 -4
- package/dist/esm/generated/src/operationsInterfaces/index.js.map +1 -0
- package/dist/esm/generated/src/operationsInterfaces/messageId.d.ts +27 -0
- package/dist/esm/generated/src/operationsInterfaces/messageId.d.ts.map +1 -0
- package/{dist-esm/storage-blob/src/generated/src/operationsInterfaces/container.js → dist/esm/generated/src/operationsInterfaces/messageId.js} +1 -1
- package/dist/esm/generated/src/operationsInterfaces/messageId.js.map +1 -0
- package/dist/esm/generated/src/operationsInterfaces/messages.d.ts +30 -0
- package/dist/esm/generated/src/operationsInterfaces/messages.d.ts.map +1 -0
- package/{dist-esm/storage-blob/src/generated/src/operationsInterfaces/pageBlob.js → dist/esm/generated/src/operationsInterfaces/messages.js} +1 -1
- package/dist/esm/generated/src/operationsInterfaces/messages.js.map +1 -0
- package/dist/esm/generated/src/operationsInterfaces/queue.d.ts +38 -0
- package/dist/esm/generated/src/operationsInterfaces/queue.d.ts.map +1 -0
- package/{dist-esm/storage-blob/src/generated/src/operationsInterfaces/blob.js → dist/esm/generated/src/operationsInterfaces/queue.js} +1 -1
- package/dist/esm/generated/src/operationsInterfaces/queue.js.map +1 -0
- package/dist/esm/generated/src/operationsInterfaces/service.d.ts +30 -0
- package/dist/esm/generated/src/operationsInterfaces/service.d.ts.map +1 -0
- package/dist/esm/generated/src/operationsInterfaces/service.js.map +1 -0
- package/dist/esm/generated/src/storageClient.d.ts +19 -0
- package/dist/esm/generated/src/storageClient.d.ts.map +1 -0
- package/{dist-esm/storage-blob/src → dist/esm}/generated/src/storageClient.js +9 -11
- package/dist/esm/generated/src/storageClient.js.map +1 -0
- package/dist/esm/generatedModels.d.ts +30 -0
- package/dist/esm/generatedModels.d.ts.map +1 -0
- package/{dist-esm/storage-blob/src/BatchResponse.js → dist/esm/generatedModels.js} +1 -1
- package/dist/esm/generatedModels.js.map +1 -0
- package/dist/esm/index.d.ts +28 -0
- package/dist/esm/index.d.ts.map +1 -0
- package/dist/esm/index.js +27 -0
- package/dist/esm/index.js.map +1 -0
- package/dist/esm/log.d.ts +5 -0
- package/dist/esm/log.d.ts.map +1 -0
- package/{dist-esm/storage-blob/src → dist/esm}/log.js +1 -1
- package/dist/esm/log.js.map +1 -0
- package/dist/esm/models.d.ts +23 -0
- package/dist/esm/models.d.ts.map +1 -0
- package/dist/esm/models.js +19 -0
- package/dist/esm/models.js.map +1 -0
- package/dist/esm/package.json +3 -0
- package/dist/esm/utils/constants.d.ts +47 -0
- package/dist/esm/utils/constants.d.ts.map +1 -0
- package/dist/esm/utils/constants.js +119 -0
- package/dist/esm/utils/constants.js.map +1 -0
- package/dist/esm/utils/tracing.d.ts +6 -0
- package/dist/esm/utils/tracing.d.ts.map +1 -0
- package/{dist-esm/storage-blob/src → dist/esm}/utils/tracing.js +2 -2
- package/dist/esm/utils/tracing.js.map +1 -0
- package/dist/esm/utils/utils.common.d.ts +198 -0
- package/dist/esm/utils/utils.common.d.ts.map +1 -0
- package/dist/esm/utils/utils.common.js +363 -0
- package/dist/esm/utils/utils.common.js.map +1 -0
- package/dist/react-native/AccountSASPermissions.d.ts +61 -0
- package/dist/react-native/AccountSASPermissions.d.ts.map +1 -0
- package/dist/react-native/AccountSASPermissions.js +128 -0
- package/dist/react-native/AccountSASPermissions.js.map +1 -0
- package/dist/react-native/AccountSASResourceTypes.d.ts +38 -0
- package/dist/react-native/AccountSASResourceTypes.d.ts.map +1 -0
- package/dist/react-native/AccountSASResourceTypes.js +72 -0
- package/dist/react-native/AccountSASResourceTypes.js.map +1 -0
- package/dist/react-native/AccountSASServices.d.ts +40 -0
- package/dist/react-native/AccountSASServices.d.ts.map +1 -0
- package/dist/react-native/AccountSASServices.js +80 -0
- package/dist/react-native/AccountSASServices.js.map +1 -0
- package/dist/react-native/AccountSASSignatureValues.d.ts +74 -0
- package/dist/react-native/AccountSASSignatureValues.d.ts.map +1 -0
- package/dist/react-native/AccountSASSignatureValues.js +72 -0
- package/dist/react-native/AccountSASSignatureValues.js.map +1 -0
- package/dist/react-native/Pipeline.d.ts +136 -0
- package/dist/react-native/Pipeline.d.ts.map +1 -0
- package/dist/react-native/Pipeline.js +261 -0
- package/dist/react-native/Pipeline.js.map +1 -0
- package/dist/react-native/QueueClient.d.ts +667 -0
- package/dist/react-native/QueueClient.d.ts.map +1 -0
- package/dist/react-native/QueueClient.js +622 -0
- package/dist/react-native/QueueClient.js.map +1 -0
- package/dist/react-native/QueueSASPermissions.d.ts +42 -0
- package/dist/react-native/QueueSASPermissions.d.ts.map +1 -0
- package/dist/react-native/QueueSASPermissions.js +82 -0
- package/dist/react-native/QueueSASPermissions.js.map +1 -0
- package/dist/react-native/QueueSASSignatureValues.d.ts +70 -0
- package/dist/react-native/QueueSASSignatureValues.d.ts.map +1 -0
- package/dist/react-native/QueueSASSignatureValues.js +65 -0
- package/dist/react-native/QueueSASSignatureValues.js.map +1 -0
- package/dist/react-native/QueueServiceClient.d.ts +411 -0
- package/dist/react-native/QueueServiceClient.d.ts.map +1 -0
- package/dist/react-native/QueueServiceClient.js +439 -0
- package/dist/react-native/QueueServiceClient.js.map +1 -0
- package/dist/react-native/SASQueryParameters.d.ts +110 -0
- package/dist/react-native/SASQueryParameters.d.ts.map +1 -0
- package/dist/react-native/SASQueryParameters.js +135 -0
- package/dist/react-native/SASQueryParameters.js.map +1 -0
- package/dist/react-native/SasIPRange.d.ts +24 -0
- package/dist/react-native/SasIPRange.d.ts.map +1 -0
- package/dist/react-native/SasIPRange.js +13 -0
- package/dist/react-native/SasIPRange.js.map +1 -0
- package/dist/react-native/StorageClient.d.ts +60 -0
- package/dist/react-native/StorageClient.d.ts.map +1 -0
- package/dist/react-native/StorageClient.js +41 -0
- package/dist/react-native/StorageClient.js.map +1 -0
- package/dist/react-native/StorageContextClient.d.ts +9 -0
- package/dist/react-native/StorageContextClient.d.ts.map +1 -0
- package/dist/react-native/StorageContextClient.js +18 -0
- package/dist/react-native/StorageContextClient.js.map +1 -0
- package/dist/react-native/generated/src/index.d.ts +4 -0
- package/dist/react-native/generated/src/index.d.ts.map +1 -0
- package/dist/react-native/generated/src/index.js +11 -0
- package/dist/react-native/generated/src/index.js.map +1 -0
- package/dist/react-native/generated/src/models/index.d.ts +830 -0
- package/dist/react-native/generated/src/models/index.d.ts.map +1 -0
- package/dist/react-native/generated/src/models/index.js +126 -0
- package/dist/react-native/generated/src/models/index.js.map +1 -0
- package/dist/react-native/generated/src/models/mappers.d.ts +50 -0
- package/dist/react-native/generated/src/models/mappers.d.ts.map +1 -0
- package/dist/react-native/generated/src/models/mappers.js +1718 -0
- package/dist/react-native/generated/src/models/mappers.js.map +1 -0
- package/dist/react-native/generated/src/models/parameters.d.ts +30 -0
- package/dist/react-native/generated/src/models/parameters.d.ts.map +1 -0
- package/dist/react-native/generated/src/models/parameters.js +325 -0
- package/dist/react-native/generated/src/models/parameters.js.map +1 -0
- package/dist/react-native/generated/src/operations/index.d.ts +5 -0
- package/dist/react-native/generated/src/operations/index.d.ts.map +1 -0
- package/dist/react-native/generated/src/operations/index.js +12 -0
- package/dist/react-native/generated/src/operations/index.js.map +1 -0
- package/dist/react-native/generated/src/operations/messageId.d.ts +35 -0
- package/dist/react-native/generated/src/operations/messageId.d.ts.map +1 -0
- package/dist/react-native/generated/src/operations/messageId.js +101 -0
- package/dist/react-native/generated/src/operations/messageId.js.map +1 -0
- package/dist/react-native/generated/src/operations/messages.d.ts +38 -0
- package/dist/react-native/generated/src/operations/messages.d.ts.map +1 -0
- package/dist/react-native/generated/src/operations/messages.js +194 -0
- package/dist/react-native/generated/src/operations/messages.js.map +1 -0
- package/dist/react-native/generated/src/operations/queue.d.ts +46 -0
- package/dist/react-native/generated/src/operations/queue.d.ts.map +1 -0
- package/dist/react-native/generated/src/operations/queue.js +221 -0
- package/dist/react-native/generated/src/operations/queue.js.map +1 -0
- package/dist/react-native/generated/src/operations/service.d.ts +38 -0
- package/dist/react-native/generated/src/operations/service.d.ts.map +1 -0
- package/dist/react-native/generated/src/operations/service.js +170 -0
- package/dist/react-native/generated/src/operations/service.js.map +1 -0
- package/dist/react-native/generated/src/operationsInterfaces/index.d.ts +5 -0
- package/dist/react-native/generated/src/operationsInterfaces/index.d.ts.map +1 -0
- package/dist/react-native/generated/src/operationsInterfaces/index.js +12 -0
- package/dist/react-native/generated/src/operationsInterfaces/index.js.map +1 -0
- package/dist/react-native/generated/src/operationsInterfaces/messageId.d.ts +27 -0
- package/dist/react-native/generated/src/operationsInterfaces/messageId.d.ts.map +1 -0
- package/{dist-esm/storage-blob/src/generated/src/operationsInterfaces/blockBlob.js → dist/react-native/generated/src/operationsInterfaces/messageId.js} +1 -1
- package/dist/react-native/generated/src/operationsInterfaces/messageId.js.map +1 -0
- package/dist/react-native/generated/src/operationsInterfaces/messages.d.ts +30 -0
- package/dist/react-native/generated/src/operationsInterfaces/messages.d.ts.map +1 -0
- package/dist/react-native/generated/src/operationsInterfaces/messages.js +9 -0
- package/dist/react-native/generated/src/operationsInterfaces/messages.js.map +1 -0
- package/dist/react-native/generated/src/operationsInterfaces/queue.d.ts +38 -0
- package/dist/react-native/generated/src/operationsInterfaces/queue.d.ts.map +1 -0
- package/dist/react-native/generated/src/operationsInterfaces/queue.js +9 -0
- package/dist/react-native/generated/src/operationsInterfaces/queue.js.map +1 -0
- package/dist/react-native/generated/src/operationsInterfaces/service.d.ts +30 -0
- package/dist/react-native/generated/src/operationsInterfaces/service.d.ts.map +1 -0
- package/dist/react-native/generated/src/operationsInterfaces/service.js +9 -0
- package/dist/react-native/generated/src/operationsInterfaces/service.js.map +1 -0
- package/dist/react-native/generated/src/storageClient.d.ts +19 -0
- package/dist/react-native/generated/src/storageClient.d.ts.map +1 -0
- package/dist/react-native/generated/src/storageClient.js +47 -0
- package/dist/react-native/generated/src/storageClient.js.map +1 -0
- package/dist/react-native/generatedModels.d.ts +30 -0
- package/dist/react-native/generatedModels.d.ts.map +1 -0
- package/dist/react-native/generatedModels.js +4 -0
- package/dist/react-native/generatedModels.js.map +1 -0
- package/dist/react-native/index.d.ts +28 -0
- package/dist/react-native/index.d.ts.map +1 -0
- package/dist/react-native/index.js +27 -0
- package/dist/react-native/index.js.map +1 -0
- package/dist/react-native/log.d.ts +5 -0
- package/dist/react-native/log.d.ts.map +1 -0
- package/dist/react-native/log.js +8 -0
- package/dist/react-native/log.js.map +1 -0
- package/dist/react-native/models.d.ts +23 -0
- package/dist/react-native/models.d.ts.map +1 -0
- package/dist/react-native/models.js +19 -0
- package/dist/react-native/models.js.map +1 -0
- package/dist/react-native/package.json +3 -0
- package/dist/react-native/utils/constants.d.ts +47 -0
- package/dist/react-native/utils/constants.d.ts.map +1 -0
- package/dist/react-native/utils/constants.js +119 -0
- package/dist/react-native/utils/constants.js.map +1 -0
- package/dist/react-native/utils/tracing.d.ts +6 -0
- package/dist/react-native/utils/tracing.d.ts.map +1 -0
- package/dist/react-native/utils/tracing.js +14 -0
- package/dist/react-native/utils/tracing.js.map +1 -0
- package/dist/react-native/utils/utils.common.d.ts +198 -0
- package/dist/react-native/utils/utils.common.d.ts.map +1 -0
- package/dist/react-native/utils/utils.common.js +363 -0
- package/dist/react-native/utils/utils.common.js.map +1 -0
- package/package.json +71 -69
- package/dist/index.js +0 -6257
- package/dist/index.js.map +0 -1
- package/dist-esm/storage-blob/src/BatchResponse.js.map +0 -1
- package/dist-esm/storage-blob/src/BatchResponseParser.js +0 -137
- package/dist-esm/storage-blob/src/BatchResponseParser.js.map +0 -1
- package/dist-esm/storage-blob/src/BatchUtils.js +0 -15
- package/dist-esm/storage-blob/src/BatchUtils.js.map +0 -1
- package/dist-esm/storage-blob/src/BlobBatch.js +0 -267
- package/dist-esm/storage-blob/src/BlobBatch.js.map +0 -1
- package/dist-esm/storage-blob/src/BlobBatchClient.js +0 -140
- package/dist-esm/storage-blob/src/BlobBatchClient.js.map +0 -1
- package/dist-esm/storage-blob/src/BlobDownloadResponse.js +0 -463
- package/dist-esm/storage-blob/src/BlobDownloadResponse.js.map +0 -1
- package/dist-esm/storage-blob/src/BlobLeaseClient.js +0 -192
- package/dist-esm/storage-blob/src/BlobLeaseClient.js.map +0 -1
- package/dist-esm/storage-blob/src/BlobQueryResponse.js +0 -367
- package/dist-esm/storage-blob/src/BlobQueryResponse.js.map +0 -1
- package/dist-esm/storage-blob/src/BlobServiceClient.js +0 -716
- package/dist-esm/storage-blob/src/BlobServiceClient.js.map +0 -1
- package/dist-esm/storage-blob/src/Clients.js +0 -2594
- package/dist-esm/storage-blob/src/Clients.js.map +0 -1
- package/dist-esm/storage-blob/src/ContainerClient.js +0 -1209
- package/dist-esm/storage-blob/src/ContainerClient.js.map +0 -1
- package/dist-esm/storage-blob/src/PageBlobRangeResponse.js +0 -24
- package/dist-esm/storage-blob/src/PageBlobRangeResponse.js.map +0 -1
- package/dist-esm/storage-blob/src/Pipeline.js.map +0 -1
- package/dist-esm/storage-blob/src/Range.js +0 -21
- package/dist-esm/storage-blob/src/Range.js.map +0 -1
- package/dist-esm/storage-blob/src/StorageBrowserPolicyFactory.js +0 -19
- package/dist-esm/storage-blob/src/StorageBrowserPolicyFactory.js.map +0 -1
- package/dist-esm/storage-blob/src/StorageClient.js +0 -29
- package/dist-esm/storage-blob/src/StorageClient.js.map +0 -1
- package/dist-esm/storage-blob/src/StorageContextClient.js.map +0 -1
- package/dist-esm/storage-blob/src/StorageRetryPolicyFactory.js +0 -26
- package/dist-esm/storage-blob/src/StorageRetryPolicyFactory.js.map +0 -1
- package/dist-esm/storage-blob/src/credentials/AnonymousCredential.js +0 -22
- package/dist-esm/storage-blob/src/credentials/AnonymousCredential.js.map +0 -1
- package/dist-esm/storage-blob/src/credentials/Credential.js +0 -18
- package/dist-esm/storage-blob/src/credentials/Credential.js.map +0 -1
- package/dist-esm/storage-blob/src/credentials/StorageSharedKeyCredential.browser.js +0 -5
- package/dist-esm/storage-blob/src/credentials/StorageSharedKeyCredential.browser.js.map +0 -1
- package/dist-esm/storage-blob/src/credentials/StorageSharedKeyCredential.js +0 -40
- package/dist-esm/storage-blob/src/credentials/StorageSharedKeyCredential.js.map +0 -1
- package/dist-esm/storage-blob/src/credentials/UserDelegationKeyCredential.browser.js +0 -5
- package/dist-esm/storage-blob/src/credentials/UserDelegationKeyCredential.browser.js.map +0 -1
- package/dist-esm/storage-blob/src/credentials/UserDelegationKeyCredential.js +0 -31
- package/dist-esm/storage-blob/src/credentials/UserDelegationKeyCredential.js.map +0 -1
- package/dist-esm/storage-blob/src/generated/src/index.js.map +0 -1
- package/dist-esm/storage-blob/src/generated/src/models/index.js +0 -258
- package/dist-esm/storage-blob/src/generated/src/models/index.js.map +0 -1
- package/dist-esm/storage-blob/src/generated/src/models/mappers.js +0 -8225
- package/dist-esm/storage-blob/src/generated/src/models/mappers.js.map +0 -1
- package/dist-esm/storage-blob/src/generated/src/models/parameters.js +0 -1610
- package/dist-esm/storage-blob/src/generated/src/models/parameters.js.map +0 -1
- package/dist-esm/storage-blob/src/generated/src/operations/appendBlob.js +0 -221
- package/dist-esm/storage-blob/src/generated/src/operations/appendBlob.js.map +0 -1
- package/dist-esm/storage-blob/src/generated/src/operations/blob.js +0 -1020
- package/dist-esm/storage-blob/src/generated/src/operations/blob.js.map +0 -1
- package/dist-esm/storage-blob/src/generated/src/operations/blockBlob.js +0 -365
- package/dist-esm/storage-blob/src/generated/src/operations/blockBlob.js.map +0 -1
- package/dist-esm/storage-blob/src/generated/src/operations/container.js +0 -713
- package/dist-esm/storage-blob/src/generated/src/operations/container.js.map +0 -1
- package/dist-esm/storage-blob/src/generated/src/operations/index.js +0 -14
- package/dist-esm/storage-blob/src/generated/src/operations/index.js.map +0 -1
- package/dist-esm/storage-blob/src/generated/src/operations/pageBlob.js +0 -456
- package/dist-esm/storage-blob/src/generated/src/operations/pageBlob.js.map +0 -1
- package/dist-esm/storage-blob/src/generated/src/operations/service.js +0 -323
- package/dist-esm/storage-blob/src/generated/src/operations/service.js.map +0 -1
- package/dist-esm/storage-blob/src/generated/src/operationsInterfaces/appendBlob.js.map +0 -1
- package/dist-esm/storage-blob/src/generated/src/operationsInterfaces/blob.js.map +0 -1
- package/dist-esm/storage-blob/src/generated/src/operationsInterfaces/blockBlob.js.map +0 -1
- package/dist-esm/storage-blob/src/generated/src/operationsInterfaces/container.js.map +0 -1
- package/dist-esm/storage-blob/src/generated/src/operationsInterfaces/index.js +0 -14
- package/dist-esm/storage-blob/src/generated/src/operationsInterfaces/index.js.map +0 -1
- package/dist-esm/storage-blob/src/generated/src/operationsInterfaces/pageBlob.js.map +0 -1
- package/dist-esm/storage-blob/src/generated/src/operationsInterfaces/service.js.map +0 -1
- package/dist-esm/storage-blob/src/generated/src/storageClient.js.map +0 -1
- package/dist-esm/storage-blob/src/generatedModels.js +0 -8
- package/dist-esm/storage-blob/src/generatedModels.js.map +0 -1
- package/dist-esm/storage-blob/src/index.js +0 -33
- package/dist-esm/storage-blob/src/index.js.map +0 -1
- package/dist-esm/storage-blob/src/log.js.map +0 -1
- package/dist-esm/storage-blob/src/models.js +0 -115
- package/dist-esm/storage-blob/src/models.js.map +0 -1
- package/dist-esm/storage-blob/src/policies/AnonymousCredentialPolicy.js +0 -20
- package/dist-esm/storage-blob/src/policies/AnonymousCredentialPolicy.js.map +0 -1
- package/dist-esm/storage-blob/src/policies/CredentialPolicy.js +0 -29
- package/dist-esm/storage-blob/src/policies/CredentialPolicy.js.map +0 -1
- package/dist-esm/storage-blob/src/policies/RequestPolicy.js +0 -40
- package/dist-esm/storage-blob/src/policies/RequestPolicy.js.map +0 -1
- package/dist-esm/storage-blob/src/policies/StorageBrowserPolicy.js +0 -47
- package/dist-esm/storage-blob/src/policies/StorageBrowserPolicy.js.map +0 -1
- package/dist-esm/storage-blob/src/policies/StorageBrowserPolicyV2.js +0 -31
- package/dist-esm/storage-blob/src/policies/StorageBrowserPolicyV2.js.map +0 -1
- package/dist-esm/storage-blob/src/policies/StorageCorrectContentLengthPolicy.browser.js +0 -18
- package/dist-esm/storage-blob/src/policies/StorageCorrectContentLengthPolicy.browser.js.map +0 -1
- package/dist-esm/storage-blob/src/policies/StorageCorrectContentLengthPolicy.js +0 -27
- package/dist-esm/storage-blob/src/policies/StorageCorrectContentLengthPolicy.js.map +0 -1
- package/dist-esm/storage-blob/src/policies/StorageRetryPolicy.js +0 -229
- package/dist-esm/storage-blob/src/policies/StorageRetryPolicy.js.map +0 -1
- package/dist-esm/storage-blob/src/policies/StorageRetryPolicyV2.js +0 -180
- package/dist-esm/storage-blob/src/policies/StorageRetryPolicyV2.js.map +0 -1
- package/dist-esm/storage-blob/src/policies/StorageSharedKeyCredentialPolicy.js +0 -141
- package/dist-esm/storage-blob/src/policies/StorageSharedKeyCredentialPolicy.js.map +0 -1
- package/dist-esm/storage-blob/src/policies/StorageSharedKeyCredentialPolicyV2.browser.js +0 -18
- package/dist-esm/storage-blob/src/policies/StorageSharedKeyCredentialPolicyV2.browser.js.map +0 -1
- package/dist-esm/storage-blob/src/policies/StorageSharedKeyCredentialPolicyV2.js +0 -132
- package/dist-esm/storage-blob/src/policies/StorageSharedKeyCredentialPolicyV2.js.map +0 -1
- package/dist-esm/storage-blob/src/pollers/BlobStartCopyFromUrlPoller.js +0 -130
- package/dist-esm/storage-blob/src/pollers/BlobStartCopyFromUrlPoller.js.map +0 -1
- package/dist-esm/storage-blob/src/sas/AccountSASPermissions.js.map +0 -1
- package/dist-esm/storage-blob/src/sas/AccountSASResourceTypes.js.map +0 -1
- package/dist-esm/storage-blob/src/sas/AccountSASServices.js.map +0 -1
- package/dist-esm/storage-blob/src/sas/AccountSASSignatureValues.js.map +0 -1
- package/dist-esm/storage-blob/src/sas/BlobSASPermissions.js +0 -195
- package/dist-esm/storage-blob/src/sas/BlobSASPermissions.js.map +0 -1
- package/dist-esm/storage-blob/src/sas/BlobSASSignatureValues.js +0 -576
- package/dist-esm/storage-blob/src/sas/BlobSASSignatureValues.js.map +0 -1
- package/dist-esm/storage-blob/src/sas/ContainerSASPermissions.js +0 -221
- package/dist-esm/storage-blob/src/sas/ContainerSASPermissions.js.map +0 -1
- package/dist-esm/storage-blob/src/sas/SASQueryParameters.js +0 -234
- package/dist-esm/storage-blob/src/sas/SASQueryParameters.js.map +0 -1
- package/dist-esm/storage-blob/src/sas/SasIPRange.js.map +0 -1
- package/dist-esm/storage-blob/src/utils/Batch.js +0 -122
- package/dist-esm/storage-blob/src/utils/Batch.js.map +0 -1
- package/dist-esm/storage-blob/src/utils/BlobQuickQueryStream.js +0 -111
- package/dist-esm/storage-blob/src/utils/BlobQuickQueryStream.js.map +0 -1
- package/dist-esm/storage-blob/src/utils/Mutex.js +0 -65
- package/dist-esm/storage-blob/src/utils/Mutex.js.map +0 -1
- package/dist-esm/storage-blob/src/utils/RetriableReadableStream.js +0 -119
- package/dist-esm/storage-blob/src/utils/RetriableReadableStream.js.map +0 -1
- package/dist-esm/storage-blob/src/utils/SharedKeyComparator.js +0 -73
- package/dist-esm/storage-blob/src/utils/SharedKeyComparator.js.map +0 -1
- package/dist-esm/storage-blob/src/utils/cache.js +0 -11
- package/dist-esm/storage-blob/src/utils/cache.js.map +0 -1
- package/dist-esm/storage-blob/src/utils/constants.js +0 -226
- package/dist-esm/storage-blob/src/utils/constants.js.map +0 -1
- package/dist-esm/storage-blob/src/utils/tracing.js.map +0 -1
- package/dist-esm/storage-blob/src/utils/utils.common.js +0 -756
- package/dist-esm/storage-blob/src/utils/utils.common.js.map +0 -1
- package/dist-esm/storage-blob/src/utils/utils.node.js +0 -132
- package/dist-esm/storage-blob/src/utils/utils.node.js.map +0 -1
- package/dist-esm/storage-queue/src/AccountSASPermissions.js.map +0 -1
- package/dist-esm/storage-queue/src/AccountSASResourceTypes.js.map +0 -1
- package/dist-esm/storage-queue/src/AccountSASServices.js.map +0 -1
- package/dist-esm/storage-queue/src/AccountSASSignatureValues.js.map +0 -1
- package/dist-esm/storage-queue/src/Pipeline.js.map +0 -1
- package/dist-esm/storage-queue/src/QueueClient.js.map +0 -1
- package/dist-esm/storage-queue/src/QueueSASPermissions.js.map +0 -1
- package/dist-esm/storage-queue/src/QueueSASSignatureValues.js.map +0 -1
- package/dist-esm/storage-queue/src/QueueServiceClient.js.map +0 -1
- package/dist-esm/storage-queue/src/SASQueryParameters.js.map +0 -1
- package/dist-esm/storage-queue/src/SasIPRange.js.map +0 -1
- package/dist-esm/storage-queue/src/StorageClient.js.map +0 -1
- package/dist-esm/storage-queue/src/StorageContextClient.js.map +0 -1
- package/dist-esm/storage-queue/src/generated/src/index.js.map +0 -1
- package/dist-esm/storage-queue/src/generated/src/models/index.js.map +0 -1
- package/dist-esm/storage-queue/src/generated/src/models/mappers.js.map +0 -1
- package/dist-esm/storage-queue/src/generated/src/operations/index.js.map +0 -1
- package/dist-esm/storage-queue/src/generated/src/operations/messageId.js.map +0 -1
- package/dist-esm/storage-queue/src/generated/src/operations/messages.js.map +0 -1
- package/dist-esm/storage-queue/src/generated/src/operations/queue.js.map +0 -1
- package/dist-esm/storage-queue/src/generated/src/operations/service.js.map +0 -1
- package/dist-esm/storage-queue/src/generated/src/operationsInterfaces/index.js.map +0 -1
- package/dist-esm/storage-queue/src/generated/src/operationsInterfaces/messageId.js.map +0 -1
- package/dist-esm/storage-queue/src/generated/src/operationsInterfaces/messages.js.map +0 -1
- package/dist-esm/storage-queue/src/generated/src/operationsInterfaces/queue.js.map +0 -1
- package/dist-esm/storage-queue/src/generated/src/operationsInterfaces/service.js.map +0 -1
- package/dist-esm/storage-queue/src/generated/src/storageClient.js.map +0 -1
- package/dist-esm/storage-queue/src/generatedModels.js.map +0 -1
- package/dist-esm/storage-queue/src/index.browser.js +0 -18
- package/dist-esm/storage-queue/src/index.browser.js.map +0 -1
- package/dist-esm/storage-queue/src/index.js +0 -27
- package/dist-esm/storage-queue/src/index.js.map +0 -1
- package/dist-esm/storage-queue/src/log.js.map +0 -1
- package/dist-esm/storage-queue/src/models.js.map +0 -1
- package/dist-esm/storage-queue/src/utils/constants.js.map +0 -1
- package/dist-esm/storage-queue/src/utils/tracing.js.map +0 -1
- package/dist-esm/storage-queue/src/utils/utils.common.js.map +0 -1
- package/types/latest/storage-queue.d.ts +0 -2886
- /package/{dist-esm/storage-queue/src → dist/browser}/AccountSASPermissions.js +0 -0
- /package/{dist-esm/storage-blob/src/sas → dist/browser}/AccountSASResourceTypes.js +0 -0
- /package/{dist-esm/storage-blob/src/sas → dist/browser}/AccountSASServices.js +0 -0
- /package/{dist-esm/storage-queue/src → dist/browser}/QueueSASPermissions.js +0 -0
- /package/{dist-esm/storage-blob/src/sas → dist/browser}/SasIPRange.js +0 -0
- /package/{dist-esm/storage-queue/src → dist/browser}/generated/src/models/index.js +0 -0
- /package/{dist-esm/storage-queue/src → dist/browser}/generated/src/models/mappers.js +0 -0
- /package/{dist-esm/storage-queue/src → dist/browser}/generated/src/operationsInterfaces/messageId.js +0 -0
- /package/{dist-esm/storage-queue/src → dist/browser}/generated/src/operationsInterfaces/messages.js +0 -0
- /package/{dist-esm/storage-queue/src → dist/browser}/generated/src/operationsInterfaces/queue.js +0 -0
- /package/{dist-esm/storage-blob/src → dist/browser}/generated/src/operationsInterfaces/service.js +0 -0
- /package/{dist-esm/storage-queue/src → dist/browser}/generatedModels.js +0 -0
- /package/{dist-esm/storage-queue/src → dist/browser}/log.js +0 -0
- /package/{dist-esm/storage-queue/src → dist/browser}/models.js +0 -0
- /package/{dist-esm/storage-queue/src → dist/esm}/AccountSASResourceTypes.js +0 -0
- /package/{dist-esm/storage-queue/src → dist/esm}/AccountSASServices.js +0 -0
- /package/{dist-esm/storage-queue/src → dist/esm}/SasIPRange.js +0 -0
- /package/{dist-esm/storage-queue/src → dist/esm}/generated/src/operationsInterfaces/service.js +0 -0
|
@@ -1,2886 +0,0 @@
|
|
|
1
|
-
import type { AbortSignalLike } from '@azure/abort-controller';
|
|
2
|
-
import { AzureLogger } from '@azure/logger';
|
|
3
|
-
import * as coreClient from '@azure/core-client';
|
|
4
|
-
import * as coreHttpCompat from '@azure/core-http-compat';
|
|
5
|
-
import { HttpHeadersLike as HttpHeaders } from '@azure/core-http-compat';
|
|
6
|
-
import { CompatResponse as HttpOperationResponse } from '@azure/core-http-compat';
|
|
7
|
-
import type { HttpPipelineLogLevel } from '@azure/core-http-compat';
|
|
8
|
-
import { RequestBodyType as HttpRequestBody } from '@azure/core-rest-pipeline';
|
|
9
|
-
import type { KeepAliveOptions } from '@azure/core-http-compat';
|
|
10
|
-
import type { OperationTracingOptions } from '@azure/core-tracing';
|
|
11
|
-
import type { PagedAsyncIterableIterator } from '@azure/core-paging';
|
|
12
|
-
import type { ProxySettings } from '@azure/core-rest-pipeline';
|
|
13
|
-
import { RequestPolicy } from '@azure/core-http-compat';
|
|
14
|
-
import { RequestPolicyFactory } from '@azure/core-http-compat';
|
|
15
|
-
import { RequestPolicyOptionsLike as RequestPolicyOptions } from '@azure/core-http-compat';
|
|
16
|
-
import { RestError } from '@azure/core-rest-pipeline';
|
|
17
|
-
import type { TokenCredential } from '@azure/core-auth';
|
|
18
|
-
import type { UserAgentPolicyOptions } from '@azure/core-rest-pipeline';
|
|
19
|
-
import { WebResourceLike as WebResource } from '@azure/core-http-compat';
|
|
20
|
-
|
|
21
|
-
/** An Access policy */
|
|
22
|
-
export declare interface AccessPolicy {
|
|
23
|
-
/** the date-time the policy is active */
|
|
24
|
-
startsOn?: string;
|
|
25
|
-
/** the date-time the policy expires */
|
|
26
|
-
expiresOn?: string;
|
|
27
|
-
/** the permissions for the acl policy */
|
|
28
|
-
permissions?: string;
|
|
29
|
-
}
|
|
30
|
-
|
|
31
|
-
/**
|
|
32
|
-
* ONLY AVAILABLE IN NODE.JS RUNTIME.
|
|
33
|
-
*
|
|
34
|
-
* This is a helper class to construct a string representing the permissions granted by an AccountSAS. Setting a value
|
|
35
|
-
* to true means that any SAS which uses these permissions will grant permissions for that operation. Once all the
|
|
36
|
-
* values are set, this should be serialized with toString and set as the permissions field on an
|
|
37
|
-
* {@link AccountSASSignatureValues} object. It is possible to construct the permissions string without this class, but
|
|
38
|
-
* the order of the permissions is particular and this class guarantees correctness.
|
|
39
|
-
*/
|
|
40
|
-
export declare class AccountSASPermissions {
|
|
41
|
-
/**
|
|
42
|
-
* Parse initializes the AccountSASPermissions fields from a string.
|
|
43
|
-
*
|
|
44
|
-
* @param permissions -
|
|
45
|
-
*/
|
|
46
|
-
static parse(permissions: string): AccountSASPermissions;
|
|
47
|
-
/**
|
|
48
|
-
* Permission to read resources granted.
|
|
49
|
-
*/
|
|
50
|
-
read: boolean;
|
|
51
|
-
/**
|
|
52
|
-
* Permission to write resources granted.
|
|
53
|
-
*/
|
|
54
|
-
write: boolean;
|
|
55
|
-
/**
|
|
56
|
-
* Permission to delete queues and messages granted.
|
|
57
|
-
*/
|
|
58
|
-
delete: boolean;
|
|
59
|
-
/**
|
|
60
|
-
* Permission to list queues granted.
|
|
61
|
-
*/
|
|
62
|
-
list: boolean;
|
|
63
|
-
/**
|
|
64
|
-
* Permission to add messages, table entities, and append to blobs granted.
|
|
65
|
-
*/
|
|
66
|
-
add: boolean;
|
|
67
|
-
/**
|
|
68
|
-
* Permission to create queues, blobs and files granted.
|
|
69
|
-
*/
|
|
70
|
-
create: boolean;
|
|
71
|
-
/**
|
|
72
|
-
* Permissions to update messages and table entities granted.
|
|
73
|
-
*/
|
|
74
|
-
update: boolean;
|
|
75
|
-
/**
|
|
76
|
-
* Permission to get and delete messages granted.
|
|
77
|
-
*/
|
|
78
|
-
process: boolean;
|
|
79
|
-
/**
|
|
80
|
-
* Produces the SAS permissions string for an Azure Storage account.
|
|
81
|
-
* Call this method to set AccountSASSignatureValues Permissions field.
|
|
82
|
-
*
|
|
83
|
-
* Using this method will guarantee the resource types are in
|
|
84
|
-
* an order accepted by the service.
|
|
85
|
-
*
|
|
86
|
-
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas
|
|
87
|
-
*
|
|
88
|
-
*/
|
|
89
|
-
toString(): string;
|
|
90
|
-
}
|
|
91
|
-
|
|
92
|
-
/**
|
|
93
|
-
* ONLY AVAILABLE IN NODE.JS RUNTIME.
|
|
94
|
-
*
|
|
95
|
-
* This is a helper class to construct a string representing the resources accessible by an AccountSAS. Setting a value
|
|
96
|
-
* to true means that any SAS which uses these permissions will grant access to that resource type. Once all the
|
|
97
|
-
* values are set, this should be serialized with toString and set as the resources field on an
|
|
98
|
-
* {@link AccountSASSignatureValues} object. It is possible to construct the resources string without this class, but
|
|
99
|
-
* the order of the resources is particular and this class guarantees correctness.
|
|
100
|
-
*/
|
|
101
|
-
export declare class AccountSASResourceTypes {
|
|
102
|
-
/**
|
|
103
|
-
* Creates an {@link AccountSASResourceTypes} from the specified resource types string. This method will throw an
|
|
104
|
-
* Error if it encounters a character that does not correspond to a valid resource type.
|
|
105
|
-
*
|
|
106
|
-
* @param resourceTypes -
|
|
107
|
-
*/
|
|
108
|
-
static parse(resourceTypes: string): AccountSASResourceTypes;
|
|
109
|
-
/**
|
|
110
|
-
* Permission to access service level APIs granted.
|
|
111
|
-
*/
|
|
112
|
-
service: boolean;
|
|
113
|
-
/**
|
|
114
|
-
* Permission to access container level APIs (Blob Containers, Tables, Queues, File Shares) granted.
|
|
115
|
-
*/
|
|
116
|
-
container: boolean;
|
|
117
|
-
/**
|
|
118
|
-
* Permission to access object level APIs (Blobs, Table Entities, Queue Messages, Files) granted.
|
|
119
|
-
*/
|
|
120
|
-
object: boolean;
|
|
121
|
-
/**
|
|
122
|
-
* Converts the given resource types to a string.
|
|
123
|
-
*
|
|
124
|
-
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas
|
|
125
|
-
*
|
|
126
|
-
*/
|
|
127
|
-
toString(): string;
|
|
128
|
-
}
|
|
129
|
-
|
|
130
|
-
/**
|
|
131
|
-
* ONLY AVAILABLE IN NODE.JS RUNTIME.
|
|
132
|
-
*
|
|
133
|
-
* This is a helper class to construct a string representing the services accessible by an AccountSAS. Setting a value
|
|
134
|
-
* to true means that any SAS which uses these permissions will grant access to that service. Once all the
|
|
135
|
-
* values are set, this should be serialized with toString and set as the services field on an
|
|
136
|
-
* {@link AccountSASSignatureValues} object. It is possible to construct the services string without this class, but
|
|
137
|
-
* the order of the services is particular and this class guarantees correctness.
|
|
138
|
-
*/
|
|
139
|
-
export declare class AccountSASServices {
|
|
140
|
-
/**
|
|
141
|
-
* Creates an {@link AccountSASServices} from the specified services string. This method will throw an
|
|
142
|
-
* Error if it encounters a character that does not correspond to a valid service.
|
|
143
|
-
*
|
|
144
|
-
* @param services -
|
|
145
|
-
*/
|
|
146
|
-
static parse(services: string): AccountSASServices;
|
|
147
|
-
/**
|
|
148
|
-
* Permission to access blob resources granted.
|
|
149
|
-
*/
|
|
150
|
-
blob: boolean;
|
|
151
|
-
/**
|
|
152
|
-
* Permission to access file resources granted.
|
|
153
|
-
*/
|
|
154
|
-
file: boolean;
|
|
155
|
-
/**
|
|
156
|
-
* Permission to access queue resources granted.
|
|
157
|
-
*/
|
|
158
|
-
queue: boolean;
|
|
159
|
-
/**
|
|
160
|
-
* Permission to access table resources granted.
|
|
161
|
-
*/
|
|
162
|
-
table: boolean;
|
|
163
|
-
/**
|
|
164
|
-
* Converts the given services to a string.
|
|
165
|
-
*
|
|
166
|
-
*/
|
|
167
|
-
toString(): string;
|
|
168
|
-
}
|
|
169
|
-
|
|
170
|
-
/**
|
|
171
|
-
* ONLY AVAILABLE IN NODE.JS RUNTIME.
|
|
172
|
-
*
|
|
173
|
-
* AccountSASSignatureValues is used to generate a Shared Access Signature (SAS) for an Azure Storage account. Once
|
|
174
|
-
* all the values here are set appropriately, call generateSASQueryParameters() to obtain a representation of the SAS
|
|
175
|
-
* which can actually be applied to queue urls. Note: that both this class and {@link SASQueryParameters} exist because
|
|
176
|
-
* the former is mutable and a logical representation while the latter is immutable and used to generate actual REST
|
|
177
|
-
* requests.
|
|
178
|
-
*
|
|
179
|
-
* @see https://learn.microsoft.com/en-us/azure/storage/common/storage-dotnet-shared-access-signature-part-1
|
|
180
|
-
* for more conceptual information on SAS
|
|
181
|
-
*
|
|
182
|
-
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas
|
|
183
|
-
* for descriptions of the parameters, including which are required
|
|
184
|
-
*/
|
|
185
|
-
export declare interface AccountSASSignatureValues {
|
|
186
|
-
/**
|
|
187
|
-
* If not provided, this defaults to the service version targeted by this version of the library.
|
|
188
|
-
*/
|
|
189
|
-
version?: string;
|
|
190
|
-
/**
|
|
191
|
-
* Optional. SAS protocols allowed.
|
|
192
|
-
*/
|
|
193
|
-
protocol?: SASProtocol;
|
|
194
|
-
/**
|
|
195
|
-
* Optional. When the SAS will take effect.
|
|
196
|
-
*/
|
|
197
|
-
startsOn?: Date;
|
|
198
|
-
/**
|
|
199
|
-
* The time after which the SAS will no longer work.
|
|
200
|
-
*/
|
|
201
|
-
expiresOn: Date;
|
|
202
|
-
/**
|
|
203
|
-
* Specifies which operations the SAS user may perform. Please refer to {@link AccountSASPermissions} for help
|
|
204
|
-
* constructing the permissions string.
|
|
205
|
-
*/
|
|
206
|
-
permissions: AccountSASPermissions;
|
|
207
|
-
/**
|
|
208
|
-
* Optional. IP range allowed.
|
|
209
|
-
*/
|
|
210
|
-
ipRange?: SasIPRange;
|
|
211
|
-
/**
|
|
212
|
-
* The values that indicate the services accessible with this SAS. Please refer to {@link AccountSASServices} to
|
|
213
|
-
* construct this value.
|
|
214
|
-
*/
|
|
215
|
-
services: string;
|
|
216
|
-
/**
|
|
217
|
-
* The values that indicate the resource types accessible with this SAS. Please refer
|
|
218
|
-
* to {@link AccountSASResourceTypes} to construct this value.
|
|
219
|
-
*/
|
|
220
|
-
resourceTypes: string;
|
|
221
|
-
}
|
|
222
|
-
|
|
223
|
-
/**
|
|
224
|
-
* AnonymousCredential provides a credentialPolicyCreator member used to create
|
|
225
|
-
* AnonymousCredentialPolicy objects. AnonymousCredentialPolicy is used with
|
|
226
|
-
* HTTP(S) requests that read public resources or for use with Shared Access
|
|
227
|
-
* Signatures (SAS).
|
|
228
|
-
*/
|
|
229
|
-
export declare class AnonymousCredential extends Credential_2 {
|
|
230
|
-
/**
|
|
231
|
-
* Creates an {@link AnonymousCredentialPolicy} object.
|
|
232
|
-
*
|
|
233
|
-
* @param nextPolicy -
|
|
234
|
-
* @param options -
|
|
235
|
-
*/
|
|
236
|
-
create(nextPolicy: RequestPolicy, options: RequestPolicyOptions): AnonymousCredentialPolicy;
|
|
237
|
-
}
|
|
238
|
-
|
|
239
|
-
/**
|
|
240
|
-
* AnonymousCredentialPolicy is used with HTTP(S) requests that read public resources
|
|
241
|
-
* or for use with Shared Access Signatures (SAS).
|
|
242
|
-
*/
|
|
243
|
-
export declare class AnonymousCredentialPolicy extends CredentialPolicy {
|
|
244
|
-
/**
|
|
245
|
-
* Creates an instance of AnonymousCredentialPolicy.
|
|
246
|
-
* @param nextPolicy -
|
|
247
|
-
* @param options -
|
|
248
|
-
*/
|
|
249
|
-
constructor(nextPolicy: RequestPolicy, options: RequestPolicyOptions);
|
|
250
|
-
}
|
|
251
|
-
|
|
252
|
-
/**
|
|
253
|
-
* The base class from which all request policies derive.
|
|
254
|
-
*/
|
|
255
|
-
export declare abstract class BaseRequestPolicy implements RequestPolicy {
|
|
256
|
-
/**
|
|
257
|
-
* The next policy in the pipeline. Each policy is responsible for executing the next one if the request is to continue through the pipeline.
|
|
258
|
-
*/
|
|
259
|
-
readonly _nextPolicy: RequestPolicy;
|
|
260
|
-
/**
|
|
261
|
-
* The options that can be passed to a given request policy.
|
|
262
|
-
*/
|
|
263
|
-
readonly _options: RequestPolicyOptions;
|
|
264
|
-
/**
|
|
265
|
-
* The main method to implement that manipulates a request/response.
|
|
266
|
-
*/
|
|
267
|
-
protected constructor(
|
|
268
|
-
/**
|
|
269
|
-
* The next policy in the pipeline. Each policy is responsible for executing the next one if the request is to continue through the pipeline.
|
|
270
|
-
*/
|
|
271
|
-
_nextPolicy: RequestPolicy,
|
|
272
|
-
/**
|
|
273
|
-
* The options that can be passed to a given request policy.
|
|
274
|
-
*/
|
|
275
|
-
_options: RequestPolicyOptions);
|
|
276
|
-
/**
|
|
277
|
-
* Sends a network request based on the given web resource.
|
|
278
|
-
* @param webResource - A {@link WebResourceLike} that describes a HTTP request to be made.
|
|
279
|
-
*/
|
|
280
|
-
abstract sendRequest(webResource: WebResource): Promise<HttpOperationResponse>;
|
|
281
|
-
/**
|
|
282
|
-
* Get whether or not a log with the provided log level should be logged.
|
|
283
|
-
* @param logLevel - The log level of the log that will be logged.
|
|
284
|
-
* @returns Whether or not a log with the provided log level should be logged.
|
|
285
|
-
*/
|
|
286
|
-
shouldLog(logLevel: HttpPipelineLogLevel): boolean;
|
|
287
|
-
/**
|
|
288
|
-
* Attempt to log the provided message to the provided logger. If no logger was provided or if
|
|
289
|
-
* the log level does not meat the logger's threshold, then nothing will be logged.
|
|
290
|
-
* @param logLevel - The log level of this log.
|
|
291
|
-
* @param message - The message of this log.
|
|
292
|
-
*/
|
|
293
|
-
log(logLevel: HttpPipelineLogLevel, message: string): void;
|
|
294
|
-
}
|
|
295
|
-
|
|
296
|
-
/**
|
|
297
|
-
* An interface for options common to every remote operation.
|
|
298
|
-
*/
|
|
299
|
-
export declare interface CommonOptions {
|
|
300
|
-
/**
|
|
301
|
-
* Options to configure spans created when tracing is enabled.
|
|
302
|
-
*/
|
|
303
|
-
tracingOptions?: OperationTracingOptions;
|
|
304
|
-
}
|
|
305
|
-
|
|
306
|
-
/** CORS is an HTTP feature that enables a web application running under one domain to access resources in another domain. Web browsers implement a security restriction known as same-origin policy that prevents a web page from calling APIs in a different domain; CORS provides a secure way to allow one domain (the origin domain) to call APIs in another domain */
|
|
307
|
-
export declare interface CorsRule {
|
|
308
|
-
/** The origin domains that are permitted to make a request against the storage service via CORS. The origin domain is the domain from which the request originates. Note that the origin must be an exact case-sensitive match with the origin that the user age sends to the service. You can also use the wildcard character '*' to allow all origin domains to make requests via CORS. */
|
|
309
|
-
allowedOrigins: string;
|
|
310
|
-
/** The methods (HTTP request verbs) that the origin domain may use for a CORS request. (comma separated) */
|
|
311
|
-
allowedMethods: string;
|
|
312
|
-
/** the request headers that the origin domain may specify on the CORS request. */
|
|
313
|
-
allowedHeaders: string;
|
|
314
|
-
/** The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer */
|
|
315
|
-
exposedHeaders: string;
|
|
316
|
-
/** The maximum amount time that a browser should cache the preflight OPTIONS request. */
|
|
317
|
-
maxAgeInSeconds: number;
|
|
318
|
-
}
|
|
319
|
-
|
|
320
|
-
/**
|
|
321
|
-
* Credential is an abstract class for Azure Storage HTTP requests signing. This
|
|
322
|
-
* class will host an credentialPolicyCreator factory which generates CredentialPolicy.
|
|
323
|
-
*/
|
|
324
|
-
declare abstract class Credential_2 implements RequestPolicyFactory {
|
|
325
|
-
/**
|
|
326
|
-
* Creates a RequestPolicy object.
|
|
327
|
-
*
|
|
328
|
-
* @param _nextPolicy -
|
|
329
|
-
* @param _options -
|
|
330
|
-
*/
|
|
331
|
-
create(_nextPolicy: RequestPolicy, _options: RequestPolicyOptions): RequestPolicy;
|
|
332
|
-
}
|
|
333
|
-
export { Credential_2 as Credential }
|
|
334
|
-
|
|
335
|
-
/**
|
|
336
|
-
* Credential policy used to sign HTTP(S) requests before sending. This is an
|
|
337
|
-
* abstract class.
|
|
338
|
-
*/
|
|
339
|
-
export declare abstract class CredentialPolicy extends BaseRequestPolicy {
|
|
340
|
-
/**
|
|
341
|
-
* Sends out request.
|
|
342
|
-
*
|
|
343
|
-
* @param request -
|
|
344
|
-
*/
|
|
345
|
-
sendRequest(request: WebResource): Promise<HttpOperationResponse>;
|
|
346
|
-
/**
|
|
347
|
-
* Child classes must implement this method with request signing. This method
|
|
348
|
-
* will be executed in {@link sendRequest}.
|
|
349
|
-
*
|
|
350
|
-
* @param request -
|
|
351
|
-
*/
|
|
352
|
-
protected signRequest(request: WebResource): WebResource;
|
|
353
|
-
}
|
|
354
|
-
|
|
355
|
-
/**
|
|
356
|
-
* A factory function that creates a new CredentialPolicy that uses the provided nextPolicy.
|
|
357
|
-
*/
|
|
358
|
-
export declare type CredentialPolicyCreator = (nextPolicy: RequestPolicy, options: RequestPolicyOptions) => CredentialPolicy;
|
|
359
|
-
|
|
360
|
-
/** The object returned in the QueueMessageList array when calling Get Messages on a Queue. */
|
|
361
|
-
export declare interface DequeuedMessageItem {
|
|
362
|
-
/** The Id of the Message. */
|
|
363
|
-
messageId: string;
|
|
364
|
-
/** The time the Message was inserted into the Queue. */
|
|
365
|
-
insertedOn: Date;
|
|
366
|
-
/** The time that the Message will expire and be automatically deleted. */
|
|
367
|
-
expiresOn: Date;
|
|
368
|
-
/** This value is required to delete the Message. If deletion fails using this popreceipt then the message has been dequeued by another client. */
|
|
369
|
-
popReceipt: string;
|
|
370
|
-
/** The time that the message will again become visible in the Queue. */
|
|
371
|
-
nextVisibleOn: Date;
|
|
372
|
-
/** The number of times the message has been dequeued. */
|
|
373
|
-
dequeueCount: number;
|
|
374
|
-
/** The content of the Message. */
|
|
375
|
-
messageText: string;
|
|
376
|
-
}
|
|
377
|
-
|
|
378
|
-
/** The object returned in the QueueMessageList array when calling Put Message on a Queue */
|
|
379
|
-
export declare interface EnqueuedMessage {
|
|
380
|
-
/** The Id of the Message. */
|
|
381
|
-
messageId: string;
|
|
382
|
-
/** The time the Message was inserted into the Queue. */
|
|
383
|
-
insertedOn: Date;
|
|
384
|
-
/** The time that the Message will expire and be automatically deleted. */
|
|
385
|
-
expiresOn: Date;
|
|
386
|
-
/** This value is required to delete the Message. If deletion fails using this popreceipt then the message has been dequeued by another client. */
|
|
387
|
-
popReceipt: string;
|
|
388
|
-
/** The time that the message will again become visible in the Queue. */
|
|
389
|
-
nextVisibleOn: Date;
|
|
390
|
-
}
|
|
391
|
-
|
|
392
|
-
/**
|
|
393
|
-
* ONLY AVAILABLE IN NODE.JS RUNTIME.
|
|
394
|
-
*
|
|
395
|
-
* Generates a {@link SASQueryParameters} object which contains all SAS query parameters needed to make an actual
|
|
396
|
-
* REST request.
|
|
397
|
-
*
|
|
398
|
-
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas
|
|
399
|
-
*
|
|
400
|
-
* @param accountSASSignatureValues - SAS Signature values of the account
|
|
401
|
-
* @param sharedKeyCredential - Shared key credential.
|
|
402
|
-
*/
|
|
403
|
-
export declare function generateAccountSASQueryParameters(accountSASSignatureValues: AccountSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential): SASQueryParameters;
|
|
404
|
-
|
|
405
|
-
/**
|
|
406
|
-
* ONLY AVAILABLE IN NODE.JS RUNTIME.
|
|
407
|
-
*
|
|
408
|
-
* Creates an instance of SASQueryParameters.
|
|
409
|
-
*
|
|
410
|
-
* Only accepts required settings needed to create a SAS. For optional settings please
|
|
411
|
-
* set corresponding properties directly, such as permissions, startsOn and identifier.
|
|
412
|
-
*
|
|
413
|
-
* WARNING: When identifier is not provided, permissions and expiresOn are required.
|
|
414
|
-
* You MUST assign value to identifier or expiresOn & permissions manually if you initial with
|
|
415
|
-
* this constructor.
|
|
416
|
-
*
|
|
417
|
-
* @param queueSASSignatureValues -
|
|
418
|
-
* @param sharedKeyCredential -
|
|
419
|
-
*/
|
|
420
|
-
export declare function generateQueueSASQueryParameters(queueSASSignatureValues: QueueSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential): SASQueryParameters;
|
|
421
|
-
|
|
422
|
-
/** Geo-Replication information for the Secondary Storage Service */
|
|
423
|
-
export declare interface GeoReplication {
|
|
424
|
-
/** The status of the secondary location */
|
|
425
|
-
status: GeoReplicationStatusType;
|
|
426
|
-
/** A GMT date/time value, to the second. All primary writes preceding this value are guaranteed to be available for read operations at the secondary. Primary writes after this point in time may or may not be available for reads. */
|
|
427
|
-
lastSyncOn: Date;
|
|
428
|
-
}
|
|
429
|
-
|
|
430
|
-
/** Defines values for GeoReplicationStatusType. */
|
|
431
|
-
export declare type GeoReplicationStatusType = "live" | "bootstrap" | "unavailable";
|
|
432
|
-
|
|
433
|
-
/**
|
|
434
|
-
* To get OAuth audience for a storage account for queue service.
|
|
435
|
-
*/
|
|
436
|
-
export declare function getQueueServiceAccountAudience(storageAccountName: string): string;
|
|
437
|
-
|
|
438
|
-
export { HttpHeaders }
|
|
439
|
-
|
|
440
|
-
export { HttpOperationResponse }
|
|
441
|
-
|
|
442
|
-
export { HttpRequestBody }
|
|
443
|
-
|
|
444
|
-
/**
|
|
445
|
-
* A representation of an HTTP response that
|
|
446
|
-
* includes a reference to the request that
|
|
447
|
-
* originated it.
|
|
448
|
-
*/
|
|
449
|
-
export declare interface HttpResponse {
|
|
450
|
-
/**
|
|
451
|
-
* The headers from the response.
|
|
452
|
-
*/
|
|
453
|
-
headers: HttpHeaders;
|
|
454
|
-
/**
|
|
455
|
-
* The original request that resulted in this response.
|
|
456
|
-
*/
|
|
457
|
-
request: WebResource;
|
|
458
|
-
/**
|
|
459
|
-
* The HTTP status code returned from the service.
|
|
460
|
-
*/
|
|
461
|
-
status: number;
|
|
462
|
-
}
|
|
463
|
-
|
|
464
|
-
/**
|
|
465
|
-
* A helper to decide if a given argument satisfies the Pipeline contract
|
|
466
|
-
* @param pipeline - An argument that may be a Pipeline
|
|
467
|
-
* @returns true when the argument satisfies the Pipeline contract
|
|
468
|
-
*/
|
|
469
|
-
export declare function isPipelineLike(pipeline: unknown): pipeline is PipelineLike;
|
|
470
|
-
|
|
471
|
-
/**
|
|
472
|
-
* Defines values for ListQueuesIncludeType.
|
|
473
|
-
* Possible values include: 'metadata'
|
|
474
|
-
* @readonly
|
|
475
|
-
*/
|
|
476
|
-
export declare type ListQueuesIncludeType = "metadata";
|
|
477
|
-
|
|
478
|
-
/** The object returned when calling List Queues on a Queue Service. */
|
|
479
|
-
export declare interface ListQueuesSegmentResponse {
|
|
480
|
-
serviceEndpoint: string;
|
|
481
|
-
prefix: string;
|
|
482
|
-
marker?: string;
|
|
483
|
-
maxPageSize: number;
|
|
484
|
-
queueItems?: QueueItem[];
|
|
485
|
-
continuationToken: string;
|
|
486
|
-
}
|
|
487
|
-
|
|
488
|
-
/**
|
|
489
|
-
* The `@azure/logger` configuration for this package.
|
|
490
|
-
*/
|
|
491
|
-
export declare const logger: AzureLogger;
|
|
492
|
-
|
|
493
|
-
/** Azure Analytics Logging settings. */
|
|
494
|
-
export declare interface Logging {
|
|
495
|
-
/** The version of Storage Analytics to configure. */
|
|
496
|
-
version: string;
|
|
497
|
-
/** Indicates whether all delete requests should be logged. */
|
|
498
|
-
deleteProperty: boolean;
|
|
499
|
-
/** Indicates whether all read requests should be logged. */
|
|
500
|
-
read: boolean;
|
|
501
|
-
/** Indicates whether all write requests should be logged. */
|
|
502
|
-
write: boolean;
|
|
503
|
-
/** the retention policy */
|
|
504
|
-
retentionPolicy: RetentionPolicy;
|
|
505
|
-
}
|
|
506
|
-
|
|
507
|
-
/** Interface representing a MessageId. */
|
|
508
|
-
declare interface MessageId {
|
|
509
|
-
/**
|
|
510
|
-
* The Update operation was introduced with version 2011-08-18 of the Queue service API. The Update
|
|
511
|
-
* Message operation updates the visibility timeout of a message. You can also use this operation to
|
|
512
|
-
* update the contents of a message. A message must be in a format that can be included in an XML
|
|
513
|
-
* request with UTF-8 encoding, and the encoded message can be up to 64KB in size.
|
|
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 visibilityTimeout Optional. Specifies the new visibility timeout value, in seconds, relative
|
|
517
|
-
* to server time. The default value is 30 seconds. A specified value must be larger than or equal to 1
|
|
518
|
-
* second, and cannot be larger than 7 days, or larger than 2 hours on REST protocol versions prior to
|
|
519
|
-
* version 2011-08-18. The visibility timeout of a message can be set to a value later than the expiry
|
|
520
|
-
* time.
|
|
521
|
-
* @param options The options parameters.
|
|
522
|
-
*/
|
|
523
|
-
update(popReceipt: string, visibilityTimeout: number, options?: MessageIdUpdateOptionalParams): Promise<MessageIdUpdateResponse_2>;
|
|
524
|
-
/**
|
|
525
|
-
* The Delete operation deletes the specified message.
|
|
526
|
-
* @param popReceipt Required. Specifies the valid pop receipt value returned from an earlier call to
|
|
527
|
-
* the Get Messages or Update Message operation.
|
|
528
|
-
* @param options The options parameters.
|
|
529
|
-
*/
|
|
530
|
-
delete(popReceipt: string, options?: MessageIdDeleteOptionalParams): Promise<MessageIdDeleteResponse_2>;
|
|
531
|
-
}
|
|
532
|
-
|
|
533
|
-
/** Defines headers for MessageId_delete operation. */
|
|
534
|
-
export declare interface MessageIdDeleteHeaders {
|
|
535
|
-
/** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
|
|
536
|
-
requestId?: string;
|
|
537
|
-
/** Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. */
|
|
538
|
-
version?: string;
|
|
539
|
-
/** UTC date/time value generated by the service that indicates the time at which the response was initiated */
|
|
540
|
-
date?: Date;
|
|
541
|
-
/** If a client request id header is sent in the request, this header will be present in the response with the same value. */
|
|
542
|
-
clientRequestId?: string;
|
|
543
|
-
/** Error Code */
|
|
544
|
-
errorCode?: string;
|
|
545
|
-
}
|
|
546
|
-
|
|
547
|
-
/** Optional parameters. */
|
|
548
|
-
declare interface MessageIdDeleteOptionalParams extends coreClient.OperationOptions {
|
|
549
|
-
/** 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> */
|
|
550
|
-
timeoutInSeconds?: number;
|
|
551
|
-
/** 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. */
|
|
552
|
-
requestId?: string;
|
|
553
|
-
}
|
|
554
|
-
|
|
555
|
-
/** Contains response data for the delete operation. */
|
|
556
|
-
export declare type MessageIdDeleteResponse = WithResponse<MessageIdDeleteHeaders, MessageIdDeleteHeaders>;
|
|
557
|
-
|
|
558
|
-
/** Contains response data for the delete operation. */
|
|
559
|
-
declare type MessageIdDeleteResponse_2 = MessageIdDeleteHeaders;
|
|
560
|
-
|
|
561
|
-
/** Defines headers for MessageId_update operation. */
|
|
562
|
-
export declare interface MessageIdUpdateHeaders {
|
|
563
|
-
/** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
|
|
564
|
-
requestId?: string;
|
|
565
|
-
/** Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. */
|
|
566
|
-
version?: string;
|
|
567
|
-
/** UTC date/time value generated by the service that indicates the time at which the response was initiated */
|
|
568
|
-
date?: Date;
|
|
569
|
-
/** The pop receipt of the queue message. */
|
|
570
|
-
popReceipt?: string;
|
|
571
|
-
/** A UTC date/time value that represents when the message will be visible on the queue. */
|
|
572
|
-
nextVisibleOn?: Date;
|
|
573
|
-
/** If a client request id header is sent in the request, this header will be present in the response with the same value. */
|
|
574
|
-
clientRequestId?: string;
|
|
575
|
-
/** Error Code */
|
|
576
|
-
errorCode?: string;
|
|
577
|
-
}
|
|
578
|
-
|
|
579
|
-
/** Optional parameters. */
|
|
580
|
-
declare interface MessageIdUpdateOptionalParams extends coreClient.OperationOptions {
|
|
581
|
-
/** 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> */
|
|
582
|
-
timeoutInSeconds?: number;
|
|
583
|
-
/** 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. */
|
|
584
|
-
requestId?: string;
|
|
585
|
-
/** A Message object which can be stored in a Queue */
|
|
586
|
-
queueMessage?: QueueMessage;
|
|
587
|
-
}
|
|
588
|
-
|
|
589
|
-
/** Contains response data for the update operation. */
|
|
590
|
-
export declare type MessageIdUpdateResponse = WithResponse<MessageIdUpdateHeaders, MessageIdUpdateHeaders>;
|
|
591
|
-
|
|
592
|
-
/** Contains response data for the update operation. */
|
|
593
|
-
declare type MessageIdUpdateResponse_2 = MessageIdUpdateHeaders;
|
|
594
|
-
|
|
595
|
-
/** Interface representing a Messages. */
|
|
596
|
-
declare interface Messages {
|
|
597
|
-
/**
|
|
598
|
-
* The Dequeue operation retrieves one or more messages from the front of the queue.
|
|
599
|
-
* @param options The options parameters.
|
|
600
|
-
*/
|
|
601
|
-
dequeue(options?: MessagesDequeueOptionalParams_2): Promise<MessagesDequeueResponse>;
|
|
602
|
-
/**
|
|
603
|
-
* The Clear operation deletes all messages from the specified queue.
|
|
604
|
-
* @param options The options parameters.
|
|
605
|
-
*/
|
|
606
|
-
clear(options?: MessagesClearOptionalParams): Promise<MessagesClearResponse_2>;
|
|
607
|
-
/**
|
|
608
|
-
* The Enqueue operation adds a new message to the back of the message queue. A visibility timeout can
|
|
609
|
-
* also be specified to make the message invisible until the visibility timeout expires. A message must
|
|
610
|
-
* be in a format that can be included in an XML request with UTF-8 encoding. The encoded message can
|
|
611
|
-
* be up to 64 KB in size for versions 2011-08-18 and newer, or 8 KB in size for previous versions.
|
|
612
|
-
* @param queueMessage A Message object which can be stored in a Queue
|
|
613
|
-
* @param options The options parameters.
|
|
614
|
-
*/
|
|
615
|
-
enqueue(queueMessage: QueueMessage, options?: MessagesEnqueueOptionalParams_2): Promise<MessagesEnqueueResponse>;
|
|
616
|
-
/**
|
|
617
|
-
* The Peek operation retrieves one or more messages from the front of the queue, but does not alter
|
|
618
|
-
* the visibility of the message.
|
|
619
|
-
* @param options The options parameters.
|
|
620
|
-
*/
|
|
621
|
-
peek(options?: MessagesPeekOptionalParams_2): Promise<MessagesPeekResponse>;
|
|
622
|
-
}
|
|
623
|
-
|
|
624
|
-
/** Defines headers for Messages_clear operation. */
|
|
625
|
-
export declare interface MessagesClearHeaders {
|
|
626
|
-
/** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
|
|
627
|
-
requestId?: string;
|
|
628
|
-
/** Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. */
|
|
629
|
-
version?: string;
|
|
630
|
-
/** UTC date/time value generated by the service that indicates the time at which the response was initiated */
|
|
631
|
-
date?: Date;
|
|
632
|
-
/** If a client request id header is sent in the request, this header will be present in the response with the same value. */
|
|
633
|
-
clientRequestId?: string;
|
|
634
|
-
/** Error Code */
|
|
635
|
-
errorCode?: string;
|
|
636
|
-
}
|
|
637
|
-
|
|
638
|
-
/** Optional parameters. */
|
|
639
|
-
declare interface MessagesClearOptionalParams extends coreClient.OperationOptions {
|
|
640
|
-
/** 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> */
|
|
641
|
-
timeoutInSeconds?: number;
|
|
642
|
-
/** 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. */
|
|
643
|
-
requestId?: string;
|
|
644
|
-
}
|
|
645
|
-
|
|
646
|
-
/** Contains response data for the clear operation. */
|
|
647
|
-
export declare type MessagesClearResponse = WithResponse<MessagesClearHeaders, MessagesClearHeaders>;
|
|
648
|
-
|
|
649
|
-
/** Contains response data for the clear operation. */
|
|
650
|
-
declare type MessagesClearResponse_2 = MessagesClearHeaders;
|
|
651
|
-
|
|
652
|
-
/** Defines headers for Messages_dequeue operation. */
|
|
653
|
-
export declare interface MessagesDequeueHeaders {
|
|
654
|
-
/** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
|
|
655
|
-
requestId?: string;
|
|
656
|
-
/** Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. */
|
|
657
|
-
version?: string;
|
|
658
|
-
/** UTC date/time value generated by the service that indicates the time at which the response was initiated */
|
|
659
|
-
date?: Date;
|
|
660
|
-
/** If a client request id header is sent in the request, this header will be present in the response with the same value. */
|
|
661
|
-
clientRequestId?: string;
|
|
662
|
-
/** Error Code */
|
|
663
|
-
errorCode?: string;
|
|
664
|
-
}
|
|
665
|
-
|
|
666
|
-
/** Optional parameters. */
|
|
667
|
-
export declare interface MessagesDequeueOptionalParams extends CommonOptions {
|
|
668
|
-
/** The The timeout parameter is expressed in seconds. For more information, see <a href="https://learn.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
|
-
/** Optional parameters. */
|
|
679
|
-
declare interface MessagesDequeueOptionalParams_2 extends coreClient.OperationOptions {
|
|
680
|
-
/** 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> */
|
|
681
|
-
timeoutInSeconds?: number;
|
|
682
|
-
/** 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. */
|
|
683
|
-
requestId?: string;
|
|
684
|
-
/** 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. */
|
|
685
|
-
numberOfMessages?: number;
|
|
686
|
-
/** 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. */
|
|
687
|
-
visibilityTimeout?: number;
|
|
688
|
-
}
|
|
689
|
-
|
|
690
|
-
/** Contains response data for the dequeue operation. */
|
|
691
|
-
declare type MessagesDequeueResponse = MessagesDequeueHeaders & DequeuedMessageItem[];
|
|
692
|
-
|
|
693
|
-
/** Defines headers for Messages_enqueue operation. */
|
|
694
|
-
export declare interface MessagesEnqueueHeaders {
|
|
695
|
-
/** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
|
|
696
|
-
requestId?: string;
|
|
697
|
-
/** Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. */
|
|
698
|
-
version?: string;
|
|
699
|
-
/** UTC date/time value generated by the service that indicates the time at which the response was initiated */
|
|
700
|
-
date?: Date;
|
|
701
|
-
/** If a client request id header is sent in the request, this header will be present in the response with the same value. */
|
|
702
|
-
clientRequestId?: string;
|
|
703
|
-
/** Error Code */
|
|
704
|
-
errorCode?: string;
|
|
705
|
-
}
|
|
706
|
-
|
|
707
|
-
/** Optional parameters. */
|
|
708
|
-
export declare interface MessagesEnqueueOptionalParams extends CommonOptions {
|
|
709
|
-
/** The The timeout parameter is expressed in seconds. For more information, see <a href="https://learn.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
|
-
/** Optional parameters. */
|
|
720
|
-
declare interface MessagesEnqueueOptionalParams_2 extends coreClient.OperationOptions {
|
|
721
|
-
/** 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> */
|
|
722
|
-
timeoutInSeconds?: number;
|
|
723
|
-
/** 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. */
|
|
724
|
-
requestId?: string;
|
|
725
|
-
/** 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. */
|
|
726
|
-
visibilityTimeout?: number;
|
|
727
|
-
/** 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. */
|
|
728
|
-
messageTimeToLive?: number;
|
|
729
|
-
}
|
|
730
|
-
|
|
731
|
-
/** Contains response data for the enqueue operation. */
|
|
732
|
-
declare type MessagesEnqueueResponse = MessagesEnqueueHeaders & EnqueuedMessage[];
|
|
733
|
-
|
|
734
|
-
/** Defines headers for Messages_peek operation. */
|
|
735
|
-
export declare interface MessagesPeekHeaders {
|
|
736
|
-
/** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
|
|
737
|
-
requestId?: string;
|
|
738
|
-
/** Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. */
|
|
739
|
-
version?: string;
|
|
740
|
-
/** UTC date/time value generated by the service that indicates the time at which the response was initiated */
|
|
741
|
-
date?: Date;
|
|
742
|
-
/** If a client request id header is sent in the request, this header will be present in the response with the same value. */
|
|
743
|
-
clientRequestId?: string;
|
|
744
|
-
/** Error Code */
|
|
745
|
-
errorCode?: string;
|
|
746
|
-
}
|
|
747
|
-
|
|
748
|
-
/** Optional parameters. */
|
|
749
|
-
export declare interface MessagesPeekOptionalParams extends CommonOptions {
|
|
750
|
-
/** The The timeout parameter is expressed in seconds. For more information, see <a href="https://learn.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-queue-service-operations">Setting Timeouts for Queue Service Operations.</a> */
|
|
751
|
-
timeoutInSeconds?: number;
|
|
752
|
-
/** 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. */
|
|
753
|
-
requestId?: string;
|
|
754
|
-
/** 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. */
|
|
755
|
-
numberOfMessages?: number;
|
|
756
|
-
}
|
|
757
|
-
|
|
758
|
-
/** Optional parameters. */
|
|
759
|
-
declare interface MessagesPeekOptionalParams_2 extends coreClient.OperationOptions {
|
|
760
|
-
/** 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> */
|
|
761
|
-
timeoutInSeconds?: number;
|
|
762
|
-
/** 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. */
|
|
763
|
-
requestId?: string;
|
|
764
|
-
/** 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. */
|
|
765
|
-
numberOfMessages?: number;
|
|
766
|
-
}
|
|
767
|
-
|
|
768
|
-
/** Contains response data for the peek operation. */
|
|
769
|
-
declare type MessagesPeekResponse = MessagesPeekHeaders & PeekedMessageItem[];
|
|
770
|
-
|
|
771
|
-
/**
|
|
772
|
-
* A collection of key-value string pairs.
|
|
773
|
-
*/
|
|
774
|
-
export declare interface Metadata {
|
|
775
|
-
/**
|
|
776
|
-
* A key-value string pair.
|
|
777
|
-
*/
|
|
778
|
-
[propertyName: string]: string;
|
|
779
|
-
}
|
|
780
|
-
|
|
781
|
-
/** An interface representing Metrics. */
|
|
782
|
-
export declare interface Metrics {
|
|
783
|
-
/** The version of Storage Analytics to configure. */
|
|
784
|
-
version?: string;
|
|
785
|
-
/** Indicates whether metrics are enabled for the Queue service. */
|
|
786
|
-
enabled: boolean;
|
|
787
|
-
/** Indicates whether metrics should generate summary statistics for called API operations. */
|
|
788
|
-
includeAPIs?: boolean;
|
|
789
|
-
/** the retention policy */
|
|
790
|
-
retentionPolicy?: RetentionPolicy;
|
|
791
|
-
}
|
|
792
|
-
|
|
793
|
-
/**
|
|
794
|
-
* Creates a new Pipeline object with Credential provided.
|
|
795
|
-
*
|
|
796
|
-
* @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.
|
|
797
|
-
* @param pipelineOptions - Optional. Options.
|
|
798
|
-
* @returns A new Pipeline object.
|
|
799
|
-
*/
|
|
800
|
-
export declare function newPipeline(credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, pipelineOptions?: StoragePipelineOptions): Pipeline;
|
|
801
|
-
|
|
802
|
-
/** The object returned in the QueueMessageList array when calling Peek Messages on a Queue */
|
|
803
|
-
export declare interface PeekedMessageItem {
|
|
804
|
-
/** The Id of the Message. */
|
|
805
|
-
messageId: string;
|
|
806
|
-
/** The time the Message was inserted into the Queue. */
|
|
807
|
-
insertedOn: Date;
|
|
808
|
-
/** The time that the Message will expire and be automatically deleted. */
|
|
809
|
-
expiresOn: Date;
|
|
810
|
-
/** The number of times the message has been dequeued. */
|
|
811
|
-
dequeueCount: number;
|
|
812
|
-
/** The content of the Message. */
|
|
813
|
-
messageText: string;
|
|
814
|
-
}
|
|
815
|
-
|
|
816
|
-
/**
|
|
817
|
-
* A Pipeline class containing HTTP request policies.
|
|
818
|
-
* You can create a default Pipeline by calling {@link newPipeline}.
|
|
819
|
-
* Or you can create a Pipeline with your own policies by the constructor of Pipeline.
|
|
820
|
-
*
|
|
821
|
-
* Refer to {@link newPipeline} and provided policies before implementing your
|
|
822
|
-
* customized Pipeline.
|
|
823
|
-
*/
|
|
824
|
-
export declare class Pipeline implements PipelineLike {
|
|
825
|
-
/**
|
|
826
|
-
* A list of chained request policy factories.
|
|
827
|
-
*/
|
|
828
|
-
readonly factories: RequestPolicyFactory[];
|
|
829
|
-
/**
|
|
830
|
-
* Configures pipeline logger and HTTP client.
|
|
831
|
-
*/
|
|
832
|
-
readonly options: PipelineOptions;
|
|
833
|
-
/**
|
|
834
|
-
* Creates an instance of Pipeline. Customize HTTPClient by implementing IHttpClient interface.
|
|
835
|
-
*
|
|
836
|
-
* @param factories -
|
|
837
|
-
* @param options -
|
|
838
|
-
*/
|
|
839
|
-
constructor(factories: RequestPolicyFactory[], options?: PipelineOptions);
|
|
840
|
-
/**
|
|
841
|
-
* Transfer Pipeline object to ServiceClientOptions object which is required by
|
|
842
|
-
* ServiceClient constructor.
|
|
843
|
-
*
|
|
844
|
-
* @returns The ServiceClientOptions object from this Pipeline.
|
|
845
|
-
*/
|
|
846
|
-
toServiceClientOptions(): ServiceClientOptions;
|
|
847
|
-
}
|
|
848
|
-
|
|
849
|
-
/**
|
|
850
|
-
* An interface for the {@link Pipeline} class containing HTTP request policies.
|
|
851
|
-
* You can create a default Pipeline by calling {@link newPipeline}.
|
|
852
|
-
* Or you can create a Pipeline with your own policies by the constructor of Pipeline.
|
|
853
|
-
*
|
|
854
|
-
* Refer to {@link newPipeline} and provided policies before implementing your
|
|
855
|
-
* customized Pipeline.
|
|
856
|
-
*/
|
|
857
|
-
export declare interface PipelineLike {
|
|
858
|
-
/**
|
|
859
|
-
* A list of chained request policy factories.
|
|
860
|
-
*/
|
|
861
|
-
readonly factories: RequestPolicyFactory[];
|
|
862
|
-
/**
|
|
863
|
-
* Configures pipeline logger and HTTP client.
|
|
864
|
-
*/
|
|
865
|
-
readonly options: PipelineOptions;
|
|
866
|
-
/**
|
|
867
|
-
* Transfer Pipeline object to ServiceClientOptions object which is required by
|
|
868
|
-
* ServiceClient constructor.
|
|
869
|
-
*
|
|
870
|
-
* @returns The ServiceClientOptions object from this Pipeline.
|
|
871
|
-
*/
|
|
872
|
-
toServiceClientOptions(): ServiceClientOptions;
|
|
873
|
-
}
|
|
874
|
-
|
|
875
|
-
/**
|
|
876
|
-
* Option interface for Pipeline constructor.
|
|
877
|
-
*/
|
|
878
|
-
export declare interface PipelineOptions {
|
|
879
|
-
/**
|
|
880
|
-
* Optional. Configures the HTTP client to send requests and receive responses.
|
|
881
|
-
*/
|
|
882
|
-
httpClient?: RequestPolicy;
|
|
883
|
-
}
|
|
884
|
-
|
|
885
|
-
/** Interface representing a Queue. */
|
|
886
|
-
declare interface Queue {
|
|
887
|
-
/**
|
|
888
|
-
* creates a new queue under the given account.
|
|
889
|
-
* @param options The options parameters.
|
|
890
|
-
*/
|
|
891
|
-
create(options?: QueueCreateOptionalParams): Promise<QueueCreateResponse_2>;
|
|
892
|
-
/**
|
|
893
|
-
* operation permanently deletes the specified queue
|
|
894
|
-
* @param options The options parameters.
|
|
895
|
-
*/
|
|
896
|
-
delete(options?: QueueDeleteOptionalParams): Promise<QueueDeleteResponse_2>;
|
|
897
|
-
/**
|
|
898
|
-
* Retrieves user-defined metadata and queue properties on the specified queue. Metadata is associated
|
|
899
|
-
* with the queue as name-values pairs.
|
|
900
|
-
* @param options The options parameters.
|
|
901
|
-
*/
|
|
902
|
-
getProperties(options?: QueueGetPropertiesOptionalParams): Promise<QueueGetPropertiesResponse_2>;
|
|
903
|
-
/**
|
|
904
|
-
* sets user-defined metadata on the specified queue. Metadata is associated with the queue as
|
|
905
|
-
* name-value pairs.
|
|
906
|
-
* @param options The options parameters.
|
|
907
|
-
*/
|
|
908
|
-
setMetadata(options?: QueueSetMetadataOptionalParams): Promise<QueueSetMetadataResponse_2>;
|
|
909
|
-
/**
|
|
910
|
-
* returns details about any stored access policies specified on the queue that may be used with Shared
|
|
911
|
-
* Access Signatures.
|
|
912
|
-
* @param options The options parameters.
|
|
913
|
-
*/
|
|
914
|
-
getAccessPolicy(options?: QueueGetAccessPolicyOptionalParams): Promise<QueueGetAccessPolicyResponse_2>;
|
|
915
|
-
/**
|
|
916
|
-
* sets stored access policies for the queue that may be used with Shared Access Signatures
|
|
917
|
-
* @param options The options parameters.
|
|
918
|
-
*/
|
|
919
|
-
setAccessPolicy(options?: QueueSetAccessPolicyOptionalParams): Promise<QueueSetAccessPolicyResponse_2>;
|
|
920
|
-
}
|
|
921
|
-
|
|
922
|
-
/**
|
|
923
|
-
* Options to configure {@link QueueClient.clearMessages} operation
|
|
924
|
-
*/
|
|
925
|
-
export declare interface QueueClearMessagesOptions extends CommonOptions {
|
|
926
|
-
/**
|
|
927
|
-
* An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
|
|
928
|
-
* For example, use the @azure/abort-controller to create an `AbortSignal`.
|
|
929
|
-
*/
|
|
930
|
-
abortSignal?: AbortSignalLike;
|
|
931
|
-
}
|
|
932
|
-
|
|
933
|
-
/**
|
|
934
|
-
* Contains response data for the {@link QueueClient.clearMessages} operation.
|
|
935
|
-
*/
|
|
936
|
-
export declare type QueueClearMessagesResponse = MessagesClearResponse;
|
|
937
|
-
|
|
938
|
-
/**
|
|
939
|
-
* A QueueClient represents a URL to an Azure Storage Queue's messages allowing you to manipulate its messages.
|
|
940
|
-
*/
|
|
941
|
-
export declare class QueueClient extends StorageClient {
|
|
942
|
-
/**
|
|
943
|
-
* messagesContext provided by protocol layer.
|
|
944
|
-
*/
|
|
945
|
-
private messagesContext;
|
|
946
|
-
/**
|
|
947
|
-
* queueContext provided by protocol layer.
|
|
948
|
-
*/
|
|
949
|
-
private queueContext;
|
|
950
|
-
private _name;
|
|
951
|
-
private _messagesUrl;
|
|
952
|
-
/**
|
|
953
|
-
* The name of the queue.
|
|
954
|
-
*/
|
|
955
|
-
get name(): string;
|
|
956
|
-
/**
|
|
957
|
-
* Creates an instance of QueueClient.
|
|
958
|
-
*
|
|
959
|
-
* @param connectionString - Account connection string or a SAS connection string of an Azure storage account.
|
|
960
|
-
* [ Note - Account connection string can only be used in NODE.JS runtime. ]
|
|
961
|
-
* Account connection string example -
|
|
962
|
-
* `DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net`
|
|
963
|
-
* SAS connection string example -
|
|
964
|
-
* `BlobEndpoint=https://myaccount.blob.core.windows.net/;QueueEndpoint=https://myaccount.queue.core.windows.net/;FileEndpoint=https://myaccount.file.core.windows.net/;TableEndpoint=https://myaccount.table.core.windows.net/;SharedAccessSignature=sasString`
|
|
965
|
-
* @param queueName - Queue name.
|
|
966
|
-
* @param options - Options to configure the HTTP pipeline.
|
|
967
|
-
*/
|
|
968
|
-
constructor(connectionString: string, queueName: string, options?: StoragePipelineOptions);
|
|
969
|
-
/**
|
|
970
|
-
* Creates an instance of QueueClient.
|
|
971
|
-
*
|
|
972
|
-
* @param url - A URL string pointing to Azure Storage queue, such as
|
|
973
|
-
* "https://myaccount.queue.core.windows.net/myqueue". You can
|
|
974
|
-
* append a SAS if using AnonymousCredential, such as
|
|
975
|
-
* "https://myaccount.queue.core.windows.net/myqueue?sasString".
|
|
976
|
-
* @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.
|
|
977
|
-
* @param options - Options to configure the HTTP pipeline.
|
|
978
|
-
*/
|
|
979
|
-
constructor(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions);
|
|
980
|
-
/**
|
|
981
|
-
* Creates an instance of QueueClient.
|
|
982
|
-
*
|
|
983
|
-
* @param url - A URL string pointing to Azure Storage queue, such as
|
|
984
|
-
* "https://myaccount.queue.core.windows.net/myqueue". You can
|
|
985
|
-
* append a SAS if using AnonymousCredential, such as
|
|
986
|
-
* "https://myaccount.queue.core.windows.net/myqueue?sasString".
|
|
987
|
-
* @param pipeline - Call newPipeline() to create a default
|
|
988
|
-
* pipeline, or provide a customized pipeline.
|
|
989
|
-
*/
|
|
990
|
-
constructor(url: string, pipeline: Pipeline);
|
|
991
|
-
private getMessageIdContext;
|
|
992
|
-
/**
|
|
993
|
-
* Creates a new queue under the specified account.
|
|
994
|
-
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/create-queue4
|
|
995
|
-
*
|
|
996
|
-
* @param options - Options to Queue create operation.
|
|
997
|
-
* @returns Response data for the Queue create operation.
|
|
998
|
-
*
|
|
999
|
-
* Example usage:
|
|
1000
|
-
*
|
|
1001
|
-
* ```js
|
|
1002
|
-
* const queueClient = queueServiceClient.getQueueClient("<new queue name>");
|
|
1003
|
-
* const createQueueResponse = await queueClient.create();
|
|
1004
|
-
* ```
|
|
1005
|
-
*/
|
|
1006
|
-
create(options?: QueueCreateOptions): Promise<QueueCreateResponse>;
|
|
1007
|
-
/**
|
|
1008
|
-
* Creates a new queue under the specified account if it doesn't already exist.
|
|
1009
|
-
* If the queue already exists, it is not changed.
|
|
1010
|
-
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/create-queue4
|
|
1011
|
-
*
|
|
1012
|
-
* @param options -
|
|
1013
|
-
*/
|
|
1014
|
-
createIfNotExists(options?: QueueCreateOptions): Promise<QueueCreateIfNotExistsResponse>;
|
|
1015
|
-
/**
|
|
1016
|
-
* Deletes the specified queue permanently if it exists.
|
|
1017
|
-
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/delete-queue3
|
|
1018
|
-
*
|
|
1019
|
-
* @param options -
|
|
1020
|
-
*/
|
|
1021
|
-
deleteIfExists(options?: QueueDeleteOptions): Promise<QueueDeleteIfExistsResponse>;
|
|
1022
|
-
/**
|
|
1023
|
-
* Deletes the specified queue permanently.
|
|
1024
|
-
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/delete-queue3
|
|
1025
|
-
*
|
|
1026
|
-
* @param options - Options to Queue delete operation.
|
|
1027
|
-
* @returns Response data for the Queue delete operation.
|
|
1028
|
-
*
|
|
1029
|
-
* Example usage:
|
|
1030
|
-
*
|
|
1031
|
-
* ```js
|
|
1032
|
-
* const deleteQueueResponse = await queueClient.delete();
|
|
1033
|
-
* console.log(
|
|
1034
|
-
* "Delete queue successfully, service assigned request Id:", deleteQueueResponse.requestId
|
|
1035
|
-
* );
|
|
1036
|
-
* ```
|
|
1037
|
-
*/
|
|
1038
|
-
delete(options?: QueueDeleteOptions): Promise<QueueDeleteResponse>;
|
|
1039
|
-
/**
|
|
1040
|
-
* Returns true if the specified queue exists; false otherwise.
|
|
1041
|
-
*
|
|
1042
|
-
* NOTE: use this function with care since an existing queue might be deleted by other clients or
|
|
1043
|
-
* applications. Vice versa new queues might be added by other clients or applications after this
|
|
1044
|
-
* function completes.
|
|
1045
|
-
*
|
|
1046
|
-
* @param options - options to Exists operation.
|
|
1047
|
-
*/
|
|
1048
|
-
exists(options?: QueueExistsOptions): Promise<boolean>;
|
|
1049
|
-
/**
|
|
1050
|
-
* Gets all user-defined metadata and system properties for the specified
|
|
1051
|
-
* queue. Metadata is associated with the queue as name-values pairs.
|
|
1052
|
-
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/get-queue-metadata
|
|
1053
|
-
*
|
|
1054
|
-
* WARNING: The `metadata` object returned in the response will have its keys in lowercase, even if
|
|
1055
|
-
* they originally contained uppercase characters. This differs from the metadata keys returned by
|
|
1056
|
-
* the `listQueues` method of {@link QueueServiceClient} using the `includeMetadata` option, which
|
|
1057
|
-
* will retain their original casing.
|
|
1058
|
-
*
|
|
1059
|
-
* @param options - Options to Queue get properties operation.
|
|
1060
|
-
* @returns Response data for the Queue get properties operation.
|
|
1061
|
-
*/
|
|
1062
|
-
getProperties(options?: QueueGetPropertiesOptions): Promise<QueueGetPropertiesResponse>;
|
|
1063
|
-
/**
|
|
1064
|
-
* Sets one or more user-defined name-value pairs for the specified queue.
|
|
1065
|
-
*
|
|
1066
|
-
* If no option provided, or no metadata defined in the option parameter, the queue
|
|
1067
|
-
* metadata will be removed.
|
|
1068
|
-
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/set-queue-metadata
|
|
1069
|
-
*
|
|
1070
|
-
* @param metadata - If no metadata provided, all existing metadata will be removed.
|
|
1071
|
-
* @param options - Options to Queue set metadata operation.
|
|
1072
|
-
* @returns Response data for the Queue set metadata operation.
|
|
1073
|
-
*/
|
|
1074
|
-
setMetadata(metadata?: Metadata, options?: QueueSetMetadataOptions): Promise<QueueSetMetadataResponse>;
|
|
1075
|
-
/**
|
|
1076
|
-
* Gets details about any stored access policies specified on the queue that may be used with Shared Access Signatures.
|
|
1077
|
-
*
|
|
1078
|
-
* WARNING: JavaScript Date will potential lost precision when parsing start and expiry string.
|
|
1079
|
-
* For example, new Date("2018-12-31T03:44:23.8827891Z").toISOString() will get "2018-12-31T03:44:23.882Z".
|
|
1080
|
-
*
|
|
1081
|
-
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/get-queue-acl
|
|
1082
|
-
*
|
|
1083
|
-
* @param options - Options to Queue get access policy operation.
|
|
1084
|
-
* @returns Response data for the Queue get access policy operation.
|
|
1085
|
-
*/
|
|
1086
|
-
getAccessPolicy(options?: QueueGetAccessPolicyOptions): Promise<QueueGetAccessPolicyResponse>;
|
|
1087
|
-
/**
|
|
1088
|
-
* Sets stored access policies for the queue that may be used with Shared Access Signatures.
|
|
1089
|
-
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/set-queue-acl
|
|
1090
|
-
*
|
|
1091
|
-
* @param queueAcl -
|
|
1092
|
-
* @param options - Options to Queue set access policy operation.
|
|
1093
|
-
* @returns Response data for the Queue set access policy operation.
|
|
1094
|
-
*/
|
|
1095
|
-
setAccessPolicy(queueAcl?: SignedIdentifier[], options?: QueueSetAccessPolicyOptions): Promise<QueueSetAccessPolicyResponse>;
|
|
1096
|
-
/**
|
|
1097
|
-
* Clear deletes all messages from a queue.
|
|
1098
|
-
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/clear-messages
|
|
1099
|
-
*
|
|
1100
|
-
* @param options - Options to clear messages operation.
|
|
1101
|
-
* @returns Response data for the clear messages operation.
|
|
1102
|
-
*/
|
|
1103
|
-
clearMessages(options?: QueueClearMessagesOptions): Promise<QueueClearMessagesResponse>;
|
|
1104
|
-
/**
|
|
1105
|
-
* sendMessage adds a new message to the back of a queue. The visibility timeout specifies how long
|
|
1106
|
-
* the message should be invisible to Dequeue and Peek operations.
|
|
1107
|
-
* The message content is up to 64KB in size, and must be in a format that can be included in an XML request with UTF-8 encoding.
|
|
1108
|
-
* To include markup in the message, the contents of the message must either be XML-escaped or Base64-encode.
|
|
1109
|
-
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/put-message
|
|
1110
|
-
*
|
|
1111
|
-
* @param messageText - Text of the message to send
|
|
1112
|
-
* @param options - Options to send messages operation.
|
|
1113
|
-
* @returns Response data for the send messages operation.
|
|
1114
|
-
*
|
|
1115
|
-
* Example usage:
|
|
1116
|
-
*
|
|
1117
|
-
* ```js
|
|
1118
|
-
* const sendMessageResponse = await queueClient.sendMessage("Hello World!");
|
|
1119
|
-
* console.log(
|
|
1120
|
-
* "Sent message successfully, service assigned message Id:", sendMessageResponse.messageId,
|
|
1121
|
-
* "service assigned request Id:", sendMessageResponse.requestId
|
|
1122
|
-
* );
|
|
1123
|
-
* ```
|
|
1124
|
-
*/
|
|
1125
|
-
sendMessage(messageText: string, options?: QueueSendMessageOptions): Promise<QueueSendMessageResponse>;
|
|
1126
|
-
/**
|
|
1127
|
-
* receiveMessages retrieves one or more messages from the front of the queue.
|
|
1128
|
-
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/get-messages
|
|
1129
|
-
*
|
|
1130
|
-
* @param options - Options to receive messages operation.
|
|
1131
|
-
* @returns Response data for the receive messages operation.
|
|
1132
|
-
*
|
|
1133
|
-
* Example usage:
|
|
1134
|
-
*
|
|
1135
|
-
* ```js
|
|
1136
|
-
* const response = await queueClient.receiveMessages();
|
|
1137
|
-
* if (response.receivedMessageItems.length == 1) {
|
|
1138
|
-
* const receivedMessageItem = response.receivedMessageItems[0];
|
|
1139
|
-
* console.log("Processing & deleting message with content:", receivedMessageItem.messageText);
|
|
1140
|
-
* const deleteMessageResponse = await queueClient.deleteMessage(
|
|
1141
|
-
* receivedMessageItem.messageId,
|
|
1142
|
-
* receivedMessageItem.popReceipt
|
|
1143
|
-
* );
|
|
1144
|
-
* console.log(
|
|
1145
|
-
* "Delete message successfully, service assigned request Id:",
|
|
1146
|
-
* deleteMessageResponse.requestId
|
|
1147
|
-
* );
|
|
1148
|
-
* }
|
|
1149
|
-
* ```
|
|
1150
|
-
*/
|
|
1151
|
-
receiveMessages(options?: QueueReceiveMessageOptions): Promise<QueueReceiveMessageResponse>;
|
|
1152
|
-
/**
|
|
1153
|
-
* peekMessages retrieves one or more messages from the front of the queue but does not alter the visibility of the message.
|
|
1154
|
-
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/peek-messages
|
|
1155
|
-
*
|
|
1156
|
-
* @param options - Options to peek messages operation.
|
|
1157
|
-
* @returns Response data for the peek messages operation.
|
|
1158
|
-
*
|
|
1159
|
-
* Example usage:
|
|
1160
|
-
*
|
|
1161
|
-
* ```js
|
|
1162
|
-
* const peekMessagesResponse = await queueClient.peekMessages();
|
|
1163
|
-
* console.log("The peeked message is:", peekMessagesResponse.peekedMessageItems[0].messageText);
|
|
1164
|
-
* ```
|
|
1165
|
-
*/
|
|
1166
|
-
peekMessages(options?: QueuePeekMessagesOptions): Promise<QueuePeekMessagesResponse>;
|
|
1167
|
-
/**
|
|
1168
|
-
* deleteMessage permanently removes the specified message from its queue.
|
|
1169
|
-
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/delete-message2
|
|
1170
|
-
*
|
|
1171
|
-
* @param messageId - Id of the message.
|
|
1172
|
-
* @param popReceipt - A valid pop receipt value returned from an earlier call to the receive messages or update message operation.
|
|
1173
|
-
* @param options - Options to delete message operation.
|
|
1174
|
-
* @returns Response data for the delete message operation.
|
|
1175
|
-
*/
|
|
1176
|
-
deleteMessage(messageId: string, popReceipt: string, options?: QueueDeleteMessageOptions): Promise<QueueDeleteMessageResponse>;
|
|
1177
|
-
/**
|
|
1178
|
-
* Update changes a message's visibility timeout and contents.
|
|
1179
|
-
* The message content is up to 64KB in size, and must be in a format that can be included in an XML request with UTF-8 encoding.
|
|
1180
|
-
* To include markup in the message, the contents of the message must either be XML-escaped or Base64-encode.
|
|
1181
|
-
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/update-message
|
|
1182
|
-
*
|
|
1183
|
-
* @param messageId - Id of the message
|
|
1184
|
-
* @param popReceipt - A valid pop receipt value returned from an earlier call to the receive messages or update message operation.
|
|
1185
|
-
* @param message - Message to update. If this parameter is undefined, then the content of the message won't be updated.
|
|
1186
|
-
* @param visibilityTimeout - Specifies the new visibility timeout value, in seconds,
|
|
1187
|
-
* relative to server time. The new value must be larger than or equal to 0,
|
|
1188
|
-
* and cannot be larger than 7 days. The visibility timeout of a message cannot
|
|
1189
|
-
* be set to a value later than the expiry time.
|
|
1190
|
-
* A message can be updated until it has been deleted or has expired.
|
|
1191
|
-
* @param options - Options to update message operation.
|
|
1192
|
-
* @returns Response data for the update message operation.
|
|
1193
|
-
*/
|
|
1194
|
-
updateMessage(messageId: string, popReceipt: string, message?: string, visibilityTimeout?: number, options?: QueueUpdateMessageOptions): Promise<QueueUpdateMessageResponse>;
|
|
1195
|
-
private getQueueNameFromUrl;
|
|
1196
|
-
/**
|
|
1197
|
-
* Only available for QueueClient constructed with a shared key credential.
|
|
1198
|
-
*
|
|
1199
|
-
* Generates a Service Shared Access Signature (SAS) URI based on the client properties
|
|
1200
|
-
* and parameters passed in. The SAS is signed by the shared key credential of the client.
|
|
1201
|
-
*
|
|
1202
|
-
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
|
|
1203
|
-
*
|
|
1204
|
-
* @param options - Optional parameters.
|
|
1205
|
-
* @returns The SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.
|
|
1206
|
-
*/
|
|
1207
|
-
generateSasUrl(options: QueueGenerateSasUrlOptions): string;
|
|
1208
|
-
/**
|
|
1209
|
-
* Only available for QueueClient constructed with a shared key credential.
|
|
1210
|
-
*
|
|
1211
|
-
* Generates string to sign for a Service Shared Access Signature (SAS) URI based on the client properties
|
|
1212
|
-
* and parameters passed in. The SAS is signed by the shared key credential of the client.
|
|
1213
|
-
*
|
|
1214
|
-
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
|
|
1215
|
-
*
|
|
1216
|
-
* @param options - Optional parameters.
|
|
1217
|
-
* @returns The SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.
|
|
1218
|
-
*/
|
|
1219
|
-
generateSasStringToSign(options: QueueGenerateSasUrlOptions): string;
|
|
1220
|
-
}
|
|
1221
|
-
|
|
1222
|
-
/** Defines headers for Queue_create operation. */
|
|
1223
|
-
export declare interface QueueCreateHeaders {
|
|
1224
|
-
/** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
|
|
1225
|
-
requestId?: string;
|
|
1226
|
-
/** Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. */
|
|
1227
|
-
version?: string;
|
|
1228
|
-
/** UTC date/time value generated by the service that indicates the time at which the response was initiated */
|
|
1229
|
-
date?: Date;
|
|
1230
|
-
/** If a client request id header is sent in the request, this header will be present in the response with the same value. */
|
|
1231
|
-
clientRequestId?: string;
|
|
1232
|
-
/** Error Code */
|
|
1233
|
-
errorCode?: string;
|
|
1234
|
-
}
|
|
1235
|
-
|
|
1236
|
-
/**
|
|
1237
|
-
* Contains response data for the {@link QueueClient.createIfNotExists} operation.
|
|
1238
|
-
*/
|
|
1239
|
-
export declare interface QueueCreateIfNotExistsResponse extends QueueCreateResponse {
|
|
1240
|
-
/**
|
|
1241
|
-
* Indicate whether the queue is successfully created. Is false when the queue is not changed as it already exists.
|
|
1242
|
-
*/
|
|
1243
|
-
succeeded: boolean;
|
|
1244
|
-
}
|
|
1245
|
-
|
|
1246
|
-
/** Optional parameters. */
|
|
1247
|
-
declare interface QueueCreateOptionalParams extends coreClient.OperationOptions {
|
|
1248
|
-
/** 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> */
|
|
1249
|
-
timeoutInSeconds?: number;
|
|
1250
|
-
/** 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. */
|
|
1251
|
-
requestId?: string;
|
|
1252
|
-
/** 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. */
|
|
1253
|
-
metadata?: {
|
|
1254
|
-
[propertyName: string]: string;
|
|
1255
|
-
};
|
|
1256
|
-
}
|
|
1257
|
-
|
|
1258
|
-
/**
|
|
1259
|
-
* Options to configure {@link QueueClient.create} operation
|
|
1260
|
-
*/
|
|
1261
|
-
export declare interface QueueCreateOptions extends CommonOptions {
|
|
1262
|
-
/**
|
|
1263
|
-
* An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
|
|
1264
|
-
* For example, use the @azure/abort-controller to create an `AbortSignal`.
|
|
1265
|
-
*/
|
|
1266
|
-
abortSignal?: AbortSignalLike;
|
|
1267
|
-
/**
|
|
1268
|
-
* A collection of key-value string pair to associate with the queue object.
|
|
1269
|
-
* The keys need to be lower-case.
|
|
1270
|
-
*/
|
|
1271
|
-
metadata?: Metadata;
|
|
1272
|
-
}
|
|
1273
|
-
|
|
1274
|
-
/**
|
|
1275
|
-
* Contains response data for the create operation.
|
|
1276
|
-
*/
|
|
1277
|
-
export declare type QueueCreateResponse = WithResponse<QueueCreateHeaders, QueueCreateHeaders>;
|
|
1278
|
-
|
|
1279
|
-
/** Contains response data for the create operation. */
|
|
1280
|
-
declare type QueueCreateResponse_2 = QueueCreateHeaders;
|
|
1281
|
-
|
|
1282
|
-
/** Defines headers for Queue_delete operation. */
|
|
1283
|
-
export declare interface QueueDeleteHeaders {
|
|
1284
|
-
/** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
|
|
1285
|
-
requestId?: string;
|
|
1286
|
-
/** Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. */
|
|
1287
|
-
version?: string;
|
|
1288
|
-
/** UTC date/time value generated by the service that indicates the time at which the response was initiated */
|
|
1289
|
-
date?: Date;
|
|
1290
|
-
/** If a client request id header is sent in the request, this header will be present in the response with the same value. */
|
|
1291
|
-
clientRequestId?: string;
|
|
1292
|
-
/** Error Code */
|
|
1293
|
-
errorCode?: string;
|
|
1294
|
-
}
|
|
1295
|
-
|
|
1296
|
-
/**
|
|
1297
|
-
* Contains response data for the {@link QueueClient.deleteIfExists} operation.
|
|
1298
|
-
*/
|
|
1299
|
-
export declare interface QueueDeleteIfExistsResponse extends QueueDeleteResponse {
|
|
1300
|
-
/**
|
|
1301
|
-
* Indicate whether the queue is successfully deleted. Is false if the queue does not exist in the first place.
|
|
1302
|
-
*/
|
|
1303
|
-
succeeded: boolean;
|
|
1304
|
-
}
|
|
1305
|
-
|
|
1306
|
-
/**
|
|
1307
|
-
* Options to configure the {@link QueueClient.deleteMessage} operation
|
|
1308
|
-
*/
|
|
1309
|
-
export declare interface QueueDeleteMessageOptions extends CommonOptions {
|
|
1310
|
-
/**
|
|
1311
|
-
* An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
|
|
1312
|
-
* For example, use the @azure/abort-controller to create an `AbortSignal`.
|
|
1313
|
-
*/
|
|
1314
|
-
abortSignal?: AbortSignalLike;
|
|
1315
|
-
}
|
|
1316
|
-
|
|
1317
|
-
/**
|
|
1318
|
-
* Contains response data for the {@link QueueClient.deleteMessage} operation.
|
|
1319
|
-
*/
|
|
1320
|
-
export declare type QueueDeleteMessageResponse = MessageIdDeleteResponse;
|
|
1321
|
-
|
|
1322
|
-
/** Optional parameters. */
|
|
1323
|
-
declare interface QueueDeleteOptionalParams extends coreClient.OperationOptions {
|
|
1324
|
-
/** 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> */
|
|
1325
|
-
timeoutInSeconds?: number;
|
|
1326
|
-
/** 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. */
|
|
1327
|
-
requestId?: string;
|
|
1328
|
-
}
|
|
1329
|
-
|
|
1330
|
-
/**
|
|
1331
|
-
* Options to configure {@link QueueClient.delete} operation
|
|
1332
|
-
*/
|
|
1333
|
-
export declare interface QueueDeleteOptions extends CommonOptions {
|
|
1334
|
-
/**
|
|
1335
|
-
* An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
|
|
1336
|
-
* For example, use the @azure/abort-controller to create an `AbortSignal`.
|
|
1337
|
-
*/
|
|
1338
|
-
abortSignal?: AbortSignalLike;
|
|
1339
|
-
}
|
|
1340
|
-
|
|
1341
|
-
/** Contains response data for the delete operation. */
|
|
1342
|
-
export declare type QueueDeleteResponse = WithResponse<QueueDeleteHeaders, QueueDeleteHeaders>;
|
|
1343
|
-
|
|
1344
|
-
/** Contains response data for the delete operation. */
|
|
1345
|
-
declare type QueueDeleteResponse_2 = QueueDeleteHeaders;
|
|
1346
|
-
|
|
1347
|
-
/**
|
|
1348
|
-
* Options to configure {@link QueueClient.exists} operation
|
|
1349
|
-
*/
|
|
1350
|
-
export declare interface QueueExistsOptions extends CommonOptions {
|
|
1351
|
-
/**
|
|
1352
|
-
* An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
|
|
1353
|
-
* For example, use the @azure/abort-controller to create an `AbortSignal`.
|
|
1354
|
-
*/
|
|
1355
|
-
abortSignal?: AbortSignalLike;
|
|
1356
|
-
}
|
|
1357
|
-
|
|
1358
|
-
/**
|
|
1359
|
-
* Options to configure {@link QueueClient.generateSasUrl} operation.
|
|
1360
|
-
*/
|
|
1361
|
-
export declare interface QueueGenerateSasUrlOptions {
|
|
1362
|
-
/**
|
|
1363
|
-
* The version of the service this SAS will target. If not specified, it will default to the version targeted by the
|
|
1364
|
-
* library.
|
|
1365
|
-
*/
|
|
1366
|
-
version?: string;
|
|
1367
|
-
/**
|
|
1368
|
-
* Optional. SAS protocols, HTTPS only or HTTPSandHTTP
|
|
1369
|
-
*/
|
|
1370
|
-
protocol?: SASProtocol;
|
|
1371
|
-
/**
|
|
1372
|
-
* Optional. When the SAS will take effect.
|
|
1373
|
-
*/
|
|
1374
|
-
startsOn?: Date;
|
|
1375
|
-
/**
|
|
1376
|
-
* Optional only when identifier is provided. The time after which the SAS will no longer work.
|
|
1377
|
-
*/
|
|
1378
|
-
expiresOn?: Date;
|
|
1379
|
-
/**
|
|
1380
|
-
* Optional only when identifier is provided.
|
|
1381
|
-
* Please refer to {@link QueueSASPermissions} for help constructing the permissions string.
|
|
1382
|
-
*/
|
|
1383
|
-
permissions?: QueueSASPermissions;
|
|
1384
|
-
/**
|
|
1385
|
-
* Optional. IP ranges allowed in this SAS.
|
|
1386
|
-
*/
|
|
1387
|
-
ipRange?: SasIPRange;
|
|
1388
|
-
/**
|
|
1389
|
-
* Optional. The name of the access policy on the queue this SAS references if any.
|
|
1390
|
-
*
|
|
1391
|
-
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/establishing-a-stored-access-policy
|
|
1392
|
-
*/
|
|
1393
|
-
identifier?: string;
|
|
1394
|
-
}
|
|
1395
|
-
|
|
1396
|
-
/** Defines headers for Queue_getAccessPolicy operation. */
|
|
1397
|
-
export declare interface QueueGetAccessPolicyHeaders {
|
|
1398
|
-
/** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
|
|
1399
|
-
requestId?: string;
|
|
1400
|
-
/** Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. */
|
|
1401
|
-
version?: string;
|
|
1402
|
-
/** UTC date/time value generated by the service that indicates the time at which the response was initiated */
|
|
1403
|
-
date?: Date;
|
|
1404
|
-
/** If a client request id header is sent in the request, this header will be present in the response with the same value. */
|
|
1405
|
-
clientRequestId?: string;
|
|
1406
|
-
/** Error Code */
|
|
1407
|
-
errorCode?: string;
|
|
1408
|
-
}
|
|
1409
|
-
|
|
1410
|
-
/** Optional parameters. */
|
|
1411
|
-
declare interface QueueGetAccessPolicyOptionalParams extends coreClient.OperationOptions {
|
|
1412
|
-
/** 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> */
|
|
1413
|
-
timeoutInSeconds?: number;
|
|
1414
|
-
/** 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. */
|
|
1415
|
-
requestId?: string;
|
|
1416
|
-
}
|
|
1417
|
-
|
|
1418
|
-
/**
|
|
1419
|
-
* Options to configure {@link QueueClient.getAccessPolicy} operation
|
|
1420
|
-
*/
|
|
1421
|
-
export declare interface QueueGetAccessPolicyOptions extends CommonOptions {
|
|
1422
|
-
/**
|
|
1423
|
-
* An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
|
|
1424
|
-
* For example, use the @azure/abort-controller to create an `AbortSignal`.
|
|
1425
|
-
*/
|
|
1426
|
-
abortSignal?: AbortSignalLike;
|
|
1427
|
-
}
|
|
1428
|
-
|
|
1429
|
-
/**
|
|
1430
|
-
* Contains response data for the {@link QueueClient.getAccessPolicy} operation.
|
|
1431
|
-
*/
|
|
1432
|
-
export declare type QueueGetAccessPolicyResponse = WithResponse<{
|
|
1433
|
-
signedIdentifiers: SignedIdentifier[];
|
|
1434
|
-
} & QueueGetAccessPolicyHeaders, QueueGetAccessPolicyHeaders, SignedIdentifierModel[]>;
|
|
1435
|
-
|
|
1436
|
-
/** Contains response data for the getAccessPolicy operation. */
|
|
1437
|
-
declare type QueueGetAccessPolicyResponse_2 = QueueGetAccessPolicyHeaders & SignedIdentifierModel[];
|
|
1438
|
-
|
|
1439
|
-
/** Defines headers for Queue_getProperties operation. */
|
|
1440
|
-
export declare interface QueueGetPropertiesHeaders {
|
|
1441
|
-
metadata?: {
|
|
1442
|
-
[propertyName: string]: string;
|
|
1443
|
-
};
|
|
1444
|
-
/** The approximate number of messages in the queue. This number is not lower than the actual number of messages in the queue, but could be higher. */
|
|
1445
|
-
approximateMessagesCount?: number;
|
|
1446
|
-
/** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
|
|
1447
|
-
requestId?: string;
|
|
1448
|
-
/** Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. */
|
|
1449
|
-
version?: string;
|
|
1450
|
-
/** UTC date/time value generated by the service that indicates the time at which the response was initiated */
|
|
1451
|
-
date?: Date;
|
|
1452
|
-
/** If a client request id header is sent in the request, this header will be present in the response with the same value. */
|
|
1453
|
-
clientRequestId?: string;
|
|
1454
|
-
/** Error Code */
|
|
1455
|
-
errorCode?: string;
|
|
1456
|
-
}
|
|
1457
|
-
|
|
1458
|
-
/** Optional parameters. */
|
|
1459
|
-
declare interface QueueGetPropertiesOptionalParams extends coreClient.OperationOptions {
|
|
1460
|
-
/** 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> */
|
|
1461
|
-
timeoutInSeconds?: number;
|
|
1462
|
-
/** 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. */
|
|
1463
|
-
requestId?: string;
|
|
1464
|
-
}
|
|
1465
|
-
|
|
1466
|
-
/**
|
|
1467
|
-
* Options to configure {@link QueueClient.getProperties} operation
|
|
1468
|
-
*/
|
|
1469
|
-
export declare interface QueueGetPropertiesOptions extends CommonOptions {
|
|
1470
|
-
/**
|
|
1471
|
-
* An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
|
|
1472
|
-
* For example, use the @azure/abort-controller to create an `AbortSignal`.
|
|
1473
|
-
*/
|
|
1474
|
-
abortSignal?: AbortSignalLike;
|
|
1475
|
-
}
|
|
1476
|
-
|
|
1477
|
-
/** Contains response data for the getProperties operation. */
|
|
1478
|
-
export declare type QueueGetPropertiesResponse = WithResponse<QueueGetPropertiesHeaders, QueueGetPropertiesHeaders>;
|
|
1479
|
-
|
|
1480
|
-
/** Contains response data for the getProperties operation. */
|
|
1481
|
-
declare type QueueGetPropertiesResponse_2 = QueueGetPropertiesHeaders;
|
|
1482
|
-
|
|
1483
|
-
/** An Azure Storage Queue. */
|
|
1484
|
-
export declare interface QueueItem {
|
|
1485
|
-
/** The name of the Queue. */
|
|
1486
|
-
name: string;
|
|
1487
|
-
/** Dictionary of <string> */
|
|
1488
|
-
metadata?: {
|
|
1489
|
-
[propertyName: string]: string;
|
|
1490
|
-
};
|
|
1491
|
-
}
|
|
1492
|
-
|
|
1493
|
-
/** A Message object which can be stored in a Queue */
|
|
1494
|
-
declare interface QueueMessage {
|
|
1495
|
-
/** The content of the message */
|
|
1496
|
-
messageText: string;
|
|
1497
|
-
}
|
|
1498
|
-
|
|
1499
|
-
/**
|
|
1500
|
-
* Options to configure {@link QueueClient.peekMessages} operation
|
|
1501
|
-
*/
|
|
1502
|
-
export declare interface QueuePeekMessagesOptions extends MessagesPeekOptionalParams, CommonOptions {
|
|
1503
|
-
/**
|
|
1504
|
-
* An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
|
|
1505
|
-
* For example, use the @azure/abort-controller to create an `AbortSignal`.
|
|
1506
|
-
*/
|
|
1507
|
-
abortSignal?: AbortSignalLike;
|
|
1508
|
-
}
|
|
1509
|
-
|
|
1510
|
-
/**
|
|
1511
|
-
* Contains the response data for the {@link QueueClient.peekMessages} operation.
|
|
1512
|
-
*/
|
|
1513
|
-
export declare type QueuePeekMessagesResponse = WithResponse<{
|
|
1514
|
-
peekedMessageItems: PeekedMessageItem[];
|
|
1515
|
-
} & MessagesPeekHeaders, MessagesPeekHeaders, PeekedMessageItem[]>;
|
|
1516
|
-
|
|
1517
|
-
/**
|
|
1518
|
-
* Options to configure {@link QueueClient.receiveMessages} operation
|
|
1519
|
-
*/
|
|
1520
|
-
export declare interface QueueReceiveMessageOptions extends MessagesDequeueOptionalParams, CommonOptions {
|
|
1521
|
-
/**
|
|
1522
|
-
* An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
|
|
1523
|
-
* For example, use the @azure/abort-controller to create an `AbortSignal`.
|
|
1524
|
-
*/
|
|
1525
|
-
abortSignal?: AbortSignalLike;
|
|
1526
|
-
}
|
|
1527
|
-
|
|
1528
|
-
/**
|
|
1529
|
-
* Contains the response data for the {@link QueueClient.receiveMessages} operation.
|
|
1530
|
-
*/
|
|
1531
|
-
export declare type QueueReceiveMessageResponse = WithResponse<{
|
|
1532
|
-
receivedMessageItems: ReceivedMessageItem[];
|
|
1533
|
-
} & MessagesDequeueHeaders, MessagesDequeueHeaders, ReceivedMessageItem[]>;
|
|
1534
|
-
|
|
1535
|
-
/**
|
|
1536
|
-
* ONLY AVAILABLE IN NODE.JS RUNTIME.
|
|
1537
|
-
*
|
|
1538
|
-
* This is a helper class to construct a string representing the permissions granted by a ServiceSAS to a Queue. Setting
|
|
1539
|
-
* a value to true means that any SAS which uses these permissions will grant permissions for that operation. Once all
|
|
1540
|
-
* the values are set, this should be serialized with toString and set as the permissions field on a
|
|
1541
|
-
* {@link QueueSASSignatureValues} object. It is possible to construct the permissions string without this class, but
|
|
1542
|
-
* the order of the permissions is particular and this class guarantees correctness.
|
|
1543
|
-
*/
|
|
1544
|
-
export declare class QueueSASPermissions {
|
|
1545
|
-
/**
|
|
1546
|
-
* Creates a {@link QueueSASPermissions} from the specified permissions string. This method will throw an
|
|
1547
|
-
* Error if it encounters a character that does not correspond to a valid permission.
|
|
1548
|
-
*
|
|
1549
|
-
* @param permissions -
|
|
1550
|
-
*/
|
|
1551
|
-
static parse(permissions: string): QueueSASPermissions;
|
|
1552
|
-
/**
|
|
1553
|
-
* Specifies Read access granted.
|
|
1554
|
-
*/
|
|
1555
|
-
read: boolean;
|
|
1556
|
-
/**
|
|
1557
|
-
* Specifies Add access granted.
|
|
1558
|
-
*/
|
|
1559
|
-
add: boolean;
|
|
1560
|
-
/**
|
|
1561
|
-
* Specifies Update access granted.
|
|
1562
|
-
*/
|
|
1563
|
-
update: boolean;
|
|
1564
|
-
/**
|
|
1565
|
-
* Specifies Process access granted.
|
|
1566
|
-
*/
|
|
1567
|
-
process: boolean;
|
|
1568
|
-
/**
|
|
1569
|
-
* Converts the given permissions to a string. Using this method will guarantee the permissions are in an
|
|
1570
|
-
* order accepted by the service.
|
|
1571
|
-
*
|
|
1572
|
-
* @returns A string which represents the QueueSASPermissions
|
|
1573
|
-
*/
|
|
1574
|
-
toString(): string;
|
|
1575
|
-
}
|
|
1576
|
-
|
|
1577
|
-
/**
|
|
1578
|
-
* ONLY AVAILABLE IN NODE.JS RUNTIME.
|
|
1579
|
-
*
|
|
1580
|
-
* QueueSASSignatureValues is used to help generating Queue service SAS tokens for queues.
|
|
1581
|
-
*/
|
|
1582
|
-
export declare interface QueueSASSignatureValues {
|
|
1583
|
-
/**
|
|
1584
|
-
* The version of the service this SAS will target. If not specified, it will default to the version targeted by the
|
|
1585
|
-
* library.
|
|
1586
|
-
*/
|
|
1587
|
-
version?: string;
|
|
1588
|
-
/**
|
|
1589
|
-
* Optional. SAS protocols, HTTPS only or HTTPSandHTTP
|
|
1590
|
-
*/
|
|
1591
|
-
protocol?: SASProtocol;
|
|
1592
|
-
/**
|
|
1593
|
-
* Optional. When the SAS will take effect.
|
|
1594
|
-
*/
|
|
1595
|
-
startsOn?: Date;
|
|
1596
|
-
/**
|
|
1597
|
-
* Optional only when identifier is provided. The time after which the SAS will no longer work.
|
|
1598
|
-
*/
|
|
1599
|
-
expiresOn?: Date;
|
|
1600
|
-
/**
|
|
1601
|
-
* Optional only when identifier is provided.
|
|
1602
|
-
* Please refer to {@link QueueSASPermissions}
|
|
1603
|
-
* being accessed for help constructing the permissions string.
|
|
1604
|
-
*/
|
|
1605
|
-
permissions?: QueueSASPermissions;
|
|
1606
|
-
/**
|
|
1607
|
-
* Optional. IP ranges allowed in this SAS.
|
|
1608
|
-
*/
|
|
1609
|
-
ipRange?: SasIPRange;
|
|
1610
|
-
/**
|
|
1611
|
-
* The name of the queue the SAS user may access.
|
|
1612
|
-
*/
|
|
1613
|
-
queueName: string;
|
|
1614
|
-
/**
|
|
1615
|
-
* Optional. The name of the access policy on the queue this SAS references if any.
|
|
1616
|
-
*
|
|
1617
|
-
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/establishing-a-stored-access-policy
|
|
1618
|
-
*/
|
|
1619
|
-
identifier?: string;
|
|
1620
|
-
}
|
|
1621
|
-
|
|
1622
|
-
/**
|
|
1623
|
-
* Options to configure {@link QueueClient.sendMessage} operation
|
|
1624
|
-
*/
|
|
1625
|
-
export declare interface QueueSendMessageOptions extends MessagesEnqueueOptionalParams, CommonOptions {
|
|
1626
|
-
/**
|
|
1627
|
-
* An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
|
|
1628
|
-
* For example, use the @azure/abort-controller to create an `AbortSignal`.
|
|
1629
|
-
*/
|
|
1630
|
-
abortSignal?: AbortSignalLike;
|
|
1631
|
-
}
|
|
1632
|
-
|
|
1633
|
-
/**
|
|
1634
|
-
* Contains the response data for the {@link QueueClient.sendMessage} operation.
|
|
1635
|
-
*/
|
|
1636
|
-
export declare type QueueSendMessageResponse = WithResponse<{
|
|
1637
|
-
/**
|
|
1638
|
-
* The ID of the sent Message.
|
|
1639
|
-
*/
|
|
1640
|
-
messageId: string;
|
|
1641
|
-
/**
|
|
1642
|
-
* This value is required to delete the Message.
|
|
1643
|
-
* If deletion fails using this popreceipt then the message has been received
|
|
1644
|
-
* by another client.
|
|
1645
|
-
*/
|
|
1646
|
-
popReceipt: string;
|
|
1647
|
-
/**
|
|
1648
|
-
* The time that the message was inserted into the
|
|
1649
|
-
* Queue.
|
|
1650
|
-
*/
|
|
1651
|
-
insertedOn: Date;
|
|
1652
|
-
/**
|
|
1653
|
-
* The time that the message will expire and be
|
|
1654
|
-
* automatically deleted.
|
|
1655
|
-
*/
|
|
1656
|
-
expiresOn: Date;
|
|
1657
|
-
/**
|
|
1658
|
-
* The time that the message will again become
|
|
1659
|
-
* visible in the Queue.
|
|
1660
|
-
*/
|
|
1661
|
-
nextVisibleOn: Date;
|
|
1662
|
-
} & MessagesEnqueueHeaders, MessagesEnqueueHeaders, EnqueuedMessage[]>;
|
|
1663
|
-
|
|
1664
|
-
/**
|
|
1665
|
-
* A QueueServiceClient represents a URL to the Azure Storage Queue service allowing you
|
|
1666
|
-
* to manipulate queues.
|
|
1667
|
-
*/
|
|
1668
|
-
export declare class QueueServiceClient extends StorageClient {
|
|
1669
|
-
/**
|
|
1670
|
-
* Creates an instance of QueueServiceClient.
|
|
1671
|
-
*
|
|
1672
|
-
* @param connectionString - Account connection string or a SAS connection string of an Azure storage account.
|
|
1673
|
-
* [ Note - Account connection string can only be used in NODE.JS runtime. ]
|
|
1674
|
-
* Account connection string example -
|
|
1675
|
-
* `DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net`
|
|
1676
|
-
* SAS connection string example -
|
|
1677
|
-
* `BlobEndpoint=https://myaccount.blob.core.windows.net/;QueueEndpoint=https://myaccount.queue.core.windows.net/;FileEndpoint=https://myaccount.file.core.windows.net/;TableEndpoint=https://myaccount.table.core.windows.net/;SharedAccessSignature=sasString`
|
|
1678
|
-
* @param options - Options to configure the HTTP pipeline.
|
|
1679
|
-
* @returns A new QueueServiceClient object from the given connection string.
|
|
1680
|
-
*/
|
|
1681
|
-
static fromConnectionString(connectionString: string, options?: StoragePipelineOptions): QueueServiceClient;
|
|
1682
|
-
/**
|
|
1683
|
-
* serviceContext provided by protocol layer.
|
|
1684
|
-
*/
|
|
1685
|
-
private serviceContext;
|
|
1686
|
-
/**
|
|
1687
|
-
* Creates an instance of QueueServiceClient.
|
|
1688
|
-
*
|
|
1689
|
-
* @param url - A URL string pointing to Azure Storage queue service, such as
|
|
1690
|
-
* "https://myaccount.queue.core.windows.net". You can append a SAS
|
|
1691
|
-
* if using AnonymousCredential, such as "https://myaccount.queue.core.windows.net?sasString".
|
|
1692
|
-
* @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.
|
|
1693
|
-
* @param options - Options to configure the HTTP pipeline.
|
|
1694
|
-
*
|
|
1695
|
-
* Example using DefaultAzureCredential from `@azure/identity`:
|
|
1696
|
-
*
|
|
1697
|
-
* ```js
|
|
1698
|
-
* const account = "<account>";
|
|
1699
|
-
*
|
|
1700
|
-
* const credential = new DefaultAzureCredential();
|
|
1701
|
-
*
|
|
1702
|
-
* const queueServiceClient = new QueueServiceClient(
|
|
1703
|
-
* `https://${account}.queue.core.windows.net`,
|
|
1704
|
-
* credential
|
|
1705
|
-
* }
|
|
1706
|
-
* ```
|
|
1707
|
-
*
|
|
1708
|
-
* Example using an account name/key:
|
|
1709
|
-
*
|
|
1710
|
-
* ```js
|
|
1711
|
-
* const account = "<account>";
|
|
1712
|
-
*
|
|
1713
|
-
* const sharedKeyCredential = new StorageSharedKeyCredential(account, "<account key>");
|
|
1714
|
-
*
|
|
1715
|
-
* const queueServiceClient = new QueueServiceClient(
|
|
1716
|
-
* `https://${account}.queue.core.windows.net`,
|
|
1717
|
-
* sharedKeyCredential,
|
|
1718
|
-
* {
|
|
1719
|
-
* retryOptions: { maxTries: 4 }, // Retry options
|
|
1720
|
-
* telemetry: { value: "BasicSample/V11.0.0" } // Customized telemetry string
|
|
1721
|
-
* }
|
|
1722
|
-
* );
|
|
1723
|
-
* ```
|
|
1724
|
-
*/
|
|
1725
|
-
constructor(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions);
|
|
1726
|
-
/**
|
|
1727
|
-
* Creates an instance of QueueServiceClient.
|
|
1728
|
-
*
|
|
1729
|
-
* @param url - A URL string pointing to Azure Storage queue service, such as
|
|
1730
|
-
* "https://myaccount.queue.core.windows.net". You can append a SAS
|
|
1731
|
-
* if using AnonymousCredential, such as "https://myaccount.queue.core.windows.net?sasString".
|
|
1732
|
-
* @param pipeline - Call newPipeline() to create a default
|
|
1733
|
-
* pipeline, or provide a customized pipeline.
|
|
1734
|
-
*/
|
|
1735
|
-
constructor(url: string, pipeline: Pipeline);
|
|
1736
|
-
/**
|
|
1737
|
-
* Creates a {@link QueueClient} object.
|
|
1738
|
-
*
|
|
1739
|
-
* @param queueName -
|
|
1740
|
-
* @returns a new QueueClient
|
|
1741
|
-
*
|
|
1742
|
-
* Example usage:
|
|
1743
|
-
*
|
|
1744
|
-
* ```js
|
|
1745
|
-
* const queueClient = queueServiceClient.getQueueClient("<new queue name>");
|
|
1746
|
-
* const createQueueResponse = await queueClient.create();
|
|
1747
|
-
* ```
|
|
1748
|
-
*/
|
|
1749
|
-
getQueueClient(queueName: string): QueueClient;
|
|
1750
|
-
/**
|
|
1751
|
-
* Returns a list of the queues under the specified account.
|
|
1752
|
-
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/list-queues1
|
|
1753
|
-
*
|
|
1754
|
-
* @param marker - A string value that identifies the portion of
|
|
1755
|
-
* the list of queues to be returned with the next listing operation. The
|
|
1756
|
-
* operation returns the continuationToken value within the response body if the
|
|
1757
|
-
* listing operation did not return all queues remaining to be listed
|
|
1758
|
-
* with the current page. The continuationToken value can be used as the value for
|
|
1759
|
-
* the marker parameter in a subsequent call to request the next page of list
|
|
1760
|
-
* items. The marker value is opaque to the client.
|
|
1761
|
-
* @param options - Options to list queues operation.
|
|
1762
|
-
* @returns Response data for the list queues segment operation.
|
|
1763
|
-
*/
|
|
1764
|
-
private listQueuesSegment;
|
|
1765
|
-
/**
|
|
1766
|
-
* Returns an AsyncIterableIterator for {@link ServiceListQueuesSegmentResponse} objects
|
|
1767
|
-
*
|
|
1768
|
-
* @param marker - A string value that identifies the portion of
|
|
1769
|
-
* the list of queues to be returned with the next listing operation. The
|
|
1770
|
-
* operation returns the continuationToken value within the response body if the
|
|
1771
|
-
* listing operation did not return all queues remaining to be listed
|
|
1772
|
-
* with the current page. The continuationToken value can be used as the value for
|
|
1773
|
-
* the marker parameter in a subsequent call to request the next page of list
|
|
1774
|
-
* items. The marker value is opaque to the client.
|
|
1775
|
-
* @param options - Options to list queues operation.
|
|
1776
|
-
*/
|
|
1777
|
-
private listSegments;
|
|
1778
|
-
/**
|
|
1779
|
-
* Returns an AsyncIterableIterator for {@link QueueItem} objects
|
|
1780
|
-
*
|
|
1781
|
-
* @param options - Options to list queues operation.
|
|
1782
|
-
*/
|
|
1783
|
-
private listItems;
|
|
1784
|
-
/**
|
|
1785
|
-
* Returns an async iterable iterator to list all the queues
|
|
1786
|
-
* under the specified account.
|
|
1787
|
-
*
|
|
1788
|
-
* .byPage() returns an async iterable iterator to list the queues in pages.
|
|
1789
|
-
*
|
|
1790
|
-
* Example using `for await` syntax:
|
|
1791
|
-
*
|
|
1792
|
-
* ```js
|
|
1793
|
-
* let i = 1;
|
|
1794
|
-
* for await (const item of queueServiceClient.listQueues()) {
|
|
1795
|
-
* console.log(`Queue${i}: ${item.name}`);
|
|
1796
|
-
* i++;
|
|
1797
|
-
* }
|
|
1798
|
-
* ```
|
|
1799
|
-
*
|
|
1800
|
-
* Example using `iter.next()`:
|
|
1801
|
-
*
|
|
1802
|
-
* ```js
|
|
1803
|
-
* let i = 1;
|
|
1804
|
-
* let iterator = queueServiceClient.listQueues();
|
|
1805
|
-
* let item = await iterator.next();
|
|
1806
|
-
* while (!item.done) {
|
|
1807
|
-
* console.log(`Queue${i}: ${item.value.name}`);
|
|
1808
|
-
* i++;
|
|
1809
|
-
* item = await iterator.next();
|
|
1810
|
-
* }
|
|
1811
|
-
* ```
|
|
1812
|
-
*
|
|
1813
|
-
* Example using `byPage()`:
|
|
1814
|
-
*
|
|
1815
|
-
* ```js
|
|
1816
|
-
* // passing optional maxPageSize in the page settings
|
|
1817
|
-
* let i = 1;
|
|
1818
|
-
* for await (const item2 of queueServiceClient.listQueues().byPage({ maxPageSize: 20 })) {
|
|
1819
|
-
* if (item2.queueItems) {
|
|
1820
|
-
* for (const queueItem of item2.queueItems) {
|
|
1821
|
-
* console.log(`Queue${i}: ${queueItem.name}`);
|
|
1822
|
-
* i++;
|
|
1823
|
-
* }
|
|
1824
|
-
* }
|
|
1825
|
-
* }
|
|
1826
|
-
* ```
|
|
1827
|
-
*
|
|
1828
|
-
* Example using paging with a marker:
|
|
1829
|
-
*
|
|
1830
|
-
* ```js
|
|
1831
|
-
* let i = 1;
|
|
1832
|
-
* let iterator = queueServiceClient.listQueues().byPage({ maxPageSize: 2 });
|
|
1833
|
-
* let item = (await iterator.next()).value;
|
|
1834
|
-
*
|
|
1835
|
-
* // Prints 2 queue names
|
|
1836
|
-
* if (item.queueItems) {
|
|
1837
|
-
* for (const queueItem of item.queueItems) {
|
|
1838
|
-
* console.log(`Queue${i}: ${queueItem.name}`);
|
|
1839
|
-
* i++;
|
|
1840
|
-
* }
|
|
1841
|
-
* }
|
|
1842
|
-
* // Gets next marker
|
|
1843
|
-
* let marker = item.continuationToken;
|
|
1844
|
-
*
|
|
1845
|
-
* // Passing next marker as continuationToken
|
|
1846
|
-
* iterator = queueServiceClient.listQueues().byPage({ continuationToken: marker, maxPageSize: 10 });
|
|
1847
|
-
* item = (await iterator.next()).value;
|
|
1848
|
-
*
|
|
1849
|
-
* // Prints 10 queue names
|
|
1850
|
-
* if (item.queueItems) {
|
|
1851
|
-
* for (const queueItem of item.queueItems) {
|
|
1852
|
-
* console.log(`Queue${i}: ${queueItem.name}`);
|
|
1853
|
-
* i++;
|
|
1854
|
-
* }
|
|
1855
|
-
* }
|
|
1856
|
-
* ```
|
|
1857
|
-
*
|
|
1858
|
-
* @param options - Options to list queues operation.
|
|
1859
|
-
* @returns An asyncIterableIterator that supports paging.
|
|
1860
|
-
*/
|
|
1861
|
-
listQueues(options?: ServiceListQueuesOptions): PagedAsyncIterableIterator<QueueItem, ServiceListQueuesSegmentResponse>;
|
|
1862
|
-
/**
|
|
1863
|
-
* Gets the properties of a storage account’s Queue service, including properties
|
|
1864
|
-
* for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules.
|
|
1865
|
-
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/get-queue-service-properties
|
|
1866
|
-
*
|
|
1867
|
-
* @param options - Options to get properties operation.
|
|
1868
|
-
* @returns Response data including the queue service properties.
|
|
1869
|
-
*/
|
|
1870
|
-
getProperties(options?: ServiceGetPropertiesOptions): Promise<ServiceGetPropertiesResponse>;
|
|
1871
|
-
/**
|
|
1872
|
-
* Sets properties for a storage account’s Queue service endpoint, including properties
|
|
1873
|
-
* for Storage Analytics, CORS (Cross-Origin Resource Sharing) rules and soft delete settings.
|
|
1874
|
-
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/set-queue-service-properties
|
|
1875
|
-
*
|
|
1876
|
-
* @param properties -
|
|
1877
|
-
* @param options - Options to set properties operation.
|
|
1878
|
-
* @returns Response data for the Set Properties operation.
|
|
1879
|
-
*/
|
|
1880
|
-
setProperties(properties: QueueServiceProperties, options?: ServiceGetPropertiesOptions): Promise<ServiceSetPropertiesResponse>;
|
|
1881
|
-
/**
|
|
1882
|
-
* Retrieves statistics related to replication for the Queue service. It is only
|
|
1883
|
-
* available on the secondary location endpoint when read-access geo-redundant
|
|
1884
|
-
* replication is enabled for the storage account.
|
|
1885
|
-
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/get-queue-service-stats
|
|
1886
|
-
*
|
|
1887
|
-
* @param options - Options to get statistics operation.
|
|
1888
|
-
* @returns Response data for get statistics the operation.
|
|
1889
|
-
*/
|
|
1890
|
-
getStatistics(options?: ServiceGetStatisticsOptions): Promise<ServiceGetStatisticsResponse>;
|
|
1891
|
-
/**
|
|
1892
|
-
* Creates a new queue under the specified account.
|
|
1893
|
-
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/create-queue4
|
|
1894
|
-
*
|
|
1895
|
-
* @param queueName - name of the queue to create
|
|
1896
|
-
* @param options - Options to Queue create operation.
|
|
1897
|
-
* @returns Response data for the Queue create operation.
|
|
1898
|
-
*/
|
|
1899
|
-
createQueue(queueName: string, options?: QueueCreateOptions): Promise<QueueCreateResponse>;
|
|
1900
|
-
/**
|
|
1901
|
-
* Deletes the specified queue permanently.
|
|
1902
|
-
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/delete-queue3
|
|
1903
|
-
*
|
|
1904
|
-
* @param queueName - name of the queue to delete.
|
|
1905
|
-
* @param options - Options to Queue delete operation.
|
|
1906
|
-
* @returns Response data for the Queue delete operation.
|
|
1907
|
-
*/
|
|
1908
|
-
deleteQueue(queueName: string, options?: QueueDeleteOptions): Promise<QueueDeleteResponse>;
|
|
1909
|
-
/**
|
|
1910
|
-
* Only available for QueueServiceClient constructed with a shared key credential.
|
|
1911
|
-
*
|
|
1912
|
-
* Generates an account Shared Access Signature (SAS) URI based on the client properties
|
|
1913
|
-
* and parameters passed in. The SAS is signed by the shared key credential of the client.
|
|
1914
|
-
*
|
|
1915
|
-
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/create-account-sas
|
|
1916
|
-
*
|
|
1917
|
-
* @param expiresOn - Optional. The time at which the shared access signature becomes invalid. Default to an hour later if not specified.
|
|
1918
|
-
* @param permissions - Specifies the list of permissions to be associated with the SAS.
|
|
1919
|
-
* @param resourceTypes - Specifies the resource types associated with the shared access signature.
|
|
1920
|
-
* @param options - Optional parameters.
|
|
1921
|
-
* @returns An account SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.
|
|
1922
|
-
*/
|
|
1923
|
-
generateAccountSasUrl(expiresOn?: Date, permissions?: AccountSASPermissions, resourceTypes?: string, options?: ServiceGenerateAccountSasUrlOptions): string;
|
|
1924
|
-
/**
|
|
1925
|
-
* Only available for QueueServiceClient constructed with a shared key credential.
|
|
1926
|
-
*
|
|
1927
|
-
* Generates string to sign for an account Shared Access Signature (SAS) URI based on the client properties
|
|
1928
|
-
* and parameters passed in. The SAS is signed by the shared key credential of the client.
|
|
1929
|
-
*
|
|
1930
|
-
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/create-account-sas
|
|
1931
|
-
*
|
|
1932
|
-
* @param expiresOn - Optional. The time at which the shared access signature becomes invalid. Default to an hour later if not specified.
|
|
1933
|
-
* @param permissions - Specifies the list of permissions to be associated with the SAS.
|
|
1934
|
-
* @param resourceTypes - Specifies the resource types associated with the shared access signature.
|
|
1935
|
-
* @param options - Optional parameters.
|
|
1936
|
-
* @returns An account SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.
|
|
1937
|
-
*/
|
|
1938
|
-
generateSasStringToSign(expiresOn?: Date, permissions?: AccountSASPermissions, resourceTypes?: string, options?: ServiceGenerateAccountSasUrlOptions): string;
|
|
1939
|
-
}
|
|
1940
|
-
|
|
1941
|
-
/** Storage Service Properties. */
|
|
1942
|
-
export declare interface QueueServiceProperties {
|
|
1943
|
-
/** Azure Analytics Logging settings */
|
|
1944
|
-
queueAnalyticsLogging?: Logging;
|
|
1945
|
-
/** A summary of request statistics grouped by API in hourly aggregates for queues */
|
|
1946
|
-
hourMetrics?: Metrics;
|
|
1947
|
-
/** a summary of request statistics grouped by API in minute aggregates for queues */
|
|
1948
|
-
minuteMetrics?: Metrics;
|
|
1949
|
-
/** The set of CORS rules. */
|
|
1950
|
-
cors?: CorsRule[];
|
|
1951
|
-
}
|
|
1952
|
-
|
|
1953
|
-
/** Stats for the storage service. */
|
|
1954
|
-
export declare interface QueueServiceStatistics {
|
|
1955
|
-
/** Geo-Replication information for the Secondary Storage Service */
|
|
1956
|
-
geoReplication?: GeoReplication;
|
|
1957
|
-
}
|
|
1958
|
-
|
|
1959
|
-
/** Defines headers for Queue_setAccessPolicy operation. */
|
|
1960
|
-
export declare interface QueueSetAccessPolicyHeaders {
|
|
1961
|
-
/** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
|
|
1962
|
-
requestId?: string;
|
|
1963
|
-
/** Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. */
|
|
1964
|
-
version?: string;
|
|
1965
|
-
/** UTC date/time value generated by the service that indicates the time at which the response was initiated */
|
|
1966
|
-
date?: Date;
|
|
1967
|
-
/** If a client request id header is sent in the request, this header will be present in the response with the same value. */
|
|
1968
|
-
clientRequestId?: string;
|
|
1969
|
-
/** Error Code */
|
|
1970
|
-
errorCode?: string;
|
|
1971
|
-
}
|
|
1972
|
-
|
|
1973
|
-
/** Optional parameters. */
|
|
1974
|
-
declare interface QueueSetAccessPolicyOptionalParams extends coreClient.OperationOptions {
|
|
1975
|
-
/** 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> */
|
|
1976
|
-
timeoutInSeconds?: number;
|
|
1977
|
-
/** 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. */
|
|
1978
|
-
requestId?: string;
|
|
1979
|
-
/** the acls for the queue */
|
|
1980
|
-
queueAcl?: SignedIdentifierModel[];
|
|
1981
|
-
}
|
|
1982
|
-
|
|
1983
|
-
/**
|
|
1984
|
-
* Options to configure {@link QueueClient.setAccessPolicy} operation
|
|
1985
|
-
*/
|
|
1986
|
-
export declare interface QueueSetAccessPolicyOptions extends CommonOptions {
|
|
1987
|
-
/**
|
|
1988
|
-
* An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
|
|
1989
|
-
* For example, use the @azure/abort-controller to create an `AbortSignal`.
|
|
1990
|
-
*/
|
|
1991
|
-
abortSignal?: AbortSignalLike;
|
|
1992
|
-
}
|
|
1993
|
-
|
|
1994
|
-
/** Contains response data for the setAccessPolicy operation. */
|
|
1995
|
-
export declare type QueueSetAccessPolicyResponse = WithResponse<QueueSetAccessPolicyHeaders, QueueSetAccessPolicyHeaders>;
|
|
1996
|
-
|
|
1997
|
-
/** Contains response data for the setAccessPolicy operation. */
|
|
1998
|
-
declare type QueueSetAccessPolicyResponse_2 = QueueSetAccessPolicyHeaders;
|
|
1999
|
-
|
|
2000
|
-
/** Defines headers for Queue_setMetadata operation. */
|
|
2001
|
-
export declare interface QueueSetMetadataHeaders {
|
|
2002
|
-
/** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
|
|
2003
|
-
requestId?: string;
|
|
2004
|
-
/** Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. */
|
|
2005
|
-
version?: string;
|
|
2006
|
-
/** UTC date/time value generated by the service that indicates the time at which the response was initiated */
|
|
2007
|
-
date?: Date;
|
|
2008
|
-
/** If a client request id header is sent in the request, this header will be present in the response with the same value. */
|
|
2009
|
-
clientRequestId?: string;
|
|
2010
|
-
/** Error Code */
|
|
2011
|
-
errorCode?: string;
|
|
2012
|
-
}
|
|
2013
|
-
|
|
2014
|
-
/** Optional parameters. */
|
|
2015
|
-
declare interface QueueSetMetadataOptionalParams extends coreClient.OperationOptions {
|
|
2016
|
-
/** 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> */
|
|
2017
|
-
timeoutInSeconds?: number;
|
|
2018
|
-
/** 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. */
|
|
2019
|
-
requestId?: string;
|
|
2020
|
-
/** 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. */
|
|
2021
|
-
metadata?: {
|
|
2022
|
-
[propertyName: string]: string;
|
|
2023
|
-
};
|
|
2024
|
-
}
|
|
2025
|
-
|
|
2026
|
-
/**
|
|
2027
|
-
* Options to configure {@link QueueClient.setMetadata} operation
|
|
2028
|
-
*/
|
|
2029
|
-
export declare interface QueueSetMetadataOptions extends CommonOptions {
|
|
2030
|
-
/**
|
|
2031
|
-
* An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
|
|
2032
|
-
* For example, use the @azure/abort-controller to create an `AbortSignal`.
|
|
2033
|
-
*/
|
|
2034
|
-
abortSignal?: AbortSignalLike;
|
|
2035
|
-
}
|
|
2036
|
-
|
|
2037
|
-
/** Contains response data for the setMetadata operation. */
|
|
2038
|
-
export declare type QueueSetMetadataResponse = WithResponse<QueueSetMetadataHeaders, QueueSetMetadataHeaders>;
|
|
2039
|
-
|
|
2040
|
-
/** Contains response data for the setMetadata operation. */
|
|
2041
|
-
declare type QueueSetMetadataResponse_2 = QueueSetMetadataHeaders;
|
|
2042
|
-
|
|
2043
|
-
/**
|
|
2044
|
-
* Options to configure {@link QueueClient.updateMessage} operation
|
|
2045
|
-
*/
|
|
2046
|
-
export declare interface QueueUpdateMessageOptions extends CommonOptions {
|
|
2047
|
-
/**
|
|
2048
|
-
* An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
|
|
2049
|
-
* For example, use the @azure/abort-controller to create an `AbortSignal`.
|
|
2050
|
-
*/
|
|
2051
|
-
abortSignal?: AbortSignalLike;
|
|
2052
|
-
}
|
|
2053
|
-
|
|
2054
|
-
/**
|
|
2055
|
-
* Contains response data for the {@link QueueClient.updateMessage} operation.
|
|
2056
|
-
*/
|
|
2057
|
-
export declare type QueueUpdateMessageResponse = MessageIdUpdateResponse;
|
|
2058
|
-
|
|
2059
|
-
/**
|
|
2060
|
-
* The object returned in the `receivedMessageItems` array when calling {@link QueueClient.receiveMessages}.
|
|
2061
|
-
*
|
|
2062
|
-
* See: {@link QueueReceiveMessageResponse}
|
|
2063
|
-
*/
|
|
2064
|
-
export declare type ReceivedMessageItem = DequeuedMessageItem;
|
|
2065
|
-
|
|
2066
|
-
export { RequestPolicy as IHttpClient }
|
|
2067
|
-
export { RequestPolicy }
|
|
2068
|
-
|
|
2069
|
-
export { RequestPolicyFactory }
|
|
2070
|
-
|
|
2071
|
-
export { RequestPolicyOptions }
|
|
2072
|
-
|
|
2073
|
-
/**
|
|
2074
|
-
* An object with a simple _response property.
|
|
2075
|
-
*/
|
|
2076
|
-
export declare interface ResponseLike {
|
|
2077
|
-
/**
|
|
2078
|
-
* The underlying HTTP response.
|
|
2079
|
-
*/
|
|
2080
|
-
_response: HttpResponse;
|
|
2081
|
-
}
|
|
2082
|
-
|
|
2083
|
-
/**
|
|
2084
|
-
* An object with a _response property that has body
|
|
2085
|
-
* and headers already parsed into known types.
|
|
2086
|
-
*/
|
|
2087
|
-
export declare interface ResponseWithBody<Headers, Body> {
|
|
2088
|
-
/**
|
|
2089
|
-
* The underlying HTTP response.
|
|
2090
|
-
*/
|
|
2091
|
-
_response: HttpResponse & {
|
|
2092
|
-
/**
|
|
2093
|
-
* The parsed HTTP response headers.
|
|
2094
|
-
*/
|
|
2095
|
-
parsedHeaders: Headers;
|
|
2096
|
-
/**
|
|
2097
|
-
* The response body as text (string format)
|
|
2098
|
-
*/
|
|
2099
|
-
bodyAsText: string;
|
|
2100
|
-
/**
|
|
2101
|
-
* The response body as parsed JSON or XML
|
|
2102
|
-
*/
|
|
2103
|
-
parsedBody: Body;
|
|
2104
|
-
};
|
|
2105
|
-
}
|
|
2106
|
-
|
|
2107
|
-
/**
|
|
2108
|
-
* An object with a _response property that has
|
|
2109
|
-
* headers already parsed into a typed object.
|
|
2110
|
-
*/
|
|
2111
|
-
export declare interface ResponseWithHeaders<Headers> {
|
|
2112
|
-
/**
|
|
2113
|
-
* The underlying HTTP response.
|
|
2114
|
-
*/
|
|
2115
|
-
_response: HttpResponse & {
|
|
2116
|
-
/**
|
|
2117
|
-
* The parsed HTTP response headers.
|
|
2118
|
-
*/
|
|
2119
|
-
parsedHeaders: Headers;
|
|
2120
|
-
};
|
|
2121
|
-
}
|
|
2122
|
-
|
|
2123
|
-
export { RestError }
|
|
2124
|
-
|
|
2125
|
-
/** the retention policy */
|
|
2126
|
-
export declare interface RetentionPolicy {
|
|
2127
|
-
/** Indicates whether a retention policy is enabled for the storage service */
|
|
2128
|
-
enabled: boolean;
|
|
2129
|
-
/** Indicates the number of days that metrics or logging or soft-deleted data should be retained. All data older than this value will be deleted */
|
|
2130
|
-
days?: number;
|
|
2131
|
-
}
|
|
2132
|
-
|
|
2133
|
-
/**
|
|
2134
|
-
* Allowed IP range for a SAS.
|
|
2135
|
-
*/
|
|
2136
|
-
export declare interface SasIPRange {
|
|
2137
|
-
/**
|
|
2138
|
-
* Starting IP address in the IP range.
|
|
2139
|
-
* If end IP doesn't provide, start IP will the only IP allowed.
|
|
2140
|
-
*/
|
|
2141
|
-
start: string;
|
|
2142
|
-
/**
|
|
2143
|
-
* Optional. IP address that ends the IP range.
|
|
2144
|
-
* If not provided, start IP will the only IP allowed.
|
|
2145
|
-
*/
|
|
2146
|
-
end?: string;
|
|
2147
|
-
}
|
|
2148
|
-
|
|
2149
|
-
/**
|
|
2150
|
-
* Protocols for generated SAS.
|
|
2151
|
-
*/
|
|
2152
|
-
export declare enum SASProtocol {
|
|
2153
|
-
/**
|
|
2154
|
-
* Protocol that allows HTTPS only
|
|
2155
|
-
*/
|
|
2156
|
-
Https = "https",
|
|
2157
|
-
/**
|
|
2158
|
-
* Protocol that allows both HTTPS and HTTP
|
|
2159
|
-
*/
|
|
2160
|
-
HttpsAndHttp = "https,http"
|
|
2161
|
-
}
|
|
2162
|
-
|
|
2163
|
-
/**
|
|
2164
|
-
* Represents the components that make up an Azure Storage SAS' query parameters. This type is not constructed directly
|
|
2165
|
-
* by the user; it is only generated by the {@link AccountSASSignatureValues} and {@link QueueSASSignatureValues}
|
|
2166
|
-
* types. Once generated, it can be encoded into a {@link String} and appended to a URL directly (though caution should
|
|
2167
|
-
* be taken here in case there are existing query parameters, which might affect the appropriate means of appending
|
|
2168
|
-
* these query parameters).
|
|
2169
|
-
*
|
|
2170
|
-
* NOTE: Instances of this class are immutable.
|
|
2171
|
-
*/
|
|
2172
|
-
export declare class SASQueryParameters {
|
|
2173
|
-
/**
|
|
2174
|
-
* The storage API version.
|
|
2175
|
-
*/
|
|
2176
|
-
readonly version: string;
|
|
2177
|
-
/**
|
|
2178
|
-
* Optional. The allowed HTTP protocol(s).
|
|
2179
|
-
*/
|
|
2180
|
-
readonly protocol?: SASProtocol;
|
|
2181
|
-
/**
|
|
2182
|
-
* Optional. The start time for this SAS token.
|
|
2183
|
-
*/
|
|
2184
|
-
readonly startsOn?: Date;
|
|
2185
|
-
/**
|
|
2186
|
-
* Optional only when identifier is provided. The expiry time for this SAS token.
|
|
2187
|
-
*/
|
|
2188
|
-
readonly expiresOn?: Date;
|
|
2189
|
-
/**
|
|
2190
|
-
* Optional only when identifier is provided.
|
|
2191
|
-
* Please refer to {@link AccountSASPermissions}, {@link QueueSASPermissions} for more details.
|
|
2192
|
-
*/
|
|
2193
|
-
readonly permissions?: string;
|
|
2194
|
-
/**
|
|
2195
|
-
* Optional. The storage services being accessed (only for Account SAS). Please refer to {@link AccountSASServices}
|
|
2196
|
-
* for more details.
|
|
2197
|
-
*/
|
|
2198
|
-
readonly services?: string;
|
|
2199
|
-
/**
|
|
2200
|
-
* Optional. The storage resource types being accessed (only for Account SAS). Please refer to
|
|
2201
|
-
* {@link AccountSASResourceTypes} for more details.
|
|
2202
|
-
*/
|
|
2203
|
-
readonly resourceTypes?: string;
|
|
2204
|
-
/**
|
|
2205
|
-
* Optional. The signed identifier (only for {@link QueueSASSignatureValues}).
|
|
2206
|
-
*
|
|
2207
|
-
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/establishing-a-stored-access-policy
|
|
2208
|
-
*/
|
|
2209
|
-
readonly identifier?: string;
|
|
2210
|
-
/**
|
|
2211
|
-
* Optional. The storage queue (only for {@link QueueSASSignatureValues}).
|
|
2212
|
-
*/
|
|
2213
|
-
readonly resource?: string;
|
|
2214
|
-
/**
|
|
2215
|
-
* The signature for the SAS token.
|
|
2216
|
-
*/
|
|
2217
|
-
readonly signature: string;
|
|
2218
|
-
/**
|
|
2219
|
-
* Inner value of getter ipRange.
|
|
2220
|
-
*/
|
|
2221
|
-
private readonly ipRangeInner?;
|
|
2222
|
-
/**
|
|
2223
|
-
* Optional. IP range allowed for this SAS.
|
|
2224
|
-
*
|
|
2225
|
-
* @readonly
|
|
2226
|
-
*/
|
|
2227
|
-
get ipRange(): SasIPRange | undefined;
|
|
2228
|
-
/**
|
|
2229
|
-
* Creates an instance of SASQueryParameters.
|
|
2230
|
-
*
|
|
2231
|
-
* @param version - Representing the storage version
|
|
2232
|
-
* @param signature - Representing the signature for the SAS token
|
|
2233
|
-
* @param permissions - Representing the storage permissions
|
|
2234
|
-
* @param services - Representing the storage services being accessed (only for Account SAS)
|
|
2235
|
-
* @param resourceTypes - Representing the storage resource types being accessed (only for Account SAS)
|
|
2236
|
-
* @param protocol - Representing the allowed HTTP protocol(s)
|
|
2237
|
-
* @param startsOn - Representing the start time for this SAS token
|
|
2238
|
-
* @param expiresOn - Representing the expiry time for this SAS token
|
|
2239
|
-
* @param ipRange - Representing the range of valid IP addresses for this SAS token
|
|
2240
|
-
* @param identifier - Representing the signed identifier (only for Service SAS)
|
|
2241
|
-
* @param resource - Representing the storage queue (only for Service SAS)
|
|
2242
|
-
*/
|
|
2243
|
-
constructor(version: string, signature: string, permissions?: string, services?: string, resourceTypes?: string, protocol?: SASProtocol, startsOn?: Date, expiresOn?: Date, ipRange?: SasIPRange, identifier?: string, resource?: string);
|
|
2244
|
-
/**
|
|
2245
|
-
* Encodes all SAS query parameters into a string that can be appended to a URL.
|
|
2246
|
-
*
|
|
2247
|
-
*/
|
|
2248
|
-
toString(): string;
|
|
2249
|
-
/**
|
|
2250
|
-
* A private helper method used to filter and append query key/value pairs into an array.
|
|
2251
|
-
*
|
|
2252
|
-
* @param queries -
|
|
2253
|
-
* @param key -
|
|
2254
|
-
* @param value -
|
|
2255
|
-
*/
|
|
2256
|
-
private tryAppendQueryParameter;
|
|
2257
|
-
}
|
|
2258
|
-
|
|
2259
|
-
/** Interface representing a Service. */
|
|
2260
|
-
declare interface Service {
|
|
2261
|
-
/**
|
|
2262
|
-
* Sets properties for a storage account's Queue service endpoint, including properties for Storage
|
|
2263
|
-
* Analytics and CORS (Cross-Origin Resource Sharing) rules
|
|
2264
|
-
* @param properties The StorageService properties.
|
|
2265
|
-
* @param options The options parameters.
|
|
2266
|
-
*/
|
|
2267
|
-
setProperties(properties: QueueServiceProperties, options?: ServiceSetPropertiesOptionalParams): Promise<ServiceSetPropertiesResponse_2>;
|
|
2268
|
-
/**
|
|
2269
|
-
* gets the properties of a storage account's Queue service, including properties for Storage Analytics
|
|
2270
|
-
* and CORS (Cross-Origin Resource Sharing) rules.
|
|
2271
|
-
* @param options The options parameters.
|
|
2272
|
-
*/
|
|
2273
|
-
getProperties(options?: ServiceGetPropertiesOptionalParams): Promise<ServiceGetPropertiesResponse_2>;
|
|
2274
|
-
/**
|
|
2275
|
-
* Retrieves statistics related to replication for the Queue service. It is only available on the
|
|
2276
|
-
* secondary location endpoint when read-access geo-redundant replication is enabled for the storage
|
|
2277
|
-
* account.
|
|
2278
|
-
* @param options The options parameters.
|
|
2279
|
-
*/
|
|
2280
|
-
getStatistics(options?: ServiceGetStatisticsOptionalParams): Promise<ServiceGetStatisticsResponse_2>;
|
|
2281
|
-
/**
|
|
2282
|
-
* The List Queues Segment operation returns a list of the queues under the specified account
|
|
2283
|
-
* @param options The options parameters.
|
|
2284
|
-
*/
|
|
2285
|
-
listQueuesSegment(options?: ServiceListQueuesSegmentOptionalParams): Promise<ServiceListQueuesSegmentResponse_2>;
|
|
2286
|
-
}
|
|
2287
|
-
|
|
2288
|
-
/**
|
|
2289
|
-
* A subset of `@azure/core-http` ServiceClientOptions
|
|
2290
|
-
*/
|
|
2291
|
-
export declare interface ServiceClientOptions {
|
|
2292
|
-
/**
|
|
2293
|
-
* Optional. Configures the HTTP client to send requests and receive responses.
|
|
2294
|
-
*/
|
|
2295
|
-
httpClient?: RequestPolicy;
|
|
2296
|
-
/**
|
|
2297
|
-
* Optional. Overrides the default policy factories.
|
|
2298
|
-
*/
|
|
2299
|
-
requestPolicyFactories?: RequestPolicyFactory[] | ((defaultRequestPolicyFactories: RequestPolicyFactory[]) => void | RequestPolicyFactory[]);
|
|
2300
|
-
}
|
|
2301
|
-
|
|
2302
|
-
/**
|
|
2303
|
-
* Options to configure {@link QueueServiceClient.generateAccountSasUrl} operation.
|
|
2304
|
-
*/
|
|
2305
|
-
export declare interface ServiceGenerateAccountSasUrlOptions {
|
|
2306
|
-
/**
|
|
2307
|
-
* The version of the service this SAS will target. If not specified, it will default to the version targeted by the
|
|
2308
|
-
* library.
|
|
2309
|
-
*/
|
|
2310
|
-
version?: string;
|
|
2311
|
-
/**
|
|
2312
|
-
* Optional. SAS protocols allowed.
|
|
2313
|
-
*/
|
|
2314
|
-
protocol?: SASProtocol;
|
|
2315
|
-
/**
|
|
2316
|
-
* Optional. When the SAS will take effect.
|
|
2317
|
-
*/
|
|
2318
|
-
startsOn?: Date;
|
|
2319
|
-
/**
|
|
2320
|
-
* Optional. IP range allowed.
|
|
2321
|
-
*/
|
|
2322
|
-
ipRange?: SasIPRange;
|
|
2323
|
-
}
|
|
2324
|
-
|
|
2325
|
-
/** Defines headers for Service_getProperties operation. */
|
|
2326
|
-
export declare interface ServiceGetPropertiesHeaders {
|
|
2327
|
-
/** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
|
|
2328
|
-
requestId?: string;
|
|
2329
|
-
/** Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. */
|
|
2330
|
-
version?: string;
|
|
2331
|
-
/** If a client request id header is sent in the request, this header will be present in the response with the same value. */
|
|
2332
|
-
clientRequestId?: string;
|
|
2333
|
-
/** Error Code */
|
|
2334
|
-
errorCode?: string;
|
|
2335
|
-
}
|
|
2336
|
-
|
|
2337
|
-
/** Optional parameters. */
|
|
2338
|
-
declare interface ServiceGetPropertiesOptionalParams extends coreClient.OperationOptions {
|
|
2339
|
-
/** 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> */
|
|
2340
|
-
timeoutInSeconds?: number;
|
|
2341
|
-
/** 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. */
|
|
2342
|
-
requestId?: string;
|
|
2343
|
-
}
|
|
2344
|
-
|
|
2345
|
-
/**
|
|
2346
|
-
* Options to configure {@link QueueServiceClient.getProperties} operation
|
|
2347
|
-
*/
|
|
2348
|
-
export declare interface ServiceGetPropertiesOptions extends CommonOptions {
|
|
2349
|
-
/**
|
|
2350
|
-
* An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
|
|
2351
|
-
* For example, use the @azure/abort-controller to create an `AbortSignal`.
|
|
2352
|
-
*/
|
|
2353
|
-
abortSignal?: AbortSignalLike;
|
|
2354
|
-
}
|
|
2355
|
-
|
|
2356
|
-
/** Contains response data for the getProperties operation. */
|
|
2357
|
-
export declare type ServiceGetPropertiesResponse = WithResponse<ServiceGetPropertiesHeaders & QueueServiceProperties, ServiceGetPropertiesHeaders, QueueServiceProperties>;
|
|
2358
|
-
|
|
2359
|
-
/** Contains response data for the getProperties operation. */
|
|
2360
|
-
declare type ServiceGetPropertiesResponse_2 = ServiceGetPropertiesHeaders & QueueServiceProperties;
|
|
2361
|
-
|
|
2362
|
-
/** Defines headers for Service_getStatistics operation. */
|
|
2363
|
-
export declare interface ServiceGetStatisticsHeaders {
|
|
2364
|
-
/** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
|
|
2365
|
-
requestId?: string;
|
|
2366
|
-
/** Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. */
|
|
2367
|
-
version?: string;
|
|
2368
|
-
/** UTC date/time value generated by the service that indicates the time at which the response was initiated */
|
|
2369
|
-
date?: Date;
|
|
2370
|
-
/** If a client request id header is sent in the request, this header will be present in the response with the same value. */
|
|
2371
|
-
clientRequestId?: string;
|
|
2372
|
-
/** Error Code */
|
|
2373
|
-
errorCode?: string;
|
|
2374
|
-
}
|
|
2375
|
-
|
|
2376
|
-
/** Optional parameters. */
|
|
2377
|
-
declare interface ServiceGetStatisticsOptionalParams extends coreClient.OperationOptions {
|
|
2378
|
-
/** 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> */
|
|
2379
|
-
timeoutInSeconds?: number;
|
|
2380
|
-
/** 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. */
|
|
2381
|
-
requestId?: string;
|
|
2382
|
-
}
|
|
2383
|
-
|
|
2384
|
-
/**
|
|
2385
|
-
* Options to configure {@link QueueServiceClient.getStatistics} operation
|
|
2386
|
-
*/
|
|
2387
|
-
export declare interface ServiceGetStatisticsOptions extends CommonOptions {
|
|
2388
|
-
/**
|
|
2389
|
-
* An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
|
|
2390
|
-
* For example, use the @azure/abort-controller to create an `AbortSignal`.
|
|
2391
|
-
*/
|
|
2392
|
-
abortSignal?: AbortSignalLike;
|
|
2393
|
-
}
|
|
2394
|
-
|
|
2395
|
-
/** Contains response data for the getStatistics operation. */
|
|
2396
|
-
export declare type ServiceGetStatisticsResponse = WithResponse<ServiceGetStatisticsHeaders & QueueServiceStatistics, ServiceGetStatisticsHeaders, QueueServiceStatistics>;
|
|
2397
|
-
|
|
2398
|
-
/** Contains response data for the getStatistics operation. */
|
|
2399
|
-
declare type ServiceGetStatisticsResponse_2 = ServiceGetStatisticsHeaders & QueueServiceStatistics;
|
|
2400
|
-
|
|
2401
|
-
/**
|
|
2402
|
-
* Options to configure {@link QueueServiceClient.listQueues} operation
|
|
2403
|
-
*/
|
|
2404
|
-
export declare interface ServiceListQueuesOptions extends CommonOptions {
|
|
2405
|
-
/**
|
|
2406
|
-
* An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
|
|
2407
|
-
* For example, use the @azure/abort-controller to create an `AbortSignal`.
|
|
2408
|
-
*/
|
|
2409
|
-
abortSignal?: AbortSignalLike;
|
|
2410
|
-
/**
|
|
2411
|
-
* Filters the results to return only queues
|
|
2412
|
-
* whose name begins with the specified prefix.
|
|
2413
|
-
*/
|
|
2414
|
-
prefix?: string;
|
|
2415
|
-
/**
|
|
2416
|
-
* Specifies whether the queue's metadata be returned as part of the response
|
|
2417
|
-
* body.
|
|
2418
|
-
*/
|
|
2419
|
-
includeMetadata?: boolean;
|
|
2420
|
-
}
|
|
2421
|
-
|
|
2422
|
-
/** Defines headers for Service_listQueuesSegment operation. */
|
|
2423
|
-
export declare interface ServiceListQueuesSegmentHeaders {
|
|
2424
|
-
/** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
|
|
2425
|
-
requestId?: string;
|
|
2426
|
-
/** Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. */
|
|
2427
|
-
version?: string;
|
|
2428
|
-
/** UTC date/time value generated by the service that indicates the time at which the response was initiated */
|
|
2429
|
-
date?: Date;
|
|
2430
|
-
/** If a client request id header is sent in the request, this header will be present in the response with the same value. */
|
|
2431
|
-
clientRequestId?: string;
|
|
2432
|
-
/** Error Code */
|
|
2433
|
-
errorCode?: string;
|
|
2434
|
-
}
|
|
2435
|
-
|
|
2436
|
-
/** Optional parameters. */
|
|
2437
|
-
declare interface ServiceListQueuesSegmentOptionalParams extends coreClient.OperationOptions {
|
|
2438
|
-
/** 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> */
|
|
2439
|
-
timeoutInSeconds?: number;
|
|
2440
|
-
/** 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. */
|
|
2441
|
-
requestId?: string;
|
|
2442
|
-
/** Filters the results to return only queues whose name begins with the specified prefix. */
|
|
2443
|
-
prefix?: string;
|
|
2444
|
-
/** 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. */
|
|
2445
|
-
marker?: string;
|
|
2446
|
-
/** 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. */
|
|
2447
|
-
maxPageSize?: number;
|
|
2448
|
-
/** Include this parameter to specify that the queues' metadata be returned as part of the response body. */
|
|
2449
|
-
include?: string[];
|
|
2450
|
-
}
|
|
2451
|
-
|
|
2452
|
-
/** Contains response data for the listQueuesSegment operation. */
|
|
2453
|
-
export declare type ServiceListQueuesSegmentResponse = WithResponse<ServiceListQueuesSegmentHeaders & ListQueuesSegmentResponse, ServiceListQueuesSegmentHeaders, ListQueuesSegmentResponse>;
|
|
2454
|
-
|
|
2455
|
-
/** Contains response data for the listQueuesSegment operation. */
|
|
2456
|
-
declare type ServiceListQueuesSegmentResponse_2 = ServiceListQueuesSegmentHeaders & ListQueuesSegmentResponse;
|
|
2457
|
-
|
|
2458
|
-
/** Defines headers for Service_setProperties operation. */
|
|
2459
|
-
export declare interface ServiceSetPropertiesHeaders {
|
|
2460
|
-
/** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
|
|
2461
|
-
requestId?: string;
|
|
2462
|
-
/** Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. */
|
|
2463
|
-
version?: string;
|
|
2464
|
-
/** If a client request id header is sent in the request, this header will be present in the response with the same value. */
|
|
2465
|
-
clientRequestId?: string;
|
|
2466
|
-
/** Error Code */
|
|
2467
|
-
errorCode?: string;
|
|
2468
|
-
}
|
|
2469
|
-
|
|
2470
|
-
/** Optional parameters. */
|
|
2471
|
-
declare interface ServiceSetPropertiesOptionalParams extends coreClient.OperationOptions {
|
|
2472
|
-
/** 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> */
|
|
2473
|
-
timeoutInSeconds?: number;
|
|
2474
|
-
/** 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. */
|
|
2475
|
-
requestId?: string;
|
|
2476
|
-
}
|
|
2477
|
-
|
|
2478
|
-
/**
|
|
2479
|
-
* Options to configure {@link QueueServiceClient.setProperties} operation
|
|
2480
|
-
*/
|
|
2481
|
-
export declare interface ServiceSetPropertiesOptions extends CommonOptions {
|
|
2482
|
-
/**
|
|
2483
|
-
* An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
|
|
2484
|
-
* For example, use the @azure/abort-controller to create an `AbortSignal`.
|
|
2485
|
-
*/
|
|
2486
|
-
abortSignal?: AbortSignalLike;
|
|
2487
|
-
}
|
|
2488
|
-
|
|
2489
|
-
/** Contains response data for the setProperties operation. */
|
|
2490
|
-
export declare type ServiceSetPropertiesResponse = WithResponse<ServiceSetPropertiesHeaders, ServiceSetPropertiesHeaders>;
|
|
2491
|
-
|
|
2492
|
-
/** Contains response data for the setProperties operation. */
|
|
2493
|
-
declare type ServiceSetPropertiesResponse_2 = ServiceSetPropertiesHeaders;
|
|
2494
|
-
|
|
2495
|
-
/**
|
|
2496
|
-
* Signed identifier.
|
|
2497
|
-
*/
|
|
2498
|
-
export declare interface SignedIdentifier {
|
|
2499
|
-
/**
|
|
2500
|
-
* a unique id
|
|
2501
|
-
*/
|
|
2502
|
-
id: string;
|
|
2503
|
-
/**
|
|
2504
|
-
* Access Policy
|
|
2505
|
-
*/
|
|
2506
|
-
accessPolicy: {
|
|
2507
|
-
/**
|
|
2508
|
-
* the date-time the policy is active.
|
|
2509
|
-
*/
|
|
2510
|
-
startsOn?: Date;
|
|
2511
|
-
/**
|
|
2512
|
-
* the date-time the policy expires.
|
|
2513
|
-
*/
|
|
2514
|
-
expiresOn?: Date;
|
|
2515
|
-
/**
|
|
2516
|
-
* the permissions for the acl policy
|
|
2517
|
-
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/set-queue-acl
|
|
2518
|
-
*/
|
|
2519
|
-
permissions?: string;
|
|
2520
|
-
};
|
|
2521
|
-
}
|
|
2522
|
-
|
|
2523
|
-
/** signed identifier */
|
|
2524
|
-
export declare interface SignedIdentifierModel {
|
|
2525
|
-
/** a unique id */
|
|
2526
|
-
id: string;
|
|
2527
|
-
/** The access policy */
|
|
2528
|
-
accessPolicy: AccessPolicy;
|
|
2529
|
-
}
|
|
2530
|
-
|
|
2531
|
-
/**
|
|
2532
|
-
* StorageBrowserPolicy will handle differences between Node.js and browser runtime, including:
|
|
2533
|
-
*
|
|
2534
|
-
* 1. Browsers cache GET/HEAD requests by adding conditional headers such as 'IF_MODIFIED_SINCE'.
|
|
2535
|
-
* StorageBrowserPolicy is a policy used to add a timestamp query to GET/HEAD request URL
|
|
2536
|
-
* thus avoid the browser cache.
|
|
2537
|
-
*
|
|
2538
|
-
* 2. Remove cookie header for security
|
|
2539
|
-
*
|
|
2540
|
-
* 3. Remove content-length header to avoid browsers warning
|
|
2541
|
-
*/
|
|
2542
|
-
export declare class StorageBrowserPolicy extends BaseRequestPolicy {
|
|
2543
|
-
/**
|
|
2544
|
-
* Creates an instance of StorageBrowserPolicy.
|
|
2545
|
-
* @param nextPolicy -
|
|
2546
|
-
* @param options -
|
|
2547
|
-
*/
|
|
2548
|
-
constructor(nextPolicy: RequestPolicy, options: RequestPolicyOptions);
|
|
2549
|
-
/**
|
|
2550
|
-
* Sends out request.
|
|
2551
|
-
*
|
|
2552
|
-
* @param request -
|
|
2553
|
-
*/
|
|
2554
|
-
sendRequest(request: WebResource): Promise<HttpOperationResponse>;
|
|
2555
|
-
}
|
|
2556
|
-
|
|
2557
|
-
/**
|
|
2558
|
-
* StorageBrowserPolicyFactory is a factory class helping generating StorageBrowserPolicy objects.
|
|
2559
|
-
*/
|
|
2560
|
-
export declare class StorageBrowserPolicyFactory implements RequestPolicyFactory {
|
|
2561
|
-
/**
|
|
2562
|
-
* Creates a StorageBrowserPolicyFactory object.
|
|
2563
|
-
*
|
|
2564
|
-
* @param nextPolicy -
|
|
2565
|
-
* @param options -
|
|
2566
|
-
*/
|
|
2567
|
-
create(nextPolicy: RequestPolicy, options: RequestPolicyOptions): StorageBrowserPolicy;
|
|
2568
|
-
}
|
|
2569
|
-
|
|
2570
|
-
/**
|
|
2571
|
-
* A StorageClient represents a based client class for {@link QueueServiceClient}, {@link QueueClient} and etc.
|
|
2572
|
-
*/
|
|
2573
|
-
declare abstract class StorageClient {
|
|
2574
|
-
/**
|
|
2575
|
-
* URL string value.
|
|
2576
|
-
*/
|
|
2577
|
-
readonly url: string;
|
|
2578
|
-
readonly accountName: string;
|
|
2579
|
-
/* Excluded from this release type: pipeline */
|
|
2580
|
-
/* Excluded from this release type: credential */
|
|
2581
|
-
/**
|
|
2582
|
-
* StorageClientContext is a reference to protocol layer operations entry, which is
|
|
2583
|
-
* generated by AutoRest generator.
|
|
2584
|
-
*/
|
|
2585
|
-
protected readonly storageClientContext: StorageClient_2;
|
|
2586
|
-
/**
|
|
2587
|
-
* Creates an instance of StorageClient.
|
|
2588
|
-
* @param url -
|
|
2589
|
-
* @param pipeline -
|
|
2590
|
-
*/
|
|
2591
|
-
protected constructor(url: string, pipeline: Pipeline);
|
|
2592
|
-
}
|
|
2593
|
-
|
|
2594
|
-
declare class StorageClient_2 extends coreHttpCompat.ExtendedServiceClient {
|
|
2595
|
-
url: string;
|
|
2596
|
-
version: string;
|
|
2597
|
-
/**
|
|
2598
|
-
* Initializes a new instance of the StorageClient class.
|
|
2599
|
-
* @param url The URL of the service account, queue or message that is the target of the desired
|
|
2600
|
-
* operation.
|
|
2601
|
-
* @param options The parameter options
|
|
2602
|
-
*/
|
|
2603
|
-
constructor(url: string, options?: StorageClientOptionalParams);
|
|
2604
|
-
service: Service;
|
|
2605
|
-
queue: Queue;
|
|
2606
|
-
messages: Messages;
|
|
2607
|
-
messageId: MessageId;
|
|
2608
|
-
}
|
|
2609
|
-
|
|
2610
|
-
/** Optional parameters. */
|
|
2611
|
-
declare interface StorageClientOptionalParams extends coreHttpCompat.ExtendedServiceClientOptions {
|
|
2612
|
-
/** Specifies the version of the operation to use for this request. */
|
|
2613
|
-
version?: string;
|
|
2614
|
-
/** Overrides client endpoint. */
|
|
2615
|
-
endpoint?: string;
|
|
2616
|
-
}
|
|
2617
|
-
|
|
2618
|
-
/**
|
|
2619
|
-
* The OAuth scope to use with Azure Storage.
|
|
2620
|
-
*/
|
|
2621
|
-
export declare const StorageOAuthScopes: string | string[];
|
|
2622
|
-
|
|
2623
|
-
/**
|
|
2624
|
-
* Options interface for the {@link newPipeline} function.
|
|
2625
|
-
*/
|
|
2626
|
-
export declare interface StoragePipelineOptions {
|
|
2627
|
-
/**
|
|
2628
|
-
* Options to configure a proxy for outgoing requests.
|
|
2629
|
-
*/
|
|
2630
|
-
proxyOptions?: ProxySettings;
|
|
2631
|
-
/**
|
|
2632
|
-
* Options for adding user agent details to outgoing requests.
|
|
2633
|
-
*/
|
|
2634
|
-
userAgentOptions?: UserAgentPolicyOptions;
|
|
2635
|
-
/**
|
|
2636
|
-
* Configures the built-in retry policy behavior.
|
|
2637
|
-
*/
|
|
2638
|
-
retryOptions?: StorageRetryOptions;
|
|
2639
|
-
/**
|
|
2640
|
-
* Keep alive configurations. Default keep-alive is enabled.
|
|
2641
|
-
*/
|
|
2642
|
-
keepAliveOptions?: KeepAliveOptions;
|
|
2643
|
-
/**
|
|
2644
|
-
* Configures the HTTP client to send requests and receive responses.
|
|
2645
|
-
*/
|
|
2646
|
-
httpClient?: RequestPolicy;
|
|
2647
|
-
/**
|
|
2648
|
-
* The audience used to retrieve an AAD token.
|
|
2649
|
-
* By default, audience 'https://storage.azure.com/.default' will be used.
|
|
2650
|
-
*/
|
|
2651
|
-
audience?: string;
|
|
2652
|
-
}
|
|
2653
|
-
|
|
2654
|
-
/**
|
|
2655
|
-
* Defines the known cloud audiences for Storage.
|
|
2656
|
-
*/
|
|
2657
|
-
export declare enum StorageQueueAudience {
|
|
2658
|
-
/**
|
|
2659
|
-
* The OAuth scope to use to retrieve an AAD token for Azure Storage.
|
|
2660
|
-
*/
|
|
2661
|
-
StorageOAuthScopes = "https://storage.azure.com/.default"
|
|
2662
|
-
}
|
|
2663
|
-
|
|
2664
|
-
/**
|
|
2665
|
-
* Storage Blob retry options interface.
|
|
2666
|
-
*/
|
|
2667
|
-
export declare interface StorageRetryOptions {
|
|
2668
|
-
/**
|
|
2669
|
-
* Optional. StorageRetryPolicyType, default is exponential retry policy.
|
|
2670
|
-
*/
|
|
2671
|
-
readonly retryPolicyType?: StorageRetryPolicyType;
|
|
2672
|
-
/**
|
|
2673
|
-
* Optional. Max try number of attempts, default is 4.
|
|
2674
|
-
* A value of 1 means 1 try and no retries.
|
|
2675
|
-
* A value smaller than 1 means default retry number of attempts.
|
|
2676
|
-
*/
|
|
2677
|
-
readonly maxTries?: number;
|
|
2678
|
-
/**
|
|
2679
|
-
* Optional. Indicates the maximum time in ms allowed for any single try of an HTTP request.
|
|
2680
|
-
* A value of zero or undefined means no default timeout on SDK client, Azure
|
|
2681
|
-
* Storage server's default timeout policy will be used.
|
|
2682
|
-
*
|
|
2683
|
-
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-blob-service-operations
|
|
2684
|
-
*/
|
|
2685
|
-
readonly tryTimeoutInMs?: number;
|
|
2686
|
-
/**
|
|
2687
|
-
* Optional. Specifies the amount of delay to use before retrying an operation (default is 4s or 4 * 1000ms).
|
|
2688
|
-
* The delay increases (exponentially or linearly) with each retry up to a maximum specified by
|
|
2689
|
-
* maxRetryDelayInMs. If you specify 0, then you must also specify 0 for maxRetryDelayInMs.
|
|
2690
|
-
*/
|
|
2691
|
-
readonly retryDelayInMs?: number;
|
|
2692
|
-
/**
|
|
2693
|
-
* Optional. Specifies the maximum delay allowed before retrying an operation (default is 120s or 120 * 1000ms).
|
|
2694
|
-
* If you specify 0, then you must also specify 0 for retryDelayInMs.
|
|
2695
|
-
*/
|
|
2696
|
-
readonly maxRetryDelayInMs?: number;
|
|
2697
|
-
/**
|
|
2698
|
-
* If a secondaryHost is specified, retries will be tried against this host. If secondaryHost is undefined
|
|
2699
|
-
* (the default) then operations are not retried against another host.
|
|
2700
|
-
*
|
|
2701
|
-
* NOTE: Before setting this field, make sure you understand the issues around
|
|
2702
|
-
* reading stale and potentially-inconsistent data at
|
|
2703
|
-
* {@link https://learn.microsoft.com/en-us/azure/storage/common/storage-designing-ha-apps-with-ragrs}
|
|
2704
|
-
*/
|
|
2705
|
-
readonly secondaryHost?: string;
|
|
2706
|
-
}
|
|
2707
|
-
|
|
2708
|
-
/**
|
|
2709
|
-
* Retry policy with exponential retry and linear retry implemented.
|
|
2710
|
-
*/
|
|
2711
|
-
export declare class StorageRetryPolicy extends BaseRequestPolicy {
|
|
2712
|
-
/**
|
|
2713
|
-
* RetryOptions.
|
|
2714
|
-
*/
|
|
2715
|
-
private readonly retryOptions;
|
|
2716
|
-
/**
|
|
2717
|
-
* Creates an instance of RetryPolicy.
|
|
2718
|
-
*
|
|
2719
|
-
* @param nextPolicy -
|
|
2720
|
-
* @param options -
|
|
2721
|
-
* @param retryOptions -
|
|
2722
|
-
*/
|
|
2723
|
-
constructor(nextPolicy: RequestPolicy, options: RequestPolicyOptions, retryOptions?: StorageRetryOptions);
|
|
2724
|
-
/**
|
|
2725
|
-
* Sends request.
|
|
2726
|
-
*
|
|
2727
|
-
* @param request -
|
|
2728
|
-
*/
|
|
2729
|
-
sendRequest(request: WebResource): Promise<HttpOperationResponse>;
|
|
2730
|
-
/**
|
|
2731
|
-
* Decide and perform next retry. Won't mutate request parameter.
|
|
2732
|
-
*
|
|
2733
|
-
* @param request -
|
|
2734
|
-
* @param secondaryHas404 - If attempt was against the secondary & it returned a StatusNotFound (404), then
|
|
2735
|
-
* the resource was not found. This may be due to replication delay. So, in this
|
|
2736
|
-
* case, we'll never try the secondary again for this operation.
|
|
2737
|
-
* @param attempt - How many retries has been attempted to performed, starting from 1, which includes
|
|
2738
|
-
* the attempt will be performed by this method call.
|
|
2739
|
-
*/
|
|
2740
|
-
protected attemptSendRequest(request: WebResource, secondaryHas404: boolean, attempt: number): Promise<HttpOperationResponse>;
|
|
2741
|
-
/**
|
|
2742
|
-
* Decide whether to retry according to last HTTP response and retry counters.
|
|
2743
|
-
*
|
|
2744
|
-
* @param isPrimaryRetry -
|
|
2745
|
-
* @param attempt -
|
|
2746
|
-
* @param response -
|
|
2747
|
-
* @param err -
|
|
2748
|
-
*/
|
|
2749
|
-
protected shouldRetry(isPrimaryRetry: boolean, attempt: number, response?: HttpOperationResponse, err?: RestError): boolean;
|
|
2750
|
-
/**
|
|
2751
|
-
* Delay a calculated time between retries.
|
|
2752
|
-
*
|
|
2753
|
-
* @param isPrimaryRetry -
|
|
2754
|
-
* @param attempt -
|
|
2755
|
-
* @param abortSignal -
|
|
2756
|
-
*/
|
|
2757
|
-
private delay;
|
|
2758
|
-
}
|
|
2759
|
-
|
|
2760
|
-
/**
|
|
2761
|
-
* StorageRetryPolicyFactory is a factory class helping generating {@link StorageRetryPolicy} objects.
|
|
2762
|
-
*/
|
|
2763
|
-
export declare class StorageRetryPolicyFactory implements RequestPolicyFactory {
|
|
2764
|
-
private retryOptions?;
|
|
2765
|
-
/**
|
|
2766
|
-
* Creates an instance of StorageRetryPolicyFactory.
|
|
2767
|
-
* @param retryOptions -
|
|
2768
|
-
*/
|
|
2769
|
-
constructor(retryOptions?: StorageRetryOptions);
|
|
2770
|
-
/**
|
|
2771
|
-
* Creates a StorageRetryPolicy object.
|
|
2772
|
-
*
|
|
2773
|
-
* @param nextPolicy -
|
|
2774
|
-
* @param options -
|
|
2775
|
-
*/
|
|
2776
|
-
create(nextPolicy: RequestPolicy, options: RequestPolicyOptions): StorageRetryPolicy;
|
|
2777
|
-
}
|
|
2778
|
-
|
|
2779
|
-
/**
|
|
2780
|
-
* RetryPolicy types.
|
|
2781
|
-
*/
|
|
2782
|
-
export declare enum StorageRetryPolicyType {
|
|
2783
|
-
/**
|
|
2784
|
-
* Exponential retry. Retry time delay grows exponentially.
|
|
2785
|
-
*/
|
|
2786
|
-
EXPONENTIAL = 0,
|
|
2787
|
-
/**
|
|
2788
|
-
* Linear retry. Retry time delay grows linearly.
|
|
2789
|
-
*/
|
|
2790
|
-
FIXED = 1
|
|
2791
|
-
}
|
|
2792
|
-
|
|
2793
|
-
/**
|
|
2794
|
-
* ONLY AVAILABLE IN NODE.JS RUNTIME.
|
|
2795
|
-
*
|
|
2796
|
-
* StorageSharedKeyCredential for account key authorization of Azure Storage service.
|
|
2797
|
-
*/
|
|
2798
|
-
export declare class StorageSharedKeyCredential extends Credential_2 {
|
|
2799
|
-
/**
|
|
2800
|
-
* Azure Storage account name; readonly.
|
|
2801
|
-
*/
|
|
2802
|
-
readonly accountName: string;
|
|
2803
|
-
/**
|
|
2804
|
-
* Azure Storage account key; readonly.
|
|
2805
|
-
*/
|
|
2806
|
-
private readonly accountKey;
|
|
2807
|
-
/**
|
|
2808
|
-
* Creates an instance of StorageSharedKeyCredential.
|
|
2809
|
-
* @param accountName -
|
|
2810
|
-
* @param accountKey -
|
|
2811
|
-
*/
|
|
2812
|
-
constructor(accountName: string, accountKey: string);
|
|
2813
|
-
/**
|
|
2814
|
-
* Creates a StorageSharedKeyCredentialPolicy object.
|
|
2815
|
-
*
|
|
2816
|
-
* @param nextPolicy -
|
|
2817
|
-
* @param options -
|
|
2818
|
-
*/
|
|
2819
|
-
create(nextPolicy: RequestPolicy, options: RequestPolicyOptions): StorageSharedKeyCredentialPolicy;
|
|
2820
|
-
/**
|
|
2821
|
-
* Generates a hash signature for an HTTP request or for a SAS.
|
|
2822
|
-
*
|
|
2823
|
-
* @param stringToSign -
|
|
2824
|
-
*/
|
|
2825
|
-
computeHMACSHA256(stringToSign: string): string;
|
|
2826
|
-
}
|
|
2827
|
-
|
|
2828
|
-
/**
|
|
2829
|
-
* StorageSharedKeyCredentialPolicy is a policy used to sign HTTP request with a shared key.
|
|
2830
|
-
*/
|
|
2831
|
-
export declare class StorageSharedKeyCredentialPolicy extends CredentialPolicy {
|
|
2832
|
-
/**
|
|
2833
|
-
* Reference to StorageSharedKeyCredential which generates StorageSharedKeyCredentialPolicy
|
|
2834
|
-
*/
|
|
2835
|
-
private readonly factory;
|
|
2836
|
-
/**
|
|
2837
|
-
* Creates an instance of StorageSharedKeyCredentialPolicy.
|
|
2838
|
-
* @param nextPolicy -
|
|
2839
|
-
* @param options -
|
|
2840
|
-
* @param factory -
|
|
2841
|
-
*/
|
|
2842
|
-
constructor(nextPolicy: RequestPolicy, options: RequestPolicyOptions, factory: StorageSharedKeyCredential);
|
|
2843
|
-
/**
|
|
2844
|
-
* Signs request.
|
|
2845
|
-
*
|
|
2846
|
-
* @param request -
|
|
2847
|
-
*/
|
|
2848
|
-
protected signRequest(request: WebResource): WebResource;
|
|
2849
|
-
/**
|
|
2850
|
-
* Retrieve header value according to shared key sign rules.
|
|
2851
|
-
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/authenticate-with-shared-key
|
|
2852
|
-
*
|
|
2853
|
-
* @param request -
|
|
2854
|
-
* @param headerName -
|
|
2855
|
-
*/
|
|
2856
|
-
private getHeaderValueToSign;
|
|
2857
|
-
/**
|
|
2858
|
-
* To construct the CanonicalizedHeaders portion of the signature string, follow these steps:
|
|
2859
|
-
* 1. Retrieve all headers for the resource that begin with x-ms-, including the x-ms-date header.
|
|
2860
|
-
* 2. Convert each HTTP header name to lowercase.
|
|
2861
|
-
* 3. Sort the headers lexicographically by header name, in ascending order.
|
|
2862
|
-
* Each header may appear only once in the string.
|
|
2863
|
-
* 4. Replace any linear whitespace in the header value with a single space.
|
|
2864
|
-
* 5. Trim any whitespace around the colon in the header.
|
|
2865
|
-
* 6. Finally, append a new-line character to each canonicalized header in the resulting list.
|
|
2866
|
-
* Construct the CanonicalizedHeaders string by concatenating all headers in this list into a single string.
|
|
2867
|
-
*
|
|
2868
|
-
* @param request -
|
|
2869
|
-
*/
|
|
2870
|
-
private getCanonicalizedHeadersString;
|
|
2871
|
-
/**
|
|
2872
|
-
* Retrieves the webResource canonicalized resource string.
|
|
2873
|
-
*
|
|
2874
|
-
* @param request -
|
|
2875
|
-
*/
|
|
2876
|
-
private getCanonicalizedResourceString;
|
|
2877
|
-
}
|
|
2878
|
-
|
|
2879
|
-
export { WebResource }
|
|
2880
|
-
|
|
2881
|
-
/**
|
|
2882
|
-
* A type that represents an operation result with a known _response property.
|
|
2883
|
-
*/
|
|
2884
|
-
export declare type WithResponse<T, Headers = undefined, Body = undefined> = T & (Body extends object ? ResponseWithBody<Headers, Body> : Headers extends object ? ResponseWithHeaders<Headers> : ResponseLike);
|
|
2885
|
-
|
|
2886
|
-
export { }
|