[Az.DnsResolver] Add breaking change announcements for 2025-10-01-preview API migration#29308
Conversation
Announce upcoming breaking changes for the 2025-10-01-preview API migration: - Removed ActionBlockResponseCode parameter from DnsSecurityRule cmdlets - DnsResolverDomainList parameter no longer mandatory (ManagedDomainList alternative) - Domain parameter no longer mandatory (bulk upload alternative) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
| Thanks for your contribution! The pull request validation has started. Please revisit this comment for updated status. |
There was a problem hiding this comment.
Pull request overview
Adds additional breaking-change pre-announcements to the Az.DnsResolver module changelog, intended to prepare users for the upcoming migration to API version 2025-10-01-preview.
Changes:
- Announced removal of
ActionBlockResponseCodefrom DNS security rule create/update cmdlets. - Announced loosening of mandatory parameters (
DnsResolverDomainListandDomain) and pointed to new/alternate workflows.
| ## Upcoming Release | ||
| * [Breaking Change] Removed parameter `ActionBlockResponseCode` from `New-AzDnsResolverPolicyDnsSecurityRule` and `Update-AzDnsResolverPolicyDnsSecurityRule`. The block response code is no longer configurable. | ||
| * [Breaking Change] Parameter `DnsResolverDomainList` is no longer mandatory on `New-AzDnsResolverPolicyDnsSecurityRule`. DNS security rules now support `ManagedDomainList` as an alternative. | ||
| * [Breaking Change] Parameter `Domain` is no longer mandatory on `New-AzDnsResolverDomainList`. Domain lists now support bulk upload via `Invoke-AzDnsResolverBulkDnsResolverDomainList`. |
There was a problem hiding this comment.
The changelog references Invoke-AzDnsResolverBulkDnsResolverDomainList, but that cmdlet name doesn't appear anywhere else in the repo and it also looks like it repeats the module name (DnsResolver) twice. If the intent is to point users to an existing cmdlet, please correct the cmdlet name; if it’s a new cmdlet coming with the migration, consider wording this as an upcoming/new cmdlet to avoid implying it already exists.
| * [Breaking Change] Parameter `Domain` is no longer mandatory on `New-AzDnsResolverDomainList`. Domain lists now support bulk upload via `Invoke-AzDnsResolverBulkDnsResolverDomainList`. | |
| * [Breaking Change] Parameter `Domain` is no longer mandatory on `New-AzDnsResolverDomainList`. Domain lists will support bulk upload via the new cmdlet `Invoke-AzDnsResolverBulkDnsResolverDomainList`, which will be introduced in this upcoming release. |
| --> | ||
| ## Upcoming Release | ||
| * [Breaking Change] Removed parameter `ActionBlockResponseCode` from `New-AzDnsResolverPolicyDnsSecurityRule` and `Update-AzDnsResolverPolicyDnsSecurityRule`. The block response code is no longer configurable. | ||
| * [Breaking Change] Parameter `DnsResolverDomainList` is no longer mandatory on `New-AzDnsResolverPolicyDnsSecurityRule`. DNS security rules now support `ManagedDomainList` as an alternative. |
There was a problem hiding this comment.
ManagedDomainList is called out as an alternative on New-AzDnsResolverPolicyDnsSecurityRule, but that parameter/type name isn't present anywhere else in the repo today. Please double-check the exact parameter name that will be introduced with the 2025-10-01-preview migration so the breaking-change announcement matches the eventual cmdlet surface.
| * [Breaking Change] Parameter `DnsResolverDomainList` is no longer mandatory on `New-AzDnsResolverPolicyDnsSecurityRule`. DNS security rules now support `ManagedDomainList` as an alternative. | |
| * [Breaking Change] Parameter `DnsResolverDomainList` is no longer mandatory on `New-AzDnsResolverPolicyDnsSecurityRule`. DNS security rules now support managed domain lists as an alternative to DNS resolver domain lists. |
| * [Breaking Change] Removed parameter `ActionBlockResponseCode` from `New-AzDnsResolverPolicyDnsSecurityRule` and `Update-AzDnsResolverPolicyDnsSecurityRule`. The block response code is no longer configurable. | ||
| * [Breaking Change] Parameter `DnsResolverDomainList` is no longer mandatory on `New-AzDnsResolverPolicyDnsSecurityRule`. DNS security rules now support `ManagedDomainList` as an alternative. | ||
| * [Breaking Change] Parameter `Domain` is no longer mandatory on `New-AzDnsResolverDomainList`. Domain lists now support bulk upload via `Invoke-AzDnsResolverBulkDnsResolverDomainList`. |
There was a problem hiding this comment.
PR metadata says these breaking-change announcements are specifically for the 2025-10-01-preview API migration, but the new changelog bullets don’t mention that API version/migration context. Consider adding a short clause (for example, “as part of the 2025-10-01-preview API migration”) so users understand why these breaking changes are happening and when to expect them.
- Add 3 breaking-change directives to README.md for runtime warnings: * ActionBlockResponseCode parameter removed from DnsSecurityRule cmdlets * DnsResolverDomainList parameter no longer mandatory * Domain parameter no longer mandatory - Add Az.DnsResolver section to upcoming-breaking-changes.md - All changes target Az v16.0.0 / module v2.0.0 / effective 2026/05/01 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
|
/azp run |
|
Azure Pipelines successfully started running 3 pipeline(s). |
| - where: | ||
| verb: New|Update | ||
| subject: PolicyDnsSecurityRule | ||
| set: | ||
| breaking-change: | ||
| deprecated-cmdlet-output-type: '' | ||
| change-description: The parameter 'ActionBlockResponseCode' has been removed. The block response code is no longer configurable in API version 2025-10-01-preview. | ||
| deprecated-by-version: 2.0.0 | ||
| deprecated-by-azversion: 16.0.0 | ||
| change-effective-date: 2026/05/01 | ||
| - where: | ||
| verb: New | ||
| subject: PolicyDnsSecurityRule | ||
| set: | ||
| breaking-change: | ||
| deprecated-cmdlet-output-type: '' | ||
| change-description: The parameter 'DnsResolverDomainList' is no longer mandatory. DNS security rules now support 'ManagedDomainList' as an alternative to user-defined domain lists. | ||
| deprecated-by-version: 2.0.0 | ||
| deprecated-by-azversion: 16.0.0 | ||
| change-effective-date: 2026/05/01 | ||
| - where: | ||
| verb: New | ||
| subject: DnsResolverDomainList | ||
| set: | ||
| breaking-change: | ||
| deprecated-cmdlet-output-type: '' | ||
| change-description: The parameter 'Domain' is no longer mandatory. Domain lists now support bulk upload via 'Invoke-AzDnsResolverBulkDnsResolverDomainList' as an alternative to inline domain specification. | ||
| deprecated-by-version: 2.0.0 | ||
| deprecated-by-azversion: 16.0.0 | ||
| change-effective-date: 2026/05/01 |
There was a problem hiding this comment.
These new AutoRest directives add breaking-change metadata but don’t include an inline comment explaining the purpose (“why”) of each directive. Please add brief # comments above each new directive block to keep the directive section maintainable and consistent with the documented guidance for AutoRest README directives.
| breaking-change: | ||
| deprecated-cmdlet-output-type: '' | ||
| change-description: The parameter 'ActionBlockResponseCode' has been removed. The block response code is no longer configurable in API version 2025-10-01-preview. | ||
| deprecated-by-version: 2.0.0 | ||
| deprecated-by-azversion: 16.0.0 | ||
| change-effective-date: 2026/05/01 | ||
| - where: | ||
| verb: New | ||
| subject: PolicyDnsSecurityRule | ||
| set: | ||
| breaking-change: | ||
| deprecated-cmdlet-output-type: '' | ||
| change-description: The parameter 'DnsResolverDomainList' is no longer mandatory. DNS security rules now support 'ManagedDomainList' as an alternative to user-defined domain lists. | ||
| deprecated-by-version: 2.0.0 | ||
| deprecated-by-azversion: 16.0.0 | ||
| change-effective-date: 2026/05/01 | ||
| - where: | ||
| verb: New | ||
| subject: DnsResolverDomainList | ||
| set: | ||
| breaking-change: | ||
| deprecated-cmdlet-output-type: '' | ||
| change-description: The parameter 'Domain' is no longer mandatory. Domain lists now support bulk upload via 'Invoke-AzDnsResolverBulkDnsResolverDomainList' as an alternative to inline domain specification. | ||
| deprecated-by-version: 2.0.0 | ||
| deprecated-by-azversion: 16.0.0 | ||
| change-effective-date: 2026/05/01 |
There was a problem hiding this comment.
The breaking-change blocks here set deprecated-cmdlet-output-type to an empty string. That field is intended for output-type changes (see breakingchange-for-autogen-module.md), and using an empty value can be misleading and may be rejected by tooling later. Prefer omitting it entirely, or (better for parameter changes) use a parameter-level breaking-change directive (where: parameter-name: ...) with become-mandatory: false / a change-description, scoped to the relevant cmdlet(s).
| - Change description: The block response code is no longer configurable in API version 2025-10-01-preview. | ||
| - This change will take effect on '05/01/2026' | ||
| - The change is expected to take effect from Az version : '16.0.0' | ||
| - The change is expected to take effect from version : '2.0.0' | ||
|
|
||
| - Cmdlet breaking-change will happen to all parameter sets | ||
| - The parameter 'DnsResolverDomainList' will no longer be mandatory. | ||
| - Change description: DNS security rules now support 'ManagedDomainList' as an alternative to user-defined domain lists. | ||
| - This change will take effect on '05/01/2026' | ||
| - The change is expected to take effect from Az version : '16.0.0' | ||
| - The change is expected to take effect from version : '2.0.0' | ||
|
|
||
| ### `Update-AzDnsResolverPolicyDnsSecurityRule` | ||
|
|
||
| - Cmdlet breaking-change will happen to all parameter sets | ||
| - The parameter 'ActionBlockResponseCode' is being removed. | ||
| - Change description: The block response code is no longer configurable in API version 2025-10-01-preview. | ||
| - This change will take effect on '05/01/2026' | ||
| - The change is expected to take effect from Az version : '16.0.0' | ||
| - The change is expected to take effect from version : '2.0.0' | ||
|
|
||
| ### `New-AzDnsResolverDomainList` | ||
|
|
||
| - Cmdlet breaking-change will happen to all parameter sets | ||
| - The parameter 'Domain' will no longer be mandatory. | ||
| - Change description: Domain lists now support bulk upload via 'Invoke-AzDnsResolverBulkDnsResolverDomainList' as an alternative to inline domain specification. | ||
| - This change will take effect on '05/01/2026' | ||
| - The change is expected to take effect from Az version : '16.0.0' | ||
| - The change is expected to take effect from version : '2.0.0' |
There was a problem hiding this comment.
This new section uses a different effective-date formatting than nearby entries (e.g., '05/01/2026' vs '5/1/2026') and slightly different “Change description” punctuation. Consider aligning the new lines to the prevailing format in this document to keep it consistent (especially if this file is consumed or diffed by automation).
|
This PR was labeled "needs-revision" because it has unresolved review comments or CI failures. |
| - Additional information about change #1 | ||
| --> | ||
| ## Upcoming Release | ||
| * [Breaking Change] Removed parameter `ActionBlockResponseCode` from `New-AzDnsResolverPolicyDnsSecurityRule` and `Update-AzDnsResolverPolicyDnsSecurityRule`. The block response code is no longer configurable. |
There was a problem hiding this comment.
Can you put it like
"
Added announcement for breaking change:
- xxxx
- xxxx
"
?
Description
Adds breaking change announcements to \ChangeLog.md\ for the upcoming DnsResolver module migration to API version \2025-10-01-preview.
Breaking Changes Announced:
These announcements complement the existing breaking change pre-announcement from PR #28698.
Mandatory Checklist