Add new API version for DNS resolver with DNS security policy changes for 2025-05-01 #34615

jamesvoongms · 2025-05-12T21:05:11Z

ARM (Control Plane) API Specification Update Pull Request

This is a PR that builds on our 2023-07-01-preview that introduces four new resources into the dnsresolver module.

The preview version added a new json containing an upcoming feature for DNS Security Policy. It also changes the existing API spec to use common types v5 from v2.

The changes from the preview version adds a new POST request for one of the resource DNS resolver domain list which allows a user to specify a storage URL for uploading or downloading domain lists (list of domains used by allowing or blocking DNS requests).

Previous Public Preview Review -> #30707
Other azure-rest-api-spec-pr change reviews for additions since last version:
https://github.com/Azure/azure-rest-api-specs-pr/pull/21053
https://github.com/Azure/azure-rest-api-specs-pr/pull/22230
https://github.com/Azure/azure-rest-api-specs-pr/pull/22287

Tip

Overwhelmed by all this guidance? See the Getting help section at the bottom of this PR description.

PR review workflow diagram

Please understand this diagram before proceeding. It explains how to get your PR approved & merged.

Purpose of this PR

What's the purpose of this PR? Check the specific option that applies. This is mandatory!

New resource provider.
New API version for an existing resource provider. (If API spec is not defined in TypeSpec, the PR should have been created in adherence to OpenAPI specs PR creation guidance).
Update existing version for a new feature. (This is applicable only when you are revising a private preview API version.)
Update existing version to fix OpenAPI spec quality issues in S360.
Convert existing OpenAPI spec to TypeSpec spec (do not combine this with implementing changes for a new API version).
Other, please clarify:
- edit this with your clarification

Due diligence checklist

To merge this PR, you must go through the following checklist and confirm you understood
and followed the instructions by checking all the boxes:

I confirm this PR is modifying Azure Resource Manager (ARM) related specifications, and not data plane related specifications.
I have reviewed following Resource Provider guidelines, including
ARM resource provider contract and
REST guidelines (estimated time: 4 hours).
I understand this is required before I can proceed to the diagram Step 2, "ARM API changes review", for this PR.
A release plan has been created. If not, please create one as it will help guide you through the REST API and SDK creation process. (https://apps.powerapps.com/play/e/ed2ffefd-774d-40dd-ab23-7fff01aeec9f/a/821ab569-ae60-420d-8264-d7b5d5ef734c?tenantId=72f988bf-86f1-41af-91ab-2d7cd011db47)

Additional information

Viewing API changes

For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the Generated ApiView comment added to this PR. You can use ApiView to show API versions diff.

Suppressing failures

If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
suppressions guide to get approval.

Getting help

First, please carefully read through this PR description, from top to bottom. Please fill out the Purpose of this PR and Due diligence checklist.
If you don't have permissions to remove or add labels to the PR, request write access per aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositories
To understand what you must do next to merge this PR, see the Next Steps to Merge comment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.
For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure
and https://aka.ms/ci-fix.
For help with ARM review (PR workflow diagram Step 2), see https://aka.ms/azsdk/pr-arm-review.
If the PR CI checks appear to be stuck in queued state, please add a comment with contents /azp run.
This should result in a new comment denoting a PR validation pipeline has started and the checks should be updated after few minutes.
If the help provided by the previous points is not enough, post to https://aka.ms/azsdk/support/specreview-channel and link to this PR.

openapi-pipeline-app · 2025-05-12T21:05:15Z

Next Steps to Merge

Next steps that must be taken to merge this PR:

❌ This PR is in purview of the ARM review (label: ARMReview). This PR must get ARMSignedOff label from an ARM reviewer.
This PR has ARMChangesRequested label. Please address or respond to feedback from the ARM API reviewer.
When you are ready to continue the ARM API review, please remove the ARMChangesRequested label.
Automation should then add WaitForARMFeedback label.
❗If you don't have permissions to remove the label, request write access per aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositories.
For details of the ARM review, see aka.ms/azsdk/pr-arm-review

openapi-pipeline-app · 2025-05-12T21:05:15Z

PR validation pipeline restarted successfully. If there is ApiView generated, it will be updated in this comment.

jamesvoongms · 2025-05-12T21:46:35Z

The linting seems to be incorrect? The four files referenced in the error are in the swagger spec

jamesvoongms · 2025-05-12T22:29:47Z

/azp run

azure-pipelines · 2025-05-12T22:29:53Z

You have several pipelines (over 10) configured to build pull requests in this repository. Specify which pipelines you would like to run by using /azp run [pipelines] command. You can specify multiple pipelines using a comma separated list.

specification/dnsresolver/resource-manager/readme.md

github-actions · 2025-05-14T17:14:31Z

API Change Check

APIView identified API level changes in this PR and created the following API reviews

Language	API Review for Package
Go	sdk/resourcemanager/dnsresolver/armdnsresolver

github-actions · 2025-05-14T17:14:32Z

API Change Check

APIView identified API level changes in this PR and created the following API reviews

Language	API Review for Package
Go	sdk/resourcemanager/dnsresolver/armdnsresolver

TimLovellSmith · 2025-05-16T22:01:43Z

@jamesvoongms so do I understand right that all the changes here have already been ARM reviewed in one PR or another?

TimLovellSmith · 2025-05-16T22:02:38Z

...ager/Microsoft.Network/stable/2025-05-01/examples/DnsResolverDomainList_BulkDomains_Get.json

+          "key1": "value1"
+        },
+        "properties": {
+          "domainsUrl": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverDomainLists/sampleDnsResolverDomainList/bulk",


domainsUrl

I'm curious about why a domainsUrl is a relative uri. Or is it more of a resource id? In which case why call it an url?

don't see any real problem here anyway

I think I'm still confused about why the 'dns resolver domain links get bulk domains operation" gets you a domains url which is itself...
isn't it just ANOTHER get bulk domains operation?
if this is the uRL?

"domainsUrl": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverDomainLists/sampleDnsResolverDomainList/bulk",

is this as recursive as it sounds??

TimLovellSmith · 2025-05-16T22:04:07Z

...ager/Microsoft.Network/stable/2025-05-01/examples/DnsResolverDomainList_BulkDomains_Put.json

+      "tags": {
+        "key1": "value1"
+      },
+      "properties": {}


properties

Is it a good example?
Why would there be no properties supplied in a bulk put example?
Would that create anything?

TimLovellSmith · 2025-05-16T22:05:43Z

...tion/dnsresolver/resource-manager/Microsoft.Network/stable/2025-05-01/dnsresolverpolicy.json

            "$ref": "./examples/DnsResolverDomainList_Get.json"
+          },
+          "Retrieve DNS resolver domain list with bulk number of domains": {
+            "$ref": "./examples/DnsResolverDomainList_BulkDomains_Get.json"
          }
        }
      }


bulk

API design
just having one action called 'bulk' seems confusing to me - compared to having separate actions 'bulkDownload' and 'bulkUpload'?

Do you think its better for some reason?

TimLovellSmith · 2025-05-17T04:54:53Z

...tion/dnsresolver/resource-manager/Microsoft.Network/stable/2025-05-01/dnsresolverpolicy.json

@@ -1593,6 +1654,11 @@
            "type": "string"
          }
        },


you might want to mention whether its possible to have both of these properties or if they're exclusive?

TimLovellSmith · 2025-05-17T04:57:54Z

this example looks really similar to the non bulk 'DnsResolverDomainList_Get.json.

Whats the difference between these two examples? Are they supposed to be the same, or different apis?

Refers to: specification/dnsresolver/resource-manager/Microsoft.Network/stable/2025-05-01/examples/DnsResolverDomainList_BulkDomains_Get.json:34 in 6035cbc. [](commit_id = 6035cbc, deletion_comment = False)

TimLovellSmith · 2025-05-17T04:58:39Z

Would appreciate some further explanation of this api

Add new changes for 2025-05-01

7c4c86c

jamesvoongms changed the title ~~[DRAFT] Add new API version for DNS resolver with DNS security policy changes for 2025-05-01~~ Add new API version for DNS resolver with DNS security policy changes for 2025-05-01 May 12, 2025

github-actions bot added the brownfield Brownfield services will soon be required to convert to TypeSpec. See https://aka.ms/azsdk/typespec. label May 12, 2025

azure-sdk mentioned this pull request May 12, 2025

[AutoPR sdk/resourcemanager/dnsresolver/armdnsresolver] Add new API version for DNS resolver with DNS security policy changes for 2025-05-01 azure-sdk/azure-sdk-for-go#14799

Draft

AzureRestAPISpecReview added ARMReview resource-manager WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels May 12, 2025

Add the readme changes

16c2775

jianingwang123 reviewed May 14, 2025

View reviewed changes

specification/dnsresolver/resource-manager/readme.md Outdated Show resolved Hide resolved

Fix tag value

6035cbc

TimLovellSmith reviewed May 16, 2025

View reviewed changes

TimLovellSmith reviewed May 17, 2025

View reviewed changes

TimLovellSmith added the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label May 17, 2025

openapi-pipeline-app bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label May 17, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add new API version for DNS resolver with DNS security policy changes for 2025-05-01 #34615

Add new API version for DNS resolver with DNS security policy changes for 2025-05-01 #34615

jamesvoongms commented May 12, 2025 •

edited

Loading

openapi-pipeline-app bot commented May 12, 2025 •

edited

Loading

openapi-pipeline-app bot commented May 12, 2025 •

edited

Loading

jamesvoongms commented May 12, 2025

jamesvoongms commented May 12, 2025

azure-pipelines bot commented May 12, 2025

github-actions bot commented May 14, 2025

github-actions bot commented May 14, 2025

TimLovellSmith commented May 16, 2025

TimLovellSmith May 16, 2025 •

edited

Loading

TimLovellSmith May 17, 2025

TimLovellSmith May 17, 2025

TimLovellSmith May 16, 2025

TimLovellSmith May 16, 2025

TimLovellSmith May 17, 2025

TimLovellSmith commented May 17, 2025

TimLovellSmith commented May 17, 2025

Add new API version for DNS resolver with DNS security policy changes for 2025-05-01 #34615

Are you sure you want to change the base?

Add new API version for DNS resolver with DNS security policy changes for 2025-05-01 #34615

Conversation

jamesvoongms commented May 12, 2025 • edited Loading

ARM (Control Plane) API Specification Update Pull Request

PR review workflow diagram

Purpose of this PR

Due diligence checklist

Additional information

Getting help

openapi-pipeline-app bot commented May 12, 2025 • edited Loading

Next Steps to Merge

openapi-pipeline-app bot commented May 12, 2025 • edited Loading

jamesvoongms commented May 12, 2025

jamesvoongms commented May 12, 2025

azure-pipelines bot commented May 12, 2025

github-actions bot commented May 14, 2025

API Change Check

github-actions bot commented May 14, 2025

API Change Check

TimLovellSmith commented May 16, 2025

TimLovellSmith May 16, 2025 • edited Loading

Choose a reason for hiding this comment

TimLovellSmith May 17, 2025

Choose a reason for hiding this comment

TimLovellSmith May 17, 2025

Choose a reason for hiding this comment

TimLovellSmith May 16, 2025

Choose a reason for hiding this comment

TimLovellSmith May 16, 2025

Choose a reason for hiding this comment

TimLovellSmith May 17, 2025

Choose a reason for hiding this comment

TimLovellSmith commented May 17, 2025

TimLovellSmith commented May 17, 2025

jamesvoongms commented May 12, 2025 •

edited

Loading

openapi-pipeline-app bot commented May 12, 2025 •

edited

Loading

openapi-pipeline-app bot commented May 12, 2025 •

edited

Loading

TimLovellSmith May 16, 2025 •

edited

Loading