Forecast - Usage
Visar en lista över prognosavgifter för definierat omfång.
POST https://management.azure.com/{scope}/providers/Microsoft.CostManagement/forecast?api-version=2024-08-01
POST https://management.azure.com/{scope}/providers/Microsoft.CostManagement/forecast?$filter={$filter}&api-version=2024-08-01
URI-parametrar
Name | I | Obligatorisk | Typ | Description |
---|---|---|---|---|
scope
|
path | True |
string |
Omfånget som är associerat med prognosåtgärder. Detta inkluderar '/subscriptions/{subscriptionId}/' för prenumerationsomfånget, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' för resourceGroup-omfånget, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' för faktureringskontoomfång och "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}" för avdelningsomfång, "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{ enrollmentAccountId} för EnrollmentAccount-omfånget "/providers/Microsoft.Management/managementGroups/{managementGroupId} för hanteringsgruppsomfånget, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' för billingProfile scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' för invoiceSection scope och '/providers/Microsoft. Fakturering/faktureringKonton/{billingAccountId}/customers/{customerId} specifika för partner. |
api-version
|
query | True |
string |
DEN API-version som ska användas för den här åtgärden. |
$filter
|
query |
string |
Kan användas för att filtrera prognoser efter egenskaper/usageDate (Utc time), egenskaper/chargeType eller egenskaper/korn. Filtret stöder "eq", "lt", "gt", "le", "ge" och "and". Det stöder för närvarande inte "ne", "eller" eller "inte". |
Begärandetext
Name | Obligatorisk | Typ | Description |
---|---|---|---|
dataset | True |
Har definition för data i den här prognosen. |
|
timeframe | True |
Tidsramen för att hämta data för prognosen. Om det är anpassat måste en viss tidsperiod anges. |
|
type | True |
Typen av prognos. |
|
includeActualCost |
boolean |
Ett booleskt värde som avgör om actualCost inkluderas. |
|
includeFreshPartialCost |
boolean |
Ett booleskt värde som avgör om FreshPartialCost ska inkluderas. |
|
timePeriod |
Har en tidsperiod för att hämta data för prognosen. |
Svar
Name | Typ | Description |
---|---|---|
200 OK |
OKEJ. Begäran har slutförts. |
|
204 No Content |
Inget innehåll. Resursen är inte tillgänglig. |
|
Other Status Codes |
Felsvar som beskriver varför åtgärden misslyckades. |
Säkerhet
azure_auth
Azure Active Directory OAuth2 Flow.
Typ:
oauth2
Flow:
implicit
Auktoriseringswebbadress:
https://login.microsoftonline.com/common/oauth2/authorize
Omfattningar
Name | Description |
---|---|
user_impersonation | personifiera ditt användarkonto |
Exempel
Billing |
Billing |
Department |
Enrollment |
Invoice |
Resource |
Subscription |
BillingAccountForecast
Exempelbegäran
POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/forecast?api-version=2024-08-01
{
"type": "Usage",
"timeframe": "Custom",
"timePeriod": {
"from": "2022-08-01T00:00:00+00:00",
"to": "2022-08-31T23:59:59+00:00"
},
"dataset": {
"granularity": "Daily",
"aggregation": {
"totalCost": {
"name": "Cost",
"function": "Sum"
}
},
"filter": {
"and": [
{
"or": [
{
"dimensions": {
"name": "ResourceLocation",
"operator": "In",
"values": [
"East US",
"West Europe"
]
}
},
{
"tags": {
"name": "Environment",
"operator": "In",
"values": [
"UAT",
"Prod"
]
}
}
]
},
{
"dimensions": {
"name": "ResourceGroup",
"operator": "In",
"values": [
"API"
]
}
}
]
}
},
"includeActualCost": false,
"includeFreshPartialCost": false
}
Exempelsvar
{
"id": "providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd",
"name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd",
"type": "Microsoft.CostManagement/query",
"properties": {
"nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/Forecast?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D",
"columns": [
{
"name": "PreTaxCost",
"type": "Number"
},
{
"name": "UsageDate",
"type": "Number"
},
{
"name": "CostStatus",
"type": "String"
},
{
"name": "Currency",
"type": "String"
}
],
"rows": [
[
2.10333307059661,
20180331,
"Forecast",
"USD"
],
[
218.68795741935486,
20180331,
"Forecast",
"USD"
],
[
0.14384913581657052,
20180401,
"Forecast",
"USD"
],
[
0.009865586851323632,
20180429,
"Forecast",
"USD"
]
]
}
}
BillingProfileForecast
Exempelbegäran
POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/forecast?api-version=2024-08-01
{
"type": "Usage",
"timeframe": "Custom",
"timePeriod": {
"from": "2022-08-01T00:00:00+00:00",
"to": "2022-08-31T23:59:59+00:00"
},
"dataset": {
"granularity": "Daily",
"aggregation": {
"totalCost": {
"name": "Cost",
"function": "Sum"
}
},
"filter": {
"and": [
{
"or": [
{
"dimensions": {
"name": "ResourceLocation",
"operator": "In",
"values": [
"East US",
"West Europe"
]
}
},
{
"tags": {
"name": "Environment",
"operator": "In",
"values": [
"UAT",
"Prod"
]
}
}
]
},
{
"dimensions": {
"name": "ResourceGroup",
"operator": "In",
"values": [
"API"
]
}
}
]
}
},
"includeActualCost": false,
"includeFreshPartialCost": false
}
Exempelsvar
{
"id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd",
"name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd",
"type": "Microsoft.CostManagement/query",
"properties": {
"nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/Forecast?api-version=2019-10-01&$skiptoken=AQAAAA%3D%3D",
"columns": [
{
"name": "PreTaxCost",
"type": "Number"
},
{
"name": "UsageDate",
"type": "Number"
},
{
"name": "CostStatus",
"type": "String"
},
{
"name": "Currency",
"type": "String"
}
],
"rows": [
[
2.10333307059661,
20180331,
"Forecast",
"USD"
],
[
218.68795741935486,
20180331,
"Forecast",
"USD"
],
[
0.14384913581657052,
20180401,
"Forecast",
"USD"
],
[
0.009865586851323632,
20180429,
"Forecast",
"USD"
]
]
}
}
DepartmentForecast
Exempelbegäran
POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/departments/123/providers/Microsoft.CostManagement/forecast?api-version=2024-08-01
{
"type": "Usage",
"timeframe": "Custom",
"timePeriod": {
"from": "2022-08-01T00:00:00+00:00",
"to": "2022-08-31T23:59:59+00:00"
},
"dataset": {
"granularity": "Daily",
"aggregation": {
"totalCost": {
"name": "Cost",
"function": "Sum"
}
},
"filter": {
"and": [
{
"or": [
{
"dimensions": {
"name": "ResourceLocation",
"operator": "In",
"values": [
"East US",
"West Europe"
]
}
},
{
"tags": {
"name": "Environment",
"operator": "In",
"values": [
"UAT",
"Prod"
]
}
}
]
},
{
"dimensions": {
"name": "ResourceGroup",
"operator": "In",
"values": [
"API"
]
}
}
]
}
},
"includeActualCost": false,
"includeFreshPartialCost": false
}
Exempelsvar
{
"id": "providers/Microsoft.Billing/billingAccounts/12345:6789/departments/123/providers/Microsoft.CostManagement/query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd",
"name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd",
"type": "Microsoft.CostManagement/query",
"properties": {
"nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/departments/123/providers/Microsoft.CostManagement/Forecast?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D",
"columns": [
{
"name": "PreTaxCost",
"type": "Number"
},
{
"name": "UsageDate",
"type": "Number"
},
{
"name": "CostStatus",
"type": "String"
},
{
"name": "Currency",
"type": "String"
}
],
"rows": [
[
2.10333307059661,
20180331,
"Forecast",
"USD"
],
[
218.68795741935486,
20180331,
"Forecast",
"USD"
],
[
0.14384913581657052,
20180401,
"Forecast",
"USD"
],
[
0.009865586851323632,
20180429,
"Forecast",
"USD"
]
]
}
}
EnrollmentAccountForecast
Exempelbegäran
POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/enrollmentAccounts/456/providers/Microsoft.CostManagement/forecast?api-version=2024-08-01
{
"type": "Usage",
"timeframe": "Custom",
"timePeriod": {
"from": "2022-08-01T00:00:00+00:00",
"to": "2022-08-31T23:59:59+00:00"
},
"dataset": {
"granularity": "Daily",
"aggregation": {
"totalCost": {
"name": "Cost",
"function": "Sum"
}
},
"filter": {
"and": [
{
"or": [
{
"dimensions": {
"name": "ResourceLocation",
"operator": "In",
"values": [
"East US",
"West Europe"
]
}
},
{
"tags": {
"name": "Environment",
"operator": "In",
"values": [
"UAT",
"Prod"
]
}
}
]
},
{
"dimensions": {
"name": "ResourceGroup",
"operator": "In",
"values": [
"API"
]
}
}
]
}
},
"includeActualCost": false,
"includeFreshPartialCost": false
}
Exempelsvar
{
"id": "providers/Microsoft.Billing/billingAccounts/12345:6789/enrollmentAccounts/456/providers/Microsoft.CostManagement/query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd",
"name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd",
"type": "Microsoft.CostManagement/query",
"properties": {
"nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/enrollmentAccounts/456/providers/Microsoft.CostManagement/Forecast?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D",
"columns": [
{
"name": "PreTaxCost",
"type": "Number"
},
{
"name": "UsageDate",
"type": "Number"
},
{
"name": "CostStatus",
"type": "String"
},
{
"name": "Currency",
"type": "String"
}
],
"rows": [
[
2.10333307059661,
20180331,
"Forecast",
"USD"
],
[
218.68795741935486,
20180331,
"Forecast",
"USD"
],
[
0.14384913581657052,
20180401,
"Forecast",
"USD"
],
[
0.009865586851323632,
20180429,
"Forecast",
"USD"
]
]
}
}
InvoiceSectionForecast
Exempelbegäran
POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/forecast?api-version=2024-08-01
{
"type": "Usage",
"timeframe": "Custom",
"timePeriod": {
"from": "2022-08-01T00:00:00+00:00",
"to": "2022-08-31T23:59:59+00:00"
},
"dataset": {
"granularity": "Daily",
"aggregation": {
"totalCost": {
"name": "Cost",
"function": "Sum"
}
},
"filter": {
"and": [
{
"or": [
{
"dimensions": {
"name": "ResourceLocation",
"operator": "In",
"values": [
"East US",
"West Europe"
]
}
},
{
"tags": {
"name": "Environment",
"operator": "In",
"values": [
"UAT",
"Prod"
]
}
}
]
},
{
"dimensions": {
"name": "ResourceGroup",
"operator": "In",
"values": [
"API"
]
}
}
]
}
},
"includeActualCost": false,
"includeFreshPartialCost": false
}
Exempelsvar
{
"id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd",
"name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd",
"type": "Microsoft.CostManagement/query",
"properties": {
"nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/Forecast?api-version=2019-10-01&$skiptoken=AQAAAA%3D%3D",
"columns": [
{
"name": "PreTaxCost",
"type": "Number"
},
{
"name": "UsageDate",
"type": "Number"
},
{
"name": "CostStatus",
"type": "String"
},
{
"name": "Currency",
"type": "String"
}
],
"rows": [
[
2.10333307059661,
20180331,
"Forecast",
"USD"
],
[
218.68795741935486,
20180331,
"Forecast",
"USD"
],
[
0.14384913581657052,
20180401,
"Forecast",
"USD"
],
[
0.009865586851323632,
20180429,
"Forecast",
"USD"
]
]
}
}
ResourceGroupForecast
Exempelbegäran
POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer/providers/Microsoft.CostManagement/forecast?api-version=2024-08-01
{
"type": "Usage",
"timeframe": "Custom",
"timePeriod": {
"from": "2022-08-01T00:00:00+00:00",
"to": "2022-08-31T23:59:59+00:00"
},
"dataset": {
"granularity": "Daily",
"aggregation": {
"totalCost": {
"name": "Cost",
"function": "Sum"
}
},
"filter": {
"and": [
{
"or": [
{
"dimensions": {
"name": "ResourceLocation",
"operator": "In",
"values": [
"East US",
"West Europe"
]
}
},
{
"tags": {
"name": "Environment",
"operator": "In",
"values": [
"UAT",
"Prod"
]
}
}
]
},
{
"dimensions": {
"name": "ResourceGroup",
"operator": "In",
"values": [
"API"
]
}
}
]
}
},
"includeActualCost": false,
"includeFreshPartialCost": false
}
Exempelsvar
{
"id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer/providers/Microsoft.CostManagement/query/00000000-0000-0000-0000-000000000000",
"name": "55312978-ba1b-415c-9304-cfd9c43c0481",
"type": "Microsoft.CostManagement/query",
"properties": {
"nextLink": null,
"columns": [
{
"name": "PreTaxCost",
"type": "Number"
},
{
"name": "UsageDate",
"type": "Number"
},
{
"name": "CostStatus",
"type": "String"
},
{
"name": "Currency",
"type": "String"
}
],
"rows": [
[
2.10333307059661,
20180331,
"Forecast",
"USD"
]
]
}
}
SubscriptionForecast
Exempelbegäran
POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/forecast?api-version=2024-08-01
{
"type": "Usage",
"timeframe": "Custom",
"timePeriod": {
"from": "2022-08-01T00:00:00+00:00",
"to": "2022-08-31T23:59:59+00:00"
},
"dataset": {
"granularity": "Daily",
"aggregation": {
"totalCost": {
"name": "Cost",
"function": "Sum"
}
},
"filter": {
"and": [
{
"or": [
{
"dimensions": {
"name": "ResourceLocation",
"operator": "In",
"values": [
"East US",
"West Europe"
]
}
},
{
"tags": {
"name": "Environment",
"operator": "In",
"values": [
"UAT",
"Prod"
]
}
}
]
},
{
"dimensions": {
"name": "ResourceGroup",
"operator": "In",
"values": [
"API"
]
}
}
]
}
},
"includeActualCost": false,
"includeFreshPartialCost": false
}
Exempelsvar
{
"id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/query/00000000-0000-0000-0000-000000000000",
"name": "55312978-ba1b-415c-9304-cfd9c43c0481",
"type": "Microsoft.CostManagement/query",
"properties": {
"nextLink": null,
"columns": [
{
"name": "PreTaxCost",
"type": "Number"
},
{
"name": "UsageDate",
"type": "Number"
},
{
"name": "CostStatus",
"type": "String"
},
{
"name": "Currency",
"type": "String"
}
],
"rows": [
[
2.10333307059661,
20180331,
"Forecast",
"USD"
],
[
218.68795741935486,
20180331,
"Forecast",
"USD"
],
[
0.14384913581657052,
20180401,
"Forecast",
"USD"
],
[
0.009865586851323632,
20180429,
"Forecast",
"USD"
]
]
}
}
Definitioner
Name | Description |
---|---|
Error |
Information om felet. |
Error |
Felsvaret anger att tjänsten inte kan bearbeta den inkommande begäran. Orsaken anges i felmeddelandet. Några felsvar:
|
Forecast |
Det sammansättningsuttryck som ska användas i prognosen. |
Forecast |
Egenskaper för prognoskolumn |
Forecast |
Jämförelseuttrycket som ska användas i prognosen. |
Forecast |
Definitionen av data som finns i prognosen. |
Forecast |
Konfigurationen av datamängden i prognosen. |
Forecast |
Definitionen av en prognos. |
Forecast |
Filteruttrycket som ska användas i exporten. |
Forecast |
Operatorn som ska användas för jämförelse. |
Forecast |
Resultat av prognos. Den innehåller alla kolumner som anges under gruppering och sammansättning. |
Forecast |
Tidsramen för att hämta data för prognosen. |
Forecast |
Har en tidsperiod för att hämta data för prognosen. |
Forecast |
Typen av prognos. |
Function |
Namnet på kolumnen som ska aggregeras. |
Function |
Namnet på den sammansättningsfunktion som ska användas. |
Granularity |
Kornigheten för rader i prognosen. |
ErrorDetails
Information om felet.
Name | Typ | Description |
---|---|---|
code |
string |
Felkod. |
message |
string |
Felmeddelande som anger varför åtgärden misslyckades. |
ErrorResponse
Felsvaret anger att tjänsten inte kan bearbeta den inkommande begäran. Orsaken anges i felmeddelandet.
Några felsvar:
429 TooManyRequests – Begäran begränsas. Försök igen efter att ha väntat på den tid som anges i rubriken "x-ms-ratelimit-microsoft.consumption-retry-after".
503 ServiceUnavailable – Tjänsten är inte tillgänglig för tillfället. Försök igen efter att ha väntat på den tid som anges i rubriken "Försök igen".
Name | Typ | Description |
---|---|---|
error |
Information om felet. |
ForecastAggregation
Det sammansättningsuttryck som ska användas i prognosen.
Name | Typ | Description |
---|---|---|
function |
Namnet på den sammansättningsfunktion som ska användas. |
|
name |
Namnet på kolumnen som ska aggregeras. |
ForecastColumn
Egenskaper för prognoskolumn
Name | Typ | Description |
---|---|---|
name |
string |
Namnet på kolumnen. |
type |
string |
Typ av kolumn. |
ForecastComparisonExpression
Jämförelseuttrycket som ska användas i prognosen.
Name | Typ | Description |
---|---|---|
name |
string |
Namnet på kolumnen som ska användas i jämförelse. |
operator |
Operatorn som ska användas för jämförelse. |
|
values |
string[] |
Matris med värden som ska användas för jämförelse |
ForecastDataset
Definitionen av data som finns i prognosen.
Name | Typ | Description |
---|---|---|
aggregation |
<string,
Forecast |
Ordlista med sammansättningsuttryck som ska användas i prognosen. Nyckeln för varje objekt i ordlistan är aliaset för den aggregerade kolumnen. prognos kan ha upp till 2 aggregeringssatser. |
configuration |
Har konfigurationsinformation för data i exporten. Konfigurationen ignoreras om sammansättning och gruppering tillhandahålls. |
|
filter |
Har filteruttryck att använda i prognosen. |
|
granularity |
Kornigheten för rader i prognosen. |
ForecastDatasetConfiguration
Konfigurationen av datamängden i prognosen.
Name | Typ | Description |
---|---|---|
columns |
string[] |
Matris med kolumnnamn som ska ingå i prognosen. Ett giltigt namn på prognoskolumnen tillåts. Om det inte anges innehåller prognosen alla kolumner. |
ForecastDefinition
Definitionen av en prognos.
Name | Typ | Description |
---|---|---|
dataset |
Har definition för data i den här prognosen. |
|
includeActualCost |
boolean |
Ett booleskt värde som avgör om actualCost inkluderas. |
includeFreshPartialCost |
boolean |
Ett booleskt värde som avgör om FreshPartialCost ska inkluderas. |
timePeriod |
Har en tidsperiod för att hämta data för prognosen. |
|
timeframe |
Tidsramen för att hämta data för prognosen. Om det är anpassat måste en viss tidsperiod anges. |
|
type |
Typen av prognos. |
ForecastFilter
Filteruttrycket som ska användas i exporten.
Name | Typ | Description |
---|---|---|
and |
Det logiska "AND"-uttrycket. Måste ha minst 2 objekt. |
|
dimensions |
Har jämförelseuttryck för en dimension |
|
or |
Det logiska "OR"-uttrycket. Måste ha minst 2 objekt. |
|
tags |
Har jämförelseuttryck för en tagg |
ForecastOperatorType
Operatorn som ska användas för jämförelse.
Name | Typ | Description |
---|---|---|
In |
string |
ForecastResult
Resultat av prognos. Den innehåller alla kolumner som anges under gruppering och sammansättning.
Name | Typ | Description |
---|---|---|
eTag |
string |
ETag för resursen. |
id |
string |
Resurs-ID. |
location |
string |
Resursens plats. |
name |
string |
Resursnamn. |
properties.columns |
Matris med kolumner |
|
properties.nextLink |
string |
Länken (url) till nästa resultatsida. |
properties.rows |
Rows[] |
Matris med rader |
sku |
string |
SKU för resursen. |
tags |
object |
Resurstaggar. |
type |
string |
Resurstyp. |
ForecastTimeframe
Tidsramen för att hämta data för prognosen.
Name | Typ | Description |
---|---|---|
Custom |
string |
ForecastTimePeriod
Har en tidsperiod för att hämta data för prognosen.
Name | Typ | Description |
---|---|---|
from |
string |
Startdatumet för att hämta data från. |
to |
string |
Slutdatumet för att hämta data till. |
ForecastType
Typen av prognos.
Name | Typ | Description |
---|---|---|
ActualCost |
string |
|
AmortizedCost |
string |
|
Usage |
string |
FunctionName
Namnet på kolumnen som ska aggregeras.
Name | Typ | Description |
---|---|---|
Cost |
string |
|
CostUSD |
string |
|
PreTaxCost |
string |
|
PreTaxCostUSD |
string |
FunctionType
Namnet på den sammansättningsfunktion som ska användas.
Name | Typ | Description |
---|---|---|
Sum |
string |
GranularityType
Kornigheten för rader i prognosen.
Name | Typ | Description |
---|---|---|
Daily |
string |