Forecast - External Cloud Provider Usage

Referens

Tjänst:: Cost Management

API-version:: 2024-08-01

Visar en lista med de prognostiserade avgifterna för den definierade typen av extern molnleverantör.

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

Med valfria parametrar:

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
externalCloudProviderId	path	True	string	Detta kan vara {externalSubscriptionId} för det länkade kontot eller {externalBillingAccountId} för konsoliderat konto som används med dimensions-/frågeåtgärder.
externalCloudProviderType	path	True	externalCloudProviderType	Den externa molnleverantörstypen som är associerad med dimensions-/frågeåtgärder. Detta inkluderar "externalSubscriptions" för länkat konto och "externalBillingAccounts" för konsoliderat konto.
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	ForecastDataset	Har definition för data i den här prognosen.
timeframe	True	ForecastTimeframe	Tidsramen för att hämta data för prognosen. Om det är anpassat måste en viss tidsperiod anges.
type	True	ForecastType	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		ForecastTimePeriod	Har en tidsperiod för att hämta data för prognosen.

Svar

Name	Typ	Description
200 OK	ForecastResult	OKEJ. Begäran har slutförts.
Other Status Codes	ErrorResponse	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

ExternalBillingAccountForecast

ExternalSubscriptionForecast

ExternalBillingAccountForecast

Exempelbegäran

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

Exempelsvar

Statuskod:: 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

Exempelbegäran

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

Exempelsvar

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

Definitioner

Name	Description
ErrorDetails	Information om felet.
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".
externalCloudProviderType	Den externa molnleverantörstypen som är associerad med dimensions-/frågeåtgärder. Detta inkluderar "externalSubscriptions" för länkat konto och "externalBillingAccounts" för konsoliderat konto.
ForecastAggregation	Det sammansättningsuttryck som ska användas i prognosen.
ForecastColumn	Egenskaper för prognoskolumn
ForecastComparisonExpression	Jämförelseuttrycket som ska användas i prognosen.
ForecastDataset	Definitionen av data som finns i prognosen.
ForecastDatasetConfiguration	Konfigurationen av datamängden i prognosen.
ForecastDefinition	Definitionen av en prognos.
ForecastFilter	Filteruttrycket som ska användas i exporten.
ForecastOperatorType	Operatorn som ska användas för jämförelse.
ForecastResult	Resultat av prognos. Den innehåller alla kolumner som anges under gruppering och sammansättning.
ForecastTimeframe	Tidsramen för att hämta data för prognosen.
ForecastTimePeriod	Har en tidsperiod för att hämta data för prognosen.
ForecastType	Typen av prognos.
FunctionName	Namnet på kolumnen som ska aggregeras.
FunctionType	Namnet på den sammansättningsfunktion som ska användas.
GranularityType	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	ErrorDetails	Information om felet.

externalCloudProviderType

Den externa molnleverantörstypen som är associerad med dimensions-/frågeåtgärder. Detta inkluderar "externalSubscriptions" för länkat konto och "externalBillingAccounts" för konsoliderat konto.

Name	Typ	Description
externalBillingAccounts	string
externalSubscriptions	string

ForecastAggregation

Det sammansättningsuttryck som ska användas i prognosen.

Name	Typ	Description
function	FunctionType	Namnet på den sammansättningsfunktion som ska användas.
name	FunctionName	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	ForecastOperatorType	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, ForecastAggregation>	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	ForecastDatasetConfiguration	Har konfigurationsinformation för data i exporten. Konfigurationen ignoreras om sammansättning och gruppering tillhandahålls.
filter	ForecastFilter	Har filteruttryck att använda i prognosen.
granularity	GranularityType	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	ForecastDataset	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	ForecastTimePeriod	Har en tidsperiod för att hämta data för prognosen.
timeframe	ForecastTimeframe	Tidsramen för att hämta data för prognosen. Om det är anpassat måste en viss tidsperiod anges.
type	ForecastType	Typen av prognos.

ForecastFilter

Filteruttrycket som ska användas i exporten.

Name	Typ	Description
and	ForecastFilter[]	Det logiska "AND"-uttrycket. Måste ha minst 2 objekt.
dimensions	ForecastComparisonExpression	Har jämförelseuttryck för en dimension
or	ForecastFilter[]	Det logiska "OR"-uttrycket. Måste ha minst 2 objekt.
tags	ForecastComparisonExpression	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	ForecastColumn[]	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

Dela via

Forecast - External Cloud Provider Usage

URI-parametrar

Begärandetext

Svar

Säkerhet

azure_auth

Omfattningar

Exempel

ExternalBillingAccountForecast

Exempelbegäran

Exempelsvar

ExternalSubscriptionForecast

Exempelbegäran

Exempelsvar

Definitioner

ErrorDetails

ErrorResponse

externalCloudProviderType

ForecastAggregation

ForecastColumn

ForecastComparisonExpression

ForecastDataset

ForecastDatasetConfiguration

ForecastDefinition

ForecastFilter

ForecastOperatorType

ForecastResult

ForecastTimeframe

ForecastTimePeriod

ForecastType

FunctionName

FunctionType

GranularityType

Ytterligare resurser