Azure SDK for .NET (October 2024)
The Azure SDK team is pleased to announce our October 2024 client library releases.
64 packages released this month.
Stable Packages (7)
-
Core - Client - Core
-
Microsoft.Azure.WebPubSub.AspNetCore
-
Microsoft.Azure.WebPubSub.Common
-
OpenAI Inference
-
Resource Management - ElasticSan
-
Resource Management - Resources
-
System.ClientModel
Patch Updates (13)
-
Azure client library integration for ASP.NET Core
-
Core - Client - Core
-
Functions extension for Blob Storage
-
Functions extension for Storage Queues
-
Identity
-
Service Bus
-
Storage - Blobs
-
Storage - Blobs Batch
-
Storage - Common
-
Storage - Files Data Lake
-
Storage - Files Share
-
Storage - Queues
-
System.ClientModel
Beta Packages (33)
-
Azure AI Search
-
Communication Email
-
Maps Search
-
OpenAI Inference
-
OpenTelemetry Exporter
-
Provisioning
-
Provisioning - App Configuration
-
Provisioning - Application Insights
-
Provisioning - Cognitive Services
-
Provisioning - CosmosDB
-
Provisioning - Deployment
-
Provisioning - Event Hubs
-
Provisioning - Key Vault
-
Provisioning - Operational Insights
-
Provisioning - PostgreSQL
-
Provisioning - Redis
-
Provisioning - SQL
-
Provisioning - Search
-
Provisioning - Service Bus
-
Provisioning - SignalR
-
Provisioning - Storage
-
Provisioning - WebPubSub
-
Resource Management - Computeschedule
-
Resource Management - Elastic
-
Resource Management - Redis Enterprise
-
Storage - Blobs
-
Storage - Blobs Batch
-
Storage - Blobs ChangeFeed
-
Storage - Common
-
Storage - Files Data Lake
-
Storage - Files Share
-
Storage - Queues
-
unknown
Release highlights
Azure AI Search 11.7.0-beta.1 Changelog
Features Added
- Added support for
VectorSearchCompression.TruncationDimension
, which allows specifying the number of dimensions to truncate vectors to. - Added support for
VectorQuery.FilterOverride
, which allows vector queries to override the broaderSearchOptions.Filter
, enabling more specific configurations for vector queries. SplitSkill
now supports tokenization.DocumentDebugInfo
is extended with vector scores for the results.
Azure client library integration for ASP.NET Core 1.7.6 Changelog
Other Changes
- Improved the efficiency of
AzureEventSourceLogForwarder
by eliminating message formatting. (#46202)
Communication Email 1.1.0-beta.2 Changelog
Features Added
- Consumers can now provide a value for the
ContentId
property when sending emails with attachments. This allows consumers to reference attachments in the email body using thecid
scheme. TheContentId
property can be set on theEmailAttachment
object.
Core - Client - Core 1.44.0 Changelog
Features Added
TokenRequestContext
added theIsProofOfPossessionEnabled
,ResourceRequestMethod
, andResourceRequestUri
properties to support Proof of Possession tokens (45134).AccessToken
added theTokenType
property to support distinguishing Bearer tokens from Proof of Possession (PoP) tokens (45134).- Moved implementation of
Azure.AzureKeyCredential
intoSystem.ClientModel.ApiKeyCredential
and madeApiKeyCredential
the base type forAzureKeyCredential
(#46128). BearerTokenAuthenticationPolicy
now will attempt to handle Continuous Access Evaluation (CAE) challenges, if present, by default (#46277).
Core - Client - Core 1.44.1 Changelog
Other Changes
- Upgraded
System.Text.Json
package dependency to 6.0.10 for security fix (#46134).
Functions extension for Blob Storage 5.3.3 Changelog
Other Changes
- Upgraded
System.Text.Json
package dependency to 6.0.10 for security fix.
Functions extension for Storage Queues 5.3.3 Changelog
Other Changes
- Upgraded
System.Text.Json
package dependency to 6.0.10 for security fix.
Identity 1.12.1 Changelog
Bugs Fixed
- Updated to version 4.65.0 of Microsoft.Identity.Client to address a bug preventing the use of alternate authority types such as dStS (4927) .
Maps Search 2.0.0-beta.3 Changelog
Breaking Changes
- Hide unnecessary GeoJson interfaces and replace with
Azure.Core.GeoJson
types
Maps Search 2.0.0-beta.4 Changelog
Bugs Fixed
- Fix the issue where
Iso
is alwaysnull
in theGetReverseGeocoding
response
Microsoft.Azure.WebPubSub.AspNetCore 1.4.0 Changelog
Features Added
- Support MQTT client event handling.
Microsoft.Azure.WebPubSub.Common 1.4.0 Changelog
Other Changes
- Updated the (de)serialization of Web PubSub CloudEvents with
System.Text.Json
library.
OpenAI Inference 2.0.0-beta.6 Changelog
Features Added
- The library now includes support for the new OpenAI o1 model family. (2ab1a94)
ChatCompletionOptions
will automatically apply itsMaxOutputTokenCount
value (renamed fromMaxTokens
) to the newmax_completion_tokens
request body propertyUsage
includes a newOutputTokenDetails
property with aReasoningTokenCount
value that will reflecto1
model use of this new subcategory of output tokens.- Note that
OutputTokenCount
(completion_tokens
) is the sum of displayed tokens generated by the model and (when applicable) these new reasoning tokens - Assistants file search now includes support for
RankingOptions
. (2ab1a94) - Use of the
include[]
query string parameter and retrieval of run step detail result content is currently only available via protocol methods - Added support for the Uploads API in
FileClient
. ThisExperimental
feature allows uploading large files in multiple parts. (2ab1a94) - The feature is supported by the
CreateUpload
,AddUploadPart
,CompleteUpload
, andCancelUpload
protocol methods.
Bugs Fixed
- Addressed an issue that caused multi-page queries of fine-tuning jobs, checkpoints, and events to fail. (2ab1a94)
ChatCompletionOptions
can now be serialized viaModelReaderWriter.Write()
prior to callingCompleteChat
using the options. (2ab1a94)
Breaking Changes
- Renamed
ChatMessageContentPart
’sCreateTextMessageContentPart
factory method toCreateTextPart
. (2ab1a94) - Renamed
ChatMessageContentPart
’sCreateImageMessageContentPart
factory method toCreateImagePart
. (2ab1a94) - Renamed
ChatMessageContentPart
’sCreateRefusalMessageContentPart
factory method toCreateRefusalPart
. (2ab1a94) - Renamed
ImageChatMessageContentPartDetail
toChatImageDetailLevel
. (2ab1a94) - Removed
ChatMessageContentPart
’sToString
overload. (2ab1a94) - Renamed the
MaxTokens
property inChatCompletionOptions
toMaxOutputTokenCount
. (2ab1a94) - Renamed properties in
ChatTokenUsage
: InputTokens
is renamed toInputTokenCount
. (2ab1a94)OutputTokens
is renamed toOutputTokenCount
. (2ab1a94)TotalTokens
is renamed toTotalTokenCount
. (2ab1a94)- Removed the common
ListOrder
enum from the top-levelOpenAI
namespace in favor of individual enums in their corresponding sub-namespace. (2ab1a94) - Renamed the
PageSize
property toPageSizeLimit
. (2ab1a94) - Updated deletion methods to return a result object instead of a
bool
. Affected methods: DeleteAssitant
,DeleteMessage
, andDeleteThread
inAssistantClient
. (2ab1a94)DeleteVectorStore
andRemoveFileFromStore
inVectorStoreClient
. (2ab1a94)DeleteModel
inModelClient
. (2ab1a94)DeleteFile
inFileClient
. (2ab1a94)- Removed setters from collection properties. (2ab1a94)
- Renamed
ChatTokenLogProbabilityInfo
toChatTokenLogProbabilityDetails
. (2ab1a94) - Renamed
ChatTokenTopLogProbabilityInfo
toChatTokenTopLogProbabilityDetails
. (2ab1a94) - Renamed the
Utf8ByteValues
properties ofChatTokenLogProbabilityDetails
andChatTokenTopLogProbabilityDetails
toUtf8Bytes
and changed their type fromIReadOnlyList<int>
toReadOnlyMemory<byte>?
. (2ab1a94) - Renamed the
Start
andEnd
properties ofTranscribedSegment
andTranscribedWord
toStartTime
andEndTime
. (2ab1a94) - Changed the type of
TranscribedSegment
’sAverageLogProbability
andNoSpeechProbability
properties fromdouble
tofloat
. (2ab1a94) - Changed the type of
TranscribedSegment
’sSeekOffset
property fromlong
toint
. (2ab1a94) - Changed the type of
TranscribedSegment
’sTokenIds
property fromIReadOnlyList<long>
toIReadOnlyList<int>
. (2ab1a94) - Updated the
Embedding.Vector
property to theEmbedding.ToFloats()
method. (2ab1a94) - Removed the optional parameter from the constructors of
VectorStoreCreationHelper
,AssistantChatMessage
, andChatFunction
. (2ab1a94) - Removed the optional
purpose
parameter fromFileClient.GetFilesAsync
andFileClient.GetFiles
methods, and added overloads wherepurpose
is required. (2ab1a94) - Renamed
ModerationClient
’sClassifyTextInput
methods toClassifyText
. (2ab1a94) - Removed duplicated
Created
property fromGeneratedImageCollection
. (2ab1a94)
OpenAI Inference 2.0.0 Changelog
Breaking Changes
AzureOpenAIClient
constructors acceptingAzureKeyCredential
have been removed; please use theApiKeyCredential
constructors, instead. Note thatAzureKeyCredential
will inherit fromApiKeyCredential
in a future update and thatAzureKeyCredential
has a non-browsable Key property that may be used for conversion in the interim.- The
AzureOpenAIClientOptions
ApplicationId
has been renamed to a more descriptiveUserAgentApplicationId
.
From OpenAI 2.0.0 stable
- Implemented
ChatMessageContent
to encapsulate the representation of content parts inChatMessage
,ChatCompletion
, andStreamingChatCompletionUpdate
. (commit_hash) - Changed the representation of function arguments to
BinaryData
inChatToolCall
,StreamingChatToolCallUpdate
,ChatFunctionCall
, andStreamingChatFunctionCallUpdate
. (commit_hash) - Renamed
OpenAIClientOptions
’sApplicationId
toUserAgentApplicationId
(commit_hash) - Renamed
StreamingChatToolCallUpdate
’sId
toToolCallId
(commit_hash) - Renamed
StreamingChatCompletionUpdate
’sId
toCompletionId
(commit_hash) - Replaced
Auto
andNone
in the deprecatedChatFunctionChoice
withCreateAutoChoice()
andCreateNoneChoice()
(commit_hash) - Replaced the deprecated
ChatFunctionChoice(ChatFunction)
constructor withCreateNamedChoice(string functionName)
(commit_hash) - Renamed
FileClient
toOpenAIFileClient
and the correspondingGetFileClient()
method inOpenAIClient
toGetOpenAIFileClient()
. (commit_hash) - Renamed
ModelClient
toOpenAIModelClient
and the correspondingGetModelClient()
method inOpenAIClient
toGetOpenAIModelClient()
. (commit_hash)
OpenAI Inference 2.1.0-beta.1 Changelog
Features Added
- Added a new
RealtimeConversationClient
in a corresponding scenario namespace. (ff75da4) - This maps to the new
/realtime
beta endpoint and is thus marked with a new[Experimental("OPENAI002")]
diagnostic tag. - This is a very early version of the convenience surface and thus subject to significant change
- Documentation and samples will arrive soon; in the interim, see the scenario test files (in
/tests
) for basic usage - You can also find an external sample employing this client, together with Azure OpenAI support, at https://github.com/Azure-Samples/aoai-realtime-audio-sdk/tree/main/dotnet/samples/console
OpenTelemetry Exporter 1.4.0-beta.2 Changelog
Bugs Fixed
- RPC attributes are now correctly exported to Application Insights as custom properties. (#45316)
- Fixed an issue where unmapped attributes were dropped from telemetry. (#45909)
Provisioning 1.0.0-beta.1 Changelog
Features Added
- Preview of the new Azure.Provisioning experience.
Provisioning - App Configuration 1.0.0-beta.1 Changelog
Provisioning - Application Insights 1.0.0-beta.1 Changelog
Provisioning - Cognitive Services 1.0.0-beta.1 Changelog
Provisioning - CosmosDB 1.0.0-beta.1 Changelog
Provisioning - Deployment 1.0.0-beta.1 Changelog
Provisioning - Event Hubs 1.0.0-beta.1 Changelog
Provisioning - Key Vault 1.0.0-beta.1 Changelog
Provisioning - Operational Insights 1.0.0-beta.1 Changelog
Provisioning - PostgreSQL 1.0.0-beta.1 Changelog
Provisioning - Redis 1.0.0-beta.1 Changelog
Provisioning - SQL 1.0.0-beta.1 Changelog
Provisioning - Search 1.0.0-beta.1 Changelog
Provisioning - Service Bus 1.0.0-beta.1 Changelog
Provisioning - SignalR 1.0.0-beta.1 Changelog
Provisioning - Storage 1.0.0-beta.1 Changelog
Provisioning - WebPubSub 1.0.0-beta.1 Changelog
Resource Management - Computeschedule 1.0.0-beta.1 Changelog
Resource Management - Elastic 1.0.0-beta.5 Changelog
Resource Management - ElasticSan 1.1.0 Changelog
Resource Management - Redis Enterprise 1.2.0-beta.1 Changelog
Resource Management - Resources 1.9.0 Changelog
Service Bus 7.18.2 Changelog
Other Changes
- Enhanced the logs emitted when acquiring a session with
ServiceBusClient
times out or is canceled. As these are known and expected exception conditions, they are now correctly logged as verbose information rather than an error. Previously, these scenarios were special-cased for processors, but receivers were treated as standard errors. Going forward, the processor and client/receiver scenarios are handled consistently.
Storage - Blobs 12.22.1 Changelog
Other Changes
- Integrated decryption for CSE v2.1
Storage - Blobs 12.23.0-beta.1 Changelog
Features Added
- Added support for service version 2025-01-05.
- Added GenerateUserDelegationSasUri() to BlobBaseClient and BlobContainerClient.
- Added BlobErrorCode.BlobAccessTierNotSupportedForAccountType enum value.
Bugs Fixed
- Fixed bug where BlobClient.Upload(BinaryData content, ..) did not properly dispose stream after wrapping the BinaryData passed.
Storage - Blobs 12.23.0-beta.2 Changelog
Other Changes
- Upgraded
System.Text.Json
package dependency to 6.0.10 for security fix.
Storage - Blobs 12.22.2 Changelog
Other Changes
- Upgraded
System.Text.Json
package dependency to 6.0.10 for security fix.
Storage - Blobs Batch 12.20.0-beta.1 Changelog
Features Added
- Added support for service version 2025-01-05.
Storage - Blobs Batch 12.20.0-beta.2 Changelog
Other Changes
- Upgraded
System.Text.Json
package dependency to 6.0.10 for security fix.
Storage - Blobs Batch 12.19.1 Changelog
Other Changes
- Upgraded
System.Text.Json
package dependency to 6.0.10 for security fix.
Storage - Blobs ChangeFeed 12.0.0-preview.50 Changelog
Features Added
- Added support for service version 2025-01-05.
Storage - Blobs ChangeFeed 12.0.0-preview.51 Changelog
Other Changes
- Upgraded
System.Text.Json
package dependency to 6.0.10 for security fix.
Storage - Common 12.22.0-beta.1 Changelog
Features Added
- This release contains bug fixes to improve quality.
Storage - Common 12.22.0-beta.2 Changelog
Other Changes
- Upgraded
System.Text.Json
package dependency to 6.0.10 for security fix.
Storage - Common 12.21.1 Changelog
Other Changes
- Upgraded
System.Text.Json
package dependency to 6.0.10 for security fix.
Storage - Files Data Lake 12.21.0-beta.1 Changelog
Features Added
- Added support for service version 2025-01-05.
- Added GenerateUserDelegationSasUri() for DataLakePathClient, DataLakeFileSystemClient, and DataLakeDirectoryClient
- Deprecated Read()/ReadAsync() in favor of ReadStreaming()/ReadStreamingAsync() and ReadContent()/ReadContentAsync() for DataLake #45418
- Added GenerateUserDelegationSasUri() to DataLakeFileSystemClient, DataLakePathClient, DataLakeDirectoryClient, and DataLakeFileClient.
Storage - Files Data Lake 12.21.0-beta.2 Changelog
Other Changes
- Upgraded
System.Text.Json
package dependency to 6.0.10 for security fix.
Storage - Files Data Lake 12.20.1 Changelog
Other Changes
- Upgraded
System.Text.Json
package dependency to 6.0.10 for security fix.
Storage - Files Share 12.21.0-beta.1 Changelog
Features Added
- Added support for service version 2025-01-05.
- Added support for the provisioned V2 billing model.
- Added support for specifying the binary file permission format for ShareFileClient.StartCopy() and .StartCopyAsync().
- Added ShareAccessTier.Premium enum value.
Storage - Files Share 12.21.0-beta.2 Changelog
Other Changes
- Upgraded
System.Text.Json
package dependency to 6.0.10 for security fix.
Storage - Files Share 12.20.1 Changelog
Other Changes
- Upgraded
System.Text.Json
package dependency to 6.0.10 for security fix.
Storage - Queues 12.21.0-beta.1 Changelog
Features Added
- Added support for service version 2025-01-05.
Storage - Queues 12.21.0-beta.2 Changelog
Other Changes
- Upgraded
System.Text.Json
package dependency to 6.0.10 for security fix.
Storage - Queues 12.20.1 Changelog
Other Changes
- Upgraded
System.Text.Json
package dependency to 6.0.10 for security fix.
System.ClientModel 1.2.0 Changelog
Other Changes
- Upgraded
System.Memory.Data
package dependency to 6.0.0 (#46134).
System.ClientModel 1.2.1 Changelog
Bugs Fixed
- Upgraded
System.Text.Json
package dependency to 6.0.10 for security fix (#46134).
unknown 1.0.0-beta.3 Changelog
Bugs Fixed
- Fix the bug that identity based negotiation result is not correct
unknown 1.0.0-beta.4 Changelog
Bugs Fixed
- Fix the issue that Python can’t use return to ack message.
Latest Releases
View all the latest versions of .NET packages here.
Installation Instructions
To install any of our packages, please search for them via Manage NuGet Packages...
in Visual Studio (with Include prerelease
checked) or copy these commands into your terminal:
$> dotnet add package Azure.AI.OpenAI --version 2.0.0-beta.6
$> dotnet add package Azure.AI.OpenAI --version 2.0.0
$> dotnet add package Azure.AI.OpenAI --version 2.1.0-beta.1
$> dotnet add package Azure.Communication.Email --version 1.1.0-beta.2
$> dotnet add package Azure.Core --version 1.44.0
$> dotnet add package Azure.Core --version 1.44.1
$> dotnet add package Azure.Identity --version 1.12.1
$> dotnet add package Azure.Maps.Search --version 2.0.0-beta.3
$> dotnet add package Azure.Maps.Search --version 2.0.0-beta.4
$> dotnet add package Azure.Messaging.ServiceBus --version 7.18.2
$> dotnet add package Azure.Monitor.OpenTelemetry.Exporter --version 1.4.0-beta.2
$> dotnet add package Azure.Provisioning --version 1.0.0-beta.1
$> dotnet add package Azure.Provisioning.AppConfiguration --version 1.0.0-beta.1
$> dotnet add package Azure.Provisioning.ApplicationInsights --version 1.0.0-beta.1
$> dotnet add package Azure.Provisioning.CognitiveServices --version 1.0.0-beta.1
$> dotnet add package Azure.Provisioning.CosmosDB --version 1.0.0-beta.1
$> dotnet add package Azure.Provisioning.Deployment --version 1.0.0-beta.1
$> dotnet add package Azure.Provisioning.EventHubs --version 1.0.0-beta.1
$> dotnet add package Azure.Provisioning.KeyVault --version 1.0.0-beta.1
$> dotnet add package Azure.Provisioning.OperationalInsights --version 1.0.0-beta.1
$> dotnet add package Azure.Provisioning.PostgreSql --version 1.0.0-beta.1
$> dotnet add package Azure.Provisioning.Redis --version 1.0.0-beta.1
$> dotnet add package Azure.Provisioning.Search --version 1.0.0-beta.1
$> dotnet add package Azure.Provisioning.ServiceBus --version 1.0.0-beta.1
$> dotnet add package Azure.Provisioning.SignalR --version 1.0.0-beta.1
$> dotnet add package Azure.Provisioning.Sql --version 1.0.0-beta.1
$> dotnet add package Azure.Provisioning.Storage --version 1.0.0-beta.1
$> dotnet add package Azure.Provisioning.WebPubSub --version 1.0.0-beta.1
$> dotnet add package Azure.ResourceManager.ComputeSchedule --version 1.0.0-beta.1
$> dotnet add package Azure.ResourceManager.Elastic --version 1.0.0-beta.5
$> dotnet add package Azure.ResourceManager.ElasticSan --version 1.1.0
$> dotnet add package Azure.ResourceManager.RedisEnterprise --version 1.2.0-beta.1
$> dotnet add package Azure.ResourceManager.Resources --version 1.9.0
$> dotnet add package Azure.Search.Documents --version 11.7.0-beta.1
$> dotnet add package Azure.Storage.Blobs --version 12.22.1
$> dotnet add package Azure.Storage.Blobs --version 12.23.0-beta.1
$> dotnet add package Azure.Storage.Blobs --version 12.23.0-beta.2
$> dotnet add package Azure.Storage.Blobs --version 12.22.2
$> dotnet add package Azure.Storage.Blobs.Batch --version 12.20.0-beta.1
$> dotnet add package Azure.Storage.Blobs.Batch --version 12.20.0-beta.2
$> dotnet add package Azure.Storage.Blobs.Batch --version 12.19.1
$> dotnet add package Azure.Storage.Blobs.ChangeFeed --version 12.0.0-preview.50
$> dotnet add package Azure.Storage.Blobs.ChangeFeed --version 12.0.0-preview.51
$> dotnet add package Azure.Storage.Common --version 12.22.0-beta.1
$> dotnet add package Azure.Storage.Common --version 12.22.0-beta.2
$> dotnet add package Azure.Storage.Common --version 12.21.1
$> dotnet add package Azure.Storage.Files.DataLake --version 12.21.0-beta.1
$> dotnet add package Azure.Storage.Files.DataLake --version 12.21.0-beta.2
$> dotnet add package Azure.Storage.Files.DataLake --version 12.20.1
$> dotnet add package Azure.Storage.Files.Shares --version 12.21.0-beta.1
$> dotnet add package Azure.Storage.Files.Shares --version 12.21.0-beta.2
$> dotnet add package Azure.Storage.Files.Shares --version 12.20.1
$> dotnet add package Azure.Storage.Queues --version 12.21.0-beta.1
$> dotnet add package Azure.Storage.Queues --version 12.21.0-beta.2
$> dotnet add package Azure.Storage.Queues --version 12.20.1
$> dotnet add package Microsoft.Azure.WebJobs.Extensions.Storage.Blobs --version 5.3.3
$> dotnet add package Microsoft.Azure.WebJobs.Extensions.Storage.Queues --version 5.3.3
$> dotnet add package Microsoft.Azure.WebJobs.Extensions.WebPubSubForSocketIO --version 1.0.0-beta.3
$> dotnet add package Microsoft.Azure.WebJobs.Extensions.WebPubSubForSocketIO --version 1.0.0-beta.4
$> dotnet add package Microsoft.Azure.WebPubSub.AspNetCore --version 1.4.0
$> dotnet add package Microsoft.Azure.WebPubSub.Common --version 1.4.0
$> dotnet add package Microsoft.Extensions.Azure --version 1.7.6
$> dotnet add package System.ClientModel --version 1.2.0
$> dotnet add package System.ClientModel --version 1.2.1
Feedback
If you have a bug or feature request for one of the libraries, please file an issue in our repo.