Forecast - Usage
Lista os encargos de previsão para o escopo definido.
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
Parâmetros do URI
Name | Em | Necessário | Tipo | Description |
---|---|---|---|---|
scope
|
path | True |
string |
O escopo associado às operações de previsão. Isso inclui '/subscriptions/{subscriptionId}/' para o escopo da assinatura, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' para o escopo resourceGroup, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' para o escopo da Conta de Cobrança e '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' para o escopo do Departamento, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{ enrollmentAccountId}' para o escopo EnrollmentAccount, '/providers/Microsoft.Management/managementGroups/{managementGroupId} para o escopo do Grupo de Gerenciamento, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' para o escopo do billingProfile, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' para o escopo invoiceSection e '/providers/Microsoft. Billing/billingAccounts/{billingAccountId}/customers/{customerId}' específico para parceiros. |
api-version
|
query | True |
string |
A versão da API a ser usada para esta operação. |
$filter
|
query |
string |
Pode ser usado para filtrar previsões por propriedades/usageDate (hora UTC), propriedades/chargeType ou propriedades/grão. O filtro suporta 'eq', 'lt', 'gt', 'le', 'ge' e 'and'. Atualmente, não suporta «ne», «ou» ou «not». |
Corpo do Pedido
Name | Necessário | Tipo | Description |
---|---|---|---|
dataset | True |
Tem definição para os dados nesta previsão. |
|
timeframe | True |
O período de tempo para extrair dados para a previsão. Se for habitual, deve ser fornecido um período de tempo específico. |
|
type | True |
O tipo de previsão. |
|
includeActualCost |
boolean |
Um booleano determinando se actualCost será incluído. |
|
includeFreshPartialCost |
boolean |
Um booleano determinando se FreshPartialCost será incluído. |
|
timePeriod |
Tem período de tempo para extrair dados para a previsão. |
Respostas
Name | Tipo | Description |
---|---|---|
200 OK |
OK. O pedido foi bem-sucedido. |
|
204 No Content |
Sem conteúdo. O recurso não está disponível. |
|
Other Status Codes |
Resposta de erro descrevendo por que a operação falhou. |
Segurança
azure_auth
Fluxo OAuth2 do Azure Ative Directory.
Tipo:
oauth2
Fluxo:
implicit
URL de Autorização:
https://login.microsoftonline.com/common/oauth2/authorize
Âmbitos
Name | Description |
---|---|
user_impersonation | personificar a sua conta de utilizador |
Exemplos
Billing |
Billing |
Department |
Enrollment |
Invoice |
Resource |
Subscription |
BillingAccountForecast
Pedido de amostra
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
}
Resposta da amostra
{
"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
Pedido de amostra
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
}
Resposta da amostra
{
"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
Pedido de amostra
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
}
Resposta da amostra
{
"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
Pedido de amostra
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
}
Resposta da amostra
{
"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
Pedido de amostra
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
}
Resposta da amostra
{
"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
Pedido de amostra
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
}
Resposta da amostra
{
"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
Pedido de amostra
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
}
Resposta da amostra
{
"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"
]
]
}
}
Definições
Name | Description |
---|---|
Error |
Os detalhes do erro. |
Error |
A resposta de erro indica que o serviço não é capaz de processar a solicitação de entrada. O motivo é fornecido na mensagem de erro. Algumas respostas de erro:
|
Forecast |
A expressão de agregação a ser usada na previsão. |
Forecast |
Propriedades da coluna de previsão |
Forecast |
A expressão de comparação a ser usada na previsão. |
Forecast |
A definição dos dados presentes na previsão. |
Forecast |
A configuração do conjunto de dados na previsão. |
Forecast |
A definição de uma previsão. |
Forecast |
A expressão de filtro a ser usada na exportação. |
Forecast |
O operador a utilizar para comparação. |
Forecast |
Resultado da previsão. Ele contém todas as colunas listadas em agrupamentos e agregação. |
Forecast |
O período de tempo para extrair dados para a previsão. |
Forecast |
Tem período de tempo para extrair dados para a previsão. |
Forecast |
O tipo de previsão. |
Function |
O nome da coluna a ser agregada. |
Function |
O nome da função de agregação a ser usada. |
Granularity |
A granularidade das linhas na previsão. |
ErrorDetails
Os detalhes do erro.
Name | Tipo | Description |
---|---|---|
code |
string |
Código de erro. |
message |
string |
Mensagem de erro indicando por que a operação falhou. |
ErrorResponse
A resposta de erro indica que o serviço não é capaz de processar a solicitação de entrada. O motivo é fornecido na mensagem de erro.
Algumas respostas de erro:
429 TooManyRequests - A solicitação está limitada. Tente novamente depois de aguardar o tempo especificado no cabeçalho "x-ms-ratelimit-microsoft.consumption-retry-after".
503 ServiçoIndisponível - O serviço está temporariamente indisponível. Tente novamente depois de aguardar o tempo especificado no cabeçalho "Retry-After".
Name | Tipo | Description |
---|---|---|
error |
Os detalhes do erro. |
ForecastAggregation
A expressão de agregação a ser usada na previsão.
Name | Tipo | Description |
---|---|---|
function |
O nome da função de agregação a ser usada. |
|
name |
O nome da coluna a ser agregada. |
ForecastColumn
Propriedades da coluna de previsão
Name | Tipo | Description |
---|---|---|
name |
string |
O nome da coluna. |
type |
string |
O tipo de coluna. |
ForecastComparisonExpression
A expressão de comparação a ser usada na previsão.
Name | Tipo | Description |
---|---|---|
name |
string |
O nome da coluna a ser usada na comparação. |
operator |
O operador a utilizar para comparação. |
|
values |
string[] |
Matriz de valores a ser usada para comparação |
ForecastDataset
A definição dos dados presentes na previsão.
Name | Tipo | Description |
---|---|---|
aggregation |
<string,
Forecast |
Dicionário de expressão de agregação a utilizar na previsão. A chave de cada item no dicionário é o alias para a coluna agregada. A previsão pode ter até 2 cláusulas de agregação. |
configuration |
Tem informações de configuração para os dados na exportação. A configuração será ignorada se a agregação e o agrupamento forem fornecidos. |
|
filter |
Tem expressão de filtro para usar na previsão. |
|
granularity |
A granularidade das linhas na previsão. |
ForecastDatasetConfiguration
A configuração do conjunto de dados na previsão.
Name | Tipo | Description |
---|---|---|
columns |
string[] |
Matriz de nomes de colunas a serem incluídos na previsão. Qualquer nome de coluna de previsão válido é permitido. Se não for fornecida, a previsão inclui todas as colunas. |
ForecastDefinition
A definição de uma previsão.
Name | Tipo | Description |
---|---|---|
dataset |
Tem definição para os dados nesta previsão. |
|
includeActualCost |
boolean |
Um booleano determinando se actualCost será incluído. |
includeFreshPartialCost |
boolean |
Um booleano determinando se FreshPartialCost será incluído. |
timePeriod |
Tem período de tempo para extrair dados para a previsão. |
|
timeframe |
O período de tempo para extrair dados para a previsão. Se for habitual, deve ser fornecido um período de tempo específico. |
|
type |
O tipo de previsão. |
ForecastFilter
A expressão de filtro a ser usada na exportação.
Name | Tipo | Description |
---|---|---|
and |
A expressão lógica "E". Deve ter pelo menos 2 itens. |
|
dimensions |
Tem expressão de comparação para uma dimensão |
|
or |
A expressão lógica "OR". Deve ter pelo menos 2 itens. |
|
tags |
Tem expressão de comparação para uma tag |
ForecastOperatorType
O operador a utilizar para comparação.
Name | Tipo | Description |
---|---|---|
In |
string |
ForecastResult
Resultado da previsão. Ele contém todas as colunas listadas em agrupamentos e agregação.
Name | Tipo | Description |
---|---|---|
eTag |
string |
ETag do recurso. |
id |
string |
Id do recurso. |
location |
string |
Localização do recurso. |
name |
string |
Nome do recurso. |
properties.columns |
Matriz de colunas |
|
properties.nextLink |
string |
O link (url) para a próxima página de resultados. |
properties.rows |
Rows[] |
Matriz de linhas |
sku |
string |
SKU do recurso. |
tags |
object |
Tags de recursos. |
type |
string |
Tipo de recurso. |
ForecastTimeframe
O período de tempo para extrair dados para a previsão.
Name | Tipo | Description |
---|---|---|
Custom |
string |
ForecastTimePeriod
Tem período de tempo para extrair dados para a previsão.
Name | Tipo | Description |
---|---|---|
from |
string |
A data de início a partir da qual extrair dados. |
to |
string |
A data final para a qual extrair dados. |
ForecastType
O tipo de previsão.
Name | Tipo | Description |
---|---|---|
ActualCost |
string |
|
AmortizedCost |
string |
|
Usage |
string |
FunctionName
O nome da coluna a ser agregada.
Name | Tipo | Description |
---|---|---|
Cost |
string |
|
CostUSD |
string |
|
PreTaxCost |
string |
|
PreTaxCostUSD |
string |
FunctionType
O nome da função de agregação a ser usada.
Name | Tipo | Description |
---|---|---|
Sum |
string |
GranularityType
A granularidade das linhas na previsão.
Name | Tipo | Description |
---|---|---|
Daily |
string |