Forecast - External Cloud Provider Usage

Referência

Serviço:: Cost Management

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

Lista os encargos de previsão 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 de URI

Nome	Em	Obrigatório	Tipo	Description
externalCloudProviderId	path	True	string	Isso pode ser '{externalSubscriptionId}' para conta vinculada ou '{externalBillingAccountId}' para a 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/granulação. O filtro dá suporte a 'eq', 'lt', 'gt', 'le', 'ge' e 'and'. Atualmente, ele não dá suporte a 'ne', 'or' ou 'not'.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
dataset	True	ForecastDataset	Tem definição de dados nesta previsão.
timeframe	True	ForecastTimeframe	O período para efetuar pull de dados para a previsão. Se personalizado, um período de tempo específico deve ser fornecido.
type	True	ForecastType	O tipo da previsão.
includeActualCost		boolean	Um booliano determinando se actualCost será incluído.
includeFreshPartialCost		boolean	Um booliano determinando se FreshPartialCost será incluído.
timePeriod		ForecastTimePeriod	Tem um período de tempo para efetuar pull de dados para a previsão.

Respostas

Nome	Tipo	Description
200 OK	ForecastResult	OKEY. A solicitação foi bem-sucedida.
Other Status Codes	ErrorResponse	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

ExternalBillingAccountForecast

ExternalSubscriptionForecast

ExternalBillingAccountForecast

Solicitação de exemplo

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 de exemplo

Código de status:: 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

Solicitação de exemplo

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 de exemplo

Código de status:: 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

Nome	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 é limitada. Tente novamente depois de aguardar o tempo especificado no cabeçalho "x-ms-ratelimit-microsoft.consumption-retry-after". 503 ServiceUnavailable – 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	Previsão de propriedades da coluna
ForecastComparisonExpression	A expressão de comparação a ser usada na previsão.
ForecastDataset	A definição de 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 ser usado para comparação.
ForecastResult	Resultado da previsão. Ele contém todas as colunas listadas em agrupamentos e agregação.
ForecastTimeframe	O período para efetuar pull de dados para a previsão.
ForecastTimePeriod	Tem um período de tempo para efetuar pull de dados para a previsão.
ForecastType	O tipo da 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.

Nome	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 é limitada. Tente novamente depois de aguardar o tempo especificado no cabeçalho "x-ms-ratelimit-microsoft.consumption-retry-after".
503 ServiceUnavailable – O serviço está temporariamente indisponível. Tente novamente depois de aguardar o tempo especificado no cabeçalho "Retry-After".

Nome	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.

Nome	Tipo	Description
externalBillingAccounts	string
externalSubscriptions	string

ForecastAggregation

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

Nome	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

Previsão de propriedades da coluna

Nome	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.

Nome	Tipo	Description
name	string	O nome da coluna a ser usada em comparação.
operator	ForecastOperatorType	O operador a ser usado para comparação.
values	string[]	Matriz de valores a serem usados para comparação

ForecastDataset

A definição de dados presentes na previsão.

Nome	Tipo	Description
aggregation	<string, ForecastAggregation>	Dicionário de expressão de agregação a ser usado na previsão. A chave de cada item no dicionário é o alias da 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 a ser usada na previsão.
granularity	GranularityType	A granularidade das linhas na previsão.

ForecastDatasetConfiguration

A configuração do conjunto de dados na previsão.

Nome	Tipo	Description
columns	string[]	Matriz de nomes de coluna a serem incluídos na previsão. Qualquer nome de coluna de previsão válido é permitido. Se não for fornecido, a previsão inclui todas as colunas.

ForecastDefinition

A definição de uma previsão.

Nome	Tipo	Description
dataset	ForecastDataset	Tem definição de dados nesta previsão.
includeActualCost	boolean	Um booliano determinando se actualCost será incluído.
includeFreshPartialCost	boolean	Um booliano determinando se FreshPartialCost será incluído.
timePeriod	ForecastTimePeriod	Tem um período de tempo para efetuar pull de dados para a previsão.
timeframe	ForecastTimeframe	O período para efetuar pull de dados para a previsão. Se personalizado, um período de tempo específico deve ser fornecido.
type	ForecastType	O tipo da previsão.

ForecastFilter

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

Nome	Tipo	Description
and	ForecastFilter[]	A expressão lógica "AND". 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 marca

ForecastOperatorType

O operador a ser usado para comparação.

Nome	Tipo	Description
In	string

ForecastResult

Resultado da previsão. Ele contém todas as colunas listadas em agrupamentos e agregação.

Nome	Tipo	Description
eTag	string	ETag do recurso.
id	string	ID do recurso.
location	string	Local 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	Marcas de recurso.
type	string	Tipo de recurso.

ForecastTimeframe

O período para efetuar pull de dados para a previsão.

Nome	Tipo	Description
Custom	string

ForecastTimePeriod

Tem um período de tempo para efetuar pull de dados para a previsão.

Nome	Tipo	Description
from	string	A data de início da qual os dados serão extraídos.
to	string	A data de término para a qual efetuar pull de dados.

ForecastType

O tipo da previsão.

Nome	Tipo	Description
ActualCost	string
AmortizedCost	string
Usage	string

FunctionName

O nome da coluna a ser agregada.

Nome	Tipo	Description
Cost	string
CostUSD	string
PreTaxCost	string
PreTaxCostUSD	string

FunctionType

O nome da função de agregação a ser usada.

Nome	Tipo	Description
Sum	string

GranularityType

A granularidade das linhas na previsão.

Nome	Tipo	Description
Daily	string

Compartilhar via

Forecast - External Cloud Provider Usage

Parâmetros de URI

Corpo da solicitação

Respostas

Segurança

azure_auth

Escopos

Exemplos

ExternalBillingAccountForecast

Solicitação de exemplo

Resposta de exemplo

ExternalSubscriptionForecast

Solicitação de exemplo

Resposta de exemplo

Definições

ErrorDetails

ErrorResponse

externalCloudProviderType

ForecastAggregation

ForecastColumn

ForecastComparisonExpression

ForecastDataset

ForecastDatasetConfiguration

ForecastDefinition

ForecastFilter

ForecastOperatorType

ForecastResult

ForecastTimeframe

ForecastTimePeriod

ForecastType

FunctionName

FunctionType

GranularityType

Recursos adicionais