Azure SDK for JavaScript (April 2023)
The Azure SDK team is pleased to announce our April 2023 client library releases.
60 packages released this month.
Stable Packages (31)
-
Common
-
Communication Email
-
Communication Phone Numbers
-
Core - Client - AMQP
-
Core - Client - Core Utils
-
Key Vault - Administration
-
Key Vault - Certificates
-
Key Vault - Keys
-
Key Vault - Secrets
-
Resource Management - App Service
-
Resource Management - Communication
-
Resource Management - Container Registry
-
Resource Management - Container Service
-
Resource Management - Data Factory
-
Resource Management - Data Protection
-
Resource Management - Desktop Virtualization
-
Resource Management - Digital Twins
-
Resource Management - NetApp Files
-
Resource Management - Network
-
Resource Management - Orbital
-
Resource Management - Recovery Services Backup
-
Resource Management - Reservations
-
Resource Management - Resources
-
Resource Management - SQL
-
Resource Management - SignalR
-
Resource Management - Web PubSub
-
Service Bus
-
Storage - Blobs
-
Storage - Files Data Lake
-
Storage - Files Share
-
Storage - Queues
Patch Updates (9)
-
Core - Client - Core Rest Pipeline
-
Core - Client - Core Utils
-
Core - Client - HTTP
-
Core - Client - Http Compat
-
Core - Client - LRO
-
Core - Client - Rest
-
Identity
-
Tables
-
Web PubSub CloudEvents Handlers for Express
Beta Packages (20)
-
Communication Chat
-
Communication Common
-
Container Registry
-
Cosmos DB
-
Form Recognizer
-
Identity
-
Resource Management - App Platform
-
Resource Management - Communication
-
Resource Management - Cosmos DB
-
Resource Management - Graphservices
-
Resource Management - Hybrid Container Service
-
Resource Management - Monitor
-
Resource Management - Newrelicobservability
-
Resource Management - Security
-
Resource Management - Storage Cache
-
Storage - Blobs
-
Storage - Files Data Lake
-
Storage - Files Share
-
Web PubSub Client
-
WebPubSub Client SDK Protobuf
Release highlights
Common 1.0.0 Changelog
Features Added
- Initial release of the keyvault-common package. The package is intended for internal consumption only and only exposes helpers and other common code used by the Key Vault SDKs.
Communication Chat 1.3.2-beta.1 Changelog
Features Added
- Added inline image support
- Updated @azure/communication-signaling to 1.0.0-beta.17 with inline image support.
Communication Common 3.0.0-beta.1 Changelog
Breaking Changes
- Introduction of
MicrosoftBotIdentifier
is a breaking change. It will affect code that relied on usingUnknownIdentifier
with a rawID starting with28:
Features Added
- Added support for a new communication identifier
MicrosoftBotIdentifier
.
Communication Email 1.0.0 Changelog
The public release of the Azure Communication Services SDK for Email has the following features:
- send emails with a variety of options (multiple recipients, attachments, etc.)
- poll for the status of the email that was sent to track its progress
Communication Phone Numbers 1.2.0 Changelog
Breaking Changes
- Changed public methods
getTrunks
tolistTrunks
andgetRoutes
tolistRoutes
.
Features Added
- Added support for SIP routing API version
2023-03-01
, releasing SIP routing functionality from public preview to GA. - Added environment variable
AZURE_TEST_DOMAIN
for SIP routing tests to support domain verification.
Container Registry 1.1.0-beta.3 Changelog
Features Added
- Added support for uploading and downloading manifests of a custom media type.
- Pass the media type of the manifest you are downloading using the
mediaType
property ofsetManifest
options bag. - On download, OCI image manifests will be deserialized. The deserialized manifest will be available at the
manifest
property of the result fromgetManifest
. - Manifests of other media types will not be deserialized, but manifests of all types will still be accessible using the
content
property of the result. - The
isGetOciImageManifestResult
type guard can be used to check if the downloaded manifest is an OCI image manifest, and therefore whether themanifest
property is available on the result.
Bugs Fixed
- Fixed a bug where an unused stream was not cleaned up when calling
deleteBlob
.
Breaking Changes
- Renamed
ContainerRegistryBlobClient
toContainerRegistryContentClient
. - Renamed
downloadManifest
anduploadManfifest
methods onContainerRegistryContentClient
togetManifest
andsetManifest
respectively. - Renamed
DownloadManifestOptions
andUploadManifestOptions
types toGetManifestOptions
andSetManifestOptions
respectively. - Renamed
OciManifest
toOciImageManifest
. - Renamed
OciImageManifest.config
toOciImageManifest.configuration
- The
configuration
andlayers
parameters onOciImageManifest
are now required. - Renamed
OciBlobDescriptor
type toOciDescriptor
. - Renamed property
OciBlobDescriptor.size
toOciBlobDescriptor.sizeInBytes
.
Core - Client - AMQP 3.3.0 Changelog
Other Changes
- upgrade dependency
rhea-promise
version to^3.0.0
.
Core - Client - Core Rest Pipeline 1.10.3 Changelog
Other Changes
- Migrate to use core-util UUID helper PR# 25413
Core - Client - Core Utils 1.3.0 Changelog
Features Added
- Add
randomUUID
to generate a random UUID. PR #25408
Core - Client - Core Utils 1.3.1 Changelog
Bugs Fixed
Core - Client - HTTP 3.0.1 Changelog
Other Changes
- Upgrade dependency
xml2js
version to^0.5.0
.
Core - Client - Http Compat 2.0.1 Changelog
Bugs Fixed
- Fix issue with disable keep alive policy being added multiple times PR #25110
Core - Client - LRO 2.5.2 Changelog
Bugs Fixed
- Change the logging level for unrecognized operation statuses from warning to verbose.
Core - Client - Rest 1.1.2 Changelog
Bugs Fixed
- fix unexpected url encoding when apiVersionPolicy applies and even if we have passed the skipUrlEncoding as true in the request.
Cosmos DB 3.17.4-beta.1 Changelog
Features Added
- Added support for hierarchical partitions.
Form Recognizer 4.1.0-beta.1 Changelog
Bugs Fixed
- Form Recognizer pollers (
AnalysisPoller
,DocumentModelPoller
, andDocumentClassifierPoller
) will now appropriately handle the HTTPRetry-After
header. If the Form Recognizer service sends aRetry-After
header in its response, the poller will wait at least that long before polling again. This prevents the poller from making too many requests if the service tells the client to wait. - Form Recognizer pollers will now appropriately handle
AbortSignal
cancellation. If the client passes anAbortSignal
to a long-running operation (such as any of the model/classifier creation operations or any analysis operation), theAbortSignal
may now be used to abort the operation. The poller will stop polling, any requests in progress will be aborted, and the poller will throw anAbortError
. - Fixed a bug in which fields of strongly-typed custom
DocumentModel
objects that contain spaces in their field names were not handled correctly. A field named"Account Number"
will now be represented asaccountNumber
in theDocumentModel
object, instead of"account Number"
. None of the supported prebuilt DocumentModel objects are affected by this change.
Features Added
- Added support for Form Recognizer API version
2023-02-28-preview
. This is the default API version for SDK version4.1.0-beta.1
. For a detailed list of changes included in this API version, see the Form Recognizer release notes. - Added an
expiresOn
property toDocumentModelSummary
andDocumentModelDetails
. If this field is populated, it contains the date and time that the model will expire and will no longer be usable. - Added support for custom classification models. Classifiers combine layout and language features to accurately identify documents from among a set of document types.
- Added
beginBuildDocumentClassifier
toDocumentModelAdministrationClient
to build a custom classifier from training documents. See the service documentation on custom classifiers for more information on creating a training data set and creating a classifier. - Added
getDocumentClassifier
,listDocumentClassifiers
, anddeleteDocumentClassifier
methods toDocumentModelAdministrationClient
to manage custom classifiers. - Added
beginClassifyDocument
andbeginClassifyDocumentFromUrl
toDocumentAnalysisClient
to classify documents using a custom classification model. - The
getOperation
method can now returnDocumentClassifierBuildOperationDetails
for classifier build operations. - Added
features
toAnalyzeDocumentOptions
. Features are add-on capabilities that must be explicitly activated in order to extract them. The use of features may incur additional costs, so please review the service documentation of add-on capabilities for more information. The Form Recognizer service has introduced four features in this API version: ocr.highResolution
: improves the quality of content extraction for A1/A2/A3 documents with small text.ocr.formula
: enables extraction of formulas, such as mathematical equations.ocr.font
: extends the existingstyles
property to include more font properties such assimilarFontFamily
for the font face of the text,fontStyle
for styles such as italics,fontWeight
for boldness,color
, andbackgroundColor
.queryFields.premium
: enables the use ofqueryFields
(see below).- Added
queryFields
toAnalyzeDocumentOptions
. The service now supports extracting additional query fields using Azure OpenAI capabilities. This feature may only be used if the"queryFields.premium"
feature is enabled (see above). See the service documentation on query fields for more information. - Updated the
AddressValue
type to include several new fields:cityDistrict
,house
,level
,stateDistrict
,suburb
, andunit
. Please see the documentation of these fields for more information. - Added a
currencyCode
field toCurrencyValue
. This field contains the normalized ISO 4217 currency code for the currency value. - Added a
commonName
field toDocumentKeyValuePair
. This field contains a normalized “common” name for the field if the service was able to extract one. - Added a new field
annotations
and corresponding typeDocumentAnnotation
toDocumentPage
. This new page-level property contains information about extracted “annotations,” which are visual marks like checkmarks or crosses. - Added a new field
barcodes
and corresponding typeDocumentBarcode
toDocumentPage
. This new page-level property contains information about extracted barcodes, including the type of the barcode (kind
) and the decoded data (value
). - Added a new field
formulas
and corresponding typeDocumentFormula
toDocumentPage
. This new page-level property contains information about extracted formulas, including thekind
of formula (“display” or “inline”) and an equivalent LaTeX expression (value
). This field is only populated if the"ocr.formula"
feature is enabled. - Added a new field
images
and corresponding typeDocumentImage
toDocumentPage
. This page-level property contains information about images in the document. Images are represented by other pages, and theDocumentImage
type contains the page number of the image’s data (pageNumber
, note that this is a 1-based index) and the bounding polygon of the image. - Added a new
kind
field toDocumentPage
. This field indicates what kind of content the page represents. The possible kinds are “document”, “sheet”, “slide”, and “image”. - Added a new
DocumentBooleanField
type for extracted fields that contain boolean values. This type is used in thefields
data of anAnalyzedDocument
. - Added new fields
backgroundColor
,color
,fontStyle
,fontWeight
, andsimilarFontFamily
toDocumentStyle
. These fields contain additional information about the font style of extracted text and will only be populated if the"ocr.font"
feature is enabled. - Added a new field
customNeuralDocumentModelBuilds
toResourceDetails
that contains information about the neural model build quota. This field has the typeQuotaDetails
and contains information about how many custom neural models may be built (quota
), how many have been built (used
), and when the quota will be reset (quotaResetOn
).
Identity 3.1.4 Changelog
Bugs Fixed
- Added a workaround of fetching all accounts from token cache to fix the issue of silent authentication not taking place when authenticationRecord is passed. For reference, see issue.
Identity 3.2.0-beta.2 Changelog
Features Added
- Added configurable process timeout for dev-time credentials -
AzureCLI Credential
,AzurePowershell Credential
andAzureDeveloperCLI Credential
.
Bugs Fixed
- Fixed a bug in
WorkloadIdentity Credential
, to incorporate the case where the options can beundefined
in a conditional check. Related issue #25089 with the fix #25119. - Exported
WorkloadIdentityDefaultCredentialOptions
which was previously not publicly exported inindex.ts
.
Key Vault - Administration 4.4.0 Changelog
Features Added
- Added
KeyVaultSettingsClient
to get and update Managed HSM settings.
Key Vault - Certificates 4.7.0 Changelog
Other Changes
- Updated
CertificateClient
to support service version 7.4 by default.
Key Vault - Keys 4.7.0 Changelog
Breaking Changes
- Removed support for OKP key types as introduced in 4.7.0-beta.1. These changes are only breaking for customers consuming the 4.7.0-beta.1 API, and do not affect those consuming a stable release such as 4.6.0.
- Removed
OKP
andOKP-HSM
fromKnownKeyTypes
. - Removed
EdDSA
fromKnownSignatureAlgorithms
. - Removed
Ed25519
fromKnownKeyCurveNames
.
Key Vault - Secrets 4.7.0 Changelog
Other Changes
- Updated
SecretClient
to support service version 7.4 by default.
Resource Management - App Platform 3.0.0-beta.1 Changelog
Resource Management - App Service 14.0.0 Changelog
Resource Management - Communication 4.0.0-beta.4 Changelog
Resource Management - Communication 4.0.0 Changelog
Resource Management - Container Registry 10.1.0 Changelog
Resource Management - Container Service 17.4.0 Changelog
Resource Management - Cosmos DB 15.4.0-beta.1 Changelog
Resource Management - Data Factory 11.1.0 Changelog
Resource Management - Data Protection 1.0.0 Changelog
Resource Management - Desktop Virtualization 1.0.0 Changelog
Resource Management - Digital Twins 3.3.0 Changelog
Resource Management - Graphservices 1.0.0-beta.1 Changelog
Resource Management - Hybrid Container Service 1.0.0-beta.2 Changelog
Resource Management - Monitor 8.0.0-beta.4 Changelog
Resource Management - NetApp Files 18.0.0 Changelog
Resource Management - Network 30.2.0 Changelog
Resource Management - Newrelicobservability 1.0.0-beta.1 Changelog
Resource Management - Orbital 2.0.0 Changelog
Resource Management - Recovery Services Backup 10.1.0 Changelog
Resource Management - Reservations 9.0.0 Changelog
Resource Management - Resources 5.2.0 Changelog
Resource Management - SQL 10.0.0 Changelog
Resource Management - Security 6.0.0-beta.3 Changelog
Resource Management - SignalR 5.2.0 Changelog
Resource Management - Storage Cache 7.0.0-beta.1 Changelog
Resource Management - Web PubSub 1.1.0 Changelog
Service Bus 7.9.0 Changelog
Bugs Fixed
- Fix an issue of over-adding credits when receiving messages in a batch PR #25185
- Fix a race condition in initializing management links PR #25279
Uint8Array
payload is converted into JSON before being sent. This PR fixes it so thatUint8Array
is being treated the same as a Buffer.- Fix an issue where closing receiver could be blocked indefinitely when we don’t receive a drain credit response.
- Fix an edge case issue where
receiveMessages()
may never resolve indefinitely. PR #25355
Storage - Blobs 12.14.0-beta.1 Changelog
Features Added
- Added support for service version 2022-11-02.
Storage - Blobs 12.14.0 Changelog
Bugs Fixed
- Fixed an issue of: StoragePipelineOptions is not passed into constructors for blob clients correctly when using undefined as credential parameter.
Features Added
- Includes all features released in 12.14.0-beta.1.
Storage - Files Data Lake 12.13.0-beta.1 Changelog
Features Added
- Added support for service version 2022-11-02.
- Added support for Encryption Context.
Storage - Files Data Lake 12.13.0 Changelog
Features Added
- Includes all features released in 12.13.0-beta.1.
Storage - Files Share 12.14.0-beta.1 Changelog
Features Added
- Added support for service version 2022-11-02.
- Added support OAuth.
- Added support for Trailing Dot.
Storage - Files Share 12.14.0 Changelog
Features Added
- Includes all features released in 12.14.0-beta.1.
Storage - Queues 12.13.0 Changelog
Features Added
- Added support for service version 2022-11-02.
Tables 13.2.2 Changelog
Bugs Fixed
- Fix issue #25252 where SAS was signed using srk, spk, erk and epk but the query parameters were not included in the result causing all requests with scoped partition and row keys to fail with
AuthorizationFailure
. 25293
Web PubSub Client 1.0.0-beta.3 Changelog
Bugs Fixed
- Fix the bug that
isDuplicated
is alwaystrue
Web PubSub CloudEvents Handlers for Express 1.0.4 Changelog
Bugs Fixed
- Address issue with
query
property from CloudEvent https://github.com/Azure/azure-sdk-for-js/issues/24515
WebPubSub Client SDK Protobuf 1.0.0-beta.1 Changelog
Features Added
- Initial beta release
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-rest/core-client@1.1.2
$> npm install @azure/ai-form-recognizer@4.1.0-beta.1
$> npm install @azure/arm-appplatform@3.0.0-beta.1
$> npm install @azure/arm-appservice@14.0.0
$> npm install @azure/arm-communication@4.0.0-beta.4
$> npm install @azure/arm-communication@4.0.0
$> npm install @azure/arm-containerregistry@10.1.0
$> npm install @azure/arm-containerservice@17.4.0
$> npm install @azure/arm-cosmosdb@15.4.0-beta.1
$> npm install @azure/arm-datafactory@11.1.0
$> npm install @azure/arm-dataprotection@1.0.0
$> npm install @azure/arm-desktopvirtualization@1.0.0
$> npm install @azure/arm-digitaltwins@3.3.0
$> npm install @azure/arm-graphservices@1.0.0-beta.1
$> npm install @azure/arm-hybridcontainerservice@1.0.0-beta.2
$> npm install @azure/arm-monitor@8.0.0-beta.4
$> npm install @azure/arm-netapp@18.0.0
$> npm install @azure/arm-network@30.2.0
$> npm install @azure/arm-newrelicobservability@1.0.0-beta.1
$> npm install @azure/arm-orbital@2.0.0
$> npm install @azure/arm-recoveryservicesbackup@10.1.0
$> npm install @azure/arm-reservations@9.0.0
$> npm install @azure/arm-resources@5.2.0
$> npm install @azure/arm-security@6.0.0-beta.3
$> npm install @azure/arm-signalr@5.2.0
$> npm install @azure/arm-sql@10.0.0
$> npm install @azure/arm-storagecache@7.0.0-beta.1
$> npm install @azure/arm-webpubsub@1.1.0
$> npm install @azure/communication-chat@1.3.2-beta.1
$> npm install @azure/communication-common@3.0.0-beta.1
$> npm install @azure/communication-email@1.0.0
$> npm install @azure/communication-phone-numbers@1.2.0
$> npm install @azure/container-registry@1.1.0-beta.3
$> npm install @azure/core-amqp@3.3.0
$> npm install @azure/core-http@3.0.1
$> npm install @azure/core-http-compat@2.0.1
$> npm install @azure/core-lro@2.5.2
$> npm install @azure/core-rest-pipeline@1.10.3
$> npm install @azure/core-util@1.3.0
$> npm install @azure/core-util@1.3.1
$> npm install @azure/cosmos@3.17.4-beta.1
$> npm install @azure/data-tables@13.2.2
$> npm install @azure/identity@3.1.4
$> npm install @azure/identity@3.2.0-beta.2
$> npm install @azure/keyvault-admin@4.4.0
$> npm install @azure/keyvault-certificates@4.7.0
$> npm install @azure/keyvault-common@1.0.0
$> npm install @azure/keyvault-keys@4.7.0
$> npm install @azure/keyvault-secrets@4.7.0
$> npm install @azure/service-bus@7.9.0
$> npm install @azure/storage-blob@12.14.0-beta.1
$> npm install @azure/storage-blob@12.14.0
$> npm install @azure/storage-file-datalake@12.13.0-beta.1
$> npm install @azure/storage-file-datalake@12.13.0
$> npm install @azure/storage-file-share@12.14.0-beta.1
$> npm install @azure/storage-file-share@12.14.0
$> npm install @azure/storage-queue@12.13.0
$> npm install @azure/web-pubsub-client@1.0.0-beta.3
$> npm install @azure/web-pubsub-client-protobuf@1.0.0-beta.1
$> npm install @azure/web-pubsub-express@1.0.4
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