azure.mgmt.costmanagement.models module¶

exception azure.mgmt.costmanagement.models.ErrorResponseException(deserialize, response, *args)[source]¶

Bases: msrest.exceptions.HttpOperationError

Server responsed with exception of type: ‘ErrorResponse’.

Parameters

deserialize – A deserializer
response – Server response to be deserialized.

class azure.mgmt.costmanagement.models.CommonExportProperties(*, delivery_info=None, definition=None, format=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The common properties of the export.

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

Parameters

format (str or FormatType) – The format of the export being delivered. Possible values include: ‘Csv’
delivery_info (ExportDeliveryInfo) – Required. Has delivery information for the export.
definition (QueryDefinition) – Required. Has definition for the export.

class azure.mgmt.costmanagement.models.Dimension(*, data=None, **kwargs)[source]¶

Bases: azure.mgmt.costmanagement.models._models_py3.Resource

Dimension.

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

Variables

id (str) – Resource Id.
name (str) – Resource name.
type (str) – Resource type.
tags (dict[str, str]) – Resource tags.
description (str) – Dimension description.
filter_enabled (bool) – Filter enabled.
grouping_enabled (bool) – Grouping enabled.
total (int) – Total number of data for the dimension.
category (str) – Dimension category.
usage_start (datetime) – Usage start.
usage_end (datetime) – Usage end.
next_link (str) – The link (url) to the next page of results.

Parameters

data (list[str]) –

class azure.mgmt.costmanagement.models.ErrorDetails(**kwargs)[source]¶

Bases: msrest.serialization.Model

The details of the error.

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

Variables

code (str) – Error code.
message (str) – Error message indicating why the operation failed.

class azure.mgmt.costmanagement.models.ErrorResponse(*, error=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

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

Parameters: error (ErrorDetails) – The details of the error.

class azure.mgmt.costmanagement.models.Export(*, delivery_info=None, definition=None, format=None, schedule=None, **kwargs)[source]¶

Bases: azure.mgmt.costmanagement.models._models_py3.Resource

A export resource.

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

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

Variables

id (str) – Resource Id.
name (str) – Resource name.
type (str) – Resource type.
tags (dict[str, str]) – Resource tags.

Parameters

format (str or FormatType) – The format of the export being delivered. Possible values include: ‘Csv’
delivery_info (ExportDeliveryInfo) – Required. Has delivery information for the export.
definition (QueryDefinition) – Required. Has definition for the export.
schedule (ExportSchedule) – Has schedule information for the export.

class azure.mgmt.costmanagement.models.ExportDeliveryDestination(*, resource_id: str = None, container: str = None, root_folder_path: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

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.

Parameters

resource_id (str) – Required. The resource id of the storage account where exports will be delivered.
container (str) – Required. The name of the container where exports will be uploaded.
root_folder_path (str) – The name of the directory where exports will be uploaded.

class azure.mgmt.costmanagement.models.ExportDeliveryInfo(*, destination=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The delivery information associated with a export.

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

Parameters: destination (ExportDeliveryDestination) – Required. Has destination for the export being delivered.

class azure.mgmt.costmanagement.models.ExportExecution(*, execution_type=None, status=None, submitted_by: str = None, submitted_time=None, processing_start_time=None, processing_end_time=None, file_name: str = None, run_settings=None, **kwargs)[source]¶

Bases: azure.mgmt.costmanagement.models._models_py3.Resource

A export execution.

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

Variables

id (str) – Resource Id.
name (str) – Resource name.
type (str) – Resource type.
tags (dict[str, str]) – Resource tags.

Parameters

execution_type (str or ExecutionType) – The type of the export execution. Possible values include: ‘OnDemand’, ‘Scheduled’
status (str or ExecutionStatus) – The status of the export execution. Possible values include: ‘Queued’, ‘InProgress’, ‘Completed’, ‘Failed’, ‘Timeout’, ‘NewDataNotAvailable’, ‘DataNotAvailable’
submitted_by (str) – The identifier for the entity that executed the export. For OnDemand executions, it is the email id. For Scheduled executions, it is the constant value - System.
submitted_time (datetime) – The time when export was queued to be executed.
processing_start_time (datetime) – The time when export was picked up to be executed.
processing_end_time (datetime) – The time when export execution finished.
file_name (str) – The name of the file export got written to.
run_settings (CommonExportProperties) –

class azure.mgmt.costmanagement.models.ExportExecutionListResult(**kwargs)[source]¶

Bases: msrest.serialization.Model

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.

Variables: value (list[ExportExecution]) – The list of export executions.

class azure.mgmt.costmanagement.models.ExportListResult(**kwargs)[source]¶

Bases: msrest.serialization.Model

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.

Variables: value (list[Export]) – The list of exports.

class azure.mgmt.costmanagement.models.ExportRecurrencePeriod(*, from_property=None, to=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The start and end date for recurrence schedule.

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

Parameters

from_property (datetime) – Required. The start date of recurrence.
to (datetime) – The end date of recurrence.

class azure.mgmt.costmanagement.models.ExportSchedule(*, recurrence=None, status=None, recurrence_period=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The schedule associated with a export.

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

Parameters

status (str or StatusType) – The status of the schedule. Whether active or not. If inactive, the export’s scheduled execution is paused. Possible values include: ‘Active’, ‘Inactive’
recurrence (str or RecurrenceType) – Required. The schedule recurrence. Possible values include: ‘Daily’, ‘Weekly’, ‘Monthly’, ‘Annually’
recurrence_period (ExportRecurrencePeriod) – Has start and end date of the recurrence. The start date must be in future. If present, the end date must be greater than start date.

class azure.mgmt.costmanagement.models.Operation(*, display=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

A Cost management REST API operation.

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

Variables: name (str) – Operation name: {provider}/{resource}/{operation}.
Parameters: display (OperationDisplay) – The object that represents the operation.

class azure.mgmt.costmanagement.models.OperationDisplay(**kwargs)[source]¶

Bases: msrest.serialization.Model

The object that represents the operation.

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

Variables

provider (str) – Service provider: Microsoft.CostManagement.
resource (str) – Resource on which the operation is performed: Dimensions, Query.
operation (str) – Operation type: Read, write, delete, etc.

class azure.mgmt.costmanagement.models.QueryAggregation(*, name: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The aggregation expression to be used in the query.

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

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

Parameters: name (str) – Required. The name of the column to aggregate.
Variables: function (str) – Required. The name of the aggregation function to use. Default value: “Sum” .

function = 'Sum'¶

class azure.mgmt.costmanagement.models.QueryColumn(*, name: str = None, type: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

QueryColumn.

Parameters

name (str) – The name of column.
type (str) – The type of column.

class azure.mgmt.costmanagement.models.QueryComparisonExpression(*, name: str = None, values=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The comparison expression to be used in the query.

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

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

Parameters

name (str) – Required. The name of the column to use in comparison.
values (list[str]) – Required. Array of values to use for comparison

Variables

operator (str) – Required. The operator to use for comparison. Default value: “In” .

operator = 'In'¶

class azure.mgmt.costmanagement.models.QueryDataset(*, granularity=None, configuration=None, aggregation=None, grouping=None, filter=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The definition of data present in the query.

Parameters

granularity (str or GranularityType) – The granularity of rows in the query. Possible values include: ‘Daily’
configuration (QueryDatasetConfiguration) – Has configuration information for the data in the export. The configuration will be ignored if aggregation and grouping are provided.
aggregation (dict[str, QueryAggregation]) – Dictionary of aggregation expression to use in the query. The key of each item in the dictionary is the alias for the aggregated column. Query can have up to 2 aggregation clauses.
grouping (list[QueryGrouping]) – Array of group by expression to use in the query. Query can have up to 2 group by clauses.
filter (QueryFilter) – Has filter expression to use in the query.

class azure.mgmt.costmanagement.models.QueryDatasetConfiguration(*, columns=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The configuration of dataset in the query.

Parameters: columns (list[str]) – Array of column names to be included in the query. Any valid query column name is allowed. If not provided, then query includes all columns.

class azure.mgmt.costmanagement.models.QueryDefinition(*, type=None, timeframe=None, time_period=None, dataset=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The definition of a query.

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

Parameters

type (str or ExportType) – Required. The type of the query. Possible values include: ‘Usage’, ‘ActualCost’, ‘AmortizedCost’
timeframe (str or TimeframeType) – Required. The time frame for pulling data for the query. If custom, then a specific time period must be provided. Possible values include: ‘MonthToDate’, ‘BillingMonthToDate’, ‘TheLastMonth’, ‘TheLastBillingMonth’, ‘WeekToDate’, ‘Custom’
time_period (QueryTimePeriod) – Has time period for pulling data for the query.
dataset (QueryDataset) – Has definition for data in this query.

class azure.mgmt.costmanagement.models.QueryFilter(*, and_property=None, or_property=None, not_property=None, dimension=None, tag=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The filter expression to be used in the export.

Parameters

and_property (list[QueryFilter]) – The logical “AND” expression. Must have at least 2 items.
or_property (list[QueryFilter]) – The logical “OR” expression. Must have at least 2 items.
not_property (QueryFilter) – The logical “NOT” expression.
dimension (QueryComparisonExpression) – Has comparison expression for a dimension
tag (QueryComparisonExpression) – Has comparison expression for a tag

class azure.mgmt.costmanagement.models.QueryGrouping(*, type=None, name: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The group by expression to be used in the query.

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

Parameters

type (str or QueryColumnType) – Required. Has type of the column to group. Possible values include: ‘Tag’, ‘Dimension’
name (str) – Required. The name of the column to group.

class azure.mgmt.costmanagement.models.QueryResult(*, next_link: str = None, columns=None, rows=None, **kwargs)[source]¶

Bases: azure.mgmt.costmanagement.models._models_py3.Resource

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.

Variables

id (str) – Resource Id.
name (str) – Resource name.
type (str) – Resource type.
tags (dict[str, str]) – Resource tags.

Parameters

next_link (str) – The link (url) to the next page of results.
columns (list[QueryColumn]) – Array of columns
rows (list[list[object]]) – Array of rows

class azure.mgmt.costmanagement.models.QueryTimePeriod(*, from_property=None, to=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

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

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

Parameters

from_property (datetime) – Required. The start date to pull data from.
to (datetime) – Required. The end date to pull data to.

class azure.mgmt.costmanagement.models.Resource(**kwargs)[source]¶

Bases: msrest.serialization.Model

The Resource model definition.

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

Variables

id (str) – Resource Id.
name (str) – Resource name.
type (str) – Resource type.
tags (dict[str, str]) – Resource tags.

class azure.mgmt.costmanagement.models.DimensionPaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of Dimension object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.costmanagement.models.OperationPaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of Operation object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.costmanagement.models.ExportType[source]¶

Bases: str, enum.Enum

An enumeration.

actual_cost = 'ActualCost'¶

amortized_cost = 'AmortizedCost'¶

usage = 'Usage'¶

class azure.mgmt.costmanagement.models.TimeframeType[source]¶

Bases: str, enum.Enum

An enumeration.

billing_month_to_date = 'BillingMonthToDate'¶

custom = 'Custom'¶

month_to_date = 'MonthToDate'¶

the_last_billing_month = 'TheLastBillingMonth'¶

the_last_month = 'TheLastMonth'¶

week_to_date = 'WeekToDate'¶

class azure.mgmt.costmanagement.models.GranularityType[source]¶

Bases: str, enum.Enum

An enumeration.

daily = 'Daily'¶

class azure.mgmt.costmanagement.models.QueryColumnType[source]¶

Bases: str, enum.Enum

An enumeration.

dimension = 'Dimension'¶

tag = 'Tag'¶

class azure.mgmt.costmanagement.models.StatusType[source]¶

Bases: str, enum.Enum

An enumeration.

active = 'Active'¶

inactive = 'Inactive'¶

class azure.mgmt.costmanagement.models.RecurrenceType[source]¶

Bases: str, enum.Enum

An enumeration.

annually = 'Annually'¶

daily = 'Daily'¶

monthly = 'Monthly'¶

weekly = 'Weekly'¶

class azure.mgmt.costmanagement.models.FormatType[source]¶

Bases: str, enum.Enum

An enumeration.

csv = 'Csv'¶

class azure.mgmt.costmanagement.models.ExecutionType[source]¶

Bases: str, enum.Enum

An enumeration.

on_demand = 'OnDemand'¶

scheduled = 'Scheduled'¶

class azure.mgmt.costmanagement.models.ExecutionStatus[source]¶

Bases: str, enum.Enum

An enumeration.

completed = 'Completed'¶

data_not_available = 'DataNotAvailable'¶

failed = 'Failed'¶

in_progress = 'InProgress'¶

new_data_not_available = 'NewDataNotAvailable'¶

queued = 'Queued'¶

timeout = 'Timeout'¶