azure-rest-api-specs
azure-rest-api-specs copied to clipboard
#16475 Add 'startDate' and 'endDate' query params to UsageDetails_List endpoint spec
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Fixes #16475
Changelog
Add a changelog entry for this PR by answering the following questions:
- What's the purpose of the update?
- [ ] new service onboarding
- [ ] new API version
- [ ] update existing version for new feature
- [x] update existing version to fix swagger quality issue in s360
- [ ] Other, please clarify
- When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
ASAP
- When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
ASAP
- If updating an existing version, please select the specific language SDKs and CLIs that must be refreshed after the swagger is published.
- [x] SDK of .NET (need service team to ensure code readiness)
- [x] SDK of Python
- [x] SDK of Java
- [x] SDK of Js
- [x] SDK of Go
- [x] PowerShell
- [ ] CLI
- [ ] Terraform
- [ ] No refresh required for updates in this PR
Contribution checklist:
- [x] I commit to follow the Breaking Change Policy of "no breaking changes"
- [x] I have reviewed the documentation for the workflow.
- [x] Validation tools were run on swagger spec(s) and errors have all been fixed in this PR. How to fix?
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Applicability: :warning:
If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.
- Change to data plane APIs
- Adding new properties
- All removals
Otherwise your PR may be subject to ARM review requirements. Complete the following:
-
[ ] Check this box if any of the following appy 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.
- Adding a new service
- Adding new API(s)
- Adding a new API version -[ ] To review changes efficiently, ensure you are using OpenAPIHub to initialize the PR for adding a new version. 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 any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.
- [ ] Removing API(s) in a stable version
- [ ] Removing properties in a stable version
- [ ] Removing API version(s) in a stable version
- [ ] Updating API in a stable or public preview version with Breaking Change Validation errors
- [ ] Updating API(s) in public preview over 1 year (refer to Retirement of Previews)
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.
Please follow the link to find more details on PR review process.
Hi, @tommyers-elastic Thanks for your PR. I am workflow bot for review process. Here are some small tips.
Swagger Validation Report
️❌BreakingChange: 2 Errors, 0 Warnings failed [Detail]
- Compared Swaggers (Based on Oad v0.9.5)
- current:stable/2021-10-01/consumption.json compared with base:stable/2021-10-01/consumption.json
| Rule | Message |
|---|---|
1043 - AddingOptionalParameter |
The optional parameter '$startDate' was added in the new version. New: Microsoft.Consumption/stable/2021-10-01/consumption.json#L141:11 |
1043 - AddingOptionalParameter |
The optional parameter '$endDate' was added in the new version. New: Microsoft.Consumption/stable/2021-10-01/consumption.json#L148:11 |
️⚠️LintDiff: 0 Warnings warning [Detail]
- Linted configuring files (Based on source branch, openapi-validator v1.13.0 , classic-openapi-validator v1.2.4 )
- Linted configuring files (Based on target branch, openapi-validator v1.13.0 , classic-openapi-validator v1.2.4 )
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
R4011 - DeleteOperationResponses |
The delete operation is defined without a 200 or 204 error response implementation,please add it.' Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L441 |
R4018 - OperationsApiResponseSchema |
The response schema of operations API '/providers/Microsoft.Consumption/operations' does not match the ARM specification. Please standardize the schema. Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L1438 |
R4037 - MissingTypeObject |
The schema 'MeterDetails' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L1867 |
R4037 - MissingTypeObject |
The schema 'UsageDetailsListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L1946 |
R4037 - MissingTypeObject |
The schema 'LegacyUsageDetailProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L1984 |
R4037 - MissingTypeObject |
The schema 'ModernUsageDetailProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L2257 |
R4037 - MissingTypeObject |
The schema 'ReservationSummariesListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L2997 |
R4037 - MissingTypeObject |
The schema 'ReservationSummaryProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L3015 |
R4037 - MissingTypeObject |
The schema 'ReservationDetailsListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L3122 |
R4037 - MissingTypeObject |
The schema 'ReservationDetailProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L3140 |
R4037 - MissingTypeObject |
The schema 'ReservationRecommendationDetailsProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L3228 |
R4037 - MissingTypeObject |
The schema 'ReservationRecommendationDetailsCalculatedSavingsProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L3263 |
R4037 - MissingTypeObject |
The schema 'ReservationRecommendationDetailsResourceProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L3302 |
R4037 - MissingTypeObject |
The schema 'ReservationRecommendationDetailsSavingsProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L3340 |
R4037 - MissingTypeObject |
The schema 'ReservationRecommendationDetailsUsageProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L3379 |
R4037 - MissingTypeObject |
The schema 'ReservationRecommendationsListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L3412 |
R4037 - MissingTypeObject |
The schema 'SkuProperty' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L3609 |
R4037 - MissingTypeObject |
The schema 'ModernReservationRecommendationProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L3644 |
R4037 - MissingTypeObject |
The schema 'ModernReservationTransactionProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L3739 |
R4037 - MissingTypeObject |
The schema 'LegacyReservationTransactionProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L3886 |
R4037 - MissingTypeObject |
The schema 'ReservationTransactionsListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L4029 |
R4037 - MissingTypeObject |
The schema 'ModernReservationTransactionsListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L4047 |
R4037 - MissingTypeObject |
The schema 'TagProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L4081 |
R4037 - MissingTypeObject |
The schema 'Tag' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L4106 |
R4037 - MissingTypeObject |
The schema 'BudgetsListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L4122 |
R4037 - MissingTypeObject |
The schema 'BudgetProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L4156 |
R4037 - MissingTypeObject |
The schema 'BudgetTimePeriod' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L4227 |
R4037 - MissingTypeObject |
The schema 'BudgetFilter' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L4245 |
R4037 - MissingTypeObject |
The schema 'BudgetFilterProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L4267 |
R4037 - MissingTypeObject |
The schema 'BudgetComparisonExpression' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L4280 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️Cross-Version Breaking Changes succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️SDK Track2 Validation succeeded [Detail] [Expand]
Validation passes for SDKTrack2Validation
- The following tags are being changed in this PR
️️✔️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).
Swagger Generation Artifacts
️️✔️ApiDocPreview succeeded [Detail] [Expand]
Please click here to preview with your @microsoft account.
️❌SDK Breaking Change Tracking failed [Detail]
Breaking Changes Tracking
❌azure-sdk-for-python-track2 - track2_azure-mgmt-consumption - 9.0.0+ Model BudgetFilter no longer has parameter not_property + Operation ReservationRecommendationDetailsOperations.get has a new parameter resource_scope + Operation ReservationRecommendationsOperations.list has a new parameter resource_scope + Operation ReservationRecommendationsOperations.list no longer has parameter scope + Operation ReservationsDetailsOperations.list has a new parameter resource_scope + Operation ReservationsDetailsOperations.list no longer has parameter scope + Operation ReservationsSummariesOperations.list has a new parameter resource_scope + Operation ReservationsSummariesOperations.list no longer has parameter scope + Operation UsageDetailsOperations.list has a new parameter end_date + Operation UsageDetailsOperations.list has a new parameter start_date
❌azure-sdk-for-js - @azure/arm-consumption - 10.0.0+ Interface BudgetFilter no longer has parameter not + Operation ReservationRecommendationDetails.get has a new signature
️❌ azure-sdk-for-net failed [Detail]
❌Failed [Logs] Generate from b5b48f81fc448373ecf072bc4b67a0c9df529b66. SDK Automation 14.0.0warn Skip initScript due to not configured command sudo apt-get install -y dotnet-sdk-6.0 command autorest --version=2.0.4421 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION [email protected]/[email protected] --csharp-sdks-folder=/mnt/vss/_work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/consumption/resource-manager/readme.md cmderr [Autorest] realpath(): Permission denied cmderr [Autorest] realpath(): Permission denied cmderr [Autorest] realpath(): Permission denied cmderr [Autorest] realpath(): Permission denied cmderr [Autorest] realpath(): Permission denied cmderr [Autorest] realpath(): Permission denied cmderr [Autorest] No usable version of the libssl was found cmderr [Autorest] FATAL: csharp/simplifier - FAILED cmderr [Autorest] FATAL: Error: [Exception] AutoRest extension '@microsoft.azure/autorest.csharp' terminated. cmderr [Autorest] Process() cancelled due to exception : [Exception] AutoRest extension '@microsoft.azure/autorest.csharp' terminated. error Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-net]: autorest warn Skip package processing as generation is failed
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
️✔️Succeeded [Logs] Generate from b5b48f81fc448373ecf072bc4b67a0c9df529b66. 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
️✔️armconsumption [View full logs] [Preview SDK Changes]info [Changelog] ### Features Added info [Changelog] info [Changelog] - New field `StartDate` in struct `UsageDetailsClientListOptions` info [Changelog] - New field `EndDate` in struct `UsageDetailsClientListOptions` info [Changelog] info [Changelog] Total 0 breaking change(s), 1 additive change(s).
️⚠️ azure-sdk-for-python-track2 warning [Detail]
⚠️Warning [Logs] Generate from b5b48f81fc448373ecf072bc4b67a0c9df529b66. 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] 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] global `--global`, `--local` are deprecated. Use `--location=global` instead.
️✔️track2_azure-mgmt-consumption [View full logs] [Preview SDK Changes] Breaking Change Detectedinfo [Changelog] **Features** info [Changelog] info [Changelog] - Added operation LotsOperations.list_by_customer info [Changelog] info [Changelog] **Breaking changes** info [Changelog] info [Changelog] - Model BudgetFilter no longer has parameter not_property info [Changelog] - Operation ReservationRecommendationDetailsOperations.get has a new parameter resource_scope info [Changelog] - Operation ReservationRecommendationsOperations.list has a new parameter resource_scope info [Changelog] - Operation ReservationRecommendationsOperations.list no longer has parameter scope info [Changelog] - Operation ReservationsDetailsOperations.list has a new parameter resource_scope info [Changelog] - Operation ReservationsDetailsOperations.list no longer has parameter scope info [Changelog] - Operation ReservationsSummariesOperations.list has a new parameter resource_scope info [Changelog] - Operation ReservationsSummariesOperations.list no longer has parameter scope info [Changelog] - Operation UsageDetailsOperations.list has a new parameter end_date info [Changelog] - Operation UsageDetailsOperations.list has a new parameter start_date
️⚠️ azure-sdk-for-java warning [Detail]
⚠️Warning [Logs] Generate from b5b48f81fc448373ecf072bc4b67a0c9df529b66. SDK Automation 14.0.0command ./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json command ./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json cmderr [generate.py] SLF4J: Failed to load class "org.slf4j.impl.StaticLoggerBinder". cmderr [generate.py] SLF4J: Defaulting to no-operation (NOP) logger implementation cmderr [generate.py] SLF4J: See http://www.slf4j.org/codes.html#StaticLoggerBinder for further details.
️✔️azure-resourcemanager-consumption [View full logs] [Preview SDK Changes]
️⚠️ azure-sdk-for-js warning [Detail]
⚠️Warning [Logs] Generate from b5b48f81fc448373ecf072bc4b67a0c9df529b66. SDK Automation 14.0.0command sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json cmderr [automation_init.sh] deprecated [email protected]: The functionality that this package provided is now in @npmcli/arborist cmderr [automation_init.sh] deprecated [email protected]: Please upgrade to version 7 or higher. Older versions may use Math.random() in certain circumstances, which is known to be problematic. See https://v8.dev/blog/math-random for details. cmderr [automation_init.sh] deprecated @opentelemetry/[email protected]: Package renamed to @opentelemetry/api, see https://github.com/open-telemetry/opentelemetry-js cmderr [automation_init.sh] deprecated @azure/[email protected]: This version has been deprecated, please upgrade to the version tagged as latest cmderr [automation_init.sh] npm WARN @octokit/[email protected] requires a peer of @octokit/core@>=3 but none is installed. You must install peer dependencies yourself. 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
️✔️@azure/arm-consumption [View full logs] [Preview SDK Changes] Breaking Change Detectedinfo [Changelog] **Features** info [Changelog] info [Changelog] - Added operation LotsOperations.listByCustomer info [Changelog] - Added Interface LotsListByCustomerNextOptionalParams info [Changelog] - Added Interface LotsListByCustomerOptionalParams info [Changelog] - Added Type Alias LotsListByCustomerNextResponse info [Changelog] - Added Type Alias LotsListByCustomerResponse info [Changelog] - Interface UsageDetailsListNextOptionalParams has a new optional parameter endDate info [Changelog] - Interface UsageDetailsListNextOptionalParams has a new optional parameter startDate info [Changelog] - Interface UsageDetailsListOptionalParams has a new optional parameter endDate info [Changelog] - Interface UsageDetailsListOptionalParams has a new optional parameter startDate info [Changelog] - Type Alias LegacyUsageDetail has a new parameter benefitId info [Changelog] - Type Alias LegacyUsageDetail has a new parameter benefitName info [Changelog] - Enum KnownEventType has a new value CreditExpired info [Changelog] info [Changelog] **Breaking Changes** info [Changelog] info [Changelog] - Operation ReservationRecommendationDetails.get has a new signature info [Changelog] - Interface BudgetFilter no longer has parameter not
️⚠️ azure-resource-manager-schemas warning [Detail]
⚠️Warning [Logs] Generate from b5b48f81fc448373ecf072bc4b67a0c9df529b66. 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] WARN old lockfile cmderr [initScript.sh] npm WARN old lockfile The package-lock.json file was created with an old version of npm, cmderr [initScript.sh] npm WARN old lockfile so supplemental metadata must be fetched from the registry. cmderr [initScript.sh] npm WARN old lockfile cmderr [initScript.sh] npm WARN old lockfile This is a one-time fix-up, please be patient... cmderr [initScript.sh] npm WARN old lockfile 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 warn No file changes detected after generation
️✔️consumption [View full logs]
️️✔️ azure-powershell succeeded [Detail] [Expand]
️✔️Succeeded [Logs] Generate from b5b48f81fc448373ecf072bc4b67a0c9df529b66. 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.Consumption [View full logs] [Preview SDK Changes]
NewApiVersionRequired reason: A service’s API is a contract with customers and is represented by using the api-version query parameter. Changes such as adding an optional property to a request/response or introducing a new operation is a change to the service’s contract and therefore requires a new api-version value. This is critically important for documentation, client libraries, and customer support. EXAMPLE: if a customer calls a service in the public cloud using api-version=2020-07-27, the new property or operation may exist but if they call the service in a government cloud, air-gapped cloud, or Azure Stack Hub cloud using the same api-version, the property or operation may not exist. Because there is no clear relationship between the service api-version and the new property/operation, customers can’t trust the documentation and Azure customer have difficulty helping customers diagnose issues. In addition, each client library version documents the service version it supports. When an optional property or new operation is added to a service and its Swagger, new client libraries must be produced to expose this functionality to customers. Without updating the api-version, it is unclear to customers which version of a client library supports these new features.
Hi, @tommyers-elastic. 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.
Hi, @tommyers-elastic. 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.
Hi, @tommyers-elastic. 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.
Hi, @tommyers-elastic. 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.
Hi, @tommyers-elastic. 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.
Hi, @tommyers-elastic. 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.
Hi, @tommyers-elastic. 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.