Share via

Forecast interface

  • Reference
Package:
@azure/arm-costmanagement

Interface representing a Forecast.

Methods

externalCloudProviderUsage(string, string, ForecastDefinition, ForecastExternalCloudProviderUsageOptionalParams)

Lists the forecast charges for external cloud provider type defined.
usage(string, ForecastDefinition, ForecastUsageOptionalParams)

Lists the forecast charges for scope defined.

Method Details

externalCloudProviderUsage(string, string, ForecastDefinition, ForecastExternalCloudProviderUsageOptionalParams)

Lists the forecast charges for external cloud provider type defined.

function externalCloudProviderUsage(externalCloudProviderType: string, externalCloudProviderId: string, parameters: ForecastDefinition, options?: ForecastExternalCloudProviderUsageOptionalParams): Promise<ForecastResult>

Parameters

externalCloudProviderType

string

The external cloud provider type associated with dimension/query operations. This includes 'externalSubscriptions' for linked account and 'externalBillingAccounts' for consolidated account.

externalCloudProviderId

string

This can be '{externalSubscriptionId}' for linked account or '{externalBillingAccountId}' for consolidated account used with dimension/query operations.

parameters
ForecastDefinition

Parameters supplied to the CreateOrUpdate Forecast Config operation.

options
ForecastExternalCloudProviderUsageOptionalParams

The options parameters.

Returns

Promise<ForecastResult>

usage(string, ForecastDefinition, ForecastUsageOptionalParams)

Lists the forecast charges for scope defined.

function usage(scope: string, parameters: ForecastDefinition, options?: ForecastUsageOptionalParams): Promise<ForecastResult>

Parameters

scope

string

The scope associated with forecast operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, '/providers/Microsoft.Management/managementGroups/{managementGroupId} for Management Group scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope, and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' specific for partners.

parameters
ForecastDefinition

Parameters supplied to the CreateOrUpdate Forecast Config operation.

options
ForecastUsageOptionalParams

The options parameters.

Returns

Promise<ForecastResult>