@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 9.27 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
* States and configurations of Cost Analysis.
*
* Uses Azure REST API version 2024-08-01. In version 2.x of the Azure Native provider, it used API version 2023-03-01.
*
* Other available API versions: 2019-04-01-preview, 2019-11-01, 2020-06-01, 2021-10-01, 2022-08-01-preview, 2022-10-01, 2022-10-01-preview, 2022-10-05-preview, 2023-03-01, 2023-04-01-preview, 2023-07-01-preview, 2023-08-01, 2023-09-01, 2023-11-01, 2024-10-01-preview, 2025-03-01. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native costmanagement [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare class View extends pulumi.CustomResource {
/**
* Get an existing View resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): View;
/**
* Returns true if the given object is an instance of View. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is View;
/**
* Show costs accumulated over time.
*/
readonly accumulated: pulumi.Output<string | undefined>;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: pulumi.Output<string>;
/**
* Chart type of the main view in Cost Analysis. Required.
*/
readonly chart: pulumi.Output<string | undefined>;
/**
* Date the user created this view.
*/
readonly createdOn: pulumi.Output<string>;
/**
* Currency of the current view.
*/
readonly currency: pulumi.Output<string>;
/**
* Has definition for data in this report config.
*/
readonly dataSet: pulumi.Output<outputs.costmanagement.ReportConfigDatasetResponse | undefined>;
/**
* Date range of the current view.
*/
readonly dateRange: pulumi.Output<string | undefined>;
/**
* User input name of the view. Required.
*/
readonly displayName: pulumi.Output<string | undefined>;
/**
* eTag of the resource. To handle concurrent update scenario, this field will be used to determine whether the user is updating the latest version or not.
*/
readonly eTag: pulumi.Output<string | undefined>;
/**
* If true, report includes monetary commitment.
*/
readonly includeMonetaryCommitment: pulumi.Output<boolean | undefined>;
/**
* List of KPIs to show in Cost Analysis UI.
*/
readonly kpis: pulumi.Output<outputs.costmanagement.KpiPropertiesResponse[] | undefined>;
/**
* Metric to use when displaying costs.
*/
readonly metric: pulumi.Output<string | undefined>;
/**
* Date when the user last modified this view.
*/
readonly modifiedOn: pulumi.Output<string | undefined>;
/**
* Resource name.
*/
readonly name: pulumi.Output<string>;
/**
* Configuration of 3 sub-views in the Cost Analysis UI.
*/
readonly pivots: pulumi.Output<outputs.costmanagement.PivotPropertiesResponse[] | undefined>;
/**
* Cost Management scope to save the view on. This includes 'subscriptions/{subscriptionId}' for subscription scope, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, 'providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope, '/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' for ExternalBillingAccount scope, and '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for ExternalSubscription scope.
*/
readonly scope: pulumi.Output<string | undefined>;
/**
* Has time period for pulling data for the report.
*/
readonly timePeriod: pulumi.Output<outputs.costmanagement.ReportConfigTimePeriodResponse | undefined>;
/**
* The time frame for pulling data for the report. If custom, then a specific time period must be provided.
*/
readonly timeframe: pulumi.Output<string>;
/**
* Resource type.
*/
readonly type: pulumi.Output<string>;
/**
* Create a View resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: ViewArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a View resource.
*/
export interface ViewArgs {
/**
* Show costs accumulated over time.
*/
accumulated?: pulumi.Input<string | enums.costmanagement.AccumulatedType>;
/**
* Chart type of the main view in Cost Analysis. Required.
*/
chart?: pulumi.Input<string | enums.costmanagement.ChartType>;
/**
* Has definition for data in this report config.
*/
dataSet?: pulumi.Input<inputs.costmanagement.ReportConfigDatasetArgs>;
/**
* Date range of the current view.
*/
dateRange?: pulumi.Input<string>;
/**
* User input name of the view. Required.
*/
displayName?: pulumi.Input<string>;
/**
* eTag of the resource. To handle concurrent update scenario, this field will be used to determine whether the user is updating the latest version or not.
*/
eTag?: pulumi.Input<string>;
/**
* If true, report includes monetary commitment.
*/
includeMonetaryCommitment?: pulumi.Input<boolean>;
/**
* List of KPIs to show in Cost Analysis UI.
*/
kpis?: pulumi.Input<pulumi.Input<inputs.costmanagement.KpiPropertiesArgs>[]>;
/**
* Metric to use when displaying costs.
*/
metric?: pulumi.Input<string | enums.costmanagement.MetricType>;
/**
* Date when the user last modified this view.
*/
modifiedOn?: pulumi.Input<string>;
/**
* Configuration of 3 sub-views in the Cost Analysis UI.
*/
pivots?: pulumi.Input<pulumi.Input<inputs.costmanagement.PivotPropertiesArgs>[]>;
/**
* Cost Management scope to save the view on. This includes 'subscriptions/{subscriptionId}' for subscription scope, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, 'providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope, '/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' for ExternalBillingAccount scope, and '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for ExternalSubscription scope.
*/
scope?: pulumi.Input<string>;
/**
* Has time period for pulling data for the report.
*/
timePeriod?: pulumi.Input<inputs.costmanagement.ReportConfigTimePeriodArgs>;
/**
* The time frame for pulling data for the report. If custom, then a specific time period must be provided.
*/
timeframe: pulumi.Input<string | enums.costmanagement.ReportTimeframeType>;
/**
* 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.
*/
type: pulumi.Input<string | enums.costmanagement.ReportType>;
/**
* View name
*/
viewName?: pulumi.Input<string>;
}