Thomasp98296 monitor microsoft.insights 2023 05 01 preview#23583
Closed
thomasp98296 wants to merge 4 commits intomainfrom
Closed
Thomasp98296 monitor microsoft.insights 2023 05 01 preview#23583thomasp98296 wants to merge 4 commits intomainfrom
thomasp98296 wants to merge 4 commits intomainfrom
Conversation
|
Hi, @thomasp98296 Thanks for your PR. I am workflow bot for review process. Here are some small tips. Any feedback about review process or workflow bot, pls contact swagger and tools team. vscswagger@microsoft.com |
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| tenantActionGroups_API.json | 2023-05-01-preview(d29d497) | 2023-03-01-preview(main) |
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️❌LintDiff: 2 Errors, 0 Warnings failed [Detail]
| compared tags (via openapi-validator v2.0.0) | new version | base version |
|---|---|---|
| package-preview-2023-04 | package-preview-2023-04(d29d497) | package-preview-2023-04(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
|
The resource name parameter 'tenantActionGroupName' should be defined with a 'pattern' restriction. Location: Microsoft.Insights/preview/2023-05-01-preview/tenantActionGroups_API.json#L252 |
RPC-Uri-V1-05 |
|
The resource name parameter 'tenantActionGroupName' should be defined with a 'pattern' restriction. Location: Microsoft.Insights/preview/2023-05-01-preview/tenantActionGroups_API.json#L313 |
RPC-Uri-V1-05 |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
|
The path for 'put' operation must be under a subscription and resource group. Location: Microsoft.Insights/preview/2023-05-01-preview/tenantActionGroups_API.json#L39 |
|
The resource name parameter 'tenantActionGroupName' should be defined with a 'pattern' restriction. Location: Microsoft.Insights/preview/2023-05-01-preview/tenantActionGroups_API.json#L39 |
|
The top-level resource 'TenantActionGroupResource' does not have list by subscription operation, please add it. Location: Microsoft.Insights/preview/2023-05-01-preview/tenantActionGroups_API.json#L528 |
| The x-ms-code-generation-setting extension is being deprecated. Please remove it and move settings to readme file for code generation. Location: Microsoft.Insights/preview/2023-05-01-preview/tenantActionGroups_API.json#L5 |
|
| The response of operation:'TenantActionGroups_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Insights/preview/2023-05-01-preview/tenantActionGroups_API.json#L40 |
|
| The response of operation:'TenantActionGroups_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Insights/preview/2023-05-01-preview/tenantActionGroups_API.json#L92 |
|
| The response of operation:'TenantActionGroups_Update' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Insights/preview/2023-05-01-preview/tenantActionGroups_API.json#L166 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.Insights/preview/2023-05-01-preview/tenantActionGroups_API.json#L570 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.Insights/preview/2023-05-01-preview/tenantActionGroups_API.json#L643 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.Insights/preview/2023-05-01-preview/tenantActionGroups_API.json#L699 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.Insights/preview/2023-05-01-preview/tenantActionGroups_API.json#L704 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.Insights/preview/2023-05-01-preview/tenantActionGroups_API.json#L817 |
️❌Avocado: 46 Errors, 0 Warnings failed [Detail]
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/microsoft.insights/activityLogAlerts/{} 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/2017-03-01-preview/activityLogAlerts_API.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/providers/microsoft.insights/activityLogAlerts 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/2017-03-01-preview/activityLogAlerts_API.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/microsoft.insights/activityLogAlerts 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/2017-03-01-preview/activityLogAlerts_API.json |
|
The default tag should contain all APIs. The API path /{}/providers/Microsoft.Insights/diagnosticSettings/{} 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/2021-05-01-preview/diagnosticsSettings_API.json |
|
The default tag should contain all APIs. The API path /{}/providers/Microsoft.Insights/diagnosticSettings 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/2021-05-01-preview/diagnosticsSettings_API.json |
|
The default tag should contain all APIs. The API path /{}/providers/Microsoft.Insights/diagnosticSettingsCategories/{} 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/2021-05-01-preview/diagnosticsSettingsCategories_API.json |
|
The default tag should contain all APIs. The API path /{}/providers/Microsoft.Insights/diagnosticSettingsCategories 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/2021-05-01-preview/diagnosticsSettingsCategories_API.json |
|
The default tag should contain all APIs. The API path /{}/providers/Microsoft.Insights/metricDefinitions 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/2017-09-01-preview/metricDefinitions_API.json |
|
The default tag should contain all APIs. The API path /{}/providers/Microsoft.Insights/metrics 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/2017-09-01-preview/metrics_API.json |
|
The default tag should contain all APIs. The API path /providers/Microsoft.Insights/operations 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/2017-09-01-preview/operations_API.json |
|
The default tag should contain all APIs. The API path /{}/providers/microsoft.insights/metricNamespaces 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/2017-12-01-preview/metricNamespaces_API.json |
|
The default tag should contain all APIs. The API path /{}/providers/Microsoft.Insights/vmInsightsOnboardingStatuses/default 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/2018-11-27-preview/vmInsightsOnboarding_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/2021-07-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/2021-07-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/2021-07-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/2021-07-01-preview/privateLinkScopes_API.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.Insights/privateLinkScopes/{}/privateLinkResources 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/2021-07-01-preview/privateLinkScopes_API.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.Insights/privateLinkScopes/{}/privateLinkResources/{} 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/2021-07-01-preview/privateLinkScopes_API.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.Insights/privateLinkScopes/{}/privateEndpointConnections/{} 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/2021-07-01-preview/privateLinkScopes_API.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.Insights/privateLinkScopes/{}/privateEndpointConnections 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/2021-07-01-preview/privateLinkScopes_API.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.Insights/privateLinkScopes/{}/scopedResources/{} 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/2021-07-01-preview/privateLinkScopes_API.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.Insights/privateLinkScopes/{}/scopedResources 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/2021-07-01-preview/privateLinkScopes_API.json |
|
The default tag should contain all APIs. The API path /{}/providers/Microsoft.Insights/dataCollectionRuleAssociations 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/2021-09-01-preview/dataCollectionRuleAssociations_API.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.Insights/dataCollectionRules/{}/associations 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/2021-09-01-preview/dataCollectionRuleAssociations_API.json |
|
The default tag should contain all APIs. The API path /{}/providers/Microsoft.Insights/dataCollectionRuleAssociations/{} 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/2021-09-01-preview/dataCollectionRuleAssociations_API.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.Insights/dataCollectionRules 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/2021-09-01-preview/dataCollectionRules_API.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/providers/Microsoft.Insights/dataCollectionRules 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/2021-09-01-preview/dataCollectionRules_API.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.Insights/dataCollectionRules/{} 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/2021-09-01-preview/dataCollectionRules_API.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/providers/Microsoft.Insights/scheduledQueryRules 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/2022-08-01-preview/scheduledQueryRule_API.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.Insights/scheduledQueryRules 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/2022-08-01-preview/scheduledQueryRule_API.json |
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️⚠️~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]
API Test is not triggered due to precheck failure. Check pipeline log for details.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️CadlAPIView 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).
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️️✔️TypeSpec Validation succeeded [Detail] [Expand]
Validation passes for TypeSpec Validation.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
Generated ApiView
|
Member
Author
|
/azp run unifiedPipeline |
|
No pipelines are associated with this pull request. |
AzureRestAPISpecReview
added
ARMReview
CI-FixRequiredOnFailure
CI-MissingBaseCommit
new-api-version
resource-manager
WaitForARMFeedback
|
Hi @thomasp98296, Your PR has some issues. Please fix the CI sequentially by following the order of
|
|
Hi, @thomasp98296, 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. Or you could onboard API spec pipeline |
This was referenced Apr 17, 2023
This was referenced Apr 17, 2023
|
@thomasp98296 - PR is not generated properly for a new API version The first commit needs to be the previous api version and the new changes should only be added in the subsequent commits. This is explained in detail here (If using Open API which is recommended) https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/208/OpenAPI-Hub-Adding-new-API-version or here(For manual process) : https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/83/Manual-Process-Adding-new-API-version . Please remove the "ARMChangesRequested" label once you have fixed this issue. While you are at it, please fix all the Linter errors found in the link https://github.com/Azure/azure-rest-api-specs/pull/23583/checks?check_run_id=12801231426 |
|
Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove |
openapi-workflow-bot
bot
removed
the
WaitForARMFeedback
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
ARM API Information (Control Plane)
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.
Changelog
Add a changelog entry for this PR by answering the following questions:
Contribution checklist (MS Employees Only):
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Otherwise your PR may be subject to ARM review requirements. Complete the following:
Check this box if any of the following apply to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.
-[ ] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki.
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 you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.
NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)
Please follow the link to find more details on PR review process.