Azure SDK for Python (December 2023)
The Azure SDK team is pleased to announce our December 2023 client library releases.
37 packages released this month.
Stable Packages (19)
-
Cognitive Search
-
Communication Call Automation
-
Communication Chat
-
Communication Identity
-
Communication JobRouter
-
Machine Learning
-
Resource Management - App Service
-
Resource Management - Chaos
-
Resource Management - Confluent
-
Resource Management - Container Registry
-
Resource Management - Container Service
-
Resource Management - Data Factory
-
Resource Management - Hybrid Network
-
Resource Management - Managed Grafana
-
Resource Management - Mobile Network
-
Resource Management - Nginx
-
Resource Management - Quota
-
Resource Management - Service Networking
-
Storage - Queues
Patch Updates (4)
-
Azure Monitor OpenTelemetry
-
Event Hubs
-
Machine Learning
-
Service Bus
Beta Packages (12)
-
AI Generative
-
AI Resources
-
Document Intelligence
-
Monitor Query
-
OpenTelemetry Exporter
-
Resource Management - Event Grid
-
Resource Management - Hybrid Compute
-
Resource Management - Hybrid Container Service
-
Resource Management - Network Analytics
-
Resource Management - Palo Alto Networks - Next Generation Firewall
-
Resource Management - PostgreSQL
-
Resource Management - SQL
Release highlights
AI Generative 1.0.0b2 Changelog
Features Added
- Added new format to export data to in qa generator.
AI Resources 1.0.0b1 Changelog
Features Added
- First preview.
AI Resources 1.0.0b2 Changelog
Other Changes
- Dependency improvements.
Azure Monitor OpenTelemetry 1.1.1 Changelog
Features Added
- Add App Service Resource Detector to Auto-Instrumentation. (#33340)
- Default Resource Detector environment variable to enable configuration. (#33305) (#33373) (#33390)
Cognitive Search 11.4.0 Changelog
Features Added
- Added new models:
VectorSearchAlgorithmMetric
IndexProjectionMode
SearchIndexerIndexProjections
SearchIndexerIndexProjectionSelector
SearchIndexerIndexProjectionsParameters
BlobIndexerDataToExtract
BlobIndexerImageAction
BlobIndexerParsingMode
CharFilterName
CustomEntity
CustomEntityAlias
DataChangeDetectionPolicy
DataDeletionDetectionPolicy
DefaultCognitiveServicesAccount
HighWaterMarkChangeDetectionPolicy
HnswAlgorithmConfiguration
IndexerExecutionResult
IndexingParameters
IndexingParametersConfiguration
IndexingSchedule
LexicalAnalyzerName
LexicalTokenizerName
PIIDetectionSkill
PIIDetectionSkillMaskingMode
ScoringProfile
SemanticSearch
- Added
index_projections
support forSearchIndexerSkillset
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.0b11 may be affected.
- Renamed
AnswerResult
toQueryAnswerResult
andCaptionResult
toQueryCaptionResult
. - Renamed
SemanticErrorHandling
toSemanticErrorMode
. - Renamed
RawVectorQuery
toVectorizedQuery
. - Renamed
ExhaustiveKnnVectorSearchAlgorithmConfiguration
toExhaustiveKnnAlgorithmConfiguration
. - Renamed
PrioritizedFields
toSemanticPrioritizedFields
. - Renamed
query_caption_highlight
toquery_caption_highlight_enabled
. query_language
andquery_speller
are not available forSearch
method in this stable release.alias
operations are not available in this stable release.
Communication Call Automation 1.1.0 Changelog
Features Added
- Mid Call actions support overriding callback url.
- Cancel Add Participant Invitation.
- Support transfer a participant in a group call to another participant.
- Add Custom Context payload to Transfer and AddParticipant API.
Communication Chat 1.2.0 Changelog
Features Added
- Added the support to receive inline images from Microsoft Teams users in an interoperability Chat with new type
ChatAttachment
- Added support for proactive refreshing of tokens
CommunicationTokenCredential
exposes a new boolean keyword argumentproactive_refresh
that defaults toFalse
. If set toTrue
, the refreshing of the token will be scheduled in the background ensuring continuous authentication state.- Added disposal function
close
forCommunicationTokenCredential
. - Added
identifier_from_raw_id
and ensured thatCommunicationIdentifier.raw_id
is populated on creation. Together, these can be used to translate between aCommunicationIdentifier
and its underlying canonical raw ID representation. Developers can now use the raw ID as an encoded format for identifiers to store in their databases or as stable keys in general.
Bugs Fixed
- Fixed bug where invalid participants were not being correctly deserialized in the response of
create_chat_thread
.
Communication Identity 1.4.0 Changelog
Features Added
- Introduction of new scopes for token generation.
CHAT_JOIN
(Access to Chat APIs but without the authorization to create, delete or update chat threads)CHAT_JOIN_LIMITED
(A more limited version ofCHAT_JOIN
that doesn’t allow to add or remove participants)VOIP_JOIN
(Access to Calling APIs but without the authorization to start new calls)- Added a new API version
ApiVersion.V2023_10_01
that is now the default API version.
Communication JobRouter 1.0.0 Changelog
Breaking Changes
- All models now resides under
azure.communication.jobrouter.models
instead ofazure.communication.jobrouter
. JobRouterAdministrationClient
- Create and update methods have been removed for
DistributionPolicy
. Useupsert_distribution_policy
instead. - Create and update methods have been removed for
RouterQueue
. Useupsert_queue
instead. - Create and update methods have been removed for
ClassificationPolicy
. Useupsert_classification_policy
instead. - Create and update methods have been removed for
ExceptionPolicy
. Useupsert_exception_policy
instead. list_classification_policies
returns(Async)Iterable[ClassificationPolicy]
instead of(Async)Iterable[ClassificationPolicyItem]
list_distribution_policies
returns(Async)Iterable[DistributionPolicy]
instead of(Async)Iterable[DistributionPolicyItem]
list_exception_policies
returns(Async)Iterable[ExceptionPolicy]
instead of(Async)Iterable[ExceptionPolicyItem]
list_queues
returns(Async)Iterable[RouterQueue]
instead of(Async)Iterable[RouterQueueItem]
JobRouterClient
- Create and update methods have been removed for
RouterJob
. Useupsert_job
instead. - Create and update methods have been removed for
RouterWorker
. Useupsert_worker
instead. list_jobs
returns(Async)Iterable[RouterJob]
instead of(Async)Iterable[RouterJobItem]
list_workers
returns(Async)Iterable[RouterWorker]
instead of(Async)Iterable[RouterWorkerItem]
decline_job_offer
- keyword argumentretry_offer_at: Optional[datetime]
removed from method. Useoptions: Optional[Union[DeclineJobOfferOptions, JSON, IO]]
instead.close_job
- keyword arguments
close_at: Optional[datetime]
,disposition_code: Optional[str]
,note: Optional[str]
removed from method. Useoptions: Optional[Union[CloseJobOptions, JSON, IO]]
instead. assignment_id: str
added as positional argument.cancel_job
- keyword argumentsdisposition_code: Optional[str]
,note: Optional[str]
removed from method. Useoptions: Optional[Union[CancelJobOptions, JSON, IO]]
instead.complete_job
- keyword argument
note: Optional[str]
removed from method. Useoptions: Optional[Union[CompleteJobOptions, JSON, IO]]
instead. assignment_id: str
added as positional argument.unassign_job
- keyword argumentsuspend_matching: Optional[bool]
removed from method. Useoptions: Optional[Union[UnassignJobOptions, JSON, IO]]
instead.RouterJob
- Property
notes
- Changed fromDict[str, ~datetime.datetime]
toList[RouterJobNote]
ClassificationPolicy
- Rename property
queue_selectors
toqueue_selector_attachments
. - Rename property
worker_selectors
toworker_selector_attachments
. ExceptionPolicy
- Property
exception_rules
- Changed fromDictionary[str, ExceptionRule]
->List[ExceptionRule]
ExceptionRule
- Property
actions
- ChangedDict[str, ExceptionAction]
->List[ExceptionAction]
ScoringRuleOptions
- Rename property
allow_scoring_batch_of_workers
->is_batch_scoring_enabled
RouterWorker
- Property changed
queue_assignments: Dict[str, RouterQueueAssignment]
->queues: List[str]
- Rename
total_capacity
->capacity
- Property changed
channel_configurations: Dict[str, ChannelConfiguration]
->channels: List[RouterChannel]
CloseJobOptions
- Removed property
assignment_id
CompleteJobOptions
- Removed property
assignment_id
JobMatchingMode
- Property
kind
- Changed fromstr
toJobMatchingModeKind
- Affected derived classes:
QueueAndMatchMode
,ScheduleAndSuspendMode
,SuspendMode
RouterRule
- Property
kind
- Changed fromstr
toRouterRuleKind
- Affected derived classes:
DirectMapRouterRule
,ExpressionRouterRule
,FunctionRouterRule
,StaticRouterRule
,WebhookRouterRule
DistributionMode
- Property
kind
- Changed fromstr
toDistributionModeKind
- Affected derived classes:
RoundRobinMode
,LongestIdleMode
,BestWorkerMode
ExceptionTrigger
- Property
kind
- Changed fromstr
toExceptionTriggerKind
- Affected derived classes:
QueueLengthExceptionTrigger
,WaitTimeExceptionTrigger
ExceptionAction
- Property
kind
- Changed fromstr
toExceptionActionKind
- Affected derived classes:
CancelExceptionAction
,ManualReclassifyExceptionAction
,ReclassifyExceptionAction
QueueSelectorAttachment
- Property
kind
- Changed fromstr
toQueueSelectorAttachmentKind
- Affected derived classes:
ConditionalQueueSelectorAttachment
,PassThroughQueueSelectorAttachment
,RuleEngineQueueSelectorAttachment
,StaticQueueSelectorAttachment
,WeightedAllocationQueueSelectorAttachment
WorkerSelectorAttachment
- Property
kind
- Changed fromstr
toWorkerSelectorAttachmentKind
- Affected derived classes:
ConditionalWorkerSelectorAttachment
,PassThroughWorkerSelectorAttachment
,RuleEngineWorkerSelectorAttachment
,StaticWorkerSelectorAttachment
,WeightedAllocationWorkerSelectorAttachment
Renames
ChannelConfiguration
->RouterChannel
Oauth2ClientCredential
->OAuth2WebhookClientCredential
Deletions
ClassificationPolicyItem
DistributionPolicyItem
ExceptionPolicyItem
RouterQueueItem
RouterWorkerItem
RouterJobItem
RouterQueueAssignment
Features Added
JobRouterAdministrationClient
- Add
upsert_distribution_policy
. Supportsmatch_condition: Optional[MatchConditions]
which can specify HTTP options for conditional requests based onetag: Optional[str]
and/orif_unmodified_since: Optional[~datetime.datetime]
. - Add
upsert_queue
. Supportsmatch_condition: Optional[MatchConditions]
which can specify HTTP options for conditional requests based onetag: Optional[str]
and/orif_unmodified_since: Optional[~datetime.datetime]
. - Add
upsert_classification_policy
. Supportsmatch_condition: Optional[MatchConditions]
which can specify HTTP options for conditional requests based onetag: Optional[str]
and/orif_unmodified_since: Optional[~datetime.datetime]
. - Add
upsert_exception_policy
. Supportsmatch_condition: Optional[MatchConditions]
which can specify HTTP options for conditional requests based onetag: Optional[str]
and/orif_unmodified_since: Optional[~datetime.datetime]
. JobRouterClient
- Add
upsert_job
. Supportsmatch_condition: Optional[MatchConditions]
which can specify HTTP options for conditional requests based onetag: Optional[str]
and/orif_unmodified_since: Optional[~datetime.datetime]
. - Add
upsert_worker
. Supportsmatch_condition: Optional[MatchConditions]
which can specify HTTP options for conditional requests based onetag: Optional[str]
and/orif_unmodified_since: Optional[~datetime.datetime]
.
Document Intelligence 1.0.0b1 Changelog
- This is the first preview of the
azure-ai-documentIntelligence
package, targeting API version 2023-10-31-preview of the Document Intelligence service.
Event Hubs 5.11.5 Changelog
Bugs Fixed
- Fixed a pyAMQP error where events split across multiple TransferFrames were depleting the link credit by more than 1 credit per message. (#32767)
Machine Learning 1.12.0 Changelog
Features Added
- Workspace Connections had 3 child classes added for open AI, cog search, and cog service connections.
- Workspace Connections replaced metadata with tags, and surfaced api_version, api_type, and kind for certain connection types.
Bugs Fixed
- Workspace Hubs now properly create various endpoints, and surface a variable to select the resource they connect to via the ‘endpoint_resource_id’ kwarg.
Machine Learning 1.12.1 Changelog
Bugs Fixed
- Addressed null value issue with workspace connection kinds
- Re-Added workspace connection metadata legacy value to address holdover issues.
- Added support for developer-role users to create lean workspaces.
- Fix an issue with pipeline deployments
Monitor Query 1.3.0b2 Changelog
Other Changes
- Internal updates to generated code.
- Bumped minimum dependency on
azure-core
to>=1.28.0
.
OpenTelemetry Exporter 1.0.0b19 Changelog
Bugs Fixed
- Fix deserialization of
TelemetryItem
from local storage (#33163)
Resource Management - App Service 7.2.0 Changelog
Resource Management - Chaos 1.0.0 Changelog
Resource Management - Confluent 2.0.0 Changelog
Resource Management - Container Registry 10.3.0 Changelog
Resource Management - Container Service 28.0.0 Changelog
Resource Management - Data Factory 4.0.0 Changelog
Resource Management - Event Grid 10.3.0b3 Changelog
Resource Management - Hybrid Compute 9.0.0b1 Changelog
Resource Management - Hybrid Container Service 1.0.0b2 Changelog
Resource Management - Hybrid Network 2.0.0 Changelog
Resource Management - Managed Grafana 1.1.0 Changelog
Resource Management - Mobile Network 3.1.0 Changelog
Resource Management - Network Analytics 1.0.0b1 Changelog
Resource Management - Nginx 3.0.0 Changelog
Resource Management - Palo Alto Networks - Next Generation Firewall 2.0.0b1 Changelog
Resource Management - PostgreSQL 10.2.0b12 Changelog
Resource Management - Quota 1.1.0 Changelog
Resource Management - SQL 4.0.0b13 Changelog
Resource Management - Service Networking 1.0.0 Changelog
Service Bus 7.11.4 Changelog
Bugs Fixed
- Fixed a bug where a two character count session id was being incorrectly parsed by azure amqp.
Storage - Queues 12.9.0 Changelog
Other Changes
- Updated type hints across the entire package and enabled MyPy to run during CI. Some public types may have been adjusted if they were previously erroneous or incomplete.
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-documentintelligence==1.0.0b1
$> pip install azure-ai-generative==1.0.0b2
$> pip install azure-ai-ml==1.12.0
$> pip install azure-ai-ml==1.12.1
$> pip install azure-ai-resources==1.0.0b1
$> pip install azure-ai-resources==1.0.0b2
$> pip install azure-communication-callautomation==1.1.0
$> pip install azure-communication-chat==1.2.0
$> pip install azure-communication-identity==1.4.0
$> pip install azure-communication-jobrouter==1.0.0
$> pip install azure-eventhub==5.11.5
$> pip install azure-mgmt-chaos==1.0.0
$> pip install azure-mgmt-confluent==2.0.0
$> pip install azure-mgmt-containerregistry==10.3.0
$> pip install azure-mgmt-containerservice==28.0.0
$> pip install azure-mgmt-dashboard==1.1.0
$> pip install azure-mgmt-datafactory==4.0.0
$> pip install azure-mgmt-eventgrid==10.3.0b3
$> pip install azure-mgmt-hybridcompute==9.0.0b1
$> pip install azure-mgmt-hybridcontainerservice==1.0.0b2
$> pip install azure-mgmt-hybridnetwork==2.0.0
$> pip install azure-mgmt-mobilenetwork==3.1.0
$> pip install azure-mgmt-networkanalytics==1.0.0b1
$> pip install azure-mgmt-nginx==3.0.0
$> pip install azure-mgmt-paloaltonetworksngfw==2.0.0b1
$> pip install azure-mgmt-quota==1.1.0
$> pip install azure-mgmt-rdbms==10.2.0b12
$> pip install azure-mgmt-servicenetworking==1.0.0
$> pip install azure-mgmt-sql==4.0.0b13
$> pip install azure-mgmt-web==7.2.0
$> pip install azure-monitor-opentelemetry==1.1.1
$> pip install azure-monitor-opentelemetry-exporter==1.0.0b19
$> pip install azure-monitor-query==1.3.0b2
$> pip install azure-search-documents==11.4.0
$> pip install azure-servicebus==7.11.4
$> pip install azure-storage-queue==12.9.0
Feedback
If you have a bug or feature request for one of the libraries, please post an issue to GitHub.