Skip to content
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.

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

Remove routingConfigNfv #25962

Conversation

rutuja-s
Copy link
Member

@rutuja-s rutuja-s commented Sep 26, 2023

ARM (Control Plane) API Specification Update Pull Request

PR review workflow diagram

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

diagram

[1] ARM review queue (for merge queues, see [4])
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] https://aka.ms/azsdk/support/specreview-channel
[3] List of SDK breaking changes approvers in pinned Teams announcement
[4] 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!

  • New API version. (Such PR should have been generated with OpenAPI Hub, per this wiki doc.)
  • 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:
    • Fixing the Routing Configuration property for NVA connection. This API is not publicly available yet and this change should not have any cx impact

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:

Breaking changes review (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.

ARM API changes review (Step 2)

  • If this PR is in purview of ARM review then automation will add the ARMReview label.
  • If you want to force ARM review, add the label yourself.
  • Proceed according to the diagram at the top of this comment.

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

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Sep 26, 2023

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
Copy link

openapi-pipeline-app bot commented Sep 26, 2023

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️LintDiff succeeded [Detail] [Expand]
Validation passes for LintDiff.
️️✔️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.
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️🔄PR Summary inProgress [Detail]
️⌛Automated merging requirements met pending [Detail]
Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Sep 26, 2023

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand]
️⌛SDK Breaking Change Tracking pending [Detail]
Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Sep 26, 2023

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

@rutuja-s rutuja-s changed the title remove routingConfigNfv Remove routingConfigNfv Sep 26, 2023
@AzureRestAPISpecReview AzureRestAPISpecReview added ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review ARMReview BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required resource-manager labels Sep 26, 2023
@openapi-workflow-bot
Copy link

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.

@rutuja-s
Copy link
Member Author

NVA connection (just another virtual wan connection) is an Nfvrp resource as opposed to other connections in virtual wan (VPN, Express route etc) which are Nrp resources. RoutingConfigurationNfv was a new definition added as a Nfvrp version of already existing definition of RoutingConfiguration (used by Nrp resources) in the Swagger. The difference in this definition is as below:

Existing Routing configuration has reference ‘#definitions/SubResource’ which uses property name ‘Id’ and the result is looks like below :

routingConfiguration": {
            "associatedRouteTable": {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1"
            },

and Nfvrp version of Routing configuration was intended to have this same same property named as ResourceUri instead of id as below:

"routingConfiguration": {
            "associatedRouteTable": {
              "resourceUri": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1"
            },

To achieve this, we introduced a new definition in previous API versions which would allow this change from id -> resourceUri

"RoutingConfigurationNfvSubResource": {
      "type": "object",
      "properties": {
        "resourceUri": {
          "type": "string",
          "description": "Resource ID."
        }
      },
      "description": "Reference to RouteTableV3 associated with the connection."
    },

However, in recent reviews and discussions for NVA connection, it was decided to have same Routing configuration property for all the connections to have consistency across them so that portal/terraform or anyone else using rest doesn’t need different automation based on connection type. This would also providing consistent results to the customers. In order to have this consistency, I’ve removed RoutingConfigurationNfv and used RoutingConfiguration instead which is now being flagged as a breaking change in 2023-06-01.

On the customer impact side, NVA connection feature is not yet enabled and hence we do not have any active users that would be impacted by this change.

@mikekistler mikekistler added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Oct 4, 2023
@rutuja-s rutuja-s removed the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Oct 9, 2023
@openapi-workflow-bot openapi-workflow-bot bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Oct 9, 2023
@Joanna-Yang-Art
Copy link
Contributor

@rutuja-s Please get your PR merged before code freeze date 10/12

@ms-zhenhua
Copy link
Contributor

/azp run

@rutuja-s
Copy link
Member Author

/pr RequestMerge

@Joanna-Yang-Art
Copy link
Contributor

@rutuja-s please request ARM to get the PR merged as soon as possible. NRP don't help review and approve PRs

@rutuja-s
Copy link
Member Author

@rkmanda can you please help with the pr merge? I have all the necessary approvals

@ms-henglu ms-henglu added ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review and removed ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review labels Oct 26, 2023
@rkmanda
Copy link
Member

rkmanda commented Oct 27, 2023

/azp run

@azure-pipelines
Copy link

Azure Pipelines successfully started running 2 pipeline(s).

@rkmanda
Copy link
Member

rkmanda commented Oct 27, 2023

waiting for all checks to pass

@rutuja-s
Copy link
Member Author

@rkmanda any update on this merge?

@rkmanda
Copy link
Member

rkmanda commented Oct 30, 2023

azp /run

@rkmanda
Copy link
Member

rkmanda commented Oct 30, 2023

/azp run

@azure-pipelines
Copy link

Azure Pipelines successfully started running 2 pipeline(s).

@rkmanda
Copy link
Member

rkmanda commented Oct 30, 2023

automated checks are stuck, waiting for those to finish

@rkmanda
Copy link
Member

rkmanda commented Oct 30, 2023

Pl get help from the API spec review channel to get unblocked on these stuck checks you can tag Konrad Jamrozik in your post

@rkmanda rkmanda merged commit b56defc into Azure:release-network-Microsoft.Network-official-2023-06-01 Nov 1, 2023
24 of 27 checks passed
@rkmanda
Copy link
Member

rkmanda commented Nov 1, 2023

/azp run

@AzureRestAPISpecReview AzureRestAPISpecReview removed the BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required label Nov 1, 2023
zizw123 pushed a commit that referenced this pull request Nov 8, 2023
* Adds base for updating Microsoft.Network from version stable/2023-05-01 to version 2023-06-01

* Updates readme

* Updates API version in new specs and examples

* Add missing DeleteBastionShareableLinkByToken API back to swagger (#25599)

* add DeleteBastionShareableLinkByToken endpoint
* fix location link format

* Adding Developer Sku (#25887)

* Firewall Policy - IDPS profiles (#25666)

* add profile to put example

* fixed RuleCollectionGroupWithHttpHeadersToInsert example

* add profile to Policy model

* description change

* indentation

* ListIdpsSignatures description change

* direction description+enum fix

* fix FirewallPolicyIDPSSignatureSeverity description

* hostnames for l4 listeners (#25982)

* added ergwscale support (#25969)

* Fixed examples for gateway load balancer (#26058)

* Add support for JSChallenge action in Application Gateway Web application Firewall (#26149)

* Add support for JSChallenge action

Add support for JSChallenge action in the list of supported actions for Custom rules and Managed rules

* Update WafPolicyGet.json

* Update WafPolicyCreateOrUpdate.json

* DDoS - Fixing Swagger Validation Issues on DDoSCustomPolicy (#26248)

* fixes

* making changes in new api version

---------

Co-authored-by: Manas Chakka <manaschakka@microsoft.com>

* [NVA] Internet Ingress Parameters (#26262)

* [NVA] Internet Ingress Parameters

* LintDiff Fix

* Minor Fix

* Added description for each of the enums for ApplicationGatewayProtocol (#26437)

* Added description for each of the enums for ApplicationGatewayProtocol

* Spacing for prettier checks

* Remove routingConfigNfv (#25962)

* remove routingConfigNfv

* remove api from older versions

* remove PUT nvaconnection from older versions

* apply prettier check

* add suppression for modelValidation

* remove suppression due to approval

* Fix lint errors & add supressions (#26494)

* fix lint error

* add supression for ResourceNameRestriction & LroErrorContent

* fix example accordingly

---------

Co-authored-by: htippanaboya <102244326+htippanaboya@users.noreply.github.com>
Co-authored-by: Sijie Lin <97983749+msftsijielin@users.noreply.github.com>
Co-authored-by: anvrao1 <109107918+anvrao1@users.noreply.github.com>
Co-authored-by: NiviShenker <99583088+NiviShenker@users.noreply.github.com>
Co-authored-by: gdhillon24 <105729965+gdhillon24@users.noreply.github.com>
Co-authored-by: aneeshakella-microsoft <109654329+aneeshakella-microsoft@users.noreply.github.com>
Co-authored-by: irrogozh <irrogozh@microsoft.com>
Co-authored-by: ssevugan21 <122578291+ssevugan21@users.noreply.github.com>
Co-authored-by: Manas Chakka <mchakka@gmail.com>
Co-authored-by: Manas Chakka <manaschakka@microsoft.com>
Co-authored-by: JainRah <108508612+JainRah@users.noreply.github.com>
Co-authored-by: rutuja-s <42910715+rutuja-s@users.noreply.github.com>
zman-ms pushed a commit that referenced this pull request Jan 10, 2024
* Adds base for updating Microsoft.Network from version stable/2023-05-01 to version 2023-06-01

* Updates readme

* Updates API version in new specs and examples

* Add missing DeleteBastionShareableLinkByToken API back to swagger (#25599)

* add DeleteBastionShareableLinkByToken endpoint
* fix location link format

* Adding Developer Sku (#25887)

* Firewall Policy - IDPS profiles (#25666)

* add profile to put example

* fixed RuleCollectionGroupWithHttpHeadersToInsert example

* add profile to Policy model

* description change

* indentation

* ListIdpsSignatures description change

* direction description+enum fix

* fix FirewallPolicyIDPSSignatureSeverity description

* hostnames for l4 listeners (#25982)

* added ergwscale support (#25969)

* Fixed examples for gateway load balancer (#26058)

* Add support for JSChallenge action in Application Gateway Web application Firewall (#26149)

* Add support for JSChallenge action

Add support for JSChallenge action in the list of supported actions for Custom rules and Managed rules

* Update WafPolicyGet.json

* Update WafPolicyCreateOrUpdate.json

* DDoS - Fixing Swagger Validation Issues on DDoSCustomPolicy (#26248)

* fixes

* making changes in new api version

---------

Co-authored-by: Manas Chakka <manaschakka@microsoft.com>

* [NVA] Internet Ingress Parameters (#26262)

* [NVA] Internet Ingress Parameters

* LintDiff Fix

* Minor Fix

* Added description for each of the enums for ApplicationGatewayProtocol (#26437)

* Added description for each of the enums for ApplicationGatewayProtocol

* Spacing for prettier checks

* Remove routingConfigNfv (#25962)

* remove routingConfigNfv

* remove api from older versions

* remove PUT nvaconnection from older versions

* apply prettier check

* add suppression for modelValidation

* remove suppression due to approval

* Fix lint errors & add supressions (#26494)

* fix lint error

* add supression for ResourceNameRestriction & LroErrorContent

* fix example accordingly

---------

Co-authored-by: htippanaboya <102244326+htippanaboya@users.noreply.github.com>
Co-authored-by: Sijie Lin <97983749+msftsijielin@users.noreply.github.com>
Co-authored-by: anvrao1 <109107918+anvrao1@users.noreply.github.com>
Co-authored-by: NiviShenker <99583088+NiviShenker@users.noreply.github.com>
Co-authored-by: gdhillon24 <105729965+gdhillon24@users.noreply.github.com>
Co-authored-by: aneeshakella-microsoft <109654329+aneeshakella-microsoft@users.noreply.github.com>
Co-authored-by: irrogozh <irrogozh@microsoft.com>
Co-authored-by: ssevugan21 <122578291+ssevugan21@users.noreply.github.com>
Co-authored-by: Manas Chakka <mchakka@gmail.com>
Co-authored-by: Manas Chakka <manaschakka@microsoft.com>
Co-authored-by: JainRah <108508612+JainRah@users.noreply.github.com>
Co-authored-by: rutuja-s <42910715+rutuja-s@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 Approved-LintDiff Approved-ModelValidation Approved-SdkBreakingChange-Go Approve the breaking change tracking for azure-sdk-for-go Approved-SdkBreakingChange-JavaScript ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review CI-BreakingChange-Go CI-BreakingChange-JavaScript FixS360 resource-manager
Projects
None yet
Development

Successfully merging this pull request may close these issues.