Forecast - External Cloud Provider Usage

Referência

Serviço:: Cost Management

Versão da API:: 2024-08-01

Lista as cobranças previstas para o tipo de provedor de nuvem externo definido.

POST https://management.azure.com/providers/Microsoft.CostManagement/{externalCloudProviderType}/{externalCloudProviderId}/forecast?api-version=2024-08-01

Com parâmetros opcionais:

POST https://management.azure.com/providers/Microsoft.CostManagement/{externalCloudProviderType}/{externalCloudProviderId}/forecast?$filter={$filter}&api-version=2024-08-01

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
externalCloudProviderId	path	True	string	Pode ser '{externalSubscriptionId}' para conta vinculada ou '{externalBillingAccountId}' para conta consolidada usada com operações de dimensão/consulta.
externalCloudProviderType	path	True	externalCloudProviderType	O tipo de provedor de nuvem externo associado a operações de dimensão/consulta. Isso inclui 'externalSubscriptions' para conta vinculada e 'externalBillingAccounts' para conta consolidada.
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	ForecastDataset	Tem definição para os dados nesta previsão.
timeframe	True	ForecastTimeframe	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	ForecastType	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		ForecastTimePeriod	Tem período de tempo para extrair dados para a previsão.

Respostas

Name	Tipo	Description
200 OK	ForecastResult	OK. O pedido foi bem-sucedido.
Other Status Codes	ErrorResponse	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

ExternalBillingAccountForecast

ExternalSubscriptionForecast

ExternalBillingAccountForecast

Pedido de amostra

HTTP

POST https://management.azure.com/providers/Microsoft.CostManagement/externalBillingAccounts/100/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"
            ]
          }
        }
      ]
    }
  }
}

Resposta da amostra

Código de estado:: 200

{
  "id": "providers/Microsoft.CostManagement/externalBillingAccounts/100/query/6dc7b06a-d90a-4df5-b655-ce6cf1c0814d",
  "name": "6dc7b06a-d90a-4df5-b655-ce6cf1c0814d",
  "type": "Microsoft.CostManagement/query",
  "properties": {
    "nextLink": null,
    "columns": [
      {
        "name": "PreTaxCost",
        "type": "Number"
      },
      {
        "name": "CostStatus",
        "type": "String"
      },
      {
        "name": "Currency",
        "type": "String"
      }
    ],
    "rows": [
      [
        0,
        "Forecast",
        "USD"
      ],
      [
        30.2572751438,
        "Forecast",
        "USD"
      ],
      [
        0.07675760200000002,
        "Forecast",
        "USD"
      ],
      [
        50.43096419040001,
        "Forecast",
        "USD"
      ]
    ]
  }
}

ExternalSubscriptionForecast

Pedido de amostra

HTTP

POST https://management.azure.com/providers/Microsoft.CostManagement/externalSubscriptions/100/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"
            ]
          }
        }
      ]
    }
  }
}

Resposta da amostra

Código de estado:: 200

{
  "id": "providers/Microsoft.CostManagement/externalSubscriptions/100/query/d99477af-7510-40ee-aca2-e59bdca0d10d",
  "name": "d99477af-7510-40ee-aca2-e59bdca0d10d",
  "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": []
  }
}

Definições

Name	Description
ErrorDetails	Os detalhes do erro.
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".
externalCloudProviderType	O tipo de provedor de nuvem externo associado a operações de dimensão/consulta. Isso inclui 'externalSubscriptions' para conta vinculada e 'externalBillingAccounts' para conta consolidada.
ForecastAggregation	A expressão de agregação a ser usada na previsão.
ForecastColumn	Propriedades da coluna de previsão
ForecastComparisonExpression	A expressão de comparação a ser usada na previsão.
ForecastDataset	A definição dos dados presentes na previsão.
ForecastDatasetConfiguration	A configuração do conjunto de dados na previsão.
ForecastDefinition	A definição de uma previsão.
ForecastFilter	A expressão de filtro a ser usada na exportação.
ForecastOperatorType	O operador a utilizar para comparação.
ForecastResult	Resultado da previsão. Ele contém todas as colunas listadas em agrupamentos e agregação.
ForecastTimeframe	O período de tempo para extrair dados para a previsão.
ForecastTimePeriod	Tem período de tempo para extrair dados para a previsão.
ForecastType	O tipo de previsão.
FunctionName	O nome da coluna a ser agregada.
FunctionType	O nome da função de agregação a ser usada.
GranularityType	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	ErrorDetails	Os detalhes do erro.

externalCloudProviderType

O tipo de provedor de nuvem externo associado a operações de dimensão/consulta. Isso inclui 'externalSubscriptions' para conta vinculada e 'externalBillingAccounts' para conta consolidada.

Name	Tipo	Description
externalBillingAccounts	string
externalSubscriptions	string

ForecastAggregation

A expressão de agregação a ser usada na previsão.

Name	Tipo	Description
function	FunctionType	O nome da função de agregação a ser usada.
name	FunctionName	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	ForecastOperatorType	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, ForecastAggregation>	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	ForecastDatasetConfiguration	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	ForecastFilter	Tem expressão de filtro para usar na previsão.
granularity	GranularityType	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	ForecastDataset	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	ForecastTimePeriod	Tem período de tempo para extrair dados para a previsão.
timeframe	ForecastTimeframe	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	ForecastType	O tipo de previsão.

ForecastFilter

A expressão de filtro a ser usada na exportação.

Name	Tipo	Description
and	ForecastFilter[]	A expressão lógica "E". Deve ter pelo menos 2 itens.
dimensions	ForecastComparisonExpression	Tem expressão de comparação para uma dimensão
or	ForecastFilter[]	A expressão lógica "OR". Deve ter pelo menos 2 itens.
tags	ForecastComparisonExpression	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	ForecastColumn[]	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

Partilhar via

Forecast - External Cloud Provider Usage

Parâmetros do URI

Corpo do Pedido

Respostas

Segurança

azure_auth

Âmbitos

Exemplos

ExternalBillingAccountForecast

Pedido de amostra

Resposta da amostra

ExternalSubscriptionForecast

Pedido de amostra

Resposta da amostra

Definições

ErrorDetails

ErrorResponse

externalCloudProviderType

ForecastAggregation

ForecastColumn

ForecastComparisonExpression

ForecastDataset

ForecastDatasetConfiguration

ForecastDefinition

ForecastFilter

ForecastOperatorType

ForecastResult

ForecastTimeframe

ForecastTimePeriod

ForecastType

FunctionName

FunctionType

GranularityType

Recursos adicionais