Package-level declarations

Types

Link copied to clipboard
data class BudgetComparisonExpressionArgs(val name: Output<String>, val operator: Output<Either<String, BudgetOperatorType>>, val values: Output<List<String>>) : ConvertibleToJava<BudgetComparisonExpressionArgs>

The comparison expression to be used in the budgets.

Link copied to clipboard
data class BudgetFilterArgs(val and: Output<List<BudgetFilterPropertiesArgs>>? = null, val dimensions: Output<BudgetComparisonExpressionArgs>? = null, val tags: Output<BudgetComparisonExpressionArgs>? = null) : ConvertibleToJava<BudgetFilterArgs>

May be used to filter budgets by user-specified dimensions and/or tags. Supported for CategoryType(s): Cost, ReservationUtilization.

Link copied to clipboard
Link copied to clipboard
data class BudgetFilterPropertiesArgs(val dimensions: Output<BudgetComparisonExpressionArgs>? = null, val tags: Output<BudgetComparisonExpressionArgs>? = null) : ConvertibleToJava<BudgetFilterPropertiesArgs>

The Dimensions or Tags to filter a budget by. Supported for CategoryType(s): Cost, ReservationUtilization.

Link copied to clipboard
data class BudgetTimePeriodArgs(val endDate: Output<String>? = null, val startDate: Output<String>) : ConvertibleToJava<BudgetTimePeriodArgs>

The time period that defines the active period of the budget. The budget will evaluate data on or after the startDate and will expire on the endDate. Supported for CategoryType(s): Cost, ReservationUtilization. Required for CategoryType(s): Cost, ReservationUtilization.

Link copied to clipboard
data class CostAllocationProportionArgs(val name: Output<String>, val percentage: Output<Double>) : ConvertibleToJava<CostAllocationProportionArgs>

Target resources and allocation

Link copied to clipboard
data class CostAllocationRuleDetailsArgs(val sourceResources: Output<List<SourceCostAllocationResourceArgs>>? = null, val targetResources: Output<List<TargetCostAllocationResourceArgs>>? = null) : ConvertibleToJava<CostAllocationRuleDetailsArgs>

Resource details of the cost allocation rule

Link copied to clipboard
data class CostAllocationRulePropertiesArgs(val description: Output<String>? = null, val details: Output<CostAllocationRuleDetailsArgs>, val status: Output<Either<String, RuleStatus>>) : ConvertibleToJava<CostAllocationRulePropertiesArgs>

The properties of a cost allocation rule

Link copied to clipboard
data class CustomerMetadataArgs(val billingAccountId: Output<String>, val billingProfileId: Output<String>) : ConvertibleToJava<CustomerMetadataArgs>

The customer billing metadata

Link copied to clipboard
data class ExportDatasetArgs(val configuration: Output<ExportDatasetConfigurationArgs>? = null, val granularity: Output<Either<String, GranularityType>>? = null) : ConvertibleToJava<ExportDatasetArgs>

The definition for data in the export.

Link copied to clipboard
Link copied to clipboard
data class ExportDatasetConfigurationArgs(val columns: Output<List<String>>? = null) : ConvertibleToJava<ExportDatasetConfigurationArgs>

The export dataset configuration. Allows columns to be selected for the export. If not provided then the export will include all available columns.

Link copied to clipboard
data class ExportDefinitionArgs(val dataSet: Output<ExportDatasetArgs>? = null, val timePeriod: Output<ExportTimePeriodArgs>? = null, val timeframe: Output<Either<String, TimeframeType>>, val type: Output<Either<String, ExportType>>) : ConvertibleToJava<ExportDefinitionArgs>

The definition of an export.

Link copied to clipboard
data class ExportDeliveryDestinationArgs(val container: Output<String>, val resourceId: Output<String>? = null, val rootFolderPath: Output<String>? = null, val sasToken: Output<String>? = null, val storageAccount: Output<String>? = null) : ConvertibleToJava<ExportDeliveryDestinationArgs>

This represents the blob storage account location where exports of costs will be delivered. There are two ways to configure the destination. The approach recommended for most customers is to specify the resourceId of the storage account. This requires a one-time registration of the account's subscription with the Microsoft.CostManagementExports resource provider in order to give Cost Management services access to the storage. When creating an export in the Azure portal this registration is performed automatically but API users may need to register the subscription explicitly (for more information see https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-supported-services ). Another way to configure the destination is available ONLY to Partners with a Microsoft Partner Agreement plan who are global admins of their billing account. These Partners, instead of specifying the resourceId of a storage account, can specify the storage account name along with a SAS token for the account. This allows exports of costs to a storage account in any tenant. The SAS token should be created for the blob service with Service/Container/Object resource types and with Read/Write/Delete/List/Add/Create permissions (for more information see https://docs.microsoft.com/en-us/azure/cost-management-billing/costs/export-cost-data-storage-account-sas-key ).

Link copied to clipboard
data class ExportDeliveryInfoArgs(val destination: Output<ExportDeliveryDestinationArgs>) : ConvertibleToJava<ExportDeliveryInfoArgs>

The delivery information associated with a export.

Link copied to clipboard
data class ExportRecurrencePeriodArgs(val from: Output<String>, val to: Output<String>? = null) : ConvertibleToJava<ExportRecurrencePeriodArgs>

The start and end date for recurrence schedule.

Link copied to clipboard
data class ExportScheduleArgs(val recurrence: Output<Either<String, RecurrenceType>>? = null, val recurrencePeriod: Output<ExportRecurrencePeriodArgs>? = null, val status: Output<Either<String, StatusType>>? = null) : ConvertibleToJava<ExportScheduleArgs>

The schedule associated with the export.

Link copied to clipboard
Link copied to clipboard
data class ExportTimePeriodArgs(val from: Output<String>, val to: Output<String>) : ConvertibleToJava<ExportTimePeriodArgs>

The date range for data in the export. This should only be specified with timeFrame set to 'Custom'. The maximum date range is 3 months.

Link copied to clipboard
data class FileDestinationArgs(val fileFormats: Output<List<Either<String, FileFormat>>>? = null) : ConvertibleToJava<FileDestinationArgs>

Destination of the view data. This is optional. Currently only CSV format is supported.

Link copied to clipboard
data class GetBudgetPlainArgs(val budgetName: String, val scope: String) : ConvertibleToJava<GetBudgetPlainArgs>
Link copied to clipboard
Link copied to clipboard
data class GetCloudConnectorPlainArgs(val connectorName: String, val expand: String? = null) : ConvertibleToJava<GetCloudConnectorPlainArgs>
Link copied to clipboard
data class GetConnectorPlainArgs(val connectorName: String, val resourceGroupName: String) : ConvertibleToJava<GetConnectorPlainArgs>
Link copied to clipboard
data class GetCostAllocationRulePlainArgs(val billingAccountId: String, val ruleName: String) : ConvertibleToJava<GetCostAllocationRulePlainArgs>
Link copied to clipboard
data class GetExportPlainArgs(val expand: String? = null, val exportName: String, val scope: String) : ConvertibleToJava<GetExportPlainArgs>
Link copied to clipboard
Link copied to clipboard
data class GetMarkupRulePlainArgs(val billingAccountId: String, val billingProfileId: String, val name: String) : ConvertibleToJava<GetMarkupRulePlainArgs>
Link copied to clipboard
data class GetReportByBillingAccountPlainArgs(val billingAccountId: String, val reportName: String) : ConvertibleToJava<GetReportByBillingAccountPlainArgs>
Link copied to clipboard
data class GetReportByDepartmentPlainArgs(val departmentId: String, val reportName: String) : ConvertibleToJava<GetReportByDepartmentPlainArgs>
Link copied to clipboard
data class GetReportByResourceGroupNamePlainArgs(val reportName: String, val resourceGroupName: String) : ConvertibleToJava<GetReportByResourceGroupNamePlainArgs>
Link copied to clipboard
data class GetReportPlainArgs(val reportName: String) : ConvertibleToJava<GetReportPlainArgs>
Link copied to clipboard
Link copied to clipboard
data class GetScheduledActionByScopePlainArgs(val name: String, val scope: String) : ConvertibleToJava<GetScheduledActionByScopePlainArgs>
Link copied to clipboard
data class GetScheduledActionPlainArgs(val name: String) : ConvertibleToJava<GetScheduledActionPlainArgs>
Link copied to clipboard
data class GetSettingPlainArgs(val settingName: String) : ConvertibleToJava<GetSettingPlainArgs>
Link copied to clipboard
data class GetTagInheritanceSettingPlainArgs(val scope: String, val type: String) : ConvertibleToJava<GetTagInheritanceSettingPlainArgs>
Link copied to clipboard
data class GetViewByScopePlainArgs(val scope: String, val viewName: String) : ConvertibleToJava<GetViewByScopePlainArgs>
Link copied to clipboard
data class GetViewPlainArgs(val viewName: String) : ConvertibleToJava<GetViewPlainArgs>
Link copied to clipboard
Link copied to clipboard
data class KpiPropertiesArgs(val enabled: Output<Boolean>? = null, val id: Output<String>? = null, val type: Output<Either<String, KpiTypeType>>? = null) : ConvertibleToJava<KpiPropertiesArgs>

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

Link copied to clipboard
Link copied to clipboard
data class NotificationArgs(val contactEmails: Output<List<String>>, val contactGroups: Output<List<String>>? = null, val contactRoles: Output<List<String>>? = null, val enabled: Output<Boolean>, val frequency: Output<Either<String, Frequency>>? = null, val locale: Output<Either<String, CultureCode>>? = null, val operator: Output<Either<String, BudgetNotificationOperatorType>>, val threshold: Output<Double>, val thresholdType: Output<Either<String, ThresholdType>>? = null) : ConvertibleToJava<NotificationArgs>

The notification associated with a budget. Supported for CategoryType(s): Cost, ReservationUtilization.

Link copied to clipboard
Link copied to clipboard
data class NotificationPropertiesArgs(val language: Output<String>? = null, val message: Output<String>? = null, val regionalFormat: Output<String>? = null, val subject: Output<String>, val to: Output<List<String>>) : ConvertibleToJava<NotificationPropertiesArgs>

The properties of the scheduled action notification.

Link copied to clipboard
data class PivotPropertiesArgs(val name: Output<String>? = null, val type: Output<Either<String, PivotTypeType>>? = null) : ConvertibleToJava<PivotPropertiesArgs>

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

Link copied to clipboard
data class ReportAggregationArgs(val function: Output<Either<String, FunctionType>>, val name: Output<String>) : ConvertibleToJava<ReportAggregationArgs>

The aggregation expression to be used in the report.

Link copied to clipboard
data class ReportComparisonExpressionArgs(val name: Output<String>, val operator: Output<Either<String, OperatorType>>, val values: Output<List<String>>) : ConvertibleToJava<ReportComparisonExpressionArgs>

The comparison expression to be used in the report.

Link copied to clipboard
data class ReportConfigAggregationArgs(val function: Output<Either<String, FunctionType>>, val name: Output<String>) : ConvertibleToJava<ReportConfigAggregationArgs>

The aggregation expression to be used in the report.

Link copied to clipboard
data class ReportConfigComparisonExpressionArgs(val name: Output<String>, val operator: Output<Either<String, OperatorType>>, val values: Output<List<String>>) : ConvertibleToJava<ReportConfigComparisonExpressionArgs>

The comparison expression to be used in the report.

Link copied to clipboard
data class ReportConfigDatasetArgs(val aggregation: Output<Map<String, ReportConfigAggregationArgs>>? = null, val configuration: Output<ReportConfigDatasetConfigurationArgs>? = null, val filter: Output<ReportConfigFilterArgs>? = null, val granularity: Output<Either<String, ReportGranularityType>>? = null, val grouping: Output<List<ReportConfigGroupingArgs>>? = null, val sorting: Output<List<ReportConfigSortingArgs>>? = null) : ConvertibleToJava<ReportConfigDatasetArgs>

The definition of data present in the report.

Link copied to clipboard
data class ReportConfigDatasetConfigurationArgs(val columns: Output<List<String>>? = null) : ConvertibleToJava<ReportConfigDatasetConfigurationArgs>

The configuration of dataset in the report.

Link copied to clipboard
data class ReportConfigFilterArgs(val and: Output<List<ReportConfigFilterArgs>>? = null, val dimensions: Output<ReportConfigComparisonExpressionArgs>? = null, val or: Output<List<ReportConfigFilterArgs>>? = null, val tags: Output<ReportConfigComparisonExpressionArgs>? = null) : ConvertibleToJava<ReportConfigFilterArgs>

The filter expression to be used in the report.

Link copied to clipboard
data class ReportConfigGroupingArgs(val name: Output<String>, val type: Output<Either<String, QueryColumnType>>) : ConvertibleToJava<ReportConfigGroupingArgs>

The group by expression to be used in the report.

Link copied to clipboard
data class ReportConfigSortingArgs(val direction: Output<Either<String, ReportConfigSortingType>>? = null, val name: Output<String>) : ConvertibleToJava<ReportConfigSortingArgs>

The order by expression to be used in the report.

Link copied to clipboard
data class ReportConfigTimePeriodArgs(val from: Output<String>, val to: Output<String>) : ConvertibleToJava<ReportConfigTimePeriodArgs>

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

Link copied to clipboard
data class ReportDatasetArgs(val aggregation: Output<Map<String, ReportAggregationArgs>>? = null, val configuration: Output<ReportDatasetConfigurationArgs>? = null, val filter: Output<ReportFilterArgs>? = null, val granularity: Output<Either<String, GranularityType>>? = null, val grouping: Output<List<ReportGroupingArgs>>? = null) : ConvertibleToJava<ReportDatasetArgs>

The definition of data present in the report.

Link copied to clipboard
Link copied to clipboard
data class ReportDatasetConfigurationArgs(val columns: Output<List<String>>? = null) : ConvertibleToJava<ReportDatasetConfigurationArgs>

The configuration of dataset in the report.

Link copied to clipboard
data class ReportDefinitionArgs(val dataset: Output<ReportDatasetArgs>? = null, val timePeriod: Output<ReportTimePeriodArgs>? = null, val timeframe: Output<Either<String, TimeframeType>>, val type: Output<Either<String, ReportType>>) : ConvertibleToJava<ReportDefinitionArgs>

The definition of a report.

Link copied to clipboard
data class ReportDeliveryDestinationArgs(val container: Output<String>, val resourceId: Output<String>, val rootFolderPath: Output<String>? = null) : ConvertibleToJava<ReportDeliveryDestinationArgs>

The destination information for the delivery of the report.

Link copied to clipboard
data class ReportDeliveryInfoArgs(val destination: Output<ReportDeliveryDestinationArgs>) : ConvertibleToJava<ReportDeliveryInfoArgs>

The delivery information associated with a report.

Link copied to clipboard
data class ReportFilterArgs(val and: Output<List<ReportFilterArgs>>? = null, val dimension: Output<ReportComparisonExpressionArgs>? = null, val not: Output<ReportFilterArgs>? = null, val or: Output<List<ReportFilterArgs>>? = null, val tag: Output<ReportComparisonExpressionArgs>? = null) : ConvertibleToJava<ReportFilterArgs>

The filter expression to be used in the report.

Link copied to clipboard
Link copied to clipboard
data class ReportGroupingArgs(val name: Output<String>, val type: Output<Either<String, ReportColumnType>>) : ConvertibleToJava<ReportGroupingArgs>

The group by expression to be used in the report.

Link copied to clipboard
Link copied to clipboard
data class ReportRecurrencePeriodArgs(val from: Output<String>, val to: Output<String>? = null) : ConvertibleToJava<ReportRecurrencePeriodArgs>

The start and end date for recurrence schedule.

Link copied to clipboard
data class ReportScheduleArgs(val recurrence: Output<Either<String, RecurrenceType>>, val recurrencePeriod: Output<ReportRecurrencePeriodArgs>? = null, val status: Output<Either<String, StatusType>>? = null) : ConvertibleToJava<ReportScheduleArgs>

The schedule associated with a report.

Link copied to clipboard
Link copied to clipboard
data class ReportTimePeriodArgs(val from: Output<String>, val to: Output<String>) : ConvertibleToJava<ReportTimePeriodArgs>

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

Link copied to clipboard
data class SchedulePropertiesArgs(val dayOfMonth: Output<Int>? = null, val daysOfWeek: Output<List<Either<String, DaysOfWeek>>>? = null, val endDate: Output<String>, val frequency: Output<Either<String, ScheduleFrequency>>, val hourOfDay: Output<Int>? = null, val startDate: Output<String>, val weeksOfMonth: Output<List<Either<String, WeeksOfMonth>>>? = null) : ConvertibleToJava<SchedulePropertiesArgs>

The properties of the schedule.

Link copied to clipboard
data class SettingsPropertiesCacheArgs(val channel: Output<String>, val id: Output<String>, val name: Output<String>, val parent: Output<String>? = null, val status: Output<String>? = null, val subchannel: Output<String>) : ConvertibleToJava<SettingsPropertiesCacheArgs>
Link copied to clipboard
data class SourceCostAllocationResourceArgs(val name: Output<String>, val resourceType: Output<Either<String, CostAllocationResourceType>>, val values: Output<List<String>>) : ConvertibleToJava<SourceCostAllocationResourceArgs>

Source resources for cost allocation

Link copied to clipboard
data class SystemAssignedServiceIdentityArgs(val type: Output<Either<String, SystemAssignedServiceIdentityType>>) : ConvertibleToJava<SystemAssignedServiceIdentityArgs>

Managed service identity (either system assigned, or none)

Link copied to clipboard
data class TagInheritancePropertiesArgs(val preferContainerTags: Output<Boolean>) : ConvertibleToJava<TagInheritancePropertiesArgs>

The properties of the tag inheritance setting.

Link copied to clipboard
data class TargetCostAllocationResourceArgs(val name: Output<String>, val policyType: Output<Either<String, CostAllocationPolicyType>>, val resourceType: Output<Either<String, CostAllocationResourceType>>, val values: Output<List<CostAllocationProportionArgs>>) : ConvertibleToJava<TargetCostAllocationResourceArgs>

Target resources for cost allocation.