Azure SDK for .NET (September 2024)
The Azure SDK team is pleased to announce our September 2024 client library releases.
64 packages released this month.
Stable Packages (29)
-
Core - Client - Core
-
Event Grid
-
Health Insights Radiology Insights
-
Microsoft.Azure.WebPubSub.Common
-
Monitor Query
-
Resource Management - App Compliance Automation
-
Resource Management - Azure Stack HCI
-
Resource Management - Batch
-
Resource Management - Billing
-
Resource Management - Compute
-
Resource Management - Connected VMware vSphere
-
Resource Management - Container Apps
-
Resource Management - Data Factory
-
Resource Management - Desktop Virtualization
-
Resource Management - Machine Learning
-
Resource Management - NetApp Files
-
Resource Management - Network
-
Resource Management - Private DNS
-
Resource Management - Resource Manager
-
Resource Management - Standby Pool
-
Schema Registry
-
Storage - Blobs
-
Storage - Blobs Batch
-
Storage - Common
-
Storage - Files Data Lake
-
Storage - Files Share
-
Storage - Queues
-
System.ClientModel
-
WebJobs Extensions - Web PubSub
Patch Updates (10)
-
Azure client library integration for ASP.NET Core
-
Communication Chat
-
Communication Rooms
-
Event Hubs - Event Processor
-
Functions extension for Blob Storage
-
Functions extension for Storage Queues
-
Key Encryptor for .NET Data Protection
-
Resource Management - Machine Learning
-
Secrets Configuration Provider for .NET
-
Tables
Beta Packages (20)
-
Document Intelligence
-
Identity
-
Maps Render
-
Maps Route
-
Maps Search
-
OpenAI Inference
-
Resource Management - API Management
-
Resource Management - Computefleet
-
Resource Management - Container Apps
-
Resource Management - Devopsinfrastructure
-
Resource Management - Fabric
-
Resource Management - HDInsight
-
Resource Management - Hardware Security Modules
-
Resource Management - Healthdataaiservices
-
Resource Management - Mongocluster
-
Resource Management - Monitor
-
Resource Management - Security Insights
-
Storage - Blobs ChangeFeed
-
System.ClientModel
-
unknown
Release highlights
Azure client library integration for ASP.NET Core 1.7.5 Changelog
Other Changes
- Updated dependency
Azure.Core
to version1.42.0
.
Communication Chat 1.3.1 Changelog
Bugs Fixed
Security patch, update to Azure.Core to 1.43.0.
Communication Rooms 1.1.1 Changelog
Bugs Fixed
Security patch, update to Azure.Core to 1.42.0.
Core - Client - Core 1.43.0 Changelog
Other Changes
- Upgraded
System.Text.Json
package dependency to 6.0.9 (#45416). - Added a new constructor on
AzureEventSourceListener
for callers that don’t need the formatted message (#45191). - Remove unused callback from
HttpRequestMessage
options inHttpClientTransport
transport (#45696). - Added
RequiresUnreferencedCode
andRequiresDynamicCode
attributes toToDynamicFromJson
extension methods andDynamicData
APIs to support AOT scenarios (#45417).
Document Intelligence 1.0.0-beta.3 Changelog
Bugs Fixed
- Calling
Operation.Id
in an operation returned from the Analyze Document API won’t throw aNotSupportedException
anymore. Using the operation ID to retrieve operations started previously is still not supported.
Breaking Changes
DocumentIntelligenceClient
andDocumentIntelligenceAdministrationClient
now target service API version2024-07-31-preview
. Support for2024-02-29-preview
has been removed.- Removed support for extracting lists from analyzed documents:
- Removed types
DocumentList
andDocumentListItem
. - Removed property
Lists
fromAnalyzeResult
. - Changes to the Compose Document API:
- Removed class
ComponentDocumentModelDetails
, originally used as part of the input of the API. - Removed property
ComponentModels
fromComposeDocumentModelContent
. ComposeDocumentModelContent
now needs a dictionary ofDocumentTypeDetails
instances and a classifier ID to be constructed.- Removed type
QuotaDetails
. - Removed property
CustomNeuralDocumentModelBuilds
fromResourceDetails.
- Updated class
DocumentIntelligenceModelFactory
to reflect model changes.
Features Added
- Added support for the Analyze Batch Documents API:
- Added method
AnalyzeBatchDocuments
toDocumentIntelligenceClient
. - Added class
AnalyzeBatchDocumentsContent
to be used as the main input of the API. - Added class
AnalyzeBatchResult
to be used as the main output of the API. - Added class
AnalyzeBatchOperationDetail
to be used as part of the output of the API. - Added support for different kinds of output in the Analyze Document API:
- Added method
GetAnalyzeResultPdf
toDocumentIntelligenceClient
. - Added method
GetAnalyzeResultFigures
toDocumentIntelligenceClient
. - Added type
AnalyzeOutputOption
to specify other kinds of output: eitherPdf
andFigures
. - Added parameter
output
toAnalyzeDocument
overloads inDocumentIntelligenceClient
. - Added property
Id
toDocumentFigure
. - Added support for the Copy Classifier API:
- Added method
AuthorizeClassifierCopy
toDocumentIntelligenceAdministrationClient
. - Added method
CopyClassifierTo
toDocumentIntelligenceAdministrationClient
. - Added class
AuthorizeClassifierCopyContent
to be used as the input of theAuthorizeClassifierCopy
API. - Added class
ClassifierCopyAuthorization
to be use das the output of theAuthorizeClassifierCopy
API. - Added class
DocumentClassifierCopyToOperationDetails
to represent a Copy Classifier operation in calls to theGetOperation
API. - Miscellaneous:
- Added new kind of
DocumentBuildMode
:Generative
. - Added property
Warnings
toAnalyzeResult
. - Added properties
ClassifierId
,Split
, andTrainingHours
toDocumentModelDetails
. - Added properties
ConfidenceThreshold
,Features
,MaxDocumentsToAnalyze
,ModelId
, andQueryFields
toDocumentTypeDetails
. - Added properties
AllowOverwrite
andMaxTrainingHours
toBuildDocumentModelContent
. - Exposed the constructor of
DocumentTypeDetails
and made its properties settable to support new changes to the Compose Document API. - Exposed the constructor of
DocumentFieldSchema
and made its properties settable to support new changes to the Compose Document API. - Added parameter
pages
toClassifyDocument
overloads inDocumentIntelligenceClient
. - Added properties
ClassifierId
,DocTypes
, andSplit
toComposeDocumentModelContent
. - Added property
AllowOverwrite
toBuildDocumentClassifierContent
.
Event Grid 4.25.0 Changelog
Features Added
- Added
AccessTier
andPreviousTier
properties toStorageBlobTierChangedEventData
system event. - Added
AccessTier
toStorageBlobCreatedEventData
system event.
Event Hubs - Event Processor 5.11.5 Changelog
Other Changes
- Bump
Azure.Core.Amqp
dependency to 1.3.1, which includes a fix to serialization of binary application properties.
Functions extension for Blob Storage 5.3.2 Changelog
Other Changes
-
This release contains bug fixes to improve quality.
Functions extension for Storage Queues 5.3.2 Changelog
Bugs Fixed
- When grabbing Queue Metrics for amount of messages, will now use the QueueTriggerMetrics.QueueLength instead of the ApproximateMessagesCount for less stale metrics.
Health Insights Radiology Insights 1.0.0 Changelog
- Initial preview of the Azure.Health.Insights.RadiologyInsights client library.
Identity 1.13.0-beta.2 Changelog
Bugs Fixed
- If
DefaultAzureCredential
attempts to authenticate with theMangagedIdentityCredential
and it receives either a failed response that is not json, it will now fall through to the next credential in the chain. #45184
Features Added
ManagedIdentityCredential
now supports specifying a user-assigned managed identity by object ID.
Key Encryptor for .NET Data Protection 1.2.4 Changelog
Other Changes
- Updated reference to
Azure.Security.KeyVault.Keys
v4.6.0 to mitigate a reported SSRF vulnerability.
Maps Render 2.0.0-beta.1 Changelog
Features Added
- Support Rendering API
2024-04-01
Maps Route 1.0.0-beta.3 Changelog
Bugs Fixed
- Support multiple SectionTypes in SectionFilter
Maps Search 2.0.0-beta.1 Changelog
Features Added
- Support Search API
2023-06-01
Maps Search 2.0.0-beta.2 Changelog
Bugs Fixed
- Fix NPE issue during client creation
Microsoft.Azure.WebPubSub.Common 1.3.0 Changelog
Features Added
- Support MQTT event handlers.
- Add
Content
field inWebPubSubClientCertificate
to carry over client certificate content.
Monitor Query 1.5.0 Changelog
Bugs Fixed
- Fix bug in
LogsQueryClient
that defaulted toAzure.PublicCloud
.Audience
is now determined from theendpoint
parameter.
OpenAI Inference 2.0.0-beta.3 Changelog
Breaking Changes
No Azure-specific breaking changes are present in this update.
The update from OpenAI
2.0.0-beta.7
to 2.0.0-beta.9
does bring a number of breaking changes, however, as described in the OpenAI changelog:
- Removed client constructors that do not explicitly take an API key parameter or an endpoint via an
OpenAIClientOptions
parameter, making it clearer how to appropriately instantiate a client. (13a9c68) - Removed the endpoint parameter from all client constructors, making it clearer that an alternative endpoint must be specified via the
OpenAIClientOptions
parameter. (13a9c68) - Removed
OpenAIClient
’sEndpoint
protected
property. (13a9c68) - Made
OpenAIClient
’s constructor that takes aClientPipeline
parameterprotected internal
instead of justprotected
. (13a9c68) - Renamed the
User
property in applicable Options classes toEndUserId
, making its purpose clearer. (13a9c68) - Changed name of return types from methods returning streaming collections from
ResultCollection
toCollectionResult
. (7bdecfd) - Changed return types from methods returning paginated collections from
PageableCollection
toPageCollection
. (7bdecfd) - Users must now call
GetAllValues
on the collection of pages to enumerate collection items directly. Corresponding protocol methods returnIEnumerable<ClientResult>
where each collection item represents a single service response holding a page of values. (7bdecfd) - Updated
VectorStoreFileCounts
andVectorStoreFileAssociationError
types fromreadonly struct
toclass
. (58f93c8)
Features Added
- The library now directly supports alternative authentication audiences, including Azure Government. This can be specified by providing an appropriate
AzureOpenAIAudience
value to theAzureOpenAIClientOptions.Audience
property when creating a client. See the client configuration section of the README for more details.
Additional new features from the OpenAI
package can be found in the OpenAI changelog.
Please note: Structured Outputs support is not yet available with the 2024-07-01-preview
service API version. This means that attempting to use the feature with this library version will fail with an unrecognized property for either response_format
or strict
in request payloads; all existing functionality is unaffected. Azure OpenAI support for Structured Outputs is coming soon.
Bugs Fixed
- Removed an inappropriate null check in
FileClient.GetFiles()
(azure-sdk-for-net 44912) - Addressed issues with automatic retry behavior, including for HTTP 429 rate limit errors:
- Authorization headers are now appropriately reapplied to retried requests
- Automatic retry behavior will now honor header-based intervals from
Retry-After
and related response headers - The client will now originate an
x-ms-client-request-id
header to match prior library behavior and facilitate troubleshooting
Additional, non-Azure-specific bug fixes can be found in the OpenAI changelog.
OpenAI Inference 2.0.0-beta.4 Changelog
Breaking Changes
AudioClient
’sGenerateSpeechFromText()
method is renamed toGenerateSpeech()
OpenAIFileInfo
’sSizeInBytes
is now of typeint?
(previouslylong?
)
OpenAI Inference 2.0.0-beta.5 Changelog
Bugs Fixed
- Corrected an internal deserialization issue that caused recent updates to Assistants
file_search
to fail when streaming a run. Strongly typed support forranking_options
is not included but will arrive soon. (cc9169a) - Mitigated a .NET runtime issue that prevented
ChatResponseFormat
from serializing correct on targets including Unity. (cc9169a)
Features Added
- Added the
OpenAIChatModelFactory
in theOpenAI.Chat
namespace (a static class that can be used to instantiate OpenAI models for mocking in non-live test scenarios). (79014ab)
Breaking Changes
- Updated fine-tuning pagination methods
GetJobs
,GetEvents
, andGetJobCheckpoints
to returnIEnumerable<ClientResult>
instead ofClientResult
. (5773292) - Updated the batching pagination method
GetBatches
to returnIEnumerable<ClientResult>
instead ofClientResult
. (5773292) - Changed
GeneratedSpeechVoice
from an enum to an “extensible enum”. (79014ab) - Changed
GeneratedSpeechFormat
from an enum to an “extensible enum”. (cc9169a) - Renamed
SpeechGenerationOptions
’sSpeed
property toSpeedRatio
. (cc9169a)
Resource Management - API Management 1.3.0-beta.1 Changelog
Resource Management - App Compliance Automation 1.0.0 Changelog
Resource Management - Azure Stack HCI 1.2.0 Changelog
Resource Management - Batch 1.5.0 Changelog
Resource Management - Billing 1.2.0 Changelog
Resource Management - Compute 1.6.0 Changelog
Resource Management - Computefleet 1.0.0-beta.1 Changelog
Resource Management - Connected VMware vSphere 1.1.0 Changelog
Resource Management - Container Apps 1.3.0-beta.1 Changelog
Resource Management - Container Apps 1.3.0 Changelog
Resource Management - Data Factory 1.3.0 Changelog
Resource Management - Data Factory 1.4.0 Changelog
Resource Management - Desktop Virtualization 1.3.0 Changelog
Resource Management - Devopsinfrastructure 1.0.0-beta.1 Changelog
Resource Management - Fabric 1.0.0-beta.2 Changelog
Resource Management - HDInsight 1.2.0-beta.3 Changelog
Resource Management - Hardware Security Modules 1.0.0-beta.3 Changelog
Resource Management - Healthdataaiservices 1.0.0-beta.1 Changelog
Resource Management - Machine Learning 1.2.0 Changelog
Resource Management - Machine Learning 1.2.1 Changelog
Resource Management - Mongocluster 1.0.0-beta.1 Changelog
Resource Management - Monitor 1.4.0-beta.1 Changelog
Resource Management - NetApp Files 1.7.0 Changelog
Resource Management - Network 1.9.0 Changelog
Resource Management - Private DNS 1.2.0 Changelog
Resource Management - Resource Manager 1.13.0 Changelog
Resource Management - Security Insights 1.2.0-beta.1 Changelog
Resource Management - Standby Pool 1.0.0 Changelog
Schema Registry 1.4.0 Changelog
Features Added
- General availability of JSON and Custom schema formats.
- General availability of
SchemRegistrySerializer
Secrets Configuration Provider for .NET 1.3.2 Changelog
Other Changes
- Updated reference to
Azure.Security.KeyVault.Secrets
v4.6.0 to mitigate a reported SSRF vulnerability.
Storage - Blobs 12.22.0 Changelog
Bugs Fixed
- Fixed [BUG] Method overload BlobBaseClient.OpenReadAsync()/OpenRead() to correctly handle the allowBlobModifications flag #45516
- Fixed [BUG] Fixed Equality failures due to implicit cast on BlobErrorCode #44213
Features Added
- Includes all features from 12.22.0-beta.1
Storage - Blobs Batch 12.19.0 Changelog
Features Added
- Includes all features from 12.19.0-beta.1.
Storage - Blobs ChangeFeed 12.0.0-preview.49 Changelog
Features Added
- This release contains bug fixes to improve quality.
Storage - Common 12.21.0 Changelog
Features Added
- This release contains bug fixes to improve quality.
Storage - Files Data Lake 12.20.0 Changelog
Bugs Fixed
- Fixed [BUG] Method overload DataLakeFileClient.OpenReadAsync()/OpenRead() to correctly handle the allowBlobModifications flag #45516
Features Added
- Includes all features from 12.20.0-beta.1.
Storage - Files Share 12.20.0 Changelog
Bugs Fixed
- Fixed [BUG] Method overload ShareFileClient.OpenReadAsync()/OpenRead() to correctly handle the allowBlobModifications flag #45516
- Fixed [BUG] Fixed Equality failures due to implicit cast on ShareErrorCode #44213
Features Added
- Includes all features from 12.20.0-beta.1.
Storage - Queues 12.20.0 Changelog
Bugs Fixed
- Fixed [BUG] Fixed Equality failures due to implicit cast on QueueErrorCode #44213
Features Added
- Includes all features from 12.20.0-beta.1.
- Removed Queue Permissions enum from 12.20.0-beta.1.
System.ClientModel 1.1.0-beta.7 Changelog
Features Added
- Added
JsonModelConverter
to allow integration with System.Text.Json.
System.ClientModel 1.1.0 Changelog
Other Changes
- Removed implicit cast from
string
toApiKeyCredential
(#45554). - Upgraded
System.Text.Json
package dependency to 6.0.9 (#45416). - Removed
PageCollection<T>
and related types in favor of usingCollectionResult<T>
and related types as the return values from paginated service endpoints (#45961).
Tables 12.9.1 Changelog
Bugs Fixed
- Fixed an issue that prevented use of stored access policy based SaS Uris by adding a parameterless constructor to
TableSasBuilder
. The resulting builder can then be modified to include the stored access policy identifier or any other details.
WebJobs Extensions - Web PubSub 1.8.0 Changelog
Features Added
- Added MQTT client events support.
unknown 1.0.0-beta.1 Changelog
Features Added
- The initial beta release of Microsoft.Azure.WebJobs.Extensions.WebPubSubForSocketIO
unknown 1.0.0-beta.2 Changelog
Features Added
- Add
UserId
parameter inSocketIONegotiate
attribute to assign user id to sockets - Add
userId
binding parameter inSocketIOTrigger
attribute to get user id of sockets.
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.DocumentIntelligence --version 1.0.0-beta.3
$> dotnet add package Azure.AI.OpenAI --version 2.0.0-beta.3
$> dotnet add package Azure.AI.OpenAI --version 2.0.0-beta.4
$> dotnet add package Azure.AI.OpenAI --version 2.0.0-beta.5
$> dotnet add package Azure.Communication.Chat --version 1.3.1
$> dotnet add package Azure.Communication.Rooms --version 1.1.1
$> dotnet add package Azure.Core --version 1.43.0
$> dotnet add package Azure.Data.SchemaRegistry --version 1.4.0
$> dotnet add package Azure.Data.Tables --version 12.9.1
$> dotnet add package Azure.Extensions.AspNetCore.Configuration.Secrets --version 1.3.2
$> dotnet add package Azure.Extensions.AspNetCore.DataProtection.Keys --version 1.2.4
$> dotnet add package Azure.Health.Insights.RadiologyInsights --version 1.0.0
$> dotnet add package Azure.Identity --version 1.13.0-beta.2
$> dotnet add package Azure.Maps.Rendering --version 2.0.0-beta.1
$> dotnet add package Azure.Maps.Routing --version 1.0.0-beta.3
$> dotnet add package Azure.Maps.Search --version 2.0.0-beta.1
$> dotnet add package Azure.Maps.Search --version 2.0.0-beta.2
$> dotnet add package Azure.Messaging.EventGrid --version 4.25.0
$> dotnet add package Azure.Messaging.EventHubs.Processor --version 5.11.5
$> dotnet add package Azure.Monitor.Query --version 1.5.0
$> dotnet add package Azure.ResourceManager --version 1.13.0
$> dotnet add package Azure.ResourceManager.ApiManagement --version 1.3.0-beta.1
$> dotnet add package Azure.ResourceManager.AppComplianceAutomation --version 1.0.0
$> dotnet add package Azure.ResourceManager.AppContainers --version 1.3.0-beta.1
$> dotnet add package Azure.ResourceManager.AppContainers --version 1.3.0
$> dotnet add package Azure.ResourceManager.Batch --version 1.5.0
$> dotnet add package Azure.ResourceManager.Billing --version 1.2.0
$> dotnet add package Azure.ResourceManager.Compute --version 1.6.0
$> dotnet add package Azure.ResourceManager.ComputeFleet --version 1.0.0-beta.1
$> dotnet add package Azure.ResourceManager.ConnectedVMwarevSphere --version 1.1.0
$> dotnet add package Azure.ResourceManager.DataFactory --version 1.3.0
$> dotnet add package Azure.ResourceManager.DataFactory --version 1.4.0
$> dotnet add package Azure.ResourceManager.DesktopVirtualization --version 1.3.0
$> dotnet add package Azure.ResourceManager.DevOpsInfrastructure --version 1.0.0-beta.1
$> dotnet add package Azure.ResourceManager.Fabric --version 1.0.0-beta.2
$> dotnet add package Azure.ResourceManager.HDInsight --version 1.2.0-beta.3
$> dotnet add package Azure.ResourceManager.HardwareSecurityModules --version 1.0.0-beta.3
$> dotnet add package Azure.ResourceManager.Hci --version 1.2.0
$> dotnet add package Azure.ResourceManager.HealthDataAIServices --version 1.0.0-beta.1
$> dotnet add package Azure.ResourceManager.MachineLearning --version 1.2.0
$> dotnet add package Azure.ResourceManager.MachineLearning --version 1.2.1
$> dotnet add package Azure.ResourceManager.MongoCluster --version 1.0.0-beta.1
$> dotnet add package Azure.ResourceManager.Monitor --version 1.4.0-beta.1
$> dotnet add package Azure.ResourceManager.NetApp --version 1.7.0
$> dotnet add package Azure.ResourceManager.Network --version 1.9.0
$> dotnet add package Azure.ResourceManager.PrivateDns --version 1.2.0
$> dotnet add package Azure.ResourceManager.SecurityInsights --version 1.2.0-beta.1
$> dotnet add package Azure.ResourceManager.StandbyPool --version 1.0.0
$> dotnet add package Azure.Storage.Blobs --version 12.22.0
$> dotnet add package Azure.Storage.Blobs.Batch --version 12.19.0
$> dotnet add package Azure.Storage.Blobs.ChangeFeed --version 12.0.0-preview.49
$> dotnet add package Azure.Storage.Common --version 12.21.0
$> dotnet add package Azure.Storage.Files.DataLake --version 12.20.0
$> dotnet add package Azure.Storage.Files.Shares --version 12.20.0
$> dotnet add package Azure.Storage.Queues --version 12.20.0
$> dotnet add package Microsoft.Azure.WebJobs.Extensions.Storage.Blobs --version 5.3.2
$> dotnet add package Microsoft.Azure.WebJobs.Extensions.Storage.Queues --version 5.3.2
$> dotnet add package Microsoft.Azure.WebJobs.Extensions.WebPubSub --version 1.8.0
$> dotnet add package Microsoft.Azure.WebJobs.Extensions.WebPubSubForSocketIO --version 1.0.0-beta.1
$> dotnet add package Microsoft.Azure.WebJobs.Extensions.WebPubSubForSocketIO --version 1.0.0-beta.2
$> dotnet add package Microsoft.Azure.WebPubSub.Common --version 1.3.0
$> dotnet add package Microsoft.Extensions.Azure --version 1.7.5
$> dotnet add package System.ClientModel --version 1.1.0-beta.7
$> dotnet add package System.ClientModel --version 1.1.0
Feedback
If you have a bug or feature request for one of the libraries, please file an issue in our repo.