Azure SDK for Python (June 2024)
The Azure SDK team is pleased to announce our June 2024 client library releases.
47 packages released this month.
Stable Packages (17)
-
App Configuration Provider
-
Azure Monitor OpenTelemetry
-
Cosmos DB
-
Dev Center
-
Event Grid
-
Event Hubs
-
Machine Learning
-
Monitor Query
-
Resource Management - Container Service Fleet
-
Resource Management - Cosmos DB
-
Resource Management - Data Factory
-
Resource Management - NetApp Files
-
Resource Management - Network
-
Resource Management - Security
-
Resource Management - Storage Cache
-
Text Translation
-
Web PubSub
Patch Updates (7)
-
Azure Monitor OpenTelemetry
-
Core - Client - Core
-
Event Hubs
-
Identity
-
Machine Learning
-
Monitor Ingestion
-
Resource Management - Content Delivery Network
Beta Packages (20)
-
AI Model Inference
-
Document Translation
-
Event Hubs
-
Face
-
Identity
-
OpenTelemetry Exporter
-
Resource Management - Devopsinfrastructure
-
Resource Management - Hybrid Compute
-
Resource Management - Informaticadatamanagement
-
Resource Management - Maintenance
-
Resource Management - Oracledatabase
-
Resource Management - PostgreSQL
-
Resource Management - SQL
-
Resource Management - Self Help
-
Service Bus
-
Storage - Blobs
-
Storage - Files Data Lake
-
Storage - Files Share
-
Storage - Queues
-
Synapse - Artifacts
Release highlights
AI Model Inference 1.0.0b1 Changelog
- Initial beta version
App Configuration Provider 1.2.0 Changelog
Bugs Fixed
- Fixes issue where loading configurations were slower due to returning a copy of the configurations.
Features Added
- Enable loading of feature flags with
feature_flag_enabled
- Select Feature Flags to load with
feature_flag_selectors
- Enable/Disable Feature Flag Refresh with
feature_flag_refresh_enabled
Azure Monitor OpenTelemetry 1.4.2 Changelog
Features Added
- Add diagnostics for sdk detection and backoff (#35610)
Azure Monitor OpenTelemetry 1.5.0 Changelog
Features Added
- Enable live metrics feature (#35566)
Azure Monitor OpenTelemetry 1.6.0 Changelog
Features Added
- Enable views configuration (#35932)
- Rework autoinstrumentation: Configure exporters and samplers directly (#35890)
Core - Client - Core 1.30.2 Changelog
Bugs Fixed
- Raise correct exception if transport is used while already closed #35559
Features Added
- Tracing:
DistributedTracingPolicy
will now set an attribute,http.request.resend_count
, on HTTP spans for resent requests to indicate the resend attempt number. #35069
Cosmos DB 4.7.0 Changelog
Bugs Fixed
- Fixed a bug where change feed query in Async client was not returning all pages due to case-sensitive response headers. See PR 35090.
- Fixed a bug when a retryable exception occurs in the first page of a query execution causing query to return 0 results. See PR 35090.
Features Added
- Adds vector embedding policy and vector indexing policy. See PR 34882.
- Adds support for vector search non-streaming order by queries. See PR 35468.
- Adds support for using the start time option for change feed query API. See PR 35090.
Dev Center 1.0.0 Changelog
Features Added
- Added classes for each Dev Center concept.
models
:- Catalog
- DevBox
- DevBoxAction
- DevBoxActionDelayResult
- DevBoxNextAction
- Environment
- EnvironmentDefinition
- EnvironmentDefinitionParameter
- EnvironmentType
- Error
- HardwareProfile
- ImageReference
- InnerError
- OperationDetails
- OSDisk
- Pool
- Project
- RemoteConnection
- Schedule
- StopOnDisconnectConfiguration
-
StorageProfile
enums
:- DevBoxActionDelayStatus
- DevBoxActionType
- DevBoxProvisioningState
- EnvironmentProvisioningState
- EnvironmentTypeStatus
- HibernateSupport
- LocalAdministratorStatus
- OperationStatus
- OSType
- ParameterType
- PoolHealthStatus
- PowerState
- ScheduledFrequency
- ScheduledType
- SkuName
-
StopOnDisconnectEnableStatus
- Updated each previous client method to return the correspondent model. E.g. The response type for
get_dev_box
was updated fromJSON
toDevBox
model.
Breaking Changes
- Removed
filter
andtop
as optional request parameters from all list operations - list_pools
- list_schedules
- list_dev_boxes
- list_all_dev_boxes
- list_all_dev_boxes_by_user
- list_projects
- list_environments
- list_all_environments
- list_environment_definitions
- list_environment_definitions_by_catalog
- list_environment_types
- list_catalogs
Document Translation 1.1.0b1 Changelog
Features Added
- Added SingleDocumentTranslationClient that is used to invoke
document_translate
API. document_translate
is the method added to submit a single/synchronous document translation request to the Document Translation service.DocumentTranslateContent
has been added to specify thedocument_translate
request content.
Breaking Changes
- Version
v1.0
is not supported. - The service has changed to date-based API versioning and v1.0 service behavior is supported through the new version: 2024-05-01.
Event Grid 4.20.0 Changelog
Features Added
- This is a GA of the
EventGridConsumerClient
, theEventGridConsumerClient
supports the following operations for Cloud Events in Event Grid Namespace:receive
,release
,acknowledge
,reject
andrenew_locks
. - The
EventGridPublisherClient
now supports the Event Grid Namespace tier. Initialize the client with the namespace endpoint, and thenamespace_topic
kwarg to send Cloud Events to an Event Grid Namespace topic.
Event Hubs 5.12.0 Changelog
Features Added
- Added support for non-tls connections (#34272)
Event Hubs 5.13.0b1 Changelog
Features Added
- Added support for georeplication and disaster recovery-enabled Event Hubs.
Event Hubs 5.12.1 Changelog
Bugs Fixed
- Fixed a bug where the correct URI was not being used for consumer authentication, causing issues when assigning roles at the consumer group level. (#35337)
Face 1.0.0b1 Changelog
Features Added
- Added support for Liveness detection.
- Asynchronous APIs are added under
azure.ai.vision.face.aio
namespace. - Authentication with Microsoft Entra ID is supported using
DefaultAzureCredential()
fromazure.identity
.
Breaking Changes
- This library only supports the API of the the operation groups below of Azure AI Face v1.1-preview.1:
- Face Detection Operations
- Face Recognition Operations: only
Find Similiar
,Group
andVerify Face To Face
. - Liveness Session Operations
- The namespace/package name for Azure AI Face has changed from
azure.cognitiveservices.vision.face
toazure.ai.vision.face
. - Two client design:
FaceClient
to perform core Face functions such as face detection, verification, finding similar faces and grouping faces.FaceSessionClient
to interact with sessions which is used for Liveness detection.- New function names that comply with Azure Python SDK Design Guidelines:
- For example, the method
person_group_person.create()
is changed tocreate_person_group_person()
. - The Snapshot operations are all removed as the Snapshot API is no longer supported.
Identity 1.17.0b1 Changelog
Features Added
- Added environment variable
AZURE_CLIENT_SEND_CERTIFICATE_CHAIN
support forEnvironmentCredential
. - Introduced a new credential,
AzurePipelinesCredential
, for supporting workload identity federation in Azure Pipelines with service connections (#35397).
Bugs Fixed
- Fixed typing errors when certain credentials are used as context managers. (#35415)
Identity 1.16.1 Changelog
Bugs Fixed
- Managed identity bug fixes
Identity 1.17.0b2 Changelog
Features Added
OnBehalfOfCredential
now supports client assertion callbacks through theclient_assertion_func
keyword argument. This enables authenticating with client assertions such as federated credentials. (#35812)
Bugs Fixed
- Managed identity bug fixes
Machine Learning 1.16.0 Changelog
Breaking Changes
- Removed WorkspaceHubConfig entity, and renamed WorkspaceHub to Hub.
- workspace_hub input of Workspace class hidden, renamed to hub_id, and re-surfaced in child class Project.
- Removed Workspace Hub Operations from ML Client.
Features Added
- Add experimental support for working with Promptflow evaluators:
ml_client.evaluators
. - Many changes to the Connection entity class and its associated operations.
- Workspace Connection
list
,get
, andcreate_or_update
operations now include an optionalpopulate_secrets
input, which causes the operations to try making a secondary call to fill in the returned connections’ credential info if possible. Only works with api key-based credentials for now. - Many workspace connection subtypes added. The full list of subclasses is now:
AzureBlobStoreConnection
AzureBlobStoreConnection
MicrosoftOneLakeConnection
AzureOpenAIConnection
AzureAIServicesConnection
AzureAISearchConnection
AzureContentSafetyConnection
AzureSpeechServicesConnection
APIKeyConnection
OpenAIConnection
SerpConnection
ServerlessConnection
- Many workspace connections only accept api keys or entra ids for credentials. Since Entra IDs require not inputs, these have been refactored to not required a full credential object. Instead they only accept an api_key as a top-level input, and default to an entra credential otherwise. Their YAML schemas have been similarly altered.
- Client-side credential-type validation added for some workspace connection types.
- Added new credential type:
AadCredentialConfiguration
- Renamed WorkspaceHub class as Hub.
- Added Project entity class and YAML support.
- Project and Hub operations supported by workspace operations.
- workspace list operation supports type filtering.
- Add support for Microsoft Entra token (
aad_token
) auth ininvoke
andget-credentials
operations. - Add experimental support for working with indexes:
ml_client.indexes
Machine Learning 1.16.1 Changelog
Bugs Fixed
- Fixed idle_time_before_shutdown_minutes not appearing in GET calls for Compute Instances.
- Add Dependency as a new rule category
- fixing workspace arm template
Monitor Ingestion 1.0.4 Changelog
Other Changes
- Bumped minimum dependency on
azure-core
to>=1.28.0
. - Added additional type validation for the
logs
parameter in theupload
method to ensure that a string hasn’t been passed in. (#33976)
Monitor Query 1.4.0 Changelog
Features Added
- An
audience
keyword argument can now be passed to theMetricsClient
constructor to specify the audience for the authentication token. This is useful when querying metrics in sovereign clouds. (#35502)
OpenTelemetry Exporter 1.0.0b26 Changelog
Bugs Fixed
- Handle invalid status codes in std metric payload (#35762)
- Disable distributed tracing for live metrics client calls (#35822)
Resource Management - Container Service Fleet 2.0.0 Changelog
Resource Management - Content Delivery Network 13.1.1 Changelog
Resource Management - Cosmos DB 9.5.0 Changelog
Resource Management - Data Factory 8.0.0 Changelog
Resource Management - Devopsinfrastructure 1.0.0b1 Changelog
Resource Management - Hybrid Compute 9.0.0b3 Changelog
Resource Management - Informaticadatamanagement 1.0.0b1 Changelog
Resource Management - Maintenance 2.2.0b2 Changelog
Resource Management - NetApp Files 13.0.0 Changelog
Resource Management - Network 25.4.0 Changelog
Resource Management - Oracledatabase 1.0.0b1 Changelog
Resource Management - PostgreSQL 10.2.0b17 Changelog
Resource Management - SQL 4.0.0b17 Changelog
Resource Management - Security 7.0.0 Changelog
Resource Management - Self Help 2.0.0b4 Changelog
Resource Management - Storage Cache 2.0.0 Changelog
Service Bus 7.13.0b1 Changelog
Features Added
-
ServiceBusReceiver
now supports the ability to delete all messages from an entity using thepurge_messages
method. Callers may optionally request to limit the target messages to those earlier than a given date. -
ServiceBusReceiver
now supports the ability to delete messages from an entity in batches using thedelete_messages
method. The messages selected for deletion will be the oldest in the entity, based on the enqueued date and callers may optionally request to limit them to only those earlier than a given date.
Storage - Blobs 12.21.0b1 Changelog
Features Added
- Added support for service version 2024-08-04.
Storage - Files Data Lake 12.16.0b1 Changelog
Features Added
- Updated OAuth implementation to use the AAD scope returned in a Bearer challenge.
Storage - Files Share 12.17.0b1 Changelog
Features Added
- Added
enable_snapshot_virtual_directory_access
parameter support for NFS shares on premium-tier Storage accounts. - Added a more descriptive authorization error message when facing authorization errors.
Storage - Queues 12.11.0b1 Changelog
Features Added
- Updated OAuth implementation to use the AAD scope returned in a Bearer challenge.
- Fixed an issue where client specified service versions may be ignored.
Synapse - Artifacts 0.19.0 Changelog
Features Added
- Model Dataset has a new parameter LakeHouseLocation
- Model Dataset has a new parameter GoogleBigQueryV2ObjectDataset
- Model Dataset has a new parameter PostgreSqlV2TableDataset
- Model Dataset has a new parameter SalesforceServiceCloudV2ObjectDataset
- Model Dataset has a new parameter SalesforceV2ObjectDataset
- Model Dataset has a new parameter ServiceNowV2ObjectDataset
- Model Dataset has a new parameter SnowflakeV2Dataset
- Model Dataset has a new parameter WarehouseTableDataset
- Model Pipeline has a new parameter ExpressionV2
- Model Pipeline has a new parameter GoogleBigQueryV2Source
- Model Pipeline has a new parameter LakeHouseTableSink
- Model Pipeline has a new parameter LakeHouseTableSource
- Model Pipeline has a new parameter LakeHouseWriteSettings
- Model Pipeline has a new parameter LakeHouseReadSettings
- Model Pipeline has a new parameter Metadata
- Model Pipeline has a new parameter MetadataItem
- Model Pipeline has a new parameter ParquetReadSettingsstate
- Model Pipeline has a new parameter PostgreSqlV2Source
- Model Pipeline has a new parameter SalesforceServiceCloudV2Sink
- Model Pipeline has a new parameter SalesforceServiceCloudV2Source
- Model Pipeline has a new parameter SalesforceV2Sink
- Model Pipeline has a new parameter SalesforceV2SourceReadBehavior
- Model Pipeline has a new parameter SalesforceV2Source
- Model Pipeline has a new parameter ServiceNowV2Source
- Model Pipeline has a new parameter SnowflakeV2Sink
- Model Pipeline has a new parameter SnowflakeV2Source
- Model Pipeline has a new parameter WarehouseSink
- Model Pipeline has a new parameter WarehouseSource
- Model LinkedService add supports GoogleAds
- Model LinkedService has a new parameter GoogleBigQueryV2LinkedService
- Model LinkedService has a new parameter LakeHouseLinkedService
- Model LinkedService has a new parameter PostgreSqlV2LinkedService
- Model LinkedService has a new parameter SalesforceServiceCloudV2LinkedService
- Model LinkedService has a new parameter SalesforceV2LinkedService
- Model LinkedService has a new parameter SalesforceV2LinkedService
- Model LinkedService has a new parameter SnowflakeV2LinkedService
- Model LinkedService has a new parameter WarehouseLinkedService
- Model LinkedService has a new parameter WarehouseLinkedService
Breaking Changes
- Model LinkedService parameter MariaDBLinkedService update new properties
- Model LinkedService parameter MySqlLinkedService update new properties
- Model LinkedService parameter ServiceNowV2LinkedService update properties
- Model Pipeline parameter ExecuteDataFlowActivity update new properties computeType
- Model Pipeline parameter ScriptActivityScriptBlock update properties type
Text Translation 1.0.0 Changelog
Features Added
- Added support for Entra Id authentication.
Breaking Changes
- All calls to the client using parameter
content
have been changed to use parameterbody
. - Users can call methods using just a string type instead of complex objects.
get_languages
methods were changed toget_supported_languages
.- renamed
from_parameter
tofrom_language
. - renamed
to
parameter toto_language
.
Web PubSub 1.1.0 Changelog
Bugs Fixed
- Use the correct REST API parameter name
groups
in methodget_client_access_token
- Upgrade dependency package
pyjwt
to>=2.0.0
which changes the return type ofjwt.encode(...)
. See https://pyjwt.readthedocs.io/en/stable/changelog.html#id30 for detail
Features Added
- Add overload signatures for operation
send_to_all
,send_to_user
,send_to_group
andsend_to_connection
- Update the type of parameter
content
fromIO
toUnion[IO, str, JSON]
for operationsend_to_all
,send_to_user
,send_to_group
andsend_to_connection
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-inference==1.0.0b1
$> pip install azure-ai-ml==1.16.0
$> pip install azure-ai-ml==1.16.1
$> pip install azure-ai-translation-document==1.1.0b1
$> pip install azure-ai-translation-text==1.0.0
$> pip install azure-ai-vision-face==1.0.0b1
$> pip install azure-appconfiguration-provider==1.2.0
$> pip install azure-core==1.30.2
$> pip install azure-cosmos==4.7.0
$> pip install azure-developer-devcenter==1.0.0
$> pip install azure-eventgrid==4.20.0
$> pip install azure-eventhub==5.12.0
$> pip install azure-eventhub==5.13.0b1
$> pip install azure-eventhub==5.12.1
$> pip install azure-identity==1.17.0b1
$> pip install azure-identity==1.16.1
$> pip install azure-identity==1.17.0b2
$> pip install azure-messaging-webpubsubservice==1.1.0
$> pip install azure-mgmt-cdn==13.1.1
$> pip install azure-mgmt-containerservicefleet==2.0.0
$> pip install azure-mgmt-cosmosdb==9.5.0
$> pip install azure-mgmt-datafactory==8.0.0
$> pip install azure-mgmt-devopsinfrastructure==1.0.0b1
$> pip install azure-mgmt-hybridcompute==9.0.0b3
$> pip install azure-mgmt-informaticadatamanagement==1.0.0b1
$> pip install azure-mgmt-maintenance==2.2.0b2
$> pip install azure-mgmt-netapp==13.0.0
$> pip install azure-mgmt-network==25.4.0
$> pip install azure-mgmt-oracledatabase==1.0.0b1
$> pip install azure-mgmt-rdbms==10.2.0b17
$> pip install azure-mgmt-security==7.0.0
$> pip install azure-mgmt-selfhelp==2.0.0b4
$> pip install azure-mgmt-sql==4.0.0b17
$> pip install azure-mgmt-storagecache==2.0.0
$> pip install azure-monitor-ingestion==1.0.4
$> pip install azure-monitor-opentelemetry==1.4.2
$> pip install azure-monitor-opentelemetry==1.5.0
$> pip install azure-monitor-opentelemetry==1.6.0
$> pip install azure-monitor-opentelemetry-exporter==1.0.0b26
$> pip install azure-monitor-query==1.4.0
$> pip install azure-servicebus==7.13.0b1
$> pip install azure-storage-blob==12.21.0b1
$> pip install azure-storage-file-datalake==12.16.0b1
$> pip install azure-storage-file-share==12.17.0b1
$> pip install azure-storage-queue==12.11.0b1
$> pip install azure-synapse-artifacts==0.19.0
Feedback
If you have a bug or feature request for one of the libraries, please post an issue to GitHub.