Azure SDK for Python (August 2023)
The Azure SDK team is pleased to announce our August 2023 client library releases.
45 packages released this month.
Stable Packages (16)
-
Core - Client - Core
-
Cosmos DB
-
Form Recognizer
-
Identity
-
Machine Learning
-
Resource Management - Authorization
-
Resource Management - Batch
-
Resource Management - Cognitive Services
-
Resource Management - Compute
-
Resource Management - Container Service
-
Resource Management - Data Protection
-
Resource Management - Kusto
-
Resource Management - Managednetworkfabric
-
Resource Management - Mobile Network
-
Resource Management - NetApp Files
-
Resource Management - Network
Patch Updates (5)
-
Confidential Ledger
-
Core - Client - Core
-
Event Hubs
-
Resource Management - Cost Management
-
Resource Management - Key Vault
Beta Packages (22)
-
App Configuration
-
Cognitive Search
-
Communication Phone Numbers
-
Core - Client - Experimental
-
Cosmos DB
-
OpenTelemetry Exporter
-
Purview Sharing
-
Resource Management - Elastic SAN
-
Resource Management - HDInsight
-
Resource Management - Iotfirmwaredefense
-
Resource Management - Networkcloud
-
Resource Management - Quantum
-
Resource Management - SQL
-
Resource Management - Sphere
-
Resource Management - Storage Mover
-
Resource Management - Web PubSub
-
Schema Registry
-
Storage - Blobs
-
Storage - Files Data Lake
-
Storage - Files Share
-
Storage - Queues
-
Synapse - Artifacts
Release highlights
App Configuration 1.5.0b2 Changelog
Bugs Fixed
- Fixed a bug in deserializing and serializing Snapshot when
filters
property isNone
. - Fixed a bug when creating
FeatureFlagConfigurationSetting
from SDK but having an error in portal.(#31326)
Cognitive Search 11.4.0b8 Changelog
Breaking Changes
These changes do not impact the API of stable versions such as 11.3.0. Only code written against a beta version such as 11.4.0b6 may be affected.
- Instead of using
VectorSearchAlgorithmConfiguration
, now you need to use concrete types likeHnswVectorSearchAlgorithmConfiguration
.- Stopped supporting
vector
,top_k
andvector_fields
inSearchClient.search
method.
Features Added
- Exposed
HnswVectorSearchAlgorithmConfiguration
- Added multi-vector search support. Now instead of passing in
vector
,top_k
andvector_fields
, search method acceptsvectors
which is a list ofVector
object.
Communication Phone Numbers 1.2.0b1 Changelog
Features Added
- Number Lookup API public preview
- API version
2023-05-01-preview
is the default
Confidential Ledger 1.1.1 Changelog
Bugs Fixed
- Allow some
ResourceNotFoundError
occurrences inbegin_wait_for_commit
to account for unexpected loss of session stickiness. These errors may occur when the connected node changes and transactions have not been fully replicated.
Core - Client - Core 1.29.0 Changelog
Features Added
- A keyword argument
enable_cae
was added to theget_token
method of theTokenCredential
protocol. #31012 BearerTokenCredentialPolicy
andAsyncBearerTokenCredentialPolicy
now acceptenable_cae
keyword arguments in their constructors. This is used in determining if Continuous Access Evaluation (CAE) should be enabled for eachget_token
request. #31012
Core - Client - Core 1.29.1 Changelog
Bugs Fixed
- Not pass
enabled_cae
unless it is explicitly enabled.
Core - Client - Experimental 1.0.0b4 Changelog
Bugs Fixed
- Create new httpx client when used without “with” (#31362)
- Fix httpx sample with right API name
Cosmos DB 4.4.1b1 Changelog
Bugs Fixed
- Fixed bug with async patch_item method. See PR 30804.
Features Added
- Added ability to limit continuation token size when querying for items. See PR 30731
Cosmos DB 4.5.0 Changelog
Features Added
- Added support for continuation tokens for streamable cross partition queries. See PR 31189.
Bugs Fixed
- Fixed bug with async
create_database_if_not_exists
method not working when passingoffer_throughput
as an option. See PR 31478.
Event Hubs 5.11.4 Changelog
Bugs Fixed
- Fixed bug #31258 where async
BlobCheckpointStore
was reprocessing old events after an error.
Features Added
- A new float keyword argument
socket_timeout
has been added to the sync and asyncEventHubConsumerClient
andEventHubProducerClient
.
Form Recognizer 3.3.0 Changelog
Breaking Changes
Note: The following changes are only breaking from the previous beta. They are not breaking against previous stable versions.
- Going forward this library will default to service API version
2023-07-31
. - Removed
query_fields
keyword argument frombegin_analyze_document()
andbegin_analyze_document_from_url()
. - Removed
kind
property fromDocumentPage
. - Removed
images
property fromDocumentPage
. - Removed
DocumentImage
model. - Removed
annotations
property fromDocumentPage
. - Removed
DocumentAnnotation
model. - Removed
common_name
property fromDocumentKeyValuePair
. - Changed
AnalysisFeature
enum member names and values. Supported enum members are:OCR_HIGH_RESOLUTION
,LANGUAGES
,BARCODES
,FORMULAS
,KEY_VALUE_PAIRS
,STYLE_FONT
. - Renamed
custom_neural_document_model_builds
property toneural_document_model_quota
onResourceDetails
model. - Renamed
AzureBlobSource
model toBlobSource
. - Renamed
AzureBlobFileListSource
model toBlobFileListSource
. - Marked
neural_document_model_quota
as optional onResourceDetails
.
Identity 1.14.0 Changelog
Breaking Changes
- CP1 client capabilities for CAE is no longer always-on by default for user credentials. This capability will now be configured as-needed in each
get_token
request by each SDK. (#30777) - Suffixes are now appended to persistent cache names to indicate whether CAE or non-CAE tokens are stored in the cache. This is to prevent CAE and non-CAE tokens from being mixed/overwritten in the same cache. This could potentially cause issues if you are trying to share the same cache between applications that are using different versions of the Azure Identity library as each application would be reading from a different cache file.
- Since CAE is no longer always enabled for user-credentials, the
AZURE_IDENTITY_DISABLE_CP1
environment variable is no longer supported.
Features Added
- Continuous Access Evaluation (CAE) is now configurable per-request by setting the
enable_cae
keyword argument toTrue
inget_token
. This applies to user credentials and service principal credentials. (#30777)
Bugs Fixed
- Credential types correctly implement
azure-core
’sTokenCredential
protocol. (#25175)
Machine Learning 1.9.0 Changelog
Features Added
- Added support to enable gpu access (local_enable_gpu) for local deployment.
OpenTelemetry Exporter 1.0.0b15 Changelog
Features Added
- Upgrading to OpenTelemetry SDK/API 1.19. (#31170)
Purview Sharing 1.0.0b3 Changelog
Breaking Changes
- In _operations.py, under the list_attached definition, the
skip_token
parameter was removed list definitions in favor of placing it withinnextLink
.
Bugs Fixed
- Fixed Samples and Tests
Features Added
- Added the new share resources capability that allows listing resources associated with sent and received shares.
- Added missing test cases to test_sent_shares and test_received_shares
Resource Management - Elastic SAN 1.0.0b2 Changelog
Resource Management - Authorization 4.0.0 Changelog
Resource Management - Batch 17.1.0 Changelog
Resource Management - Cognitive Services 13.5.0 Changelog
Resource Management - Compute 30.1.0 Changelog
Resource Management - Container Service 25.0.0 Changelog
Resource Management - Cost Management 4.0.1 Changelog
Resource Management - Data Protection 1.2.0 Changelog
Resource Management - HDInsight 9.0.0b2 Changelog
Resource Management - Iotfirmwaredefense 1.0.0b1 Changelog
Resource Management - Key Vault 10.2.3 Changelog
Resource Management - Kusto 3.2.0 Changelog
Resource Management - Managednetworkfabric 1.0.0 Changelog
Resource Management - Mobile Network 3.0.0 Changelog
Resource Management - NetApp Files 10.1.0 Changelog
Resource Management - Network 24.0.0 Changelog
Resource Management - Networkcloud 1.0.0b2 Changelog
Resource Management - Quantum 1.0.0b4 Changelog
Resource Management - SQL 4.0.0b11 Changelog
Resource Management - Sphere 1.0.0b1 Changelog
Resource Management - Storage Mover 2.0.0b1 Changelog
Resource Management - Web PubSub 2.0.0b1 Changelog
Schema Registry 1.3.0b2 Changelog
Features Added
The following features are experimental and may be removed:
- Sync and async
JsonSchemaEncoder
have been added underazure.schemaregistry.encoder.jsonencoder
. InvalidContentError
andJsonSchemaDraftIdentifier
have been added underazure.schemaregistry.encoder.jsonencoder
for use with theJsonSchemaEncoder
.MessageType
,MessageContent
,SchemaContentValidate
,SchemaEncoder
have been added underazure.schemaregistry
as protocols to define/for use with theJsonSchemaEncoder
and future encoder implementations.
Storage - Blobs 12.18.0b1 Changelog
Features Added
- Added support for service versions 2023-05-03 and 2023-08-03.
- Added
version_id
as a client constructor parameter toBlobClient
. This change makesBlobClient
s version-aware, such that all APIs that acceptversion_id
will operate on the version ID provided during client construction by default. - Added optional keyword
version_id
toget_blob_client
APIs which, if provided, will result in a version-awareBlobClient
in which all APIs that acceptversion_id
will operate on the version ID provided to theget_blob_client
API call by default.
Storage - Files Data Lake 12.13.0b1 Changelog
Features Added
- Added support for service versions 2023-05-03 and 2023-08-03.
Storage - Files Share 12.14.0b1 Changelog
Features Added
- Added support for service versions 2023-05-03 and 2023-08-03.
Storage - Queues 12.7.0b1 Changelog
Other Changes
- Bumped
azure-core
minimum dependency to 1.28.0 andtyping-extensions
to 4.3.0.
Synapse - Artifacts 0.17.0 Changelog
Features Added
- Added operation group RunNotebookOperations
- Model Activity has a new parameter on_inactive_mark_as
- Model Activity has a new parameter state
- Model AmazonRdsForSqlServerLinkedService has a new parameter always_encrypted_settings
- Model AmazonRdsForSqlServerSource has a new parameter isolation_level
- Model AppendVariableActivity has a new parameter on_inactive_mark_as
- Model AppendVariableActivity has a new parameter state
- Model AzureBatchLinkedService has a new parameter credential
- Model AzureBlobFSLinkedService has a new parameter credential
- Model AzureBlobStorageLinkedService has a new parameter credential
- Model AzureDataExplorerCommandActivity has a new parameter on_inactive_mark_as
- Model AzureDataExplorerCommandActivity has a new parameter state
- Model AzureDataExplorerLinkedService has a new parameter credential
- Model AzureDataLakeStoreLinkedService has a new parameter credential
- Model AzureDatabricksDeltaLakeLinkedService has a new parameter credential
- Model AzureDatabricksLinkedService has a new parameter credential
- Model AzureFunctionActivity has a new parameter on_inactive_mark_as
- Model AzureFunctionActivity has a new parameter state
- Model AzureFunctionLinkedService has a new parameter authentication
- Model AzureFunctionLinkedService has a new parameter credential
- Model AzureFunctionLinkedService has a new parameter resource_id
- Model AzureKeyVaultLinkedService has a new parameter credential
- Model AzureMLBatchExecutionActivity has a new parameter on_inactive_mark_as
- Model AzureMLBatchExecutionActivity has a new parameter state
- Model AzureMLExecutePipelineActivity has a new parameter on_inactive_mark_as
- Model AzureMLExecutePipelineActivity has a new parameter state
- Model AzureMLLinkedService has a new parameter authentication
- Model AzureMLServiceLinkedService has a new parameter authentication
- Model AzureMLUpdateResourceActivity has a new parameter on_inactive_mark_as
- Model AzureMLUpdateResourceActivity has a new parameter state
- Model AzureSqlDWLinkedService has a new parameter credential
- Model AzureSqlDatabaseLinkedService has a new parameter always_encrypted_settings
- Model AzureSqlDatabaseLinkedService has a new parameter credential
- Model AzureSqlMILinkedService has a new parameter always_encrypted_settings
- Model AzureSqlMILinkedService has a new parameter credential
- Model AzureSqlSource has a new parameter isolation_level
- Model ControlActivity has a new parameter on_inactive_mark_as
- Model ControlActivity has a new parameter state
- Model CopyActivity has a new parameter on_inactive_mark_as
- Model CopyActivity has a new parameter state
- Model CosmosDbLinkedService has a new parameter credential
- Model CustomActivity has a new parameter on_inactive_mark_as
- Model CustomActivity has a new parameter state
- Model DataLakeAnalyticsUSQLActivity has a new parameter on_inactive_mark_as
- Model DataLakeAnalyticsUSQLActivity has a new parameter state
- Model DatabricksNotebookActivity has a new parameter on_inactive_mark_as
- Model DatabricksNotebookActivity has a new parameter state
- Model DatabricksSparkJarActivity has a new parameter on_inactive_mark_as
- Model DatabricksSparkJarActivity has a new parameter state
- Model DatabricksSparkPythonActivity has a new parameter on_inactive_mark_as
- Model DatabricksSparkPythonActivity has a new parameter state
- Model DeleteActivity has a new parameter on_inactive_mark_as
- Model DeleteActivity has a new parameter state
- Model DynamicsLinkedService has a new parameter credential
- Model ExecuteDataFlowActivity has a new parameter on_inactive_mark_as
- Model ExecuteDataFlowActivity has a new parameter state
- Model ExecutePipelineActivity has a new parameter on_inactive_mark_as
- Model ExecutePipelineActivity has a new parameter state
- Model ExecuteSSISPackageActivity has a new parameter on_inactive_mark_as
- Model ExecuteSSISPackageActivity has a new parameter state
- Model ExecutionActivity has a new parameter on_inactive_mark_as
- Model ExecutionActivity has a new parameter state
- Model FailActivity has a new parameter on_inactive_mark_as
- Model FailActivity has a new parameter state
- Model FilterActivity has a new parameter on_inactive_mark_as
- Model FilterActivity has a new parameter state
- Model ForEachActivity has a new parameter on_inactive_mark_as
- Model ForEachActivity has a new parameter state
- Model GetMetadataActivity has a new parameter on_inactive_mark_as
- Model GetMetadataActivity has a new parameter state
- Model HDInsightHiveActivity has a new parameter on_inactive_mark_as
- Model HDInsightHiveActivity has a new parameter state
- Model HDInsightMapReduceActivity has a new parameter on_inactive_mark_as
- Model HDInsightMapReduceActivity has a new parameter state
- Model HDInsightOnDemandLinkedService has a new parameter credential
- Model HDInsightPigActivity has a new parameter on_inactive_mark_as
- Model HDInsightPigActivity has a new parameter state
- Model HDInsightSparkActivity has a new parameter on_inactive_mark_as
- Model HDInsightSparkActivity has a new parameter state
- Model HDInsightStreamingActivity has a new parameter on_inactive_mark_as
- Model HDInsightStreamingActivity has a new parameter state
- Model IfConditionActivity has a new parameter on_inactive_mark_as
- Model IfConditionActivity has a new parameter state
- Model LinkConnectionTargetDatabaseTypeProperties has a new parameter action_on_existing_target_table
- Model LookupActivity has a new parameter on_inactive_mark_as
- Model LookupActivity has a new parameter state
- Model MongoDbAtlasLinkedService has a new parameter driver_version
- Model RestServiceLinkedService has a new parameter credential
- Model ScriptActivity has a new parameter on_inactive_mark_as
- Model ScriptActivity has a new parameter state
- Model SetVariableActivity has a new parameter on_inactive_mark_as
- Model SetVariableActivity has a new parameter policy
- Model SetVariableActivity has a new parameter state
- Model SqlDWSource has a new parameter isolation_level
- Model SqlMISource has a new parameter isolation_level
- Model SqlPoolStoredProcedureActivity has a new parameter on_inactive_mark_as
- Model SqlPoolStoredProcedureActivity has a new parameter state
- Model SqlServerLinkedService has a new parameter always_encrypted_settings
- Model SqlServerSource has a new parameter isolation_level
- Model SqlServerStoredProcedureActivity has a new parameter on_inactive_mark_as
- Model SqlServerStoredProcedureActivity has a new parameter state
- Model SwitchActivity has a new parameter on_inactive_mark_as
- Model SwitchActivity has a new parameter state
- Model SynapseNotebookActivity has a new parameter configuration_type
- Model SynapseNotebookActivity has a new parameter on_inactive_mark_as
- Model SynapseNotebookActivity has a new parameter spark_config
- Model SynapseNotebookActivity has a new parameter state
- Model SynapseNotebookActivity has a new parameter target_spark_configuration
- Model SynapseSparkJobDefinitionActivity has a new parameter on_inactive_mark_as
- Model SynapseSparkJobDefinitionActivity has a new parameter state
- Model UntilActivity has a new parameter on_inactive_mark_as
- Model UntilActivity has a new parameter state
- Model ValidationActivity has a new parameter on_inactive_mark_as
- Model ValidationActivity has a new parameter state
- Model WaitActivity has a new parameter on_inactive_mark_as
- Model WaitActivity has a new parameter state
- Model WebActivity has a new parameter on_inactive_mark_as
- Model WebActivity has a new parameter state
- Model WebActivityAuthentication has a new parameter credential
- Model WebActivityAuthentication has a new parameter user_tenant
- Model WebHookActivity has a new parameter on_inactive_mark_as
- Model WebHookActivity has a new parameter state
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.0
$> pip install azure-ai-ml==1.9.0
$> pip install azure-appconfiguration==1.5.0b2
$> pip install azure-communication-phonenumbers==1.2.0b1
$> pip install azure-confidentialledger==1.1.1
$> pip install azure-core==1.29.0
$> pip install azure-core==1.29.1
$> pip install azure-core-experimental==1.0.0b4
$> pip install azure-cosmos==4.4.1b1
$> pip install azure-cosmos==4.5.0
$> pip install azure-eventhub==5.11.4
$> pip install azure-identity==1.14.0
$> pip install azure-mgmt-authorization==4.0.0
$> pip install azure-mgmt-batch==17.1.0
$> pip install azure-mgmt-cognitiveservices==13.5.0
$> pip install azure-mgmt-compute==30.1.0
$> pip install azure-mgmt-containerservice==25.0.0
$> pip install azure-mgmt-costmanagement==4.0.1
$> pip install azure-mgmt-dataprotection==1.2.0
$> pip install azure-mgmt-elasticsan==1.0.0b2
$> pip install azure-mgmt-hdinsight==9.0.0b2
$> pip install azure-mgmt-iotfirmwaredefense==1.0.0b1
$> pip install azure-mgmt-keyvault==10.2.3
$> pip install azure-mgmt-kusto==3.2.0
$> pip install azure-mgmt-managednetworkfabric==1.0.0
$> pip install azure-mgmt-mobilenetwork==3.0.0
$> pip install azure-mgmt-netapp==10.1.0
$> pip install azure-mgmt-network==24.0.0
$> pip install azure-mgmt-networkcloud==1.0.0b2
$> pip install azure-mgmt-quantum==1.0.0b4
$> pip install azure-mgmt-sphere==1.0.0b1
$> pip install azure-mgmt-sql==4.0.0b11
$> pip install azure-mgmt-storagemover==2.0.0b1
$> pip install azure-mgmt-webpubsub==2.0.0b1
$> pip install azure-monitor-opentelemetry-exporter==1.0.0b15
$> pip install azure-purview-sharing==1.0.0b3
$> pip install azure-schemaregistry==1.3.0b2
$> pip install azure-search-documents==11.4.0b8
$> pip install azure-storage-blob==12.18.0b1
$> pip install azure-storage-file-datalake==12.13.0b1
$> pip install azure-storage-file-share==12.14.0b1
$> pip install azure-storage-queue==12.7.0b1
$> pip install azure-synapse-artifacts==0.17.0
Feedback
If you have a bug or feature request for one of the libraries, please post an issue to GitHub.