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

Adding the toplevel resource for querying the onboarded resources #15230

Merged
merged 18 commits into from
Jul 20, 2021

Conversation

harics24
Copy link
Contributor

This resource definition is for the top level readonly endpoint that serves the list of perimeter associable resources (resources/RPs that are onboarded to use the network security perimeter feature).

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.

harics24 and others added 7 commits March 19, 2021 19:49
Taking latest from upstream
Adding the definition of the new location based endpoint for getting the list of resources onboarded to use the network security perimeter feature.
Adding the example response for the resource endpoint
@openapi-workflow-bot
Copy link

[Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks.

@openapi-workflow-bot
Copy link

Hi, @harics24 your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com).

@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 Jul 16, 2021
@ghost ghost added the Network label Jul 16, 2021
@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Jul 16, 2021

Swagger Validation Report

️❌BreakingChange: 1 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/preview/2021-03-01-preview/networkSecurityPerimeter.json#L241:5
️🔄LintDiff inProgress [Detail]
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️Cross-Version Breaking Changes succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️❌[Staging] SDK Track2 Validation: 2 Errors, 3 Warnings failed [Detail]
The following errors/warnings are introduced by current PR:
Rule Message
PreCheck/DuplicateSchema "readme":"network/resource-manager/readme.md",
"tag":"package-2021-03-preview",
"details":"Duplicate Schema named CloudError -- properties.error.$ref: undefined => "#/components/schemas/schemas:3896" ; This error can be temporarily avoided by using the 'modelerfour.lenient-model-deduplication' setting. NOTE: This setting will be removed in a future version of @autorest/modelerfour; schemas should be updated to fix this issue sooner than that."
PreCheck/DuplicateSchema "readme":"network/resource-manager/readme.md",
"tag":"package-2021-03-preview",
"details":"Duplicate Schema named CloudErrorBody -- properties.details.$ref: undefined => "#/components/schemas/schemas:3900" ; This error can be temporarily avoided by using the 'modelerfour.lenient-model-deduplication' setting. NOTE: This setting will be removed in a future version of @autorest/modelerfour; schemas should be updated to fix this issue sooner than that."
⚠️ PreCheck/PropertyRedeclarationWarning "readme":"network/resource-manager/readme.md",
"tag":"package-2021-03-preview",
"details":"Schema 'PerimeterAssociableResource' has a property 'id' that is already declared the parent schema 'Resource' but 'readonly' has been changed -- this is not permitted. The property has been removed from PerimeterAssociableResource"
⚠️ PreCheck/PropertyRedeclarationWarning "readme":"network/resource-manager/readme.md",
"tag":"package-2021-03-preview",
"details":"Schema 'PerimeterAssociableResource' has a property 'name' that is already declared the parent schema 'Resource' but 'readonly' has been changed -- this is not permitted. The property has been removed from PerimeterAssociableResource"
⚠️ PreCheck/PropertyRedeclarationWarning "readme":"network/resource-manager/readme.md",
"tag":"package-2021-03-preview",
"details":"Schema 'PerimeterAssociableResource' has a property 'type' that is already declared the parent schema 'Resource' but isn't significantly different. The property has been removed from PerimeterAssociableResource"
💬 AutorestCore/Exception "readme":"network/resource-manager/readme.md",
"tag":"package-2021-03-preview",
"details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"
💬 AutorestCore/Exception "readme":"network/resource-manager/readme.md",
"tag":"package-2021-03-preview",
"details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"


The following errors/warnings exist before current PR submission:

Rule Message
AutorestCore/Exception "readme":"network/resource-manager/readme.md",
"tag":"package-2021-03-preview",
"details":"Error: Plugin prechecker reported failure."
⚠️ PreCheck/PropertyRedeclarationWarning "readme":"network/resource-manager/readme.md",
"tag":"package-2021-03-preview",
"details":"Schema 'NetworkSecurityPerimeter' has a property 'id' that is already declared the parent schema 'Resource' but 'readonly' has been changed -- this is not permitted. The property has been removed from NetworkSecurityPerimeter"
⚠️ PreCheck/PropertyRedeclarationWarning "readme":"network/resource-manager/readme.md",
"tag":"package-2021-03-preview",
"details":"Schema 'NetworkSecurityPerimeter' has a property 'name' that is already declared the parent schema 'Resource' but 'readonly' has been changed -- this is not permitted. The property has been removed from NetworkSecurityPerimeter"
⚠️ PreCheck/PropertyRedeclarationWarning "readme":"network/resource-manager/readme.md",
"tag":"package-2021-03-preview",
"details":"Schema 'NetworkSecurityPerimeter' has a property 'type' that is already declared the parent schema 'Resource' but isn't significantly different. The property has been removed from NetworkSecurityPerimeter"
⚠️ PreCheck/PropertyRedeclarationWarning "readme":"network/resource-manager/readme.md",
"tag":"package-2021-03-preview",
"details":"Schema 'ResourceNavigationLink' has a property 'id' that is already declared the parent schema 'SubResource' but 'readonly' has been changed -- this is not permitted. The property has been removed from ResourceNavigationLink"
⚠️ PreCheck/PropertyRedeclarationWarning "readme":"network/resource-manager/readme.md",
"tag":"package-2021-03-preview",
"details":"Schema 'VpnServerConfiguration' has a property 'name' that is already declared the parent schema 'Resource' but 'readonly' has been changed -- this is not permitted. The property has been removed from VpnServerConfiguration"
💬 AutorestCore/Exception "readme":"network/resource-manager/readme.md",
"tag":"package-2021-03-preview",
"details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"
️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️[Staging] Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Jul 16, 2021

Swagger Generation Artifacts

️️✔️[Staging] ApiDocPreview succeeded [Detail] [Expand]
 Please click here to preview with your @microsoft account. 
️❌[Staging] SDK Breaking Change Tracking failed [Detail]

Breaking Changes Tracking

️✔️azure-sdk-for-python-track2 - track2_azure-mgmt-network - 19.0.0
️✔️azure-sdk-for-go - network/mgmt/2021-02-01/network - v55.7.0
️✔️azure-sdk-for-go - network/mgmt/2020-11-01/network - v55.7.0
azure-sdk-for-go - network/mgmt/2020-08-01/network - v55.7.0
+	Field `ExtendedLocation` of struct `VirtualNetworkGatewayPropertiesFormat` has been removed
+	Field `VirtualNetworkExtendedLocationResourceID` of struct `VirtualNetworkGatewayPropertiesFormat` has been removed
+	Type of `SubnetPropertiesFormat.PrivateEndpointNetworkPolicies` has been changed from `*string` to `VirtualNetworkPrivateEndpointNetworkPolicies`
+	Type of `SubnetPropertiesFormat.PrivateLinkServiceNetworkPolicies` has been changed from `*string` to `VirtualNetworkPrivateLinkServiceNetworkPolicies`
azure-sdk-for-go - network/mgmt/2020-07-01/network - v55.7.0
+	Field `ExtendedLocation` of struct `VirtualNetworkGatewayPropertiesFormat` has been removed
+	Field `VirtualNetworkExtendedLocationResourceID` of struct `VirtualNetworkGatewayPropertiesFormat` has been removed
+	Type of `SubnetPropertiesFormat.PrivateEndpointNetworkPolicies` has been changed from `*string` to `VirtualNetworkPrivateEndpointNetworkPolicies`
+	Type of `SubnetPropertiesFormat.PrivateLinkServiceNetworkPolicies` has been changed from `*string` to `VirtualNetworkPrivateLinkServiceNetworkPolicies`
️✔️azure-sdk-for-go - network/mgmt/2020-06-01/network - v55.7.0
️✔️azure-sdk-for-go - network/mgmt/2020-05-01/network - v55.7.0
️✔️azure-sdk-for-go - network/mgmt/2020-04-01/network - v55.7.0
️✔️azure-sdk-for-go - network/mgmt/2020-03-01/network - v55.7.0
️✔️azure-sdk-for-go - network/mgmt/2019-12-01/network - v55.7.0
️✔️azure-sdk-for-go - network/mgmt/2019-11-01/network - v55.7.0
️✔️azure-sdk-for-go - network/mgmt/2019-09-01/network - v55.7.0
️✔️azure-sdk-for-go - network/mgmt/2019-08-01/network - v55.7.0
️✔️azure-sdk-for-go - network/mgmt/2019-07-01/network - v55.7.0
️✔️azure-sdk-for-go - network/mgmt/2019-06-01/network - v55.7.0
️✔️azure-sdk-for-go - network/mgmt/2019-04-01/network - v55.7.0
️✔️azure-sdk-for-go - network/mgmt/2019-02-01/network - v55.7.0
️✔️azure-sdk-for-go - network/mgmt/2018-12-01/network - v55.7.0
️✔️azure-sdk-for-go - network/mgmt/2018-11-01/network - v55.7.0
️✔️azure-sdk-for-go - network/mgmt/2018-10-01/network - v55.7.0
️✔️azure-sdk-for-go - network/mgmt/2018-08-01/network - v55.7.0
️✔️azure-sdk-for-go - network/mgmt/2018-07-01/network - v55.7.0
️✔️azure-sdk-for-go - network/mgmt/2018-06-01/network - v55.7.0
️✔️azure-sdk-for-go - network/mgmt/2018-04-01/network - v55.7.0
️✔️azure-sdk-for-go - network/mgmt/2018-02-01/network - v55.7.0
️✔️azure-sdk-for-go - network/mgmt/2018-01-01/network - v55.7.0
️✔️azure-sdk-for-go - network/mgmt/2017-11-01/network - v55.7.0
️✔️azure-sdk-for-go - network/mgmt/2017-10-01/network - v55.7.0
️✔️azure-sdk-for-go - network/mgmt/2017-09-01/network - v55.7.0
️✔️azure-sdk-for-go - network/mgmt/2017-08-01/network - v55.7.0
️✔️azure-sdk-for-go - network/mgmt/2017-06-01/network - v55.7.0
️✔️azure-sdk-for-go - network/mgmt/2017-03-01/network - v55.7.0
️✔️azure-sdk-for-go - network/mgmt/2016-12-01/network - v55.7.0
️✔️azure-sdk-for-go - network/mgmt/2016-09-01/network - v55.7.0
️✔️azure-sdk-for-go - network/mgmt/2016-06-01/network - v55.7.0
️✔️azure-sdk-for-go - network/mgmt/2016-03-30/network - v55.7.0
️✔️azure-sdk-for-go - network/mgmt/2015-06-15/network - v55.7.0
️✔️azure-sdk-for-go - preview/network/mgmt/2015-05-01-preview/network - v55.7.0
️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs]Release - Generate from 83453ca. 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]  [Release SDK Changes]
️⚠️ azure-sdk-for-python-track2 warning [Detail]
️⚠️ azure-sdk-for-java warning [Detail]
  • ⚠️Warning [Logs]Release - Generate from 83453ca. 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-07-20 08:18:21 INFO [VERSION][Not Found] cannot find version for "com.azure.resourcemanager:azure-resourcemanager-network-generated"
    cmderr	[generate.py] 2021-07-20 08:18:21 INFO [VERSION][Not Found] cannot find stable version, current version "1.0.0-beta.1"
    cmderr	[generate.py] 2021-07-20 08:18:21 INFO autorest --version=3.4.5 --use=@autorest/java@4.0.33 --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-07-20 08:21:59 INFO [CI][Success] Write to ci.yml
    cmderr	[generate.py] 2021-07-20 08:21:59 INFO [POM][Process] dealing with pom.xml
    cmderr	[generate.py] 2021-07-20 08:21:59 INFO [POM][Skip] pom already has module azure-resourcemanager-network-generated
    cmderr	[generate.py] 2021-07-20 08:21:59 INFO [POM][Success] Write to pom.xml
    cmderr	[generate.py] 2021-07-20 08:21:59 INFO [POM][Process] dealing with root pom
    cmderr	[generate.py] 2021-07-20 08:21:59 INFO [POM][Success] Write to root pom
  • ️✔️azure-resourcemanager-network-generated [View full logs]  [Release SDK Changes]
    cmderr	[Inst] 2021-07-20 08:28:47 DEBUG Got artifact_id: azure-resourcemanager-network-generated
    cmderr	[Inst] 2021-07-20 08:28:47 DEBUG Got artifact: pom.xml
    cmderr	[Inst] 2021-07-20 08:28:47 DEBUG Got artifact: azure-resourcemanager-network-generated-1.0.0-beta.1.jar
    cmderr	[Inst] 2021-07-20 08:28:47 DEBUG Match jar package: azure-resourcemanager-network-generated-1.0.0-beta.1.jar
    cmderr	[Inst] 2021-07-20 08:28:47 DEBUG output: {"full": "```sh\ncurl -L \"https://portal.azure-devex-tools.com/api/sdk-dl-pub?p=Azure/15230/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]
  • ️✔️Succeeded [Logs]Release - Generate from 83453ca. SDK Automation 14.0.0
    command	sh ./initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
    command	generator automation ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
  • ️✔️network/mgmt/2021-02-01/network [View full logs]  [Release SDK Changes]
    info	[Changelog] No exported changes
  • ️✔️network/mgmt/2020-11-01/network [View full logs
    info	[Changelog] No exported changes
  • ️✔️network/mgmt/2020-08-01/network [View full logsBreaking Change Detected
    Only show 4 items here, please refer to log for details.
    info	[Changelog] - New field `Type` in struct `Delegation`
    info	[Changelog]
    info	[Changelog] Total 2 breaking change(s), 35 additive change(s).
    info	[Changelog]
  • ️✔️network/mgmt/2020-07-01/network [View full logsBreaking Change Detected
    Only show 4 items here, please refer to log for details.
    info	[Changelog] - New field `MigrationPhase` in struct `PublicIPAddressPropertiesFormat`
    info	[Changelog]
    info	[Changelog] Total 2 breaking change(s), 27 additive change(s).
    info	[Changelog]
  • ️✔️network/mgmt/2020-06-01/network [View full logs
    info	[Changelog] No exported changes
  • ️✔️network/mgmt/2020-05-01/network [View full logs
    info	[Changelog] No exported changes
  • ️✔️network/mgmt/2020-04-01/network [View full logs
    info	[Changelog] No exported changes
  • ️✔️network/mgmt/2020-03-01/network [View full logs
    info	[Changelog] No exported changes
  • ️✔️network/mgmt/2019-12-01/network [View full logs
    info	[Changelog] No exported changes
  • ️✔️network/mgmt/2019-11-01/network [View full logs
    info	[Changelog] No exported changes
  • ️✔️network/mgmt/2019-09-01/network [View full logs
    info	[Changelog] No exported changes
  • ️✔️network/mgmt/2019-08-01/network [View full logs
    info	[Changelog] No exported changes
  • ️✔️network/mgmt/2019-07-01/network [View full logs
    info	[Changelog] No exported changes
  • ️✔️network/mgmt/2019-06-01/network [View full logs
    info	[Changelog] No exported changes
  • ️✔️network/mgmt/2019-04-01/network [View full logs
    info	[Changelog] No exported changes
  • ️✔️network/mgmt/2019-02-01/network [View full logs
    info	[Changelog] No exported changes
  • ️✔️network/mgmt/2018-12-01/network [View full logs
    info	[Changelog] No exported changes
  • ️✔️network/mgmt/2018-11-01/network [View full logs
    info	[Changelog] No exported changes
  • ️✔️network/mgmt/2018-10-01/network [View full logs
    info	[Changelog] No exported changes
  • ️✔️network/mgmt/2018-08-01/network [View full logs
    info	[Changelog] No exported changes
  • ️✔️network/mgmt/2018-07-01/network [View full logs
    info	[Changelog] No exported changes
  • ️✔️network/mgmt/2018-06-01/network [View full logs
    info	[Changelog] No exported changes
  • ️✔️network/mgmt/2018-04-01/network [View full logs
    info	[Changelog] No exported changes
  • ️✔️network/mgmt/2018-02-01/network [View full logs
    info	[Changelog] No exported changes
  • ️✔️network/mgmt/2018-01-01/network [View full logs
    info	[Changelog] No exported changes
  • ️✔️network/mgmt/2017-11-01/network [View full logs
    info	[Changelog] No exported changes
  • ️✔️network/mgmt/2017-10-01/network [View full logs
    info	[Changelog] No exported changes
  • ️✔️network/mgmt/2017-09-01/network [View full logs
    info	[Changelog] No exported changes
  • ️✔️network/mgmt/2017-08-01/network [View full logs
    info	[Changelog] No exported changes
  • ️✔️network/mgmt/2017-06-01/network [View full logs
    info	[Changelog] No exported changes
  • ️✔️network/mgmt/2017-03-01/network [View full logs
    info	[Changelog] No exported changes
  • ️✔️network/mgmt/2016-12-01/network [View full logs
    info	[Changelog] No exported changes
  • ️✔️network/mgmt/2016-09-01/network [View full logs
    info	[Changelog] No exported changes
  • ️✔️network/mgmt/2016-06-01/network [View full logs
    info	[Changelog] No exported changes
  • ️✔️network/mgmt/2016-03-30/network [View full logs
    info	[Changelog] No exported changes
  • ️✔️network/mgmt/2015-06-15/network [View full logs
    info	[Changelog] No exported changes
  • ️✔️preview/network/mgmt/2015-05-01-preview/network [View full logs
    info	[Changelog] No exported changes
️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs]Release - Generate from 83453ca. 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.7.0 --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]  [Release 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.7s
️⚠️ azure-resource-manager-schemas warning [Detail]
  • ⚠️Warning [Logs]Release - Generate from 83453ca. Schema Automation 14.0.0
    command	.sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json
    cmderr	[initScript.sh] WARN old lockfile
    cmderr	[initScript.sh] npm WARN old lockfile The package-lock.json file was created with an old version of npm,
    cmderr	[initScript.sh] npm WARN old lockfile so supplemental metadata must be fetched from the registry.
    cmderr	[initScript.sh] npm WARN old lockfile
    cmderr	[initScript.sh] npm WARN old lockfile This is a one-time fix-up, please be patient...
    cmderr	[initScript.sh] npm WARN old lockfile
    warn	File azure-resource-manager-schemas_tmp/initOutput.json not found to read
    command	.sdkauto/generateScript.sh ../azure-resource-manager-schemas_tmp/generateInput.json ../azure-resource-manager-schemas_tmp/generateOutput.json
    warn	No file changes detected after generation
    warn	Skip detect changed packages
Posted by Swagger Pipeline | How to fix these errors?

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

@openapi-workflow-bot
Copy link

Hi @harics24, 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.

@mentat9
Copy link
Member

mentat9 commented Jul 17, 2021

@harics24, this change is adding new Uri paths to an existing API version which is a breaking change. Current automation is failing to correctly add the BreakingChangeReviewRequired label (actually it incorrectly removed it in this case). I've added it back. Please follow the instructions to get a breaking change review. After you have breaking change signoff, send an email to armapireview group so the current oncall can pick up the review.

@harics24
Copy link
Contributor Author

harics24 commented Jul 19, 2021

@lirenhe , I see 3 failures:

1). https://github.com/Azure/azure-rest-api-specs/pull/15230/checks?check_run_id=3088578737:
This is a preview version and we want all the resources to go in the same version.

2). https://github.com/Azure/azure-rest-api-specs/pull/15230/checks?check_run_id=3088578981:
Not related to the changes I made.

3). https://github.com/Azure/azure-rest-api-specs/pull/15230/checks?check_run_id=3088578904:
Duplicate definitions. Not sure how can I avoid them. Please help me if I need to fix them.

@harics24
Copy link
Contributor Author

@harics24, this change is adding new Uri paths to an existing API version which is a breaking change. Current automation is failing to correctly add the BreakingChangeReviewRequired label (actually it incorrectly removed it in this case). I've added it back. Please follow the instructions to get a breaking change review. After you have breaking change signoff, send an email to armapireview group so the current oncall can pick up the review.

Hi @mentat9 , this is a new service/endpoint and had never been exposed. There are no users. We are working on the very first version. We need the endpoints to be available through ARM. So, we had initiated the changes in manifest. The ARM had requested for swagger PR. This PR for the same. There's not really anything that we're breaking.

@mentat9
Copy link
Member

mentat9 commented Jul 19, 2021

OK, please work with this week's oncall @majastrz to get this API reviewed.

@JeffreyRichter JeffreyRichter added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Jul 19, 2021
@majastrz majastrz added ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review and removed WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Jul 20, 2021
Copy link
Member

@majastrz majastrz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Signed off from ARM side.

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 ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review CI-BreakingChange-Go Network
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants