CHANGELOG.md

Release History

12.11.0 (2022-10-14)

Features

• Added support for service version 2021-10-04.

Bugs Fixed

• Refined URL parsing method to let it be able to correctly parse URLs with account name in path.

12.10.0 (2022-07-08)

Features Added

• Added support for service version 2021-08-06.

12.9.0 (2022-05-12)

Features Added

• Added support for service version 2021-06-08.

Bugs Fixed

• Add react-native mapping to ESM entry point
• Fixed a bug where customized ProxyOptions is overwrited by a default one when initializing QueueServiceClient or QueueClient with connection string.
• Refined user-agent value to avoid failure when os information is not available on some platforms.

12.8.0 (2022-03-11)

Features Added

• Added support for service version 2021-04-10.

Bugs Fixed

• Fixed a bug where customized ProxyOptions is overwrited by a default one when initializing QueueServiceClient or QueueClient with connection string.

12.8.0-beta.1 (2021-11-09)

Features Added

• Added support for service version 2020-12-06.

12.7.0 (2021-09-10)

Features Added

• Added support for service version 2020-10-02.
• With the dropping of support for Node.js versions that are no longer in LTS, the dependency on @types/node has been updated to version 12. Read our support policy for more details.

12.6.0 (2021-08-02)

• Support for Node.js 8 and IE 11 has been dropped. Please see our support policy for more details.
• Changed TS compilation target to ES2017 in order to produce smaller bundles and use more native platform features
• Updated our internal core package dependencies to their latest versions in order to add support for Opentelemetry 1.0.0 which is compatible with the latest versions of our other client libraries.

12.5.0 (2021-06-09)

• Updated Azure Storage Service API version to 2020-08-04.

12.4.0 (2021-03-10)

• Updated Azure Storage Service API version to 2020-06-12.

12.3.1 (2021-02-03)

• The "Unclosed root tag" XML parser error is now retriable. PR #13076.

12.3.0 (2021-01-12)

• This release contains bug fixes to improve quality.

12.3.0-beta.1 (2020-12-09)

• Updated Azure Storage Service API version to 2020-04-08.
• Added generateSasUrl to QueueClient to generate a service-level SAS URI for the client.
• Added generateAccountSasUrl to QueueServiceClient to generate an account-level SAS URI for the client.
• Won't remove the first space in the userAgentOptions.userAgentPrefix passed to the newPipeline() now. Fixed bug 7536.

12.2.0 (2020-11-10)

• Updated Azure Storage Service API version to 2020-02-10.

12.1.0 (2020-09-08)

• Bug fix - credential parameter of newPipeline() function is now optional. If not specified, AnonymousCredential is used. Fixes bug 9628.
• Bug fix - Content-Length header is no more ignored. Fixes bugs 8903, 9300 and 10614.

12.1.0-preview.1 (2020-07-03)

• Updated Azure Storage Service API version to 2019-12-12.
• Added exists, createIfNotExists and deleteIfExists to QueueClient.

12.0.5 (2020-05-20)

• Fix un-handled TypeError issue #8499 in Electron applications. PR #8568
• Updated to use @opentelemetry/api 0.6.1 via @azure/core-tracing. PR #7998
• Updated to use typescript 3.8.3. PR #8659

12.0.4 (2020-03-12)

• Buf fix - Fixed typings support for TypeScript 3.1. PR #7350

12.0.3 (2020-02-11)

• Updated Azure Storage Service API version to 2019-07-07.

12.0.2 (2020-01-09)

• Bug fix - Name properties on clients now support more kinds of endpoints(IPv4/v6 hosts, single word domains). PR #6694

• Service clients now share a single http client instance by default. PR #6657

  Previously, a new http client was created for each service client if none was provided by the user. This could result in TCP port exhaustion under heavy usage with the keepAlive option enabled because each http client has its own persistent TCP connection. This change creates a single http client instance which is shared among all service clients by default.

12.0.1 (2019-12-04)

• Updated to use OpenTelemetry 0.2 via @azure/core-tracing
• Bug Fix - Convert empty prefixes ("") to undefined when passed as options to the listQueues method to avoid sending an invalid request to the service. Fixes bug 5817.
• Documented the behavior of getProperties methods with respect to metadata keys and their casing inconsistency when compared to the metadata keys returned through corresponding "list" methods with the includeMetadata option.

12.0.0 (2019-10-30)

• This release marks the general availability of the @azure/storage-queue package.
• [Breaking] The custom browser and retry policies that are specific to the Storage libraries have been renamed to have the Storage prefix. PR 5862. Below are the entities that now have the Storage prefix
  • BrowserPolicy
  • BrowserPolicyFactory
  • RetryPolicy
  • RetryPolicyType
  • RetryOptions
  • RetryPolicyFactory
• [Breaking] The interface NewPipelineOptions has been renamed to StoragePipelineOptions and its properties have been updated as below:
  • The proxy property of type ProxySettings | string has been renamed to proxyOptions and will be of type ProxyOptions. If you have been passing url directly, split the value into host and port then pass it as a json object.
  • The telemetry property of type TelemetryOptions has been renamed to userAgentOptions of type UserAgentOptions.
  • The logger is no longer a property available to configure. To enable logging, please see the Troubleshooting section of our readme.
• [Breaking]
  • The UniqueRequestIdPolicy and KeepAlivePolicy are no longer exported from this library. The corresponding policies from the @azure/core-http library are meant to be used instead.
• [Breaking] The default browser bundle has been removed from the npm package. Bundling your application with a bundler such as Webpack is the recommended approach to building a browser bundle. For details on how to do this, please refer to our bundling documentation.

12.0.0-preview.5 (2019-10-22)

• [Breaking] Major API changes for the @azure/storage-queue package.
  • Flattened Client Hierarchy - QueueClient is flattened into QueueServiceClient, MessagesClient is renamed to QueueClient, MessageIdClient is flattened into the new QueueClient. PR #5579
    • enqueueMessage is renamed as sendMessage, dequeueMessages is renamed to receiveMessages
    • The new QueueServiceClient has createQueue and deleteQueue helper methods.
    • Names of Options and Responses as per the new hierarchy of clients. PR #5617
      • Example - MessagesClearOptions is renamed to QueueClearMessagesOptions, MessagesEnqueueResponse is renamed to QueueSendMessageResponse.
    • DequeuedMessageItem is renamed to ReceivedMessageItem PR #5661
• Created new interface CommonOptions. This interface is for standard options that apply to all methods that invoke remote operations. This interface currently contains options that enable client-side tracing of the SDK. PR #5550
• [Breaking] IPRange is renamed to SasIPRange. PR #5551
• [Breaking] Models is no longer exported in public API surface. Instead generated model types required by the public API are explicitly re-exported and aliased with Model suffix. For example, after this change, Models.QueueItem becomes QueueItemModel. PR #5534
• [Breaking] Cancelling an operation now throws a standardized error with the name AbortError. PR #5633
• [Breaking] queueName on QueueClient is renamed to name. PR #5613
• [Breaking] body field from RestError Object in core-http Library is removed, the response property on the error will now have the parsedBody & headers along with raw body & headers that are already present. PRs #5670, #5437
  • Errors from the storage service can be seen in an extra field details with the expected error code. #5688
• [Breaking] Type of the permissions attribute in the options bag FileSASSignatureValues to be passed into generateQueueSASQueryParameters is changed to QueueSASPermissions from type string. PR #5626
  • Similarly, AccountSASPermissions for generateAccountSASQueryParameters instead of type string.
  • Example - permissions attribute in generateQueueSASQueryParameters
    • permissions: QueueSASPermissions.parse("racwd").toString() changes to QueueSASPermissions.parse("racwd")
• [Breaking] Appropriate attribute renames in all the interfaces PR #5629
  • Example - nextMarker -> continuationToken, HTTPClient -> HttpClient, permission -> permissions
• Bug fix - Name properties on clients now support the Emulator. PR #5557
  • emulator url when the queueEndpoint is http://127.0.0.1:10001/devstoreaccount1 supported
  • emulator connection string shorthands are supported
    • UseDevelopmentStorage=true
    • (with proxyURI) UseDevelopmentStorage=true;DevelopmentStorageProxyUri=proxyURI
• [Breaking] IE11 needs Object.assign polyfill loaded. PR #5727

12.0.0-preview.4 (2019-10-09)

• Library tries to load the proxy settings from the environment variables like HTTP_PROXY if the proxy settings are not provided when clients like QueueServiceClient or QueueClient are instantiated.
• Added development connection string support to connect to the storage emulator Azurite - Extension for VS Code
  • Development Connection String
    • DefaultEndpointsProtocol=http;AccountName=devstoreaccount1;AccountKey=Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==; QueueEndpoint=http://127.0.0.1:10001/devstoreaccount1;
  • Shorthand notation is also supported
    • UseDevelopmentStorage=true (or UseDevelopmentStorage=true;DevelopmentStorageProxyUri=http://myProxyUri)
• Added name properties on all the clients for convenience.
  • accountName is added to MessageIdClient, MessagesClient, QueueClient and QueueServiceClient.
  • queueName is added to MessageIdClient, MessagesClient and QueueClient.
  • messageId is added to MessageIdClient.
• [Breaking] Models.StorageServiceProperties is renamed to Models.QueueServiceProperties.
• [Breaking] Models.StorageServiceStats is renamed to Models.QueueServiceStatistics.
• [Breaking] Replace string with boolean flag to specify dataset to include when listing queues. Before this change the option is specified as

  queueServiceClient.listShares({
    include: "metadata",
  });

  After this change:

  queueServiceClient.listShares({
    includeMetadata: true,
  });

12.0.0-preview.3 (2019-09-11)

• [Breaking] RawTokenCredential is dropped. TokenCredential implementations can be found in the @azure/identity library for authentication.
• Updated Azure Storage Service API version to 2019-02-02.
• Responses for all APIs now return x-ms-client-request-id through clientRequestId that was passed in on the request from client-side.
• Fixed a bug that Aborter cannot work during retry interval.
• Fixed a bug that "err.code.toUpperCase is not a function" when retries in browser.
• Export RetryPolicyType.
• Aborter doesn't require dom as tsconfig lib requirement anymore for Event type.
• Updated HTTP client from axios to node-fetch in Node.js runtime.
• A new option keepAliveOptions added to parameter of newPipeline() which controls keep-alive configurations. Keep-alive is enabled by default.
• Pass through options.abortSignal to the optional abortSignal attribute in option bags instead of using AbortSignal.none as the default value when options.abortSignal is not specified.
• Basic HTTP proxy authentication support is added. Proxy settings can be passed in the options while creating a new client. Example - typescript/proxyAuth.ts
• Connection strings for explicit storage endpoints are supported. - Configure Azure Storage connection strings

10.3.0 (2019-09-09)

• Updated Azure Storage Service API version to 2019-02-02.
• Responses for all APIs now return x-ms-client-request-id through clientRequestId that was passed in on the request from client-side.

12.0.0-preview.2 (2019-08-06)

• [Breaking] Aborter class is no longer exposed from the package. Use the package @azure/abort-controller to pass an abort signal to any of the async operations. AbortController.timeout(<milliseconds>) can be utilized as an abort signal.
• Generalized the credential parameter in client constructors to support {SharedKeyCredential | AnonymousCredential | TokenCredential} credentials as a union type.
• Storage service allows SAS connection string with SAS string and endpoints along with the Account connection string(account name, key and endpoint). In this preview, SAS connection string support is added to the existing connection string client constructors and static methods.
  • Account connection string example - DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net
  • SAS connection string example - 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
  • SAS connection string is supported in both NodeJS and browser runtimes unlike the Account Connection String which is supported only in the NodeJS runtime.
• Fixed a bug where MessageIdClient constructor throws an error URL is undefined when the client is created with a valid connection string.

10.2.0 (2019-07-31)

• Fixed a bug that Aborter cannot work during retry interval.
• Fixed a bug that "err.code.toUpperCase is not a function" when retries in browser.
• Export RetryPolicyType.
• Aborter doesn't require dom as tsconfig lib requirement anymore for Event type.
• Updated API version to 2018-11-09.
• Updated HTTP client from axios to node-fetch in Node.js runtime.
• A new option keepAliveOptions added to parameter of StorageURL.newPipeline() which controls keep-alive configurations. Keep-alive is enabled by default.
• Updated Azure Storage Service API version to 2018-11-09.

12.0.0-preview.1 (2019-07-03)

• [Breaking] Client types are renamed from *URL to *Client.
  • QueueURL, MessagesURL, MessageIdURL, ServiceURL, StorageURL to QueueClient, MessagesClient, MessageIdClient, QueueServiceClient, StorageClient respectively.
• [Breaking] Aborter parameters are now moved into option bags.
  • abortSignal attribute(optional) in the option-bag of respective module has to be utilized for the Aborter.timeout(<milliseconds>) functionality.
  • Aborter.none is the default value.
• [Breaking] I- prefixes are removed from interface names
  • Example- IQueueCreateOptions is updated to QueueCreateOptions, the new names must to be used.
• [Breaking] The static methods to create client types are removed. The functionality is moved into new instance methods added to the parent clients.
• [Breaking] The telemetry strings have been updated.
  • Azure-Storage/${SDK_VERSION} is updated to azsdk-js-storagequeue/${SDK_VERSION}.
• [Breaking] withPipeline method is removed.
• Async iterators with pagination support are added for listing queues listQueues()
  • Please refer to the samples for async iterators in the samples folder.
• [Breaking] Methods that list segments(listQueuesSegment()) is no longer exposed in public api.
• [Breaking] StorageClient is no longer exposed. StorageClient.newPipeline() static method is moved to the top level exported function newPipeline().
• [Breaking] TokenCredential has been renamed to RawTokenCredential to make way for the new @azure/identity library's TokenCredential interface.
• [Breaking] The type of the include field of both ServiceListQueuesOptions and ServiceListQueuesSegmentOptions has changed from ListQueuesIncludeType to ListQueuesIncludeType[] due to changes in the underlying OpenAPI specification.
• [Breaking] Blob/Container member methods that manage leases are removed. A new type LeaseClient is added to manage leases.
• Updated dependency @azure/ms-rest-js to @azure/core-http.
• Constructor overloads added into client types so they can be constructed from a url and a pipeline/credential and connection string.
  • Constructors with overloads - MessageIdClient, MessagesClient, QueueClient and QueueServiceClient.
  • Connection string method is supported only in Node.js (not browsers).
• Creation/Deletion of child resources are duplicated to parent client type.
• HTTP proxy support is added (Node.js only).
  • Please refer to the proxyAuth.ts sample in the samples/v12/typescript folder.
• Request and response headers are now logged at INFO level, with sensitive data redacted.

For release notes and more information please visit https://aka.ms/azsdk/releases/july2019preview

10.1.0 (2019-01-18)

• [Breaking] Updated convenience layer methods enum type parameters into typescript union types, this will help to reduce bundle footprint.
• [Breaking] SASQueryParameters is not going to be exported in browser bundle, and will be exported in Node.js runtime.
• [Breaking] IE11 needs Array.prototype.includes and Object.keys polyfills loaded.
• Updated dependency ms-rest-js to @azure/ms-rest-js.
• Updated server timeout value for retry options tryTimeoutInMs to 30 seconds.
• Fixed Aborter.timeout() misleading scale description.
• Fixed an issue that enqueue/dequeue/peek fail to work with some utf8 characters.
• Exported HttpRequestBody type for who wants to implement a customized HTTP client.

10.0.0-preview (2018-12-12)

• Initial Release. API version 2018-03-28 supported. Please see the README for information on the new design.