models Package

Classes

Alert

An individual alert.

Variables are only populated by the server, and will be ignored when sending a request.

AlertPropertiesDefinition

defines the type of alert.

AlertPropertiesDetails

Alert details.

AlertsResult

Result of alerts.

Variables are only populated by the server, and will be ignored when sending a request.

CacheItem

CacheItem.

All required parameters must be populated in order to send to Azure.

CommonExportProperties

The common properties of the export.

All required parameters must be populated in order to send to Azure.

Dimension

Dimension.

Variables are only populated by the server, and will be ignored when sending a request.

DimensionsListResult

Result of listing dimensions. It contains a list of available dimensions.

Variables are only populated by the server, and will be ignored when sending a request.

DismissAlertPayload

The request payload to update an alert.

ErrorDetails

The details of the error.

Variables are only populated by the server, and will be ignored when sending a request.

ErrorResponse

Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message.

Some Error responses:

  • 429 TooManyRequests - Request is throttled. Retry after waiting for the time specified in the "x-ms-ratelimit-microsoft.consumption-retry-after" header.

  • 503 ServiceUnavailable - Service is temporarily unavailable. Retry after waiting for the time specified in the "Retry-After" header.

    param error: The details of the error.

    type error: ~azure.mgmt.costmanagement.models.ErrorDetails

Export

A export resource.

Variables are only populated by the server, and will be ignored when sending a request.

ExportDefinition

The definition of a query.

All required parameters must be populated in order to send to Azure.

ExportDeliveryDestination

The destination information for the delivery of the export. To allow access to a storage account, you must register the account's subscription with the Microsoft.CostManagementExports resource provider. This is required once per subscription. When creating an export in the Azure portal, it is done automatically, however API users need to register the subscription. For more information see https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-supported-services .

All required parameters must be populated in order to send to Azure.

ExportDeliveryInfo

The delivery information associated with a export.

All required parameters must be populated in order to send to Azure.

ExportExecution

A export execution.

Variables are only populated by the server, and will be ignored when sending a request.

ExportExecutionListResult

Result of listing exports execution history of a export by name.

Variables are only populated by the server, and will be ignored when sending a request.

ExportListResult

Result of listing exports. It contains a list of available exports in the scope provided.

Variables are only populated by the server, and will be ignored when sending a request.

ExportProperties

The properties of the export.

All required parameters must be populated in order to send to Azure.

ExportRecurrencePeriod

The start and end date for recurrence schedule.

All required parameters must be populated in order to send to Azure.

ExportSchedule

The schedule associated with a export.

All required parameters must be populated in order to send to Azure.

ForecastDefinition

The definition of a forecast.

All required parameters must be populated in order to send to Azure.

KpiProperties

Each KPI must contain a 'type' and 'enabled' key.

Operation

A Cost management REST API operation.

Variables are only populated by the server, and will be ignored when sending a request.

OperationDisplay

The object that represents the operation.

Variables are only populated by the server, and will be ignored when sending a request.

OperationListResult

Result of listing cost management operations. It contains a list of operations and a URL link to get the next set of results.

Variables are only populated by the server, and will be ignored when sending a request.

OperationStatus

The status of the long running operation.

PivotProperties

Each pivot must contain a 'type' and 'name'.

ProxyResource

The Resource model definition.

Variables are only populated by the server, and will be ignored when sending a request.

ProxySettingResource

The Resource model definition.

Variables are only populated by the server, and will be ignored when sending a request.

QueryAggregation

The aggregation expression to be used in the query.

All required parameters must be populated in order to send to Azure.

QueryColumn

QueryColumn.

QueryComparisonExpression

The comparison expression to be used in the query.

All required parameters must be populated in order to send to Azure.

QueryDataset

The definition of data present in the query.

QueryDatasetAutoGenerated

The definition of data present in the query.

QueryDatasetConfiguration

The configuration of dataset in the query.

QueryDefinition

The definition of a query.

All required parameters must be populated in order to send to Azure.

QueryFilter

The filter expression to be used in the export.

QueryFilterAutoGenerated

The filter expression to be used in the export.

QueryGrouping

The group by expression to be used in the query.

All required parameters must be populated in order to send to Azure.

QueryResult

Result of query. It contains all columns listed under groupings and aggregation.

Variables are only populated by the server, and will be ignored when sending a request.

QueryTimePeriod

The start and end date for pulling data for the query.

All required parameters must be populated in order to send to Azure.

ReportConfigAggregation

The aggregation expression to be used in the report.

All required parameters must be populated in order to send to Azure.

ReportConfigComparisonExpression

The comparison expression to be used in the report.

All required parameters must be populated in order to send to Azure.

ReportConfigDataset

The definition of data present in the report.

ReportConfigDatasetConfiguration

The configuration of dataset in the report.

ReportConfigFilter

The filter expression to be used in the report.

ReportConfigGrouping

The group by expression to be used in the report.

All required parameters must be populated in order to send to Azure.

ReportConfigSorting

The order by expression to be used in the report.

All required parameters must be populated in order to send to Azure.

ReportConfigTimePeriod

The start and end date for pulling data for the report.

All required parameters must be populated in order to send to Azure.

Resource

The Resource model definition.

Variables are only populated by the server, and will be ignored when sending a request.

Setting

State of the myscope setting.

Variables are only populated by the server, and will be ignored when sending a request.

SettingsListResult

Result of listing settings. It contains a list of available settings.

Variables are only populated by the server, and will be ignored when sending a request.

Status

The status of the long running operation.

View

States and configurations of Cost Analysis.

Variables are only populated by the server, and will be ignored when sending a request.

ViewListResult

Result of listing views. It contains a list of available views.

Variables are only populated by the server, and will be ignored when sending a request.

Enums

AccumulatedType

Show costs accumulated over time.

AlertCategory

Alert category

AlertCriteria

Criteria that triggered alert

AlertOperator

operator used to compare currentSpend with amount

AlertSource

Source of alert

AlertStatus

alert status

AlertTimeGrainType

Type of timegrain cadence

AlertType

type of alert

ChartType

Chart type of the main view in Cost Analysis. Required.

ExecutionStatus

The status of the export execution.

ExecutionType

The type of the export execution.

ExportType

The type of the query.

ExternalCloudProviderType

An enumeration.

ForecastTimeframeType

The time frame for pulling data for the forecast. If custom, then a specific time period must be provided.

ForecastType

The type of the forecast.

FormatType

The format of the export being delivered.

FunctionType

The name of the aggregation function to use.

GranularityType

The granularity of rows in the query.

KpiType

KPI type (Forecast, Budget).

MetricType

Metric to use when displaying costs.

OperationStatusType

The status of the long running operation.

OperatorType

The operator to use for comparison.

PivotType

Data type to show in view.

QueryColumnType

The type of the column in the export.

RecurrenceType

The schedule recurrence.

ReportConfigColumnType

The type of the column in the report.

ReportConfigSortingDirection

Direction of sort.

ReportGranularityType

The granularity of rows in the report.

ReportTimeframeType

The time frame for pulling data for the report. If custom, then a specific time period must be provided.

ReportType

The type of the report. Usage represents actual usage, forecast represents forecasted data and UsageAndForecast represents both usage and forecasted data. Actual usage and forecasted data can be differentiated based on dates.

SettingsPropertiesStartOn

Indicates what scope Cost Management in the Azure portal should default to. Allowed values: LastUsed.

StatusType

The status of the schedule. Whether active or not. If inactive, the export's scheduled execution is paused.

TimeframeType

The time frame for pulling data for the query. If custom, then a specific time period must be provided.