CostManagementExtensions.ExternalCloudProviderUsageForecastAsync Method

Definition

Lists the forecast charges for external cloud provider type defined.

  • Request Path: /providers/Microsoft.CostManagement/{externalCloudProviderType}/{externalCloudProviderId}/forecast
  • Operation Id: Forecast_ExternalCloudProviderUsage
public static System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.CostManagement.Models.ForecastResult>> ExternalCloudProviderUsageForecastAsync (this Azure.ResourceManager.Resources.TenantResource tenantResource, Azure.ResourceManager.CostManagement.Models.ExternalCloudProviderType externalCloudProviderType, string externalCloudProviderId, Azure.ResourceManager.CostManagement.Models.ForecastDefinition forecastDefinition, string filter = default, System.Threading.CancellationToken cancellationToken = default);
static member ExternalCloudProviderUsageForecastAsync : Azure.ResourceManager.Resources.TenantResource * Azure.ResourceManager.CostManagement.Models.ExternalCloudProviderType * string * Azure.ResourceManager.CostManagement.Models.ForecastDefinition * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.CostManagement.Models.ForecastResult>>
<Extension()>
Public Function ExternalCloudProviderUsageForecastAsync (tenantResource As TenantResource, externalCloudProviderType As ExternalCloudProviderType, externalCloudProviderId As String, forecastDefinition As ForecastDefinition, Optional filter As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of ForecastResult))

Parameters

tenantResource
TenantResource

The TenantResource instance the method will execute against.

externalCloudProviderType
ExternalCloudProviderType

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.

forecastDefinition
ForecastDefinition

Parameters supplied to the CreateOrUpdate Forecast Config operation.

filter
String

May be used to filter forecasts by properties/usageDate (Utc time), properties/chargeType or properties/grain. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

externalCloudProviderId is an empty string, and was expected to be non-empty.

tenantResource, externalCloudProviderId or forecastDefinition is null.

Applies to