azure-rest-api-specs
azure-rest-api-specs copied to clipboard
Azure
Addition of SourceAddressList in InternetGateways Rule
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.
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)
- If this PR is in purview of ARM review then automation will add the
ARMReviewlabel. - If you want to force ARM review, add the label yourself.
- Proceed according to the diagram at the top of this comment.
Click here to see the diagram footnotes
Diagram footnotes
[1] ARM review queue (for merge queues, see [2])
The PRs are processed by time opened, ascending. Your PR may show up on 2nd or later page.
If you addressed Step 1 from the diagram and your PR is not showing up in the queue, ensure the label ARMChangesRequested
is removed from your PR. This should cause the label WaitForARMFeedback to be added.
[2] public repo merge queue, private repo merge queue (for ARM review queue, [1])
If you need further help with anything, see Getting help section below.
Purpose of this PR
What's the purpose of this PR? Check all that apply. This is mandatory!
- [x] New API version. (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 swagger 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:
- [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 Swagger-Suppression-Process 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.
- 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 breaking change (label:
BreakingChangeReviewRequired).
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.
For details of the ARM review, see aka.ms/azsdk/pr-arm-review. - ❌ The required check named
TypeSpec Validationhas failed. Refer to the check in the PR's 'Checks' tab for details on how to fix it.
![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): 9 Errors, 10 Warnings failed [Detail]
| Compared specs (v0.10.8) | new version | base version |
|---|---|---|
| InternetGatewayRules.json | 2024-02-15-preview(8f739d4) | 2023-06-15(main) |
| common.json | 2024-02-15-preview(8f739d4) | 2023-06-15(main) |
| common.json | 2024-02-15-preview(8f739d4) | 2023-02-01-preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
The following breaking changes are detected by comparison with the latest preview version:
| Rule | Message |
|---|---|
| :warning: 1047 - XmsEnumChanged | The new version has a different x-ms-enum 'name' than the previous one. New: Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/common.json#L121:9 Old: Microsoft.ManagedNetworkFabric/preview/2023-02-01-preview/common.json#L132:9 |
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 0 Warnings warning [Detail]
| Compared specs (v2.2.2) | new version | base version |
|---|---|---|
| package-2024-02-15-preview | package-2024-02-15-preview(8f739d4) | default(main) |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
| :warning: XmsIdentifierValidation | Missing identifier id in array item property Location: Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/common.json#L609 |
| :warning: XmsIdentifierValidation | Missing identifier id in array item property Location: Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/common.json#L618 |
| :warning: XmsIdentifierValidation | Missing identifier id in array item property Location: Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/common.json#L627 |
️️✔️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-go succeeded [Detail] [Expand]
️✔️Succeeded in generating from 10f0a2ef28cc364c676b4060d82fd7fb25f28a3a. 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 warn specification/managednetworkfabric/ManagedNetworkFabric.InternetGatewayRules.Management/tspconfig.yaml skipped due to azure-sdk-for-go not found in tspconfig.yaml command generator automation-v2 ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
️✔️sdk/resourcemanager/managednetworkfabric/armmanagednetworkfabric [Preview SDK Changes] Breaking Change Detectedinfo [Changelog] ### Breaking Changes info [Changelog] info [Changelog] - Function `*NetworkFabricsClient.BeginUpgrade` parameter(s) have been changed from `(context.Context, string, string, UpdateVersion, *NetworkFabricsClientBeginUpgradeOptions)` to `(context.Context, string, string, UpgradeNetworkFabricProperties, *NetworkFabricsClientBeginUpgradeOptions)` info [Changelog] info [Changelog] ### Features Added info [Changelog] info [Changelog] - New value `ConfigurationStatePendingCommit`, `ConfigurationStateProvisioning` added to enum type `ConfigurationState` info [Changelog] - New enum type `NetworkFabricUpgradeAction` with values `NetworkFabricUpgradeActionComplete`, `NetworkFabricUpgradeActionStart` info [Changelog] - New struct `UpgradeNetworkFabricProperties` info [Changelog] - New field `DefaultAction` in struct `AccessControlListPatchProperties` info [Changelog] - New field `DefaultAction` in struct `AccessControlListProperties` info [Changelog] - New field `NetworkToNetworkInterconnectID` in struct `ExternalNetworkPatchProperties` info [Changelog] - New field `DefaultAction` in struct `RoutePolicyPatchableProperties` info [Changelog] - New field `DefaultAction` in struct `RoutePolicyProperties` info [Changelog] info [Changelog] Total 1 breaking change(s), 12 additive change(s).
Present SDK breaking changes suppressions No suppression file added.
Absent SDK breaking changes suppressions - Function `*NetworkFabricsClient.BeginUpgrade` parameter(s) have been changed from `(context.Context, string, string, UpdateVersion, *NetworkFabricsClientBeginUpgradeOptions)` to `(context.Context, string, string, UpgradeNetworkFabricProperties, *NetworkFabricsClientBeginUpgradeOptions)`
Parse Suppression File Errors No suppression file added.
Please refer to https://aka.ms/azsdk/sdk-suppression for more information.
️️✔️ azure-sdk-for-java succeeded [Detail] [Expand]
️✔️Succeeded in generating from 10f0a2ef28cc364c676b4060d82fd7fb25f28a3a. SDK Automation 14.0.0command ./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json command ./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
️✔️azure-resourcemanager-managednetworkfabric [Preview SDK Changes]- pom.xml
- azure-resourcemanager-managednetworkfabric-1.1.0-beta.1.jar
- azure-resourcemanager-managednetworkfabric-1.1.0-beta.1-sources.jar
️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
️✔️Succeeded in generating from 10f0a2ef28cc364c676b4060d82fd7fb25f28a3a. 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-managednetworkfabric [Preview SDK Changes] Breaking Change Detected- azure-arm-managednetworkfabric-2.0.0.tgz
info [Changelog] **Features** info [Changelog] info [Changelog] - Added Interface UpgradeNetworkFabricProperties info [Changelog] - Added Type Alias NetworkFabricUpgradeAction info [Changelog] - Interface AccessControlList has a new optional parameter defaultAction info [Changelog] - Interface AccessControlListPatch has a new optional parameter defaultAction info [Changelog] - Interface AccessControlListPatchableProperties has a new optional parameter defaultAction info [Changelog] - Interface ExternalNetworkPatch has a new optional parameter networkToNetworkInterconnectId info [Changelog] - Interface ExternalNetworkPatchableProperties has a new optional parameter networkToNetworkInterconnectId info [Changelog] - Interface RoutePolicy has a new optional parameter defaultAction info [Changelog] - Interface RoutePolicyPatch has a new optional parameter defaultAction info [Changelog] - Interface RoutePolicyPatchableProperties has a new optional parameter defaultAction info [Changelog] - Added Enum KnownNetworkFabricUpgradeAction info [Changelog] - Enum KnownConfigurationState has a new value PendingCommit info [Changelog] - Enum KnownConfigurationState has a new value Provisioning info [Changelog] info [Changelog] **Breaking Changes** info [Changelog] info [Changelog] - Operation NetworkFabrics.beginUpgrade has a new signature info [Changelog] - Operation NetworkFabrics.beginUpgradeAndWait has a new signature
Present SDK breaking changes suppressions No suppression file added.
Absent SDK breaking changes suppressions - Operation NetworkFabrics.beginUpgrade has a new signature - Operation NetworkFabrics.beginUpgradeAndWait has a new signature
Parse Suppression File Errors No suppression file added.
Please refer to https://aka.ms/azsdk/sdk-suppression for more information.
️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]
️✔️Succeeded in generating from 10f0a2ef28cc364c676b4060d82fd7fb25f28a3a. 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 warn specification/managednetworkfabric/ManagedNetworkFabric.InternetGatewayRules.Management/tspconfig.yaml skipped due to azure-sdk-for-net-track2 not found in tspconfig.yaml command pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json
️✔️Azure.ResourceManager.ManagedNetworkFabric [Preview SDK Changes] Breaking Change Detected- Azure.ResourceManager.ManagedNetworkFabric.1.2.0-alpha.20240509.1.nupkg
info [Changelog] Breaking Changes: /home/cloudtest/.nuget/packages/microsoft.dotnet.apicompat/5.0.0-beta.20467.1/build/Microsoft.DotNet.ApiCompat.targets(82,5): error : MembersMustExist : Member 'public Azure.ResourceManager.ManagedNetworkFabric.NetworkFabricExternalNetworkData Azure.ResourceManager.ManagedNetworkFabric.Models.ArmManagedNetworkFabricModelFactory.NetworkFabricExternalNetworkData(Azure.Core.ResourceIdentifier, System.String, Azure.Core.ResourceType, Azure.ResourceManager.Models.SystemData, System.String, Azure.Core.ResourceIdentifier, Azure.Core.ResourceIdentifier, Azure.ResourceManager.ManagedNetworkFabric.Models.ImportRoutePolicy, Azure.ResourceManager.ManagedNetworkFabric.Models.ExportRoutePolicy, Azure.Core.ResourceIdentifier, Azure.ResourceManager.ManagedNetworkFabric.Models.PeeringOption, Azure.ResourceManager.ManagedNetworkFabric.Models.L3OptionBProperties, Azure.ResourceManager.ManagedNetworkFabric.Models.ExternalNetworkOptionAProperties, System.Nullable<Azure.ResourceManager.ManagedNetworkFabric.Models.NetworkFabricConfigurationState>, System.Nullable<Azure.ResourceManager.ManagedNetworkFabric.Models.NetworkFabricProvisioningState>, System.Nullable<Azure.ResourceManager.ManagedNetworkFabric.Models.NetworkFabricAdministrativeState>)' does not exist in the implementation but it does exist in the contract. [/mnt/vss/_work/1/s/azure-sdk-for-net/sdk/managednetworkfabric/Azure.ResourceManager.ManagedNetworkFabric/src/Azure.ResourceManager.ManagedNetworkFabric.csproj::TargetFramework=netstandard2.0], info [Changelog] /home/cloudtest/.nuget/packages/microsoft.dotnet.apicompat/5.0.0-beta.20467.1/build/Microsoft.DotNet.ApiCompat.targets(96,5): error : ApiCompat failed for '/mnt/vss/_work/1/s/azure-sdk-for-net/artifacts/bin/Azure.ResourceManager.ManagedNetworkFabric/Debug/netstandard2.0/Azure.ResourceManager.ManagedNetworkFabric.dll' [/mnt/vss/_work/1/s/azure-sdk-for-net/sdk/managednetworkfabric/Azure.ResourceManager.ManagedNetworkFabric/src/Azure.ResourceManager.ManagedNetworkFabric.csproj::TargetFramework=netstandard2.0]
Parse Suppression File Errors No suppression file added.
Please refer to https://aka.ms/azsdk/sdk-suppression for more information.
️⚠️ azure-sdk-for-python warning [Detail]
⚠️Warning in generating from 10f0a2ef28cc364c676b4060d82fd7fb25f28a3a. 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: Skipping azure-nspkg as it is not installed. cmderr [automation_init.sh] notice cmderr [automation_init.sh] npm notice New minor version of npm available! 10.5.0 -> 10.7.0 cmderr [automation_init.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.7.0> cmderr [automation_init.sh] npm notice Run `npm install -g [email protected]` to update! cmderr [automation_init.sh] npm notice warn specification/managednetworkfabric/ManagedNetworkFabric.InternetGatewayRules.Management/tspconfig.yaml skipped due to azure-sdk-for-python not found in tspconfig.yaml command sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
️✔️azure-mgmt-managednetworkfabric [Preview SDK Changes]- azure-mgmt-managednetworkfabric-1.0.0b1.zip
- azure_mgmt_managednetworkfabric-1.0.0b1-py3-none-any.whl
info [Changelog] ### Features Added info [Changelog] info [Changelog] - Model AccessControlList has a new parameter default_action info [Changelog] - Model AccessControlListPatch has a new parameter default_action info [Changelog] - Model AccessControlListPatchProperties has a new parameter default_action info [Changelog] - Model AccessControlListPatchableProperties has a new parameter default_action info [Changelog] - Model AccessControlListProperties has a new parameter default_action info [Changelog] - Model ExternalNetworkPatch has a new parameter network_to_network_interconnect_id info [Changelog] - Model ExternalNetworkPatchProperties has a new parameter network_to_network_interconnect_id info [Changelog] - Model ExternalNetworkPatchableProperties has a new parameter network_to_network_interconnect_id info [Changelog] - Model RoutePolicy has a new parameter default_action info [Changelog] - Model RoutePolicyPatch has a new parameter default_action info [Changelog] - Model RoutePolicyPatchableProperties has a new parameter default_action info [Changelog] - Model RoutePolicyProperties has a new parameter default_action
Generated ApiView
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 @amartya321! For review efficiency consideration, when creating a new API version, it is required to place API specs of the base version in the first commit, and push new version updates into successive commits. You can use OpenAPIHub to initialize the PR for adding a new version.
For more details refer to the wiki.