Port Azure SDK patches to Consumption API v1.1.0 #1
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
According to the MS docs [1], modern customers with a Microsoft Customer Agreement (MCA) must use the `StartDate` and `EndDate` query parameters to get the usage details for a specific date range. Unfortunately, the API spec [2] does include these query parameters, so we are manually adding them to the generated client. If we don't add the query parameters, MCA users will get (many more) usage details items outside the intended time range. [1]: https://learn.microsoft.com/en-us/azure/cost-management-billing/costs/manage-automation#get-usage-details-for-a-scope-during-specific-date-range [2]: https://github.com/Azure/azure-rest-api-specs/blob/main/specification/consumption/resource-manager/Microsoft.Consumption/stable/2023-11-01/consumption.json#L106-L147
When there are more than 1000 usage details items, the Consumption API paginates the response. Each response page contains a 'next link' to the following page. The `$filter` query parameters contain a date range expression like the following: ``` properties/usageStart eq '2023-11-16' and properties/usageEnd eq '2023-11-16' ``` Unfortunately, the Azure service adds the query parameters value to the 'next link' without encoding them. Since one of the parameters, `$filter` contains space, it breaks the URL, causing the following parameters to get lost.
zmoog
changed the title
6 tasks
tommyers-elastic
approved these changes
Nov 30, 2023
zmoog
merged commit 6375973
into
sdk/resourcemanager/consumption/armconsumption/v1.1.0-elastic
1 check passed
zmoog
deleted the
zmoog/sdk/resourcemanager/consumption/armconsumption/v1.1.0-elastic
branch
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.
This PR ports two patches to the Azure SDK to address the following problems:
Add StartDate/EndDate parameters for MCA users
According to the Microsoft docs, modern customers with a Microsoft Customer Agreement (MCA) must use the
StartDateandEndDatequery parameters to get the usage details for a specific date range.Unfortunately, the API spec does include these query parameters, so we are manually adding them to the generated client.
If we don't add the query parameters, MCA users will get (many more) usage details items outside the intended time range.
URL encode 'next link' in multipage responses
When there are more than 1000 usage details items, the Consumption API paginates the response. Each response page contains a 'next link' to the following page.
The
$filterquery parameters contain a date range expression like the following:Unfortunately, the Azure service adds the query parameters value to the 'next link' without URL-encoding them. Since one of the parameters,
$filtercontains space, it breaks the URL, causing the following query parameters to get lost causing the error.