Forecast - External Cloud Provider Usage

Referencia

Servicio:: Cost Management

Versión de la API:: 2024-08-01

Enumera los cargos de previsión para el tipo de proveedor de nube externo definido.

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

Con parámetros opcionales:

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
externalCloudProviderId	path	True	string	Puede ser '{externalSubscriptionId}' para la cuenta vinculada o '{externalBillingAccountId}' para la cuenta consolidada usada con operaciones de dimensión/consulta.
externalCloudProviderType	path	True	externalCloudProviderType	Tipo de proveedor de nube externo asociado a las operaciones de dimensión y consulta. Esto incluye "externalSubscriptions" para la cuenta vinculada y "externalBillingAccounts" para la cuenta consolidada.
api-version	query	True	string	Versión de la API que se va a usar para esta operación.
$filter	query		string	Puede usarse para filtrar las previsiones por propiedades/usageDate (hora Utc), properties/chargeType o properties/grain. El filtro admite 'eq', 'lt', 'gt', 'le', 'ge' y 'and'. Actualmente no admite 'ne', 'or' o 'not'.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
dataset	True	ForecastDataset	Tiene definición para los datos de esta previsión.
timeframe	True	ForecastTimeframe	Período de tiempo para extraer datos para la previsión. Si es personalizado, se debe proporcionar un período de tiempo específico.
type	True	ForecastType	Tipo de la previsión.
includeActualCost		boolean	Valor booleano que determina si se incluirá realCost.
includeFreshPartialCost		boolean	Valor booleano que determina si FreshPartialCost se incluirá.
timePeriod		ForecastTimePeriod	Tiene un período de tiempo para extraer datos para la previsión.

Respuestas

Nombre	Tipo	Description
200 OK	ForecastResult	De acuerdo. La solicitud se ha realizado correctamente.
Other Status Codes	ErrorResponse	Respuesta de error que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

ExternalBillingAccountForecast

ExternalSubscriptionForecast

ExternalBillingAccountForecast

Solicitud de ejemplo

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"
            ]
          }
        }
      ]
    }
  }
}

Respuesta de muestra

status code:: 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

Solicitud de ejemplo

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"
            ]
          }
        }
      ]
    }
  }
}

Respuesta de muestra

status code:: 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": []
  }
}

Definiciones

Nombre	Description
ErrorDetails	Detalles del error.
ErrorResponse	La respuesta de error indica que el servicio no puede procesar la solicitud entrante. El motivo se proporciona en el mensaje de error. Algunas respuestas de error: 429 TooManyRequests: la solicitud está limitada. Vuelva a intentarlo después de esperar el tiempo especificado en el encabezado "x-ms-ratelimit-microsoft.consumption-retry-after". 503 ServiceUnavailable: el servicio no está disponible temporalmente. Vuelva a intentarlo después de esperar el tiempo especificado en el encabezado "Retry-After".
externalCloudProviderType	Tipo de proveedor de nube externo asociado a las operaciones de dimensión y consulta. Esto incluye "externalSubscriptions" para la cuenta vinculada y "externalBillingAccounts" para la cuenta consolidada.
ForecastAggregation	Expresión de agregación que se va a usar en la previsión.
ForecastColumn	Propiedades de columna de previsión
ForecastComparisonExpression	Expresión de comparación que se va a usar en la previsión.
ForecastDataset	Definición de los datos presentes en la previsión.
ForecastDatasetConfiguration	Configuración del conjunto de datos en la previsión.
ForecastDefinition	Definición de una previsión.
ForecastFilter	Expresión de filtro que se va a usar en la exportación.
ForecastOperatorType	Operador que se va a usar para la comparación.
ForecastResult	Resultado de la previsión. Contiene todas las columnas enumeradas en agrupaciones y agregaciones.
ForecastTimeframe	Período de tiempo para extraer datos para la previsión.
ForecastTimePeriod	Tiene un período de tiempo para extraer datos para la previsión.
ForecastType	Tipo de la previsión.
FunctionName	Nombre de la columna que se va a agregar.
FunctionType	Nombre de la función de agregación que se va a usar.
GranularityType	Granularidad de las filas de la previsión.

ErrorDetails

Detalles del error.

Nombre	Tipo	Description
code	string	Código de error.
message	string	Mensaje de error que indica por qué se produjo un error en la operación.

ErrorResponse

La respuesta de error indica que el servicio no puede procesar la solicitud entrante. El motivo se proporciona en el mensaje de error.

Algunas respuestas de error:

429 TooManyRequests: la solicitud está limitada. Vuelva a intentarlo después de esperar el tiempo especificado en el encabezado "x-ms-ratelimit-microsoft.consumption-retry-after".
503 ServiceUnavailable: el servicio no está disponible temporalmente. Vuelva a intentarlo después de esperar el tiempo especificado en el encabezado "Retry-After".

Nombre	Tipo	Description
error	ErrorDetails	Detalles del error.

externalCloudProviderType

Tipo de proveedor de nube externo asociado a las operaciones de dimensión y consulta. Esto incluye "externalSubscriptions" para la cuenta vinculada y "externalBillingAccounts" para la cuenta consolidada.

Nombre	Tipo	Description
externalBillingAccounts	string
externalSubscriptions	string

ForecastAggregation

Expresión de agregación que se va a usar en la previsión.

Nombre	Tipo	Description
function	FunctionType	Nombre de la función de agregación que se va a usar.
name	FunctionName	Nombre de la columna que se va a agregar.

ForecastColumn

Propiedades de columna de previsión

Nombre	Tipo	Description
name	string	Nombre de la columna.
type	string	Tipo de columna.

ForecastComparisonExpression

Expresión de comparación que se va a usar en la previsión.

Nombre	Tipo	Description
name	string	Nombre de la columna que se va a usar en comparación.
operator	ForecastOperatorType	Operador que se va a usar para la comparación.
values	string[]	Matriz de valores que se van a usar para la comparación

ForecastDataset

Definición de los datos presentes en la previsión.

Nombre	Tipo	Description
aggregation	<string, ForecastAggregation>	Diccionario de expresiones de agregación que se van a usar en la previsión. La clave de cada elemento del diccionario es el alias de la columna agregada. la previsión puede tener hasta 2 cláusulas de agregación.
configuration	ForecastDatasetConfiguration	Tiene información de configuración para los datos de la exportación. La configuración se omitirá si se proporcionan la agregación y la agrupación.
filter	ForecastFilter	Tiene la expresión de filtro que se va a usar en la previsión.
granularity	GranularityType	Granularidad de las filas de la previsión.

ForecastDatasetConfiguration

Configuración del conjunto de datos en la previsión.

Nombre	Tipo	Description
columns	string[]	Matriz de nombres de columna que se van a incluir en la previsión. Se permite cualquier nombre de columna de previsión válido. Si no se proporciona, la previsión incluye todas las columnas.

ForecastDefinition

Definición de una previsión.

Nombre	Tipo	Description
dataset	ForecastDataset	Tiene definición para los datos de esta previsión.
includeActualCost	boolean	Valor booleano que determina si se incluirá realCost.
includeFreshPartialCost	boolean	Valor booleano que determina si FreshPartialCost se incluirá.
timePeriod	ForecastTimePeriod	Tiene un período de tiempo para extraer datos para la previsión.
timeframe	ForecastTimeframe	Período de tiempo para extraer datos para la previsión. Si es personalizado, se debe proporcionar un período de tiempo específico.
type	ForecastType	Tipo de la previsión.

ForecastFilter

Expresión de filtro que se va a usar en la exportación.

Nombre	Tipo	Description
and	ForecastFilter[]	Expresión "AND" lógica. Debe tener al menos 2 elementos.
dimensions	ForecastComparisonExpression	Tiene una expresión de comparación para una dimensión
or	ForecastFilter[]	Expresión "OR" lógica. Debe tener al menos 2 elementos.
tags	ForecastComparisonExpression	Tiene expresión de comparación para una etiqueta

ForecastOperatorType

Operador que se va a usar para la comparación.

Nombre	Tipo	Description
In	string

ForecastResult

Resultado de la previsión. Contiene todas las columnas enumeradas en agrupaciones y agregaciones.

Nombre	Tipo	Description
eTag	string	ETag del recurso.
id	string	Identificador de recurso.
location	string	Ubicación del recurso.
name	string	Nombre del recurso.
properties.columns	ForecastColumn[]	Matriz de columnas
properties.nextLink	string	Vínculo (url) a la página siguiente de resultados.
properties.rows	Rows[]	Matriz de filas
sku	string	SKU del recurso.
tags	object	Etiquetas de recursos.
type	string	Tipo de recurso.

ForecastTimeframe

Período de tiempo para extraer datos para la previsión.

Nombre	Tipo	Description
Custom	string

ForecastTimePeriod

Tiene un período de tiempo para extraer datos para la previsión.

Nombre	Tipo	Description
from	string	Fecha de inicio de la que se van a extraer datos.
to	string	Fecha de finalización a la que se van a extraer los datos.

ForecastType

Tipo de la previsión.

Nombre	Tipo	Description
ActualCost	string
AmortizedCost	string
Usage	string

FunctionName

Nombre de la columna que se va a agregar.

Nombre	Tipo	Description
Cost	string
CostUSD	string
PreTaxCost	string
PreTaxCostUSD	string

FunctionType

Nombre de la función de agregación que se va a usar.

Nombre	Tipo	Description
Sum	string

GranularityType

Granularidad de las filas de la previsión.

Nombre	Tipo	Description
Daily	string

Compartir a través de

Forecast - External Cloud Provider Usage

Parámetros de identificador URI

Cuerpo de la solicitud

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

ExternalBillingAccountForecast

Solicitud de ejemplo

Respuesta de muestra

ExternalSubscriptionForecast

Solicitud de ejemplo

Respuesta de muestra

Definiciones

ErrorDetails

ErrorResponse

externalCloudProviderType

ForecastAggregation

ForecastColumn

ForecastComparisonExpression

ForecastDataset

ForecastDatasetConfiguration

ForecastDefinition

ForecastFilter

ForecastOperatorType

ForecastResult

ForecastTimeframe

ForecastTimePeriod

ForecastType

FunctionName

FunctionType

GranularityType

Recursos adicionales