Dev cost management microsoft.cost management 2023 04 01 preview #23334
Conversation
This file contains 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
…022-10-01 to version 2023-04-01-preview
#22866) * Adding Budgets API translated from 2022-10-01 stable version of Microsoft.Consumption/budgets * Updating api-version in examples to 2023-04-01-preview * Adding costmanagement.budgets.json to readme * Addressing Swagger LintDiff errors * Updating budget name pattern * Adding suppression for R4011 * Adding budget name pattern regex for only alphanumeric, underscore, or hyphen characters * fixing readme.go.md for budgets * removing "object" type from notifications dictionary keys * removing tags * removing mismatching enum values * updating notifications key type * Revert "updating notifications key type" This reverts commit eeb504b. * Revert "removing mismatching enum values" This reverts commit cba0132. * updates to enum name * Removing incorrect/outdated description info * fixing BudgetsList example * Updating example Ids to use Microsoft.CostManagement RP * updating min & max length of budget name per conversations with PMs * Adding suppressions for DeleteOperationResponses, TopLevelResourcesListBySubscription, and NoDuplicatePathsForScopeParameter * fixing indentation in readme * fixing formatting of suppressions in readme * Adding paging back in, specifying as null for future use
* Updating budgets swagger definition to include modifications from RU Alert category * Adding new examples for all scenarios of RU Alerts, added new examples for all scopes for Cost Budgets * Spelling & lintdiff fixes * prettier-fix * Added more descriptions, and some light markdown to larger descripitons * Addressing comments * prettier-fix * Updating description for amount property * addressing Shravan's offline comments * spell check * removing aws scopes from scope description * Addressing comments from internal review, removed legacy tags for EA
|
Hi, @alprosms 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] |
openapi-workflow-bot
bot
added
ARMReview
WaitForARMFeedback
|
Hi, @alprosms your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]). |
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| common-types.json | 2023-04-01-preview(fb6e27e) | 2022-10-01(main) |
| common-types.json | 2023-04-01-preview(fb6e27e) | 2022-10-05-preview(main) |
| costmanagement.benefits.json | 2023-04-01-preview(fb6e27e) | 2022-10-01(main) |
| costmanagement.exports.json | 2023-04-01-preview(fb6e27e) | 2022-10-01(main) |
| costmanagement.exports.json | 2023-04-01-preview(fb6e27e) | 2020-12-01-preview(main) |
| costmanagement.generatecostdetailsreport.json | 2023-04-01-preview(fb6e27e) | 2022-10-01(main) |
| costmanagement.generatedetailedcostreport.json | 2023-04-01-preview(fb6e27e) | 2022-10-01(main) |
| costmanagement.generatedetailedcostreport.json | 2023-04-01-preview(fb6e27e) | 2020-12-01-preview(main) |
| costmanagement.json | 2023-04-01-preview(fb6e27e) | 2022-10-01(main) |
| costmanagement.json | 2023-04-01-preview(fb6e27e) | 2022-10-05-preview(main) |
| costmanagement.pricesheets.json | 2023-04-01-preview(fb6e27e) | 2022-10-01(main) |
| costmanagement.pricesheets.json | 2023-04-01-preview(fb6e27e) | 2022-02-01-preview(main) |
| scheduledActions.json | 2023-04-01-preview(fb6e27e) | 2022-10-01(main) |
| scheduledActions.json | 2023-04-01-preview(fb6e27e) | 2022-06-01-preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
| Rule | Message |
|---|---|
| The new version has a different 'allOf' property than the previous one. New: Microsoft.CostManagement/preview/2023-04-01-preview/common-types.json#L166:5 Old: Microsoft.CostManagement/stable/2022-10-01/common-types.json#L166:5 |
|
| The new version has a different 'allOf' property than the previous one. New: Microsoft.CostManagement/preview/2023-04-01-preview/common-types.json#L166:5 Old: Microsoft.CostManagement/stable/2022-10-01/common-types.json#L166:5 |
|
| The new version has a different 'allOf' property than the previous one. New: Microsoft.CostManagement/preview/2023-04-01-preview/common-types.json#L166:5 Old: Microsoft.CostManagement/stable/2022-10-01/common-types.json#L166:5 |
The following breaking changes are detected by comparison with the latest preview version:
Only 28 items are listed, please refer to log for more details.
️❌CredScan: 0 Errors, 0 Warnings failed [Detail]
️⚠️LintDiff: 3 Warnings warning [Detail]
| compared tags (via openapi-validator v2.0.1) | new version | base version |
|---|---|---|
| package-preview-2023-04 | package-preview-2023-04(fb6e27e) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| The response of operation:'Budgets_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.budgets.json#L122 |
||
| The response of operation:'Budgets_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.budgets.json#L165 |
||
| 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.CostManagement/preview/2023-04-01-preview/costmanagement.budgets.json#L574 |
The following errors/warnings exist before current PR submission:
Only 28 items are listed, please refer to log for more details.
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️❌ApiReadinessCheck: 1 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
"code: InvalidResourceType, message: The resource type 'operations' could not be found in the namespace 'Microsoft.CostManagement' for api version '2023-04-01-preview'. The supported api-versions are '2018-08-31, 2019-01-01, 2018-08-01-preview, 2018-10-01, 2019-10-01, 2021-10-01, 2022-10-01'." |
️❌~[Staging] ServiceAPIReadinessTest: 114 Errors, 0 Warnings failed [Detail]
Tag package-preview-2023-04; Prod region: Not deployed; Canary region: Deployed
Test run on region: eastus2euap; Operation coverage: total: 55, untested: 0, failed: 55, passed: 0
Service API Readiness Test failed. Check pipeline artifact for detail report.
Only 28 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
statusCode: 404, errorCode: InvalidResourceType, errorMessage: The resource type 'CheckNameAvailability' could not be found in the namespace 'Microsoft.CostManagement' for api version '2023-04-01-preview'. The supported api-versions are '2020-03-01-preview,2022-04-01-preview,2022-06-01-preview,2022-10-01'. Source: runtime OperationId: ScheduledActions_CheckNameAvailability |
|
Expected type integer but found type string Source: response OperationId: ScheduledActions_CheckNameAvailability |
|
statusCode: 404, errorCode: MissingSubscription, errorMessage: The request did not have a subscription or a valid tenant level resource provider. Source: runtime OperationId: ScheduledActions_CheckNameAvailabilityByScope |
|
Expected type integer but found type string Source: response OperationId: ScheduledActions_CheckNameAvailabilityByScope |
|
statusCode: 404, errorCode: MissingSubscription, errorMessage: The request did not have a subscription or a valid tenant level resource provider. Source: runtime OperationId: Exports_CreateOrUpdate |
|
Expected type integer but found type string Source: response OperationId: Exports_CreateOrUpdate |
|
statusCode: 404, errorCode: MissingSubscription, errorMessage: The request did not have a subscription or a valid tenant level resource provider. Source: runtime OperationId: Exports_List |
|
Expected type integer but found type string Source: response OperationId: Exports_List |
|
statusCode: 404, errorCode: MissingSubscription, errorMessage: The request did not have a subscription or a valid tenant level resource provider. Source: runtime OperationId: Exports_Get |
|
Expected type integer but found type string Source: response OperationId: Exports_Get |
|
statusCode: 404, errorCode: MissingSubscription, errorMessage: The request did not have a subscription or a valid tenant level resource provider. Source: runtime OperationId: Exports_GetExecutionHistory |
|
Expected type integer but found type string Source: response OperationId: Exports_GetExecutionHistory |
|
statusCode: 404, errorCode: MissingSubscription, errorMessage: The request did not have a subscription or a valid tenant level resource provider. Source: runtime OperationId: Exports_Execute |
|
Expected type integer but found type string Source: response OperationId: Exports_Execute |
|
statusCode: 404, errorCode: InvalidResourceType, errorMessage: The resource type 'ScheduledActions' could not be found in the namespace 'Microsoft.CostManagement' for api version '2023-04-01-preview'. The supported api-versions are '2020-03-01-preview,2022-04-01-preview,2022-06-01-preview,2022-10-01'. Source: runtime OperationId: ScheduledActions_CreateOrUpdate |
|
Expected type integer but found type string Source: response OperationId: ScheduledActions_CreateOrUpdate |
|
statusCode: 404, errorCode: InvalidResourceType, errorMessage: The resource type 'ScheduledActions' could not be found in the namespace 'Microsoft.CostManagement' for api version '2023-04-01-preview'. The supported api-versions are '2020-03-01-preview,2022-04-01-preview,2022-06-01-preview,2022-10-01'. Source: runtime OperationId: ScheduledActions_List |
|
Expected type integer but found type string Source: response OperationId: ScheduledActions_List |
|
statusCode: 404, errorCode: InvalidResourceType, errorMessage: The resource type 'ScheduledActions' could not be found in the namespace 'Microsoft.CostManagement' for api version '2023-04-01-preview'. The supported api-versions are '2020-03-01-preview,2022-04-01-preview,2022-06-01-preview,2022-10-01'. Source: runtime OperationId: ScheduledActions_Get |
|
Expected type integer but found type string Source: response OperationId: ScheduledActions_Get |
|
statusCode: 404, errorCode: MissingSubscription, errorMessage: The request did not have a subscription or a valid tenant level resource provider. Source: runtime OperationId: ScheduledActions_ListByScope |
|
Expected type integer but found type string Source: response OperationId: ScheduledActions_ListByScope |
|
statusCode: 404, errorCode: InvalidResourceType, errorMessage: The resource type 'ScheduledActions' could not be found in the namespace 'Microsoft.CostManagement' for api version '2023-04-01-preview'. The supported api-versions are '2020-03-01-preview,2022-04-01-preview,2022-06-01-preview,2022-10-01'. Source: runtime OperationId: ScheduledActions_Run |
|
Expected type integer but found type string Source: response OperationId: ScheduledActions_Run |
|
statusCode: 404, errorCode: MissingSubscription, errorMessage: The request did not have a subscription or a valid tenant level resource provider. Source: runtime OperationId: ScheduledActions_CreateOrUpdateByScope |
|
Expected type integer but found type string Source: response OperationId: ScheduledActions_CreateOrUpdateByScope |
|
statusCode: 404, errorCode: MissingSubscription, errorMessage: The request did not have a subscription or a valid tenant level resource provider. Source: runtime OperationId: ScheduledActions_GetByScope |
|
Expected type integer but found type string Source: response OperationId: ScheduledActions_GetByScope |
️️✔️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 @alprosms, Your PR has some issues. Please fix the CI sequentially by following the order of
|
|
Hi, @alprosms, 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 |
|
Hi @alprosms, one or multiple validation error/warning suppression(s) is detected in your PR. Please follow the Swagger-Suppression-Process to get approval. |
This was referenced Mar 28, 2023
visingla-ms
added
the
ARMSignedOff
openapi-workflow-bot
bot
removed
the
WaitForARMFeedback
AzureRestAPISpecReview
added
ReadyForApiTest
There was a problem hiding this comment.
Could we change the azure-sdk-for-net on line 404 in this file to azure-sdk-for-net-track2?
tadelesh
added
the
Approved-SdkBreakingChange-Go
|
Hi, @alprosms. 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 |
ghost
added
…ew (#23770) * changing azure-sdk-for-net to azure-sdk-for-net-track2 per ask from comment on main branch PR * Adding in descriptions + examples for RU Alerts support at the customer scope * fixing json formatting * fixing example references * Updating costmanagementproxyresource to reference ARM common proxy resource. Minor formatting change on scope parameter * Updating common-types with updates to common-types from 2022-10-01 version * prettier-fix
AzureRestAPISpecReview
added
BreakingChangeReviewRequired
|
Hi @alprosms, 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. |
…#23795) * updating costdetailreport swaggers from recent changes to 2022-10-01 version * suppressing invalid LintDiff errors
AzureRestAPISpecReview
removed
BreakingChangeReviewRequired
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
ArcturusZhang
approved these changes
May 4, 2023
ArcturusZhang
deleted the
dev-cost-management-Microsoft.CostManagement-2023-04-01-preview
branch
This was referenced May 4, 2023
|
@alprosms @ArcturusZhang these changes have started causing long file path issues for folks working in this repo on windows. Is there any reason we cannot shorten these paths? |
|
I've submitted PR #23834 to reduce the paths of these examles. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
-[x] 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.