Skip to content

[Python] TypeSpec migration for azure-mgmt-monitor#46407

Draft
ChenxiJiang333 wants to merge 3 commits intoAzure:mainfrom
ChenxiJiang333:sdk-azure-mgmt-monitor
Draft

[Python] TypeSpec migration for azure-mgmt-monitor#46407
ChenxiJiang333 wants to merge 3 commits intoAzure:mainfrom
ChenxiJiang333:sdk-azure-mgmt-monitor

Conversation

@ChenxiJiang333
Copy link
Copy Markdown
Member

[Python] TypeSpec migration for azure-mgmt-monitor

Spec source

Spec PR: Azure/azure-rest-api-specs#42199

Pre-migration swagger source

specification/monitor/resource-manager@0136b7fc

Swagger API version

Default tag package-preview-2023-09 contains multiple API versions: 2015-04-01 / 2016-03-01 / 2018-03-01 / 2018-11-27-preview / 2019-03-01 / 2020-10-01 / 2021-05-01-preview / 2021-07-01-preview / 2022-10-01 / 2023-03-11 / 2023-04-03 / 2023-05-01-preview / 2023-09-01-preview / 2023-12-01 / 2024-02-01

Breaking Change Analysis

All 15 breaking changes classified as ACCEPT — no mitigations needed.

The vast majority of breaking changes stem from a scope difference: the old swagger tag package-preview-2023-09 bundled many Microsoft.Insights APIs (action groups, tenant action groups, metrics, autoscale, etc.), while this TypeSpec (Microsoft.Monitor.Management) only covers AzureMonitorWorkspace and PipelineGroup resources.

Classification Summary

# Breaking Change Classification Reason
1 Deleted operation group tenant_action_groups ACCEPT Scope difference — not in TypeSpec
2 Inserted parameter subscription_id in __init__ ACCEPT Standard ARM client pattern
3 ErrorResponse lost code/message vars ACCEPT Common Types Upgrade
4 Deleted model ActionGroupPatchBody ACCEPT Scope difference — not in TypeSpec
5 Deleted model AzureAppPushReceiver ACCEPT Scope difference — not in TypeSpec
6 Deleted model AzureResource ACCEPT Unreferenced model removal
7 Deleted model EmailReceiver ACCEPT Scope difference — not in TypeSpec
8 Deleted model ReceiverStatus ACCEPT Scope difference — not in TypeSpec
9 Deleted model SmsReceiver ACCEPT Scope difference — not in TypeSpec
10 Deleted model TenantActionGroupList ACCEPT Pageable model removal
11 Deleted model TenantActionGroupResource ACCEPT Scope difference — not in TypeSpec
12 Deleted model VoiceReceiver ACCEPT Scope difference — not in TypeSpec
13 Deleted model WebhookReceiver ACCEPT Scope difference — not in TypeSpec
14 Deleted model TenantActionGroupsOperations ACCEPT Scope difference — not in TypeSpec

Accepted Breaking Changes (will remain)

All breaking changes are accepted:

  • Scope difference (10 items): The Microsoft.Insights APIs (tenant action groups, action group receivers, etc.) are not covered by the Microsoft.Monitor.Management TypeSpec. These APIs should be migrated separately under their own TypeSpec.
  • Common Types Upgrade (2 items): ErrorResponse now uses ARM common types v4 error structure.
  • Standard ARM pattern (1 item): subscription_id is a required parameter for ARM management clients.
  • Unreferenced model removal (1 item): AzureResource base class replaced by ARM common types.
  • Pageable model removal (1 item): TenantActionGroupList wrapper model removed per TypeSpec convention.

Spec mitigation PR

No mitigations needed — no spec PR created.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant