costmanagement¶

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-azure repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-azurerm repo.

class pulumi_azure.costmanagement.ResourceGroupExport(resource_name, opts=None, active=None, delivery_info=None, name=None, query=None, recurrence_period_end=None, recurrence_period_start=None, recurrence_type=None, resource_group_id=None, __props__=None, __name__=None, __opts__=None)¶

Manages an Azure Cost Management Export for a Resource Group.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="northeurope")
example_account = azure.storage.Account("exampleAccount",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    account_tier="Standard",
    account_replication_type="LRS")
example_resource_group_export = azure.costmanagement.ResourceGroupExport("exampleResourceGroupExport",
    resource_group_id=example_resource_group.id,
    recurrence_type="Monthly",
    recurrence_period_start="2020-08-18T00:00:00Z",
    recurrence_period_end="2020-09-18T00:00:00Z",
    delivery_info={
        "storage_account_id": example_account.id,
        "container_name": "examplecontainer",
        "rootFolderPath": "/root/updated",
    },
    query={
        "type": "Usage",
        "timeFrame": "WeekToDate",
    })

Parameters

• resource_name (str) – The name of the resource.

• opts (pulumi.ResourceOptions) – Options for the resource.

• active (pulumi.Input[bool]) – Is the cost management export active? Default is true.

• delivery_info (pulumi.Input[dict]) – A delivery_info block as defined below.

• name (pulumi.Input[str]) – Specifies the name of the Cost Management Export. Changing this forces a new resource to be created.

• query (pulumi.Input[dict]) – A query block as defined below.

• recurrence_period_end (pulumi.Input[str]) – The date the export will stop capturing information.

• recurrence_period_start (pulumi.Input[str]) – The date the export will start capturing information.

• recurrence_type (pulumi.Input[str]) – How often the requested information will be exported. Valid values include Annually, Daily, Monthly, Weekly.

• resource_group_id (pulumi.Input[str]) – The id of the resource group in which to export information.

The delivery_info object supports the following:

• container_name (pulumi.Input[str]) - The name of the container where exports will be uploaded.

• rootFolderPath (pulumi.Input[str]) - The path of the directory where exports will be uploaded.

• storage_account_id (pulumi.Input[str]) - The storage account id where exports will be delivered.

The query object supports the following:

• timeFrame (pulumi.Input[str]) - The time frame for pulling data for the query. If custom, then a specific time period must be provided. Possible values include: WeekToDate, MonthToDate, YearToDate, TheLastWeek, TheLastMonth, TheLastYear, Custom.

• type (pulumi.Input[str]) - The type of the query.

active: pulumi.Output[bool] = None¶

Is the cost management export active? Default is true.

delivery_info: pulumi.Output[dict] = None¶

A delivery_info block as defined below.

• container_name (str) - The name of the container where exports will be uploaded.

• rootFolderPath (str) - The path of the directory where exports will be uploaded.

• storage_account_id (str) - The storage account id where exports will be delivered.

name: pulumi.Output[str] = None¶

Specifies the name of the Cost Management Export. Changing this forces a new resource to be created.

query: pulumi.Output[dict] = None¶

A query block as defined below.

• timeFrame (str) - The time frame for pulling data for the query. If custom, then a specific time period must be provided. Possible values include: WeekToDate, MonthToDate, YearToDate, TheLastWeek, TheLastMonth, TheLastYear, Custom.

• type (str) - The type of the query.

recurrence_period_end: pulumi.Output[str] = None¶

The date the export will stop capturing information.

recurrence_period_start: pulumi.Output[str] = None¶

The date the export will start capturing information.

recurrence_type: pulumi.Output[str] = None¶

How often the requested information will be exported. Valid values include Annually, Daily, Monthly, Weekly.

resource_group_id: pulumi.Output[str] = None¶

The id of the resource group in which to export information.

static get(resource_name, id, opts=None, active=None, delivery_info=None, name=None, query=None, recurrence_period_end=None, recurrence_period_start=None, recurrence_type=None, resource_group_id=None)¶

Get an existing ResourceGroupExport resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

• resource_name (str) – The unique name of the resulting resource.

• id (str) – The unique provider ID of the resource to lookup.

• opts (pulumi.ResourceOptions) – Options for the resource.

• active (pulumi.Input[bool]) – Is the cost management export active? Default is true.

• delivery_info (pulumi.Input[dict]) – A delivery_info block as defined below.

• name (pulumi.Input[str]) – Specifies the name of the Cost Management Export. Changing this forces a new resource to be created.

• query (pulumi.Input[dict]) – A query block as defined below.

• recurrence_period_end (pulumi.Input[str]) – The date the export will stop capturing information.

• recurrence_period_start (pulumi.Input[str]) – The date the export will start capturing information.

• recurrence_type (pulumi.Input[str]) – How often the requested information will be exported. Valid values include Annually, Daily, Monthly, Weekly.

• resource_group_id (pulumi.Input[str]) – The id of the resource group in which to export information.

The delivery_info object supports the following:

• container_name (pulumi.Input[str]) - The name of the container where exports will be uploaded.

• rootFolderPath (pulumi.Input[str]) - The path of the directory where exports will be uploaded.

• storage_account_id (pulumi.Input[str]) - The storage account id where exports will be delivered.

The query object supports the following:

• timeFrame (pulumi.Input[str]) - The time frame for pulling data for the query. If custom, then a specific time period must be provided. Possible values include: WeekToDate, MonthToDate, YearToDate, TheLastWeek, TheLastMonth, TheLastYear, Custom.

• type (pulumi.Input[str]) - The type of the query.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str