azure-powershell
azure-powershell copied to clipboard
Azure
Get-AzConsumptionUsageDetail returns 'BadRequest'
same issue as https://github.com/Azure/azure-powershell/issues/10203 , however that is closed so I'm opening a new issue
Steps to reproduce
Get-AzConsumptionUsageDetail : Operation returned an invalid status code 'BadRequest'
At line:1 char:1
+ Get-AzConsumptionUsageDetail
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+ CategoryInfo : CloseError: (:) [Get-AzConsumptionUsageDetail], ErrorResponseException
+ FullyQualifiedErrorId : Microsoft.Azure.Commands.Consumption.Cmdlets.UsageDetails.GetAzureRmConsumptionUsageDetail
Environment data
PS C:\WINDOWS\system32> $PSVersionTable
Name Value
---- -----
PSVersion 5.1.18362.752
PSEdition Desktop
PSCompatibleVersions {1.0, 2.0, 3.0, 4.0...}
BuildVersion 10.0.18362.752
CLRVersion 4.0.30319.42000
WSManStackVersion 3.0
PSRemotingProtocolVersion 2.3
SerializationVersion 1.1.0.1
Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc @ms-premp.
![msftbot[bot] avatar](https://avatars.githubusercontent.com/in/26612?v=4 "Published by a pub.dev verified publisher"){kind=small}
Thanks for reporting. I can see the similar issue. It seems SDK doesn't return error details.
@PcChip , please set $DebugPreference="Continue" and then execute Get-AzConsumptionUsageDetail. Then, you should get the detail information from response. Please share error message to us.
I'm not sure what parts of this I need to sanitize so I left off a lot of previous [DEBUG] output, but this might be what you're after,
I suspect this is of importance "api-version=2018-01-31"
DEBUG: ============================ HTTP REQUEST ============================
HTTP Method:
GET
Absolute Uri:
https://management.azure.com/subscriptions/[REDACTED]/providers/Microsoft.Consumption/usageDetails?$top=1000&api-version=2018-01-31
Headers:
x-ms-client-request-id : 24217901-244a-499d-b391-959aaf39f6e5
accept-language : en-US
Body:
DEBUG: ============================ HTTP RESPONSE ============================
Status Code:
BadRequest
Headers:
Pragma : no-cache
session-id : f3654ade-07cc-437c-adbb-175feac17ee5
x-ms-request-id : ea46b8d0-d573-4a3b-a1f8-98b49f0fccf9
x-ms-correlation-request-id : c4321a65-3464-4a2e-8615-5558b2f5689e
x-ms-client-request-id : bfa224e5-3d90-4060-aaff-94a0cf00ec64
x-ms-ratelimit-microsoft.consumption-tenant-retry-after: 60
x-ms-ratelimit-remaining-microsoft.consumption-tenant-requests: 9
OData-Version : 4.0
Access-Control-Allow-Origin : *
X-Content-Type-Options : nosniff
Strict-Transport-Security : max-age=31536000; includeSubDomains
x-ms-ratelimit-remaining-subscription-reads: 11999
x-ms-routing-request-id : EASTUS:20200804T165914Z:c4321a65-3464-4a2e-8615-5558b2f5689e
Cache-Control : no-cache
Date : Tue, 04 Aug 2020 16:59:14 GMT
Body:
{
"error": {
"code": "400",
"message": "Subscription scope usage is not supported for current api version. Please use api version after 2019-10-01 (Request ID: ea46b8d0-d573-4a3b-a1f8-98b49f0fccf9)"
}
}
Get-AzConsumptionUsageDetail : Operation returned an invalid status code 'BadRequest'
At line:1 char:1
+ Get-AzConsumptionUsageDetail
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+ CategoryInfo : CloseError: (:) [Get-AzConsumptionUsageDetail], ErrorResponseException
+ FullyQualifiedErrorId : Microsoft.Azure.Commands.Consumption.Cmdlets.UsageDetails.GetAzureRmConsumptionUsageDetail
DEBUG: AzureQoSEvent: CommandName - Get-AzConsumptionUsageDetail; IsSuccess - False; Duration - 00:00:02.3438538;; Exception - Microsoft.Azure.Management.Consumption.Models.ErrorResponseException: Operation
returned an invalid status code 'BadRequest'
at Microsoft.Azure.Management.Consumption.UsageDetailsOperations.<ListWithHttpMessagesAsync>d__5.MoveNext()
--- End of stack trace from previous location where exception was thrown ---
at System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw()
at System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task)
at Microsoft.Azure.Management.Consumption.UsageDetailsOperationsExtensions.<ListAsync>d__1.MoveNext()
--- End of stack trace from previous location where exception was thrown ---
at System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw()
at Microsoft.Azure.Commands.Consumption.Cmdlets.UsageDetails.GetAzureRmConsumptionUsageDetail.ExecuteCmdlet();
DEBUG: Finish sending metric.
DEBUG: 11:59:23 AM - GetAzureRmConsumptionUsageDetail end processing.
Code 400 means BadRequest. its detail message is Subscription scope usage is not supported for current api version. Please use api version after 2019-10-01 (Request ID: ea46b8d0-d573-4a3b-a1f8-98b49f0fccf9)
Service team, please check this issue.
@PcChip I have the same problem and opened a ticket as I thought it had something to do with a resource provider that wouldn't register. They are telling me it has something to do with Legacy vs Modern subscriptions, which I had never heard of before. I used the API directly and was able to return results using the 2019-10-01 version. @dingmeng-xue do you know when the API will be updated in the module?
This is affecting us as well. We have a Azure runbook that we've created that checks for reservation utilization. Since the API version changed, the Get-AzConsumptionUsageDetail cmdlet no long works. When enabling debug preference, I see the same error as @PcChip
thank you for your feedback. The Old SDK does not support non-EA subscription. A new version of SDK (Potentially to be released by end of this year) will fix this. REST API is the best alternative right now.
I am having the same issue as well.
The Old SDK does not support non-EA subscription
@ramaganesan-rg By SDK do you mean this Powershell module?
Do you mean I should try to use the REST API directly and I might be able to get the information?
@ramaganesan-rg why is this issue closed? The bug still exists in the latest version of Azure Powershell (5.1.2). What is the status of the new SDK that contains the fix?
@ramaganesan-rg , could you explain this question further? If it is fixed on service side, and does user not need to update module?
I'm also still having this issue. What's the status?
Can someone please point me to the REST API method? Thanks.
I have had a case with MS support since December. I asked for a time estimate when this will be fixed and got this back:
I sincerely apologize for any inconvenience this may be causing, however, after considerable review with our cost management team and Technical leads, it has been confirmed that there is curently no estimated time as this feature is not supported.
I guess they mean that the API version the Powershell command is using is not supported. Our hope seem to be an update of the Powershell command to use the supported API version. I am not really happy with rewriting my scripts to use the REST API instead.
[Updated 2021.03.30 after reply from @tomasrudh] In case it helps anyone, I wrote the following to work around the problem. It is tailored to solve my particular need for daily data collection but anyone can alter to suit their needs. There is a little uncertainty in the mapping between 'legacy' and 'modern' response properties but the values seem to closely match the data I've already collected.
function Get-ConsumptionUsageDetail {
[CmdletBinding()]
param (
[Parameter(Mandatory)]
[string] $SubscriptionId,
[Parameter(Mandatory)]
[ValidateSet('Legacy', 'Modern')]
[string] $SubscriptionKind,
[Parameter(Mandatory)]
[datetime] $Date
)
$isLegacy = $SubscriptionKind -eq 'Legacy'
$resource = 'https://management.azure.com'
$context = [Microsoft.Azure.Commands.Common.Authentication.Abstractions.AzureRmProfileProvider]::Instance.Profile.DefaultContext
$accessToken = [Microsoft.Azure.Commands.Common.Authentication.AzureSession]::Instance.AuthenticationFactory.Authenticate($context.Account, $context.Environment, $context.Tenant.Id.ToString(), $null, [Microsoft.Azure.Commands.Common.Authentication.ShowDialog]::Never, $null, $resource).AccessToken
$dateFilter = $Date.Date.ToString('yyyy-MM-dd')
$uriPath = "https://management.azure.com/subscriptions/$($SubscriptionId)/providers/Microsoft.Consumption/usageDetails"
# https://docs.microsoft.com/en-us/azure/cost-management-billing/costs/manage-automation#get-usage-details-for-a-scope-during-specific-date-range
if ($isLegacy) {
$uriQuery = '?$expand=properties/meterDetails&$filter=properties/usageStart ge ''' + $dateFilter + ''' and properties/usageEnd le ''' + $dateFilter + '''&$top=5000&api-version=2019-10-01'
}
else {
$uriQuery = '?startDate=' + $dateFilter + '&endDate=' + $dateFilter + '&$top=5000&api-version=2019-10-01'
}
$uri = $uriPath + $uriQuery
$consumptionDetailsRaw = Invoke-RestMethod -Method 'Get' -Uri $uri -Headers @{ Authorization = "Bearer " + $accessToken }
$consumptionDetails = @()
foreach ($detail in $consumptionDetailsRaw.value) {
$convertedDetail = @{
SubscriptionGuid = if ($isLegacy) { $detail.properties.subscriptionId } else { $detail.properties.subscriptionGuid }
InstanceName = if ($isLegacy) { $detail.properties.resourceName } else { ($detail.properties.instanceName -split '/')[-1] }
AccountName = if ($isLegacy) { $detail.properties.accountName } else { $detail.properties.billingAccountName }
DepartmentName = if ($isLegacy) { $detail.properties.invoiceSection } else { $detail.properties.billingProfileName }
CostCenter = $detail.properties.costCenter
BillingPeriodName = $detail.properties.billingPeriodStartDate
UsageStart = $detail.properties.date
UsageEnd = $detail.properties.date
ConsumedService = $detail.properties.consumedService
Product = $detail.properties.product
Currency = if ($isLegacy) { $detail.properties.billingCurrency } else { $detail.properties.billingCurrencyCode }
MeterDetails = @{
MeterName = $detail.properties.meterDetails.meterName
MeterCategory = $detail.properties.meterDetails.meterCategory
MeterSubCategory = $detail.properties.meterDetails.meterSubCategory
Unit = $detail.properties.meterDetails.unitOfMeasure
MeterLocation = $detail.properties.resourceLocation
}
UsageQuantity = $detail.properties.quantity
PreTaxCost = if ($isLegacy) { $detail.properties.cost } else { $detail.properties.costInUSD }
}
$consumptionDetails += $convertedDetail
}
$consumptionDetails
}
I call it with something like:
$result = Get-ConsumptionUsageDetail -SubscriptionId (Get-AzContext).Subscription.Id -SubscriptionKind 'Modern' -Date '2021-03-23' -Verbose
Thanks Brian! Useful script. However, for the subscription where I cannot run the cmdlet Get-AzConsumptionUsageDetail this script also don't work, it seems filtering is not working. It is working fine for another subscription. I have placed another support case to Microsoft for the REST API problem.
We are having the exact same issue. Is there any ETA by when this will be fixed?
The support case I have with MS is still open, since December. Neither the above Powershell commandlet nor the REST API do work. I suspect it has to do with our subscription are 'modern'. MS support asks a question, or suggests something, I test and answer usually within a day or two. Then MS gets back after a week or two, at best. They have no ETA, they have not even said it is a known problem. If you have the possibility, please log a support case at MS.
Rest API should work, you can get more information in https://docs.microsoft.com/en-us/rest/api/consumption/usage-details/list,
The REST API do work, at least until you try to use filter, that function seem to be broken as well. This might also only be a problem for 'modern' subscriptions. I had a remote with MS support last week and showed them, they will investigate.
Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc @ms-premp.
Issue Details
same issue as https://github.com/Azure/azure-powershell/issues/10203 , however that is closed so I'm opening a new issue
Steps to reproduce
Get-AzConsumptionUsageDetail : Operation returned an invalid status code 'BadRequest'
At line:1 char:1
+ Get-AzConsumptionUsageDetail
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+ CategoryInfo : CloseError: (:) [Get-AzConsumptionUsageDetail], ErrorResponseException
+ FullyQualifiedErrorId : Microsoft.Azure.Commands.Consumption.Cmdlets.UsageDetails.GetAzureRmConsumptionUsageDetail
Environment data
PS C:\WINDOWS\system32> $PSVersionTable
Name Value
---- -----
PSVersion 5.1.18362.752
PSEdition Desktop
PSCompatibleVersions {1.0, 2.0, 3.0, 4.0...}
BuildVersion 10.0.18362.752
CLRVersion 4.0.30319.42000
WSManStackVersion 3.0
PSRemotingProtocolVersion 2.3
SerializationVersion 1.1.0.1
| Author: | PcChip |
|---|---|
| Assignees: | - |
| Labels: |
|
| Milestone: | - |
We're having the same issue.
We recently converted from a pay-as-you-go to an MCA. Not sure if that's the issue?
@PcChip @c240amg @tomasrudh @DecimalZero
FWiW - Had the same issue, got BadRequest when calling Get-AzConsumptionUsageDetail using a Service Principal (in Azure Automation or from the CLI).
My org has ~12 Azure Subscriptions of various types. I could [foreach] my way through 2 of the 12 successfully w/ the Get-AzConsumptionUsageDetail command. 10 subs resulted in BadRequest.
Progress 1: While the Svc Principal account I was using had the [Billing Reader] role at the Subscription level, it wasn't at the Billing Scope level. I called our Azure Admin & got put into a top-level Billing Reader custom group he created.
Next, I ensured that the SPAccount had the Billing Reader role at each Sub level.
Success! Now, I can loop through 5 more of the 12. That explained some of my BadRequest errors. The original 2 subs that worked were bound to a different billing root (for some odd reason, perhaps having to due to the fact that we got credits years ago - not sure - not all accounts were moved over to the new root/scope.)
So, the case I opened at Microsoft in December is finally closed, unfortunately without a proper solution. The problems are because our subscriptions have been changed to 'modern' subscriptions. My conclusion is this:
Pro: The invoices have better grouping of costs
Cons: Reading out cost using PowerShell do not work Reading out cost on management level do not work Filtering do not work when reading out cost using the REST API
Microsoft has no plan to fix this, not that they want to share anyway.
I am also facing this 'Bad Request' while executing the below code on Azure Runbook. On the local machine, it is working fine.
Get-AzConsumptionUsageDetail -StartDate $startDate -EndDate $endDate | Measure-Object -Property PretaxCost -Sum
Error:
Get-AzConsumptionUsageDetail : Operation returned an invalid status code 'BadRequest' At line:44 char:16 + ... rrentCost = Get-AzConsumptionUsageDetail -StartDate $startDate -EndDa ... + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + CategoryInfo : CloseError: (:) [Get-AzConsumptionUsageDetail], ErrorResponseException + FullyQualifiedErrorId : Microsoft.Azure.Commands.Consumption.Cmdlets.UsageDetails.GetAzureRmConsumptionUsageDetail
After put -debug, the error is:
Get-AzConsumptionUsageDetail : A command that prompts the user failed because the host program or the command type does not support user interaction. The host was attempting to request confirmation with the following message: A command that prompts the user failed because the host program or the command type does not support user interaction. The host was attempting to request confirmation with the following message: Operation returned an invalid status code 'BadRequest' At line:44 char:16 + ... rrentCost = Get-AzConsumptionUsageDetail -StartDate $startDate -EndDa ... + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + CategoryInfo : NotImplemented: (:) [Get-AzConsumptionUsageDetail], HostException + FullyQualifiedErrorId : HostFunctionNotImplemented,Microsoft.Azure.Commands.Consumption.Cmdlets.UsageDetails.GetAzureRmConsumptionUsageDetail
I tried with -Force and -Confirm:$false but had no luck.
Can someone please help with this?
@rajnegi - Give up on Get-AzConsumptionUsageDetails until MS updates it to reflect the 2 methods for querying the Microsoft.Consumption Management API.
Scroll up and take note of the replacement function written by @brianstringfellow. I've adapted this, slightly, to account for the modern & legacy subscription types I'm passing in and added some try/catch to deal with gatewayTimeout retries (simple). Works as designed. I'm getting Consumption Details for all subscriptions now. Best.
I shared the information on this issue with our on-calls they will look into it and update the thread. stay tuned.
Finally able to resolve this issue. Actually, i am passing date format in ("dd-MM-yyyy") for 'BillingPeriodStartDate' and 'BillingPeriodEndDate'. The date format should be ("yyyy-MM-dd") I don't know why it is correctly working with ("dd-MM-yyyy") format in my local machine. After using ("yyyy-MM-dd") format, It is working on both local and Azure runbook.
Debug logs really help me to find out the exact problem.
That do not work for me. The error message says the called API is of the wrong version, so I actually don't think it is a problem with date format. But glad it worked for you!