azure-rest-api-specs
azure-rest-api-specs copied to clipboard
Published
20 hours ago •
Azure
Azure
Changing API documentation for system data changes in NSP APIs
ARM (Control Plane) API Specification Update Pull Request
[!TIP] Overwhelmed by all this guidance? See the
Getting helpsection at the bottom of this PR description.
[!NOTE] As of January 2024 there is no PR assignee. This is expected. See https://aka.ms/azsdk/pr-arm-review.
PR review workflow diagram
Please understand this diagram before proceeding. It explains how to get your PR approved & merged.
Click here to see the details of Step 1, Breaking Changes review
If you are in purview of Step 1 of the diagram, follow the Breaking Changes review process.
IMPORTANT! This applies even if you believe your PR was mislabeled, for any reason, including tool failure.
Click here to see the details of Step 2, ARM review
See https://aka.ms/azsdk/pr-arm-review.
Click here to see the diagram footnotes
Diagram footnotes
[1] See ARM review queue (for PR merge queues, see [2]).
[2] public repo merge queue, private repo merge queue (for ARM review queue, [1])
The ARM reviewer on-call engineer visits the merge queue twice a day, so the approximate ETA for merges is 12 - 24 hours.
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 generated using OpenAPI Hub).
- [x] 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.
- [x] Other, please clarify:
- The system data will be shown from current api version onwards ie. 2023-07-01-preview.
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:
- [x] I confirm this PR is modifying Azure Resource Manager (ARM) related specifications, and not data plane related specifications.
- [x] 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.
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 PRandDue diligence checklist. - To understand what you must do next to merge this PR, see the
Next Steps to Mergecomment. 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 PR workflow diagram Step 2 (ARM review), see https://aka.ms/azsdk/pr-arm-review.
- If the PR CI checks appear to be stuck in
queuedstate, please add a comment with contents/azp run. This should result in a new comment denoting aPR validation pipelinehas 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.
Next Steps to Merge
Next steps that must be taken to merge this PR:- ❌ This PR has at least one change violating Azure versioning policy (label:
VersioningReviewRequired).
To unblock this PR, either introduce a new API version with these changes instead of modifying an existing API version To unblock this PR, follow the process at aka.ms/brch. - ❌ This PR is in purview of the ARM review (label:
ARMReview). This PR must getARMSignedOfflabel from an ARM reviewer.
This PR hasARMChangesRequestedlabel. Please address or respond to feedback from the ARM API reviewer.
When you are ready to continue the ARM API review, please remove theARMChangesRequestedlabel.
Automation should then addWaitForARMFeedbacklabel.
❗If you don't have permissions to remove the label, requestwrite accessper 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 - ❌ The required check named
Swagger BreakingChangehas failed. To unblock this PR, follow the process at aka.ms/brch.
![openapi-pipeline-app[bot] avatar](https://avatars.githubusercontent.com/in/65541?v=4 "Published by a pub.dev verified publisher"){kind=small}
Swagger Validation Report
️❌BreakingChange: 22 Errors, 0 Warnings failed [Detail]
| Compared specs (v0.10.5) | new version | base version |
|---|---|---|
| networkSecurityPerimeter.json | 2023-07-01-preview(307d0d8) | 2023-07-01-preview(main) |
| networkSecurityPerimeter.json | 2023-08-01-preview(307d0d8) | 2023-08-01-preview(main) |
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 12 Warnings warning [Detail]
| Compared specs (v2.2.0) | new version | base version |
|---|---|---|
| package-2023-08-preview | package-2023-08-preview(307d0d8) | package-2023-08-preview(main) |
| package-2023-07-preview | package-2023-07-preview(307d0d8) | package-2023-07-preview(main) |
[must fix]The following errors/warnings are introduced by current PR:
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
The resource name parameter 'networkSecurityPerimeterName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/preview/2023-07-01-preview/networkSecurityPerimeter.json#L37 |
|
The resource name parameter 'networkSecurityPerimeterName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/preview/2023-07-01-preview/networkSecurityPerimeter.json#L278 |
|
The resource name parameter 'profileName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/preview/2023-07-01-preview/networkSecurityPerimeter.json#L278 |
|
The resource name parameter 'networkSecurityPerimeterName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/preview/2023-07-01-preview/networkSecurityPerimeter.json#L392 |
|
The resource name parameter 'networkSecurityPerimeterName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/preview/2023-07-01-preview/networkSecurityPerimeter.json#L443 |
|
The resource name parameter 'profileName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/preview/2023-07-01-preview/networkSecurityPerimeter.json#L443 |
|
The resource name parameter 'accessRuleName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/preview/2023-07-01-preview/networkSecurityPerimeter.json#L443 |
|
The resource name parameter 'networkSecurityPerimeterName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/preview/2023-07-01-preview/networkSecurityPerimeter.json#L560 |
|
The resource name parameter 'profileName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/preview/2023-07-01-preview/networkSecurityPerimeter.json#L560 |
|
The resource name parameter 'networkSecurityPerimeterName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/preview/2023-07-01-preview/networkSecurityPerimeter.json#L614 |
|
The resource name parameter 'associationName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/preview/2023-07-01-preview/networkSecurityPerimeter.json#L614 |
|
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: Microsoft.Network/preview/2023-07-01-preview/networkSecurityPerimeter.json#L701 |
|
The resource name parameter 'networkSecurityPerimeterName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/preview/2023-07-01-preview/networkSecurityPerimeter.json#L738 |
|
The resource name parameter 'networkSecurityPerimeterName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/preview/2023-07-01-preview/networkSecurityPerimeter.json#L789 |
|
The resource name parameter 'associationName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/preview/2023-07-01-preview/networkSecurityPerimeter.json#L789 |
|
The resource name parameter 'networkSecurityPerimeterName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/preview/2023-07-01-preview/networkSecurityPerimeter.json#L884 |
|
The resource name parameter 'profileName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/preview/2023-07-01-preview/networkSecurityPerimeter.json#L884 |
|
The resource name parameter 'accessRuleName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/preview/2023-07-01-preview/networkSecurityPerimeter.json#L884 |
|
The resource name parameter 'networkSecurityPerimeterName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/preview/2023-07-01-preview/networkSecurityPerimeter.json#L943 |
|
The resource name parameter 'linkName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/preview/2023-07-01-preview/networkSecurityPerimeter.json#L943 |
|
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: Microsoft.Network/preview/2023-07-01-preview/networkSecurityPerimeter.json#L1030 |
|
The resource name parameter 'networkSecurityPerimeterName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/preview/2023-07-01-preview/networkSecurityPerimeter.json#L1070 |
|
The resource name parameter 'networkSecurityPerimeterName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/preview/2023-07-01-preview/networkSecurityPerimeter.json#L1121 |
|
The resource name parameter 'linkReferenceName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/preview/2023-07-01-preview/networkSecurityPerimeter.json#L1121 |
|
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: Microsoft.Network/preview/2023-07-01-preview/networkSecurityPerimeter.json#L1165 |
|
The resource name parameter 'networkSecurityPerimeterName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/preview/2023-07-01-preview/networkSecurityPerimeter.json#L1205 |
|
Model definition 'NetworkSecurityPerimeter' must have the properties 'name', 'id' and 'type' in its hierarchy and these properties must be marked as readonly. Location: Microsoft.Network/preview/2023-07-01-preview/networkSecurityPerimeter.json#L1258 |
|
Model definition 'NspProfile' must have the properties 'name', 'id' and 'type' in its hierarchy and these properties must be marked as readonly. Location: Microsoft.Network/preview/2023-07-01-preview/networkSecurityPerimeter.json#L1348 |
|
Tracked resource 'NspProfile' must have patch operation that at least supports the update of tags. Location: Microsoft.Network/preview/2023-07-01-preview/networkSecurityPerimeter.json#L1348 |
|
Model definition 'NspAccessRule' must have the properties 'name', 'id' and 'type' in its hierarchy and these properties must be marked as readonly. Location: Microsoft.Network/preview/2023-07-01-preview/networkSecurityPerimeter.json#L1416 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Swagger Generation Artifacts
️️✔️ApiDocPreview succeeded [Detail] [Expand]
Please click here to preview with your @microsoft account.
️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]
️✔️Succeeded [Logs] Generate from 352f807c220c9512c6aa3dcf7768e5117da18b8b. SDK Automation 14.0.0command pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json command autorest --version=2.0.4421 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION [email protected]/[email protected] --csharp-sdks-folder=/mnt/vss/_work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/network/resource-manager/readme.md cmderr [Autorest] realpath(): Permission denied cmderr [Autorest] realpath(): Permission denied cmderr [Autorest] realpath(): Permission denied
️✔️Microsoft.Azure.Management.Network [View full logs] [Preview SDK Changes]
️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]
️✔️Succeeded [Logs] Generate from 352f807c220c9512c6aa3dcf7768e5117da18b8b. SDK Automation 14.0.0command pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json command pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json
️✔️Azure.ResourceManager.Network [View full logs] [Preview SDK Changes]info [Changelog]
️🔄 azure-sdk-for-python inProgress [Detail]
️⚠️ azure-sdk-for-java warning [Detail]
⚠️Warning [Logs] Generate from 352f807c220c9512c6aa3dcf7768e5117da18b8b. SDK Automation 14.0.0command ./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json cmderr [init.sh] [notice] A new release of pip is available: 23.0.1 -> 24.0 cmderr [init.sh] [notice] To update, run: pip install --upgrade pip cmderr [init.sh] [notice] A new release of pip is available: 23.0.1 -> 24.0 cmderr [init.sh] [notice] To update, run: pip install --upgrade pip cmderr [init.sh] Speed Time Time Time Current cmderr [init.sh] Dload Upload Total Spent Left Speed cmderr [init.sh] 0 0 0 0 0 0 0 0 --:--:-- --:--:-- --:--:-- 0 1295k 0 --:--:-- --:--:-- --:--:-- 1295k cmderr [init.sh] notice cmderr [init.sh] npm notice New minor version of npm available! 10.2.4 -> 10.5.0 cmderr [init.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.5.0> cmderr [init.sh] npm notice Run `npm install -g [email protected]` to update! cmderr [init.sh] npm notice cmderr [init.sh] Downloading https://nodejs.org/dist/v18.15.0/node-v18.15.0-linux-x64.tar.xz... cmderr [init.sh] ###################### 100.0% cmderr [init.sh] Computing checksum with sha256sum cmderr [init.sh] Checksums matched! command ./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
️✔️azure-resourcemanager-network-generated [View full logs] [Preview SDK Changes]
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
️✔️Succeeded [Logs] Generate from 352f807c220c9512c6aa3dcf7768e5117da18b8b. SDK Automation 14.0.0command sh ./eng/scripts/automation_init.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json command generator automation-v2 ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
️✔️sdk/resourcemanager/network/armnetwork [View full logs] [Preview SDK Changes]info [Changelog] ### Other Changes info [Changelog] info [Changelog] Total 0 breaking change(s), 0 additive change(s).
️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
️✔️Succeeded [Logs] Generate from 352f807c220c9512c6aa3dcf7768e5117da18b8b. SDK Automation 14.0.0command sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json warn File azure-sdk-for-js_tmp/initOutput.json not found to read command sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json cmderr [automation_generate.sh] [ERROR] Cannot generate changelog because the codes of local and npm may be the same.
️✔️@azure/arm-network [View full logs] [Preview SDK Changes]info [Changelog] error breakingChangeTracking is enabled, but version or changelogItem is not found in output.
️🔄 azure-resource-manager-schemas inProgress [Detail]
️⚠️ azure-powershell warning [Detail]
⚠️Warning [Logs] Generate from 352f807c220c9512c6aa3dcf7768e5117da18b8b. SDK Automation 14.0.0command sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json command pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json
⚠️Az.network.DefaultTag [View full logs] [Preview SDK Changes]
Generated ApiView
| Language | Package Name | ApiView Link |
|---|---|---|
| Go | sdk/resourcemanager/network/armnetwork | https://apiview.dev/Assemblies/Review/08ab188fdab64564bc46944e13addcf9?revisionId=9c779b4b13d6453f99d67bc063a7e90c |
| Java | azure-resourcemanager-network-generated | https://apiview.dev/Assemblies/Review/d496e631581f47bcab5c961219fc2258?revisionId=dfa48f55db8947e5aa0ce92b0ea5ee52 |
| JavaScript | @azure/arm-network | There is no API change compared with the previous version |
| .Net | Azure.ResourceManager.Network | There is no API change compared with the previous version |
| Swagger | Microsoft.Network | https://apiview.dev/Assemblies/Review/9a91f46aa0a846acaae91aba821517fb?revisionId=0d20ec93d5b7488794aabc65016576cd |
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.
This will notify the reviewer to have another look.
If the feedback provided needs further discussion, please use this Teams channel to post your questions - aka.ms/azsdk/support/specreview-channel.
Please include [ARM Query] in the title of your question to indicate that it is ARM-related.
![openapi-workflow-bot[bot] avatar](https://avatars.githubusercontent.com/in/81125?v=4 "Published by a pub.dev verified publisher"){kind=small}
Hi, @apoorvtiwarims. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.
![microsoft-github-policy-service[bot] avatar](https://avatars.githubusercontent.com/in/95686?v=4 "Published by a pub.dev verified publisher"){kind=small}
Hi, @apoorvtiwarims. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee.