Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jamesvoongms wants to merge 2 commits into
base: main
Choose a base branch
from
Open

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e91820b
Add DnsResolver breaking change announcements to ChangeLog
jamesvoongms Mar 24, 2026
49f121a
Add breaking-change directives and upcoming-breaking-changes entry
jamesvoongms Mar 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions documentation/breaking-changes/upcoming-breaking-changes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -310,6 +310,42 @@ Preview modules are not included in this list. Read more about [module version t
- This change will take effect on '5/1/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'

## Az.DnsResolver

### `New-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'

- 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'
Comment on lines +319 to +347
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.

## Az.KeyVault

### `Get-AzKeyVaultKey`
Expand Down
30 changes: 30 additions & 0 deletions src/DnsResolver/DnsResolver.Autorest/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,4 +129,34 @@ directive:
set:
preview-announcement:
preview-message: "*****************************************************************************************\\r\\n* This cmdlet will undergo a breaking change in Az v16.0.0, to be released in May 2026. *\\r\\n* At least one change applies to this cmdlet. *\\r\\n* See all possible breaking changes at https://go.microsoft.com/fwlink/?linkid=2333486 *\\r\\n**************************************************************************************************"
- 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
Comment on lines +132 to +161
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
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.
```
3 changes: 3 additions & 0 deletions src/DnsResolver/DnsResolver/ChangeLog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@
- 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 •
edited
Loading

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
"
?

* [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.
* [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.
Comment on lines +21 to +23
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.

## Version 1.2.1
* Preannounced breaking changes. Please refer to https://go.microsoft.com/fwlink/?linkid=2333229
Expand Down
Loading