Azure SDK for JavaScript (April 2024)
The Azure SDK team is pleased to announce our April 2024 client library releases.
79 packages released this month.
Stable Packages (30)
-
App Configuration
-
Azure Monitor OpenTelemetry
-
Core - Client - Abort Controller
-
Core - Client - Auth
-
Core - Client - Client
-
Core - Client - Core Rest Pipeline
-
Core - Client - Core Utils
-
Core - Client - Http Compat
-
Core - Client - LRO
-
Core - Client - Logger
-
Core - Client - Rest
-
Core - Client - Tracing
-
Core - Client - XML
-
Core - Paging
-
Event Grid
-
Identity
-
Monitor Query
-
Notification Hubs
-
Resource Management - Batch
-
Resource Management - Communication
-
Resource Management - Compute
-
Resource Management - Confluent
-
Resource Management - Container Service
-
Resource Management - Data Factory
-
Resource Management - IoT Firmware Defense
-
Resource Management - Mobile Network
-
Resource Management - NetApp Files
-
Resource Management - New Relic Observability
-
Resource Management - Sphere
-
unknown
Patch Updates (16)
-
Communication Identity
-
Core - Client - Abort Controller
-
Core - Client - Auth
-
Core - Client - Client
-
Core - Client - Core Rest Pipeline
-
Core - Client - Core Utils
-
Core - Client - Http Compat
-
Core - Client - LRO
-
Core - Client - Logger
-
Core - Client - Rest
-
Core - Client - Tracing
-
Core - Client - XML
-
Core - Paging
-
Event Hubs
-
Notification Hubs
-
unknown
Beta Packages (19)
-
Azure AI Search
-
Communication Chat
-
Communication Phone Numbers
-
OpenAI
-
Resource Management - Agrifood
-
Resource Management - Azure AI Search
-
Resource Management - Container Apps
-
Resource Management - Container Service
-
Resource Management - Container Service Fleet
-
Resource Management - Cosmos DB
-
Resource Management - CosmosDB for PostgreSQL
-
Resource Management - HDInsight Containers
-
Resource Management - Monitor
-
Resource Management - Nginx
-
Resource Management - Notification Hubs
-
Resource Management - Quantum
-
Resource Management - Storageactions
-
Resource Management - Support
-
Resource Management - Workloadssapvirtualinstance
Release highlights
App Configuration 1.6.0 Changelog
Features Added
- The
etag
for each page of configuration settings feature is generally available
Azure AI Search 12.1.0-beta.1 Changelog
Features Added
- Add vector compression #28772
- Service-side scalar quantization of your vector data
- Optional reranking with full-precision vectors
- Optional oversampling of documents when reranking compressed vectors
- Add
Edm.Half
,Edm.Int16
, andEdm.SByte
vector spaces #28772 - Add non-persistent vector usage through
SimpleField.stored
#28772 - Expose the internal HTTP pipeline to allow users to send raw requests with it
Breaking Changes
- Refactor in alignment with v12 #28576
- Replace or replace the following types/properties
- Use
ExhaustiveKnnAlgorithmConfiguration
in place of ExhaustiveKnnVectorSearchAlgorithmConfiguration
- Use
HnswAlgorithmConfiguration
in place of HnswVectorSearchAlgorithmConfiguration
- Use
PIIDetectionSkill.categories
in place of PIIDetectionSkill.piiCategories
- Use
QueryAnswer
in place of Answers
AnswersOption
QueryAnswerType
- Use
QueryAnswerResult
in place of AnswerResult
- Use
QueryCaption
in place of Captions
QueryCaptionType
- Use
QueryCaptionResult
in place of CaptionResult
- Use
SearchRequestOptions.VectorSearchOptions.filterMode
in place of SearchRequestOptions.vectorFilterMode
- Use
SearchRequestOptions.VectorSearchOptions.queries
in place of SearchRequestOptions.vectorQueries
- Use
SearchRequestOptions.semanticSearchOptions.answers
in place of SearchRequestOptions.answers
- Use
SearchRequestOptions.semanticSearchOptions.captions
in place of SearchRequestOptions.captions
- Use
SearchRequestOptions.semanticSearchOptions.configurationName
in place of SearchRequestOptions.semanticConfiguration
- Use
SearchRequestOptions.semanticSearchOptions.debugMode
in place of SearchRequestOptions.debugMode
- Use
SearchRequestOptions.semanticSearchOptions.errorMode
in place of SearchRequestOptions.semanticErrorHandlingMode
- Use
SearchRequestOptions.semanticSearchOptions.maxWaitInMilliseconds
in place of SearchRequestOptions.semanticMaxWaitInMilliseconds
- Use
SearchRequestOptions.semanticSearchOptions.semanticFields
in place of SearchRequestOptions.semanticFields
- Use
SearchRequestOptions.semanticSearchOptions.semanticQuery
in place of SearchRequestOptions.semanticQuery
- Use
SemanticErrorMode
in place of SemanticErrorHandlingMode
- Use
SemanticErrorReason
in place of SemanticPartialResponseReason
- Use
SemanticPrioritizedFields
in place of PrioritizedFields
- Use
SemanticSearch
in place of SemanticSettings
- Use
SemanticSearchResultsType
in place of SemanticPartialResponseType
- Use
SimpleField.vectorSearchProfileName
in place of SimpleField.vectorSearchProfile
- Use
VectorSearchProfile.algorithmConfigurationName
in place of VectorSearchProfile.algorithm
- Narrow some enum property types to the respective string literal union
BlobIndexerDataToExtract
BlobIndexerImageAction
BlobIndexerParsingMode
BlobIndexerPDFTextRotationAlgorithm
CustomEntityLookupSkillLanguage
EntityCategory
EntityRecognitionSkillLanguage
ImageAnalysisSkillLanguage
ImageDetail
IndexerExecutionEnvironment
KeyPhraseExtractionSkillLanguage
OcrSkillLanguage
RegexFlags
SearchIndexerDataSourceType
SentimentSkillLanguage
SplitSkillLanguage
TextSplitMode
TextTranslationSkillLanguage
VisualFeature
- Remove
KnownLexicalAnalyzerName
as a duplicate ofKnownAnalyzerNames
- Remove
KnownCharFilterName
as a duplicate ofKnownCharFilterNames
- Remove
KnownTokenFilterName
as a duplicate ofKnownTokenFilterNames
- Remove
SearchRequest
as a duplicate ofSearchRequestOptions
Azure Monitor OpenTelemetry 1.3.0 Changelog
Bugs Fixed
- Fix detecting Azure Functions and Azure App Service RPs incorrectly in the browser SDK loader.
- Fix OpenTelemetry Resource type being used when resource is set on the AzureMonitorOpenTelemetryOptions by resource detector.
- Fix Resource typing on the Azure Monitor config.
- Fix document duration, dependency duration metric, and default quickpulse endpoint.
- Fix issue with miscalculation of Live Metrics request/depdendency duration.
Features Added
- Allow spanProcessors and logRecordProcessors to be passed as options to useAzureMonitor.
Communication Chat 1.5.0-beta.2 Changelog
Features Added
- Updated to use gateway version 2024-03-01-preview for teams anonymous visitor ID support.
Communication Identity 1.3.1 Changelog
Other Changes
- Updated to
@azure/communication-common
2.3.1.
Communication Phone Numbers 1.3.0-beta.4 Changelog
Features Added
- Add support for number lookup
- Format only can be returned for no cost
- Additional number details can be returned for a cost
Core - Client - Abort Controller 2.1.0 Changelog
Other Changes
- Migrated the codebase to ESM. This change is internal and should not affect customers.
- Migrated unit tests to vitest.
Core - Client - Abort Controller 2.1.1 Changelog
Other Changes
- Add top-level
browser
field topackage.json
as fallback for legacy bundlers that do not support theexports
field.
Core - Client - Abort Controller 2.1.2 Changelog
Other Changes
- Revert TypeScript output target to ES2017.
Core - Client - Auth 1.7.0 Changelog
Other Changes
- Migrated the codebase to ESM. This change is internal and should not affect customers.
- Migrated unit tests to vitest.
Core - Client - Auth 1.7.1 Changelog
Other Changes
- Add top-level
browser
field topackage.json
as fallback for legacy bundlers that do not support theexports
field.
Core - Client - Auth 1.7.2 Changelog
Other Changes
- Revert TypeScript output target to ES2017.
Core - Client - Client 1.9.0 Changelog
Other Changes
- Migrated the codebase to ESM. This change is internal and should not affect customers.
- Migrated unit tests to vitest.
Core - Client - Client 1.9.1 Changelog
Bugs Fixed
- Addressed an issue with
authorizeRequestOnTenantChallenge
not correctly parsing challenges. PR #28967
Core - Client - Client 1.9.2 Changelog
Bugs Fixed
- Address two issues related to Azure Disk Storage. PR #29087
Core - Client - Core Rest Pipeline 1.15.0 Changelog
Bugs Fixed
- Fix issue where files created using
createFileFromStream
were not properly supported in the browser.
Core - Client - Core Rest Pipeline 1.15.1 Changelog
Bugs Fixed
- Fixed an issue where
proxyPolicy
was ignoring a custom port setting. PR #28974
Core - Client - Core Rest Pipeline 1.15.2 Changelog
Other Changes
- Revert TypeScript output target to ES2017.
Core - Client - Core Utils 1.8.0 Changelog
Other Changes
- Migrated the codebase to ESM. This change is internal and should not affect customers.
- Migrated unit tests to vitest.
Core - Client - Core Utils 1.8.1 Changelog
Other Changes
- Add top-level
browser
field topackage.json
as fallback for legacy bundlers that do not support theexports
field.
Core - Client - Core Utils 1.9.0 Changelog
Features Added
- Add new
isNodeLike
andisNodeRuntime
helpers. PR #29086 isNodeLike
can be used to test if the current environment is compatible with Node.isNodeRuntime
can be used to test if the current environment is strictly Node.js.- Deprecated the existing
isNode
helper. UseisNodeLike
instead.
Core - Client - Http Compat 2.1.0 Changelog
Other Changes
- Migrated the codebase to ESM. This change is internal and should not affect customers.
- Migrated unit tests to vitest.
Core - Client - Http Compat 2.1.1 Changelog
Other Changes
- Add top-level
browser
field topackage.json
as fallback for legacy bundlers that do not support theexports
field.
Core - Client - Http Compat 2.1.2 Changelog
Other Changes
- Revert TypeScript output target to ES2017.
Core - Client - LRO 2.7.0 Changelog
Other Changes
- Migrated the codebase to ESM. This change is internal and should not affect customers.
- Migrated unit tests to vitest.
Core - Client - LRO 2.7.1 Changelog
Other Changes
- Add top-level
browser
field topackage.json
as fallback for legacy bundlers that do not support theexports
field.
Core - Client - LRO 2.7.2 Changelog
Other Changes
- Revert TypeScript output target to ES2017.
Core - Client - Logger 1.1.0 Changelog
Other Changes
- Migrated the codebase to ESM. This change is internal and should not affect customers.
- Migrated unit tests to vitest.
Core - Client - Logger 1.1.1 Changelog
Other Changes
- Add top-level
browser
field topackage.json
as fallback for legacy bundlers that do not support theexports
field.
Core - Client - Logger 1.1.2 Changelog
Other Changes
- Revert TypeScript output target to ES2017.
Core - Client - Rest 1.3.0 Changelog
Bugs Fixed
- Set the content-type as
undefined
if it’s a non-json string in the body and we are unknown of the content-type, but remain to beapplication/json
if it’s json string.
Features Added
- Allow customers to set request content type by
option.contentType
orcontent-type
request headers.
Core - Client - Rest 1.3.1 Changelog
Other Changes
- Add top-level
browser
field topackage.json
as fallback for legacy bundlers that do not support theexports
field.
Core - Client - Rest 1.4.0 Changelog
Features Added
- Support accept in headers.
Core - Client - Tracing 1.1.0 Changelog
Other Changes
- Migrated the codebase to ESM. This change is internal and should not affect customers.
- Migrated unit tests to vitest.
Core - Client - Tracing 1.1.1 Changelog
Other Changes
- Add top-level
browser
field topackage.json
as fallback for legacy bundlers that do not support theexports
field.
Core - Client - Tracing 1.1.2 Changelog
Other Changes
- Revert TypeScript output target to ES2017.
Core - Client - XML 1.4.0 Changelog
Other Changes
- Migrated the codebase to ESM. This change is internal and should not affect customers.
- Migrated unit tests to vitest.
Core - Client - XML 1.4.1 Changelog
Other Changes
- Add top-level
browser
field topackage.json
as fallback for legacy bundlers that do not support theexports
field.
Core - Client - XML 1.4.2 Changelog
Other Changes
- Revert TypeScript output target to ES2017.
Core - Paging 1.6.0 Changelog
Other Changes
- Migrated the codebase to ESM. This change is internal and should not affect customers.
- Migrated unit tests to vitest.
Core - Paging 1.6.1 Changelog
Other Changes
- Add top-level
browser
field topackage.json
as fallback for legacy bundlers that do not support theexports
field.
Core - Paging 1.6.2 Changelog
Other Changes
- Revert TypeScript output target to ES2017.
Event Grid 5.3.0 Changelog
Features Added
-
Added new System Events:
Microsoft.ApiCenter.ApiDefinitionAdded
Microsoft.ApiCenter.ApiDefinitionUpdated
Event Grid 5.4.0 Changelog
Features Added
-
Added new System Events:
Microsoft.Communication.AdvancedMessageDeliveryStatusUpdated
Microsoft.Communication.AdvancedMessageReceived
Microsoft.Communication.RouterWorkerUpdated
Event Hubs 5.11.4 Changelog
Other Changes
- The minimum value of timeout for all operations is no longer 60 seconds. The user can now set the timeout to lower values if needed. The default timeout value is still 60 seconds.
Identity 4.1.0 Changelog
Breaking Changes
- IMDS probing retry configuration updated for
DefaultAzureCredential
andManagedIdentityCredential
, withmaxRetryCount
increased to 5. For more information, see BREAKING_CHANGES.md.
Bugs Fixed
- msal cache files are properly named when the user does not pass in a custom file name #29039
- Allow IMDS probing retry options in
ManagedIdentityCredential
andDefaultAzureCredential
to be overridden by customers.
Features Added
InteractiveBrowserCredential
: Added support for using the default broker account. #28979.
Monitor Query 1.2.0 Changelog
Features Added
- Added a new
MetricsClient
to query metrics for multiple resources. - Added
autoAdjustTimegrain
,rollUpBy
andvalidateDimensions
properties to theMetricsQueryOptions
object. - Added
resourceId
property to theMetricsQueryResult
object.
Notification Hubs 1.1.1 Changelog
Bugs Fixed
- Fixed to allow
FcmV1Notification
as part of theNotification
andsendNotification
parameters.
Notification Hubs 1.2.0 Changelog
Features Added
- Added overloads to create notifications for ADM, Baidu, Template, Xiaomi and WebPush accepting either a string or a custom object that is transformed into the JSON notification body.
Bugs Fixed
- Fix ordering of XML
BrowserRegistrationDescription
properties.
OpenAI 1.0.0-beta.12 Changelog
Features Added
- Adds a new property
logprobs
inChatChoice
to support log probabilities for this chat choice - Adds new properties
logprobs
andtopLogprobs
inChatCompletionsOptions
class to support log probabilities for chat completions - Adds
dimensions
inGetEmbeddingsOptions
. when using Azure OpenAI, specifies the input type to use for embedding search. - Updates the default service API version to
2024-03-01-preview
- Returns content filter results and prompt filter results for image generations through
contentFilterResults
andpromptFilterResults
properties
Bugs Fixed
- Fix a bug where
ChatCompletionsFunctionToolCall
did not expose theindex
property for the streaming mode.
Breaking Changes
AzureChatExtensionConfiguration
,OnYourDataAuthenticationOptions
,OnYourDataVectorizationSource
,OnYourDataVectorizationSourceType
,ChatCompletionsNamedToolSelection
,ChatCompletionsToolDefinition
,ChatCompletionsToolCall
,ChatMessageContentItem
,ChatRequestMessage
,ChatFinishDetails
are renamed withUnion
postfix.AzureCognitiveSearchQueryType
,ChatMessageImageDetailLevel
,ElasticsearchQueryType
,FunctionCallPreset
,ImageGenerationQuality
,ImageGenerationResponseFormat
,ImageSize
,ImageGenerationStyle
,OnYourDataAuthenticationType
,OnYourDataVectorizationSourceType
union types no longer have fixed values.prompFilterResults
property inChatCompletions
,prompFilterResults
property inChoice
,toolCalls
inChatResponseMessage
are now optional
Changes to “bring your own data” features:
- Introduces a new type:
AzureChatExtensionDataSourceResponseCitation
- For
AzureChatExtensionsMessageContext
, replacedmessages
property withcitations
and addedintent
as a string - Rename
AzureCognitiveSearch
toAzureSearch
embeddingDependency
is a required property forAzureCosmosDBChatExtensionConfiguration
- All extension configuration
type
properties are changed into snake casing. For example, typeAzureCosmosDB
is changed intoazure_cosmos_db
inAzureCosmosDBChatExtensionConfiguration
- All authentication
type
properties are changed into snake casing. For example, typeConnectionString
is changed intoconnection_string
inOnYourDataConnectionStringAuthenticationOptions
- New properties are added to
AzureCosmosDBFieldMappingOptions
:contentFields
,contentFieldsSeparator
,filepathField
,titleField
, andurlField
. - Adds additional support for different authentication options, including access token and encoded API key authentication
embeddingDependency
is required inPineconeChatExtensionConfiguration
contentField
is required inPineconeFieldMappingOptions
Resource Management - Agrifood 1.0.0-beta.5 Changelog
Resource Management - Azure AI Search 3.3.0-beta.1 Changelog
Resource Management - Batch 9.2.0 Changelog
Resource Management - Communication 4.1.0 Changelog
Resource Management - Compute 21.5.0 Changelog
Resource Management - Confluent 3.1.0 Changelog
Resource Management - Container Apps 2.1.0-beta.1 Changelog
Resource Management - Container Service 19.8.0-beta.2 Changelog
Resource Management - Container Service 19.8.0 Changelog
Resource Management - Container Service Fleet 1.1.0-beta.1 Changelog
Resource Management - Cosmos DB 16.0.0-beta.7 Changelog
Resource Management - CosmosDB for PostgreSQL 1.1.0-beta.1 Changelog
Resource Management - Data Factory 14.1.0 Changelog
Resource Management - HDInsight Containers 1.0.0-beta.2 Changelog
Resource Management - IoT Firmware Defense 1.0.0 Changelog
Resource Management - Mobile Network 5.0.0 Changelog
Resource Management - Monitor 8.0.0-beta.5 Changelog
Resource Management - NetApp Files 20.0.0 Changelog
Resource Management - New Relic Observability 1.1.0 Changelog
Resource Management - Nginx 4.0.0-beta.1 Changelog
Resource Management - Notification Hubs 3.0.0-beta.1 Changelog
Resource Management - Quantum 1.0.0-beta.2 Changelog
Resource Management - Sphere 1.0.0 Changelog
Resource Management - Storageactions 1.0.0-beta.1 Changelog
Resource Management - Support 2.2.0-beta.2 Changelog
Resource Management - Workloadssapvirtualinstance 1.0.0-beta.1 Changelog
unknown 2.1.1 Changelog
Other Changes
- Add top-level
browser
field topackage.json
as fallback for legacy bundlers that do not support theexports
field.
unknown 2.1.0 Changelog
Other Changes
- Migrated the codebase to ESM. This change is internal and should not affect customers.
- Migrated unit tests to vitest.
unknown 2.1.2 Changelog
Other Changes
- Revert TypeScript output target to ES2017.
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.3.0
$> npm install @azure-rest/core-client@1.3.1
$> npm install @azure-rest/core-client@1.4.0
$> npm install @azure/abort-controller@2.1.0
$> npm install @azure/abort-controller@2.1.1
$> npm install @azure/abort-controller@2.1.2
$> npm install @azure/app-configuration@1.6.0
$> npm install @azure/arm-agrifood@1.0.0-beta.5
$> npm install @azure/arm-appcontainers@2.1.0-beta.1
$> npm install @azure/arm-batch@9.2.0
$> npm install @azure/arm-communication@4.1.0
$> npm install @azure/arm-compute@21.5.0
$> npm install @azure/arm-confluent@3.1.0
$> npm install @azure/arm-containerservice@19.8.0-beta.2
$> npm install @azure/arm-containerservice@19.8.0
$> npm install @azure/arm-containerservicefleet@1.1.0-beta.1
$> npm install @azure/arm-cosmosdb@16.0.0-beta.7
$> npm install @azure/arm-cosmosdbforpostgresql@1.1.0-beta.1
$> npm install @azure/arm-datafactory@14.1.0
$> npm install @azure/arm-hdinsightcontainers@1.0.0-beta.2
$> npm install @azure/arm-iotfirmwaredefense@1.0.0
$> npm install @azure/arm-mobilenetwork@5.0.0
$> npm install @azure/arm-monitor@8.0.0-beta.5
$> npm install @azure/arm-netapp@20.0.0
$> npm install @azure/arm-newrelicobservability@1.1.0
$> npm install @azure/arm-nginx@4.0.0-beta.1
$> npm install @azure/arm-notificationhubs@3.0.0-beta.1
$> npm install @azure/arm-quantum@1.0.0-beta.2
$> npm install @azure/arm-search@3.3.0-beta.1
$> npm install @azure/arm-sphere@1.0.0
$> npm install @azure/arm-storageactions@1.0.0-beta.1
$> npm install @azure/arm-support@2.2.0-beta.2
$> npm install @azure/arm-workloadssapvirtualinstance@1.0.0-beta.1
$> npm install @azure/communication-chat@1.5.0-beta.2
$> npm install @azure/communication-identity@1.3.1
$> npm install @azure/communication-phone-numbers@1.3.0-beta.4
$> npm install @azure/core-auth@1.7.0
$> npm install @azure/core-auth@1.7.1
$> npm install @azure/core-auth@1.7.2
$> npm install @azure/core-client@1.9.0
$> npm install @azure/core-client@1.9.1
$> npm install @azure/core-client@1.9.2
$> npm install @azure/core-http-compat@2.1.0
$> npm install @azure/core-http-compat@2.1.1
$> npm install @azure/core-http-compat@2.1.2
$> npm install @azure/core-lro@2.7.0
$> npm install @azure/core-lro@2.7.1
$> npm install @azure/core-lro@2.7.2
$> npm install @azure/core-paging@1.6.0
$> npm install @azure/core-paging@1.6.1
$> npm install @azure/core-paging@1.6.2
$> npm install @azure/core-rest-pipeline@1.15.0
$> npm install @azure/core-rest-pipeline@1.15.1
$> npm install @azure/core-rest-pipeline@1.15.2
$> npm install @azure/core-sse@2.1.1
$> npm install @azure/core-sse@2.1.0
$> npm install @azure/core-sse@2.1.2
$> npm install @azure/core-tracing@1.1.0
$> npm install @azure/core-tracing@1.1.1
$> npm install @azure/core-tracing@1.1.2
$> npm install @azure/core-util@1.8.0
$> npm install @azure/core-util@1.8.1
$> npm install @azure/core-util@1.9.0
$> npm install @azure/core-xml@1.4.0
$> npm install @azure/core-xml@1.4.1
$> npm install @azure/core-xml@1.4.2
$> npm install @azure/event-hubs@5.11.4
$> npm install @azure/eventgrid@5.3.0
$> npm install @azure/eventgrid@5.4.0
$> npm install @azure/identity@4.1.0
$> npm install @azure/logger@1.1.0
$> npm install @azure/logger@1.1.1
$> npm install @azure/logger@1.1.2
$> npm install @azure/monitor-opentelemetry@1.3.0
$> npm install @azure/monitor-query@1.2.0
$> npm install @azure/notification-hubs@1.1.1
$> npm install @azure/notification-hubs@1.2.0
$> npm install @azure/openai@1.0.0-beta.12
$> npm install @azure/search-documents@12.1.0-beta.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