azure-rest-api-specs
azure-rest-api-specs copied to clipboard
Azure
Release network microsoft.network official 2023 11 01
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 (Diagram Step 1)
If the automation determines you have breaking changes, i.e. Step 1 from the diagram applies to you,
you must follow the breaking changes process.
IMPORTANT This applies even if:
- The tool fails while it shouldn't, e.g. due to runtime exception, or incorrect detection of breaking changes.
- You believe there is no need for you to request breaking change approval, for any reason. Such claims must be reviewed, and the process is the same.
Click here to see the details of Step 2
ARM API changes review (Diagram Step 2)
- For help with 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).
- [ ] 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.
- [ ] 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.
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
✅ All automated merging requirements have been met! Refer to step 4 in the PR workflow diagram (even if your PR is for data plane, not ARM).![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 succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| applicationGateway.json | 2023-11-01(69ae4fd) | 2023-09-01(main) |
️⚠️LintDiff: 0 Warnings warning [Detail]
| compared tags (via openapi-validator v2.1.6) | new version | base version |
|---|---|---|
| package-2023-11 | package-2023-11(69ae4fd) | package-2023-11(release-network-Microsoft.Network-official-2023-11-01) |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
The private endpoint API: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateLinkServices/{serviceName}/privateLinkResources is missing. Location: Microsoft.Network/stable/2023-11-01/applicationGateway.json#L36 |
|
The resource name parameter 'applicationGatewayName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/stable/2023-11-01/applicationGateway.json#L37 |
|
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/stable/2023-11-01/applicationGateway.json#L38 |
|
A 202 response should include an Location response header. Location: Microsoft.Network/stable/2023-11-01/applicationGateway.json#L72 |
|
The patch operation body parameter schema should contain property 'identity'. Location: Microsoft.Network/stable/2023-11-01/applicationGateway.json#L234 |
|
The resource name parameter 'applicationGatewayName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/stable/2023-11-01/applicationGateway.json#L351 |
|
200 return code does not have a schema specified. LRO POST must have a 200 return code if only if the final response is intended to have a schema, if not the 200 return code must not be specified. Location: Microsoft.Network/stable/2023-11-01/applicationGateway.json#L352 |
|
A 202 response should include an Location response header. Location: Microsoft.Network/stable/2023-11-01/applicationGateway.json#L389 |
|
The resource name parameter 'applicationGatewayName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/stable/2023-11-01/applicationGateway.json#L405 |
|
200 return code does not have a schema specified. LRO POST must have a 200 return code if only if the final response is intended to have a schema, if not the 200 return code must not be specified. Location: Microsoft.Network/stable/2023-11-01/applicationGateway.json#L406 |
|
A 202 response should include an Location response header. Location: Microsoft.Network/stable/2023-11-01/applicationGateway.json#L443 |
|
The resource name parameter 'applicationGatewayName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/stable/2023-11-01/applicationGateway.json#L459 |
|
$expand is a query parameter. Post operation must not contain any query parameter other than api-version. Location: Microsoft.Network/stable/2023-11-01/applicationGateway.json#L471 |
|
A 202 response should include an Location response header. Location: Microsoft.Network/stable/2023-11-01/applicationGateway.json#L507 |
|
The resource name parameter 'applicationGatewayName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/stable/2023-11-01/applicationGateway.json#L523 |
|
$expand is a query parameter. Post operation must not contain any query parameter other than api-version. Location: Microsoft.Network/stable/2023-11-01/applicationGateway.json#L535 |
|
A 202 response should include an Location response header. Location: Microsoft.Network/stable/2023-11-01/applicationGateway.json#L580 |
|
The resource name parameter 'applicationGatewayName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/stable/2023-11-01/applicationGateway.json#L596 |
|
The resource name parameter 'applicationGatewayName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/stable/2023-11-01/applicationGateway.json#L649 |
|
The resource name parameter 'connectionName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/stable/2023-11-01/applicationGateway.json#L649 |
|
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/stable/2023-11-01/applicationGateway.json#L650 |
|
A 202 response should include an Location response header. Location: Microsoft.Network/stable/2023-11-01/applicationGateway.json#L691 |
|
201 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes. Location: Microsoft.Network/stable/2023-11-01/applicationGateway.json#L712 |
|
Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes. Location: Microsoft.Network/stable/2023-11-01/applicationGateway.json#L712 |
|
A 202 response should include an Location response header. Location: Microsoft.Network/stable/2023-11-01/applicationGateway.json#L763 |
|
The resource name parameter 'applicationGatewayName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/stable/2023-11-01/applicationGateway.json#L839 |
|
x-ms-pageable extension must be specified for LIST APIs.Location: Microsoft.Network/stable/2023-11-01/applicationGateway.json#L893 |
|
the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content. Location: Microsoft.Network/stable/2023-11-01/applicationGateway.json#L919 |
|
x-ms-pageable extension must be specified for LIST APIs.Location: Microsoft.Network/stable/2023-11-01/applicationGateway.json#L929 |
|
the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content. Location: Microsoft.Network/stable/2023-11-01/applicationGateway.json#L955 |
️️✔️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.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️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 4171af4c1161ecaef559520068c48173a9883196. 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 4171af4c1161ecaef559520068c48173a9883196. 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-track2 warning [Detail]
⚠️Warning [Logs] Generate from 4171af4c1161ecaef559520068c48173a9883196. SDK Automation 14.0.0command sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json cmderr [automation_init.sh] WARNING: azure-devtools 1.2.1 does not provide the extra 'ci-tools' cmderr [automation_init.sh] WARNING: azure-devtools 1.2.1 does not provide the extra 'ci-tools' cmderr [automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed. command sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
️✔️track2_azure-mgmt-network [View full logs] [Preview SDK Changes]info [Changelog]
️⚠️ azure-sdk-for-java warning [Detail]
⚠️Warning [Logs] Generate from 4171af4c1161ecaef559520068c48173a9883196. 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 -> 23.3.2 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 -> 23.3.2 cmderr [init.sh] [notice] To update, run: pip install --upgrade pip cmderr [init.sh] % Total % Received % Xferd Average 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 --:--:-- --:--:-- --:--:-- 01k 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 4171af4c1161ecaef559520068c48173a9883196. 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] ### Features Added info [Changelog] info [Changelog] - New value `VirtualNetworkPrivateEndpointNetworkPoliciesNetworkSecurityGroupEnabled`, `VirtualNetworkPrivateEndpointNetworkPoliciesRouteTableEnabled` added to enum type `VirtualNetworkPrivateEndpointNetworkPolicies` info [Changelog] - New struct `HeaderValueMatcher` info [Changelog] - New field `HeaderValueMatcher` in struct `ApplicationGatewayHeaderConfiguration` info [Changelog] - New field `Zones` in struct `BastionHost` info [Changelog] info [Changelog] Total 0 breaking change(s), 6 additive change(s).
️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
️✔️Succeeded [Logs] Generate from 4171af4c1161ecaef559520068c48173a9883196. 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
️✔️@azure/arm-network [View full logs] [Preview SDK Changes]info [Changelog] **Features** info [Changelog] info [Changelog] - Added Interface HeaderValueMatcher info [Changelog] - Interface ApplicationGatewayHeaderConfiguration has a new optional parameter headerValueMatcher info [Changelog] - Interface BastionHost has a new optional parameter zones info [Changelog] - Enum KnownVirtualNetworkPrivateEndpointNetworkPolicies has a new value NetworkSecurityGroupEnabled info [Changelog] - Enum KnownVirtualNetworkPrivateEndpointNetworkPolicies has a new value RouteTableEnabled
️🔄 azure-resource-manager-schemas inProgress [Detail]
️⚠️ azure-powershell warning [Detail]
⚠️Warning [Logs] Generate from 4171af4c1161ecaef559520068c48173a9883196. 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=7a0d6bfd4d364634af474709a596dc2e |
| Java | azure-resourcemanager-network-generated | https://apiview.dev/Assemblies/Review/d496e631581f47bcab5c961219fc2258?revisionId=928d3a3e0502449bae08140644516e41 |
| JavaScript | @azure/arm-network | https://apiview.dev/Assemblies/Review/c13fd66ecbcc4c2a9995c8a1f4187240?revisionId=b850bf4607ed416fb041df486d1b500a |
| .Net | Azure.ResourceManager.Network | https://apiview.dev/Assemblies/Review/806ead8231374028b5c49cb90e200641?revisionId=d3b0bacb7cf34ff38374ec780bd9244e |
| Swagger | Microsoft.Network | https://apiview.dev/Assemblies/Review/9a91f46aa0a846acaae91aba821517fb?revisionId=c962bab778c244abb7e877f86518f49f |
Commenter does not have sufficient privileges for PR 27477 in repo Azure/azure-rest-api-specs
![azure-pipelines[bot] avatar](https://avatars.githubusercontent.com/in/9426?v=4 "Published by a pub.dev verified publisher"){kind=small}
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}
Removed ARMChangeRequested Label as requested by PR author. Please add it back if any changes are needed.
@Sukhdev841 - ARM reviewers only do the merges to main and RPSaaSMaster branches. You should be able to merge this PR yourself.
Please help to merge this PR, I don't see any merge button available to me.