100 curated breaking changes across major versions of azure-core. Use this as a migration checklist before bumping dependencies.
Some breaking change
Some breaking change
Some breaking change
This version introduces new hybrid models which have dual dictionary and model nature. Please follow https://aka.ms/azsdk/python/migrate/hybrid-models for migration.
Model `CloudEndpointCreateParameters` moved instance variable `storage_account_resource_id`, `azure_file_share_name`, `storage_account_tenant_id` and `friendly_name` under property `properties` whose type is `CloudEndpointCreateParametersProperties`
Model `CloudEndpoint` moved instance variable `storage_account_resource_id`, `azure_file_share_name`, `storage_account_tenant_id`, `partnership_id`, `friendly_name`, `backup_enabled`, `provisioning_state`, `last_workflow_id`, `last_operation_name` and `change_enumeration_status` under property `properties` whose type is `CloudEndpointProperties`
Operation group `CloudEndpointsOperations` renamed method `restoreheartbeat` to `restore_heartbeat`
Renamed client `MicrosoftStorageSync` to `StorageSyncMgmtClient`
Deleted or renamed enum value `PrivateEndpointProvisioningState.DROPPING`
Deleted or renamed enum value `PrivateEndpointProvisioningState.APPROVING`
Deleted or renamed enum value `PrivateEndpointProvisioningState.REJECTING`
Deleted or renamed enum value `PrivateEndpointProvisioningState.READY`
This version introduces new hybrid models which have dual dictionary and model nature. Please follow https://aka.ms/azsdk/python/migrate/hybrid-models for migration.
Model `PrivateEndpointConnection` moved instance variable `private_endpoint`, `private_link_service_connection_state` and `provisioning_state` under property `properties` whose type is `PrivateEndpointConnectionProperties`
Model `ArmDisasterRecovery` moved instance variable `provisioning_state`, `pending_replication_operations_count`, `partner_namespace`, `alternate_name` and `role` under property `properties` whose type is `ArmDisasterRecoveryProperties`
Model `MigrationConfigProperties` moved instance variable `provisioning_state`, `pending_replication_operations_count`, `target_namespace`, `post_migration_name` and `migration_state` under property `properties` whose type is `MigrationConfigPropertiesProperties`
Model `NetworkRuleSet` moved instance variable `trusted_service_access_enabled`, `default_action`, `virtual_network_rules`, `ip_rules` and `public_network_access` under property `properties` whose type is `NetworkRuleSetProperties`
Model `SerialConsoleStatus` moved instance variable `disabled` under property `properties` whose type is `SerialConsoleStatusProperties`
Model `EnableSerialConsoleResult` moved instance variable `disabled` under property `properties` whose type is `EnableSerialConsoleResultProperties`
Model `DisableSerialConsoleResult` moved instance variable `disabled` under property `properties` whose type is `DisableSerialConsoleResultProperties`
This version introduces new hybrid models which have dual dictionary and model nature. Please follow https://aka.ms/azsdk/python/migrate/hybrid-models for migration.
Renamed operation group `MicrosoftSerialConsoleClientOperationsMixin` to `_MicrosoftSerialConsoleClientOperationsMixin`
Model `MergeRequest` moved instance variable `sources` under property `properties` whose type is `MergeProperties`
Model `AppliedReservations` moved instance variable `reservation_order_ids` under property `properties` whose type is `AppliedReservationsProperties`
Renamed client `AzureReservationAPI` to `ReservationsMgmtClient`
For the method breakings, please refer to https://aka.ms/azsdk/python/migrate/operations for migration.
This version introduces new hybrid models which have dual dictionary and model nature. Please follow https://aka.ms/azsdk/python/migrate/hybrid-models for migration.
Model `HybridConnection` moved instance variable `created_at`, `updated_at`, `listener_count`, `requires_client_authorization` and `user_metadata` under property `properties` whose type is `HybridConnectionProperties`
This version introduces new hybrid models which have dual dictionary and model nature. Please follow https://aka.ms/azsdk/python/migrate/hybrid-models for migration.
Renamed client `RelayAPI` to `RelayAPIMgmtClient`
Model `AuthorizationRule` moved instance variable `rights` under property `properties` whose type is `AuthorizationRuleProperties`
Model `ErrorResponse` moved instance variable `code` and `message` under property `error` whose type is `ErrorDetail`
This version introduces new hybrid models which have dual dictionary and model nature. Please follow https://aka.ms/azsdk/python/migrate/hybrid-models for migration.
Model `PlatformWorkloadIdentityRoleSet` moved instance variable `open_shift_version` and `platform_workload_identity_roles` under property `properties` whose type is `PlatformWorkloadIdentityRoleSetProperties`
Model `OpenShiftVersion` moved instance variable `version` under property `properties` whose type is `OpenShiftVersionProperties`
Model `OpenShiftClusterUpdate` moved instance variable `apiserver_profile`, `cluster_profile`, `console_profile`, `ingress_profiles`, `master_profile`, `network_profile`, `platform_workload_identity_profile`, `provisioning_state`, `service_principal_profile`, `worker_profiles` and `worker_profiles_status` under property `properties` whose type is `OpenShiftClusterProperties`
Model `OpenShiftCluster` moved instance variable `apiserver_profile`, `cluster_profile`, `console_profile`, `ingress_profiles`, `master_profile`, `network_profile`, `platform_workload_identity_profile`, `provisioning_state`, `service_principal_profile`, `worker_profiles` and `worker_profiles_status` under property `properties` whose type is `OpenShiftClusterProperties`
Model `PrivateZone` moved instance variable `max_number_of_record_sets`, `number_of_record_sets`, `max_number_of_virtual_network_links`, `number_of_virtual_network_links`, `max_number_of_virtual_network_links_with_registration`, `number_of_virtual_network_links_with_registration`, `provisioning_state` and `internal_id` under property `properties` whose type is `PrivateZoneProperties`
This version introduces new hybrid models which have dual dictionary and model nature. Please follow https://aka.ms/azsdk/python/migrate/hybrid-models for migration.
For the method breakings, please refer to https://aka.ms/azsdk/python/migrate/operations for migration.
Model `RecordSet` moved instance variable `metadata`, `ttl`, `fqdn`, `is_auto_registered`, `a_records`, `aaaa_records`, `cname_record`, `mx_records`, `ptr_records`, `soa_record`, `srv_records` and `txt_records` under property `properties` whose type is `RecordSetProperties`
Model `VirtualNetworkLink` moved instance variable `virtual_network`, `registration_enabled`, `resolution_policy`, `virtual_network_link_state` and `provisioning_state` under property `properties` whose type is `VirtualNetworkLinkProperties`
Model `AutoScaleVCore` moved instance variable `capacity_limit`, `capacity_object_id` and `provisioning_state` under property `properties` whose type is `AutoScaleVCoreProperties`
Renamed enum `IdentityType` to `CreatedByType`
Renamed client `PowerBIDedicated` to `PowerBIDedicatedMgmtClient`
This version introduces new hybrid models which have dual dictionary and model nature. Please follow https://aka.ms/azsdk/python/migrate/hybrid-models for migration.
Model `AutoScaleVCoreUpdateParameters` moved instance variable `capacity_limit` under property `properties` whose type is `AutoScaleVCoreMutableProperties`
For the method breakings, please refer to https://aka.ms/azsdk/python/migrate/operations for migration.
Model `BareMetalMachine` moved instance variable `action_states`, `associated_resource_ids`, `bmc_connection_string`, `bmc_credentials`, `bmc_mac_address`, `boot_mac_address`, `ca_certificate`, `cluster_id`, `cordon_status`, `detailed_status`, `detailed_status_message`, `hardware_inventory`, `hardware_validation_status`, `hybrid_aks_clusters_associated_ids`, `kubernetes_node_name`, `kubernetes_version`, `machine_cluster_version`, `machine_details`, `machine_name`, `machine_roles`, `machine_sku_i
Model `AgentPoolPatchParameters` moved instance variable `administrator_configuration`, `count` and `upgrade_settings` under property `properties` whose type is `AgentPoolPatchProperties`
Model `AgentPool` moved instance variable `administrator_configuration`, `agent_options`, `attached_network_configuration`, `availability_zones`, `count`, `detailed_status`, `detailed_status_message`, `kubernetes_version`, `labels`, `mode`, `provisioning_state`, `taints`, `upgrade_settings` and `vm_sku_name` under property `properties` whose type is `AgentPoolProperties`
This version introduces new hybrid models which have dual dictionary and model nature. Please follow https://aka.ms/azsdk/python/migrate/hybrid-models for migration.
Operation group `ConnectedClusterOperations` renamed method `begin_create` to `begin_create_or_replace`
This version introduces new hybrid models which have dual dictionary and model nature. Please follow https://aka.ms/azsdk/python/migrate/hybrid-models for migration.
Model `ConnectedCluster` moved instance variable `agent_public_key_certificate`, `agent_version`, `connectivity_status`, `distribution`, `infrastructure`, `kubernetes_version`, `last_connectivity_time`, `managed_identity_certificate_expiration_time`, `offering`, `provisioning_state`, `total_core_count` and `total_node_count` under property `properties` whose type is `ConnectedClusterProperties`
Model `SystemData` renamed type of property `last_modified_by_type` from `LastModifiedByType` to `CreatedByType`
Operation group `ConnectedClusterOperations` renamed method `update` to `begin_update_async`
Deleted or renamed model `Identity`
Deleted or renamed model `ResourceIdentityType`
Deleted or renamed method `CloudHsmClusterBackupStatusOperations.begin_get`
Deleted or renamed method `CloudHsmClusterRestoreStatusOperations.begin_get`
Model `ApplicationGroup` moved instance variable `client_app_group_identifier`, `is_enabled` and `policies` under property `properties` whose type is `ApplicationGroupProperties`
This version introduces new hybrid models which have dual dictionary and model nature. Please follow https://aka.ms/azsdk/python/migrate/hybrid-models for migration.
Model `Cluster` moved instance variable `created_at`, `metric_id`, `provisioning_state`, `status`, `supports_scaling` and `updated_at` under property `properties` whose type is `ClusterProperties`
Model `AuthorizationRule` moved instance variable `rights` under property `properties` whose type is `AuthorizationRuleProperties`
Model `ArmDisasterRecovery` moved instance variable `alternate_name`, `partner_namespace`, `pending_replication_operations_count`, `provisioning_state` and `role` under property `properties` whose type is `ArmDisasterRecoveryProperties`
Renamed client `MicrosoftElastic` to `ElasticMgmtClient`
For the method breakings, please refer to https://aka.ms/azsdk/python/migrate/operations for migration.
Method `AssociateTrafficFilterOperations.begin_associate` changed its parameter `ruleset_id` from `positional_or_keyword` to `keyword_only`
Method `CreateAndAssociateIPFilterOperations.begin_create` changed its parameter `ips`/`name` from `positional_or_keyword` to `keyword_only`
Method `CreateAndAssociatePLFilterOperations.begin_create` changed its parameter `name`/`private_endpoint_guid`/`private_endpoint_name` from `positional_or_keyword` to `keyword_only`
For the method breakings, please refer to https://aka.ms/azsdk/python/migrate/operations for migration.
Method `CreationSupportedOperations.list` changed its parameter `datadog_organization_id` from `positional_or_keyword` to `keyword_only`
Method `CreationSupportedOperations.get` changed its parameter `datadog_organization_id` from `positional_or_keyword` to `keyword_only`
For the method breakings, please refer to https://aka.ms/azsdk/python/migrate/operations for migration.
This version introduces new hybrid models which have dual dictionary and model nature. Please follow https://aka.ms/azsdk/python/migrate/hybrid-models for migration.
Model `AutoUpgradeProfile` moved instance variable `auto_upgrade_profile_status`, `channel`, `disabled`, `node_image_selection`, `provisioning_state` and `update_strategy_id` under property `properties` whose type is `AutoUpgradeProfileProperties`
Model `Fleet` moved instance variable `hub_profile`, `provisioning_state` and `status` under property `properties` whose type is `FleetProperties`
Model `FleetMember` moved instance variable `cluster_resource_id`, `group`, `provisioning_state` and `status` under property `properties` whose type is `FleetMemberProperties`
This version introduces new hybrid models which have dual dictionary and model nature. Please follow https://aka.ms/azsdk/python/migrate/hybrid-models for migration.
Model `Budget` moved instance variable `amount`, `category`, `current_spend`, `filter`, `forecast_spend`, `notifications`, `time_grain` and `time_period` under property `properties` whose type is `BudgetProperties`
Model `Balance` moved instance variable `adjustment_details`, `adjustments`, `azure_marketplace_service_charges`, `beginning_balance`, `billing_frequency`, `charges_billed_separately`, `currency`, `ending_balance`, `new_purchases`, `new_purchases_details`, `price_hidden`, `service_overage`, `total_overage`, `total_usage` and `utilized` under property `properties` whose type is `BalanceProperties`
For the method breakings, please refer to https://aka.ms/azsdk/python/migrate/operations for migration.
Model `BudgetComparisonExpression` renamed its instance variable `values` to `values_property`
Model `ResourceProvisionPayload` renamed its instance variable `base_profile` to `virtual_machine_base_profile`
Deleted or renamed enum value `ActionType.START`
Deleted or renamed enum value `ActionType.HIBERNATE`
Deleted or renamed enum value `ActionType.DEALLOCATE`
Model `ResourceProvisionPayload` renamed its instance variable `resource_overrides` to `virtual_machine_overrides`
**Default API Version Update**: Changed the SDK default API version from `2026-06-01-preview` to the GA version `2026-07-15`. Pass `api_version="2026-06-01-preview"` explicitly to keep the previous default behavior.
**Workspace**: the investigations long-running operation status model, previously generated as `ResourceOperationStatusInvestigationInvestigationError`, has been renamed to `InvestigationOperationStatus`. The payload is unchanged; only the model name differs.
**Bookshelf**: the `KnowledgeBaseVersionsOperations` operation group is removed. Knowledge-base versioning has been folded into the unified `KnowledgeBasesOperations` group; callers using `client.knowledge_base_versions.<method>` must migrate to the equivalent method on `client.knowledge_bases`.
**Bookshelf**: the models `KnowledgeBaseOperationStatus` and `KnowledgeBaseVersion` are removed. Operation-status payloads are now typed as `KnowledgeBaseOperationResponse`, `KnowledgeBaseIndexingOperationResponse`, or `KnowledgeBaseSearchOperationResponse` depending on the operation; create/update returns the `KnowledgeBase` resource.
The preview API version `2026-02-01-preview` is no longer listed as a supported value for the `api_version` kwarg. Both `WorkspaceClient` and `BookshelfClient` now default to `2026-06-01`. Pinning to the removed preview value is not supported in the GA SDK.
Replaced generated model classes in `azure.ai.agentserver.responses.models` with dict-native `TypedDict` contracts. Model constructors such as `ItemMessage(...)` and `CreateResponse(...)` now produce plain dictionaries instead of generated model instances.
Removed a-prefixed async convenience generator methods from the sync `ResponseEventStream` and sync builder classes. Use `azure.ai.agentserver.responses.aio.ResponseEventStream` for async streaming convenience methods.
The resilient-task input persisted for a `store=true` background response now carries a single `user_id_key` (the durable per-user partition key) instead of the previous `user_isolation_key` / `chat_isolation_key` pair; conversation scoping continues to use `conversation_id`.
Replaced most generated enum classes with string literal type aliases. Use string values directly for protocol fields, for example `"completed"`, `"message"`, or `"function_call_output"`.
Removed runtime model-class behavior from response protocol models. Code should no longer rely on attribute access, `isinstance(..., ModelType)`, `.as_dict()`, or generated model base-class behavior.
Removed the unused public `AgentServerHost.sse_keepalive_stream` helper.
Get this data programmatically \u2014 free, no authentication.
curl https://depscope.dev/api/breaking/pypi/azure-core