ForecastOperations Class
ForecastOperations operations.
You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.
- Inheritance
-
builtins.objectForecastOperations
Constructor
ForecastOperations(client, config, serializer, deserializer)Parameters
- client
Client for service requests.
- config
Configuration of service client.
- serializer
An object model serializer.
- deserializer
An object model deserializer.
Variables
- models
Alias to model classes used in this operation group.
Methods
| external_cloud_provider_usage |
Lists the forecast charges for external cloud provider type defined. |
| usage |
Lists the forecast charges for scope defined. |
external_cloud_provider_usage
Lists the forecast charges for external cloud provider type defined.
external_cloud_provider_usage(external_cloud_provider_type: Union[str, _models.ExternalCloudProviderType], external_cloud_provider_id: str, parameters: _models.ForecastDefinition, filter: Optional[str] = None, **kwargs: Any) -> _models.QueryResultParameters
- external_cloud_provider_type
- str or ExternalCloudProviderType
The external cloud provider type associated with dimension/query operations. This includes 'externalSubscriptions' for linked account and 'externalBillingAccounts' for consolidated account.
- external_cloud_provider_id
- str
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.
- filter
- str
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'.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
QueryResult, or the result of cls(response)
Return type
Exceptions
usage
Lists the forecast charges for scope defined.
usage(scope: str, parameters: _models.ForecastDefinition, filter: Optional[str] = None, **kwargs: Any) -> Optional[_models.QueryResult]Parameters
- scope
- str
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.
- filter
- str
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'.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
QueryResult, or the result of cls(response)
Return type
Exceptions
Attributes
models
models = <module 'azure.mgmt.costmanagement.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\costmanagement\\models\\__init__.py'>Feedback
Submit and view feedback for