Azure SDK for Python (April 2023)
The Azure SDK team is pleased to announce our April 2023 client library releases.
60 packages released this month.
Stable Packages (32)
-
Communication Email
-
Communication Phone Numbers
-
Event Grid
-
Key Vault - Administration
-
Key Vault - Certificates
-
Key Vault - Keys
-
Key Vault - Secrets
-
Machine Learning
-
Resource Management - App Configuration
-
Resource Management - Communication
-
Resource Management - Container Apps
-
Resource Management - Container Service
-
Resource Management - Core
-
Resource Management - Data Factory
-
Resource Management - Desktop Virtualization
-
Resource Management - Digital Twins
-
Resource Management - Event Hubs
-
Resource Management - Key Vault
-
Resource Management - Monitor
-
Resource Management - Network
-
Resource Management - Nginx
-
Resource Management - Orbital
-
Resource Management - Recovery Services Backup
-
Resource Management - Reservations
-
Resource Management - Resources
-
Resource Management - Security
-
Resource Management - SignalR
-
Resource Management - Web PubSub
-
Service Bus
-
Storage - Blobs
-
Storage - Files Data Lake
-
Storage - Files Share
Patch Updates (4)
-
Core - Client - Core
-
Event Hubs
-
Monitor Ingestion
-
Resource Management - Key Vault
Beta Packages (20)
-
Communication Identity
-
Container Registry
-
Core - Client - Experimental
-
Cosmos DB
-
Form Recognizer
-
Identity
-
OpenTelemetry Exporter
-
Purview Sharing
-
Resource Management - Communication
-
Resource Management - Compute
-
Resource Management - Cosmos DB
-
Resource Management - Defendereasm
-
Resource Management - Graphservices
-
Resource Management - Hybridcontainerservice
-
Resource Management - Newrelicobservability
-
Resource Management - SQL
-
Service Bus
-
Storage - Blobs
-
Storage - Files Data Lake
-
Storage - Files Share
Release highlights
Communication Email 1.0.0 Changelog
Features Added
The public release of the Azure Communication Services SDK for Email has the following features:
- send emails with a variety of options (multiple recipients, attachments, etc.)
- poll for the status of the email that was sent to track its progress
Communication Identity 1.4.0b1 Changelog
Features Added
- Added support for a new communication identifier
MicrosoftBotIdentifier
.
Communication Phone Numbers 1.1.0 Changelog
Features Added
- API version
2022-12-01
is now the default for Phone Numbers clients. - Added support for SIP routing API version
2023-03-01
, releasing SIP routing functionality from public preview to GA. - Added environment variable
AZURE_TEST_DOMAIN
for SIP routing tests to support domain verification.
Bugs Fixed
- Adds missing API version
2022-12-01
to the list of supported API versions.
Container Registry 1.1.0b2 Changelog
Bugs Fixed
- Fixed a
TypeError
when calllist_tag()
in an empty repository. (#28234) - Fixed a
TypeError
when calllist_manifest()
in an empty repository. (#28432)
Container Registry 1.1.0b3 Changelog
Breaking Changes
- Suppress the response error with status code
404
indelete_blob()
. - Added to return blob size in bytes in
upload_blob()
. - Changed
download_blob()
return type fromDownloadBlobResult
toDownloadBlobStream
andAsyncDownloadBlobStream
.
Features Added
- Supported uploading and downding large OCI artifact blobs in synchronous and asynchronous
ContainerRegistryClient
. - Published model
DownloadManifestResult
,DownloadBlobStream
andAsyncDownloadBlobStream
.
Core - Client - Core 1.26.4 Changelog
Features Added
- Updated settings to include OpenTelemetry as a tracer provider. #29095
Core - Client - Experimental 1.0.0b2 Changelog
Features Added
- httpx implementation of azure-core transport protocol
Cosmos DB 4.4.0b1 Changelog
Bugs Fixed
- Fixed bug in method
create_container_if_not_exists()
of async database client for unexpected kwargs being passed intoread()
method used internally. See PR 29136. - Fixed bug with method
query_items()
of our async container class, where partition key and cross partition headers would both be set when using partition keys. See PR 29366. - Fixed bug with client not properly surfacing errors for invalid credentials and identities with insufficient permissions. Users running into ‘NoneType has no attribute ConsistencyPolicy’ errors when initializing their clients will now see proper authentication exceptions. See PR 29256.
Features Added
- Added preview delete all items by partition key functionality. See PR 29186.
- Added preview partial document update (Patch API) functionality and container methods for patching items with operations. See PR 29497. For more information on Patch, please see Azure Cosmos DB Partial Document Update.
Event Grid 4.10.0 Changelog
Features Added
- Added new enum values to
SystemEventNames
related to Azure Communication Services, DataBox and ApiManagementGateway APIs.
Bugs Fixed
SystemEventNames
enums for APIManagement were incorrectly capitalized, changedApi
toAPI
.
Event Hubs 5.11.2 Changelog
Bugs Fixed
- Fixed a bug that would prevent reconnect after a long idle period, network drop (issue #28996)
Form Recognizer 3.3.0b1 Changelog
Features Added
- Added
features
keyword argument onbegin_analyze_document()
andbegin_analyze_document_from_url()
. - Added
query_fields
keyword argument onbegin_analyze_document()
andbegin_analyze_document_from_url()
. - Added
AnalysisFeature
enum with optional document analysis feature to enable. - Added
file_list
keyword argument onbegin_build_document_model()
. - Added the following optional properties on
DocumentStyle
class:similar_font_family
,font_style
,font_weight
,color
,background_color
. - Added support for custom document classification on
DocumentModelAdministrationClient
:begin_build_document_classifier
,list_document_classifiers
,get_document_classifier
, anddelete_document_classifier
. - Added support for classifying documents on
DocumentAnalysisClient
:begin_classify_document
andbegin_classify_document_from_url
. - Added
ClassifierDocumentTypeDetails
to use withbegin_build_document_classifier()
. - Added model
QuotaDetails
and propertycustom_neural_document_model_builds
onResourceDetails
. - Added kind
documentClassifierBuild
toOperationSummary
andOperationDetails
. - Added property
expires_on
toDocumentModelDetails
andDocumentModelSummary
. - Added kind
formulaBlock
toDocumentParagraph
. - Added property
common_name
toDocumentKeyValuePair
. - Added property
code
toCurrencyValue
. - Added properties
unit
,city_district
,state_district
,suburb
,house
, andlevel
toAddressValue
. - Added “boolean”
value_type
andbool
value
toDocumentField
. - Added properties
annotations
,images
,formulas
, andbarcodes
toDocumentPage
. - Added models
DocumentAnnotation
,DocumentImage
,DocumentFormula
, andDocumentBarcode
.
Identity 1.13.0b4 Changelog
Features Added
- Credentials that are implemented via launching a subprocess to acquire tokens now have configurable timeouts using the
process_timeout
keyword argument. This addresses scenarios where these proceses can take longer than the current default timeout values. The affected credentials areAzureCliCredential
,AzureDeveloperCliCredential
, andAzurePowerShellCredential
. (Note: ForDefaultAzureCredential
, thedeveloper_credential_timeout
keyword argument allows users to propagate this option toAzureCliCredential
,AzureDeveloperCliCredential
, andAzurePowerShellCredential
in the authentication chain.) (#28290)
Key Vault - Administration 4.3.0 Changelog
Features Added
- Added support for service API version
7.4
- Clients each have a
send_request
method that can be used to send custom requests using the client’s existing pipeline (#25172) - (From 4.3.0b1) Added sync and async
KeyVaultSettingsClient
s for getting and updating Managed HSM settings - The
KeyVaultSetting
class has agetboolean
method that will return the setting’svalue
as abool
, if possible, and raise aValueError
otherwise
Breaking Changes
These changes do not impact the API of stable versions such as 4.2.0. Only code written against a beta version such as 4.3.0b1 may be affected.
KeyVaultSettingsClient.update_setting
now accepts a singlesetting
argument (aKeyVaultSetting
instance) instead of aname
andvalue
- The
KeyVaultSetting
model’stype
parameter and attribute have been renamed tosetting_type
- The
SettingType
enum has been renamed toKeyVaultSettingType
Key Vault - Certificates 4.7.0 Changelog
Features Added
- Added support for service API version
7.4
- Clients each have a
send_request
method that can be used to send custom requests using the client’s existing pipeline (#25172)
Bugs Fixed
- The type hints for
KeyVaultCertificate.cer
andDeletedCertificate.cer
are nowOptional[bytearray]
instead ofOptional[bytes]
(#28959)
Key Vault - Keys 4.8.0 Changelog
Features Added
- Added support for service API version
7.4
- Clients each have a
send_request
method that can be used to send custom requests using the client’s existing pipeline (#25172) - (From 4.8.0b1) An attempt will be made to generate an IV if one isn’t provided for local encryption (#25380)
Breaking Changes
These changes do not impact the API of stable versions such as 4.7.0. Only code written against a beta version such as 4.8.0b2 may be affected.
- Removed support for octet key pair (OKP) keys and operations
Key Vault - Secrets 4.7.0 Changelog
Features Added
- Added support for service API version
7.4
- Clients each have a
send_request
method that can be used to send custom requests using the client’s existing pipeline (#25172)
Machine Learning 1.5.0 Changelog
Bugs Fixed
- Fix experiment name wrongly set to ‘Default’ when schedule existing job.
- Error message improvement when a local path fails to match with data asset type.
- Error message improvement when an asset does not exist in a registry
- Fix an issue when submit spark pipeline job with referring a registered component
- Fix an issue that prevented Job.download from downloading the output of a BatchJob
Features Added
- Added support for
tags
on Compute Resources. - Added support for promoting data asset from a workspace to a registry
- Added support for registering named asset from job output or node output by specifying name and version settings.
- Added support for data binding on outputs inside dynamic arguments for dsl pipeline
- Added support for serverless compute in pipeline, command, automl and sweep job
- Added support for
job_tier
andpriority
in standalone job - Added support for passing
locations
via command function and set it toJobResourceConfiguration.locations
- Added support for modifying SSH key values after creation on Compute Resources.
- Added WorkspaceConnection types
s3
,snowflake
,azure_sql_db
,azure_synapse_analytics
,azure_my_sql_db
,azure_postgres_db
- Added WorkspaceConnection auth type
access_key
fors3
- Added DataImport class and DataOperations.import_data.
- Added DataOperations.list_materialization_status - list status of data import jobs that create asset versions via asset name.
Monitor Ingestion 1.0.1 Changelog
Bugs Fixed
- Fixed an issue where log entry sizes were miscalculated when chunking. (#29584)
OpenTelemetry Exporter 1.0.0b13 Changelog
Features Added
- Enable AAD Credentials (#28888)
- Upgrading to OpenTelemetry SDK/API 1.17 (#29656)
- Updating sdkVersion prefix according to new spec. Using agents folder for marker. (#29730)
Purview Sharing 1.0.0b1 Changelog
New Features
- Initial release of the Purview Share client library for python
Resource Management - App Configuration 3.0.0 Changelog
Resource Management - Communication 2.0.0b3 Changelog
Resource Management - Communication 2.0.0 Changelog
Resource Management - Compute 29.2.0b2 Changelog
Resource Management - Container Apps 2.0.0 Changelog
Resource Management - Container Service 22.0.0 Changelog
Resource Management - Core 1.4.0 Changelog
Resource Management - Cosmos DB 9.1.0b1 Changelog
Resource Management - Data Factory 3.1.0 Changelog
Resource Management - Defendereasm 1.0.0b1 Changelog
Resource Management - Desktop Virtualization 1.0.0 Changelog
Resource Management - Digital Twins 6.4.0 Changelog
Resource Management - Event Hubs 11.0.0 Changelog
Resource Management - Graphservices 1.0.0b1 Changelog
Resource Management - Hybridcontainerservice 1.0.0b1 Changelog
Resource Management - Key Vault 10.2.0 Changelog
Resource Management - Key Vault 10.2.1 Changelog
Resource Management - Monitor 6.0.0 Changelog
Resource Management - Network 22.3.0 Changelog
Resource Management - Network 23.0.0 Changelog
Resource Management - Newrelicobservability 1.0.0b1 Changelog
Resource Management - Nginx 2.1.0 Changelog
Resource Management - Orbital 2.0.0 Changelog
Resource Management - Recovery Services Backup 5.2.0 Changelog
Resource Management - Reservations 2.3.0 Changelog
Resource Management - Resources 23.0.0 Changelog
Resource Management - SQL 4.0.0b9 Changelog
Resource Management - SQL 4.0.0b10 Changelog
Resource Management - Security 4.0.0 Changelog
Resource Management - SignalR 1.2.0 Changelog
Resource Management - Web PubSub 1.1.0 Changelog
Service Bus 7.9.0 Changelog
Bugs Fixed
- Fixed a bug where enum members in
azure.servicebus.management
were not following uppercase convention.
Breaking Changes
- Client side validation of input is now disabled by default for the sync and async
ServiceBusAdministrationClient
. This means there will be nomsrest.exceptions.ValidationError
raised by theServiceBusAdministrationClient
in the case of malformed input. Anazure.core.exceptions.HttpResponseError
may now be raised if the server refuses the request.
Service Bus 7.10.0b1 Changelog
Bugs Fixed
- Fixed a bug where sync and async
ServiceBusAdministrationClient
expectedcredential
withget_token
method returningAccessToken.token
of typebytes
and notstr
, now matching the documentation. - Fixed a bug where
raw_amqp_message.header
andmessage.header
properties onServiceReceivedBusMessage
were returned withdurable
,first_acquirer
, andpriority
properties set by default, rather than the values returned by the service.
Features Added
- A new boolean keyword argument
uamqp_transport
has been added to sync and asyncServiceBusClient
constructors which indicates whether to use theuamqp
library or the default pure Python AMQP library as the underlying transport.
Storage - Blobs 12.16.0b1 Changelog
Features Added
- Added support for service version 2022-11-02.
Storage - Blobs 12.16.0 Changelog
Features Added
- Stable release of features from 12.16.0b1
Storage - Files Data Lake 12.11.0b1 Changelog
Features Added
- Added support for service version 2022-11-02.
- Added support for
encryption_context
, a string value that can be passed when creating a file that will not be encrypted with the file. This value is returned ondownload_file
,get_file_properties
andget_paths
.
Storage - Files Data Lake 12.11.0 Changelog
Features Added
- Stable release of features from 12.11.0b1
Storage - Files Share 12.12.0b1 Changelog
Features Added
- Added support for service version 2022-11-02.
- Added support for
TokenCredential
to be used for authentication. ATokenCredential
can be provided for thecredential
parameter to any client constructor. Note: When using aTokenCredential
, the new keyword parametertoken_intnet
is required and must be provided. Additionally, this form of authentication is only supported for certain operations in the Data Plane SDK. - Added support for
allow_trailing_dot
andallow_source_trailing_dot
on client construction. Whenallow_trailing_dot
is provided, the service will not silently remove any trailing.
character from directory/file names for all operations made from that client.allow_source_trailing_dot
will apply this same rule to source files when performing a rename or copy operation.
Storage - Files Share 12.12.0 Changelog
Features Added
- Stable release of features from 12.12.0b1
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.3.0b1
$> pip install azure-ai-ml==1.5.0
$> pip install azure-communication-email==1.0.0
$> pip install azure-communication-identity==1.4.0b1
$> pip install azure-communication-phonenumbers==1.1.0
$> pip install azure-containerregistry==1.1.0b2
$> pip install azure-containerregistry==1.1.0b3
$> pip install azure-core==1.26.4
$> pip install azure-core-experimental==1.0.0b2
$> pip install azure-cosmos==4.4.0b1
$> pip install azure-eventgrid==4.10.0
$> pip install azure-eventhub==5.11.2
$> pip install azure-identity==1.13.0b4
$> pip install azure-keyvault-administration==4.3.0
$> pip install azure-keyvault-certificates==4.7.0
$> pip install azure-keyvault-keys==4.8.0
$> pip install azure-keyvault-secrets==4.7.0
$> pip install azure-mgmt-appconfiguration==3.0.0
$> pip install azure-mgmt-appcontainers==2.0.0
$> pip install azure-mgmt-communication==2.0.0b3
$> pip install azure-mgmt-communication==2.0.0
$> pip install azure-mgmt-compute==29.2.0b2
$> pip install azure-mgmt-containerservice==22.0.0
$> pip install azure-mgmt-core==1.4.0
$> pip install azure-mgmt-cosmosdb==9.1.0b1
$> pip install azure-mgmt-datafactory==3.1.0
$> pip install azure-mgmt-defendereasm==1.0.0b1
$> pip install azure-mgmt-desktopvirtualization==1.0.0
$> pip install azure-mgmt-digitaltwins==6.4.0
$> pip install azure-mgmt-eventhub==11.0.0
$> pip install azure-mgmt-graphservices==1.0.0b1
$> pip install azure-mgmt-hybridcontainerservice==1.0.0b1
$> pip install azure-mgmt-keyvault==10.2.0
$> pip install azure-mgmt-keyvault==10.2.1
$> pip install azure-mgmt-monitor==6.0.0
$> pip install azure-mgmt-network==22.3.0
$> pip install azure-mgmt-network==23.0.0
$> pip install azure-mgmt-newrelicobservability==1.0.0b1
$> pip install azure-mgmt-nginx==2.1.0
$> pip install azure-mgmt-orbital==2.0.0
$> pip install azure-mgmt-recoveryservicesbackup==5.2.0
$> pip install azure-mgmt-reservations==2.3.0
$> pip install azure-mgmt-resource==23.0.0
$> pip install azure-mgmt-security==4.0.0
$> pip install azure-mgmt-signalr==1.2.0
$> pip install azure-mgmt-sql==4.0.0b9
$> pip install azure-mgmt-sql==4.0.0b10
$> pip install azure-mgmt-webpubsub==1.1.0
$> pip install azure-monitor-ingestion==1.0.1
$> pip install azure-monitor-opentelemetry-exporter==1.0.0b13
$> pip install azure-purview-sharing==1.0.0b1
$> pip install azure-servicebus==7.9.0
$> pip install azure-servicebus==7.10.0b1
$> pip install azure-storage-blob==12.16.0b1
$> pip install azure-storage-blob==12.16.0
$> pip install azure-storage-file-datalake==12.11.0b1
$> pip install azure-storage-file-datalake==12.11.0
$> pip install azure-storage-file-share==12.12.0b1
$> pip install azure-storage-file-share==12.12.0
Feedback
If you have a bug or feature request for one of the libraries, please post an issue to GitHub.