The Azure SDK team is pleased to announce our October 2021 client library releases.

31 packages released this month.

Stable Packages (7)

  • Communication Chat

  • Event Grid

  • Monitor Query

  • Storage - Blobs

  • Storage - Files Data Lake

  • Storage - Files Shares

  • Storage - Queues

Patch Updates (5)

  • Core - Client

  • Core - HTTP

  • Core - LRO

  • Core - Logger

  • Core Rest Pipeline

Beta Packages (19)

  • Azure Mixed Reality Authentication

  • Azure Remote Rendering

  • Cognitive Search

  • Form Recognizer

  • Key Vault - Keys

  • Monitor OpenTelemetry Exporter

  • Resource Management - Api Management

  • Resource Management - Event Grid

  • Resource Management - Event Hubs

  • Resource Management - Extendedlocation

  • Resource Management - Purview

  • Resource Management - Quota

  • Resource Management - Redis Cache

  • Resource Management - SQL

  • Schema Registry

  • Schema Registry - Avro

  • Service Bus

  • Synapse - Artifacts

  • Synapse - Spark

Release highlights

Azure Mixed Reality Authentication 1.0.0-beta.1 Changelog

  • Initial release.

Azure Remote Rendering 1.0.0-beta.1 Changelog

  • Initial release.

Cognitive Search 11.3.0-beta.4 Changelog

Breaking Changes

  • Changed property ignoreResetRequirements to skipIndexerResetRequirementForCache in CreateorUpdateDataSourceConnectionOptions, CreateorUpdateIndexerOptions & CreateOrUpdateSkillsetOptions objects.
  • Changed the type of answers property from Answers to QueryAnswerType, in the SearchRequest object.
  • Changed the type of captions property from Captions to QueryCaptionType, in the SearchRequest object.
  • Changed the type of speller property from Speller to QuerySpellerType, in the SearchRequest object.
  • Changed the underlying dependency of the SDK from core-http to core-rest-pipeline package.

Features Added

  • Added properties currentState & statusDetail to the IndexerExecutionResult object.
  • Added operations resetDocs & resetSkills to the SearchIndexerClient class.

Communication Chat 1.1.0 Changelog

Features Added

  • 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.
  • Updated to @azure/communication-signaling@1.0.0-beta.10.

Core - Client 1.3.1 Changelog

Other Changes

  • Updates package to work with the react native bundler. Browser APIs may still need to be pollyfilled for this package to run in react native. PR #17783

Core - HTTP 2.2.1 Changelog

Bugs Fixed

  • Fix incorrect caching of proxy agents PR #17546

Core - LRO 2.2.1 Changelog

Bugs Fixed

  • Check for string type before calling toLowerCase(). PR #17573

Core - Logger 1.0.3 Changelog

Other Changes

  • Updates package to work with the react native bundler. PR #17783

Core Rest Pipeline 1.3.1 Changelog

Bugs Fixed

  • Addressed an issue on Node where aborting a request while its response body was still be processed would cause the HttpClient to emit a RestError rather than the appropriate AbortError. PR #17956

Event Grid 4.5.0 Changelog

Features Added

  • Added new properties for the Microsoft.Media.LiveEventIngestHeartbeat System Event:

  • ingestDriftValue
  • lastFragmentArrivalTime
  • transcriptionLanguage
  • transcriptionState

  • Added new System Events:
  • API Management:
  • Microsoft.ApiManagement.APICreated
  • Microsoft.ApiManagement.APIDeleted
  • Microsoft.ApiManagement.APIReleaseCreated
  • Microsoft.ApiManagement.APIReleaseDeleted
  • Microsoft.ApiManagement.APIReleaseUpdated
  • Microsoft.ApiManagement.APIUpdated
  • Microsoft.ApiManagement.ProductCreated
  • Microsoft.ApiManagement.ProductDeleted
  • Microsoft.ApiManagement.ProductUpdated
  • Microsoft.ApiManagement.SubscriptionCreated
  • Microsoft.ApiManagement.SubscriptionDeleted
  • Microsoft.ApiManagement.SubscriptionUpdated
  • Microsoft.ApiManagement.UserCreated
  • Microsoft.ApiManagement.UserDeleted
  • Microsoft.ApiManagement.UserUpdated
  • Container Service:
  • Microsoft.ContainerService.NewKubernetesVersionAvailable
  • Communication:
  • Microsoft.Communication.UserDisconnected
  • Media Streaming:
  • Microsoft.Media.LiveEventChannelArchiveHeartbeat

Form Recognizer 4.0.0-beta.1 Changelog

Breaking Changes

  • This package targets Azure Form Recognizer service API version 2021-09-30-preview and newer. It is not compatible with the older Form Recognizer service API versions (2.0 and 2.1). To continue to use Form Recognizer API version 2.1, please use major version 3 of the client package (@azure/ai-form-recognizer@^3.2.0).
  • FormRecognizerClient has been replaced by DocumentAnalysisClient.
  • The new beginExtractLayout method replaces the previous beginRecognizeContent method and its -FromUrl counterpart. Rather than a FormPageArray, the new method produces an object that has properties for pages, tables, and styles.
  • The new beginAnalyzeDocuments method replaces the form recognition methods of the previous client. It provides a single method that can analyze documents using any model ID, including prebuilt models. It replaces beginRecognizeCustomForms, beginRecognizeReceipts, beginRecognizeBusinessCards, beginRecognizeInvoices, and beginRecognizeIdentityDocuments, as well as all of their -FromUrl counterparts. Rather than an array of forms, the new method produces an AnalyzeResult (an object with several fields, described below).
  • Analysis using models trained without labeled training data is no longer supported by this package. This use-case is now provided by the prebuilt (generic) document model (see “New Features” below).
  • The language option has been renamed to locale, and it accepts a wider variety of locale codes (such as “en-US” for United States English) as well as two-letter language codes (such as “fr” for French).
  • The pages option is now a single string instead of an array of strings. Multiple page ranges may be specified by separating them with commas.
  • In many output types, boundingBox has been replaced by a list of boundingRegions, which may contain a bounding box and page number. This is useful for objects that may span multiple pages.
  • FormTrainingClient has been replaced by DocumentModelAdministrationClient.
  • The new beginBuildModel method replaces the previous beginTraining method. The new method and underlying service API do not support training a model using unlabeled training data. Labeled data are required to build a custom document model using the new SDK and service API.
  • The new beginComposeModel method replaces the beginCreateComposedModel method.
  • The getCopyAuthorization method no longer requires the target resource name and region, instead requiring only a model ID/name.
  • The getModel and listModels methods replace the getCustomModel and listCustomModels methods, as the new methods support prebuilt models as well as custom models. They no longer produce any information about models that did not succeed (if a model creation operation failed, it will not be included in the output of listModels and cannot be retrieved with getModel by model ID).
  • Custom models no longer have a name that is distinct from the model ID (more accurately, the model ID and name have been unified).
  • You must now specify a model ID to create a model (whether composed, copied, or built). Previously, the Form Recognizer service would generate a GUID for the newly-created model. Now, the model ID may be any text (so long as it does not start with “prebuilt-“), and it must be provided when the model is created.
  • The ModelInfo type (previously CustomFormModelInfo) has been redesigned. It no longer contains trainingDocuments, and it has a property called docTypes that contains the information previously contained in submodels, but with a different shape. Please refer to the documentation for more information, as this type has changed significantly.
  • The structure of many output types has changed. The full list of changes is extensive and discussed in depth in the migration guide. The following are some of the changes:
  • When analyzing a document, the output is no longer an array of RecognizedForms. All analysis methods—including custom/prebuilt model analysis, layout, and the generic document model—produce an AnalyzeResult or a subset thereof. The AnalyzeResult has fields for pages, tables, styles, entities, keyValuePairs, and documents. The beginExtractLayout and beginExtractGenericDocument methods produce subtypes (LayoutResult and GenericDocumentResult respectively) of AnalyzeResult that contain only those fields that are produced by that model. The list of changes within these types is extensive, as they have been redesigned. Please consult the documentation for more information.
  • The new type AnalyzedDocument replaces RecognizedForm. It does not contain a pages property, as pages are now a top-level property of the AnalyzeResult.
  • The new type DocumentPage replaces FormPage. It does not have a tables property, as tables are now a top-level property of the AnalyzeResult.
  • The DocumentLine type (replacing FormLine) no longer has a words property, as words is now a property of the DocumentPage. The DocumentLine instead contains spans which can be used to correlate DocumentWords to DocumentLines, as words are no longer required to be part of a line.

Key Vault - Keys 4.4.0-beta.2 Changelog

Features Added

  • Added support for KeyClient.getCryptographyClient(keyName, options) which provides a simple way to create a CryptographyClient for a given key (identified by its name).
  • An optional keyVersion property may be used in the options parameter to create a cryptography client targeting a specific key version. The latest version is used by default.
  • Added support for automated key rotation in Azure Key Vault.
  • Added KeyClient.rotateKey to rotate a key on-demand.
  • Added KeyClient.updateKeyRotationPolicy to update a key’s automated rotation policy.
  • Added JsonWebKey.key_ops property to JsonWebKey in addition to the existing JsonWebKey.keyOps property in order to comply with the JSON Web Key spec.

Monitor OpenTelemetry Exporter 1.0.0-beta.5 Changelog

Bugs Fixed

  • Fixed issue with SDK version field not being populated correctly.

Monitor Query 1.0.0 Changelog

Breaking Changes

  • Renamed ErrorInfo to LogsErrorInfo, which now extends the Error class and code as an additional property. Removed all the other properties.
  • query method in LogsQueryClient renamed to queryWorkspace
  • query method in MetricsQueryClient renamed to queryResource
  • Renamed the status types in LogsQueryResultStatus. Partial to PartialFailure and Failed to Failure.
  • Renamed timeGrain in MetricAvailability to granularity
  • Renamed TimeInterval to QueryTimeInterval
  • Updated constants in Durations to camel-case.
  • Removed credentialOptions.credentialScopes property in LogsQueryClientOptions since scopes other than default are not supported yet.
  • Removed throwOnAnyError flag from LogsQueryOptions and LogsQueryBatchOptions
  • Removed the error classes BatchError and AggregateBatchError
  • Updated LogsQueryBatchResult object to be a list of objects with the following possible types:
  • LogsQueryPartialResult
  • LogsQuerySuccessfulResult
  • LogsQueryError
  • Updated LogsQueryResult object to be of type LogsQuerySuccessfulResult or LogsQueryPartialResult

Features Added

  • Enabled browser support
  • Added different result objects LogsQueryPartialResult, LogsQuerySuccessfulResult or LogsQueryError based on the success scenarios for log queries.

Bugs Fixed

  • Updated listMetricNamespaces signature to return the list of appropriate MetricsNamespaces object type

Resource Management - Api Management 30.0.0-beta.1 Changelog

Resource Management - Event Grid 30.0.0-beta.1 Changelog

Resource Management - Event Hubs 30.0.0-beta.2 Changelog

Resource Management - Extendedlocation 1.0.0-beta.1 Changelog

Resource Management - Purview 1.0.0-beta.1 Changelog

Resource Management - Quota 1.0.0-beta.1 Changelog

Resource Management - Redis Cache 30.0.0-beta.1 Changelog

Resource Management - SQL 30.0.0-beta.4 Changelog

Schema Registry 1.0.0-beta.3 Changelog

Breaking Changes

  • renames SchemaDescription’s group to groupName
  • renames SchemaId to SchemaProperties
  • renames getSchemaById to getSchema
  • renames GetSchemaByIdOptions to GetSchemaOptions
  • renames content to schemaDefinition, serializationType to format, and KnownSerializationType to KnownSchemaFormat

Schema Registry - Avro 1.0.0-beta.3 Changelog

Breaking Changes

  • schemaGroup is no longer a constructor parameter and has been moved to the constructor options because it is only required for serialization.

Service Bus 7.4.0-beta.1 Changelog

Features Added

  • Adds new get/set property maxMessageSizeInKilobytes to QueueProperties, TopicProperties, CreateQueueOptions, and CreateTopicOptions. Only applicable for premium namespaces. Use this when creating or updating queues and topics. Added in #17953

Storage - Blobs 12.8.0 Changelog

Features Added

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

Storage - Files Data Lake 12.7.0 Changelog

Features Added

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

Storage - Files Shares 12.8.0 Changelog

Features Added

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

Storage - Queues 12.7.0 Changelog

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.

Synapse - Artifacts 1.0.0-beta.6 Changelog

Other Changes

  • Upgrade to package-artifacts-composite-v1

  • Added SparkConfiguration, KqlScripts and associated support types.
  • Update type of many modles from string to object
  • SparkJobDefinition, Notebook and SqlScript now has a folder property
  • SqlConnection now has poolName and databaseName properties

Synapse - Spark 1.0.0-beta.4 Changelog

Features Added

  • Re-generate with latest release tag package-spark-2020-12-01
  • Update LivyState to be an extensible enum.

Latest Releases

View all the latest versions of JavaScript packages here.

Installation Instructions

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

$> npm install @azure/ai-form-recognizer@4.0.0-beta.1
$> npm install @azure/arm-apimanagement@30.0.0-beta.1
$> npm install @azure/arm-eventgrid@30.0.0-beta.1
$> npm install @azure/arm-eventhub@30.0.0-beta.2
$> npm install @azure/arm-extendedlocation@1.0.0-beta.1
$> npm install @azure/arm-purview@1.0.0-beta.1
$> npm install @azure/arm-quota@1.0.0-beta.1
$> npm install @azure/arm-rediscache@30.0.0-beta.1
$> npm install @azure/arm-sql@30.0.0-beta.4
$> npm install @azure/communication-chat@1.1.0
$> npm install @azure/core-client@1.3.1
$> npm install @azure/core-http@2.2.1
$> npm install @azure/core-lro@2.2.1
$> npm install @azure/core-rest-pipeline@1.3.1
$> npm install @azure/eventgrid@4.5.0
$> npm install @azure/keyvault-keys@4.4.0-beta.2
$> npm install @azure/logger@1.0.3
$> npm install @azure/mixed-reality-authentication@1.0.0-beta.1
$> npm install @azure/mixed-reality-remote-rendering@1.0.0-beta.1
$> npm install @azure/monitor-opentelemetry-exporter@1.0.0-beta.5
$> npm install @azure/monitor-query@1.0.0
$> npm install @azure/schema-registry@1.0.0-beta.3
$> npm install @azure/schema-registry-avro@1.0.0-beta.3
$> npm install @azure/search-documents@11.3.0-beta.4
$> npm install @azure/service-bus@7.4.0-beta.1
$> npm install @azure/storage-blob@12.8.0
$> npm install @azure/storage-file-datalake@12.7.0
$> npm install @azure/storage-file-share@12.8.0
$> npm install @azure/storage-queue@12.7.0
$> npm install @azure/synapse-artifacts@1.0.0-beta.6
$> npm install @azure/synapse-spark@1.0.0-beta.4


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