The Azure SDK team is pleased to announce our March 2022 client library releases.

GA

  • @azure/arm-authorization-profile-2020-09-01-hybrid

  • @azure/arm-commerce-profile-2020-09-01-hybrid

  • @azure/arm-compute-profile-2020-09-01-hybrid

  • @azure/arm-databoxedge-profile-2020-09-01-hybrid

  • @azure/arm-dns-profile-2020-09-01-hybrid

  • @azure/arm-eventhub-profile-2020-09-01-hybrid

  • @azure/arm-keyvault-profile-2020-09-01-hybrid

  • @azure/arm-locks-profile-2020-09-01-hybrid

  • @azure/arm-monitor-profile-2020-09-01-hybrid

  • @azure/arm-network-profile-2020-09-01-hybrid

  • @azure/arm-policy-profile-2020-09-01-hybrid

  • @azure/arm-resources-profile-2020-09-01-hybrid

  • @azure/arm-storage-profile-2020-09-01-hybrid

  • @azure/arm-subscriptions-profile-2020-09-01-hybrid

  • Blobs

  • Communication Common

  • Core - Client - Core Rest Pipeline

  • Event Grid

  • Files Data Lake

  • Files Shares

  • Queues

  • Resource Management - Azure Stack HCI

  • Resource Management - Compute

  • Resource Management - Container Service

  • Resource Management - Data Factory

  • Resource Management - IoT Hub

  • Resource Management - Kusto

  • Resource Management - NetApp

  • Resource Management - Recovery Services Backup

  • Resource Management - Storage

  • Service Bus

Updates

  • Core - Client - LRO

  • Identity

  • Service Bus

Beta

  • @azure/arm-commerce-profile-2020-09-01-hybrid

  • Avro

  • Blobs

  • Cognitive Search

  • Communication Network Traversal

  • Communication Phone Numbers

  • Digital Twins Definition Language Parser

  • Files Shares

  • Form Recognizer

  • Identity

  • Resource Management - App Platform

  • Resource Management - Container Registry

  • Resource Management - Cosmos DB

  • Resource Management - Digital Twins

  • Resource Management - Dnsresolver

  • Resource Management - Mobilenetwork

  • Resource Management - Sql Virtual Machine

  • Schema Registry - Avro

  • Storage - Blobs

  • Storage - Files Shares

Installation Instructions

To install the packages, copy and paste the below into a terminal.

$> npm install @azure/ai-form-recognizer@4.0.0-beta.3
$> npm install @azure/arm-appplatform@2.0.0-beta.3
$> npm install @azure/arm-authorization-profile-2020-09-01-hybrid@2.0.0
$> npm install @azure/arm-azurestackhci@2.1.0
$> npm install @azure/arm-commerce-profile-2020-09-01-hybrid@2.0.0
$> npm install @azure/arm-commerce-profile-2020-09-01-hybrid@2.0.0-beta.1
$> npm install @azure/arm-compute@17.2.0
$> npm install @azure/arm-compute@17.3.0
$> npm install @azure/arm-compute-profile-2020-09-01-hybrid@2.0.0
$> npm install @azure/arm-containerregistry@10.1.0-beta.1
$> npm install @azure/arm-containerservice@15.1.0
$> npm install @azure/arm-cosmosdb@16.0.0-beta.1
$> npm install @azure/arm-databoxedge-profile-2020-09-01-hybrid@2.0.0
$> npm install @azure/arm-datafactory@10.2.0
$> npm install @azure/arm-digitaltwins@3.1.0-beta.1
$> npm install @azure/arm-dns-profile-2020-09-01-hybrid@2.0.0
$> npm install @azure/arm-dnsresolver@1.0.0-beta.1
$> npm install @azure/arm-eventhub-profile-2020-09-01-hybrid@2.0.0
$> npm install @azure/arm-iothub@6.1.0
$> npm install @azure/arm-keyvault-profile-2020-09-01-hybrid@2.0.0
$> npm install @azure/arm-kusto@7.1.0
$> npm install @azure/arm-locks-profile-2020-09-01-hybrid@2.0.0
$> npm install @azure/arm-mobilenetwork@1.0.0-beta.1
$> npm install @azure/arm-monitor-profile-2020-09-01-hybrid@2.0.0
$> npm install @azure/arm-netapp@15.1.0
$> npm install @azure/arm-network-profile-2020-09-01-hybrid@2.0.0
$> npm install @azure/arm-policy-profile-2020-09-01-hybrid@2.0.0
$> npm install @azure/arm-recoveryservicesbackup@8.1.0
$> npm install @azure/arm-resources-profile-2020-09-01-hybrid@2.0.0
$> npm install @azure/arm-sqlvirtualmachine@5.0.0-beta.3
$> npm install @azure/arm-storage@17.1.0
$> npm install @azure/arm-storage-profile-2020-09-01-hybrid@2.0.0
$> npm install @azure/arm-subscriptions-profile-2020-09-01-hybrid@2.0.0
$> npm install @azure/communication-common@2.0.0
$> npm install @azure/communication-network-traversal@1.1.0-beta.1
$> npm install @azure/communication-phone-numbers@1.2.0-beta.2
$> npm install @azure/core-lro@2.2.4
$> npm install @azure/core-rest-pipeline@1.6.0
$> npm install @azure/dtdl-parser@1.0.0-beta.2
$> npm install @azure/eventgrid@4.8.0
$> npm install @azure/identity@2.0.3
$> npm install @azure/identity@2.0.4
$> npm install @azure/identity@2.1.0-beta.1
$> npm install @azure/schema-registry-avro@1.0.0-beta.6
$> npm install @azure/schema-registry-avro@1.0.0-beta.7
$> npm install @azure/search-documents@11.3.0-beta.7
$> npm install @azure/service-bus@7.5.0
$> npm install @azure/service-bus@7.5.1
$> npm install @azure/storage-blob@12.9.0-beta.3
$> npm install @azure/storage-blob@12.9.0-beta.4
$> npm install @azure/storage-blob@12.9.0
$> npm install @azure/storage-file-datalake@12.8.0
$> npm install @azure/storage-file-share@12.9.0-beta.3
$> npm install @azure/storage-file-share@12.9.0-beta.4
$> npm install @azure/storage-file-share@12.9.0
$> npm install @azure/storage-queue@12.8.0

Feedback

If you have a bug or feature request for one of the libraries, please post an issue at the azure-sdk-for-js repository

Release highlights

@azure/arm-authorization-profile-2020-09-01-hybrid 2.0.0 Changelog

@azure/arm-commerce-profile-2020-09-01-hybrid 2.0.0 Changelog

@azure/arm-commerce-profile-2020-09-01-hybrid 2.0.0-beta.1 Changelog

@azure/arm-compute-profile-2020-09-01-hybrid 2.0.0 Changelog

@azure/arm-databoxedge-profile-2020-09-01-hybrid 2.0.0 Changelog

@azure/arm-dns-profile-2020-09-01-hybrid 2.0.0 Changelog

@azure/arm-eventhub-profile-2020-09-01-hybrid 2.0.0 Changelog

@azure/arm-keyvault-profile-2020-09-01-hybrid 2.0.0 Changelog

@azure/arm-locks-profile-2020-09-01-hybrid 2.0.0 Changelog

@azure/arm-monitor-profile-2020-09-01-hybrid 2.0.0 Changelog

@azure/arm-network-profile-2020-09-01-hybrid 2.0.0 Changelog

@azure/arm-policy-profile-2020-09-01-hybrid 2.0.0 Changelog

@azure/arm-resources-profile-2020-09-01-hybrid 2.0.0 Changelog

@azure/arm-storage-profile-2020-09-01-hybrid 2.0.0 Changelog

@azure/arm-subscriptions-profile-2020-09-01-hybrid 2.0.0 Changelog

Avro 1.0.0-beta.7 Changelog

Breaking Changes

  • AvroEncoder has been renamed to AvroSerializer
  • The encodeMessageData method has been renamed to serializeMessageData
  • The decodeMessageData method has been renamed to deserializeMessageData

Blobs 12.9.0-beta.4 Changelog

Features Added

  • Added ability to specify Disk Compute AAD Audience in StoragePipelineOptions.

Bugs Fixed

  • Set correct content length in requests for uploading operations to avoid unexpected failure if customized content length is incorrect.

Blobs 12.9.0 Changelog

Bugs Fixed

  • Fixed an issue of always sending x-ms-encryption-algorithm header in request.

Features Added

  • Includes all features released in 12.9.0-beta.1, 12.9.0-beta.2, 12.9.0-beta.3 and 12.9.0-beta.4.

Cognitive Search 11.3.0-beta.7 Changelog

Features Added

  • Added new APIs createAlias, createOrUpdateAlias, deleteAlias, getAlias & listAliases operations to the SearchIndexClient.

Communication Common 2.0.0 Changelog

Breaking Changes

  • Migrated from using @azure/core-http to @azure/core-rest-pipeline for the handling of HTTP requests. See Azure Core v1 vs v2 for more on the difference and benefits of the move.
  • createCommunicationAccessKeyCredentialPolicy and createCommunicationAuthPolicy newly return PipelinePolicy instead of RequestPolicyFactory.

Features Added

  • Optimization added: When the proactive refreshing is enabled and the token refresher fails to provide a token that’s not about to expire soon, the subsequent refresh attempts will be scheduled for when the token reaches half of its remaining lifetime until a token with long enough validity (>10 minutes) is obtained.

Communication Network Traversal 1.1.0-beta.1 Changelog

Breaking Changes

  • Making User, RouteType and Ttl part of the options parameter
  • getRelayConfiguration can be called without parameters or passing the GetRelayConfigurationOptions parameter

Features Added

  • Adding optional parameter to GetRelayConfiguration to choose credential Time-To-Live in seconds of max 48 hours. The default value will be used if given value exceeds it.

Communication Phone Numbers 1.2.0-beta.2 Changelog

Features Added

  • Upgraded the package to use the Azure Core V2, bringing several improvements to the package’s HTTP pipeline architecture.

Core - Client - Core Rest Pipeline 1.6.0 Changelog

Other Changes

  • Add “WWW-Authenticate” to the allowed logged header list. #20288

  • Switch browser transport to fetch. #20201

Core - Client - LRO 2.2.4 Changelog

Bugs Fixed

  • Fix polling so that resources created in a different URL will be retrieved once polling is done. PR #20656

Digital Twins Definition Language Parser 1.0.0-beta.2 Changelog

Bugs Fixed

  • Fix integration issues with @azure/iot-modelsrepository.

Event Grid 4.8.0 Changelog

Features Added

  • Added new value IdentityUnsupported to MediaJobErrorCode and Account to MediaJobErrorCategory for Microsoft.Media events.

Files Data Lake 12.8.0 Changelog

Bugs Fixed

  • Fixed a bug where customized ProxyOptions is overwrited by a default one when initializing DataLakeServiceClient with connection string.
  • Set correct content length in requests for uploading operations to avoid unexpected failure if customized content length is incorrect.

Features Added

  • Includes all features released in 12.8.0-beta.1.

Files Shares 12.9.0-beta.4 Changelog

Bugs Fixed

  • Fixed bug where ShareFileClient.startCopyFromURL() was not sending the ignoreReadonly parameter correctly.
  • Set correct content length in requests for uploading operations to avoid unexpected failure if customized content length is incorrect.

Files Shares 12.9.0 Changelog

Features Added

  • Includes all features released in 12.9.0-beta.1, 12.9.0-beta.2, 12.9.0-beta.3 and 12.9.0-beta.4.

Form Recognizer 4.0.0-beta.3 Changelog

Features Added

  • Updated the SDK to use the latest preview version of the Form Recognizer service: 2022-01-30-preview.
  • A new prebuilt model, PrebuiltModels.TaxUsW2, is available. It supports extracting data from United States W2 tax forms such as employee and employer information, IRS control number, tax withholding information, etc.
  • Added a new method, beginReadDocument to DocumentAnalysisClient. This method uses the “prebuilt-read” model to extract textual information from the document such as page text contents and language spans.
  • Added a languages field to the AnalyzeResult type. This field contains information about regions of text in the document that were identified as being of a particular written language. A DocumentLanguage consists of the identified languageCode (ISO 639-1 or BCP 47 language code), a list of spans of text that are of that language, and a confidence value (between zero and one) that the assessment is correct.
  • Added a tags field to BuildModelOptions, GetCopyAuthorizationOptions, and ModelSummary. Tags are user-specified key-value pairs that are immutably associated with the model. If tags are provided when a model is created, the Form Recognizer service will return the same tags as part of the model’s summary. The OperationInfo and TrainingPollOperationState of a model creation operation also produce the tags if they were provided in the BuildModelOptions.
  • Models now report the service API version used to create the model and that will be used for analysis in the apiVersion field.
  • Documents may now contain a new field type DocumentCurrencyField, which has an object with amount and currencySymbol fields as its value. This field is identified by the value "currency" in the kind field. The amount field contains the amount of the currency value, and the currencySymbol field may contain a three-letter currency symbol if one was identified for the field. For example, the text $100.50 may have an amount of 100.5 and a currencySymbol of “USD”.
  • Added support for setting the buildMode of a model building operation and introduced the “neural” build mode. Previous versions of the service and SDK only supported a single build mode that is now known as the “template” mode. Template models only accept documents that have the same basic page structure (i.e. a uniform visual appearance, or the same relative positioning of elements within the document), hence a fixed document “template.” Neural models support document classes that have the same information, but different page structures. Examples of these documents include United States W2 tax forms, which all share the same information, but may vary in appearance by the company that created the document. Neural models currently only support English text, and are more costly and time-consuming to train and use for analysis, but should yield higher-quality results for English documents that do not follow a “template.”
  • The DocTypeInfo type now has a buildMode field that contains the build mode originally used to create the document type.

Bugs Fixed

  • The LayoutResult and GeneralDocumentResult types were missing the apiVersion, modelId, and content fields that are common to all other analysis results. This version adds them through a new interface, AnalyzeResultCommon, that includes these fields. LayoutResult, GeneralDocumentResult, ReadResult, and AnalyzeResult all now extend the AnalyzeResultCommon interface.
  • The DocumentSignatureField interface was missing a type for its value property. The property existed at runtime, but no type information was available for this field. The value property has been added to the interface.

Breaking Changes

  • Renamed the beginAnalyzeDocuments method of DocumentAnalysisClient to beginAnalyzeDocument for accuracy (only one input document is supported, though the document may contain multiple pages in certain file formats) and for consistency with other Azure SDK packages.
  • Renamed the options bag type AnalyzeDocumentsOptions to AnalyzeDocumentOptions for consistency with the method name.
  • The buildMode parameter of DocumentModelAdminsitrationClient#beginBuildModel is a required parameter. To retain the same behavior as in previous versions, explicitly use the template build mode (pass the value "template" to the method).
  • The GeneratedDocument type (as well as related types like GeneratedDocumentField) was removed from the public API and its uses replaced with unknown, as it is only intended for internal use. These types represented raw REST API response types that are not exposed at runtime by the client methods.
  • Removed the Preview variant from the FormRecognizerApiVersion object because it will never be different from the Latest version in beta packages, and stable packages will not support it.
  • Renamed beginExtractGenericDocument and GenericDocumentResult to beginExtractGeneralDocument and GeneralDocumentResult for consistency with other Form Recognizer SDK packages.
  • Several of the prebuilt model schemas and result types have changed:
  • The document type naming convention has changed. Instead of separation by colons (e.g. “prebuilt:receipt”), prebuilt model document type names are now separated by periods and are no longer prefixed with “prebuilt” (“prebuilt:idDocument:driverLicense” becomes “idDocument.driverLicense”, “prebuilt:invoice” becomes just “invoice”).
  • In the prebuilt-invoice model, several numeric fields that represented amounts of money have been changed to a designated "currency" type. These include the subTotal, totalTax, invoiceTotal, amountDue, and previousUnpaidBalance fields of invoices and the amount, tax, and unitPrice fields of invoice items (a subfield of invoices).

Identity 2.0.3 Changelog

Bugs Fixed

  • Fixed bug that duplicated the tenant Id on the URI of outgoing requests when passing an authorityHost ending with a tenant Id.
  • ManagedIdentityCredential now won’t retry when it tries to ping the IMDS endpoint.
  • Now we are specifying the maximum number of retries to 3 to ensure that maximum retries won’t change without notice.

Features Added

  • Added log warning for non-support of user assigned identity in Managed Identity credentials in Cloud Shell environments.

Identity 2.0.4 Changelog

Bugs Fixed

  • Fixed a regression in version 2.0.3 in which providing an options bag, but not a client ID, to the ManagedIdentityCredential constructor would discard the options parameter.

Identity 2.1.0-beta.1 Changelog

Features Added

  • Added support for specifying a custom resourceId when creating a ManagedIdentityCredential or DefaultAzureCredential.
  • In some scenarios where a user-assigned managed identity is required, the identity may be known by an ARM resource ID, but not a client ID (such as when user-assigned identities are created using an ARM template). The resourceId option allows an app to select its managed identity by its ARM resource ID to support such scenarios.
  • If resourceId is provided, the managed identity providers for Azure App Service (2017), Azure Arc, Azure Cloud Shell, Azure Service Fabric and Token Exchange authentication will log a warning since this parameter is not supported by the identity endpoints in those services. The authentication attempts will be sent, but the parameter will be ignored by the service.
  • Added clientId to the optional parameters of the ManagedIdentityCredential.
  • Updated the Troubleshoot guide to have error codes and error messages for the Identity Customer Service Support.

Queues 12.8.0 Changelog

Bugs Fixed

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

Features Added

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

Resource Management - App Platform 2.0.0-beta.3 Changelog

Resource Management - Azure Stack HCI 2.1.0 Changelog

Resource Management - Compute 17.2.0 Changelog

Resource Management - Compute 17.3.0 Changelog

Resource Management - Container Registry 10.1.0-beta.1 Changelog

Resource Management - Container Service 15.1.0 Changelog

Resource Management - Cosmos DB 16.0.0-beta.1 Changelog

Resource Management - Data Factory 10.2.0 Changelog

Resource Management - Digital Twins 3.1.0-beta.1 Changelog

Resource Management - Dnsresolver 1.0.0-beta.1 Changelog

Resource Management - IoT Hub 6.1.0 Changelog

Resource Management - Kusto 7.1.0 Changelog

Resource Management - Mobilenetwork 1.0.0-beta.1 Changelog

Resource Management - NetApp 15.1.0 Changelog

Resource Management - Recovery Services Backup 8.1.0 Changelog

Resource Management - Sql Virtual Machine 5.0.0-beta.3 Changelog

Resource Management - Storage 17.1.0 Changelog

Schema Registry - Avro 1.0.0-beta.6 Changelog

Features Added

  • The encoder APIs have been revamped to work on messages instead of buffers where the payload is the pure encoded-data. The schema ID became part of the content type of that message. This change will improve the experience of using this encoder with the other messaging clients (e.g. Event Hubs, Service Bus, and Event Grid clients). The encoder also supports decoding messages with payloads that follow the old format where the schema ID was part of the payload.
  • decodeMessageData now supports decoding using a different but compatible schema

Breaking Changes

  • The SchemaRegistryAvroSerializer class has been renamed to AvroEncoder
  • The serialize method has been renamed to encodeMessageData and it now returns a message
  • The deserialize method has been renamed to decodeMessageData and it now takes a message as input

Service Bus 7.5.0 Changelog

Bugs Fixed

  • The processError callback to subscribe() was previously called only for errors on setting up the receiver, errors on message settlement or message lock renewal and not for errors on AMQP link or session. This is now fixed. PR #19189
  • Fix an issue where we don’t respect retry options before starting the next retry cycle when using the subscribe() method. PR #20316

Features Added

  • Add state property to ServiceBusReceivedMessage. Its value is one of "active", "deferred", or "scheduled". PR #18938
  • Add optional boolean skipParsingBodyAsJson property to ServiceBusReceiverOptions and ServiceBusSessionReceiverOptions. By default, the client attempts to parse message body as JSON object, and this new parameter controls whether the client should skip performing this parsing. PR #18692

Service Bus 7.5.1 Changelog

Bugs Fixed

  • Fix an issue where we don’t respect user request to close the receiver if the connection is disconnected when using the subscribe() method. PR #20427

Storage - Blobs 12.9.0-beta.3 Changelog

Features Added

  • Added support for service version 2021-04-10.
  • Added support for finding blobs by tags in a container.

Bugs Fixed

  • Fixed a bug where customized ProxyOptions is overwrited by a default one when initializing BlobServiceClient, BlobClient, AppendBlobClient, BlockBlobClient, PageBlobClient or ContainerClient with connection string.

Storage - Files Shares 12.9.0-beta.3 Changelog

Features Added

  • Added support for service version 2021-04-10.
  • Added support for renaming a file or a directory.

Latest Releases

View all the latest versions of JavaScript packages here.