Forecast - External Cloud Provider Usage

Referentie

Service:: Cost Management

API-versie:: 2024-08-01

Toont de prognosekosten voor het type externe cloudprovider dat is gedefinieerd.

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

Met optionele parameters:

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

URI-parameters

Name	In	Vereist	Type	Description
externalCloudProviderId	path	True	string	Dit kan {externalSubscriptionId} zijn voor een gekoppeld account of {externalBillingAccountId} voor een geconsolideerd account dat wordt gebruikt met dimensie-/querybewerkingen.
externalCloudProviderType	path	True	externalCloudProviderType	Het type externe cloudprovider dat is gekoppeld aan dimensie-/querybewerkingen. Dit omvat 'externalSubscriptions' voor gekoppelde accounts en 'externalBillingAccounts' voor een geconsolideerd account.
api-version	query	True	string	De API-versie die voor deze bewerking moet worden gebruikt.
$filter	query		string	Kan worden gebruikt om prognoses te filteren op eigenschappen/usageDate (Utc-tijd), properties/chargeType of properties/grain. Het filter ondersteunt 'eq', 'lt', 'gt', 'le', 'ge' en 'and'. Het biedt momenteel geen ondersteuning voor 'ne', 'or', of 'niet'.

Aanvraagbody

Name	Vereist	Type	Description
dataset	True	ForecastDataset	Bevat definitie voor gegevens in deze prognose.
timeframe	True	ForecastTimeframe	Het tijdsbestek voor het ophalen van gegevens voor de prognose. Als dit aangepast is, moet er een specifieke periode worden opgegeven.
type	True	ForecastType	Het type van de prognose.
includeActualCost		boolean	Een Booleaanse waarde die bepaalt of actualCost wordt opgenomen.
includeFreshPartialCost		boolean	Een Booleaanse waarde die bepaalt of FreshPartialCost wordt opgenomen.
timePeriod		ForecastTimePeriod	Heeft een periode voor het ophalen van gegevens voor de prognose.

Antwoorden

Name	Type	Description
200 OK	ForecastResult	OK. De aanvraag is voltooid.
Other Status Codes	ErrorResponse	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

ExternalBillingAccountForecast

ExternalSubscriptionForecast

ExternalBillingAccountForecast

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Name	Description
ErrorDetails	De details van de fout.
ErrorResponse	Foutreactie geeft aan dat de service de binnenkomende aanvraag niet kan verwerken. De reden is opgegeven in het foutbericht. Enkele foutberichten: 429 TooManyRequests - Aanvraag wordt beperkt. Probeer het opnieuw nadat u hebt gewacht op de tijd die is opgegeven in de header x-ms-ratelimit-microsoft.consumption-retry-after. 503 ServiceUnavailable - Service is tijdelijk niet beschikbaar. Probeer het opnieuw nadat u hebt gewacht op de tijd die is opgegeven in de header 'Opnieuw proberen-na'.
externalCloudProviderType	Het type externe cloudprovider dat is gekoppeld aan dimensie-/querybewerkingen. Dit omvat 'externalSubscriptions' voor gekoppelde accounts en 'externalBillingAccounts' voor een geconsolideerd account.
ForecastAggregation	De aggregatie-expressie die moet worden gebruikt in de prognose.
ForecastColumn	Eigenschappen van prognosekolommen
ForecastComparisonExpression	De vergelijkingsexpressie die moet worden gebruikt in de prognose.
ForecastDataset	De definitie van gegevens die aanwezig zijn in de prognose.
ForecastDatasetConfiguration	De configuratie van de gegevensset in de prognose.
ForecastDefinition	De definitie van een prognose.
ForecastFilter	De filterexpressie die moet worden gebruikt in de export.
ForecastOperatorType	De operator die moet worden gebruikt voor vergelijking.
ForecastResult	Resultaat van prognose. Het bevat alle kolommen die worden vermeld onder groeperingen en aggregatie.
ForecastTimeframe	Het tijdsbestek voor het ophalen van gegevens voor de prognose.
ForecastTimePeriod	Heeft een periode voor het ophalen van gegevens voor de prognose.
ForecastType	Het type van de prognose.
FunctionName	De naam van de kolom die moet worden samengevoegd.
FunctionType	De naam van de te gebruiken aggregatiefunctie.
GranularityType	De granulariteit van rijen in de prognose.

ErrorDetails

De details van de fout.

Name	Type	Description
code	string	Foutcode.
message	string	Foutbericht dat aangeeft waarom de bewerking is mislukt.

ErrorResponse

Foutreactie geeft aan dat de service de binnenkomende aanvraag niet kan verwerken. De reden is opgegeven in het foutbericht.

Enkele foutberichten:

429 TooManyRequests - Aanvraag wordt beperkt. Probeer het opnieuw nadat u hebt gewacht op de tijd die is opgegeven in de header x-ms-ratelimit-microsoft.consumption-retry-after.
503 ServiceUnavailable - Service is tijdelijk niet beschikbaar. Probeer het opnieuw nadat u hebt gewacht op de tijd die is opgegeven in de header 'Opnieuw proberen-na'.

Name	Type	Description
error	ErrorDetails	De details van de fout.

externalCloudProviderType

Het type externe cloudprovider dat is gekoppeld aan dimensie-/querybewerkingen. Dit omvat 'externalSubscriptions' voor gekoppelde accounts en 'externalBillingAccounts' voor een geconsolideerd account.

Name	Type	Description
externalBillingAccounts	string
externalSubscriptions	string

ForecastAggregation

De aggregatie-expressie die moet worden gebruikt in de prognose.

Name	Type	Description
function	FunctionType	De naam van de te gebruiken aggregatiefunctie.
name	FunctionName	De naam van de kolom die moet worden samengevoegd.

ForecastColumn

Eigenschappen van prognosekolommen

Name	Type	Description
name	string	De naam van de kolom.
type	string	Het type kolom.

ForecastComparisonExpression

De vergelijkingsexpressie die moet worden gebruikt in de prognose.

Name	Type	Description
name	string	De naam van de kolom die moet worden gebruikt in vergelijking.
operator	ForecastOperatorType	De operator die moet worden gebruikt voor vergelijking.
values	string[]	Matrix met waarden die moeten worden gebruikt voor vergelijking

ForecastDataset

De definitie van gegevens die aanwezig zijn in de prognose.

Name	Type	Description
aggregation	<string, ForecastAggregation>	Woordenlijst van aggregatie-expressie die moet worden gebruikt in de prognose. De sleutel van elk item in de woordenlijst is de alias voor de samengevoegde kolom. prognose kan maximaal 2 aggregatiecomponenten bevatten.
configuration	ForecastDatasetConfiguration	Bevat configuratie-informatie voor de gegevens in de export. De configuratie wordt genegeerd als aggregatie en groepering worden opgegeven.
filter	ForecastFilter	Heeft filterexpressie die moet worden gebruikt in de prognose.
granularity	GranularityType	De granulariteit van rijen in de prognose.

ForecastDatasetConfiguration

De configuratie van de gegevensset in de prognose.

Name	Type	Description
columns	string[]	Matrix van kolomnamen die moeten worden opgenomen in de prognose. Elke geldige kolomnaam voor prognose is toegestaan. Als dit niet is opgegeven, bevat de prognose alle kolommen.

ForecastDefinition

De definitie van een prognose.

Name	Type	Description
dataset	ForecastDataset	Bevat definitie voor gegevens in deze prognose.
includeActualCost	boolean	Een Booleaanse waarde die bepaalt of actualCost wordt opgenomen.
includeFreshPartialCost	boolean	Een Booleaanse waarde die bepaalt of FreshPartialCost wordt opgenomen.
timePeriod	ForecastTimePeriod	Heeft een periode voor het ophalen van gegevens voor de prognose.
timeframe	ForecastTimeframe	Het tijdsbestek voor het ophalen van gegevens voor de prognose. Als dit aangepast is, moet er een specifieke periode worden opgegeven.
type	ForecastType	Het type van de prognose.

ForecastFilter

De filterexpressie die moet worden gebruikt in de export.

Name	Type	Description
and	ForecastFilter[]	De logische 'AND'-expressie. Moet ten minste 2 items bevatten.
dimensions	ForecastComparisonExpression	Heeft een vergelijkingsexpressie voor een dimensie
or	ForecastFilter[]	De logische 'OR'-expressie. Moet ten minste 2 items bevatten.
tags	ForecastComparisonExpression	Heeft een vergelijkingsexpressie voor een tag

ForecastOperatorType

De operator die moet worden gebruikt voor vergelijking.

Name	Type	Description
In	string

ForecastResult

Resultaat van prognose. Het bevat alle kolommen die worden vermeld onder groeperingen en aggregatie.

Name	Type	Description
eTag	string	ETag van de resource.
id	string	Resource-id.
location	string	Locatie van de resource.
name	string	Resourcenaam.
properties.columns	ForecastColumn[]	Matrix van kolommen
properties.nextLink	string	De koppeling (URL) naar de volgende pagina met resultaten.
properties.rows	Rows[]	Matrix met rijen
sku	string	SKU van de resource.
tags	object	Resourcetags.
type	string	Resourcetype.

ForecastTimeframe

Het tijdsbestek voor het ophalen van gegevens voor de prognose.

Name	Type	Description
Custom	string

ForecastTimePeriod

Heeft een periode voor het ophalen van gegevens voor de prognose.

Name	Type	Description
from	string	De begindatum waaruit gegevens moeten worden opgehaald.
to	string	De einddatum voor het ophalen van gegevens naar.

ForecastType

Het type van de prognose.

Name	Type	Description
ActualCost	string
AmortizedCost	string
Usage	string

FunctionName

De naam van de kolom die moet worden samengevoegd.

Name	Type	Description
Cost	string
CostUSD	string
PreTaxCost	string
PreTaxCostUSD	string

FunctionType

De naam van de te gebruiken aggregatiefunctie.

Name	Type	Description
Sum	string

GranularityType

De granulariteit van rijen in de prognose.

Name	Type	Description
Daily	string

Delen via

Forecast - External Cloud Provider Usage

URI-parameters

Aanvraagbody

Antwoorden

Beveiliging

azure_auth

Bereiken

Voorbeelden

ExternalBillingAccountForecast

Voorbeeldaanvraag

Voorbeeldrespons

ExternalSubscriptionForecast

Voorbeeldaanvraag

Voorbeeldrespons

Definities

ErrorDetails

ErrorResponse

externalCloudProviderType

ForecastAggregation

ForecastColumn

ForecastComparisonExpression

ForecastDataset

ForecastDatasetConfiguration

ForecastDefinition

ForecastFilter

ForecastOperatorType

ForecastResult

ForecastTimeframe

ForecastTimePeriod

ForecastType

FunctionName

FunctionType

GranularityType

Aanvullende resources