pulumi-azure-native-kotlin/com.pulumi.azurenative.costmanagement.kotlin.outputs

Package-level declarations

Types

data class BudgetComparisonExpressionResponse(val name: String, val operator: String, val values: List<String>)

The comparison expression to be used in the budgets.

data class BudgetFilterPropertiesResponse(val dimensions: BudgetComparisonExpressionResponse? = null, val tags: BudgetComparisonExpressionResponse? = null)

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

BudgetFilterResponse

data class BudgetFilterResponse(val and: List<BudgetFilterPropertiesResponse>? = null, val dimensions: BudgetComparisonExpressionResponse? = null, val tags: BudgetComparisonExpressionResponse? = null)

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

BudgetTimePeriodResponse

data class BudgetTimePeriodResponse(val endDate: String? = null, val startDate: String)

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.

CommonExportPropertiesResponse

data class CommonExportPropertiesResponse(val definition: ExportDefinitionResponse, val deliveryInfo: ExportDeliveryInfoResponse, val format: String? = null, val nextRunTimeEstimate: String, val partitionData: Boolean? = null, val runHistory: ExportExecutionListResultResponse? = null)

The common properties of the export.

ConnectorCollectionErrorInfoResponse

data class ConnectorCollectionErrorInfoResponse(val errorCode: String, val errorInnerMessage: String? = null, val errorMessage: String, val errorStartTime: String)

Details of any error encountered on last collection attempt

ConnectorCollectionInfoResponse

data class ConnectorCollectionInfoResponse(val error: ConnectorCollectionErrorInfoResponse? = null, val lastChecked: String? = null, val lastRun: String, val lastUpdated: String, val sourceLastUpdated: String)

Collection and ingestion information

CostAllocationProportionResponse

data class CostAllocationProportionResponse(val name: String, val percentage: Double)

Target resources and allocation

CostAllocationRuleDetailsResponse

data class CostAllocationRuleDetailsResponse(val sourceResources: List<SourceCostAllocationResourceResponse>? = null, val targetResources: List<TargetCostAllocationResourceResponse>? = null)

Resource details of the cost allocation rule

CostAllocationRulePropertiesResponse

data class CostAllocationRulePropertiesResponse(val createdDate: String, val description: String? = null, val details: CostAllocationRuleDetailsResponse, val status: String, val updatedDate: String)

The properties of a cost allocation rule

CurrentSpendResponse

data class CurrentSpendResponse(val amount: Double, val unit: String)

The current amount of cost which is being tracked for a budget. Supported for CategoryType(s): Cost.

CustomerMetadataResponse

data class CustomerMetadataResponse(val billingAccountId: String, val billingProfileId: String)

The customer billing metadata

ErrorDetailsResponse

data class ErrorDetailsResponse(val code: String, val message: String)

The details of the error.

ExportDatasetConfigurationResponse

data class ExportDatasetConfigurationResponse(val columns: List<String>? = null)

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

ExportDatasetResponse

data class ExportDatasetResponse(val configuration: ExportDatasetConfigurationResponse? = null, val granularity: String? = null)

The definition for data in the export.

ExportDefinitionResponse

data class ExportDefinitionResponse(val dataSet: ExportDatasetResponse? = null, val timePeriod: ExportTimePeriodResponse? = null, val timeframe: String, val type: String)

The definition of an export.

ExportDeliveryDestinationResponse

data class ExportDeliveryDestinationResponse(val container: String, val resourceId: String? = null, val rootFolderPath: String? = null, val sasToken: String? = null, val storageAccount: String? = null)

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 ).

ExportDeliveryInfoResponse

data class ExportDeliveryInfoResponse(val destination: ExportDeliveryDestinationResponse)

The delivery information associated with a export.

ExportExecutionListResultResponse

data class ExportExecutionListResultResponse(val value: List<ExportRunResponse>)

Result of listing the run history of an export.

ExportRecurrencePeriodResponse

data class ExportRecurrencePeriodResponse(val from: String, val to: String? = null)

The start and end date for recurrence schedule.

ExportRunResponse

data class ExportRunResponse(val eTag: String? = null, val error: ErrorDetailsResponse? = null, val executionType: String? = null, val fileName: String? = null, val id: String, val name: String, val processingEndTime: String? = null, val processingStartTime: String? = null, val runSettings: CommonExportPropertiesResponse? = null, val status: String? = null, val submittedBy: String? = null, val submittedTime: String? = null, val type: String)

An export run.

ExportScheduleResponse

data class ExportScheduleResponse(val recurrence: String? = null, val recurrencePeriod: ExportRecurrencePeriodResponse? = null, val status: String? = null)

The schedule associated with the export.

ExportTimePeriodResponse

data class ExportTimePeriodResponse(val from: String, val to: String)

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.

FileDestinationResponse

data class FileDestinationResponse(val fileFormats: List<String>? = null)

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

ForecastSpendResponse

data class ForecastSpendResponse(val amount: Double, val unit: String)

The forecasted cost which is being tracked for a budget. Supported for CategoryType(s): Cost.

GetBudgetResult

data class GetBudgetResult(val amount: Double? = null, val azureApiVersion: String, val category: String, val currentSpend: CurrentSpendResponse, val eTag: String? = null, val filter: BudgetFilterResponse? = null, val forecastSpend: ForecastSpendResponse, val id: String, val name: String, val notifications: Map<String, NotificationResponse>? = null, val timeGrain: String, val timePeriod: BudgetTimePeriodResponse, val type: String)

A budget resource.

GetCloudConnectorResult

data class GetCloudConnectorResult(val azureApiVersion: String, val billingModel: String? = null, val collectionInfo: ConnectorCollectionInfoResponse, val createdOn: String, val credentialsKey: String? = null, val daysTrialRemaining: Int, val defaultManagementGroupId: String? = null, val displayName: String? = null, val externalBillingAccountId: String, val id: String, val kind: String? = null, val modifiedOn: String, val name: String, val providerBillingAccountDisplayName: String, val providerBillingAccountId: String, val reportId: String? = null, val status: String, val subscriptionId: String? = null, val type: String)

The Connector model definition

GetConnectorResult

data class GetConnectorResult(val azureApiVersion: String, val collection: ConnectorCollectionInfoResponse, val createdOn: String, val credentialsKey: String? = null, val displayName: String? = null, val id: String, val kind: String? = null, val location: String? = null, val modifiedOn: String, val name: String, val providerAccountId: String, val reportId: String? = null, val status: String? = null, val tags: Map<String, String>? = null, val type: String)

The Connector model definition

GetCostAllocationRuleResult

data class GetCostAllocationRuleResult(val azureApiVersion: String, val id: String, val name: String, val properties: CostAllocationRulePropertiesResponse, val type: String)

The cost allocation rule model definition

GetExportResult

data class GetExportResult(val azureApiVersion: String, val definition: ExportDefinitionResponse, val deliveryInfo: ExportDeliveryInfoResponse, val eTag: String? = null, val format: String? = null, val id: String, val identity: SystemAssignedServiceIdentityResponse? = null, val location: String? = null, val name: String, val nextRunTimeEstimate: String, val partitionData: Boolean? = null, val runHistory: ExportExecutionListResultResponse? = null, val schedule: ExportScheduleResponse? = null, val type: String)

An export resource.

GetMarkupRuleResult

data class GetMarkupRuleResult(val azureApiVersion: String, val customerDetails: CustomerMetadataResponse, val description: String? = null, val eTag: String? = null, val endDate: String? = null, val id: String, val name: String, val percentage: Double, val startDate: String, val type: String)

Markup rule

GetReportByBillingAccountResult

data class GetReportByBillingAccountResult(val azureApiVersion: String, val definition: ReportDefinitionResponse, val deliveryInfo: ReportDeliveryInfoResponse, val format: String? = null, val id: String, val name: String, val schedule: ReportScheduleResponse? = null, val tags: Map<String, String>, val type: String)

A report resource.

GetReportByDepartmentResult

data class GetReportByDepartmentResult(val azureApiVersion: String, val definition: ReportDefinitionResponse, val deliveryInfo: ReportDeliveryInfoResponse, val format: String? = null, val id: String, val name: String, val schedule: ReportScheduleResponse? = null, val tags: Map<String, String>, val type: String)

A report resource.

GetReportByResourceGroupNameResult

data class GetReportByResourceGroupNameResult(val azureApiVersion: String, val definition: ReportDefinitionResponse, val deliveryInfo: ReportDeliveryInfoResponse, val format: String? = null, val id: String, val name: String, val schedule: ReportScheduleResponse? = null, val tags: Map<String, String>, val type: String)

A report resource.

GetReportResult

data class GetReportResult(val azureApiVersion: String, val definition: ReportDefinitionResponse, val deliveryInfo: ReportDeliveryInfoResponse, val format: String? = null, val id: String, val name: String, val schedule: ReportScheduleResponse? = null, val tags: Map<String, String>, val type: String)

A report resource.

GetScheduledActionByScopeResult

data class GetScheduledActionByScopeResult(val azureApiVersion: String, val displayName: String, val eTag: String, val fileDestination: FileDestinationResponse? = null, val id: String, val kind: String? = null, val name: String, val notification: NotificationPropertiesResponse, val notificationEmail: String? = null, val schedule: SchedulePropertiesResponse, val scope: String? = null, val status: String, val systemData: SystemDataResponse, val type: String, val viewId: String)

Scheduled action definition.

GetScheduledActionResult

data class GetScheduledActionResult(val azureApiVersion: String, val displayName: String, val eTag: String, val fileDestination: FileDestinationResponse? = null, val id: String, val kind: String? = null, val name: String, val notification: NotificationPropertiesResponse, val notificationEmail: String? = null, val schedule: SchedulePropertiesResponse, val scope: String? = null, val status: String, val systemData: SystemDataResponse, val type: String, val viewId: String)

Scheduled action definition.

GetSettingResult

data class GetSettingResult(val azureApiVersion: String, val cache: List<SettingsPropertiesResponseCache>? = null, val id: String, val kind: String, val name: String, val scope: String, val startOn: String? = null, val type: String)

State of the myscope setting.

GetTagInheritanceSettingResult

data class GetTagInheritanceSettingResult(val azureApiVersion: String, val id: String, val kind: String, val name: String, val properties: TagInheritancePropertiesResponse, val type: String)

Tag Inheritance Setting definition.

GetViewByScopeResult

data class GetViewByScopeResult(val accumulated: String? = null, val azureApiVersion: String, val chart: String? = null, val createdOn: String, val currency: String, val dataSet: ReportConfigDatasetResponse? = null, val dateRange: String? = null, val displayName: String? = null, val eTag: String? = null, val id: String, val includeMonetaryCommitment: Boolean? = null, val kpis: List<KpiPropertiesResponse>? = null, val metric: String? = null, val modifiedOn: String? = null, val name: String, val pivots: List<PivotPropertiesResponse>? = null, val scope: String? = null, val timePeriod: ReportConfigTimePeriodResponse? = null, val timeframe: String, val type: String)

States and configurations of Cost Analysis.

GetViewResult

data class GetViewResult(val accumulated: String? = null, val azureApiVersion: String, val chart: String? = null, val createdOn: String, val currency: String, val dataSet: ReportConfigDatasetResponse? = null, val dateRange: String? = null, val displayName: String? = null, val eTag: String? = null, val id: String, val includeMonetaryCommitment: Boolean? = null, val kpis: List<KpiPropertiesResponse>? = null, val metric: String? = null, val modifiedOn: String? = null, val name: String, val pivots: List<PivotPropertiesResponse>? = null, val scope: String? = null, val timePeriod: ReportConfigTimePeriodResponse? = null, val timeframe: String, val type: String)

States and configurations of Cost Analysis.

KpiPropertiesResponse

data class KpiPropertiesResponse(val enabled: Boolean? = null, val id: String? = null, val type: String? = null)

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

NotificationPropertiesResponse

data class NotificationPropertiesResponse(val language: String? = null, val message: String? = null, val regionalFormat: String? = null, val subject: String, val to: List<String>)

The properties of the scheduled action notification.

NotificationResponse

data class NotificationResponse(val contactEmails: List<String>, val contactGroups: List<String>? = null, val contactRoles: List<String>? = null, val enabled: Boolean, val frequency: String? = null, val locale: String? = null, val operator: String, val threshold: Double, val thresholdType: String? = null)

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

PivotPropertiesResponse

data class PivotPropertiesResponse(val name: String? = null, val type: String? = null)

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

ReportAggregationResponse

data class ReportAggregationResponse(val function: String, val name: String)

The aggregation expression to be used in the report.

ReportComparisonExpressionResponse

data class ReportComparisonExpressionResponse(val name: String, val operator: String, val values: List<String>)

The comparison expression to be used in the report.

ReportConfigAggregationResponse

data class ReportConfigAggregationResponse(val function: String, val name: String)

The aggregation expression to be used in the report.

ReportConfigComparisonExpressionResponse

data class ReportConfigComparisonExpressionResponse(val name: String, val operator: String, val values: List<String>)

The comparison expression to be used in the report.

ReportConfigDatasetConfigurationResponse

data class ReportConfigDatasetConfigurationResponse(val columns: List<String>? = null)

The configuration of dataset in the report.

ReportConfigDatasetResponse

data class ReportConfigDatasetResponse(val aggregation: Map<String, ReportConfigAggregationResponse>? = null, val configuration: ReportConfigDatasetConfigurationResponse? = null, val filter: ReportConfigFilterResponse? = null, val granularity: String? = null, val grouping: List<ReportConfigGroupingResponse>? = null, val sorting: List<ReportConfigSortingResponse>? = null)

The definition of data present in the report.

ReportConfigFilterResponse

data class ReportConfigFilterResponse(val and: List<ReportConfigFilterResponse>? = null, val dimensions: ReportConfigComparisonExpressionResponse? = null, val or: List<ReportConfigFilterResponse>? = null, val tags: ReportConfigComparisonExpressionResponse? = null)

The filter expression to be used in the report.

ReportConfigGroupingResponse

data class ReportConfigGroupingResponse(val name: String, val type: String)

The group by expression to be used in the report.

ReportConfigSortingResponse

data class ReportConfigSortingResponse(val direction: String? = null, val name: String)

The order by expression to be used in the report.

ReportConfigTimePeriodResponse

data class ReportConfigTimePeriodResponse(val from: String, val to: String)

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

ReportDatasetConfigurationResponse

data class ReportDatasetConfigurationResponse(val columns: List<String>? = null)

The configuration of dataset in the report.

ReportDatasetResponse

data class ReportDatasetResponse(val aggregation: Map<String, ReportAggregationResponse>? = null, val configuration: ReportDatasetConfigurationResponse? = null, val filter: ReportFilterResponse? = null, val granularity: String? = null, val grouping: List<ReportGroupingResponse>? = null)

The definition of data present in the report.

ReportDefinitionResponse

data class ReportDefinitionResponse(val dataset: ReportDatasetResponse? = null, val timePeriod: ReportTimePeriodResponse? = null, val timeframe: String, val type: String)

The definition of a report.

ReportDeliveryDestinationResponse

data class ReportDeliveryDestinationResponse(val container: String, val resourceId: String, val rootFolderPath: String? = null)

The destination information for the delivery of the report.

ReportDeliveryInfoResponse

data class ReportDeliveryInfoResponse(val destination: ReportDeliveryDestinationResponse)

The delivery information associated with a report.

ReportFilterResponse

data class ReportFilterResponse(val and: List<ReportFilterResponse>? = null, val dimension: ReportComparisonExpressionResponse? = null, val not: ReportFilterResponse? = null, val or: List<ReportFilterResponse>? = null, val tag: ReportComparisonExpressionResponse? = null)

The filter expression to be used in the report.

ReportGroupingResponse

data class ReportGroupingResponse(val name: String, val type: String)

The group by expression to be used in the report.

ReportRecurrencePeriodResponse

data class ReportRecurrencePeriodResponse(val from: String, val to: String? = null)

The start and end date for recurrence schedule.

ReportScheduleResponse

data class ReportScheduleResponse(val recurrence: String, val recurrencePeriod: ReportRecurrencePeriodResponse? = null, val status: String? = null)

The schedule associated with a report.

ReportTimePeriodResponse

data class ReportTimePeriodResponse(val from: String, val to: String)

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

SchedulePropertiesResponse

data class SchedulePropertiesResponse(val dayOfMonth: Int? = null, val daysOfWeek: List<String>? = null, val endDate: String, val frequency: String, val hourOfDay: Int? = null, val startDate: String, val weeksOfMonth: List<String>? = null)

The properties of the schedule.

SettingsPropertiesResponseCache

data class SettingsPropertiesResponseCache(val channel: String, val id: String, val name: String, val parent: String? = null, val status: String? = null, val subchannel: String)

SourceCostAllocationResourceResponse

data class SourceCostAllocationResourceResponse(val name: String, val resourceType: String, val values: List<String>)

Source resources for cost allocation

SystemAssignedServiceIdentityResponse

data class SystemAssignedServiceIdentityResponse(val principalId: String, val tenantId: String, val type: String)

Managed service identity (either system assigned, or none)

SystemDataResponse

data class SystemDataResponse(val createdAt: String? = null, val createdBy: String? = null, val createdByType: String? = null, val lastModifiedAt: String? = null, val lastModifiedBy: String? = null, val lastModifiedByType: String? = null)

Metadata pertaining to creation and last modification of the resource.

TagInheritancePropertiesResponse

data class TagInheritancePropertiesResponse(val preferContainerTags: Boolean)

The properties of the tag inheritance setting.

TargetCostAllocationResourceResponse

data class TargetCostAllocationResourceResponse(val name: String, val policyType: String, val resourceType: String, val values: List<CostAllocationProportionResponse>)

Target resources for cost allocation.