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.

Sign up for GitHub

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

Jump to bottom

VPN NAT for Virtual Network Gateway feature changes(master) #13443

Closed
wants to merge 6 commits into from
Closed

VPN NAT for Virtual Network Gateway feature changes(master) #13443

wants to merge 6 commits into from

Conversation

Khushboo-Baheti
Copy link
Member

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

Changelog

Please ensure to add changelog with this PR by answering the following questions.

  1. What's the purpose of the update?
    • new service onboarding
    • new API version
    • update existing version for new feature
    • update existing version to fix swagger quality issue in s360
    • Other, please clarify
  2. When you are targeting to deploy new service/feature to public regions? Please provide date, or month to public if date is not available yet.
  3. When you expect to publish swagger? Please provide date, or month to public if date is not available yet.
  4. If it's an update to existing version, please select SDKs of specific language and CLIs that require refresh after swagger is published.
    • SDK of .NET (need service team to ensure code readiness)
    • SDK of Python
    • SDK of Java
    • SDK of Js
    • SDK of Go
    • PowerShell
    • CLI
    • Terraform
    • No, no need to refresh for updates in this PR

Contribution checklist:

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

  • Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.

    • Adding new API(s)
    • Adding a new API version
    • Ensure to copy the existing version into new directory structure for first commit (including refactoring) and then push new changes including version updates in separate commits. This is required to review the changes efficiently.
    • Adding a new service

  • Please ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.

  • If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.

Breaking Change Review Checklist

If there are following updates in the PR, ensure to request an approval from Breaking Change Review Board as defined in the Breaking Change Policy.

  • Removing API(s) in stable version
  • Removing properties in stable version
  • Removing API version(s) in stable version
  • Updating API in stable or public preview version with Breaking Change Validation errors
  • Updating API(s) in public preview over 1 year (refer to Retirement of Previews)

Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.

Please follow the link to find more details on PR review process.

@openapi-workflow-bot
Copy link

Hi, @Khushboo-Baheti Thanks for your PR. I am workflow bot for review process. Here are some small tips.

  • Please ensure to do self-check against checklists in first PR comment.
  • PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.
  • For specs comparison cross API versions, Use API Specs Comparison Report Generator
  • If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

    • Any feedback about review process or workflow bot, pls contact swagger and tools team. [email protected]

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Mar 16, 2021 •
    edited
    Loading

    Swagger Validation Report

    ️❌BreakingChange: 6 Errors, 0 Warnings failed [Detail]

    Rule Message
    ❌ 1038 - AddedPath The new version is adding a path that was not found in the old version.
    New: Microsoft.Network/stable/2020-11-01/virtualNetworkGateway.json#L2335:5
    ❌ 1038 - AddedPath The new version is adding a path that was not found in the old version.
    New: Microsoft.Network/stable/2020-11-01/virtualNetworkGateway.json#L2519:5
    ❌ 1045 - AddedOptionalProperty The new version has a new optional property 'natRules' that was not found in the old version.
    New: Microsoft.Network/stable/2020-11-01/virtualNetworkGateway.json#L2704:7
    Old: Microsoft.Network/stable/2020-11-01/virtualNetworkGateway.json#L2389:7
    ❌ 1045 - AddedOptionalProperty The new version has a new optional property 'enableBgpRouteTranslationForNat' that was not found in the old version.
    New: Microsoft.Network/stable/2020-11-01/virtualNetworkGateway.json#L2704:7
    Old: Microsoft.Network/stable/2020-11-01/virtualNetworkGateway.json#L2389:7
    ❌ 1045 - AddedOptionalProperty The new version has a new optional property 'ingressNatRules' that was not found in the old version.
    New: Microsoft.Network/stable/2020-11-01/virtualNetworkGateway.json#L3358:7
    Old: Microsoft.Network/stable/2020-11-01/virtualNetworkGateway.json#L3016:7
    ❌ 1045 - AddedOptionalProperty The new version has a new optional property 'egressNatRules' that was not found in the old version.
    New: Microsoft.Network/stable/2020-11-01/virtualNetworkGateway.json#L3358:7
    Old: Microsoft.Network/stable/2020-11-01/virtualNetworkGateway.json#L3016:7
    ️️✔️LintDiff succeeded [Detail] [Expand] 
    Validation passes for LintDiff.

    ️️✔️Avocado succeeded [Detail] [Expand] 
    Validation passes for Avocado.
    ️️✔️ModelValidation succeeded [Detail] [Expand] 
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand] 
    Validation passes for SemanticValidation.
    ️️✔️[Staging] Cross Version BreakingChange (Base on preview version) succeeded [Detail] [Expand] 
    There are no breaking changes.
    ️️✔️[Staging] Cross Version BreakingChange (Base on stable version) succeeded [Detail] [Expand] 
    There are no breaking changes.
    ️️✔️CredScan succeeded [Detail] [Expand] 
    There is no credential detected.
    ️⚠️[Staging] SDK Track2 Validation: 698 Warnings warning [Detail] Only 10 items are listed, please refer to log for more details.

    Rule Message
    ⚠️ PreCheck/SchemaMissingType "readme":"network/resource-manager/readme.md",
    "tag":"package-2020-11",
    "details":"The schema 'ApplicationGatewayOnDemandProbe' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/SchemaMissingType "readme":"network/resource-manager/readme.md",
    "tag":"package-2020-11",
    "details":"The schema 'ApplicationGatewayBackendHealthOnDemand' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/SchemaMissingType "readme":"network/resource-manager/readme.md",
    "tag":"package-2020-11",
    "details":"The schema 'ApplicationGatewayBackendHealth' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/SchemaMissingType "readme":"network/resource-manager/readme.md",
    "tag":"package-2020-11",
    "details":"The schema 'ApplicationGatewayBackendHealthPool' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/SchemaMissingType "readme":"network/resource-manager/readme.md",
    "tag":"package-2020-11",
    "details":"The schema 'ApplicationGatewayBackendHealthHttpSettings' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/SchemaMissingType "readme":"network/resource-manager/readme.md",
    "tag":"package-2020-11",
    "details":"The schema 'ApplicationGatewayBackendHealthServer' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/SchemaMissingType "readme":"network/resource-manager/readme.md",
    "tag":"package-2020-11",
    "details":"The schema 'ApplicationGatewaySku' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/SchemaMissingType "readme":"network/resource-manager/readme.md",
    "tag":"package-2020-11",
    "details":"The schema 'ApplicationGatewaySslPolicy' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/SchemaMissingType "readme":"network/resource-manager/readme.md",
    "tag":"package-2020-11",
    "details":"The schema 'ApplicationGatewayClientAuthConfiguration' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/SchemaMissingType "readme":"network/resource-manager/readme.md",
    "tag":"package-2020-11",
    "details":"The schema 'ApplicationGatewayIPConfigurationPropertiesFormat' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand] 
    Validation passes for PrettierCheck.
    ️️✔️[Staging] SpellCheck succeeded [Detail] [Expand] 
    Validation passes for SpellCheck.
    Posted by Swagger Pipeline | How to fix these errors?

    @ghost ghost added the Network label Mar 16, 2021
    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Mar 16, 2021 •
    edited
    Loading

    Swagger Generation Artifacts

    ️️✔️[Staging] ApiDocPreview succeeded [Detail] [Expand] 
     Please click here to preview with your @microsoft account.
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs] Generate from 5d8d9da8486de72935b11cd4c0bc6988303cdf85. SDK Automation 14.0.0 
      command	./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
cmderr	[generate.py] 2021-03-16 19:19:58 INFO [VERSION][Not Found] cannot find version for "com.azure.resourcemanager:azure-resourcemanager-network-generated"
cmderr	[generate.py] 2021-03-16 19:19:58 INFO [VERSION][Not Found] cannot find stable version, current version "1.0.0-beta.1"
cmderr	[generate.py] 2021-03-16 19:19:58 INFO autorest --version=3.1.3 --use=@autorest/[email protected] --java.azure-libraries-for-java-folder=/home/vsts/work/1/s/azure-sdk-for-java --java.output-folder=/home/vsts/work/1/s/azure-sdk-for-java/sdk/network/azure-resourcemanager-network-generated --java.namespace=com.azure.resourcemanager.network.generated   --java --pipeline.modelerfour.additional-checks=false --pipeline.modelerfour.lenient-model-deduplication=true --azure-arm --verbose --sdk-integration --fluent=lite --java.fluent=lite --java.license-header=MICROSOFT_MIT_SMALL ../azure-rest-api-specs/specification/network/resource-manager/readme.md
cmderr	[generate.py] 2021-03-16 19:23:08 INFO [CI][Success] Write to ci.yml
cmderr	[generate.py] 2021-03-16 19:23:08 INFO [POM][Process] dealing with pom.xml
cmderr	[generate.py] 2021-03-16 19:23:08 INFO [POM][Skip] pom already has module azure-resourcemanager-network-generated
cmderr	[generate.py] 2021-03-16 19:23:08 INFO [POM][Success] Write to pom.xml
cmderr	[generate.py] 2021-03-16 19:23:08 INFO [POM][Process] dealing with root pom
cmderr	[generate.py] 2021-03-16 19:23:08 INFO [POM][Success] Write to root pom
    • ️✔️azure-resourcemanager-network-generated [View full logs]  [Preview SDK Changes] 
      cmderr	[Inst] 2021-03-16 19:29:10 DEBUG Got artifact_id: azure-resourcemanager-network-generated
cmderr	[Inst] 2021-03-16 19:29:10 DEBUG Got artifact: pom.xml
cmderr	[Inst] 2021-03-16 19:29:10 DEBUG Got artifact: azure-resourcemanager-network-generated-1.0.0-beta.1-sources.jar
cmderr	[Inst] 2021-03-16 19:29:10 DEBUG Got artifact: azure-resourcemanager-network-generated-1.0.0-beta.1-javadoc.jar
cmderr	[Inst] 2021-03-16 19:29:10 DEBUG Got artifact: azure-resourcemanager-network-generated-1.0.0-beta.1.jar
cmderr	[Inst] 2021-03-16 19:29:10 DEBUG Match jar package: azure-resourcemanager-network-generated-1.0.0-beta.1.jar
cmderr	[Inst] 2021-03-16 19:29:10 DEBUG output: {"full": "```sh\ncurl -L \"https://portal.azure-devex-tools.com/api/sdk-dl-pub?p=Azure/13443/azure-sdk-for-java/azure-resourcemanager-network-generated/azure-resourcemanager-network-generated-1.0.0-beta.1.jar\" -o azure-resourcemanager-network-generated-1.0.0-beta.1.jar\nmvn install:install-file -DgroupId=com.azure.resourcemanager -DartifactId=azure-resourcemanager-network-generated -Dversion=1.0.0-beta.0 -Dfile=azure-resourcemanager-network-generated-1.0.0-beta.1.jar -Dpackaging=jar -DgeneratePom=true
```"}
    ️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from 5d8d9da8486de72935b11cd4c0bc6988303cdf85. SDK Automation 14.0.0 
      warn	Skip initScript due to not configured
command	sudo apt-get install -y dotnet-sdk-5.0
command	autorest --version=V2 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION [email protected]/[email protected] --csharp-sdks-folder=/home/vsts/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
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-python-track2 warning [Detail]
    • ⚠️Warning [Logs] Generate from 5d8d9da8486de72935b11cd4c0bc6988303cdf85. SDK Automation 14.0.0 
      command	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.
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] **Features**
info	[Changelog]
info	[Changelog]   - Model VirtualNetworkGatewayConnection has a new parameter egress_nat_rules
info	[Changelog]   - Model VirtualNetworkGatewayConnection has a new parameter ingress_nat_rules
info	[Changelog]   - Model VirtualNetworkGateway has a new parameter nat_rules
info	[Changelog]   - Model VirtualNetworkGateway has a new parameter enable_bgp_route_translation_for_nat
info	[Changelog]   - Added operation NatRulesOperations.list_by_virtual_network_gateway
info	[Changelog]   - Added operation group VirtualNetworkGatewayNatRulesOperations
    ️🔄 azure-resource-manager-schemas inProgress [Detail]
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from 5d8d9da8486de72935b11cd4c0bc6988303cdf85. SDK Automation 14.0.0 
      warn	Skip initScript due to not configured
command	autorest --version=V2 --typescript --license-header=MICROSOFT_MIT_NO_VERSION [email protected]/[email protected] --typescript-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-js/azure-sdk-for-js ../../azure-rest-api-specs/specification/network/resource-manager/readme.md
    • ️✔️@azure/arm-network [View full logs]  [Preview SDK Changes] 
      cmderr	[npmPack] loaded rollup.config.js with warnings
cmderr	[npmPack] (!) Unused external imports
cmderr	[npmPack] default imported from external module 'rollup' but never used
cmderr	[npmPack] ./esm/networkManagementClient.js → ./dist/arm-network.js...
cmderr	[npmPack] created ./dist/arm-network.js in 2.9s
    Posted by Swagger Pipeline | How to fix these errors?

    @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 Mar 16, 2021
    @openapi-workflow-bot
    Copy link

    Hi, @Khushboo-Baheti your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]). cc @

    @openapi-workflow-bot
    Copy link

    NewApiVersionRequired reason:

    A service’s API is a contract with customers and is represented by using the api-version query parameter. Changes such as adding an optional property to a request/response or introducing a new operation is a change to the service’s contract and therefore requires a new api-version value. This is critically important for documentation, client libraries, and customer support.

    EXAMPLE: if a customer calls a service in the public cloud using api-version=2020-07-27, the new property or operation may exist but if they call the service in a government cloud, air-gapped cloud, or Azure Stack Hub cloud using the same api-version, the property or operation may not exist. Because there is no clear relationship between the service api-version and the new property/operation, customers can’t trust the documentation and Azure customer have difficulty helping customers diagnose issues. In addition, each client library version documents the service version it supports. When an optional property or new operation is added to a service and its Swagger, new client libraries must be produced to expose this functionality to customers. Without updating the api-version, it is unclear to customers which version of a client library supports these new features.

    This was referenced Mar 16, 2021
    Draft
    Draft
    Draft
    @openapi-sdkautomation openapi-sdkautomation bot mentioned this pull request Mar 16, 2021
    Draft
    @Khushboo-Baheti
    Copy link
    Member Author

    @lirenhe Can you please look into this.

    @lirenhe
    Copy link
    Member

    lirenhe commented Mar 17, 2021

    @Khushboo-Baheti, the PR for NRP is usually created for the monthly release branch but your PR is about updating0 an existing API version. Is there any specific reason for it?

    @Khushboo-Baheti
    Copy link
    Member Author

    [@Khushboo-Baheti, the PR for NRP is usually created for the monthly release branch but your PR is about updating0 an existing API version. Is there any specific reason for it?] - @lirenhe I have created this PR as per this message in teams channel [3/11 11:41 AM] Mikhail TriakhovImportant!
    Hey guys Swagger-SDK-PowerShell-CLI
    We've found regressions regarding 2021-01-01 version. It's not deployed from NRP and won't be part of NRP 154.
    So we would leave the same 11-01 api version for manifest update in NRP 154 and would wait for the next api version in NRP 155 (2021-02-01).
    So please guys who made PR
    s for our january branch - please move your changes for master or wait for our february branch and merge it for correct version 2021-02-01 instead of previous one.

    network-february-release branch was not cut at the time I created this PR. But now I have created this below PR targeting Azure:network-february-release. #13481
    Can you please review this new PR. We can close this PR.

    @lirenhe lirenhe closed this Mar 18, 2021
    @lirenhe
    Copy link
    Member

    lirenhe commented Mar 18, 2021

    Close this one as the new PR for network-february-release branch was created

    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Reviewers

    @MikhailTryakhov MikhailTryakhov Awaiting requested review from MikhailTryakhov

    Assignees

    @lirenhe lirenhe

    Labels
    CI-BreakingChange-Go Network Reviewed-FeedbackProvided WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required
    Projects
    None yet
    Milestone
    No milestone
    Development

    Successfully merging this pull request may close these issues.
    2 participants
    @Khushboo-Baheti @lirenhe