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
etagfor 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.SBytevector 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
ExhaustiveKnnAlgorithmConfigurationin place of ExhaustiveKnnVectorSearchAlgorithmConfiguration- Use
HnswAlgorithmConfigurationin place of HnswVectorSearchAlgorithmConfiguration- Use
PIIDetectionSkill.categoriesin place of PIIDetectionSkill.piiCategories- Use
QueryAnswerin place of AnswersAnswersOptionQueryAnswerType- Use
QueryAnswerResultin place of AnswerResult- Use
QueryCaptionin place of CaptionsQueryCaptionType- Use
QueryCaptionResultin place of CaptionResult- Use
SearchRequestOptions.VectorSearchOptions.filterModein place of SearchRequestOptions.vectorFilterMode- Use
SearchRequestOptions.VectorSearchOptions.queriesin place of SearchRequestOptions.vectorQueries- Use
SearchRequestOptions.semanticSearchOptions.answersin place of SearchRequestOptions.answers- Use
SearchRequestOptions.semanticSearchOptions.captionsin place of SearchRequestOptions.captions- Use
SearchRequestOptions.semanticSearchOptions.configurationNamein place of SearchRequestOptions.semanticConfiguration- Use
SearchRequestOptions.semanticSearchOptions.debugModein place of SearchRequestOptions.debugMode- Use
SearchRequestOptions.semanticSearchOptions.errorModein place of SearchRequestOptions.semanticErrorHandlingMode- Use
SearchRequestOptions.semanticSearchOptions.maxWaitInMillisecondsin place of SearchRequestOptions.semanticMaxWaitInMilliseconds- Use
SearchRequestOptions.semanticSearchOptions.semanticFieldsin place of SearchRequestOptions.semanticFields- Use
SearchRequestOptions.semanticSearchOptions.semanticQueryin place of SearchRequestOptions.semanticQuery- Use
SemanticErrorModein place of SemanticErrorHandlingMode- Use
SemanticErrorReasonin place of SemanticPartialResponseReason- Use
SemanticPrioritizedFieldsin place of PrioritizedFields- Use
SemanticSearchin place of SemanticSettings- Use
SemanticSearchResultsTypein place of SemanticPartialResponseType- Use
SimpleField.vectorSearchProfileNamein place of SimpleField.vectorSearchProfile- Use
VectorSearchProfile.algorithmConfigurationNamein place of VectorSearchProfile.algorithm- Narrow some enum property types to the respective string literal union
BlobIndexerDataToExtractBlobIndexerImageActionBlobIndexerParsingModeBlobIndexerPDFTextRotationAlgorithmCustomEntityLookupSkillLanguageEntityCategoryEntityRecognitionSkillLanguageImageAnalysisSkillLanguageImageDetailIndexerExecutionEnvironmentKeyPhraseExtractionSkillLanguageOcrSkillLanguageRegexFlagsSearchIndexerDataSourceTypeSentimentSkillLanguageSplitSkillLanguageTextSplitModeTextTranslationSkillLanguageVisualFeature- Remove
KnownLexicalAnalyzerNameas a duplicate ofKnownAnalyzerNames - Remove
KnownCharFilterNameas a duplicate ofKnownCharFilterNames - Remove
KnownTokenFilterNameas a duplicate ofKnownTokenFilterNames - Remove
SearchRequestas 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-common2.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
browserfield topackage.jsonas fallback for legacy bundlers that do not support theexportsfield.
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
browserfield topackage.jsonas fallback for legacy bundlers that do not support theexportsfield.
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
authorizeRequestOnTenantChallengenot 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
createFileFromStreamwere not properly supported in the browser.
Core - Client - Core Rest Pipeline 1.15.1 Changelog
Bugs Fixed
- Fixed an issue where
proxyPolicywas 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
browserfield topackage.jsonas fallback for legacy bundlers that do not support theexportsfield.
Core - Client - Core Utils 1.9.0 Changelog
Features Added
- Add new
isNodeLikeandisNodeRuntimehelpers. PR #29086 isNodeLikecan be used to test if the current environment is compatible with Node.isNodeRuntimecan be used to test if the current environment is strictly Node.js.- Deprecated the existing
isNodehelper. UseisNodeLikeinstead.
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
browserfield topackage.jsonas fallback for legacy bundlers that do not support theexportsfield.
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
browserfield topackage.jsonas fallback for legacy bundlers that do not support theexportsfield.
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
browserfield topackage.jsonas fallback for legacy bundlers that do not support theexportsfield.
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
undefinedif it’s a non-json string in the body and we are unknown of the content-type, but remain to beapplication/jsonif it’s json string.
Features Added
- Allow customers to set request content type by
option.contentTypeorcontent-typerequest headers.
Core - Client - Rest 1.3.1 Changelog
Other Changes
- Add top-level
browserfield topackage.jsonas fallback for legacy bundlers that do not support theexportsfield.
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
browserfield topackage.jsonas fallback for legacy bundlers that do not support theexportsfield.
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
browserfield topackage.jsonas fallback for legacy bundlers that do not support theexportsfield.
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
browserfield topackage.jsonas fallback for legacy bundlers that do not support theexportsfield.
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.ApiDefinitionAddedMicrosoft.ApiCenter.ApiDefinitionUpdated
Event Grid 5.4.0 Changelog
Features Added
-
Added new System Events:
Microsoft.Communication.AdvancedMessageDeliveryStatusUpdatedMicrosoft.Communication.AdvancedMessageReceivedMicrosoft.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
DefaultAzureCredentialandManagedIdentityCredential, withmaxRetryCountincreased 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
ManagedIdentityCredentialandDefaultAzureCredentialto 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
MetricsClientto query metrics for multiple resources. - Added
autoAdjustTimegrain,rollUpByandvalidateDimensionsproperties to theMetricsQueryOptionsobject. - Added
resourceIdproperty to theMetricsQueryResultobject.
Notification Hubs 1.1.1 Changelog
Bugs Fixed
- Fixed to allow
FcmV1Notificationas part of theNotificationandsendNotificationparameters.
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
BrowserRegistrationDescriptionproperties.
OpenAI 1.0.0-beta.12 Changelog
Features Added
- Adds a new property
logprobsinChatChoiceto support log probabilities for this chat choice - Adds new properties
logprobsandtopLogprobsinChatCompletionsOptionsclass to support log probabilities for chat completions - Adds
dimensionsinGetEmbeddingsOptions. 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
contentFilterResultsandpromptFilterResultsproperties
Bugs Fixed
- Fix a bug where
ChatCompletionsFunctionToolCalldid not expose theindexproperty for the streaming mode.
Breaking Changes
AzureChatExtensionConfiguration,OnYourDataAuthenticationOptions,OnYourDataVectorizationSource,OnYourDataVectorizationSourceType,ChatCompletionsNamedToolSelection,ChatCompletionsToolDefinition,ChatCompletionsToolCall,ChatMessageContentItem,ChatRequestMessage,ChatFinishDetailsare renamed withUnionpostfix.AzureCognitiveSearchQueryType,ChatMessageImageDetailLevel,ElasticsearchQueryType,FunctionCallPreset,ImageGenerationQuality,ImageGenerationResponseFormat,ImageSize,ImageGenerationStyle,OnYourDataAuthenticationType,OnYourDataVectorizationSourceTypeunion types no longer have fixed values.prompFilterResultsproperty inChatCompletions,prompFilterResultsproperty inChoice,toolCallsinChatResponseMessageare now optional
Changes to “bring your own data” features:
- Introduces a new type:
AzureChatExtensionDataSourceResponseCitation - For
AzureChatExtensionsMessageContext, replacedmessagesproperty withcitationsand addedintentas a string - Rename
AzureCognitiveSearchtoAzureSearch embeddingDependencyis a required property forAzureCosmosDBChatExtensionConfiguration- All extension configuration
typeproperties are changed into snake casing. For example, typeAzureCosmosDBis changed intoazure_cosmos_dbinAzureCosmosDBChatExtensionConfiguration - All authentication
typeproperties are changed into snake casing. For example, typeConnectionStringis changed intoconnection_stringinOnYourDataConnectionStringAuthenticationOptions - 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
embeddingDependencyis required inPineconeChatExtensionConfigurationcontentFieldis 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
browserfield topackage.jsonas fallback for legacy bundlers that do not support theexportsfield.
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