[Python] TypeSpec migration for azure-mgmt-cdn#46978
Draft
msyyc wants to merge 3 commits into
Draft
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
[Python] TypeSpec migration for azure-mgmt-cdn
This draft PR contains the regenerated
azure-mgmt-cdnSDK output from the TypeSpec migration of the CDN service, along with the breaking-change analysis used to design the mitigations.Spec source
2025-06-01(default tag:package-2025-06)2025-06-01(matched from swagger default tag)Spec mitigation PR
Azure/azure-rest-api-specs#43333
Summary of breaking-change classifications
CdnManagementClient@@clientName)PolicySettingsDefaultCustomBlockResponseStatusCodenumeric members →ENUM_*@@clientName)propertiesnesting)LogAnalyticsOperationsparameters changed to keyword-onlyMitigated breaking changes
After the spec mitigation PR is merged, the following changelog items will no longer appear:
Deleted or renamed client CdnManagementClientDeleted or renamed enum value PolicySettingsDefaultCustomBlockResponseStatusCode.TWO_HUNDREDDeleted or renamed enum value PolicySettingsDefaultCustomBlockResponseStatusCode.FOUR_HUNDRED_THREEDeleted or renamed enum value PolicySettingsDefaultCustomBlockResponseStatusCode.FOUR_HUNDRED_FIVEDeleted or renamed enum value PolicySettingsDefaultCustomBlockResponseStatusCode.FOUR_HUNDRED_SIXDeleted or renamed enum value PolicySettingsDefaultCustomBlockResponseStatusCode.FOUR_HUNDRED_TWENTY_NINEAccepted breaking changes (will remain)
Per the SDK breaking-changes guide for TypeSpec migration, these changes are intentional and follow the new model-hierarchy / API-design rules:
Multi-level flattening removal (guide §11)
Flattened properties on the following models now nest under
.properties:AFDDomain,AFDDomainUpdateParameters,AFDEndpoint,AFDEndpointUpdateParameters,AFDOrigin,AFDOriginUpdateParameters,AFDOriginGroup,AFDOriginGroupUpdateParameters,CanMigrateResult,CustomDomainParameters,Endpoint,EndpointUpdateParameters,Operation,Origin,OriginUpdateParameters,OriginGroup,OriginGroupUpdateParameters,ProfileUpdateParameters,Route,RouteUpdateParameters,Rule,RuleUpdateParameters,RuleSet,Secret,SecurityPolicy,SecurityPolicyUpdateParameters.Removed models (guide §7 / §8)
CdnWebApplicationFirewallPolicyList,ManagedRuleSetDefinitionList,EdgenodeResult.AzureFirstPartyManagedCertificate,Certificate,CustomerCertificate,ManagedCertificate,ValidationToken,DeliveryRuleActionEnum(replaced by enumDeliveryRuleActionName).Keyword-only parameters (guide §9)
All query/header parameters on
LogAnalyticsOperations.get_log_analytics_metrics,get_log_analytics_rankings,get_waf_log_analytics_metrics, andget_waf_log_analytics_rankingsare now keyword-only. Users should switch positional calls to keyword form.Notes
eb08171fand reflects the spec before the mitigation PR is merged. After the spec PR is merged, regenerate to apply the Python@@clientNameoverrides and the changelog should shrink accordingly.