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

48 packages released this month.

Stable Packages (22)

  • App Configuration

  • Core

  • Event Grid

  • Identity

  • Question Answering

  • Resource Management - Bare Metal Infrastructure

  • Resource Management - Compute

  • Resource Management - Container Instances

  • Resource Management - Container Service

  • Resource Management - Data Factory

  • Resource Management - Event Hubs

  • Resource Management - HDInsight

  • Resource Management - Hybrid Kubernetes

  • Resource Management - KeyVault

  • Resource Management - Monitor

  • Resource Management - Network

  • Resource Management - Rdbms

  • Resource Management - SignalR

  • Schema Registry

  • Service Bus

  • Tables

  • Web PubSub

Patch Updates (2)

  • Identity

  • Monitor Query

Beta Packages (19)

  • Cognitive Search

  • Communication Identity

  • Conversation Analysis

  • Form Recognizer

  • Key Vault - Administration

  • Key Vault - Certificates

  • Key Vault - Keys

  • Key Vault - Secrets

  • Purview Catalog

  • Purview Scanning

  • Resource Management - Cosmos DB

  • Resource Management - Synapse

  • Schema Registry - Avro

  • Storage - Blobs

  • Storage - Files Data Lake

  • Synapse - Artifacts

  • Text Analytics

  • Video Analyzer Edge

  • Web PubSub

Release highlights

App Configuration 1.3.0 Changelog

Bugs Fixed

  • Fix the issue that data was persisted according to an incorrect schema/in an incorrect format (#20518)

SecretReferenceConfigurationSetting in 1.2.0 used “secret_uri” rather than “uri” as the schema keywords which broken inter-operation of SecretReferenceConfigurationSetting between SDK and the portal.

Please:

  • Use 1.3.0+ for any SecretReferenceConfigurationSetting uses.
  • Call a get method for existing SecretReferenceConfigurationSettings and set them back to correct the format.

Cognitive Search 11.3.0b5 Changelog

Features Added

  • Added properties to SearchClient.search: session_id, scoring_statistics.
  • Added properties to SearchIndexerDataSourceConnection: identity, encryption_key.
  • Added select property to the following SearchIndexClient operations: get_synonym_maps, list_indexes.
  • Added select property to the following SearchIndexersClient operations: get_data_source_connections, get_indexers, get_skillsets.
  • Added operations to SearchIndexerClient: reset_skills, reset_documents.
  • Added model: DocumentKeysOrIds

Communication Identity 1.1.0b1 Changelog

Features Added

  • Added support for Microsoft 365 Teams identities
  • CommunicationIdentityClient added a new method get_token_for_teams_user that provides the ability to exchange an AAD access token of a Teams user for a Communication Identity access token

Conversation Analysis 1.0.0b1 Changelog

Features Added

  • Initial release

Core 1.20.0 Changelog

Bugs Fixed

  • The Content-Length header in a http response is strictly checked against the actual number of bytes in the body, rather than silently truncating data in case the underlying tcp connection is closed prematurely. (thanks to @jochen-ott-by for the contribution) #20412
  • UnboundLocalError when SansIOHTTPPolicy handles an exception #15222
  • Add default content type header of text/plain and content length header for users who pass unicode strings to the content kwarg of HttpRequest in 2.7 #21550
  • respect text encoding specified in argument (thanks to @ryohji for the contribution) #20796
  • Fix “coroutine x.read() was never awaited” warning from ContentDecodePolicy #21318
  • fix type check for data input to azure.core.rest for python 2.7 users #21341
  • use charset_normalizer if chardet is not installed to migrate aiohttp 3.8.0 changes.
  • Correctly set response’s content to decompressed body when users are using aiohttp transport with decompression headers #21620

Features Added

  • GA send_request onto the azure.core.PipelineClient and azure.core.AsyncPipelineClient. This method takes in requests and sends them through our pipelines.
  • GA azure.core.rest. azure.core.rest is our new public simple HTTP library in azure.core that users will use to create requests, and consume responses.
  • GA errors StreamConsumedError, StreamClosedError, and ResponseNotReadError to azure.core.exceptions. These errors are thrown if you mishandle streamed responses from the azure.core.rest module
  • add kwargs to the methods for iter_raw and iter_bytes #21529
  • no longer raise JSON errors if users pass in file descriptors of JSON to the json kwarg in HttpRequest #21504
  • Added new error type IncompleteReadError which is raised if peer closes the connection before we have received the complete message body.

Breaking Changes

  • SansIOHTTPPolicy.on_exception returns None instead of bool.

Event Grid 4.7.0 Changelog

Features Added

  • Added support for publishing native CNCF cloudevents (https://pypi.org/project/cloudevents/).

Form Recognizer 3.2.0b2 Changelog

Features Added

  • Added get_words() on DocumentLine.
  • Added samples showing how to use get_words() on a DocumentLine under /samples/v3.2-beta: sample_get_words_on_document_line.py and sample_get_words_on_document_line_async.py.

Breaking Changes

  • Renamed DocumentElement to DocumentContentElement.

Identity 1.7.0 Changelog

Breaking Changes

These changes do not impact the API of stable versions such as 1.6.0. Only code written against a beta version such as 1.7.0b1 may be affected.

  • The allow_multitenant_authentication argument has been removed and the default behavior is now as if it were true. The multitenant authentication feature can be totally disabled by setting the environment variable AZURE_IDENTITY_DISABLE_MULTITENANTAUTH to True.
  • azure.identity.RegionalAuthority is removed.
  • regional_authority argument is removed for CertificateCredential and ClientSecretCredential.
  • AzureApplicationCredential is removed.
  • client_credential in the ctor of OnBehalfOfCredential is removed. Please use client_secret or client_certificate instead.
  • Make user_assertion in the ctor of OnBehalfOfCredential a keyword only argument.

Identity 1.7.1 Changelog

Bugs Fixed

  • Fix multi-tenant auth using async AadClient (#21289)

Key Vault - Administration 4.1.0b2 Changelog

Features Added

  • Added support for multi-tenant authentication when using azure-identity 1.7.1 or newer (#20698)

Key Vault - Certificates 4.4.0b2 Changelog

Features Added

  • Added support for multi-tenant authentication when using azure-identity 1.7.1 or newer (#20698)

Key Vault - Keys 4.5.0b5 Changelog

Features Added

  • Added support for multi-tenant authentication when using azure-identity 1.7.1 or newer (#20698)

Breaking Changes

These changes do not impact the API of stable versions such as 4.4.0. Only code written against a beta version such as 4.5.0b1 may be affected.

  • KeyClient.get_random_bytes now returns bytes instead of RandomBytes. The RandomBytes class has been removed
  • Renamed the version keyword-only argument in KeyClient.get_cryptography_client to key_version
  • Renamed KeyReleasePolicy.data to KeyReleasePolicy.encoded_policy
  • Renamed the target parameter in KeyClient.release_key to target_attestation_token

Key Vault - Secrets 4.4.0b2 Changelog

Features Added

  • Added support for multi-tenant authentication when using azure-identity 1.7.1 or newer (#20698)

Monitor Query 1.0.1 Changelog

Bugs Fixed

  • Fixed a bug where Metadata values in timestamp don’t show up sometimes.

Purview Catalog 1.0.0b2 Changelog

Features

  • Add convenience operations to client

Breaking changes

  • Remove rest layer and request builders(detailed description is in README.md)
  • The HttpRequest parameter to send_request has changed from http_request to request
  • Ordering of endpoint and credential params have changed

Purview Scanning 1.0.0b2 Changelog

Features

  • Add convenience operations to client

Breaking changes

  • Remove rest layer and request builders(detailed description is in README.md)
  • The HttpRequest parameter to send_request has changed from http_request to request
  • Ordering of endpoint and credential params have changed

Question Answering 1.0.0 Changelog

Breaking Changes

  • Method QuestionAnsweringClient.query_knowledge_base has been renamed to get_answers
  • Method QuestionAnsweringClient.query_text has been renamed to get_answers_from_text
  • Model QueryKnowledgeBaseOptions has been renamed to AnswersOptions
  • Method kwarg and model property QueryKnowledgeBaseOptions.confidence_score_threshold has been renamed to AnswersOptions.confidence_threshold
  • Method kwarg and model property QueryKnowledgeBaseOptions.answer_span_request has been renamed to AnswersOptions.short_answer_options
  • Method kwarg and model property QueryKnowledgeBaseOptions.ranker_type has been renamed to AnswersOptions.ranker_kind
  • Method kwarg and model property QueryKnowledgeBaseOptions.context has been renamed to AnswersOptions.answer_context
  • Model QueryTextOptions has been renamed to AnswersFromTextOptions
  • Method kwarg and model property QueryTextOptions.records has been renamed to AnswersFromTextOptions.text_documents
  • Model AnswerSpanRequest has been renamed to ShortAnswerOptions
  • Model property AnswerSpanRequest.confidence_score_threshold has been renamed to ShortAnswerOptions.confidence_threshold
  • Model property AnswerSpanRequest.top_answers_with_span has been renamed to ShortAnswerOptions.top
  • Model KnowledgeBaseAnswerRequestContext has been renamed to KnowledgeBaseAnswerContext
  • Model property KnowledgeBaseAnswerRequestContext.previous_user_query has been renamed to KnowledgeBaseAnswerContext.previous_question
  • Model TextRecord has been renamed to TextDocument
  • Model KnowledgeBaseAnswers has been renamed to AnswersResult
  • Model TextAnswers has been renamed to AnswersFromTextResult
  • Model property KnowledgeBaseAnswer.answer_span has been renamed to KnowledgeBaseAnswer.short_answer
  • Model property KnowledgeBaseAnswer.id has been renamed to KnowledgeBaseAnswer.qna_id
  • Model property KnowledgeBaseAnswer.confidence_score has been renamed to KnowledgeBaseAnswer.confidence
  • Model property AnswerSpan.confidence_score has been renamed to AnswerSpan.confidence
  • Model property TextAnswer.confidence_score has been renamed to TextAnswer.confidence
  • Model property TextAnswer.answer_span has been renamed to TextAnswer.short_answer
  • Enums LogicalOperationKind and RankerType have been removed
  • The operations and aio.operations namespaces are no longer public

Bugs Fixed

  • Fixed formating of MetadataFilter.metadata

Resource Management - Bare Metal Infrastructure 1.0.0 Changelog

Resource Management - Compute 23.1.0 Changelog

Resource Management - Container Instances 9.1.0 Changelog

Resource Management - Container Service 16.3.0 Changelog

Resource Management - Cosmos DB 7.0.0b2 Changelog

Resource Management - Data Factory 2.0.0 Changelog

Resource Management - Event Hubs 10.0.0 Changelog

Resource Management - HDInsight 9.0.0 Changelog

Resource Management - Hybrid Kubernetes 1.1.0 Changelog

Resource Management - KeyVault 9.2.0 Changelog

Resource Management - Monitor 3.0.0 Changelog

Resource Management - Network 19.1.0 Changelog

Resource Management - Network 19.2.0 Changelog

Resource Management - Network 19.3.0 Changelog

Resource Management - Rdbms 10.0.0 Changelog

Resource Management - SignalR 1.0.0 Changelog

Resource Management - Synapse 2.1.0b2 Changelog

Resource Management - Synapse 2.1.0b3 Changelog

Schema Registry 1.0.0 Changelog

Breaking Changes

  • version instance variable in SchemaProperties has been removed.
  • schema_definition instance variable in Schema has been renamed definition.
  • id parameter in get_schema method on sync and async SchemaRegistryClient has been renamed schema_id.
  • schema_definition parameter in register_schema and get_schema_properties methods on sync and async SchemaRegistryClient has been renamed definition.
  • serializer namespace has been removed from azure.schemaregistry.

Features Added

  • SchemaRegistryClient is the top-level client class interacting with the Azure Schema Registry Service. It provides three methods:
  • register_schema: Store schema in the service by providing schema group name, schema name, schema definition, and schema format.
  • get_schema: Get schema definition and its properties by schema id.
  • get_schema_properties: Get schema properties by providing schema group name, schema name, schema definition, and schema format.
  • SchemaProperties has the following instance variables: id and format:
  • The type of format has been changed from str to SchemaFormat.
  • Schema has the following properties: properties and definition.
  • SchemaFormat provides the schema format to be stored by the service. Currently, the only supported format is Avro.
  • api_version has been added as a keyword arg to the sync and async SchemaRegistryClient constructors.

Schema Registry - Avro 1.0.0b4 Changelog

Features Added

  • Async version of AvroSerializer has been added under azure.schemaregistry.serializer.avroserializer.aio.
  • Depends on azure-schemaregistry>=1.0.0,<2.0.0.

Breaking Changes

  • SchemaParseError, SchemaSerializationError, and SchemaDeserializationError have been introduced under azure.schemaregistry.serializer.avroserializer.exceptions and will be raised for corresponding operations.
  • SchemaParseError and SchemaSerializationError may be raised for errors when calling serialize on AvroSerializer.
  • SchemaParseError and SchemaDeserializationError may be raised for errors when calling deserialize on AvroSerializer.

Service Bus 7.4.0 Changelog

Bugs Fixed

  • Fixed bug that ServiceBusReceiver can not connect to sessionful entity with session id being empty string.
  • Fixed bug that ServiceBusMessage.partition_key can not parse empty string properly.

Features Added

  • GA the support to create and update queues and topics of large message size to ServiceBusAdministrationClient. This feature is only available for Service Bus of Premium Tier.
  • Methodscreate_queue, create_topic, update_queue, update_topic on ServiceBusAdministrationClient now take a new keyword argument max_message_size_in_kilobytes.
  • QueueProperties and TopicProperties now have a new instance variable max_message_size_in_kilobytes.
  • The constructor ofServiceBusAdministrationClient as well as ServiceBusAdministrationClient.from_connection_string now take keyword argument api_version to configure the Service Bus API version. Supported service versions are “2021-05” and “2017-04”.
  • Added new enum class azure.servicebus.management.ApiVersion to represent the supported Service Bus API versions.

Storage - Blobs 12.10.0b1 Changelog

New Features

  • Account level SAS tokens now support two new permissions:
  • permanent_delete
  • Encryption Scope is now supported for Sync Blob Copy (copy_from_url())
  • Encryption Scope is now supported as a SAS permission

Fixes

  • Blob Client Typing annotation issues have been resolved, specifically invalid type inference issues (#19906)
  • Duplicate type signature issue has been resolved (#19739)

Storage - Files Data Lake 12.6.0b1 Changelog

New features

  • Added support for batch deleting files using the delete_files() method from a FileSystemClient
  • Account level SAS tokens now support two new permissions:
  • permanent_delete
  • set_immutability_policy Fixes
  • FileSystemProperties was not subscriptable. Now it is both subscriptable and attributes can also be accessed directly (#20772)
  • Datalake Client Typing annotation issues have been resolved (#19906)

Synapse - Artifacts 0.10.0 Changelog

Other Changes

  • Internal bugfixes (re-generated with latest generator)

Tables 12.2.0 Changelog

Bugs Fixed

  • Resolved bug where strings couldn’t be used instead of enum value for entity Update Mode (#20247).
  • Resolved bug where single quote characters in Partition and Row keys were not escaped correctly (#20301).

Features Added

  • Added support for async iterators in `aio.TableClient.submit_transaction (#21083, thank you yashbhutoria).

Text Analytics 5.2.0b2 Changelog

Bugs Fixed

  • Restarting a long-running operation from a saved state is now supported for the begin_analyze_actions and begin_recognize_healthcare_entities methods.
  • In the event of an action level error, available partial results are now returned for any successful actions in begin_analyze_actions.

Features Added

  • Added support for Custom Entities Recognition through the begin_analyze_actions API with the RecognizeCustomEntitiesAction and RecognizeCustomEntitiesResult types.
  • Added support for Custom Single Classification through the begin_analyze_actions API with the SingleCategoryClassifyAction and SingleCategoryClassifyActionResult types.
  • Added support for Custom Multi Classification through the begin_analyze_actions API with the MultiCategoryClassifyAction and MultiCategoryClassifyActionResult types.
  • Multiple of the same action type is now supported with begin_analyze_actions.

Video Analyzer Edge 1.0.0b3 Changelog

  • Added device discovery and device detail request for ONVIF enabled devices.
  • Added Remote Device Adapter configuration for ingesting video in a private network
  • Added retention policy to VideoSink

Web PubSub 1.0.0b2 Changelog

  • Change api-version to 2021-10-01
  • Add operations to client
  • Support AAD
  • Support Api Management Proxy

Web PubSub 1.0.0 Changelog

Breaking changes

  • rename operation generate_client_token to get_client_access_token
  • moved operation build_authentication_token into get_client_access_token on the client
  • rename parameter role to roles of operation get_client_access_token
  • remove the operations namespace from azure.messaging.webpubsubservice
  • rename operation check_permission to has_permission
  • operations connection_exists, group_exists, user_exists, and has_permission now return boolean values instead of raising
  • move parameter ‘hub’ from operation to client

Latest Releases

View all the latest versions of Python packages here.

Installation Instructions

To install the latest beta version of the packages, copy and paste the following commands into a terminal:

$> pip install azure-ai-formrecognizer==3.2.0b2
$> pip install azure-ai-language-conversations==1.0.0b1
$> pip install azure-ai-language-questionanswering==1.0.0
$> pip install azure-ai-textanalytics==5.2.0b2
$> pip install azure-appconfiguration==1.3.0
$> pip install azure-communication-identity==1.1.0b1
$> pip install azure-core==1.20.0
$> pip install azure-data-tables==12.2.0
$> pip install azure-eventgrid==4.7.0
$> pip install azure-identity==1.7.0
$> pip install azure-identity==1.7.1
$> pip install azure-keyvault-administration==4.1.0b2
$> pip install azure-keyvault-certificates==4.4.0b2
$> pip install azure-keyvault-keys==4.5.0b5
$> pip install azure-keyvault-secrets==4.4.0b2
$> pip install azure-media-videoanalyzer-edge==1.0.0b3
$> pip install azure-messaging-webpubsubservice==1.0.0b2
$> pip install azure-messaging-webpubsubservice==1.0.0
$> pip install azure-mgmt-baremetalinfrastructure==1.0.0
$> pip install azure-mgmt-compute==23.1.0
$> pip install azure-mgmt-containerinstance==9.1.0
$> pip install azure-mgmt-containerservice==16.3.0
$> pip install azure-mgmt-cosmosdb==7.0.0b2
$> pip install azure-mgmt-datafactory==2.0.0
$> pip install azure-mgmt-eventhub==10.0.0
$> pip install azure-mgmt-hdinsight==9.0.0
$> pip install azure-mgmt-hybridkubernetes==1.1.0
$> pip install azure-mgmt-keyvault==9.2.0
$> pip install azure-mgmt-monitor==3.0.0
$> pip install azure-mgmt-network==19.1.0
$> pip install azure-mgmt-network==19.2.0
$> pip install azure-mgmt-network==19.3.0
$> pip install azure-mgmt-rdbms==10.0.0
$> pip install azure-mgmt-signalr==1.0.0
$> pip install azure-mgmt-synapse==2.1.0b2
$> pip install azure-mgmt-synapse==2.1.0b3
$> pip install azure-monitor-query==1.0.1
$> pip install azure-purview-catalog==1.0.0b2
$> pip install azure-purview-scanning==1.0.0b2
$> pip install azure-schemaregistry==1.0.0
$> pip install azure-schemaregistry-avroserializer==1.0.0b4
$> pip install azure-search-documents==11.3.0b5
$> pip install azure-servicebus==7.4.0
$> pip install azure-storage-blob==12.10.0b1
$> pip install azure-storage-file-datalake==12.6.0b1
$> pip install azure-synapse-artifacts==0.10.0

Feedback

If you have a bug or feature request for one of the libraries, please post an issue to GitHub.