Adding trusted ranges as an optional field by osid29 · Pull Request #25649 · Azure/azure-rest-api-specs

osid29 · 2023-09-05T05:12:15Z

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.

[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:
- edit this with your clarification

Due diligence checklist

To merge this PR, you must go through the following checklist and confirm you understood
and followed the instructions by checking all the boxes:

I confirm this PR is modifying Azure Resource Manager (ARM) related specifications, and not data plane related specifications.
I have reviewed following Resource Provider guidelines, including
ARM resource provider contract and
REST guidelines (estimated time: 4 hours).
I understand this is required before I can proceed to Step 2, "ARM Review", for this PR.

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

For general PR approval workflow, see the diagram at the top of this comment.
For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure
and https://aka.ms/ci-fix.
If the help provided by the previous points is not enough, post to https://aka.ms/azsdk/support/specreview-channel and link to this PR.

openapi-pipeline-app · 2023-09-05T05:12:18Z

Next Steps to Merge

⚠️ This is an experimental comment. It may not always be up-to-date. ⚠️

✔️ 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 · 2023-09-05T05:12:19Z

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]

There are no breaking changes.

compared swaggers (via Oad v0.10.4)]	new version	base version
PaloAltoNetworks.Cloudngfw.json	2023-09-01-preview(a9d8d15)	2022-08-29(main)
PaloAltoNetworks.Cloudngfw.json	2023-09-01-preview(a9d8d15)	2022-08-29-preview(main)

️️✔️CredScan succeeded [Detail] [Expand]

There is no credential detected.

️️✔️LintDiff succeeded [Detail]

compared tags (via openapi-validator v2.1.4)	new version	base version
package-2023-09-01-preview	package-2023-09-01-preview(a9d8d15)	default(main)

The following errors/warnings exist before current PR submission:

Rule	Message
`❌` DescriptionMustNotBeNodeName	Description must not match the name of the node it is supposed to describe. Node name:'title' Description:'title' Location: PaloAltoNetworks.Cloudngfw/preview/2023-09-01-preview/PaloAltoNetworks.Cloudngfw.json#L4544
`❌` DescriptionMustNotBeNodeName	Description must not match the name of the node it is supposed to describe. Node name:'category' Description:'category' Location: PaloAltoNetworks.Cloudngfw/preview/2023-09-01-preview/PaloAltoNetworks.Cloudngfw.json#L4548
`❌` DescriptionMustNotBeNodeName	Description must not match the name of the node it is supposed to describe. Node name:'subCategory' Description:'subCategory' Location: PaloAltoNetworks.Cloudngfw/preview/2023-09-01-preview/PaloAltoNetworks.Cloudngfw.json#L4552
`❌` DescriptionMustNotBeNodeName	Description must not match the name of the node it is supposed to describe. Node name:'risk' Description:'risk' Location: PaloAltoNetworks.Cloudngfw/preview/2023-09-01-preview/PaloAltoNetworks.Cloudngfw.json#L4556
`❌` DescriptionMustNotBeNodeName	Description must not match the name of the node it is supposed to describe. Node name:'tag' Description:'tag' Location: PaloAltoNetworks.Cloudngfw/preview/2023-09-01-preview/PaloAltoNetworks.Cloudngfw.json#L4560
`❌` DescriptionMustNotBeNodeName	Description must not match the name of the node it is supposed to describe. Node name:'technology' Description:'technology' Location: PaloAltoNetworks.Cloudngfw/preview/2023-09-01-preview/PaloAltoNetworks.Cloudngfw.json#L4564
`❌` DescriptionMustNotBeNodeName	Description must not match the name of the node it is supposed to describe. Node name:'standardPorts' Description:'standardPorts' Location: PaloAltoNetworks.Cloudngfw/preview/2023-09-01-preview/PaloAltoNetworks.Cloudngfw.json#L4568
`❌` TopLevelResourcesListBySubscription	The top-level resource 'GlobalRulestackResource' does not have list by subscription operation, please add it. Location: PaloAltoNetworks.Cloudngfw/preview/2023-09-01-preview/PaloAltoNetworks.Cloudngfw.json#L5525

️️✔️Avocado succeeded [Detail] [Expand]

Validation passes for Avocado.

️️✔️SwaggerAPIView succeeded [Detail] [Expand]

️️✔️TypeSpecAPIView succeeded [Detail] [Expand]

️️✔️ModelValidation succeeded [Detail] [Expand]

Validation passes for ModelValidation.

️️✔️SemanticValidation succeeded [Detail] [Expand]

Validation passes for SemanticValidation.

️️✔️PoliCheck succeeded [Detail] [Expand]

Validation passed for PoliCheck.

️️✔️PrettierCheck succeeded [Detail] [Expand]

Validation passes for PrettierCheck.

️️✔️SpellCheck succeeded [Detail] [Expand]

Validation passes for SpellCheck.

️️✔️Lint(RPaaS) succeeded [Detail] [Expand]

Validation passes for Lint(RPaaS).

️️✔️PR Summary succeeded [Detail] [Expand]

Validation passes for Summary.

️️✔️Automated merging requirements met succeeded [Detail] [Expand]

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-pipeline-app · 2023-09-05T05:12:20Z

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand]

 Please click here to preview with your @microsoft account.

️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]

Breaking Changes Tracking

️⚠️ azure-sdk-for-python-track2 warning [Detail]

⚠️Warning [Logs] Generate from 38c21cc0f6427d2b89fda4b2f39789d77ba20dfa. 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
cmderr	[automation_generate.sh]
cmderr	[automation_generate.sh] npm notice New major version of npm available! 9.6.7 -> 10.0.0
cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.0.0>
cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@10.0.0` to update!
cmderr	[automation_generate.sh] npm notice

️✔️track2_azure-mgmt-paloaltonetworksngfw [View full logs] [Preview SDK Changes]
- azure_mgmt_paloaltonetworksngfw-1.0.0b1-py3-none-any.whl
- azure-mgmt-paloaltonetworksngfw-1.0.0b1.zip
```
info	[Changelog]
```

️⚠️ azure-sdk-for-java warning [Detail]

⚠️Warning [Logs] Generate from 38c21cc0f6427d2b89fda4b2f39789d77ba20dfa. 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
cmderr	[init.sh] [notice] A new release of pip is available: 23.0.1 -> 23.2.1
cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
cmderr	[init.sh] [notice] A new release of pip is available: 23.0.1 -> 23.2.1
cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json

️✔️azure-resourcemanager-paloaltonetworks-ngfw [View full logs] [Preview SDK Changes]

️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]

️✔️Succeeded [Logs] Generate from 38c21cc0f6427d2b89fda4b2f39789d77ba20dfa. SDK Automation 14.0.0

command	sh ./eng/scripts/automation_init.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
command	generator automation-v2 ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json

️✔️sdk/resourcemanager/paloaltonetworksngfw/armpanngfw [View full logs] [Preview SDK Changes]

info	[Changelog] ### Other Changes
info	[Changelog]
info	[Changelog] Total 0 breaking change(s), 0 additive change(s).

️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]

️✔️Succeeded [Logs] Generate from 38c21cc0f6427d2b89fda4b2f39789d77ba20dfa. SDK Automation 14.0.0

command	sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json
warn	File azure-sdk-for-js_tmp/initOutput.json not found to read
command	sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json
cmderr	[automation_generate.sh] [ERROR] Cannot generate changelog because the codes of local and npm may be the same.

️✔️@azure/arm-paloaltonetworksngfw [View full logs] [Preview SDK Changes]
- azure-arm-paloaltonetworksngfw-1.0.1.tgz
```
info	[Changelog]
error	breakingChangeTracking is enabled, but version or changelogItem is not found in output.
```

️❌ azure-resource-manager-schemas failed [Detail]

❌Code Generator Failed [Logs] Generate from 38c21cc0f6427d2b89fda4b2f39789d77ba20dfa. 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]  ERR! code EBADENGINE
cmderr	[initScript.sh]  Unsupported engine
cmderr	[initScript.sh] npm ERR! engine Not compatible with your version of node/npm: npm@10.0.0
cmderr	[initScript.sh] npm ERR! notsup Not compatible with your version of node/npm: npm@10.0.0
cmderr	[initScript.sh] npm ERR! notsup Required: {"node":"^18.17.0 || >=20.5.0"}
cmderr	[initScript.sh] npm ERR! notsup Actual:   {"npm":"8.19.4","node":"v16.20.2"}
cmderr	[initScript.sh] ERR! A complete log of this run can be found in:
cmderr	[initScript.sh] npm ERR!     /home/cloudtest/.npm/_logs/2023-09-06T10_32_52_653Z-debug-0.log
error	Script return with result [failed] code [1] signal [null] cwd [azure-resource-manager-schemas]: .sdkauto/initScript.sh
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
cmderr	[generateScript.sh] /mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/ts-node@9.0.0_typescript@3.9.10/node_modules/ts-node/src/index.ts:500
cmderr	[generateScript.sh]     return new TSError(diagnosticText, diagnosticCodes)
cmderr	[generateScript.sh]            ^
cmderr	[generateScript.sh] TSError: ⨯ Unable to compile TypeScript:
cmderr	[generateScript.sh] cmd/generateall.ts(7,20): error TS2307: Cannot find module 'colors' or its corresponding type declarations.
cmderr	[generateScript.sh] cmd/generateall.ts(11,19): error TS2307: Cannot find module 'yargs' or its corresponding type declarations.
cmderr	[generateScript.sh] cmd/generateall.ts(12,18): error TS2307: Cannot find module 'path' or its corresponding type declarations.
cmderr	[generateScript.sh] cmd/generateall.ts(14,35): error TS2307: Cannot find module 'fs' or its corresponding type declarations.
cmderr	[generateScript.sh] cmd/generateall.ts(15,23): error TS2307: Cannot find module 'strip-ansi' or its corresponding type declarations.
cmderr	[generateScript.sh] cmd/generateall.ts(53,9): error TS2584: Cannot find name 'console'. Do you need to change your target library? Try changing the `lib` compiler option to include 'dom'.
cmderr	[generateScript.sh] cmd/generateall.ts(64,9): error TS2584: Cannot find name 'console'. Do you need to change your target library? Try changing the `lib` compiler option to include 'dom'.
cmderr	[generateScript.sh] cmd/generateall.ts(81,67): error TS7006: Parameter 'x' implicitly has an 'any' type.
cmderr	[generateScript.sh] cmd/generateall.ts(82,49): error TS7006: Parameter 'f' implicitly has an 'any' type.
cmderr	[generateScript.sh] cmd/generateall.ts(106,21): error TS2584: Cannot find name 'console'. Do you need to change your target library? Try changing the `lib` compiler option to include 'dom'.
cmderr	[generateScript.sh] cmd/generateall.ts(117,21): error TS2584: Cannot find name 'console'. Do you need to change your target library? Try changing the `lib` compiler option to include 'dom'.
cmderr	[generateScript.sh] cmd/generateall.ts(118,21): error TS2584: Cannot find name 'console'. Do you need to change your target library? Try changing the `lib` compiler option to include 'dom'.
cmderr	[generateScript.sh] cmd/generateall.ts(169,13): error TS2591: Cannot find name 'process'. Do you need to install type definitions for node? Try `npm i @types/node` and then add `node` to the types field in your tsconfig.
cmderr	[generateScript.sh]     at createTSError (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/ts-node@9.0.0_typescript@3.9.10/node_modules/ts-node/src/index.ts:500:12)
cmderr	[generateScript.sh]     at reportTSError (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/ts-node@9.0.0_typescript@3.9.10/node_modules/ts-node/src/index.ts:504:19)
cmderr	[generateScript.sh]     at getOutput (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/ts-node@9.0.0_typescript@3.9.10/node_modules/ts-node/src/index.ts:739:36)
cmderr	[generateScript.sh]     at Object.compile (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/ts-node@9.0.0_typescript@3.9.10/node_modules/ts-node/src/index.ts:955:32)
cmderr	[generateScript.sh]     at Module.m._compile (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/ts-node@9.0.0_typescript@3.9.10/node_modules/ts-node/src/index.ts:1043:43)
cmderr	[generateScript.sh]     at Module._extensions..js (node:internal/modules/cjs/loader:1252:10)
cmderr	[generateScript.sh]     at Object.require.extensions.<computed> [as .ts] (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/ts-node@9.0.0_typescript@3.9.10/node_modules/ts-node/src/index.ts:1046:12)
cmderr	[generateScript.sh]     at Module.load (node:internal/modules/cjs/loader:1076:32)
cmderr	[generateScript.sh]     at Function.Module._load (node:internal/modules/cjs/loader:911:12)
cmderr	[generateScript.sh]     at Function.executeUserEntryPoint [as runMain] (node:internal/modules/run_main:81:12)
cmderr	[generateScript.sh]  notice
cmderr	[generateScript.sh] npm notice New major version of npm available! 8.19.4 -> 10.0.0
cmderr	[generateScript.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.0.0>
cmderr	[generateScript.sh] npm notice Run `npm install -g npm@10.0.0` to update!
cmderr	[generateScript.sh] npm notice
error	Script return with result [failed] code [1] signal [null] cwd [azure-resource-manager-schemas]: .sdkauto/generateScript.sh
warn	Skip package processing as generation is failed

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-pipeline-app · 2023-09-05T05:12:20Z

Generated ApiView

Language	Package Name	ApiView Link
Go	sdk/resourcemanager/paloaltonetworksngfw/armpanngfw	There is no API change compared with the previous version
Java	azure-resourcemanager-paloaltonetworks-ngfw	https://apiview.dev/Assemblies/Review/427479b1417d4ffeb95e2471d36140e9
JavaScript	@azure/arm-paloaltonetworksngfw	There is no API change compared with the previous version
Swagger	PaloAltoNetworks.Cloudngfw	https://apiview.dev/Assemblies/Review/b58c7d9b8d4d4553830be8f889d53f1b

openapi-workflow-bot · 2023-09-05T05:19:05Z

Hi @osid29! For review efficiency consideration, when creating a new API version, it is required to place API specs of the base version in the first commit, and push new version updates into successive commits. You can use OpenAPIHub to initialize the PR for adding a new version.
For more details refer to the wiki.

mnasnh1009 · 2023-09-06T05:35:00Z

Added IDCDevDiv label. @mukundnigam Please review this.

mukundnigam · 2023-09-06T09:46:27Z

Signing off from swager API perspective. Please fix the avocado and SDK failures.

osid29 · 2023-09-06T10:52:40Z

/pr RequestMerge

* Base commit * Adding trusted ranges as optional field * Fixing avocado errors

osid29 added 2 commits September 5, 2023 10:22

Base commit

23339ca

Adding trusted ranges as optional field

0463876

openapi-assignment-bot Bot assigned rkmanda Sep 5, 2023

azure-sdk mentioned this pull request Sep 5, 2023

[AutoPR sdk/resourcemanager/paloaltonetworksngfw/armpanngfw] Adding trusted ranges as an optional field azure-sdk/azure-sdk-for-go#7193

Closed

AzureRestAPISpecReview added ARMReview CI-MissingBaseCommit new-api-version resource-manager RPaaS WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Sep 5, 2023

mnasnh1009 added the IDCDevDiv label Sep 6, 2023

mukundnigam added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Sep 6, 2023

openapi-workflow-bot Bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Sep 6, 2023

Fixing avocado errors

a9d8d15

AzureRestAPISpecReview added the ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test label Sep 6, 2023

github-actions Bot added the MergeRequested label Sep 6, 2023

mentat9 enabled auto-merge (squash) September 6, 2023 18:12

mentat9 self-requested a review September 6, 2023 18:13

mentat9 approved these changes Sep 6, 2023

View reviewed changes

mentat9 merged commit a29126c into Azure:main Sep 6, 2023

jnlycklama pushed a commit that referenced this pull request Nov 8, 2023

Adding trusted ranges as an optional field (#25649)

9429619

* Base commit * Adding trusted ranges as optional field * Fixing avocado errors

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adding trusted ranges as an optional field#25649

Adding trusted ranges as an optional field#25649
mentat9 merged 3 commits into
Azure:mainfrom
osid29:osid/Sept23

osid29 commented Sep 5, 2023 •

edited

Loading

Uh oh!

openapi-pipeline-app Bot commented Sep 5, 2023 •

edited

Loading

Uh oh!

openapi-pipeline-app Bot commented Sep 5, 2023 •

edited

Loading

Uh oh!

openapi-pipeline-app Bot commented Sep 5, 2023 •

edited

Loading

Breaking Changes Tracking

Uh oh!

openapi-pipeline-app Bot commented Sep 5, 2023 •

edited

Loading

Uh oh!

openapi-workflow-bot Bot commented Sep 5, 2023

Uh oh!

mnasnh1009 commented Sep 6, 2023

Uh oh!

mukundnigam commented Sep 6, 2023

Uh oh!

osid29 commented Sep 6, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Conversation

osid29 commented Sep 5, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

ARM (Control Plane) API Specification Update Pull Request

PR review workflow diagram

Purpose of this PR

Due diligence checklist

Breaking changes review (Step 1)

ARM API changes review (Step 2)

Viewing API changes

Suppressing failures

Getting help

Uh oh!

openapi-pipeline-app Bot commented Sep 5, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Next Steps to Merge

Uh oh!

openapi-pipeline-app Bot commented Sep 5, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Swagger Validation Report

Uh oh!

openapi-pipeline-app Bot commented Sep 5, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Swagger Generation Artifacts

Breaking Changes Tracking

Uh oh!

openapi-pipeline-app Bot commented Sep 5, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Generated ApiView

Uh oh!

openapi-workflow-bot Bot commented Sep 5, 2023

Uh oh!

mnasnh1009 commented Sep 6, 2023

Uh oh!

mukundnigam commented Sep 6, 2023

Uh oh!

osid29 commented Sep 6, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

osid29 commented Sep 5, 2023 •

edited

Loading

openapi-pipeline-app Bot commented Sep 5, 2023 •

edited

Loading

openapi-pipeline-app Bot commented Sep 5, 2023 •

edited

Loading

openapi-pipeline-app Bot commented Sep 5, 2023 •

edited

Loading

openapi-pipeline-app Bot commented Sep 5, 2023 •

edited

Loading