Azure SDK for Python (June 2021)
The Azure SDK team is pleased to announce our June 2021 client library releases.
25 packages released this month.
Stable Packages (13)
-
Cognitive Search
-
Core
-
Event Grid
-
Resource Management - Cognitive Services
-
Resource Management - Cost Management
-
Resource Management - HDInsight
-
Resource Management - Media Services
-
Resource Management - Rdbms
-
Resource Management - Service Fabric
-
Service Bus
-
Storage - Files Data Lake
-
Storage - Files Shares
-
Tables
Patch Updates (4)
-
Communication Identity
-
Communication Phone Numbers
-
Communication Sms
-
Form Recognizer
Beta Packages (8)
-
App Configuration
-
Attestation
-
Container Registry
-
Document Translation
-
Identity
-
Metrics Advisor
-
Monitor Query
-
Resource Management - Resource Mover
Release highlights
App Configuration 1.2.0b2 Changelog
Features
- Adds context manager functionality to the sync and async
AzureAppConfigurationClient
s.
Fixes
- Fixes a deserialization bug for
FeatureFlagConfigurationSetting
andSecretReferenceConfigurationSetting
.
Attestation 1.0.0b4 Changelog
Features Added
- Added reset_policy API which was missed in the previous API.
- Added models for all the generated API types.
- Documentation cleanup for several APIs.
Breaking Changes
- Creating the
StoredAttestationPolicy
model type means that theattestation_policy
kwargs parameter for the constructor has been replaced with a positionalpolicy
parameter. As a result of this change, this code:
StoredAttestationPolicy(attestation_policy=str(attestation_policy).encode('utf-8')))
changes to:
StoredAttestationPolicy(attestation_policy)
- Several parameters for the
AttestationResult
type have been renamed, and several parameters which were shared withAttestationToken
have been removed. In general, the naming changes removed some protocol specific elements and replaced them with friendlier names. Finally, the deprecated attributes have been removed from theAttestationResult
Full set of changes:
iss
renamed toissuer
cnf
renamed toconfirmation
jti
renamed tounique_identifier
iat
removedexp
removednbf
removeddeprecated_version
removeddeprecated_is_debuggable
removeddeprecated_sgx_collateral
removeddeprecated_enclave_held_data
removeddeprecated_enclave_held_data2
removeddeprecated_product_id
removeddeprecated_mr_enclave
removeddeprecated_mr_signer
removeddeprecated_svn
removeddeprecated_tee
removeddeprecated_policy_signer
removeddeprecated_policy_hash
removeddeprecated_rp_data
removed
If customers need to access the removed or renamed fields directly, they can
use the get_body
method of the AttestationResponse
object:
if response.token.get_body().deprecated_tee != 'sgx':
print("Unexpected tee claim in token")
Cognitive Search 11.2.0 Changelog
This version will be the last version to officially support Python 3.5, future versions will require Python 2.7 or Python 3.6+.
New features
- Added support for knowledge store #18461
- Added new data source type ADLS gen2 #16852
Communication Identity 1.0.1 Changelog
Bug Fixes
- Fixed async client to use async bearer token credential policy instead of sync policy.
Communication Phone Numbers 1.0.1 Changelog
Bug Fixes
- Fixed async client to use async bearer token credential policy instead of sync policy.
Communication Sms 1.0.1 Changelog
Bug Fixes
- Fixed async client to use async bearer token credential policy instead of sync policy.
Container Registry 1.0.0b3 Changelog
- Removes
DeleteRepositoryResult
.ContainerRegistryClient.delete_repository
now returnsNone
- Removed
writeable_properties
objects, placingcan_delete/read/write/list
properties on the immediateRepository/Tag/ArtifactManifestProperties
objects - Removed
ContainerRepository
andRegistryArtifact
classes. The methods for acting on a repository and a registry artifact are now contained in theContainerRegistryClient
object. - Parses refresh token expiration time from returned JWT.
- The
delete_repository
andget_repository
methods parameters have been renamed fromrepository_name
torepository
.
Core 1.15.0 Changelog
New Features
- Added
BearerTokenCredentialPolicy.on_challenge
and.authorize_request
to allow subclasses to optionally handle authentication challenges
Bug Fixes
- Retry policies don’t sleep after operations time out
- The
from_dict
methhod in theCloudEvent
can now convert a datetime string to datetime object when microsecond exceeds the python limitation
Document Translation 1.0.0b2 Changelog
This version of the SDK defaults to the latest supported service version, which currently is v1.0
Breaking changes
create_translation_job
was removed and replaced withbegin_translation
which follows a long-running operation (LRO) approach. The client method now returns aDocumentTranslationLROPoller
(orAsyncDocumentTranslationLROPoller
) to begin the long-running operation. A call to.result()
can be made on the poller object to wait until the translation is complete. See the README for more information about LROs.- Upon completion of the LRO,
begin_translation
now returns a pageable ofDocumentStatusResult
. All job-level metadata can still be found onpoller.details
. has_completed
has been removed fromJobStatusResult
andDocumentStatusResult
. Usepoller.done()
to check if the translation has completed.- Client method
wait_until_done
has been removed. Usepoller.result()
to wait for the LRO to complete. - Client method
list_submitted_jobs
has been renamed tolist_all_translation_statuses
. - Client method
get_job_status
has been renamed toget_translation_status
. - Client method
cancel_job
has been renamed tocancel_translation
. - Parameter
job_id
was renamed totranslation_id
forget_translation_status
,cancel_translation
,list_all_document_statuses
, andget_document_status
. JobStatusResult
has been renamed toTranslationStatusResult
.DocumentStatusResult
propertytranslate_to
has been renamed totranslated_to
New features
- Authentication using
azure-identity
credentials now supported. - see the Azure Identity documentation for more information.
- Added paging and filtering options to
list_all_document_statuses
andlist_submitted_jobs
. - The input to
begin_translation
now accepts either the parameterinputs
as aList[DocumentTranslationInput]
to perform multiple translations, or the parameterssource_url
,target_url
, andtarget_language_code
to perform a single translation of your documents.
Dependency updates
- Package requires azure-core version 1.14.0 or greater.
Event Grid 4.3.0 Changelog
New Features
- Added new event names related to blob inventory to the
SystemEventNames
enum.
Bug Fixes
- Replaced the
ServiceBusDeadletterMessagesAvailableWithNoListenerEventName
with the right value.
Form Recognizer 3.1.1 Changelog
Bug Fixes
- Handles invoices that do not have sub-line item fields detected.
Identity 1.7.0b1 Changelog
Beginning with this release, this library requires Python 2.7 or 3.6+.
Added
VisualStudioCodeCredential
gets its default tenant and authority configuration from VS Code user settings (#14808)
Metrics Advisor 1.0.0b4 Changelog
New Features
- Added
AzureLogAnalyticsDataFeedSource
andAzureEventHubsDataFeedSource
- Update method now returns the updated object
- Added DatasourceCredentials and DatasourceCredential operations
- Added authentication type support for data feed
Breaking Changes
- Delete methods now take positional only argument as id
update_subscription_key
andupdate_api_key
are merged into one methodupdate_key
-
Removed
DataFeedOptions
and moved all its properties to theDataFeed
model - Deprecated:
HttpRequestDataFeed
-
ElasticsearchDataFeed
- Renamed
AzureApplicationInsightsDataFeed
->AzureApplicationInsightsDataFeedSource
AzureBlobDataFeed
->AzureBlobDataFeedSource
AzureCosmosDBDataFeed
->AzureCosmosDbDataFeedSource
AzureDataExplorerDataFeed
->AzureDataExplorerDataFeedSource
AzureTableDataFeed
->AzureTableDataFeedSource
InfluxDBDataFeed
->InfluxDbDataFeedSource
MySqlDataFeed
->MySqlDataFeedSource
PostgreSqlDataFeed
->PostgreSqlDataFeedSource
SQLServerDataFeed
->SqlServerDataFeedSource
MongoDBDataFeed
->MongoDbDataFeedSource
AzureDataLakeStorageGen2DataFeed
->AzureDataLakeStorageGen2DataFeedSource
Dependency Updates
- Bump
msrest
requirement from0.6.12
to0.6.21
Monitor Query 1.0.0b1 Changelog
Features
- Version (1.0.0b1) is the first preview of our efforts to create a user-friendly and Pythonic client library for Azure Monitor Query. For more information about this, and preview releases of other Azure SDK libraries, please visit https://azure.github.io/azure-sdk/releases/latest/python.html.
- Added
~azure.monitor.query.LogsQueryClient
to query log analytics along with~azure.monitor.query.aio.LogsQueryClient
. - Implements the
~azure.monitor.query.MetricsQueryClient
for querying metrics, listing namespaces and metric definitions along with~azure.monitor.query.aio.MetricsQueryClient
.
Resource Management - Cognitive Services 12.0.0 Changelog
Features
- Model UserOwnedStorage has a new parameter identity_client_id
- Model Sku has a new parameter family
- Model Sku has a new parameter capacity
- Model Sku has a new parameter size
- Model PrivateEndpointConnection has a new parameter location
- Model PrivateEndpointConnection has a new parameter system_data
- Model PrivateEndpointConnection has a new parameter etag
- Model PrivateEndpointConnectionProperties has a new parameter provisioning_state
- Model KeyVaultProperties has a new parameter identity_client_id
- Model PrivateLinkServiceConnectionState has a new parameter actions_required
- Added operation PrivateEndpointConnectionsOperations.begin_create_or_update
- Added operation PrivateEndpointConnectionsOperations.begin_delete
- Added operation AccountsOperations.list_usages
- Added operation AccountsOperations.begin_delete
- Added operation AccountsOperations.get
- Added operation AccountsOperations.begin_create
- Added operation AccountsOperations.begin_update
- Added operation group DeletedAccountsOperations
Breaking changes
- Model PrivateLinkServiceConnectionState no longer has parameter action_required
- Removed operation PrivateEndpointConnectionsOperations.create_or_update
- Removed operation PrivateEndpointConnectionsOperations.delete
- Removed operation AccountsOperations.delete
- Removed operation AccountsOperations.create
- Removed operation AccountsOperations.get_usages
- Removed operation AccountsOperations.update
- Removed operation AccountsOperations.get_properties
Resource Management - Cost Management 2.0.0 Changelog
Features
- Model QueryResult has a new parameter sku
- Model QueryResult has a new parameter e_tag
- Model QueryResult has a new parameter location
- Model View has a new parameter date_range
- Model View has a new parameter data_set
- Model View has a new parameter include_monetary_commitment
- Model View has a new parameter currency
- Model ExportExecution has a new parameter tags
- Added operation group GenerateReservationDetailsReportOperations
- Added operation group SettingsOperations
Breaking changes
- Parameter recurrence of model ExportSchedule is now required
- Operation ExportsOperations.list has a new signature
- Operation ExportsOperations.get has a new signature
- Model Export no longer has parameter run_history
- Model Export no longer has parameter next_run_time_estimate
- Model View no longer has parameter dataset
- Model ExportExecution no longer has parameter e_tag
- Model ExportExecution no longer has parameter error
- Model CommonExportProperties no longer has parameter run_history
- Model CommonExportProperties no longer has parameter next_run_time_estimate
- Model ExportProperties no longer has parameter run_history
- Model ExportProperties no longer has parameter next_run_time_estimate
- Model QueryFilter has a new signature
- Model ReportConfigFilter has a new signature
Resource Management - HDInsight 8.0.0 Changelog
Features
- Model Role has a new parameter encrypt_data_disks
- Model Role has a new parameter vm_group_name
- Model VmSizeCompatibilityFilter has a new parameter esp_applied
- Model VmSizeCompatibilityFilter has a new parameter os_type
- Model VmSizeCompatibilityFilter has a new parameter vm_sizes
- Model VmSizeCompatibilityFilter has a new parameter compute_isolation_supported
- Model ClusterGetProperties has a new parameter cluster_hdp_version
- Model ClusterGetProperties has a new parameter excluded_services_config
- Model ClusterGetProperties has a new parameter storage_profile
- Model Operation has a new parameter properties
- Model StorageAccount has a new parameter saskey
- Model StorageAccount has a new parameter fileshare
- Model CapabilitiesResult has a new parameter vmsizes
- Model CapabilitiesResult has a new parameter vmsize_filters
- Model ConnectivityEndpoint has a new parameter private_ip_address
- Model ApplicationGetEndpoint has a new parameter private_ip_address
- Model BillingResponseListResult has a new parameter vm_sizes_with_encryption_at_host
- Model BillingResponseListResult has a new parameter vm_size_properties
- Model OperationDisplay has a new parameter description
- Model ApplicationGetHttpsEndpoint has a new parameter private_ip_address
- Model ComponentsC51Ht8SchemasClusteridentityPropertiesUserassignedidentitiesAdditionalproperties has a new parameter tenant_id
- Model KafkaRestProperties has a new parameter configuration_override
- Added operation VirtualMachinesOperations.get_async_operation_status
- Added operation ApplicationsOperations.get_azure_async_operation_status
- Added operation LocationsOperations.get_azure_async_operation_status
- Added operation LocationsOperations.check_name_availability
- Added operation LocationsOperations.validate_cluster_create_request
- Added operation ExtensionsOperations.get_azure_async_operation_status
- Added operation ExtensionsOperations.get_azure_monitor_status
- Added operation ExtensionsOperations.begin_disable_azure_monitor
- Added operation ExtensionsOperations.begin_enable_azure_monitor
- Added operation ClustersOperations.get_azure_async_operation_status
- Added operation ClustersOperations.begin_update_identity_certificate
- Added operation ScriptActionsOperations.get_execution_async_operation_status
Breaking changes
- Model VmSizeCompatibilityFilter no longer has parameter vmsizes
- Model CapabilitiesResult no longer has parameter vm_size_filters
- Model CapabilitiesResult no longer has parameter vm_sizes
Resource Management - Media Services 7.0.0 Changelog
Features
- Model Asset has a new parameter system_data
- Model StreamingPolicy has a new parameter system_data
- Model Operation has a new parameter action_type
- Model Operation has a new parameter is_data_action
- Model JobInputAsset has a new parameter input_definitions
- Model AccountFilter has a new parameter system_data
- Model FaceDetectorPreset has a new parameter mode
- Model FaceDetectorPreset has a new parameter blur_type
- Model LiveEvent has a new parameter system_data
- Model MediaService has a new parameter key_delivery
- Model MediaService has a new parameter system_data
- Model Job has a new parameter system_data
- Model StreamingLocator has a new parameter system_data
- Model StreamingEndpoint has a new parameter system_data
- Model ContentKeyPolicy has a new parameter system_data
- Model JobInputClip has a new parameter input_definitions
- Model JobInputHttp has a new parameter input_definitions
- Model MetricSpecification has a new parameter lock_aggregation_type
- Model MetricSpecification has a new parameter supported_time_grain_types
- Model MetricSpecification has a new parameter source_mdm_namespace
- Model MetricSpecification has a new parameter source_mdm_account
- Model MetricSpecification has a new parameter enable_regional_mdm_account
- Model AssetFilter has a new parameter system_data
- Model Transform has a new parameter system_data
Breaking changes
- Removed operation MediaservicesOperations.get_by_subscription
Resource Management - Rdbms 8.1.0 Changelog
- New models and operations for mariadb
Resource Management - Resource Mover 1.1.0b2 Changelog
- Models rename
Resource Management - Service Fabric 1.0.0 Changelog
Features
- Model ManagedCluster has a new parameter addon_features
- Model ManagedClusterUpdateParameters has a new parameter addon_features
- Added operation group ManagedclusterOperations
- Added operation group ApplicationOperations
- Added operation group NodetypeOperations
Breaking changes
- Operation ApplicationTypesOperations.create_or_update has a new signature
- Operation NodeTypesOperations.begin_delete_node has a new signature
- Operation NodeTypesOperations.begin_reimage has a new signature
- Operation NodeTypesOperations.begin_restart has a new signature
- Operation NodeTypesOperations.begin_restart has a new signature
- Operation NodeTypesOperations.begin_reimage has a new signature
- Operation NodeTypesOperations.begin_delete_node has a new signature
- Operation ApplicationTypesOperations.create_or_update has a new signature
- Model ManagedCluster no longer has parameter cluster_upgrade_description
- Model ManagedCluster no longer has parameter cluster_upgrade_mode
- Model ManagedClusterUpdateParameters no longer has parameter cluster_upgrade_description
- Model ManagedClusterUpdateParameters no longer has parameter cluster_upgrade_mode
Service Bus 7.3.0 Changelog
New Features
- Support for sending AMQP annotated message which allows full access to the AMQP message fields is now GA.
- Introduced new namespace
azure.servicebus.amqp
. - Introduced new classes
azure.servicebus.amqp.AmqpMessageHeader
andazure.servicebus.amqp.AmqpMessageProperties
for accessing amqp header and properties.
Breaking Changes from 7.2.0b1
- Renamed and moved
azure.servicebus.AMQPAnnotatedMessage
toazure.servicebus.amqp.AmqpAnnotatedMessage
. - Renamed and moved
azure.servicebus.AMQPMessageBodyType
toazure.servicebus.amqp.AmqpMessageBodyType
. AmqpAnnotatedMessage.header
returnsazure.servicebus.amqp.AmqpMessageHeader
instead ofuamqp.message.MessageHeader
.AmqpAnnotatedMessage.properties
returnsazure.servicebus.amqp.AmqpMessageProperties
instead ofuamqp.message.MessageProperties
.raw_amqp_message
onServiceBusMessage
andServiceBusReceivedMessage
is now a read-only property instead of an instance variable.
Bug Fixes
- Fixed a bug that
ServiceBusReceiver
iterator stops iteration after recovery from connection error (#18795).
Storage - Files Data Lake 12.4.0 Changelog
New features
- Added support
set_service_properties()
,get_service_properties()
onDataLakeServiceClient
- Added support for
list_deleted_paths()
onFileSystemClient
Storage - Files Shares 12.5.0 Changelog
New features
- Added support for lease operation on a share, eg. acquire_lease
Tables 12.0.0 Changelog
Breaking
- EdmType.Binary data in entities will now be deserialized as
bytes
in Python 3 andstr
in Python 2, rather than anEdmProperty
instance. Likewise on serialization,bytes
in Python 3 andstr
in Python 2 will be interpreted as binary (this is unchanged for Python 3, but breaking for Python 2, wherestr
was previously serialized as EdmType.String) TableClient.create_table
now returns an instance ofTableItem
.- All optional parameters for model constructors are now keyword-only.
- Storage service configuration models have now been prefixed with
Table
, includingTableAccessPolicy
,TableMetrics
,TableRetentionPolicy
,TableCorsRule
- All parameters for
TableServiceClient.set_service_properties
are now keyword-only. - The
credential
parameter for all Clients is now keyword-only. - The method
TableClient.get_access_policy
will now returnNone
where previously it returned an “empty” access policy object. - Timestamp properties on
TableAccessPolicy
instances returned fromTableClient.get_access_policy
will now be deserialized todatetime
instances.
Fixes
- Fixed support for Cosmos emulator endpoint, via URL/credential or connection string.
- Fixed table name from URL parsing in
TableClient.from_table_url
classmethod. - The
account_name
attribute on clients will now be pulled from anAzureNamedKeyCredential
if used. - Any additional odata metadata is returned in entitys metadata.
- The timestamp in entity metadata is now deserialized to a timestamp.
- If the
prefer
header is added in thecreate_entity
operation, the echo will be returned. - Errors raised on a 412 if-not-match error will now be a specific
azure.core.exceptions.ResourceModifiedError
. EdmType.DOUBLE
values are now explicitly typed in the request payload.- Fixed de/serialization of list attributes on
TableCorsRule
.
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.1.1
$> pip install azure-ai-metricsadvisor==1.0.0b4
$> pip install azure-ai-translation-document==1.0.0b2
$> pip install azure-appconfiguration==1.2.0b2
$> pip install azure-communication-identity==1.0.1
$> pip install azure-communication-phonenumbers==1.0.1
$> pip install azure-communication-sms==1.0.1
$> pip install azure-containerregistry==1.0.0b3
$> pip install azure-core==1.15.0
$> pip install azure-data-tables==12.0.0
$> pip install azure-eventgrid==4.3.0
$> pip install azure-identity==1.7.0b1
$> pip install azure-mgmt-cognitiveservices==12.0.0
$> pip install azure-mgmt-costmanagement==2.0.0
$> pip install azure-mgmt-hdinsight==8.0.0
$> pip install azure-mgmt-media==7.0.0
$> pip install azure-mgmt-rdbms==8.1.0
$> pip install azure-mgmt-resourcemover==1.1.0b2
$> pip install azure-mgmt-servicefabric==1.0.0
$> pip install azure-monitor-query==1.0.0b1
$> pip install azure-search-documents==11.2.0
$> pip install azure-security-attestation==1.0.0b4
$> pip install azure-servicebus==7.3.0
$> pip install azure-storage-file-datalake==12.4.0
$> pip install azure-storage-file-share==12.5.0
Feedback
If you have a bug or feature request for one of the libraries, please post an issue to GitHub.