-
Notifications
You must be signed in to change notification settings - Fork 5.1k
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
Add new test notification APIs for Tenant Action Groups #23714
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. [email protected] |
Swagger Validation Report
|
compared swaggers (via Oad v0.10.4)] | new version | base version |
---|---|---|
tenantActionGroups_API.json | 2023-05-01-preview(a4e0a89) | 2023-03-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: 0 Warnings warning [Detail]
compared tags (via openapi-validator v2.1.1) | new version | base version |
---|---|---|
package-2023-04 | package-2023-04(a4e0a89) | package-2023-04(main) |
The following errors/warnings exist before current PR submission:
Rule | Message |
---|---|
PathForPutOperation |
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 |
TopLevelResourcesListBySubscription |
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: 1 Warnings warning [Detail]
Rule | Message |
---|---|
The default tag contains multiple API versions swaggers. readme: specification/monitor/resource-manager/readme.md tag: specification/monitor/resource-manager/readme.md#tag-package-2023-04 |
️️✔️
ApiReadinessCheck succeeded [Detail] [Expand]
️❌
~[Staging] ServiceAPIReadinessTest: 132 Errors, 0 Warnings failed [Detail]
Tag package-2023-04; Prod region: Deployed
Test run on region: westcentralus; Operation coverage: total: 116, untested: 0, failed: 78, passed: 38
Service API Readiness Test failed. Check pipeline artifact for detail report.
Only 30 items are listed, please refer to log for more details.
Rule | Message |
---|---|
CLIENT_ERROR |
statusCode: 400, errorCode: LocationNotAvailableForResourceType, errorMessage: The provided location 'westcentralus' is not available for resource type 'microsoft.insights/privateLinkScopes'. List of available regions for the resource type is 'global'. Source: runtime OperationId: PrivateLinkScopes_CreateOrUpdate |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'microsoft.insights/privateLinkScopes/scopenamwh04kd' under resource group 'apiTest-WnBuRx-23714' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: PrivateLinkScopes_Get |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'microsoft.insights/privateLinkScopes/scopenamwh04kd' under resource group 'apiTest-WnBuRx-23714' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: PrivateLinkScopes_UpdateTags |
CLIENT_ERROR |
statusCode: 400, errorCode: LocationNotAvailableForResourceType, errorMessage: The provided location 'westcentralus' is not available for resource type 'microsoft.insights/actiongroups'. List of available regions for the resource type is 'global,swedencentral,germanywestcentral,northcentralus,southcentralus,eastus2euap,centraluseuap'. Source: runtime OperationId: ActionGroups_CreateOrUpdate |
OBJECT_ADDITIONAL_PROPERTIES |
Additional properties not allowed: error Source: response OperationId: ActionGroups_CreateOrUpdate |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.Insights/actiongroups/actiongri05t1a' under resource group 'apiTest-WnBuRx-23714' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: ActionGroups_GetTestNotificationsAtActionGroupResourceLevel |
OBJECT_ADDITIONAL_PROPERTIES |
Additional properties not allowed: error Source: response OperationId: ActionGroups_GetTestNotificationsAtActionGroupResourceLevel |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.Insights/actiongroups/actiongri05t1a' under resource group 'apiTest-WnBuRx-23714' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: ActionGroups_Get |
OBJECT_ADDITIONAL_PROPERTIES |
Additional properties not allowed: error Source: response OperationId: ActionGroups_Get |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.Insights/actiongroups/actiongri05t1a' under resource group 'apiTest-WnBuRx-23714' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: ActionGroups_Update |
OBJECT_ADDITIONAL_PROPERTIES |
Additional properties not allowed: error Source: response OperationId: ActionGroups_Update |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.Insights/actiongroups/actiongri05t1a' under resource group 'apiTest-WnBuRx-23714' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: ActionGroups_EnableReceiver |
OBJECT_ADDITIONAL_PROPERTIES |
Additional properties not allowed: error Source: response OperationId: ActionGroups_EnableReceiver |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.Insights/actiongroups/actiongri05t1a' under resource group 'apiTest-WnBuRx-23714' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: ActionGroups_CreateNotificationsAtActionGroupResourceLevel |
OBJECT_ADDITIONAL_PROPERTIES |
Additional properties not allowed: error Source: response OperationId: ActionGroups_CreateNotificationsAtActionGroupResourceLevel |
CLIENT_ERROR |
statusCode: 403, errorCode: AuthorizationFailed, errorMessage: The client '7904a8be-825f-480e-a728-80a70579dba4' with object id '7904a8be-825f-480e-a728-80a70579dba4' does not have authorization to perform action 'Microsoft.Insights/tenantActionGroups/write' over scope '/providers/Microsoft.Management/managementGroups/managemeqrgu4m/providers/Microsoft.Insights/tenantActionGroups/tenantac79uwd6' or the scope is invalid. If access was recently granted, please refresh your credentials. Source: runtime OperationId: TenantActionGroups_CreateOrUpdate |
OBJECT_ADDITIONAL_PROPERTIES |
Additional properties not allowed: error Source: response OperationId: TenantActionGroups_CreateOrUpdate |
CLIENT_ERROR |
statusCode: 403, errorCode: AuthorizationFailed, errorMessage: The client '7904a8be-825f-480e-a728-80a70579dba4' with object id '7904a8be-825f-480e-a728-80a70579dba4' does not have authorization to perform action 'Microsoft.Insights/tenantActionGroups/read' over scope '/providers/Microsoft.Management/managementGroups/managemeqrgu4m/providers/Microsoft.Insights' or the scope is invalid. If access was recently granted, please refresh your credentials. Source: runtime OperationId: TenantActionGroups_ListByManagementGroupId |
OBJECT_ADDITIONAL_PROPERTIES |
Additional properties not allowed: error Source: response OperationId: TenantActionGroups_ListByManagementGroupId |
CLIENT_ERROR |
statusCode: 403, errorCode: AuthorizationFailed, errorMessage: The client '7904a8be-825f-480e-a728-80a70579dba4' with object id '7904a8be-825f-480e-a728-80a70579dba4' does not have authorization to perform action 'Microsoft.Insights/tenantActionGroups/read' over scope '/providers/Microsoft.Management/managementGroups/managemeqrgu4m/providers/Microsoft.Insights/tenantActionGroups/tenantac79uwd6' or the scope is invalid. If access was recently granted, please refresh your credentials. Source: runtime OperationId: TenantActionGroups_Get |
OBJECT_ADDITIONAL_PROPERTIES |
Additional properties not allowed: error Source: response OperationId: TenantActionGroups_Get |
CLIENT_ERROR |
statusCode: 403, errorCode: AuthorizationFailed, errorMessage: The client '7904a8be-825f-480e-a728-80a70579dba4' with object id '7904a8be-825f-480e-a728-80a70579dba4' does not have authorization to perform action 'Microsoft.Insights/tenantActionGroups/write' over scope '/providers/Microsoft.Management/managementGroups/managemeqrgu4m/providers/Microsoft.Insights/tenantActionGroups/tenantac79uwd6' or the scope is invalid. If access was recently granted, please refresh your credentials. Source: runtime OperationId: TenantActionGroups_Update |
OBJECT_ADDITIONAL_PROPERTIES |
Additional properties not allowed: error Source: response OperationId: TenantActionGroups_Update |
CLIENT_ERROR |
statusCode: 400, errorCode: LocationNotAvailableForResourceType, errorMessage: The provided location 'westcentralus' is not available for resource type 'microsoft.insights/metricalerts'. List of available regions for the resource type is 'global,westeurope,northeurope,swedencentral,germanywestcentral,eastus2euap'. Source: runtime OperationId: MetricAlerts_CreateOrUpdate |
INVALID_FORMAT |
Object didn't pass validation for format duration: Pt1m Source: request OperationId: MetricAlerts_CreateOrUpdate |
INVALID_FORMAT |
Object didn't pass validation for format duration: Pt15m Source: request OperationId: MetricAlerts_CreateOrUpdate |
INVALID_TYPE |
Expected type object but found type array Source: request OperationId: MetricAlerts_CreateOrUpdate |
OBJECT_ADDITIONAL_PROPERTIES |
Additional properties not allowed: error Source: response OperationId: MetricAlerts_CreateOrUpdate |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.Insights/metricalerts/rulenamecpj5zl' under resource group 'apiTest-WnBuRx-23714' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: MetricAlerts_Get |
OBJECT_ADDITIONAL_PROPERTIES |
Additional properties not allowed: error Source: response OperationId: MetricAlerts_Get |
️️✔️
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
|
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 |
@raych1 hi Ray, could you please advise the next step for this PR? Thank you! @keryul could you please help? Thank you! |
@thomasp98296 can you fix the LintDiff error? |
@keryul I went ahead and fix it. Could you please help to proceed? Thanks! |
@keryul , is there anything else needed from me or it should be good to merge? If good, can you please merge it? Thanks! |
/azp run |
Azure Pipelines successfully started running 1 pipeline(s). |
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.