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

GA

  • @azure/arm-hybridkubernetes

  • @azure/arm-resourcemover

  • Core - AMQP

  • Core - Client

  • Core - XML

  • Core Rest Pipeline

  • Event Grid

  • Event Hubs

  • Resouce Management - Redis Enterprise Cache

  • Resource Management - Data Catalog

  • Resource Management - Device Provisioning Services

  • Resource Management - Health Care APIs

  • Resource Management - Hybrid Compute

  • Resource Management - IoT Central

  • Resource Management - Key Vault

  • Resource Management - Kusto

  • Resource Management - Machine Learning Services

  • Resource Management - Management Partner

  • Resource Management - Maps

  • Resource Management - Maria DB

  • Resource Management - Market Place Ordering

  • Resource Management - Migrate

  • Resource Management - Mixed Reality

  • Resource Management - NetApp

  • Resource Management - Peering

  • Resource Management - Policy Insights

  • Resource Management - Postgresql

  • Resource Management - Power BI Dedicated

  • Resource Management - Power BI Embedded

  • Resource Management - Private DNS

  • Resource Management - Recovery Services Backup

  • Resource Management - Recovery Services Site Recovery

  • Resource Management - Reservations

  • Resource Management - Serial Console

  • Resource Management - SignalR

  • Resource Management - StorSimple1200Series

  • Resource Management - StorSimple8000Series

  • Resource Management - Storage Cache

  • Resource Management - Storage Import Export

  • Resource Management - Storage Sync

  • Resource Management - Subscriptions

  • Resource Management - Support

  • Resource Management - Synapse

  • Resource Management - Time Series Insights

  • Resource Management - Traffic Manager

  • Resource Management - VMware CloudSimple

  • Resource Management - Web Services

  • Resource Management - Work Spaces

Updates

  • Communication Chat

  • Core - HTTP

  • Cosmos DB

  • Identity

  • Monitor Query

  • Resource Management - Mixed Reality

  • Web PubSub CloudEvents Handlers for Express

Beta

  • Anomaly Detector

  • Cognitive Search

  • Communication Phone Numbers

  • Core - Tracing

  • Digital Twins Definition Language Parser

  • Event Hubs

  • Form Recognizer

  • Key Vault - Keys

  • Monitor OpenTelemetry Exporter

  • OpenTelemetry Instrumentation

  • Resource Management - Application Insights

  • Resource Management - Commerce

  • Resource Management - Commitment Plans

  • Resource Management - Data Migration

  • Resource Management - Deployment Manager

  • Resource Management - HANA on Azure

  • Resource Management - Kubernetes Configuration

  • Resource Management - Lab Services

  • Resource Management - Machine Learning Compute

  • Resource Management - Machine Learning Experimentation

  • Resource Management - Oep

  • Resource Management - Resource Graph

  • Resource Management - Securityinsight

  • Resource Management - Service Fabric Mesh

  • Resource Management - Service Map

  • Resource Management - Visual Studio

  • 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-anomaly-detector@3.0.0-beta.5
$> npm install @azure/ai-form-recognizer@4.0.0-beta.3
$> npm install @azure/arm-appinsights@5.0.0-beta.1
$> npm install @azure/arm-appinsights@5.0.0-beta.2
$> npm install @azure/arm-commerce@4.0.0-beta.1
$> npm install @azure/arm-commitmentplans@2.0.0-beta.1
$> npm install @azure/arm-datacatalog@3.0.0
$> npm install @azure/arm-datamigration@3.0.0-beta.1
$> npm install @azure/arm-deploymentmanager@4.0.0-beta.1
$> npm install @azure/arm-deploymentmanager@4.0.0-beta.2
$> npm install @azure/arm-deviceprovisioningservices@4.1.0
$> npm install @azure/arm-hanaonazure@4.0.0-beta.1
$> npm install @azure/arm-healthcareapis@2.0.0
$> npm install @azure/arm-hybridcompute@3.0.0
$> npm install @azure/arm-hybridkubernetes@2.0.0
$> npm install @azure/arm-iotcentral@6.0.0
$> npm install @azure/arm-keyvault@2.0.0
$> npm install @azure/arm-kubernetesconfiguration@5.0.0-beta.1
$> npm install @azure/arm-kusto@7.0.0
$> npm install @azure/arm-labservices@3.0.0-beta.1
$> npm install @azure/arm-machinelearningcompute@3.0.0-beta.1
$> npm install @azure/arm-machinelearningexperimentation@2.0.0-beta.1
$> npm install @azure/arm-machinelearningservices@5.0.0
$> npm install @azure/arm-managementpartner@2.0.0
$> npm install @azure/arm-maps@3.0.0
$> npm install @azure/arm-mariadb@2.0.0
$> npm install @azure/arm-marketplaceordering@3.0.0
$> npm install @azure/arm-migrate@2.0.0
$> npm install @azure/arm-mixedreality@4.0.1
$> npm install @azure/arm-mixedreality@4.0.0
$> npm install @azure/arm-netapp@15.0.0
$> npm install @azure/arm-oep@1.0.0-beta.1
$> npm install @azure/arm-peering@2.0.0
$> npm install @azure/arm-policyinsights@5.0.0
$> npm install @azure/arm-postgresql-flexible@5.0.0
$> npm install @azure/arm-powerbidedicated@3.0.0
$> npm install @azure/arm-powerbiembedded@2.0.0
$> npm install @azure/arm-privatedns@3.0.0
$> npm install @azure/arm-recoveryservices-siterecovery@4.0.0
$> npm install @azure/arm-recoveryservicesbackup@8.0.0
$> npm install @azure/arm-redisenterprisecache@2.0.0
$> npm install @azure/arm-reservations@7.0.0
$> npm install @azure/arm-resourcegraph@5.0.0-beta.1
$> npm install @azure/arm-resourcemover@2.0.0
$> npm install @azure/arm-securityinsight@1.0.0-beta.1
$> npm install @azure/arm-serialconsole@2.0.0
$> npm install @azure/arm-servicefabricmesh@3.0.0-beta.1
$> npm install @azure/arm-servicemap@3.0.0-beta.1
$> npm install @azure/arm-signalr@5.0.0
$> npm install @azure/arm-storagecache@5.0.0
$> npm install @azure/arm-storageimportexport@2.0.0
$> npm install @azure/arm-storagesync@9.0.0
$> npm install @azure/arm-storsimple1200series@2.0.0
$> npm install @azure/arm-storsimple8000series@2.0.0
$> npm install @azure/arm-subscriptions@5.0.0
$> npm install @azure/arm-support@2.0.0
$> npm install @azure/arm-synapse@8.0.0
$> npm install @azure/arm-timeseriesinsights@2.0.0
$> npm install @azure/arm-trafficmanager@6.0.0
$> npm install @azure/arm-visualstudio@4.0.0-beta.1
$> npm install @azure/arm-vmwarecloudsimple@2.0.0
$> npm install @azure/arm-webservices@1.0.0
$> npm install @azure/arm-workspaces@1.0.0
$> npm install @azure/communication-chat@1.1.2
$> npm install @azure/communication-phone-numbers@1.2.0-beta.1
$> npm install @azure/core-amqp@3.1.0
$> npm install @azure/core-client@1.5.0
$> npm install @azure/core-http@2.2.4
$> npm install @azure/core-rest-pipeline@1.5.0
$> npm install @azure/core-tracing@1.0.0-preview.14
$> npm install @azure/core-xml@1.2.0
$> npm install @azure/cosmos@3.15.1
$> npm install @azure/dtdl-parser@1.0.0-beta.1
$> npm install @azure/event-hubs@5.7.0
$> npm install @azure/event-hubs@5.8.0-beta.1
$> npm install @azure/eventgrid@4.7.0
$> npm install @azure/identity@2.0.2
$> npm install @azure/keyvault-keys@4.4.0-beta.4
$> npm install @azure/monitor-opentelemetry-exporter@1.0.0-beta.6
$> npm install @azure/monitor-query@1.0.1
$> npm install @azure/opentelemetry-instrumentation-azure-sdk@1.0.0-beta.1
$> npm install @azure/schema-registry-avro@1.0.0-beta.6
$> npm install @azure/search-documents@11.3.0-beta.6
$> npm install @azure/storage-blob@12.9.0-beta.3
$> npm install @azure/storage-file-share@12.9.0-beta.3
$> npm install @azure/web-pubsub-express@1.0.1

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-hybridkubernetes 2.0.0 Changelog

@azure/arm-resourcemover 2.0.0 Changelog

Anomaly Detector 3.0.0-beta.5 Changelog

  • Fix release issues

Cognitive Search 11.3.0-beta.6 Changelog

Features Added

  • Added new type of SearchIndexer skill - AzureMachineLearningSkill. Please refer #20183 for further details.

Communication Chat 1.1.2 Changelog

Breaking Changes

  • Prohibit sending the typing notification request within 8 seconds of the previous request.

Features Added

  • Updated to @azure/communication-signaling@1.0.0-beta.12.
  • Added two new events realTimeNotificationConnected and realTimeNotificationDisconnected that allow the developer to know when the connection to the call server is active

Communication Phone Numbers 1.2.0-beta.1 Changelog

Features Added

  • Added support for the API version 2022-01-11-preview2

Core - AMQP 3.1.0 Changelog

Features Added

  • Changed TS compilation target to ES2017 in order to produce smaller bundles and use more native platform features
  • 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.
  • Updated to use the latest version of the rhea package.
  • Add a constant messageState with value of "x-opt-message-state" which is the name for the new message state property in the message annotations. PR 18938

Core - Client 1.5.0 Changelog

Features Added

  • Added new CommonClientOptions member additionalPolicies to allow passing custom pipeline policies to client constructors. PR #19920

Bugs Fixed

  • Addressed an issue where the onResponse callback wouldn’t be called in certain cases where an unexpected response was received from the service. PR #19702

Core - HTTP 2.2.4 Changelog

Bugs Fixed

  • Updated the HTTP tracing span names to conform to the OpenTelemetry Specification. #19838
  • New HTTP spans will use the HTTP <VERB> convention instead of using the URL path.

Core - Tracing 1.0.0-preview.14 Changelog

Breaking Changes

  • @azure/core-tracing has been rewritten in order to provide cleaner abstractions for client libraries as well as remove @opentelemetry/api as a direct dependency.
  • @opentelemetry/api is no longer a direct dependency of @azure/core-tracing providing for smaller bundle sizes and lower incidence of version conflicts
  • createSpanFunction has been removed and replaced with a stateful TracingClient which can be created using the createTracingClient function.
  • TracingClient introduces a new API for creating tracing spans. Use TracingClient#withSpan to wrap an invocation in a span, ensuring the span is ended and exceptions are captured.
  • TracingClient also provides the lower-level APIs necessary to start a span without making it active, create request headers, serialize traceparent header, and wrapping a callback with an active context.

Core - XML 1.2.0 Changelog

Other Changes

  • Fix root version node handling difference with fxp v3. #20035
  • Upgrade to fast-xml-parser to v4 PR# 19898

Core Rest Pipeline 1.5.0 Changelog

Features Added

  • Added new phase “Sign” for policies that sign the request for security purposes. #20129

Bugs Fixed

  • Updated the HTTP tracing span names to conform to the OpenTelemetry Specification. #19838
  • New HTTP spans will use the HTTP <VERB> convention instead of using the URL path.
  • Addressed an issue where policy order might change in cases where there are no policies inside a phase specified by an “afterPhase” constraint. #20129

Cosmos DB 3.15.1 Changelog

Bugs Fixed

  • Fixed the paths mapped by the browser entry in package.json to be correct for the package’s new output structure. This solves errors with bundling the package for browsers.

Digital Twins Definition Language Parser 1.0.0-beta.1 Changelog

Features Added

Event Grid 4.7.0 Changelog

Key Bug Fixes

  • The TypeScript typings for two events have had small changes to accurately reflect the data sent by Azure.
  • Microsoft.EventHub.CaptureFileCreated’s fileurl property is now correctly cased as fileUrl
  • Microsoft.Storage.DirectoryDeleted’s recursive property has been changed from boolean to string. The service sets this property to the string "true" or "false".

Event Hubs 5.7.0 Changelog

Features Added

  • Added skipParsingBodyAsJson optional parameter to EventHubConsumerClient.subscribe method. When set to true it will disable the client from running JSON.parse() on the message body when receiving the message. Not applicable if the message was sent with AMQP body type value or sequence.

Event Hubs 5.8.0-beta.1 Changelog

Features Added

  • A new function createEventDataAdapter is exported that can convert an EventData to a simple message with body and contentType fields. This adapter can be used with the Avro encoder in @azure/schema-registry-avro starting from version 1.0.0-beta.6 to create EventData messages with Avro-encoded bodies.

  • When publishing events to Event Hubs, timeouts or other transient failures may introduce ambiguity into the understanding of whether a batch of events was received by the service. To assist in this scenario, the option to publish events idempotently has been added to EventHubBufferedProducerClient. The functionality can be enabled by setting the enableIdempotentPartitions client option to true. If enabled, retries during publishing will attempt to avoid duplication with a minor cost to throughput. Duplicates are still possible but the chance of them occurring is much lower when idempotent retries are enabled. PR #20156

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.

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).

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.

Identity 2.0.2 Changelog

Features Added

  • Improved the error message when InteractiveBrowserCredential is used with an unavailable port (such as when no redirectUri is provided, and the port 80 is busy) and when no browser is available.

Bugs Fixed

  • Challenge claims now are properly being passed through to the outgoing token requests.
  • The ManagedIdentityCredential now properly parses expiration dates from token exchange requests.

Key Vault - Keys 4.4.0-beta.4 Changelog

Features Added

  • Added KeyReleasePolicy#immutable flag to support immutable release policies. Once a release policy is marked as immutable, it can no longer be modified.

Monitor OpenTelemetry Exporter 1.0.0-beta.6 Changelog

Other Changes

  • Updated OpenTelemtry dependencies to their latest available versions.

Monitor Query 1.0.1 Changelog

Bugs Fixed

  • Fixed the timeInterval field of MetricsQueryResult object to correctly return all the fields of QueryTimeInterval.

OpenTelemetry Instrumentation 1.0.0-beta.1 Changelog

This marks the first beta release of the OpenTelemetry Instrumentation library for the Azure SDK which will enable OpenTelemetry instrumentation for Azure SDK client libraries.

Resouce Management - Redis Enterprise Cache 2.0.0 Changelog

Resource Management - Application Insights 5.0.0-beta.1 Changelog

Resource Management - Application Insights 5.0.0-beta.2 Changelog

Resource Management - Commerce 4.0.0-beta.1 Changelog

Resource Management - Commitment Plans 2.0.0-beta.1 Changelog

Resource Management - Data Catalog 3.0.0 Changelog

Resource Management - Data Migration 3.0.0-beta.1 Changelog

Resource Management - Deployment Manager 4.0.0-beta.1 Changelog

Resource Management - Deployment Manager 4.0.0-beta.2 Changelog

Resource Management - Device Provisioning Services 4.1.0 Changelog

Resource Management - HANA on Azure 4.0.0-beta.1 Changelog

Resource Management - Health Care APIs 2.0.0 Changelog

Resource Management - Hybrid Compute 3.0.0 Changelog

Resource Management - IoT Central 6.0.0 Changelog

Resource Management - Key Vault 2.0.0 Changelog

Resource Management - Kubernetes Configuration 5.0.0-beta.1 Changelog

Resource Management - Kusto 7.0.0 Changelog

Resource Management - Lab Services 3.0.0-beta.1 Changelog

Resource Management - Machine Learning Compute 3.0.0-beta.1 Changelog

Resource Management - Machine Learning Experimentation 2.0.0-beta.1 Changelog

Resource Management - Machine Learning Services 5.0.0 Changelog

Resource Management - Management Partner 2.0.0 Changelog

Resource Management - Maps 3.0.0 Changelog

Resource Management - Maria DB 2.0.0 Changelog

Resource Management - Market Place Ordering 3.0.0 Changelog

Resource Management - Migrate 2.0.0 Changelog

Resource Management - Mixed Reality 4.0.1 Changelog

Resource Management - Mixed Reality 4.0.0 Changelog

Resource Management - NetApp 15.0.0 Changelog

Resource Management - Oep 1.0.0-beta.1 Changelog

Resource Management - Peering 2.0.0 Changelog

Resource Management - Policy Insights 5.0.0 Changelog

Resource Management - Postgresql 5.0.0 Changelog

Resource Management - Power BI Dedicated 3.0.0 Changelog

Resource Management - Power BI Embedded 2.0.0 Changelog

Resource Management - Private DNS 3.0.0 Changelog

Resource Management - Recovery Services Backup 8.0.0 Changelog

Resource Management - Recovery Services Site Recovery 4.0.0 Changelog

Resource Management - Reservations 7.0.0 Changelog

Resource Management - Resource Graph 5.0.0-beta.1 Changelog

Resource Management - Securityinsight 1.0.0-beta.1 Changelog

Resource Management - Serial Console 2.0.0 Changelog

Resource Management - Service Fabric Mesh 3.0.0-beta.1 Changelog

Resource Management - Service Map 3.0.0-beta.1 Changelog

Resource Management - SignalR 5.0.0 Changelog

Resource Management - StorSimple1200Series 2.0.0 Changelog

Resource Management - StorSimple8000Series 2.0.0 Changelog

Resource Management - Storage Cache 5.0.0 Changelog

Resource Management - Storage Import Export 2.0.0 Changelog

Resource Management - Storage Sync 9.0.0 Changelog

Resource Management - Subscriptions 5.0.0 Changelog

Resource Management - Support 2.0.0 Changelog

Resource Management - Synapse 8.0.0 Changelog

Resource Management - Time Series Insights 2.0.0 Changelog

Resource Management - Traffic Manager 6.0.0 Changelog

Resource Management - VMware CloudSimple 2.0.0 Changelog

Resource Management - Visual Studio 4.0.0-beta.1 Changelog

Resource Management - Web Services 1.0.0 Changelog

Resource Management - Work Spaces 1.0.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

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.

Web PubSub CloudEvents Handlers for Express 1.0.1 Changelog

Bugs Fixed

  • Fix the data definition for UserEventRequest when dataType is json. When dataType is json, data is the JSON parsed result from request body, so the type of data depends on the user scenario.
  • Fix the CloudEvents parsing issue that now data also can be boolean or number.

Latest Releases

View all the latest versions of JavaScript packages here.