Skip to content

[Az.DnsResolver] Add breaking change announcements for 2025-10-01-preview API migration#29308

Open
jamesvoongms wants to merge 2 commits intoAzure:mainfrom
jamesvoongms:dev/jamesvoong/dnsresolver-breaking-change-announcement
Open

[Az.DnsResolver] Add breaking change announcements for 2025-10-01-preview API migration#29308
jamesvoongms wants to merge 2 commits intoAzure:mainfrom
jamesvoongms:dev/jamesvoong/dnsresolver-breaking-change-announcement

Conversation

@jamesvoongms
Copy link
Copy Markdown
Member

Description

Adds breaking change announcements to \ChangeLog.md\ for the upcoming DnsResolver module migration to API version \2025-10-01-preview.

Breaking Changes Announced:

  • Removed parameter \ActionBlockResponseCode\ from \New-AzDnsResolverPolicyDnsSecurityRule\ and \Update-AzDnsResolverPolicyDnsSecurityRule. The block response code is no longer configurable.
  • Parameter no longer mandatory: \DnsResolverDomainList\ on \New-AzDnsResolverPolicyDnsSecurityRule. DNS security rules now support \ManagedDomainList\ as an alternative.
  • Parameter no longer mandatory: \Domain\ on \New-AzDnsResolverDomainList. Domain lists now support bulk upload via \Invoke-AzDnsResolverBulkDnsResolverDomainList.

These announcements complement the existing breaking change pre-announcement from PR #28698.

Mandatory Checklist

  • No need for a release
  • Check this box to confirm: I have read the Submitting Changes section

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>
Copilot AI review requested due to automatic review settings March 24, 2026 06:46
@azure-client-tools-bot-prd
Copy link
Copy Markdown

Thanks for your contribution! The pull request validation has started. Please revisit this comment for updated status.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 ActionBlockResponseCode from DNS security rule create/update cmdlets.
  • Announced loosening of mandatory parameters (DnsResolverDomainList and Domain) 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`.
Copy link

Copilot AI Mar 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Suggested change
* [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.

Copilot uses AI. Check for mistakes.
-->
## 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.
Copy link

Copilot AI Mar 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Suggested change
* [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.

Copilot uses AI. Check for mistakes.
Comment on lines +21 to +23
* [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`.
Copy link

Copilot AI Mar 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copilot uses AI. Check for mistakes.
- 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>
@NoriZC
Copy link
Copy Markdown
Contributor

NoriZC commented Mar 24, 2026

/azp run

@azure-pipelines
Copy link
Copy Markdown
Contributor

Azure Pipelines successfully started running 3 pipeline(s).

@jamesvoongms jamesvoongms marked this pull request as ready for review March 24, 2026 18:22
Copilot AI review requested due to automatic review settings March 24, 2026 18:22
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.

Comment on lines +132 to +161
- 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
Copy link

Copilot AI Mar 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copilot generated this review using guidance from repository custom instructions.
Comment on lines +136 to +161
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
Copy link

Copilot AI Mar 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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).

Copilot uses AI. Check for mistakes.
Comment on lines +319 to +347
- 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'
Copy link

Copilot AI Mar 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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).

Copilot uses AI. Check for mistakes.
@github-actions
Copy link
Copy Markdown

This PR was labeled "needs-revision" because it has unresolved review comments or CI failures.
Please resolve all open review comments and make sure all CI checks are green. Refer to our guide to troubleshoot common 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.
Copy link
Copy Markdown
Contributor

@JunKai-v JunKai-v Mar 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you put it like
"
Added announcement for breaking change:
- xxxx
- xxxx
"
?

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants