The Azure SDK team is pleased to announce our May 2022 client library releases.

48 packages released this month.

Stable Packages (18)

  • Avro Encoder

  • Blobs

  • Core - Client - Core

  • Event Hubs

  • Files Data Lake

  • Files Shares

  • Identity

  • Queues

  • Resource Management - Container Instances

  • Resource Management - Container Service

  • Resource Management - Data Factory

  • Resource Management - Network

  • Resource Management - Red Hat OpenShift

  • Resource Management - Reservations

  • Resource Management - Resources

  • Resource Management - Service Linker

  • Schema Registry

  • Tables

Patch Updates (4)

  • Cognitive Search

  • Keys

  • Monitor Query

  • Service Bus

Beta Packages (18)

  • Blobs

  • Communication Phone Numbers

  • Container Registry

  • Conversation Analysis

  • Event Hubs

  • Files Data Lake

  • Files Shares

  • Queues

  • Resource Management - Chaos

  • Resource Management - App

  • Resource Management - Bot Service

  • Resource Management - Cosmos DB

  • Resource Management - Dashboard

  • Resource Management - Resources

  • Resource Management - Synapse

  • Resource Management - Video Analyzer

  • Synapse - Artifacts

  • Video Analyzer Edge

Release highlights

Avro Encoder 1.0.0 Changelog

Features Added

  • AvroEncoder sync and async classes provide the functionality to encode and decode content which follows a schema with the RecordSchema format, as defined by the Apache Avro specification. The Apache Avro library is used as the implementation for encoding and decoding. The encoder will automatically register and retrieve schemas from Azure Schema Registry Service. It provides the following methods:
  • constructor: If auto_register=True keyword is passed in, will automatically register schemas passed in to the encode method. Otherwise, and by default, will require pre-registering of schemas passed to encode. Takes a group_name argument that is optional when decoding, but required for encoding.
  • encode: Encodes dict content into bytes according to the given schema and registers schema if needed. Returns either a dict of encoded content and corresponding content type or a MessageType subtype object, depending on arguments provided.
  • decode: Decodes bytes content into dict content by automatically retrieving schema from the service.
  • MessageContent TypedDict has been introduced with the following required keys:
  • content: The bytes content.
  • content_type: The string content type, which holds the schema ID and the record format indicator.
  • MessageType has been introduced with the following methods:
  • from_message_content: Class method that creates an object with given bytes content and string content type.
  • __message_content__: Returns a MessageContent object with content and content type values set to their respective properties on the object.
  • Schemas and Schema IDs are cached locally, so that multiple calls with the same schema/schema ID will not trigger multiple service calls.
  • The number of hits, misses, and total entries for the schema/schema ID caches will be logged at an info level when a new entry is added.
  • InvalidContentError has been introduced for errors related to invalid content and content types, where __cause__ will contain the underlying exception raised by the Avro library.
  • InvalidSchemaError has been introduced for errors related to invalid schemas, where __cause__ will contain the underlying exception raised by the Apache Avro library.
  • The encode and decode methods on AvroEncoder support the following message models:
  • azure.eventhub.EventData in azure-eventhub>=5.9.0

Blobs 12.12.0b1 Changelog

Features Added

  • Added support for service version 2021-06-08.
  • Added a new paginated method for listing page ranges, list_page_ranges(). This replaces get_page_ranges() which has been deprecated.
  • Added support for copying source blob tags with start_copy_from_url() by specifying "COPY" for the tags keyword.

Blobs 12.12.0 Changelog

Features Added

  • Stable release of features from 12.12.0b1.
  • Added support for progress tracking to upload_blob() and download_blob() via a new optional callback,progress_hook.

Cognitive Search 11.2.2 Changelog

Bugs Fixed

  • Fixes a bug allowing users to set keys for cognitive service skills using the API. Exposes DefaultCognitiveServicesAccount and CognitiveServicesAccountKey

Communication Phone Numbers 1.1.0b2 Changelog

Other Changes

  • Python 2.7 is no longer supported. Please use Python version 3.6 or later.

Container Registry 1.1.0b1 Changelog

Features Added

  • Support uploading and downloading OCI manifests and artifact blobs in synchronous ContainerRegistryClient. (#24004)

Conversation Analysis 1.0.0b3 Changelog

Features Added

  • Entity resolutions
  • Extra features

Breaking Changes

  • The ConversationAnalysisOptions model used as input to the analyze_conversation operation is now wrapped in a CustomConversationalTask which combines the analysis options with the project parameters into a single model.
  • The query within the ConversationAnalysisOptions is now further qualified as a TextConversationItem with additional properties.
  • The output AnalyzeConversationResult is now wrapped in a CustomConversationalTaskResult according to the input model.

Core - Client - Core 1.24.0 Changelog

Features Added

  • Add SerializationError and DeserializationError in azure.core.exceptions for errors raised during serialization / deserialization #24312

Event Hubs 5.9.0b3 Changelog

Features Added

  • Introduced new method send_event to EventHubProducerClient which allows sending single EventData or AmqpAnnotatedMessage.
  • Introduced buffered mode sending to EventHubProducerClient which is intended to allow for efficient publishing of events without having to explicitly manage batches in the application.
  • The constructor of EventHubProducerClient and from_connection_string method now takes the following new keyword arguments for configuration:
  • buffered_mode: The flag to enable/disable buffered mode sending.
  • on_success: The callback to be called once events have been successfully published.
  • on_error: The callback to be called once events have failed to be published.
  • max_buffer_length: The total number of events per partition that can be buffered before a flush will be triggered.
  • max_wait_time: The amount of time to wait for a batch to be built with events in the buffer before publishing.
  • Introduced new method EventHubProducerClient.flush which flushes events in the buffer to be sent immediately.
  • Introduced new method EventHubProducerClient.get_buffered_event_count which returns the number of events that are buffered and waiting to be published for a given partition.
  • Introduced new property EventHubProducerClient.total_buffered_event_count which returns the total number of events that are currently buffered and waiting to be published, across all partitions.
  • Introduced new boolean keyword argument flush to EventHubProducerClient.close which indicates whether to flush the buffer or not while closing.

Event Hubs 5.9.0 Changelog

Features Added

  • The classmethod from_message_content has been added to EventData for interoperability with the Schema Registry Avro Encoder library, and takes content and content_type as positional parameters.

Files Data Lake 12.7.0b1 Changelog

Features Added

  • Added support for service version 2021-06-08 as well as previous versions.
  • Added support for Customer-Provided Keys (cpk) to all required APIs.
  • The get_paths() API now returns creation_time and expiry_time for each path.

Bugs Fixed

  • Updated create_file_system() docstring to have the correct return-type of None
  • Fixed parsing of extra / symbols not being stripped properly in async clients
  • Fixed a bug where get_paths() would fail if a path did not contain last_modified from the service.

Files Data Lake 12.7.0 Changelog

Bugs Fixed

  • Fixed a bug, introduced in the previous beta release, that caused Authentication errors when attempting to use an Account SAS with certain service level operations.

Features Added

  • Stable release of features from 12.7.0b1.

Files Shares 12.8.0b1 Changelog

Features Added

  • Added support for service version 2021-06-08.
  • Added support for missing parameters on create_directory() including file_attributes, file_creation_time, file_last_write_time, file_permission and file_permission_key.
  • Added support for setting content_type on rename_file().
  • Added support for setting file_change_time on create_directory(), set_http_headers() (directory) rename_directory(), create_file(), set_http_headers() (file) and rename_file().
  • Added support for setting file_last_written_mode on upload_range() and upload_range_from_url() with possible values of Now or Preserve.

Bugs Fixed

  • Updated create_share() docstring to have the correct return-type of None

Files Shares 12.8.0 Changelog

Bugs Fixed

  • Fixed a bug, introduced in the previous beta release, that caused Authentication errors when attempting to use an Account SAS with certain service level operations.

Features Added

  • Stable release of features from 12.8.0b1.

Identity 1.10.0 Changelog

Breaking Changes

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

  • validate_authority support is not available in 1.10.0.

Other Changes

  • Supported msal-extensions version 1.0.0 (#23927)

Keys 4.5.1 Changelog

Bugs Fixed

  • Fixed error that could occur when fetching a key rotation policy that has no defined lifetime_actions.

Monitor Query 1.0.2 Changelog

Bugs Fixed

  • Fixed a bug where having a None value in datetime throws

Queues 12.3.0b1 Changelog

Features Added

  • Added support for max_messages in receive_messages() to specify the maximum number of messages to receive from the queue.

Queues 12.3.0 Changelog

Bugs Fixed

  • Fixed a bug, introduced in the previous beta release, that caused Authentication errors when attempting to use an Account SAS with certain service level operations.

Features Added

  • Stable release of features from 12.3.0b1.

Resource Management - Chaos 1.0.0b3 Changelog

Resource Management - App 1.0.0b2 Changelog

Resource Management - Bot Service 2.0.0b2 Changelog

Resource Management - Container Instances 9.2.0 Changelog

Resource Management - Container Service 19.0.0 Changelog

Resource Management - Container Service 19.1.0 Changelog

Resource Management - Cosmos DB 7.0.0b4 Changelog

Resource Management - Cosmos DB 7.0.0b5 Changelog

Resource Management - Dashboard 1.0.0b1 Changelog

  • Initial Release

Resource Management - Dashboard 1.0.0b2 Changelog

Features

  • Add a default value to base_url in DashboardManagementClient

Resource Management - Data Factory 2.4.0 Changelog

Resource Management - Data Factory 2.5.0 Changelog

Resource Management - Network 20.0.0 Changelog

Resource Management - Red Hat OpenShift 1.1.0 Changelog

Resource Management - Reservations 2.0.0 Changelog

Resource Management - Resources 21.1.0b1 Changelog

Resource Management - Resources 21.1.0 Changelog

Resource Management - Service Linker 1.0.0 Changelog

Resource Management - Synapse 2.1.0b5 Changelog

Resource Management - Video Analyzer 1.0.0b4 Changelog

Schema Registry 1.1.0 Changelog

Features Added

  • group_name and name have been added as instance variables to SchemaProperties.

Service Bus 7.6.1 Changelog

Other Changes

  • Improved receiving by releasing messages from internal buffer when the prefetch_count of ServiceBusReceiver is set 0 and there is no active receive call, this helps avoid receiving expired messages and incrementing delivery count of a message.

Synapse - Artifacts 0.13.0 Changelog

Features

  • Added operation group LinkConnectionOperations

Tables 12.4.0 Changelog

Features Added

  • Support for multitenant authentication (#24278)

Bugs Fixed

  • Fixed bug where odmtype tag was not being included for boolean and int32 types even when a full EdmProperty tuple was passed in. This is needed for CLI compatibility.

Video Analyzer Edge 1.0.0b4 Changelog

Other Changes

Deprecated. We’re retiring the Azure Video Analyzer preview service, you’re advised to transition your applications off of Video Analyzer by 01 December 2022. This SDK is not longer maintained.

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-language-conversations==1.0.0b3
$> pip install azure-communication-phonenumbers==1.1.0b2
$> pip install azure-containerregistry==1.1.0b1
$> pip install azure-core==1.24.0
$> pip install azure-data-tables==12.4.0
$> pip install azure-eventhub==5.9.0b3
$> pip install azure-eventhub==5.9.0
$> pip install azure-identity==1.10.0
$> pip install azure-keyvault-keys==4.5.1
$> pip install azure-media-videoanalyzer-edge==1.0.0b4
$> pip install azure-mgmt-app==1.0.0b2
$> pip install azure-mgmt-botservice==2.0.0b2
$> pip install azure-mgmt-chaos==1.0.0b3
$> pip install azure-mgmt-containerinstance==9.2.0
$> pip install azure-mgmt-containerservice==19.0.0
$> pip install azure-mgmt-containerservice==19.1.0
$> pip install azure-mgmt-cosmosdb==7.0.0b4
$> pip install azure-mgmt-cosmosdb==7.0.0b5
$> pip install azure-mgmt-dashboard==1.0.0b1
$> pip install azure-mgmt-dashboard==1.0.0b2
$> pip install azure-mgmt-datafactory==2.4.0
$> pip install azure-mgmt-datafactory==2.5.0
$> pip install azure-mgmt-network==20.0.0
$> pip install azure-mgmt-redhatopenshift==1.1.0
$> pip install azure-mgmt-reservations==2.0.0
$> pip install azure-mgmt-resource==21.1.0b1
$> pip install azure-mgmt-resource==21.1.0
$> pip install azure-mgmt-servicelinker==1.0.0
$> pip install azure-mgmt-synapse==2.1.0b5
$> pip install azure-mgmt-videoanalyzer==1.0.0b4
$> pip install azure-monitor-query==1.0.2
$> pip install azure-schemaregistry==1.1.0
$> pip install azure-schemaregistry-avroencoder==1.0.0
$> pip install azure-search-documents==11.2.2
$> pip install azure-servicebus==7.6.1
$> pip install azure-storage-blob==12.12.0b1
$> pip install azure-storage-blob==12.12.0
$> pip install azure-storage-file-datalake==12.7.0b1
$> pip install azure-storage-file-datalake==12.7.0
$> pip install azure-storage-file-share==12.8.0b1
$> pip install azure-storage-file-share==12.8.0
$> pip install azure-storage-queue==12.3.0b1
$> pip install azure-storage-queue==12.3.0
$> pip install azure-synapse-artifacts==0.13.0

Feedback

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