@azure/arm-costmanagement package

Classes

CostManagementClient

Interfaces

Alert

An individual alert.

AlertPropertiesDefinition

defines the type of alert

AlertPropertiesDetails

Alert details

Alerts

Interface representing a Alerts.

AlertsDismissOptionalParams

Optional parameters.

AlertsGetOptionalParams

Optional parameters.

AlertsListExternalOptionalParams

Optional parameters.

AlertsListOptionalParams

Optional parameters.

AlertsResult

Result of alerts.

AllSavingsBenefitDetails

Benefit recommendation details.

AllSavingsList

The list of all benefit recommendations with the recommendation details.

BenefitRecommendationModel

benefit plan recommendation details.

BenefitRecommendationProperties

The properties of the benefit recommendations.

BenefitRecommendations

Interface representing a BenefitRecommendations.

BenefitRecommendationsListNextOptionalParams

Optional parameters.

BenefitRecommendationsListOptionalParams

Optional parameters.

BenefitRecommendationsListResult

Result of listing benefit recommendations.

BenefitResource

The benefit resource model definition.

BenefitUtilizationSummaries

Interface representing a BenefitUtilizationSummaries.

BenefitUtilizationSummariesListByBillingAccountIdNextOptionalParams

Optional parameters.

BenefitUtilizationSummariesListByBillingAccountIdOptionalParams

Optional parameters.

BenefitUtilizationSummariesListByBillingProfileIdNextOptionalParams

Optional parameters.

BenefitUtilizationSummariesListByBillingProfileIdOptionalParams

Optional parameters.

BenefitUtilizationSummariesListBySavingsPlanIdNextOptionalParams

Optional parameters.

BenefitUtilizationSummariesListBySavingsPlanIdOptionalParams

Optional parameters.

BenefitUtilizationSummariesListBySavingsPlanOrderNextOptionalParams

Optional parameters.

BenefitUtilizationSummariesListBySavingsPlanOrderOptionalParams

Optional parameters.

BenefitUtilizationSummariesListResult

List of benefit utilization summaries.

BenefitUtilizationSummary

Benefit utilization summary resource.

BenefitUtilizationSummaryProperties

The properties of a benefit utilization summary.

BlobInfo

The blob information generated by this operation.

CheckNameAvailabilityRequest

The check availability request body.

CheckNameAvailabilityResponse

The check availability result.

CommonExportProperties

The common properties of the export.

CostDetailsOperationResults

The result of the long running operation for cost details Api.

CostDetailsTimePeriod

The start and end date for pulling data for the cost detailed report. API only allows data to be pulled for 1 month or less and no older than 13 months.

CostManagementClientOptionalParams

Optional parameters.

CostManagementOperation

A Cost management REST API operation.

CostManagementProxyResource

The Resource model definition.

CostManagementResource

The Resource model definition.

Dimension

List of Dimension.

Dimensions

Interface representing a Dimensions.

DimensionsByExternalCloudProviderTypeOptionalParams

Optional parameters.

DimensionsListOptionalParams

Optional parameters.

DimensionsListResult

Result of listing dimensions. It contains a list of available dimensions.

DismissAlertPayload

The request payload to update an alert

DownloadURL

The URL to download the generated report.

ErrorDetails

The details of the error.

ErrorDetailsWithNestedDetails

The details of the error.

ErrorResponse

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

Some Error responses:

  • 429 TooManyRequests - Request is throttled. Retry after waiting for the time specified in the "x-ms-ratelimit-microsoft.consumption-retry-after" header.

  • 503 ServiceUnavailable - Service is temporarily unavailable. Retry after waiting for the time specified in the "Retry-After" header.

ErrorResponseWithNestedDetails

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

Some Error responses:

  • 429 TooManyRequests - Request is throttled. Retry after waiting for the time specified in the "x-ms-ratelimit-microsoft.consumption-retry-after" header.

  • 503 ServiceUnavailable - Service is temporarily unavailable. Retry after waiting for the time specified in the "Retry-After" header.

Export

An export resource.

ExportDataset

The definition for data in the export.

ExportDatasetConfiguration

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

ExportDefinition

The definition of an export.

ExportDeliveryDestination

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

ExportDeliveryInfo

The delivery information associated with a export.

ExportExecutionListResult

Result of listing the run history of an export.

ExportListResult

Result of listing exports. It contains a list of available exports in the scope provided.

ExportProperties

The properties of the export.

ExportRecurrencePeriod

The start and end date for recurrence schedule.

ExportRun

An export run.

ExportSchedule

The schedule associated with the export.

ExportTimePeriod

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.

Exports

Interface representing a Exports.

ExportsCreateOrUpdateOptionalParams

Optional parameters.

ExportsDeleteOptionalParams

Optional parameters.

ExportsExecuteOptionalParams

Optional parameters.

ExportsGetExecutionHistoryOptionalParams

Optional parameters.

ExportsGetOptionalParams

Optional parameters.

ExportsListOptionalParams

Optional parameters.

FileDestination

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

Forecast

Interface representing a Forecast.

ForecastAggregation

The aggregation expression to be used in the forecast.

ForecastColumn

Forecast column properties

ForecastComparisonExpression

The comparison expression to be used in the forecast.

ForecastDataset

The definition of data present in the forecast.

ForecastDatasetConfiguration

The configuration of dataset in the forecast.

ForecastDefinition

The definition of a forecast.

ForecastExternalCloudProviderUsageOptionalParams

Optional parameters.

ForecastFilter

The filter expression to be used in the export.

ForecastResult

Result of forecast. It contains all columns listed under groupings and aggregation.

ForecastTimePeriod

Has time period for pulling data for the forecast.

ForecastUsageOptionalParams

Optional parameters.

GenerateCostDetailsReport

Interface representing a GenerateCostDetailsReport.

GenerateCostDetailsReportCreateOperationHeaders

Defines headers for GenerateCostDetailsReport_createOperation operation.

GenerateCostDetailsReportCreateOperationOptionalParams

Optional parameters.

GenerateCostDetailsReportErrorResponse

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

Some Error responses:

  • 400 Bad Request - Invalid Request Payload. Request payload provided is not in a json format or had an invalid member not accepted in the request payload.

  • 400 Bad Request - Invalid request payload: can only have either timePeriod or invoiceId or billingPeriod. API only allows data to be pulled for either timePeriod or invoiceId or billingPeriod. Customer should provide only one of these parameters.

  • 400 Bad Request - Start date must be after . API only allows data to be pulled no older than 13 months from now.

  • 400 Bad Request - The maximum allowed date range is 1 months. API only allows data to be pulled for 1 month or less.

  • 429 TooManyRequests - Request is throttled. Retry after waiting for the time specified in the "retry-after" header.

  • 503 ServiceUnavailable - Service is temporarily unavailable. Retry after waiting for the time specified in the "Retry-After" header.

GenerateCostDetailsReportGetOperationResultsOptionalParams

Optional parameters.

GenerateCostDetailsReportRequestDefinition

The definition of a cost detailed report.

GenerateDetailedCostReport

Interface representing a GenerateDetailedCostReport.

GenerateDetailedCostReportCreateOperationHeaders

Defines headers for GenerateDetailedCostReport_createOperation operation.

GenerateDetailedCostReportCreateOperationOptionalParams

Optional parameters.

GenerateDetailedCostReportDefinition

The definition of a cost detailed report.

GenerateDetailedCostReportErrorResponse

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

Some Error responses:

  • 413 Request Entity Too Large - Request is throttled. The amount of data required to fulfill the request exceeds the maximum size permitted of 2Gb. Please utilize our Exports feature instead.

  • 429 TooManyRequests - Request is throttled. Retry after waiting for the time specified in the "x-ms-ratelimit-microsoft.consumption-retry-after" header.

  • 503 ServiceUnavailable - Service is temporarily unavailable. Retry after waiting for the time specified in the "Retry-After" header.

GenerateDetailedCostReportOperationResult

The result of the long running operation for cost detailed report.

GenerateDetailedCostReportOperationResults

Interface representing a GenerateDetailedCostReportOperationResults.

GenerateDetailedCostReportOperationResultsGetOptionalParams

Optional parameters.

GenerateDetailedCostReportOperationStatus

Interface representing a GenerateDetailedCostReportOperationStatus.

GenerateDetailedCostReportOperationStatusGetOptionalParams

Optional parameters.

GenerateDetailedCostReportOperationStatuses

The status of the long running operation for cost detailed report.

GenerateDetailedCostReportTimePeriod

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

GenerateReservationDetailsReport

Interface representing a GenerateReservationDetailsReport.

GenerateReservationDetailsReportByBillingAccountIdHeaders

Defines headers for GenerateReservationDetailsReport_byBillingAccountId operation.

GenerateReservationDetailsReportByBillingAccountIdOptionalParams

Optional parameters.

GenerateReservationDetailsReportByBillingProfileIdHeaders

Defines headers for GenerateReservationDetailsReport_byBillingProfileId operation.

GenerateReservationDetailsReportByBillingProfileIdOptionalParams

Optional parameters.

IncludedQuantityUtilizationSummary

Included Quantity utilization summary resource.

IncludedQuantityUtilizationSummaryProperties

Included Quantity utilization summary properties.

KpiProperties

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

NotificationProperties

The properties of the scheduled action notification.

Operation

Details of a REST API operation, returned from the Resource Provider Operations API

OperationDisplay

Localized display information for this particular operation.

OperationListResult

Result of listing cost management operations. It contains a list of operations and a URL link to get the next set of results.

OperationStatus

The status of the long running operation.

Operations

Interface representing a Operations.

OperationsListNextOptionalParams

Optional parameters.

OperationsListOptionalParams

Optional parameters.

PivotProperties

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

PriceSheet

Interface representing a PriceSheet.

PriceSheetDownloadByBillingProfileHeaders

Defines headers for PriceSheet_downloadByBillingProfile operation.

PriceSheetDownloadByBillingProfileOptionalParams

Optional parameters.

PriceSheetDownloadHeaders

Defines headers for PriceSheet_download operation.

PriceSheetDownloadOptionalParams

Optional parameters.

ProxyResource

The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location

Query

Interface representing a Query.

QueryAggregation

The aggregation expression to be used in the query.

QueryColumn

QueryColumn properties

QueryComparisonExpression

The comparison expression to be used in the query.

QueryDataset

The definition of data present in the query.

QueryDatasetConfiguration

The configuration of dataset in the query.

QueryDefinition

The definition of a query.

QueryFilter

The filter expression to be used in the export.

QueryGrouping

The group by expression to be used in the query.

QueryResult

Result of query. It contains all columns listed under groupings and aggregation.

QueryTimePeriod

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

QueryUsageByExternalCloudProviderTypeOptionalParams

Optional parameters.

QueryUsageOptionalParams

Optional parameters.

RecommendationUsageDetails

On-demand charges between firstConsumptionDate and lastConsumptionDate that were used for computing benefit recommendations.

ReportConfigAggregation

The aggregation expression to be used in the report.

ReportConfigComparisonExpression

The comparison expression to be used in the report.

ReportConfigDataset

The definition of data present in the report.

ReportConfigDatasetConfiguration

The configuration of dataset in the report.

ReportConfigFilter

The filter expression to be used in the report.

ReportConfigGrouping

The group by expression to be used in the report.

ReportConfigSorting

The order by expression to be used in the report.

ReportConfigTimePeriod

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

Resource

Common fields that are returned in the response for all Azure Resource Manager resources

SavingsPlanUtilizationSummary

Savings plan utilization summary resource.

SavingsPlanUtilizationSummaryProperties

Savings plan utilization summary properties.

ScheduleProperties

The properties of the schedule.

ScheduledAction

Scheduled action definition.

ScheduledActionListResult

Scheduled actions list result. It contains a list of scheduled actions.

ScheduledActionProxyResource

The Resource model definition.

ScheduledActions

Interface representing a ScheduledActions.

ScheduledActionsCheckNameAvailabilityByScopeOptionalParams

Optional parameters.

ScheduledActionsCheckNameAvailabilityOptionalParams

Optional parameters.

ScheduledActionsCreateOrUpdateByScopeOptionalParams

Optional parameters.

ScheduledActionsCreateOrUpdateOptionalParams

Optional parameters.

ScheduledActionsDeleteByScopeOptionalParams

Optional parameters.

ScheduledActionsDeleteOptionalParams

Optional parameters.

ScheduledActionsGetByScopeOptionalParams

Optional parameters.

ScheduledActionsGetOptionalParams

Optional parameters.

ScheduledActionsListByScopeNextOptionalParams

Optional parameters.

ScheduledActionsListByScopeOptionalParams

Optional parameters.

ScheduledActionsListNextOptionalParams

Optional parameters.

ScheduledActionsListOptionalParams

Optional parameters.

ScheduledActionsRunByScopeOptionalParams

Optional parameters.

ScheduledActionsRunOptionalParams

Optional parameters.

SharedScopeBenefitRecommendationProperties

The properties of the benefit recommendation when scope is 'Shared'.

SingleScopeBenefitRecommendationProperties

The properties of the benefit recommendations when scope is 'Single'.

Status

The status of the long running operation.

SystemData

Metadata pertaining to creation and last modification of the resource.

View

States and configurations of Cost Analysis.

ViewListResult

Result of listing views. It contains a list of available views.

Views

Interface representing a Views.

ViewsCreateOrUpdateByScopeOptionalParams

Optional parameters.

ViewsCreateOrUpdateOptionalParams

Optional parameters.

ViewsDeleteByScopeOptionalParams

Optional parameters.

ViewsDeleteOptionalParams

Optional parameters.

ViewsGetByScopeOptionalParams

Optional parameters.

ViewsGetOptionalParams

Optional parameters.

ViewsListByScopeNextOptionalParams

Optional parameters.

ViewsListByScopeOptionalParams

Optional parameters.

ViewsListNextOptionalParams

Optional parameters.

ViewsListOptionalParams

Optional parameters.

Type Aliases

AccumulatedType

Defines values for AccumulatedType.
KnownAccumulatedType can be used interchangeably with AccumulatedType, this enum contains the known values that the service supports.

Known values supported by the service

true
false

ActionType

Defines values for ActionType.
KnownActionType can be used interchangeably with ActionType, this enum contains the known values that the service supports.

Known values supported by the service

Internal

AlertCategory

Defines values for AlertCategory.
KnownAlertCategory can be used interchangeably with AlertCategory, this enum contains the known values that the service supports.

Known values supported by the service

Cost
Usage
Billing
System

AlertCriteria

Defines values for AlertCriteria.
KnownAlertCriteria can be used interchangeably with AlertCriteria, this enum contains the known values that the service supports.

Known values supported by the service

CostThresholdExceeded
UsageThresholdExceeded
CreditThresholdApproaching
CreditThresholdReached
QuotaThresholdApproaching
QuotaThresholdReached
MultiCurrency
ForecastCostThresholdExceeded
ForecastUsageThresholdExceeded
InvoiceDueDateApproaching
InvoiceDueDateReached
CrossCloudNewDataAvailable
CrossCloudCollectionError
GeneralThresholdError

AlertOperator

Defines values for AlertOperator.
KnownAlertOperator can be used interchangeably with AlertOperator, this enum contains the known values that the service supports.

Known values supported by the service

None
EqualTo
GreaterThan
GreaterThanOrEqualTo
LessThan
LessThanOrEqualTo

AlertSource

Defines values for AlertSource.
KnownAlertSource can be used interchangeably with AlertSource, this enum contains the known values that the service supports.

Known values supported by the service

Preset
User

AlertStatus

Defines values for AlertStatus.
KnownAlertStatus can be used interchangeably with AlertStatus, this enum contains the known values that the service supports.

Known values supported by the service

None
Active
Overridden
Resolved
Dismissed

AlertTimeGrainType

Defines values for AlertTimeGrainType.
KnownAlertTimeGrainType can be used interchangeably with AlertTimeGrainType, this enum contains the known values that the service supports.

Known values supported by the service

None
Monthly
Quarterly
Annually
BillingMonth
BillingQuarter
BillingAnnual

AlertType

Defines values for AlertType.
KnownAlertType can be used interchangeably with AlertType, this enum contains the known values that the service supports.

Known values supported by the service

Budget
Invoice
Credit
Quota
General
xCloud
BudgetForecast

AlertsDismissResponse

Contains response data for the dismiss operation.

AlertsGetResponse

Contains response data for the get operation.

AlertsListExternalResponse

Contains response data for the listExternal operation.

AlertsListResponse

Contains response data for the list operation.

BenefitKind

Defines values for BenefitKind.
KnownBenefitKind can be used interchangeably with BenefitKind, this enum contains the known values that the service supports.

Known values supported by the service

IncludedQuantity: Benefit is IncludedQuantity.
Reservation: Benefit is Reservation.
SavingsPlan: Benefit is SavingsPlan.

BenefitRecommendationPropertiesUnion
BenefitRecommendationsListNextResponse

Contains response data for the listNext operation.

BenefitRecommendationsListResponse

Contains response data for the list operation.

BenefitUtilizationSummariesListByBillingAccountIdNextResponse

Contains response data for the listByBillingAccountIdNext operation.

BenefitUtilizationSummariesListByBillingAccountIdResponse

Contains response data for the listByBillingAccountId operation.

BenefitUtilizationSummariesListByBillingProfileIdNextResponse

Contains response data for the listByBillingProfileIdNext operation.

BenefitUtilizationSummariesListByBillingProfileIdResponse

Contains response data for the listByBillingProfileId operation.

BenefitUtilizationSummariesListBySavingsPlanIdNextResponse

Contains response data for the listBySavingsPlanIdNext operation.

BenefitUtilizationSummariesListBySavingsPlanIdResponse

Contains response data for the listBySavingsPlanId operation.

BenefitUtilizationSummariesListBySavingsPlanOrderNextResponse

Contains response data for the listBySavingsPlanOrderNext operation.

BenefitUtilizationSummariesListBySavingsPlanOrderResponse

Contains response data for the listBySavingsPlanOrder operation.

BenefitUtilizationSummaryUnion
ChartType

Defines values for ChartType.
KnownChartType can be used interchangeably with ChartType, this enum contains the known values that the service supports.

Known values supported by the service

Area
Line
StackedColumn
GroupedColumn
Table

CheckNameAvailabilityReason

Defines values for CheckNameAvailabilityReason.
KnownCheckNameAvailabilityReason can be used interchangeably with CheckNameAvailabilityReason, this enum contains the known values that the service supports.

Known values supported by the service

Invalid
AlreadyExists

CostDetailsDataFormat

Defines values for CostDetailsDataFormat.
KnownCostDetailsDataFormat can be used interchangeably with CostDetailsDataFormat, this enum contains the known values that the service supports.

Known values supported by the service

Csv: Csv data format.

CostDetailsMetricType

Defines values for CostDetailsMetricType.
KnownCostDetailsMetricType can be used interchangeably with CostDetailsMetricType, this enum contains the known values that the service supports.

Known values supported by the service

ActualCost: Actual cost data.
AmortizedCost: Amortized cost data.

CostDetailsStatusType

Defines values for CostDetailsStatusType.
KnownCostDetailsStatusType can be used interchangeably with CostDetailsStatusType, this enum contains the known values that the service supports.

Known values supported by the service

Completed: Operation is Completed.
NoDataFound: Operation is Completed and no cost data found.
Failed: Operation Failed.

CreatedByType

Defines values for CreatedByType.
KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports.

Known values supported by the service

User
Application
ManagedIdentity
Key

DaysOfWeek

Defines values for DaysOfWeek.
KnownDaysOfWeek can be used interchangeably with DaysOfWeek, this enum contains the known values that the service supports.

Known values supported by the service

Monday
Tuesday
Wednesday
Thursday
Friday
Saturday
Sunday

DimensionsByExternalCloudProviderTypeResponse

Contains response data for the byExternalCloudProviderType operation.

DimensionsListResponse

Contains response data for the list operation.

ExecutionStatus

Defines values for ExecutionStatus.
KnownExecutionStatus can be used interchangeably with ExecutionStatus, this enum contains the known values that the service supports.

Known values supported by the service

Queued
InProgress
Completed
Failed
Timeout
NewDataNotAvailable
DataNotAvailable

ExecutionType

Defines values for ExecutionType.
KnownExecutionType can be used interchangeably with ExecutionType, this enum contains the known values that the service supports.

Known values supported by the service

OnDemand
Scheduled

ExportType

Defines values for ExportType.
KnownExportType can be used interchangeably with ExportType, this enum contains the known values that the service supports.

Known values supported by the service

Usage
ActualCost
AmortizedCost

ExportsCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

ExportsGetExecutionHistoryResponse

Contains response data for the getExecutionHistory operation.

ExportsGetResponse

Contains response data for the get operation.

ExportsListResponse

Contains response data for the list operation.

ExternalCloudProviderType

Defines values for ExternalCloudProviderType.
KnownExternalCloudProviderType can be used interchangeably with ExternalCloudProviderType, this enum contains the known values that the service supports.

Known values supported by the service

externalSubscriptions
externalBillingAccounts

FileFormat

Defines values for FileFormat.
KnownFileFormat can be used interchangeably with FileFormat, this enum contains the known values that the service supports.

Known values supported by the service

Csv

ForecastExternalCloudProviderUsageResponse

Contains response data for the externalCloudProviderUsage operation.

ForecastOperatorType

Defines values for ForecastOperatorType.
KnownForecastOperatorType can be used interchangeably with ForecastOperatorType, this enum contains the known values that the service supports.

Known values supported by the service

In

ForecastTimeframe

Defines values for ForecastTimeframe.
KnownForecastTimeframe can be used interchangeably with ForecastTimeframe, this enum contains the known values that the service supports.

Known values supported by the service

Custom

ForecastType

Defines values for ForecastType.
KnownForecastType can be used interchangeably with ForecastType, this enum contains the known values that the service supports.

Known values supported by the service

Usage
ActualCost
AmortizedCost

ForecastUsageResponse

Contains response data for the usage operation.

FormatType

Defines values for FormatType.
KnownFormatType can be used interchangeably with FormatType, this enum contains the known values that the service supports.

Known values supported by the service

Csv

FunctionName

Defines values for FunctionName.
KnownFunctionName can be used interchangeably with FunctionName, this enum contains the known values that the service supports.

Known values supported by the service

PreTaxCostUSD
Cost
CostUSD
PreTaxCost

FunctionType

Defines values for FunctionType.
KnownFunctionType can be used interchangeably with FunctionType, this enum contains the known values that the service supports.

Known values supported by the service

Sum

GenerateCostDetailsReportCreateOperationResponse

Contains response data for the createOperation operation.

GenerateCostDetailsReportGetOperationResultsResponse

Contains response data for the getOperationResults operation.

GenerateDetailedCostReportCreateOperationResponse

Contains response data for the createOperation operation.

GenerateDetailedCostReportMetricType

Defines values for GenerateDetailedCostReportMetricType.
KnownGenerateDetailedCostReportMetricType can be used interchangeably with GenerateDetailedCostReportMetricType, this enum contains the known values that the service supports.

Known values supported by the service

ActualCost
AmortizedCost

GenerateDetailedCostReportOperationResultsGetResponse

Contains response data for the get operation.

GenerateDetailedCostReportOperationStatusGetResponse

Contains response data for the get operation.

GenerateReservationDetailsReportByBillingAccountIdResponse

Contains response data for the byBillingAccountId operation.

GenerateReservationDetailsReportByBillingProfileIdResponse

Contains response data for the byBillingProfileId operation.

Grain

Defines values for Grain.
KnownGrain can be used interchangeably with Grain, this enum contains the known values that the service supports.

Known values supported by the service

Hourly: Hourly grain corresponds to value per hour.
Daily: Hourly grain corresponds to value per day.
Monthly: Hourly grain corresponds to value per month.

GrainParameter

Defines values for GrainParameter.
KnownGrainParameter can be used interchangeably with GrainParameter, this enum contains the known values that the service supports.

Known values supported by the service

Hourly: Hourly grain corresponds to value per hour.
Daily: Hourly grain corresponds to value per day.
Monthly: Hourly grain corresponds to value per month.

GranularityType

Defines values for GranularityType.
KnownGranularityType can be used interchangeably with GranularityType, this enum contains the known values that the service supports.

Known values supported by the service

Daily

KpiType

Defines values for KpiType.
KnownKpiType can be used interchangeably with KpiType, this enum contains the known values that the service supports.

Known values supported by the service

Forecast
Budget

LookBackPeriod

Defines values for LookBackPeriod.
KnownLookBackPeriod can be used interchangeably with LookBackPeriod, this enum contains the known values that the service supports.

Known values supported by the service

Last7Days: 7 days used to look back.
Last30Days: 30 days used to look back.
Last60Days: 60 days used to look back.

MetricType

Defines values for MetricType.
KnownMetricType can be used interchangeably with MetricType, this enum contains the known values that the service supports.

Known values supported by the service

ActualCost
AmortizedCost
AHUB

OperationStatusType

Defines values for OperationStatusType.
KnownOperationStatusType can be used interchangeably with OperationStatusType, this enum contains the known values that the service supports.

Known values supported by the service

Running
Completed
Failed

OperationsListNextResponse

Contains response data for the listNext operation.

OperationsListResponse

Contains response data for the list operation.

OperatorType

Defines values for OperatorType.
KnownOperatorType can be used interchangeably with OperatorType, this enum contains the known values that the service supports.

Known values supported by the service

In
Contains

Origin

Defines values for Origin.
KnownOrigin can be used interchangeably with Origin, this enum contains the known values that the service supports.

Known values supported by the service

user
system
user,system

PivotType

Defines values for PivotType.
KnownPivotType can be used interchangeably with PivotType, this enum contains the known values that the service supports.

Known values supported by the service

Dimension
TagKey

PriceSheetDownloadByBillingProfileResponse

Contains response data for the downloadByBillingProfile operation.

PriceSheetDownloadResponse

Contains response data for the download operation.

QueryColumnType

Defines values for QueryColumnType.
KnownQueryColumnType can be used interchangeably with QueryColumnType, this enum contains the known values that the service supports.

Known values supported by the service

TagKey: The tag associated with the cost data.
Dimension: The dimension of cost data.

QueryOperatorType

Defines values for QueryOperatorType.
KnownQueryOperatorType can be used interchangeably with QueryOperatorType, this enum contains the known values that the service supports.

Known values supported by the service

In

QueryUsageByExternalCloudProviderTypeResponse

Contains response data for the usageByExternalCloudProviderType operation.

QueryUsageResponse

Contains response data for the usage operation.

RecurrenceType

Defines values for RecurrenceType.
KnownRecurrenceType can be used interchangeably with RecurrenceType, this enum contains the known values that the service supports.

Known values supported by the service

Daily
Weekly
Monthly
Annually

ReportConfigSortingType

Defines values for ReportConfigSortingType.
KnownReportConfigSortingType can be used interchangeably with ReportConfigSortingType, this enum contains the known values that the service supports.

Known values supported by the service

Ascending
Descending

ReportGranularityType

Defines values for ReportGranularityType.
KnownReportGranularityType can be used interchangeably with ReportGranularityType, this enum contains the known values that the service supports.

Known values supported by the service

Daily
Monthly

ReportOperationStatusType

Defines values for ReportOperationStatusType.
KnownReportOperationStatusType can be used interchangeably with ReportOperationStatusType, this enum contains the known values that the service supports.

Known values supported by the service

InProgress
Completed
Failed
Queued
NoDataFound
ReadyToDownload
TimedOut

ReportTimeframeType

Defines values for ReportTimeframeType.
KnownReportTimeframeType can be used interchangeably with ReportTimeframeType, this enum contains the known values that the service supports.

Known values supported by the service

WeekToDate
MonthToDate
YearToDate
Custom

ReportType

Defines values for ReportType.
KnownReportType can be used interchangeably with ReportType, this enum contains the known values that the service supports.

Known values supported by the service

Usage

ReservationReportSchema

Defines values for ReservationReportSchema.
KnownReservationReportSchema can be used interchangeably with ReservationReportSchema, this enum contains the known values that the service supports.

Known values supported by the service

InstanceFlexibilityGroup
InstanceFlexibilityRatio
InstanceId
Kind
ReservationId
ReservationOrderId
ReservedHours
SkuName
TotalReservedQuantity
UsageDate
UsedHours

ScheduleFrequency

Defines values for ScheduleFrequency.
KnownScheduleFrequency can be used interchangeably with ScheduleFrequency, this enum contains the known values that the service supports.

Known values supported by the service

Daily: Cost analysis data will be emailed every day.
Weekly: Cost analysis data will be emailed every week.
Monthly: Cost analysis data will be emailed every month.

ScheduledActionKind

Defines values for ScheduledActionKind.
KnownScheduledActionKind can be used interchangeably with ScheduledActionKind, this enum contains the known values that the service supports.

Known values supported by the service

Email: Cost analysis data will be emailed.
InsightAlert: Cost anomaly information will be emailed. Available only on subscription scope at daily frequency. If no anomaly is detected on the resource, an email won't be sent.

ScheduledActionStatus

Defines values for ScheduledActionStatus.
KnownScheduledActionStatus can be used interchangeably with ScheduledActionStatus, this enum contains the known values that the service supports.

Known values supported by the service

Disabled: Scheduled action is saved but will not be run.
Enabled: Scheduled action is saved and will be run.
Expired: Scheduled action is expired.

ScheduledActionsCheckNameAvailabilityByScopeResponse

Contains response data for the checkNameAvailabilityByScope operation.

ScheduledActionsCheckNameAvailabilityResponse

Contains response data for the checkNameAvailability operation.

ScheduledActionsCreateOrUpdateByScopeResponse

Contains response data for the createOrUpdateByScope operation.

ScheduledActionsCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

ScheduledActionsGetByScopeResponse

Contains response data for the getByScope operation.

ScheduledActionsGetResponse

Contains response data for the get operation.

ScheduledActionsListByScopeNextResponse

Contains response data for the listByScopeNext operation.

ScheduledActionsListByScopeResponse

Contains response data for the listByScope operation.

ScheduledActionsListNextResponse

Contains response data for the listNext operation.

ScheduledActionsListResponse

Contains response data for the list operation.

Scope

Defines values for Scope.
KnownScope can be used interchangeably with Scope, this enum contains the known values that the service supports.

Known values supported by the service

Single: Single scope recommendation.
Shared: Shared scope recommendation.

StatusType

Defines values for StatusType.
KnownStatusType can be used interchangeably with StatusType, this enum contains the known values that the service supports.

Known values supported by the service

Active
Inactive

Term

Defines values for Term.
KnownTerm can be used interchangeably with Term, this enum contains the known values that the service supports.

Known values supported by the service

P1Y: Benefit term is 1 year.
P3Y: Benefit term is 3 years.

TimeframeType

Defines values for TimeframeType.
KnownTimeframeType can be used interchangeably with TimeframeType, this enum contains the known values that the service supports.

Known values supported by the service

MonthToDate
BillingMonthToDate
TheLastMonth
TheLastBillingMonth
WeekToDate
Custom

ViewsCreateOrUpdateByScopeResponse

Contains response data for the createOrUpdateByScope operation.

ViewsCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

ViewsGetByScopeResponse

Contains response data for the getByScope operation.

ViewsGetResponse

Contains response data for the get operation.

ViewsListByScopeNextResponse

Contains response data for the listByScopeNext operation.

ViewsListByScopeResponse

Contains response data for the listByScope operation.

ViewsListNextResponse

Contains response data for the listNext operation.

ViewsListResponse

Contains response data for the list operation.

WeeksOfMonth

Defines values for WeeksOfMonth.
KnownWeeksOfMonth can be used interchangeably with WeeksOfMonth, this enum contains the known values that the service supports.

Known values supported by the service

First
Second
Third
Fourth
Last

Enums

KnownAccumulatedType

Known values of AccumulatedType that the service accepts.

KnownActionType

Known values of ActionType that the service accepts.

KnownAlertCategory

Known values of AlertCategory that the service accepts.

KnownAlertCriteria

Known values of AlertCriteria that the service accepts.

KnownAlertOperator

Known values of AlertOperator that the service accepts.

KnownAlertSource

Known values of AlertSource that the service accepts.

KnownAlertStatus

Known values of AlertStatus that the service accepts.

KnownAlertTimeGrainType

Known values of AlertTimeGrainType that the service accepts.

KnownAlertType

Known values of AlertType that the service accepts.

KnownBenefitKind

Known values of BenefitKind that the service accepts.

KnownChartType

Known values of ChartType that the service accepts.

KnownCheckNameAvailabilityReason

Known values of CheckNameAvailabilityReason that the service accepts.

KnownCostDetailsDataFormat

Known values of CostDetailsDataFormat that the service accepts.

KnownCostDetailsMetricType

Known values of CostDetailsMetricType that the service accepts.

KnownCostDetailsStatusType

Known values of CostDetailsStatusType that the service accepts.

KnownCreatedByType

Known values of CreatedByType that the service accepts.

KnownDaysOfWeek

Known values of DaysOfWeek that the service accepts.

KnownExecutionStatus

Known values of ExecutionStatus that the service accepts.

KnownExecutionType

Known values of ExecutionType that the service accepts.

KnownExportType

Known values of ExportType that the service accepts.

KnownExternalCloudProviderType

Known values of ExternalCloudProviderType that the service accepts.

KnownFileFormat

Known values of FileFormat that the service accepts.

KnownForecastOperatorType

Known values of ForecastOperatorType that the service accepts.

KnownForecastTimeframe

Known values of ForecastTimeframe that the service accepts.

KnownForecastType

Known values of ForecastType that the service accepts.

KnownFormatType

Known values of FormatType that the service accepts.

KnownFunctionName

Known values of FunctionName that the service accepts.

KnownFunctionType

Known values of FunctionType that the service accepts.

KnownGenerateDetailedCostReportMetricType

Known values of GenerateDetailedCostReportMetricType that the service accepts.

KnownGrain

Known values of Grain that the service accepts.

KnownGrainParameter

Known values of GrainParameter that the service accepts.

KnownGranularityType

Known values of GranularityType that the service accepts.

KnownKpiType

Known values of KpiType that the service accepts.

KnownLookBackPeriod

Known values of LookBackPeriod that the service accepts.

KnownMetricType

Known values of MetricType that the service accepts.

KnownOperationStatusType

Known values of OperationStatusType that the service accepts.

KnownOperatorType

Known values of OperatorType that the service accepts.

KnownOrigin

Known values of Origin that the service accepts.

KnownPivotType

Known values of PivotType that the service accepts.

KnownQueryColumnType

Known values of QueryColumnType that the service accepts.

KnownQueryOperatorType

Known values of QueryOperatorType that the service accepts.

KnownRecurrenceType

Known values of RecurrenceType that the service accepts.

KnownReportConfigSortingType

Known values of ReportConfigSortingType that the service accepts.

KnownReportGranularityType

Known values of ReportGranularityType that the service accepts.

KnownReportOperationStatusType

Known values of ReportOperationStatusType that the service accepts.

KnownReportTimeframeType

Known values of ReportTimeframeType that the service accepts.

KnownReportType

Known values of ReportType that the service accepts.

KnownReservationReportSchema

Known values of ReservationReportSchema that the service accepts.

KnownScheduleFrequency

Known values of ScheduleFrequency that the service accepts.

KnownScheduledActionKind

Known values of ScheduledActionKind that the service accepts.

KnownScheduledActionStatus

Known values of ScheduledActionStatus that the service accepts.

KnownScope

Known values of Scope that the service accepts.

KnownStatusType

Known values of StatusType that the service accepts.

KnownTerm

Known values of Term that the service accepts.

KnownTimeframeType

Known values of TimeframeType that the service accepts.

KnownWeeksOfMonth

Known values of WeeksOfMonth that the service accepts.

Functions

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

Function Details

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

function getContinuationToken(page: unknown): string | undefined

Parameters

page

unknown

An object from accessing value on the IteratorResult from a byPage iterator.

Returns

string | undefined

The continuation token that can be passed into byPage() during future calls.