azure-rest-api-specs
azure-rest-api-specs copied to clipboard
Azure
API version to support Metric Dataplane Subscriptions in Azure Monitor Private Link Scopes
ARM (Control Plane) API Specification Update Pull Request
Purpose of this PR
What's the purpose of this PR? Check all that apply. This is mandatory!
- [x] 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:
- [x] I have reviewed the general guidance on the spec PR review process: https://aka.ms/specprreview.
- [x] I confirm this PR is modifying Azure Resource Manager (ARM) related specifications, and not data-plane related specifications.
- [x] I commit to follow the Breaking Change Policy.
- [X] 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 request review from an ARM API Review board.
ARM API changes review
- If you want for the ARM team to review this PR, you must add the
ARMReviewlabel. - The automation may automatically add the
ARMReviewlabel, if appropriate.
If this happens, proceed according to guidance given in GitHub comments also added by the automation.
Breaking change review
If you have any breaking changes as defined in the Breaking Change Policy, follow the process outlined in the High-level Breaking Change Process doc.
Getting help
- For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure and https://aka.ms/ci-fix.
- For additional help, see https://aka.ms/azsdk/support/spectools.
Swagger Validation Report
️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
️⚠️Breaking Change(Cross-Version): 27 Warnings warning [Detail]
| Compared specs (v0.10.12) | new version | base version |
|---|---|---|
| privateLinkScopes_API.json | 2023-06-01-preview(cbc02a4) | 2021-07-01-preview(main) |
The following breaking changes are detected by comparison with the latest preview version:
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 21 Warnings warning [Detail]
| Compared specs (v2.2.2) | new version | base version |
|---|---|---|
| package-2023-06-01-preview-only | package-2023-06-01-preview-only(cbc02a4) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
️❌Avocado: 5 Errors, 1 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
The default tag does not contains the latest API version. Please make sure the latest api version swaggers are in the default tag. readme: specification/monitor/resource-manager/readme.md json: Microsoft.Insights/preview/2023-06-01-preview/privateLinkScopes_API.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/providers/Microsoft.Insights/privateLinkScopes is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/monitor/resource-manager/readme.md json: Microsoft.Insights/preview/2023-06-01-preview/privateLinkScopes_API.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.Insights/privateLinkScopes is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/monitor/resource-manager/readme.md json: Microsoft.Insights/preview/2023-06-01-preview/privateLinkScopes_API.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.Insights/privateLinkScopes/{} is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/monitor/resource-manager/readme.md json: Microsoft.Insights/preview/2023-06-01-preview/privateLinkScopes_API.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.Insights/privateLinkScopeOperationStatuses/{} is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/monitor/resource-manager/readme.md json: Microsoft.Insights/preview/2023-06-01-preview/privateLinkScopes_API.json |
| :warning: MULTIPLE_API_VERSION | The default tag contains multiple API versions swaggers. readme: specification/monitor/resource-manager/readme.md tag: specification/monitor/resource-manager/readme.md#tag-package-2024-04 |
️️✔️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.
️️✔️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]
![openapi-pipeline-app[bot] avatar](https://avatars.githubusercontent.com/in/65541?v=4 "Published by a pub.dev verified publisher"){kind=small}
Hi, @qinjoshua Thanks for your PR. I am workflow bot for review process. Here are some small tips.
![openapi-workflow-bot[bot] avatar](https://avatars.githubusercontent.com/in/81125?v=4 "Published by a pub.dev verified publisher"){kind=small}
Swagger Generation Artifacts
️️✔️ApiDocPreview succeeded [Detail] [Expand]
Please click here to preview with your @microsoft account.
️🔄 azure-sdk-for-net-track2 inProgress [Detail]
️⚠️ azure-sdk-for-python warning [Detail]
- For more instructions, please refer to the FAQ .
⚠️Warning in generating from ba215ce16d0d7b6bd858ac4128f2c95bdd04dca0. SDK Automation 14.0.0command sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json cmderr [automation_init.sh] W: Target Packages (main/binary-amd64/Packages) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1 cmderr [automation_init.sh] W: Target Packages (main/binary-all/Packages) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1 cmderr [automation_init.sh] W: Target Translations (main/i18n/Translation-en) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1 cmderr [automation_init.sh] W: Target CNF (main/cnf/Commands-amd64) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1 cmderr [automation_init.sh] W: Target CNF (main/cnf/Commands-all) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1 cmderr [automation_init.sh] W: Target Packages (main/binary-amd64/Packages) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1 cmderr [automation_init.sh] W: Target Packages (main/binary-all/Packages) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1 cmderr [automation_init.sh] W: Target Translations (main/i18n/Translation-en) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1 cmderr [automation_init.sh] W: Target CNF (main/cnf/Commands-amd64) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1 cmderr [automation_init.sh] W: Target CNF (main/cnf/Commands-all) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1 cmderr [automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed. cmderr [automation_init.sh] npm notice cmderr [automation_init.sh] npm notice New minor version of npm available! 10.7.0 -> 10.8.1 cmderr [automation_init.sh] npm notice Changelog: https://github.com/npm/cli/releases/tag/v10.8.1 cmderr [automation_init.sh] npm notice To update run: npm install -g [email protected] cmderr [automation_init.sh] npm notice command sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
️✔️azure-mgmt-monitor [Preview SDK Changes]info [Changelog]
️🔄 azure-sdk-for-java inProgress [Detail]
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
- For more instructions, please refer to the FAQ .
️✔️Succeeded in generating from ba215ce16d0d7b6bd858ac4128f2c95bdd04dca0. SDK Automation 14.0.0command 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/monitor/armmonitor [Preview SDK Changes]
️🔄 azure-sdk-for-js inProgress [Detail]
️❌ azure-resource-manager-schemas failed [Detail]
- For more instructions, please refer to the FAQ .
❌Code Generator Failed in generating from ba215ce16d0d7b6bd858ac4128f2c95bdd04dca0. Schema Automation 14.0.0command .sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json cmderr [initScript.sh] Submodule 'bicep-types-az' (https://github.com/Azure/bicep-types-az) registered for path 'bicep-types-az' cmderr [initScript.sh] Cloning into '/mnt/vss/_work/1/s/azure-resource-manager-schemas/bicep-types-az'... cmderr [initScript.sh] Submodule 'bicep-types' (https://github.com/Azure/bicep-types) registered for path 'bicep-types-az/bicep-types' cmderr [initScript.sh] Cloning into '/mnt/vss/_work/1/s/azure-resource-manager-schemas/bicep-types-az/bicep-types'... cmderr [initScript.sh] npm notice cmderr [initScript.sh] npm notice New minor version of npm available! 10.7.0 -> 10.8.1 cmderr [initScript.sh] npm notice Changelog: https://github.com/npm/cli/releases/tag/v10.8.1 cmderr [initScript.sh] npm notice To update run: npm install -g [email protected] cmderr [initScript.sh] npm notice error Script return with result [failed] code [1] signal [null] cwd [azure-resource-manager-schemas]: .sdkauto/initScript.sh warn Warning: File azure-resource-manager-schemas_tmp/initOutput.json not found to read. Please re-run the pipeline if the error is transitient error or report this issue through https://aka.ms/azsdk/support/specreview-channel. 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/[email protected][email protected]/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(6,20): error TS2307: Cannot find module 'colors' or its corresponding type declarations. cmderr [generateScript.sh] cmd/generateall.ts(10,19): error TS2307: Cannot find module 'yargs' or its corresponding type declarations. cmderr [generateScript.sh] cmd/generateall.ts(11,18): error TS2307: Cannot find module 'path' or its corresponding type declarations. cmderr [generateScript.sh] cmd/generateall.ts(13,35): error TS2307: Cannot find module 'fs' or its corresponding type declarations. cmderr [generateScript.sh] cmd/generateall.ts(14,23): error TS2307: Cannot find module 'strip-ansi' or its corresponding type declarations. cmderr [generateScript.sh] cmd/generateall.ts(42,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(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(69,67): error TS7006: Parameter 'x' implicitly has an 'any' type. cmderr [generateScript.sh] cmd/generateall.ts(70,49): error TS7006: Parameter 'f' implicitly has an 'any' type. cmderr [generateScript.sh] cmd/generateall.ts(94,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(105,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(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(157,13): error TS2591: Cannot find name 'process'. Do you need to install type definitions for node? Try `npm i --save-dev @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/[email protected][email protected]/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/[email protected][email protected]/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/[email protected][email protected]/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/[email protected][email protected]/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/[email protected][email protected]/node_modules/ts-node/src/index.ts:1043:43) cmderr [generateScript.sh] at Module._extensions..js (node:internal/modules/cjs/loader:1422:10) cmderr [generateScript.sh] at Object.require.extensions.<computed> [as .ts] (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected][email protected]/node_modules/ts-node/src/index.ts:1046:12) cmderr [generateScript.sh] at Module.load (node:internal/modules/cjs/loader:1203:32) cmderr [generateScript.sh] at Function.Module._load (node:internal/modules/cjs/loader:1019:12) cmderr [generateScript.sh] at Function.executeUserEntryPoint [as runMain] (node:internal/modules/run_main:128:12) error Script return with result [failed] code [1] signal [null] cwd [azure-resource-manager-schemas]: .sdkauto/generateScript.sh warn Warning: Package processing is skipped as the SDK generation fails. Please look into the above generation errors or report this issue through https://aka.ms/azsdk/support/specreview-channel.
️⚠️ azure-powershell warning [Detail]
- For more instructions, please refer to the FAQ .
⚠️Warning in generating from ba215ce16d0d7b6bd858ac4128f2c95bdd04dca0. SDK Automation 14.0.0command sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json command pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json
⚠️Az.monitor.DefaultTag [Preview SDK Changes]
Generated ApiView
| Language | Package Name | ApiView Link |
|---|---|---|
| Go | sdk/resourcemanager/monitor/armmonitor | https://apiview.dev/Assemblies/Review/14110b73692e404ca82e994b5fe313ad?revisionId=a344d0155c79439f8880baf21a506d3a |
| Swagger | Microsoft.Insights | https://apiview.dev/Assemblies/Review/b1062e1dbaa34b189b1d407e01e2e372?revisionId=ff3fcdb82c4c48479dc455122e07a25b |
Hi @qinjoshua! Your PR has some issues. Please fix the CI issues, if present, in following order: Avocado, SemanticValidation, ModelValidation, Breaking Change, LintDiff.
| Task | How to fix | Priority |
|---|---|---|
| Avocado | Fix-Avocado | High |
| Semantic Validation | Fix-SemanticValidation-Error | High |
| Model Validation | Fix-ModelValidation-Error | High |
| LintDiff | Fix-LintDiff | High |
If you need further help, please reach out on the Teams channel aka.ms/azsdk/support/specreview-channel.
Hi @qinjoshua! 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.
Hi @qinjoshua! 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.
Hey @qunjoshua.. can you please add the version of the file that contains the previous version of the privatelinkScopes_API file as a base commit as is called out here before start the ARM review ?
I see that your team does not renew all files for a new api version. This is not recommended since this will lead to SDKs only having some apis in the release. Is there a reason why you do not renew all the files ?
Please address or respond to feedback from the ARM API reviewer.
When you are ready to continue the ARM API review, please remove the ARMChangesRequested label.
This will notify the reviewer to have another look.
If the feedback provided needs further discussion, please use this Teams channel to post your questions - aka.ms/azsdk/support/specreview-channel.
Please include [ARM Query] in the title of your question to indicate that it is ARM-related.
Hi @raosuhas , thank you for taking a look at my PR.
I've added a base commit that just replicates the previous version of the API that I'm updating. Let me know if that looks good
I'm new to the team and this is my first Swagger docs update, but my understanding is that my Team only renews files for the APIs that we're updating in the newest version because those are the only files being change. In this case, I only plan to modify the private links API. I am not sure why this is not recommended, as other APIs will continue to work using whatever their latest version is.
Let me know if there's anything else I need to do.
Hi @qinjoshua! The automation detected breaking changes in this pull request. As a result, it added the BreakingChangeReviewRequired label.
You cannot proceed with merging this PR until you complete one of the following action items:
ACTION ITEM ALTERNATIVE A: Fix the breaking change.
Please consult the documentation provided in the relevant validation failures.
ACTION ITEM ALTERNATIVE B: Request approval.
Alternatively, if you cannot fix the breaking changes, then you can request an approval for them. Please follow the process described in the High-level Breaking Change Process doc.
ACTION ITEM ALTERNATIVE C: Report false positive.
If you think there are no breaking changes, i.e. the validation should pass yet it fails, then proceed as explained in ACTION ITEM ALTERNATIVE B.
This applies even if the breaking change tool fails with internal runtime error. In such case a manual breaking change review is necessary.
Next Steps to Merge
✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge.
This one looks like you're declaring the Location header incorrectly per openapi
❌ unacceptable kind of an object to dump [object Error] | "role":"Model Validation","url":"https://github.com/Azure/azure-rest-api-specs/blob/e7f921b92fbc7c9aff11ee68d60a25f21809809c/specification/monitor/resource-manager/Microsoft.Insights/preview/2023-06-01-preview/privateLinkScopes_API.json"
@rkmanda All required validations should be successfully completed, as previously discussed in the email thread. Please take a look at the changes and approve as soon as you can.
There seem to be some new linter errors show up now (either because of changes or because some linter issues got fixed):
❌ XmsEnumValidation | The enum types should have x-ms-enum type extension set with appropriate options.Location: Microsoft.Insights/preview/2023-06-01-preview/privateLinkScopes_API.json#L929 | ❌ XmsEnumValidation | The enum types should have x-ms-enum type extension set with appropriate options.Location: Microsoft.Insights/preview/2023-06-01-preview/privateLinkScopes_API.json#L1089
This avocado warning sounds like its caused by an accidental oversight?
The example JSON file is not referenced from the swagger file. readme: specification/monitor/resource-manager/readme.md json: preview/2023-06-01-preview/examples/PrivateLinkScopedResourceUpdatePlatformMetrics.json
![azure-pipelines[bot] avatar](https://avatars.githubusercontent.com/in/9426?v=4 "Published by a pub.dev verified publisher"){kind=small}
I see there are still ModelValidation issues around the casing for the enums. Please advise on how to make my enums case-insensitive - otherwise, validation issues should be resolved
I see there are still ModelValidation issues around the casing for the enums. Please advise on how to make my enums case-insensitive - otherwise, validation issues should be resolved
Doesn't it just want you to case it as 'Resource' instead of 'resource' in the examples? Would there be a problem with doing that?
For Semantic I think there are also maybe one or two places where you need to fix
"readonly": "true",
to
"readonly": true,
?
@TimLovellSmith since the API accepts case-insensitive kind, I don't want it to be labeled as case-sensitive in the swagger docs. Also not certain this is the case but it looks like all the other enum examples I've looked at uses uppercase definitions.
This looks a little strange: https://github.com/Azure/azure-rest-api-specs/pull/24590/checks?check_run_id=17758414025
please update here to your new apiversion
@kazrael2119 I believe that is addressed here: https://github.com/Azure/azure-rest-api-specs/pull/24590/files#:~:text=%2D%20Microsoft.Insights/preview/2023%2D06%2D01%2Dpreview/privateLinkScopes_API.json
I don't intend to change the settings for older tags, let me know if there is something you'd like me to change
please update here to your new apiversion
@kazrael2119 I believe that is addressed here: https://github.com/Azure/azure-rest-api-specs/pull/24590/files#:~:text=%2D%20Microsoft.Insights/preview/2023%2D06%2D01%2Dpreview/privateLinkScopes_API.json
I don't intend to change the settings for older tags, let me know if there is something you'd like me to change
Do you mean in the future, there will be a composite apiversion like 2023-04-01 which contains all services with their new apiversion? So you don't want to change the setting for older version?
For JS, we have so many duplicate schemas in monitor. like these: https://github.com/azure-sdk/azure-sdk-for-js/pull/5546/files#diff-b4f88d7279e423e43b8b4d038d99dfdd2290d798e0e96815fd72ce98cf331da2R147-R152 And some of them may be related with your service and other service. Do you think it's good to fix these duplicate schemas in the next composite apiverison? If yes, I think we can approve js breaking in this pr
PR validation pipeline can not start as the pull request is not merged or mergeable - most likely it has merge conflicts.
Hi, @qinjoshua. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.
![microsoft-github-policy-service[bot] avatar](https://avatars.githubusercontent.com/in/95686?v=4 "Published by a pub.dev verified publisher"){kind=small}
Hi, @qinjoshua. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee.