Azure SDK for .NET (October 2021)

The Azure SDK team is pleased to announce our October 2021 client library releases.

25 packages released this month.

Stable Packages (7)

• App Configuration

• Azure Remote Rendering

• Communication Chat

• Core

• Event Grid

• Monitor Query

• Service Bus

Patch Updates (2)

• Event Hubs

• Event Hubs - Event Processor

Beta Packages (16)

• Cognitive Search

• Form Recognizer

• Monitor OpenTelemetry Exporter

• Personalizer

• Question Answering

• Resource Management - Compute

• Resource Management - Core

• Resource Management - KeyVault

• Resource Management - Network

• Resource Management - Resources

• Resource Management - Storage

• Schema Registry

• Schema Registry - Avro

• Service Bus

• Synapse - Artifacts

• Synapse - Spark

Release highlights

App Configuration 1.2.0 Changelog

Features Added

• Added a ConfigurationSetting constructor parameter to set an ETag.

Azure Remote Rendering 1.1.0 Changelog

• Ensure the MS-CV header is not redacted in logs. If you are logging an issue, it can be useful to quote this value.

Cognitive Search 11.4.0-beta.4 Changelog

Features Added

• Added APIs to reset documents and skills.

Breaking Changes

• Renamed QueryAnswer to QueryAnswerType in SearchOptions.
• Renamed QueryCaption to QueryCaptionType in SearchOptions.
• Renamed QuerySpeller to QuerySpellerType in SearchOptions.
• Renamed QueryCaptionHighlight to QueryCaptionHighlightEnabled in SearchOptions.

Communication Chat 1.1.0 Changelog

Updated Azure.Communication.Chat version.

Core 1.20.0 Changelog

Bugs Fixed

• Fixed an exception during EventSource creation on Xamarin.

Features Added

• Added the static DelegatedTokenCredential type with a Create method, which returns an instance of TokenCredential that uses the supplied delgates to produce an AccessToken. This would most typically be used when an token has previously been obtained from some other source and that token needs to be returned by a TokenCredential instance.
• Added ResponseError type to represent an Azure error type.
• Added an experimental ActivitySource support.

Event Grid 4.7.0 Changelog

Features Added

• Added API Management events
• Added AcsUserDisconnectedEventData event

Event Hubs 5.6.2 Changelog

Bugs Fixed

• Dependencies have been updated to resolve an error when creating EventSource instances when used with Xamarin.

Event Hubs - Event Processor 5.6.2 Changelog

Bugs Fixed

• Dependencies have been updated to resolve an error when creating EventSource instances when used with Xamarin.

Form Recognizer 4.0.0-beta.1 Changelog

Features Added

• This version of the SDK defaults to the latest supported Service API version, which currently is 2021_09_30_preview.
• Added class DocumentAnalysisClient to the new Azure.AI.FormRecognizer.DocumentAnalysis namespace. This will be the main client to use when analyzing documents for service versions 2021_09_30_preview and higher. For lower versions, please use the FormRecognizerClient.
• Added methods StartAnalyzeDocument and StartAnalyzeDocumentFromUri to DocumentAnalysisClient. These methods substitute all existing StartRecognize<...> methods, such as StartRecognizeContent and StartRecognizeReceiptsFromUri.
• Added class DocumentModelAdministrationClient to the new Azure.AI.FormRecognizer.DocumentAnalysis namespace. This will be the main client to use for model management for service versions 2021_09_30_preview and higher. For lower versions, please use the FormTrainingClient.
• Added methods StartBuildModel, StartCopyModel, StartCreateComposedModel, GetCopyAuthorization, GetModel, GetModels, GetAccountProperties, DeleteModel, GetOperation, GetOperations, and the equivalent async methods to DocumentModelAdministrationClient.

Monitor OpenTelemetry Exporter 1.0.0-beta.3 Changelog

• Update SdkVersion to include pre-release part
• Remove otel.status_code from custom properties
• Update Request operation name to use http.route/http.url path
• Update Http Dependency name to httpUrl path and target for Db dependency
• Rename EventSource
• Update Request Name to match Operation Name
• Fix success field logic for request and dependency
• Default cloud_RoleInstance to HostName
• Add InProc dependency type and update Db target mapping
• Add ai.location.ip and ai.user.userAgent mapping
• Operation name mapping for ActivityKind = SERVER
• Update Dependency Type and Target mapping for Http and Db
• Update Http Request mapping
• Add ActivityLinks Support
• Update OpenTelemetry Package versions

Monitor Query 1.0.0 Changelog

Breaking Changes

• Query renamed to QueryWorkspace in LogsQueryClient
• Query renamed to QueryResource in MetricsQueryClient
• Interval renamed to Granularity in MetricsQueryResult
• DisplayDescription renamed to Description in MetricResult
• Type renamed to ResourceType in MetricResult
• Removed LogsQueryClientAudience and MetricsQueryClientAudience types and corresponding properties on MetricsQueryClientOptions and LogsQueryClientOptions.

Features Added

• Added GetMetricByName to MetricsQueryResult
• Added MetricsQueryResult to MonitorQueryModelFactory
• Added LogsQueryResult to MonitorQueryModelFactory

Personalizer 2.0.0-beta.1 Changelog

Features Added

• Initial Release of Azure AI Personalizer cognitive service version 2.0.0-beta.1 SDK.
• This is a new release of the Azure AI Personalizer SDK that follows the Azure SDK guidelines, so the structure is a little different from the old SDK.
• Multi-Slot personalization
• Personalizer Automatic Optimization
• Support Azure Active Directory Authentication.
• New overloads for Rank, Reward and the PersonalizerClient constructor.

Breaking Changes

• PersonalizerClient contains (single and multi-slot) Rank / Reward / Activate functionality.
• All other functionality (ServiceConfiguration, Evaluations, Policy, Model, Log) was moved to PersonalizerAdministrationClient.
• All methods are exposed in their top level client. For example PersonalizerClient.Events.Reward is now PersonalizerClient.Reward.
• Changed method names and signatures to follow Azure SDK guidelines.

Question Answering 1.0.0-beta.2 Changelog

Breaking Changes

• Changed StrictFilters to QueryFilters which now contains a list of MetadataRecord - key-value pairs that allow for referencing the same key numerous times in a filter similar to, for example, “food = ‘fruit’ OR food = ‘vegetable’”.
• Made projectName and deploymentName parameters required for QuestionAnsweringClient methods.
• Moved QueryKnowledgeBaseOptions, QueryTextOptions, and TextRecord to Azure.AI.Language.QuestionAnswering namespace.
• Removed QueryTextOptions.StringIndexType property and will always pass StringIndexType.Utf16CodeUnit for .NET.
• Renamed “CompoundOperation” to “LogicalOperation” in properties and type names.
• Renamed QuestionKnowledgeBaseOptions.StrictFilters to Filters and changed type to QueryFilters.

Features Added

• Added support for API version 2021-07-15-preview.
• Added QuestionAnsweringClientOptions.DefaultLanguage to specify a client default, and the language parameters of QueryTextOptions optional.

Resource Management - Compute 1.0.0-beta.2 Changelog

Resource Management - Core 1.0.0-beta.4 Changelog

Resource Management - KeyVault 1.0.0-beta.2 Changelog

Resource Management - Network 1.0.0-beta.2 Changelog

Resource Management - Resources 1.0.0-beta.2 Changelog

Resource Management - Storage 1.0.0-beta.2 Changelog

Schema Registry 1.0.0-beta.4 Changelog

Features Added

• Added FullyQualifiedNamespace property to SchemaRegistryClient.

Breaking Changes

• Removed caching from SchemaRegistryClient.
• Renamed GetSchemaId method to GetSchemaProperties.
• Renamed endpoint parameter to fullyQualifiedNamespace in constructor.
• Renamed SerializationType to SchemaFormat.
• Make all methods return Response<T> instead of T.
• Changed return type of GetSchema to SchemaRegistrySchema type.

Schema Registry - Avro 1.0.0-beta.3 Changelog

Features Added

• Added caching of schemas.
• Updated dependency on Azure.Data.SchemaRegistry.

Service Bus 7.4.0 Changelog

Bugs Fixed

• Leveraged fix in AMQP library that allows messages to be properly unlocked when shutting down the processor.

Features Added

• Added support for cancelling send and receives while in-flight.

Service Bus 7.5.0-beta.1 Changelog

Features Added

• Added support for specifying the maximum message size for entities in Premium namespaces.

Synapse - Artifacts 1.0.0-preview.11 Changelog

• Upgrade to package-artifacts-composite-v1
• Added SparkConfigurationClient, KqlScriptsClient and associated support types.
• Update type of many modles from string to object
• SparkJobDefinition, Notebook and SqlScript now has a folder property
• SqlScript now has poolName and databaseName properties

Synapse - Spark 1.0.0-preview.8 Changelog

Features Added

• Enhance Long Running Operation (LRO) logic for SparkBatchClient to support both scenarios of job submission and job execution.
• Update LivyState to be an extensible enum.

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.FormRecognizer --version 4.0.0-beta.1
$> dotnet add package Azure.AI.Language.QuestionAnswering --version 1.0.0-beta.2
$> dotnet add package Azure.AI.Personalizer --version 2.0.0-beta.1
$> dotnet add package Azure.Analytics.Synapse.Artifacts --version 1.0.0-preview.11
$> dotnet add package Azure.Analytics.Synapse.Spark --version 1.0.0-preview.8
$> dotnet add package Azure.Communication.Chat --version 1.1.0
$> dotnet add package Azure.Core --version 1.20.0
$> dotnet add package Azure.Data.AppConfiguration --version 1.2.0
$> dotnet add package Azure.Data.SchemaRegistry --version 1.0.0-beta.4
$> dotnet add package Azure.Messaging.EventGrid --version 4.7.0
$> dotnet add package Azure.Messaging.EventHubs --version 5.6.2
$> dotnet add package Azure.Messaging.EventHubs.Processor --version 5.6.2
$> dotnet add package Azure.Messaging.ServiceBus --version 7.4.0
$> dotnet add package Azure.Messaging.ServiceBus --version 7.5.0-beta.1
$> dotnet add package Azure.MixedReality.RemoteRendering --version 1.1.0
$> dotnet add package Azure.Monitor.OpenTelemetry.Exporter --version 1.0.0-beta.3
$> dotnet add package Azure.Monitor.Query --version 1.0.0
$> dotnet add package Azure.ResourceManager --version 1.0.0-beta.4
$> dotnet add package Azure.ResourceManager.Compute --version 1.0.0-beta.2
$> dotnet add package Azure.ResourceManager.KeyVault --version 1.0.0-beta.2
$> dotnet add package Azure.ResourceManager.Network --version 1.0.0-beta.2
$> dotnet add package Azure.ResourceManager.Resources --version 1.0.0-beta.2
$> dotnet add package Azure.ResourceManager.Storage --version 1.0.0-beta.2
$> dotnet add package Azure.Search.Documents --version 11.4.0-beta.4
$> dotnet add package Microsoft.Azure.Data.SchemaRegistry.ApacheAvro --version 1.0.0-beta.3

Feedback

If you have a bug or feature request for one of the libraries, please file an issue in our repo.