Skip to content

VPN NAT for Virtual Network Gateway feature changes #13318

Closed
Khushboo-Baheti wants to merge 4 commits intoAzure:network-november-releasefrom
Khushboo-Baheti:natVng
Closed

VPN NAT for Virtual Network Gateway feature changes #13318
Khushboo-Baheti wants to merge 4 commits intoAzure:network-november-releasefrom
Khushboo-Baheti:natVng

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
    • 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.

Khushboo-Baheti and others added 2 commits March 1, 2021 09:54
@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. vsswagger@microsoft.com

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Mar 8, 2021

    Swagger Validation Report

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

    Rule Message
    1033 - RemovedProperty The new version is missing a property found in the old version. Was 'vNetExtendedLocationResourceId' renamed or removed?
    New: Microsoft.Network/stable/2020-11-01/virtualNetworkGateway.json#L2721:7
    Old: Microsoft.Network/stable/2020-11-01/virtualNetworkGateway.json#L2389:7
    1033 - RemovedProperty The new version is missing a property found in the old version. Was 'virtualNetworkExtendedLocation' renamed or removed?
    New: Microsoft.Network/stable/2020-11-01/virtualNetworkGateway.json#L2721:7
    Old: Microsoft.Network/stable/2020-11-01/virtualNetworkGateway.json#L2389:7
    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
    ️️✔️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.
    ️⚠️[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?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Mar 8, 2021

    Swagger Generation Artifacts

    ️🔄[Staging] ApiDocPreview inProgress [Detail]
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs] Generate from 24a4624f9b82e05dc33a98819f1071721b34c298. 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-08 15:16:29 INFO [VERSION][Not Found] cannot find version for "com.azure.resourcemanager:azure-resourcemanager-network-generated"
      cmderr	[generate.py] 2021-03-08 15:16:29 INFO [VERSION][Not Found] cannot find stable version, current version "1.0.0-beta.1"
      cmderr	[generate.py] 2021-03-08 15:16:29 INFO autorest --version=3.1.0 --use=@autorest/java@4.0.19 --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-08 15:19:49 INFO [CI][Success] Write to ci.yml
      cmderr	[generate.py] 2021-03-08 15:19:49 INFO [POM][Process] dealing with pom.xml
      cmderr	[generate.py] 2021-03-08 15:19:49 INFO [POM][Skip] pom already has module azure-resourcemanager-network-generated
      cmderr	[generate.py] 2021-03-08 15:19:49 INFO [POM][Success] Write to pom.xml
      cmderr	[generate.py] 2021-03-08 15:19:49 INFO [POM][Process] dealing with root pom
      cmderr	[generate.py] 2021-03-08 15:19:49 INFO [POM][Success] Write to root pom
    • ️✔️azure-resourcemanager-network-generated [View full logs]  [Preview SDK Changes]
      cmderr	[Inst] 2021-03-08 15:26:06 DEBUG Got artifact_id: azure-resourcemanager-network-generated
      cmderr	[Inst] 2021-03-08 15:26:06 DEBUG Got artifact: pom.xml
      cmderr	[Inst] 2021-03-08 15:26:06 DEBUG Got artifact: azure-resourcemanager-network-generated-1.0.0-beta.1-sources.jar
      cmderr	[Inst] 2021-03-08 15:26:06 DEBUG Got artifact: azure-resourcemanager-network-generated-1.0.0-beta.1-javadoc.jar
      cmderr	[Inst] 2021-03-08 15:26:06 DEBUG Got artifact: azure-resourcemanager-network-generated-1.0.0-beta.1.jar
      cmderr	[Inst] 2021-03-08 15:26:06 DEBUG Match jar package: azure-resourcemanager-network-generated-1.0.0-beta.1.jar
      cmderr	[Inst] 2021-03-08 15:26:06 DEBUG output: {"full": "```sh\ncurl -L \"https://portal.azure-devex-tools.com/api/sdk-dl-pub?p=Azure/13318/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-go succeeded [Detail] [Expand]
    ️️✔️ azure-resource-manager-schemas succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from 24a4624f9b82e05dc33a98819f1071721b34c298. Schema Automation 14.0.0
      warn	Skip initScript due to not configured
      command	npx n 12
      command	autorest --use=@autorest/azureresourceschema@3.0.92 --version=3.0.6374 --azureresourceschema --multiapi --title=none --pass-thru:subset-reducer --azureresourceschema-folder=/home/vsts/work/1/s/azure-resource-manager-schemas/azure-resource-manager-schemas ../../azure-rest-api-specs/specification/network/resource-manager/readme.md
    • ️✔️network [View full logs]  [Preview Schema Changes]
      cmderr	[resource-manager] node-pre-gyp
      cmderr	[resource-manager] WARN
      cmderr	[resource-manager] Using request for node-pre-gyp https download
      cmderr	[resource-manager]  template-schema-validation-tools@1.0.0 No repository field.
      cmderr	[resource-manager]  SKIPPING OPTIONAL DEPENDENCY: fsevents@2.1.3 (node_modules/fsevents):
      cmderr	[resource-manager] npm WARN notsup SKIPPING OPTIONAL DEPENDENCY: Unsupported platform for fsevents@2.1.3: wanted {"os":"darwin","arch":"any"} (current: {"os":"linux","arch":"x64"})
      cmderr	[resource-manager] npm ERR! code ELIFECYCLE
      cmderr	[resource-manager] npm ERR! errno 255
      cmderr	[resource-manager] npm ERR! template-schema-validation-tools@1.0.0 test: `mocha -r ts-node/register tests.ts`
      cmderr	[resource-manager] npm ERR! Exit status 255
      cmderr	[resource-manager] npm ERR!
      cmderr	[resource-manager] npm ERR! Failed at the template-schema-validation-tools@1.0.0 test script.
      cmderr	[resource-manager] npm ERR! This is probably not a problem with npm. There is likely additional logging output above.
      cmderr	[resource-manager] npm ERR! A complete log of this run can be found in:
      cmderr	[resource-manager] npm ERR!     /home/vsts/.npm/_logs/2021-03-08T17_08_06_425Z-debug.log
      cmderr	[resource-manager] Error: Command failed: npm run test --prefix tools
      cmderr	[resource-manager]     at checkExecSyncError (child_process.js:635:11)
      cmderr	[resource-manager]     at Object.execSync (child_process.js:671:15)
      cmderr	[resource-manager]     at Object.<anonymous> (/home/vsts/work/1/s/azure-resource-manager-schemas/azure-resource-manager-schemas/sdkauto_afterscript.js:13:28)
      cmderr	[resource-manager]     at Module._compile (internal/modules/cjs/loader.js:999:30)
      cmderr	[resource-manager]     at Object.Module._extensions..js (internal/modules/cjs/loader.js:1027:10)
      cmderr	[resource-manager]     at Module.load (internal/modules/cjs/loader.js:863:32)
      cmderr	[resource-manager]     at Function.Module._load (internal/modules/cjs/loader.js:708:14)
      cmderr	[resource-manager]     at Function.executeUserEntryPoint [as runMain] (internal/modules/run_main.js:60:12)
      cmderr	[resource-manager]     at internal/main/run_main_module.js:17:47 {
      cmderr	[resource-manager]   status: 255,
      cmderr	[resource-manager]   signal: null,
      cmderr	[resource-manager]   output: [ null, null, null ],
      cmderr	[resource-manager]   pid: 8170,
      cmderr	[resource-manager]   stdout: null,
      cmderr	[resource-manager]   stderr: null
      cmderr	[resource-manager] }
    ️⚠️ azure-sdk-for-python warning [Detail]
    • ⚠️Warning [Logs] Generate from 24a4624f9b82e05dc33a98819f1071721b34c298. 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
    • ️✔️azure-mgmt-network [View full logs]  [Preview SDK Changes] Breaking Change Detected
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Model Route has a new parameter has_bgp_override
      info	[Changelog]   - Model Route has a new parameter type
      info	[Changelog]   - Model BackendAddressPool has a new parameter location
      info	[Changelog]   - Model SecurityRule has a new parameter type
      info	[Changelog]   - Model CustomIpPrefix has a new parameter extended_location
      info	[Changelog]   - Model PrivateLinkService has a new parameter extended_location
      info	[Changelog]   - Model VpnGateway has a new parameter nat_rules
      info	[Changelog]   - Model VpnSiteLinkConnection has a new parameter vpn_link_connection_mode
      info	[Changelog]   - Model VpnSiteLinkConnection has a new parameter egress_nat_rules
      info	[Changelog]   - Model VpnSiteLinkConnection has a new parameter ingress_nat_rules
      info	[Changelog]   - Model PrivateEndpoint has a new parameter extended_location
      info	[Changelog]   - Model RouteTable has a new parameter resource_guid
      info	[Changelog]   - Model VirtualNetworkGateway has a new parameter v_net_extended_location_resource_id
      info	[Changelog]   - Model VirtualNetworkGateway has a new parameter virtual_network_extended_location
      info	[Changelog]   - Added operation NetworkInterfacesOperations.list_cloud_service_role_instance_network_interfaces
      info	[Changelog]   - Added operation NetworkInterfacesOperations.list_cloud_service_network_interfaces
      info	[Changelog]   - Added operation NetworkInterfacesOperations.get_cloud_service_network_interface
      info	[Changelog]   - Added operation VirtualNetworkGatewayConnectionsOperations.get_ike_sas
      info	[Changelog]   - Added operation PublicIPAddressesOperations.list_cloud_service_role_instance_public_ip_addresses
      info	[Changelog]   - Added operation PublicIPAddressesOperations.list_cloud_service_public_ip_addresses
      info	[Changelog]   - Added operation PublicIPAddressesOperations.get_cloud_service_public_ip_address
      info	[Changelog]   - Added operation ExpressRouteGatewaysOperations.update_tags
      info	[Changelog]   - Added operation group NatRulesOperations
      info	[Changelog]
      info	[Changelog] **Breaking changes**
      info	[Changelog]
      info	[Changelog]   - Model VirtualNetworkPeering no longer has parameter peering_sync_level
      info	[Changelog]   - Model VirtualNetworkPeering no longer has parameter remote_virtual_network_address_space
      info	[Changelog]   - Model VirtualNetworkPeering no longer has parameter sync_remote_address_space
      info	[Changelog]   - Model VirtualNetworkGateway no longer has parameter extended_location
      info	[Changelog]   - Model VirtualNetworkGateway no longer has parameter virtual_network_extended_location_resource_id
    ️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from 24a4624f9b82e05dc33a98819f1071721b34c298. 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 --use=@microsoft.azure/autorest.csharp@2.3.82 --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 24a4624f9b82e05dc33a98819f1071721b34c298. 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] Breaking Change Detected
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Model VirtualNetworkGateway has a new parameter v_net_extended_location_resource_id
      info	[Changelog]   - Model VirtualNetworkGateway has a new parameter virtual_network_extended_location
      info	[Changelog]
      info	[Changelog] **Breaking changes**
      info	[Changelog]
      info	[Changelog]   - Model VirtualNetworkGateway no longer has parameter virtual_network_extended_location_resource_id
      info	[Changelog]   - Model VirtualNetworkGateway no longer has parameter extended_location
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from 24a4624f9b82e05dc33a98819f1071721b34c298. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      command	autorest --version=V2 --typescript --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.typescript@4.4.4 --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 3s
    Posted by Swagger Pipeline | How to fix these errors?

    @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(armapireview@microsoft.com). cc @

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

    Hi @Khushboo-Baheti, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff.

    TaskHow to fixPrioritySupport (Microsoft alias)
    AvocadoFix-AvocadoHighruowan
    Semantic validationFix-SemanticValidation-ErrorHighraychen, jianyxi
    Model validationFix-ModelValidation-ErrorHighraychen,jianyxi
    LintDiffFix-LintDiffhighjianyxi, ruoxuan
    If you need further help, please feedback via swagger feedback."

    @openapi-workflow-bot
    Copy link

    Hi @Khushboo-Baheti, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review.
    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.
    If you want to know the production traffic statistic, please see ARM Traffic statistic.
    If you think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ms/swaggerfeedback.

    @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.

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

    Labels

    CI-BreakingChange-Go CI-BreakingChange-Python Network WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required

    Projects

    None yet

    Development

    Successfully merging this pull request may close these issues.

    2 participants