Azure SDK for JavaScript (August 2023)
The Azure SDK team is pleased to announce our August 2023 client library releases.
40 packages released this month.
Stable Packages (16)
-
Core - Client - Auth
-
Core - Client - Core Rest Pipeline
-
Core - Client - Core Utils
-
Form Recognizer
-
Resource Management - Advisor
-
Resource Management - Batch
-
Resource Management - Cognitive Services
-
Resource Management - Compute
-
Resource Management - Container Service
-
Resource Management - Data Protection
-
Resource Management - Kusto
-
Resource Management - Managednetworkfabric
-
Resource Management - Mobile Network
-
Resource Management - NetApp Files
-
Resource Management - Network
-
Resource Management - Paloaltonetworksngfw
Patch Updates (3)
-
Core - Client - LRO
-
Identity
-
Key Vault - Keys
Beta Packages (21)
-
App Configuration
-
Artifacts
-
Cognitive Search
-
Communication Chat
-
Communication JobRouter
-
Communication Phone Numbers
-
OpenAI
-
OpenTelemetry Instrumentation
-
Resource Management - Authorization
-
Resource Management - Elasticsan
-
Resource Management - HDInsight
-
Resource Management - Iotfirmwaredefense
-
Resource Management - Networkcloud
-
Resource Management - Quantum
-
Resource Management - SQL
-
Resource Management - Sphere
-
Resource Management - Storage Mover
-
Resource Management - Web PubSub
-
Schema Registry Json
-
Storage - Blobs
-
Storage - Files Data Lake
Release highlights
App Configuration 1.5.0-beta.1 Changelog
Features Added
- With the new preview API version
2022-11-01-preview
, added configuration settings snapshot feature that allows users to create a point-in-time snapshot of their configuration store. #24535
Artifacts 1.0.0-beta.13 Changelog
Features Added
- Added
authenticationType
,containerUri
,sasUri
andsasToken
properties to BlobService - Added
setSystemVariable
proprety to SetVariableActivityTypeProperties - Added
mongoDbAtlasDriverVersion
property to MongoDbAtlasLinkedServiceTypeProperties - Added
ActionOnExistingTargetTable
property for Synapse Link - Added
OutputColumn
Object For Office365Source outputColumns - Added
configurationType
,targetSparkConfiguration
andsparkConfig
properties for SynapseNotebookActivityTypeProperties - Added
credential
property for LinkedService - Added
isolationLevel
property for SQLServerSource - Added new apis of Create/Cancel/GetStatus/GetSnapshot for RunNotebook
Cognitive Search 12.0.0-beta.3 Changelog
Features Added
- Add multi-vector search. #26765
Breaking Changes
- Change vector option
SearchOptions.vector
to array of vectors optionSearchOptions.vectors
. #26765
Communication Chat 1.3.2-beta.3 Changelog
Features Added
- Updated to
@azure/communication-common
3.0.0-beta.1
Communication JobRouter 1.0.0-beta.1 Changelog
Features Added
- Using
JobRouterAdministrationClient
- Create, update, get, list and delete
DistributionPolicy
. - Create, update, get, list and delete
RouterQueue
. - Create, update, get, list and delete
ClassificationPolicy
. - Create, update, get, list and delete
ExceptionPolicy
. - Using
JobRouterClient
- Create, update, get, list and delete
RouterJob
. RouterJob
can be created and updated with different matching modes:QueueAndMatchMode
,ScheduleAndSuspendMode
andSuspendMode
.- Re-classify a
RouterJob
. - Close a
RouterJob
. - Complete a
RouterJob
. - Cancel a
RouterJob
. - Un-assign a
RouterJob
, with option to suspend matching. - Get the position of a
RouterJob
in a queue. - Create, update, get, list and delete
RouterWorker
. - Accept an offer.
- Decline an offer.
- Get queue statistics.
Communication Phone Numbers 1.3.0-beta.1 Changelog
Features Added
- Number Lookup API public preview
- API version
2023-05-01-preview
is the default
Core - Client - Auth 1.5.0 Changelog
Features Added
- Added
enableCae
option toGetTokenOptions
to enable Continuous Access Evaluation in PR #26614.
Core - Client - Core Rest Pipeline 1.12.0 Changelog
Bugs Fixed
- Fix a TypeError in React Native when
Platform.constants
is undefined Issue #26609
Features Added
- Add CommonTelemetryOptions in PipelineOptions to allow customizing the client request id header name PR #26424
Core - Client - Core Utils 1.4.0 Changelog
Features Added
- Adds extra environment checks for browser or other environments PR #26018
- Add helper functions
uint8ArrayToString
andstringToUint8Array
for transform between string and bytes array with different character encodings.
Core - Client - LRO 2.5.4 Changelog
Bugs Fixed
- Support non-standard PATCH operations.
Form Recognizer 5.0.0 Changelog
Breaking Changes
From the last stable release (4.0.0):
- Support for passing alternative API versions has been removed from the client. In practice, the client only supported using a single API version, but types and options for specifying an API version were provided. In version 5.0.0, these options and their associated types were removed:
- The
apiVersion
option that was previously accepted by theDocumentAnalysisClient
andDocumentModelAdministrationClient
constructors was removed. This option previously only had one valid value in version 4.0.0, and supporting multiple API versions in a single package weakens the type constraints, so we have chosen to only support the latest Generally Available version of the service in this SDK package. Support for multiple API versions may be reintroduced in a future version. - The
FormRecognizerApiVersion
type and enum were removed as they no longer serve any purpose. - The type of
apiVersion
properties of result objects was changed fromFormRecognizerApiVersion
tostring
. This type is more accurate, as these fields reflect the API version used to create the model or start the analysis operation, and not necessarily an API version that the client instance is aware of. - The
FormRecognizerCommonClientOptions
interface, which bothDocumentAnalysisClientOptions
andDocumentModelAdministrationClientOptions
inherited from was removed, as it only carried theapiVersion
option that no longer exists. - The
languages
andkeyValuePairs
properties ofAnalyzeResult
that were previously returned when using theprebuilt-document
model are no longer returned unless the correspondingfeatures
are specified when making the analysis request.
From the last beta release (4.1.0-beta.1):
AnalyzeDocumentOptions.features
changed the following feature names:ocr.highResolution
renamed toocrHighResolution
.ocr.formula
renamed toformulas
.ocr.font
renamed tostyleFont
.- The following fields have been removed:
AnalyzeDocumentOptions.queryFields
DocumentPage.kind
andDocumentPage.images
(DocumentPageKind
andDocumentImage
types have been removed too.)DocumentKeyValuePair.commonName
- The type of the
docTypes
parameter ofbeginBuildDocumentClassifier
was refined slightly. The type will no longer accept bothazureBlobSource
andazureFileListSource
Features Added
- Updated the SDK to use the latest Generally Available (GA) version of the Form Recognizer REST API:
2023-07-31
. AnalyzeDocumentOptions.features
accepts three new features compared to the last beta version:barcodes
: enables the detection of barcodes in the document.keyValuePairs
: enable the detection of general key value pairs (form fields) in the document.languages
: enables the detection of the text content language.beginBuildDocumentModel
has a new overload that accepts aDocumentModelSource
in place of a rawcontainerUrl
. This allows training document models using the new Blob File List source (that is already supported by document classifiers). Like with classifiers, the source inputs are specified as an object containing anazureFileListSource
property or anazureBlobSource
property containing the respective details of each source type.
Identity 3.2.4 Changelog
Bug Fixes
- Fixed a bug related to Managed Identity Credential intermixing wrong scopes for successive
getToken()
calls.
Key Vault - Keys 4.7.2 Changelog
Bugs Fixed
- Fixed a bug where
listPropertiesOfKeysVersions
failed to retrieve the second page of results. Issue #26547; PR #26584. - Bumped
@azure/core-rest-pipeline
dependency to version including theisRestError
helper, which was used in PR #26016.
OpenAI 1.0.0-beta.4 Changelog
Bugs Fixed
- Fix a bug where server-sent events were not being parsed correctly.
Features Added
- Exporting individual capabilities as separate functions to be used in code-size-concious applications. For example, streaming completions can be imported individually as follows:
import { listCompletions, createOpenAI } from "@azure/openai/api";
const client = createOpenAI(endpoint, new AzureKeyCredential(azureApiKey));
const events = listCompletions(client, prompt, deploymentId, { maxTokens: 128 });
OpenTelemetry Instrumentation 1.0.0-beta.5 Changelog
Other Changes
- Updated to latest OTEL libraries
Resource Management - Advisor 3.2.0 Changelog
Resource Management - Authorization 10.0.0-beta.1 Changelog
Resource Management - Batch 9.0.0 Changelog
Resource Management - Cognitive Services 7.5.0 Changelog
Resource Management - Compute 21.1.0 Changelog
Resource Management - Container Service 19.1.0 Changelog
Resource Management - Data Protection 1.2.0 Changelog
Resource Management - Elasticsan 1.0.0-beta.2 Changelog
Resource Management - HDInsight 1.3.0-beta.1 Changelog
Resource Management - Iotfirmwaredefense 1.0.0-beta.1 Changelog
Resource Management - Kusto 8.0.0 Changelog
Resource Management - Managednetworkfabric 1.0.0 Changelog
Resource Management - Mobile Network 3.0.0 Changelog
Resource Management - NetApp Files 18.1.0 Changelog
Resource Management - Network 32.0.0 Changelog
Resource Management - Networkcloud 1.0.0-beta.2 Changelog
Resource Management - Paloaltonetworksngfw 1.0.0 Changelog
Resource Management - Quantum 1.0.0-beta.1 Changelog
Resource Management - SQL 10.1.0-beta.1 Changelog
Resource Management - Sphere 1.0.0-beta.1 Changelog
Resource Management - Storage Mover 2.0.0-beta.1 Changelog
Resource Management - Web PubSub 2.0.0-beta.1 Changelog
Schema Registry Json 1.0.0-beta.1 Changelog
- Initial preview release
Storage - Blobs 12.16.0-beta.1 Changelog
Features Added
- Added support for service version 2023-08-03.
- Added rehydrate-pending-to-cold value to ArchiveStatus enum.
Storage - Files Data Lake 12.15.0-beta.1 Changelog
Features Added
- Added support for service version 2023-08-03.
- Added support for paginated directory delete when using AAD authentication. Note that this feature only applies to HNS storage accounts.
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@5.0.0
$> npm install @azure/app-configuration@1.5.0-beta.1
$> npm install @azure/arm-advisor@3.2.0
$> npm install @azure/arm-authorization@10.0.0-beta.1
$> npm install @azure/arm-batch@9.0.0
$> npm install @azure/arm-cognitiveservices@7.5.0
$> npm install @azure/arm-compute@21.1.0
$> npm install @azure/arm-containerservice@19.1.0
$> npm install @azure/arm-dataprotection@1.2.0
$> npm install @azure/arm-elasticsan@1.0.0-beta.2
$> npm install @azure/arm-hdinsight@1.3.0-beta.1
$> npm install @azure/arm-iotfirmwaredefense@1.0.0-beta.1
$> npm install @azure/arm-kusto@8.0.0
$> npm install @azure/arm-managednetworkfabric@1.0.0
$> npm install @azure/arm-mobilenetwork@3.0.0
$> npm install @azure/arm-netapp@18.1.0
$> npm install @azure/arm-network@32.0.0
$> npm install @azure/arm-networkcloud@1.0.0-beta.2
$> npm install @azure/arm-paloaltonetworksngfw@1.0.0
$> npm install @azure/arm-quantum@1.0.0-beta.1
$> npm install @azure/arm-sphere@1.0.0-beta.1
$> npm install @azure/arm-sql@10.1.0-beta.1
$> npm install @azure/arm-storagemover@2.0.0-beta.1
$> npm install @azure/arm-webpubsub@2.0.0-beta.1
$> npm install @azure/communication-chat@1.3.2-beta.3
$> npm install @azure/communication-job-router@1.0.0-beta.1
$> npm install @azure/communication-phone-numbers@1.3.0-beta.1
$> npm install @azure/core-auth@1.5.0
$> npm install @azure/core-lro@2.5.4
$> npm install @azure/core-rest-pipeline@1.12.0
$> npm install @azure/core-util@1.4.0
$> npm install @azure/identity@3.2.4
$> npm install @azure/keyvault-keys@4.7.2
$> npm install @azure/openai@1.0.0-beta.4
$> npm install @azure/opentelemetry-instrumentation-azure-sdk@1.0.0-beta.5
$> npm install @azure/schema-registry-json@1.0.0-beta.1
$> npm install @azure/search-documents@12.0.0-beta.3
$> npm install @azure/storage-blob@12.16.0-beta.1
$> npm install @azure/storage-file-datalake@12.15.0-beta.1
$> npm install @azure/synapse-artifacts@1.0.0-beta.13
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