你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

@azure/arm-costmanagement package

接口

Alert

单个警报。

AlertProperties

警报房产。

AlertPropertiesDefinition

定义警报的类型

AlertPropertiesDetails

警报详细信息

AlertsDismissOptionalParams

可选参数。

AlertsGetOptionalParams

可选参数。

AlertsListExternalOptionalParams

可选参数。

AlertsListOptionalParams

可选参数。

AlertsOperations

表示警报操作的界面。

AlertsResult

警报结果。

AllSavingsBenefitDetails

权益建议详细信息。

AllSavingsList

包含建议详细信息的所有权益建议的列表。

ArmErrorResponse

所有 Azure 资源管理器 API 的常见错误响应,以返回失败作的错误详细信息。

AsyncOperationStatusProperties

对象,表示报表 URL 和有效,直到生成的异步报表的日期。

BenefitRecommendationModel

权益计划建议详细信息。

BenefitRecommendationProperties

权益建议的属性。

BenefitRecommendationsListOptionalParams

可选参数。

BenefitRecommendationsOperations

表示 BenefitRecommendations 操作的接口。

BenefitResource

利益资源模型定义。

BenefitUtilizationSummariesListByBillingAccountIdOptionalParams

可选参数。

BenefitUtilizationSummariesListByBillingProfileIdOptionalParams

可选参数。

BenefitUtilizationSummariesListBySavingsPlanIdOptionalParams

可选参数。

BenefitUtilizationSummariesListBySavingsPlanOrderOptionalParams

可选参数。

BenefitUtilizationSummariesOperationStatus

权益利用率摘要报告的状态。 提供异步权益利用率摘要请求输入、状态和报告 sas URL。

BenefitUtilizationSummariesOperations

表示 BenefitUtilizationSummary 操作的接口。

BenefitUtilizationSummariesRequest

异步权益利用率摘要请求的属性。

BenefitUtilizationSummary

福利利用总结资源。

BenefitUtilizationSummaryProperties

福利利用摘要的属性。

BlobInfo

此操作生成的 Blob 信息。

Budget

预算资源。

BudgetComparisonExpression

要用于预算的比较表达式。

BudgetFilter

可用于按用户指定的维度和/或标记筛选预算。

支持 CategoryType:Cost、ReservationUtilization。

BudgetFilterProperties

要按其筛选预算的维度或标记。

支持 CategoryType:Cost、ReservationUtilization。

BudgetProperties

预算的属性。

BudgetTimePeriod

定义预算的有效期间。 预算将在 startDate 或之后评估数据,并将在 endDate 过期。

支持 CategoryType:Cost、ReservationUtilization。

CategoryType(s) 是必需的:Cost、ReservationUtilization。

BudgetsCreateOrUpdateOptionalParams

可选参数。

BudgetsDeleteOptionalParams

可选参数。

BudgetsGetOptionalParams

可选参数。

BudgetsListOptionalParams

可选参数。

BudgetsOperations

代表预算操作的接口。

CheckNameAvailabilityRequest

检查可用性请求正文。

CheckNameAvailabilityResponse

检查可用性结果。

CommonExportProperties

导出的常见属性。

CostAllocationProportion

目标资源和分配

CostAllocationResource

资源用于成本分配的常见数值

CostAllocationRuleCheckNameAvailabilityRequest

成本分配规则检查名称可用性请求

CostAllocationRuleCheckNameAvailabilityResponse

成本分配规则检查名称可用性响应

CostAllocationRuleDefinition

成本分配规则模型定义

CostAllocationRuleDetails

成本分配规则的资源详细信息

CostAllocationRuleProperties

成本分配规则的属性

CostAllocationRulesCheckNameAvailabilityOptionalParams

可选参数。

CostAllocationRulesCreateOrUpdateOptionalParams

可选参数。

CostAllocationRulesDeleteOptionalParams

可选参数。

CostAllocationRulesGetOptionalParams

可选参数。

CostAllocationRulesListOptionalParams

可选参数。

CostAllocationRulesOperations

表示CostAllocationRules操作的接口。

CostDetailsOperationResults

成本详细信息 Api 长时间运行的操作的结果。

CostDetailsTimePeriod

拉取成本详细报表数据的开始日期和结束日期。 API 仅允许提取 1 个月或更少的数据,且不超过 13 个月。

CostManagementClientOptionalParams

客户端的可选参数。

CostManagementOperation

成本管理 REST API 操作。

CostManagementProxyResource

资源模型定义。

CostManagementResource

资源模型定义。

CurrentSpend

正在跟踪预算的当前成本量。

CategoryType(s) 支持:Cost。

Dimension

维度列表。

DimensionProperties

维度属性。

DimensionsListByExternalCloudProviderTypeOptionalParams

可选参数。

DimensionsListOptionalParams

可选参数。

DimensionsOperations

表示维度操作的接口。

DismissAlertPayload

用于更新警报的请求有效负载

DownloadURL

用于下载生成的报表的 URL。

ErrorAdditionalInfo

资源管理错误附加信息。

ErrorDetail

错误详情

ErrorDetails

错误的详细信息。

ErrorDetailsWithNestedDetails

错误的详细信息。

ErrorResponse

错误响应指示服务无法处理传入请求。 错误消息中提供了原因。 \n\n一些错误响应:\n\n * 429 TooManyRequests - 请求被限速。 等待“x-ms-ratelimit-microsoft.consumption-retry-after”标头中指定的时间后重试。 \n\n * 503 服务不可用 - 服务暂时不可用。 在等待“Retry-After”标头中指定的时间后重试。

ErrorResponseWithNestedDetails

错误响应指示服务无法处理传入请求。 错误消息中提供了原因。

一些错误响应:

  • 429 TooManyRequests - 请求受到限制。 等待“x-ms-ratelimit-microsoft.consumption-retry-after”标头中指定的时间后重试。

  • 503 ServiceUnavailable - 服务暂时不可用。 在等待“Retry-After”标头中指定的时间后重试。

Export

导出资源。

ExportDataset

导出中的数据的定义。

ExportDatasetConfiguration

这是弃用的路径,今后将不受支持。

ExportDefinition

导出的定义。

ExportDeliveryDestination

这表示将交付成本的 Blob 存储帐户位置。 有两种方法可以配置目标。 建议大多数客户使用的方法是指定存储帐户的 resourceId。 这需要向 Microsoft.CostManagementExports 资源提供程序注册帐户的订阅,以便向成本管理服务授予对存储的访问权限。 在 Azure 门户中创建导出时,会自动执行此注册,但 API 用户可能需要显式注册订阅(有关详细信息,请参阅 https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-supported-services)。 配置目标的另一种方法仅适用于具有Microsoft合作伙伴协议计划的合作伙伴,他们是其计费帐户的全局管理员。 这些合作伙伴可以指定存储帐户名称以及帐户的 SAS 令牌,而不是指定存储帐户的 resourceId。 这允许将成本导出到任何租户中的存储帐户。 应为具有服务/容器/对象资源类型的 Blob 服务创建 SAS 令牌,并使用读/写/删除/列表/添加/创建权限(有关详细信息,请参阅 https://docs.microsoft.com/en-us/azure/cost-management-billing/costs/export-cost-data-storage-account-sas-key)。

ExportDeliveryInfo

与导出关联的传递信息。

ExportExecutionListResult

列出导出的运行历史记录的结果。

ExportListResult

列出导出的结果。 它包含提供的作用域中可用导出的列表。

ExportProperties

导出的属性。

ExportRecurrencePeriod

定期计划的开始日期和结束日期。

ExportRun

导出运行。

ExportRunProperties

导出运行的属性。

ExportRunRequest

导出运行请求。

ExportSchedule

与导出关联的计划。

ExportSuspensionContext

导出运行的属性。 目前尚未填充。

ExportTimePeriod

导出中的数据的日期范围。 这只能指定时间帧设置为“Custom”。 最大日期范围为 1 个日历月。

ExportsCreateOrUpdateOptionalParams

可选参数。

ExportsDeleteOptionalParams

可选参数。

ExportsExecuteOptionalParams

可选参数。

ExportsGetExecutionHistoryOptionalParams

可选参数。

ExportsGetOptionalParams

可选参数。

ExportsListOptionalParams

可选参数。

ExportsOperations

表示导出操作的接口。

ExtensionResource

基本扩展资源。

FileDestination

视图数据的目标。 这是可选的。 目前仅支持 CSV 格式。

FilterItems

将包含要作的筛选器名称和值。 目前仅支持 ReservationRecommendations 的导出定义类型。

ForecastAggregation

要用于预测的聚合表达式。

ForecastColumn

预测列属性

ForecastComparisonExpression

要用于预测的比较表达式。

ForecastDataset

预测中存在的数据的定义。

ForecastDatasetConfiguration

预测中的数据集配置。

ForecastDefinition

预测的定义。

ForecastExternalCloudProviderUsageOptionalParams

可选参数。

ForecastFilter

要用于导出的筛选器表达式。

ForecastOperations

表示预测操作的接口。

ForecastProperties

预报性质

ForecastResult

预测结果。 它包含分组和聚合下列出的所有列。

ForecastSpend

正在跟踪预算的预测成本。

CategoryType(s) 支持:Cost。

ForecastTimePeriod

具有用于拉取预测数据的时间段。

ForecastUsageOptionalParams

可选参数。

GenerateBenefitUtilizationSummariesReportGenerateByBillingAccountOptionalParams

可选参数。

GenerateBenefitUtilizationSummariesReportGenerateByBillingProfileOptionalParams

可选参数。

GenerateBenefitUtilizationSummariesReportGenerateByReservationIdOptionalParams

可选参数。

GenerateBenefitUtilizationSummariesReportGenerateByReservationOrderIdOptionalParams

可选参数。

GenerateBenefitUtilizationSummariesReportGenerateBySavingsPlanIdOptionalParams

可选参数。

GenerateBenefitUtilizationSummariesReportGenerateBySavingsPlanOrderIdOptionalParams

可选参数。

GenerateBenefitUtilizationSummariesReportOperations

表示生成收益的接口:利用摘要报告操作。

GenerateCostDetailsReportCreateOperationOptionalParams

可选参数。

GenerateCostDetailsReportErrorResponse

错误响应指示服务无法处理传入请求。 错误消息中提供了原因。

一些错误响应:

  • 400 错误的请求 - 无效的请求有效负载。 提供的请求有效负载不采用 json 格式,或者请求有效负载中不接受无效成员。

  • 400 错误请求 - 请求有效负载无效:只能有 timePeriod 或 invoiceId 或 billingPeriod。 API 仅允许为 timePeriod 或 invoiceId 或 billingPeriod 提取数据。 客户应仅提供其中一个参数。

  • 400 错误请求 - 开始日期必须在之后。 API 仅允许从现在起 13 个月内拉取数据。

  • 400 错误请求 - 允许的最大日期范围为 1 个月。 API 仅允许提取 1 个月或更少的数据。

  • 429 TooManyRequests - 请求受到限制。 在等待“retry-after”标头中指定的时间后重试。

  • 503 ServiceUnavailable - 服务暂时不可用。 在等待“Retry-After”标头中指定的时间后重试。

GenerateCostDetailsReportGetOperationResultsOptionalParams

可选参数。

GenerateCostDetailsReportOperations

表示生成成本详情报告操作的接口。

GenerateCostDetailsReportRequestDefinition

成本详细报表的定义。

GenerateDetailedCostReportCreateOperationOptionalParams

可选参数。

GenerateDetailedCostReportDefinition

成本详细报表的定义。

GenerateDetailedCostReportErrorResponse

错误响应指示服务无法处理传入请求。 错误消息中提供了原因。

一些错误响应:

  • 413 请求实体太大 - 请求受到限制。 满足请求所需的数据量超过了允许的最大大小为 2Gb。 请改用导出功能。

  • 429 TooManyRequests - 请求受到限制。 等待“x-ms-ratelimit-microsoft.consumption-retry-after”标头中指定的时间后重试。

  • 503 ServiceUnavailable - 服务暂时不可用。 在等待“Retry-After”标头中指定的时间后重试。

GenerateDetailedCostReportOperationResult

成本详细报告长时间运行操作的结果。

GenerateDetailedCostReportOperationResultsGetOptionalParams

可选参数。

GenerateDetailedCostReportOperationResultsOperations

表示生成详细成本报告操作结果的接口。

GenerateDetailedCostReportOperationStatusGetOptionalParams

可选参数。

GenerateDetailedCostReportOperationStatusOperations

表示生成详细成本报告操作状态操作的接口。

GenerateDetailedCostReportOperationStatuses

成本详细报表的长时间运行操作的状态。

GenerateDetailedCostReportOperations

表示 GenerateDetailedCostReport 操作的接口。

GenerateDetailedCostReportTimePeriod

拉取成本详细报表数据的开始日期和结束日期。

GenerateReservationDetailsReportByBillingAccountIdOptionalParams

可选参数。

GenerateReservationDetailsReportByBillingProfileIdOptionalParams

可选参数。

GenerateReservationDetailsReportOperations

表示生成预留详情报告操作的接口。

IncludedQuantityUtilizationSummary

包含的数量利用率摘要资源。

IncludedQuantityUtilizationSummaryProperties

包含数量利用汇总属性。

KpiProperties

每个 KPI 必须包含“type”和“enabled”密钥。

MCAPriceSheetProperties

价目表的属性。

Notification

与预算关联的通知。

支持 CategoryType:Cost、ReservationUtilization。

NotificationProperties

计划操作通知的属性。

Operation

从资源提供程序作 API 返回的 REST API作的详细信息

OperationDisplay

作的局部显示信息。

OperationStatus

长时间运行的操作的状态。

OperationsListOptionalParams

可选参数。

OperationsOperations

表示作作的接口。

PageSettings

byPage 方法的选项

PagedAsyncIterableIterator

允许异步迭代到完成和逐页迭代的接口。

PivotProperties

每个透视表必须包含一个“type”和“name”。

PriceSheetDownloadByBillingAccountOptionalParams

可选参数。

PriceSheetDownloadByBillingProfileOptionalParams

可选参数。

PriceSheetDownloadByInvoiceOptionalParams

可选参数。

PriceSheetOperations

表示价格表操作的接口。

PricesheetDownloadProperties

用于下载生成的报表的 URL。

ProxyResource

Azure 资源管理器代理资源的资源模型定义。 它不具有标记和位置

QueryAggregation

要用于查询的聚合表达式。

QueryColumn

QueryColumn 属性

QueryComparisonExpression

要用于查询的比较表达式。

QueryDataset

查询中存在的数据的定义。

QueryDatasetConfiguration

查询中数据集的配置。

QueryDefinition

查询的定义。

QueryFilter

要用于导出的筛选器表达式。

QueryGrouping

要用于查询的按表达式分组。

QueryOperations

表示查询操作的接口。

QueryProperties

查询属性

QueryResult

查询结果。 它包含分组和聚合下列出的所有列。

QueryTimePeriod

用于拉取查询数据的开始和结束日期。

QueryUsageByExternalCloudProviderTypeOptionalParams

可选参数。

QueryUsageOptionalParams

可选参数。

RecommendationUsageDetails

用于计算权益建议的 firstConsumptionDate 和 lastConsumptionDate 之间的按需费用。

ReportConfigAggregation

要用于报表的聚合表达式。

ReportConfigComparisonExpression

要用于报表的比较表达式。

ReportConfigDataset

报表中存在的数据的定义。

ReportConfigDatasetConfiguration

报表中数据集的配置。

ReportConfigDefinition

报告配置的定义。

ReportConfigFilter

报表中使用的筛选器表达式。

ReportConfigGrouping

报表中使用的按表达式分组。

ReportConfigSorting

报表中使用的按表达式排序。

ReportConfigTimePeriod

用于拉取报表数据的开始和结束日期。

ReportManifest

行动产生的报告清单。

ReportURL

用于下载生成的报表的 URL。

RequestContext

费用详情请求的背景。

Resource

所有 Azure 资源管理器资源的响应中返回的常见字段

RestorePollerOptions
SavingsPlanUtilizationSummary

节省计划利用率摘要资源。

SavingsPlanUtilizationSummaryProperties

储蓄计划利用率总结房产。

ScheduleProperties

计划的属性。

ScheduledAction

计划的操作定义。

ScheduledActionProperties

计划作的属性。

ScheduledActionsCheckNameAvailabilityByScopeOptionalParams

可选参数。

ScheduledActionsCheckNameAvailabilityOptionalParams

可选参数。

ScheduledActionsCreateOrUpdateByScopeOptionalParams

可选参数。

ScheduledActionsCreateOrUpdateOptionalParams

可选参数。

ScheduledActionsDeleteByScopeOptionalParams

可选参数。

ScheduledActionsDeleteOptionalParams

可选参数。

ScheduledActionsGetByScopeOptionalParams

可选参数。

ScheduledActionsGetOptionalParams

可选参数。

ScheduledActionsListByScopeOptionalParams

可选参数。

ScheduledActionsListOptionalParams

可选参数。

ScheduledActionsOperations

表示 ScheduledActions 操作的接口。

ScheduledActionsRunByScopeOptionalParams

可选参数。

ScheduledActionsRunOptionalParams

可选参数。

Setting

设定定义。

SettingsCreateOrUpdateByScopeOptionalParams

可选参数。

SettingsDeleteByScopeOptionalParams

可选参数。

SettingsGetByScopeOptionalParams

可选参数。

SettingsListOptionalParams

可选参数。

SettingsListResult

设置列表结果。 它包含设置列表。

SettingsOperations

表示设置操作的接口。

SharedScopeBenefitRecommendationProperties

范围为“共享”时权益建议的属性。

SimplePollerLike

可用于轮询长时间运行的操作的简单轮询程序。

SingleScopeBenefitRecommendationProperties

范围为“Single”时权益建议的属性。

SourceCostAllocationResource

用于成本分配的源资源

Status

长时间运行的操作的状态。

SystemAssignedServiceIdentity

托管服务标识(系统分配或无)

SystemData

与创建和上次修改资源相关的元数据。

TagInheritanceProperties

标记继承设置的属性。

TagInheritanceSetting

标记继承设置定义。

TargetCostAllocationResource

以成本分配为目标资源。

View

成本分析的状态和配置。

ViewProperties

视图的属性。

ViewsCreateOrUpdateByScopeOptionalParams

可选参数。

ViewsCreateOrUpdateOptionalParams

可选参数。

ViewsDeleteByScopeOptionalParams

可选参数。

ViewsDeleteOptionalParams

可选参数。

ViewsGetByScopeOptionalParams

可选参数。

ViewsGetOptionalParams

可选参数。

ViewsListByScopeOptionalParams

可选参数。

ViewsListOptionalParams

可选参数。

ViewsOperations

表示视图操作的接口。

类型别名

AccumulatedType

显示一段时间内累积的成本。
KnownAccumulatedType 可以与 StackdType 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

true
false

ActionType

可扩展枚举。 指示操作类型。 “内部”是指仅适用于内部 API 的操作。
KnownActionType 可与 ActionType 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

内部:作适用于仅限内部的 API。

AlertCategory

警报类别
KnownAlertCategory 可以与 AlertCategory 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

Cost
用法
账单
System

AlertCriteria

触发警报的标准
KnownAlertCriteria 可以与 AlertCriteria 互换使用,这个枚举包含服务支持的已知值。

服务支持的已知值

CostThresholdExceeded
使用阈值已超过
信用门槛接近
已达信贷门槛
配额阈值接近
达到配额阈值
多币种
预测成本阈值已超
预测使用阈值已超过
发票到期日临近
发票到期日已达
CrossCloudNewDataAvailable
CrossCloudCollectionError(跨云收集错误)
通用阈值误差

AlertOperator

用于比较当前支出与金额的操作符
KnownAlertOperator 可以与 AlertOperator 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

没有
EqualTo
GreaterThan
比大于或平等
LessThan
LessThanOrEqualTo

AlertSource

警报来源
KnownAlertSource 可以与 AlertSource 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

预设
用户

AlertStatus

警报状态
KnownAlertStatus 可与 AlertStatus 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

没有
Active
重写
已解析
已取消

AlertTimeGrainType

时间粒度节奏类型
KnownAlertTimeGrainType 可以与 AlertTimeGrainType 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

没有
每月
季度
每年
计费月
计费季度
账单年刊

AlertType

警报类型
KnownAlertType 可以与 AlertType 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

预算
发票
信用卡
配额
常规
xCloud
预算预测

AzureSupportedClouds

云设置为字符串文字类型的支持值

BenefitKind

福利的种类和类型。
KnownBenefitKind 可以与 BenefitKind 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

包含数量:利益包含数量。
预留:福利是预留。
储蓄计划:福利是储蓄计划。

BenefitRecommendationPropertiesUnion

福利别名推荐PropertiesUnion

BenefitUtilizationSummaryReportSchema

reportUrl 和 secondaryReportUrl blob 链接中的 CSV 文件由以下权益利用率数据列组成。 UtilizedPercentage 将为 0,用于节省计划报告和非数据砖预留。 数据砖预留的利用率百分比将为 0。
KnownBenefitUtilizationSummaryReportSchema 可与 BenefitUtilizationSummaryReportSchema 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

Kind
平均利用率
利益命令ID
好处
BenefitType(福利类型)
最大利用率
最小利用率百分比
使用日期
利用率

BenefitUtilizationSummaryUnion

福利利用摘要Union的别名

BudgetNotificationOperatorType

比较运算符。

支持 CategoryType:Cost、ReservationUtilization。

CategoryType: Cost 支持的运算符

  • GreaterThan
  • GreaterThanOrEqualTo

CategoryType 支持的运算符:ReservationUtilization

服务支持的已知值

EqualTo:如果评估成本与阈值相同,将触发通知。 注意:不建议使用此 OperatorType,因为成本与阈值完全相同,从而导致警报缺失。 将来将弃用此 OperatorType。

CategoryType(s) 支持:Cost。
大于:如果评估成本大于阈值,将触发通知。 注意:这是配置预算警报时建议的 OperatorType。

CategoryType(s) 支持:Cost。
GreaterThanOrEqualTo:如果评估成本大于或等于阈值,将触发通知。

CategoryType(s) 支持:Cost。
LessThan:如果预订使用警报规则范围内的任何预订利用率低于阈值百分比,将触发通知。

CategoryType(s) 支持:ReservationUtilization。

BudgetOperatorType

用于比较的运算符。
KnownBudgetOperatorType 可以与 BudgetOperatorType 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

CategoryType

预算的类别。

  • “成本”定义预算。
  • “ReservationUtilization”定义预留利用率警报规则。
    KnownCategoryType 可以与 CategoryType 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

成本:一个预算,将 Azure 资源的货币成本与一定金额进行评估,并根据配置的通知阈值发出警报。
预留利用:一个警报规则,用于评估Azure预订的利用率,以及基于配置通知阈值的警报。

ChartType

成本分析中主视图的图表类型。 必填。
KnownChartType 可以与 ChartType 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

Area
线条
堆叠列
GroupedColumn
Table

CheckNameAvailabilityReason

名称不可用的可能原因。
KnownCheckNameAvailabilityReason 可与 CheckNameAvailabilityReason 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

无效:名称无效。
AlreadyExists:名称已存在。

CompressionModeType

允许客户选择压缩数据进行导出。 此设置将在运行时启用目标文件压缩方案。 默认情况下设置为“无”。 Gzip 适用于 csv 和 parquet 的 snappy。
KnownCompressionModeType 可以与 CompressionModeType 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

gzip
snappy

ContinuablePage

描述结果页的接口。

CostAllocationPolicyType

用于分配成本的方法。 FixedProportion 指示将基于指定百分比值拆分成本。
KnownCostAllocationPolicyType 可以与 CostAllocationPolicyType 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

固定比例

CostAllocationResourceType

要用于分配的资源类别。
KnownCostAllocationResourceType 可以与 CostAllocationResourceType 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

维度:表示正在分配中使用Azure维度,如订阅ID或资源组名称。
标签:根据Azure标签的关键值对分配成本。

CostDetailsDataFormat

报告的数据格式
KnownCostDetailsDataFormat 可以与 CostDetailsDataFormat 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

Csv:Csv 数据格式。

CostDetailsMetricType

详细报表的类型。 默认情况下,会提供实际成本
KnownCostDetailsMetricType 可以与 CostDetailsMetricType 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

实际成本:实际成本数据。
摊销成本:摊销成本数据。

CostDetailsStatusType

成本详情操作的状态
KnownCostDetailsStatusType 可与 CostDetailsStatusType 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

完成:操作完成。
未找到数据:操作已完成,且找到无费用数据。
失败:行动失败。

CreatedByType

创建资源的实体类型。
KnownCreatedByType 可与 CreatedByType 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

用户:实体是由用户创建的。
应用程序:实体是由应用程序创建的。
ManagedIdentity:实体是由托管标识创建的。
密钥:实体是由密钥创建的。

CultureCode

接收者接收通知的语言,

支持 CategoryType:Cost、ReservationUtilization。
KnownCultureCode 可以与 CultureCode 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

en-us
ja-jp
zh-cn
de-de
es-es
fr-fr
it-it
ko-kr
pt-br
ru-ru
zh-tw
cs-cz
pl-pl
tr-tr
da-dk
en-gb
hu-hu
nb-no
nl-nl
pt-pt
sv-se

DataOverwriteBehaviorType

允许客户选择覆盖数据(OverwritePreviousReport)进行导出。 此设置将在客户存储帐户中为同一个月启用覆盖数据。 默认情况下设置为 CreateNewReport。
KnownDataOverwriteBehaviorType 可以与 DataOverwriteBehaviorType 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

覆盖上一报告
CreateNewReport

DaysOfWeek

星期几。
KnownDaysOfWeek 可与 DaysOfWeek 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

星期一
星期二
星期三
星期四
星期五
星期六
星期日

DestinationType

导出传递目标类型。 目前仅支持“AzureBlob”。
KnownDestinationType 可与 DestinationType 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

AzureBlob

ExecutionStatus

导出运行的最后一个已知状态。
KnownExecutionStatus 可与 ExecutionStatus 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

已排队
InProgress
Completed
Failed
Timeout
NewDataNotAvailable
数据不可得

ExecutionType

导出运行的类型。
KnownExecutionType 可以与 ExecutionType 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

按需
已安排

ExportType

导出的类型。 请注意,“使用情况”等效于“ActualCost”,适用于尚未提供服务预留费用或摊销数据的导出。
KnownExportType 可以与 ExportType 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

用法
ActualCost
摊销成本
焦点成本
价格表
预订事务
预订推荐
预订详情

ExternalCloudProviderType

ExternalCloudProviderType 类型

FileFormat

视图数据的目标。 目前仅支持 CSV 格式。
KnownFileFormat 可与 FileFormat 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

csv

FilterItemNames

筛选器的名称。 目前仅支持 ReservationRecommendations 的导出定义类型。 支持的名称有 ['ReservationScope', 'LookBackPeriod', 'ResourceType']
KnownFilterItemNames 可以与 FilterItemName 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

预约范围
ResourceType
回顾时期

ForecastOperatorType

用于比较的运算符。
KnownForecastOperatorType 可以与 ForecastOperatorType 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

ForecastTimeframe

为预测拉取数据的时间范围。
KnownForecastTimeframe 可与 ForecastTimeframe 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

自定义

ForecastType

预测的类型。
KnownForecastType 可与 ForecastType 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

用法
ActualCost
摊销成本

FormatType

要传递的导出的格式。
KnownFormatType 可以与 FormatType 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

csv
Parquet

Frequency

通知的频率。 表示在触发阈值违规警报后,通知将保持静默的时间。 如果未指定,则默认根据 timeGrain 设置频率(当 timeGrain: Last7Days 时为每周,当 timeGrain: Last30Days 时为每月)。

CategoryType(s) 支持:ReservationUtilization。
已知频率 可以与频率互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

每日:在阈值突破并触发警报后,直到下一个日历日之前不会再发送新的警报。
每周:门槛突破并触发警报后,7个日历天内不会再发送新的警报。
每月:在阈值突破并触发警报后,30个日历日内不会再发送任何警报。

FunctionName

要聚合的列的名称。
KnownFunctionName 可以与 FunctionName 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

税前CostUSD
Cost
CostUSD
税前成本

FunctionType

要使用的聚合函数的名称。
KnownFunctionType 可以与 FunctionType 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

总和

GenerateDetailedCostReportMetricType

详细报表的类型。 默认情况下,会提供实际成本
KnownGenerateDetailedCostReportMetricType 可与 GenerateDetailedCostReportMetricType 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

ActualCost
摊销成本

Grain

谷物,对应于价值。
已知晶粒 可以与晶粒互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

按小时:每小时的粮食价值对应每小时的价值。
日:每小时谷物对应每日价值。
月计:每小时粮食对应每月价值。

GrainParameter

颗粒参数类型

GranularityType

导出中的行粒度。 目前,大多数情况下支持“每日”。
KnownGranularityType 可以与 GranularityType 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

每天
每月

KpiType

KPI 类型(预测、预算)。
KnownKpiType 可以与 KpiType 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

预测
预算

LookBackPeriod

过去回头看的天数。
KnownLookBackPeriod 可以与 LookBackPeriod 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

过去7天:7天过去是回头。
过去30天:过去30天用来回顾过去。
Last60Days:过去60天用来回顾过去。

MetricType

显示成本时使用的度量。
KnownMetricType 可与 MetricType 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

ActualCost
摊销成本
AHUB

OperationStatusType

枚举表示异步作的状态。
KnownOperationStatusType 可以与 OperationStatusType 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

正在运行
Completed
Failed

OperatorType

用于比较的运算符。
KnownOperatorType 可以与 OperatorType 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值


Contains

Origin

操作的预期执行者;例如在基于资源的访问控制(RBAC)和审核日志的用户体验中。 默认值为“user,system”
KnownOrigin 可与 Origin 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

user:指示作由用户发起。
system:指示作由系统启动。
user,system:指示作由用户或系统启动。

PivotType

要在视图中显示的数据类型。
KnownPivotType 可以与 PivotType 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

维 度
标签键

QueryColumnType

报告中专栏的类型。
KnownQueryColumnType 可以与 QueryColumnType 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

TagKey:与成本数据相关的标签。
维度:成本数据的维度。

QueryOperatorType

用于比较的运算符。
KnownQueryOperatorType 可以与 QueryOperatorType 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

Reason

此名称不可用的原因。
KnownReason 可以与 Reason 互换使用,这个枚举包含服务支持的已知值。

服务支持的已知值

无效的
已经存在
有效

RecurrenceType

计划重复周期。
KnownRecurrenceType 可以与 RecurrenceType 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

每天
周刊
每月
每年

ReportConfigSortingType

排序方向。
KnownReportConfigSortingType 可以与 ReportConfigSortingType 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

上升

ReportGranularityType

报表中行的粒度。
KnownReportGranularityType 可以与 ReportGranularityType 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

每天
每月

ReportOperationStatusType

长时间运行的操作的状态。
KnownReportOperationStatusType 可以与 ReportOperationStatusType 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

InProgress
Completed
Failed
已排队
未发现数据
准备下载
TimedOut

ReportTimeframeType

为报表拉取数据的时间范围。 如果为自定义,则必须提供特定的时间段。
KnownReportTimeframeType 可以与 ReportTimeFrameType 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

本周至日
本月至今
截至今年
自定义

ReportType

报表的类型。 Usage 表示实际使用情况,forecast 表示预测数据,UsageAndForecast 表示使用情况和预测数据。 可以根据日期区分实际使用情况和预测数据。
KnownReportType 可以与 ReportType 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

用法

ReservationReportSchema

reportUrl blob链接中的CSV文件包含预订使用数据,按每日粒度为以下模式
KnownReservationReportSchema 可以与 ReservationReportSchema 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

实例灵活性集团
实例灵活性比
InstanceId
Kind
ReservationId (预订编号)
ReservationOrderId
预约时间
SkuName (英文)
总储蓄数量
使用日期
使用小时数

RuleStatus

规则的当前状态。
KnownRuleStatus 可与 RuleStatus 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

非活跃:规则被保存,但不用于分配成本。
激活:规则被保存并影响成本分配。
处理:规则被保存,成本分配正在更新。 无法在 put 请求中提交的只读值。

ScheduleFrequency

计划的频率。
KnownScheduleFrequency 可以与 ScheduleFrequency 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

每日:成本分析数据将每天通过电子邮件发送。
每周:成本分析数据将每周通过电子邮件发送。
每月:成本分析数据将每月通过电子邮件发送。

ScheduledActionKind

Kind of the scheduled action(计划作的种类)。
KnownScheduledActionKind 可以与 ScheduledActionKind 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

电子邮件:成本分析数据将通过电子邮件发送。
InsightAlert:费用异常信息将通过电子邮件发送。 仅在每日频率的订阅范围内可用。 如果未在资源上检测到异常,则不会发送电子邮件。

ScheduledActionStatus

计划作的状态。
KnownScheduledActionStatus 可以与 ScheduledActionStatus 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

启用:计划操作已保存并执行。
已过期:计划中的行动已过期。
禁用:计划操作被保存,但不会执行。

Scope

大致上是推荐范围。
KnownScope 可以与 Scope 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

单镜:单镜推荐。
分享:共享范围推荐。

SettingType

环境类型

SettingUnion

SettingUnion 的别名

SettingsKind

指定设置的类型。
KnownSettingsKind 可以与 SettingsKind 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

标签继承

StatusType

导出计划的状态。 如果为“非活动”,则导出的计划将暂停。 若要启用导出,请将状态设置为“活动”,然后发出 PUT 请求。
KnownStatusType 可以与 StatusType 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

Active
非活动

SystemAssignedServiceIdentityType

托管服务标识的类型(系统分配或无)。
KnownSystemAssignedServiceIdentityType 可与 SystemAssignedServiceIdentityType 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

:无托管系统标识。
SystemAssigned:系统分配的托管系统标识。

Term

谷物,对应于价值。
KnownTerm 可以与 Term 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

P1Y:福利期限为1年。
P3Y:福利期限为3年。

ThresholdType

阈值的类型。

CategoryType(s) 支持:Cost。
KnownThresholdType 可以与 ThresholdType 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

实际成本:实际成本预算提醒会在实际应计成本超过分配预算时通知。
预测:预测成本预算提醒会提前通知您的支出趋势可能超出预算,因为它依赖于预测成本预测。

TimeGrainType

预算涵盖的时间。 将根据时间粒度重置对金额的跟踪。

支持 CategoryType:Cost、ReservationUtilization。

CategoryType: Cost 支持的 timeGrainTypes

  • 每月
  • 每季度一次
  • 每年
  • BillingMonth*
  • BillingQuarter*
  • BillingAnnual*

*仅支持 Web Direct 客户。

CategoryType 支持的 timeGrainTypes:ReservationUtilization

  • Last7Days
  • Last30Days

CategoryType(s) 是必需的:Cost、ReservationUtilization。
KnownTimeGrainType 可以与 TimeGrainType 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

月度:预算将当日历月的成本与金额进行跟踪。

CategoryType 支持:仅成本。
季度预算:预算将跟踪当季度的费用与金额。

CategoryType 支持:仅成本。
年度:预算将将当日历年的成本与金额进行跟踪。

CategoryType 支持:仅成本。
计费月:预算将跟踪当前计费月的成本与金额。

CategoryType 支持:仅限成本和 Web Direct 客户。
计费季度:预算将跟踪当前计费季度的成本与金额。

CategoryType 支持:仅限成本和 Web Direct 客户。
BillingAnnual:预算将当年度计费与金额进行跟踪。

CategoryType 支持:仅限成本和 Web Direct 客户。
Last7Days:预订使用提醒规则将根据预订的7天使用率进行评估。

对 CategoryType 支持:仅 ReservationUtilization。
Last30Days:预订使用提醒规则将根据预订的30天使用率进行评估。

对 CategoryType 支持:仅 ReservationUtilization。

TimeframeType

为导出拉取数据的时间范围。 如果为自定义,则必须提供特定的时间段。
KnownTimeframeType 可以与 TimeframeType 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

本月至今
账目月至今
最后一个月
最后一个计费月份
本周至日
自定义
本月

WeeksOfMonth

月数周。
已知的WeeksOfMonth 可以与WeeksOfMonth互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

首先
第二
第三
第四
最后

枚举

AzureClouds

用于描述 Azure 云环境的枚举。

KnownAccumulatedType

显示一段时间内累积的成本。

KnownActionType

可扩展枚举。 指示操作类型。 “内部”是指仅适用于内部 API 的操作。

KnownAlertCategory

警报类别

KnownAlertCriteria

触发警报的条件

KnownAlertOperator

用于将 currentSpend 与 amount 进行比较的运算符

KnownAlertSource

警报源

KnownAlertStatus

警报状态

KnownAlertTimeGrainType

时间根节奏的类型

KnownAlertType

警报类型

KnownBenefitKind

福利的种类和类型。

KnownBenefitUtilizationSummaryReportSchema

reportUrl 和 secondaryReportUrl blob 链接中的 CSV 文件由以下权益利用率数据列组成。 UtilizedPercentage 将为 0,用于节省计划报告和非数据砖预留。 数据砖预留的利用率百分比将为 0。

KnownBudgetNotificationOperatorType

比较运算符。

支持 CategoryType:Cost、ReservationUtilization。

CategoryType: Cost 支持的运算符

  • GreaterThan
  • GreaterThanOrEqualTo

CategoryType 支持的运算符:ReservationUtilization

  • LessThan
KnownBudgetOperatorType

用于比较的运算符。

KnownCategoryType

预算的类别。

  • “成本”定义预算。
  • “ReservationUtilization”定义预留利用率警报规则。
KnownChartType

成本分析中主视图的图表类型。 必填。

KnownCheckNameAvailabilityReason

名称不可用的可能原因。

KnownCompressionModeType

允许客户选择压缩数据进行导出。 此设置将在运行时启用目标文件压缩方案。 默认情况下设置为“无”。 Gzip 适用于 csv 和 parquet 的 snappy。

KnownCostAllocationPolicyType

用于分配成本的方法。 FixedProportion 指示将基于指定百分比值拆分成本。

KnownCostAllocationResourceType

要用于分配的资源类别。

KnownCostDetailsDataFormat

报表的数据格式

KnownCostDetailsMetricType

详细报表的类型。 默认情况下提供 ActualCost

KnownCostDetailsStatusType

成本详细信息操作的状态

KnownCreatedByType

创建资源的实体类型。

KnownCultureCode

接收者接收通知的语言,

支持 CategoryType:Cost、ReservationUtilization。

KnownDataOverwriteBehaviorType

允许客户选择覆盖数据(OverwritePreviousReport)进行导出。 此设置将在客户存储帐户中为同一个月启用覆盖数据。 默认情况下设置为 CreateNewReport。

KnownDaysOfWeek

星期几。

KnownDestinationType

导出传递目标类型。 目前仅支持“AzureBlob”。

KnownExecutionStatus

导出运行的最后一个已知状态。

KnownExecutionType

导出运行的类型。

KnownExportType

导出的类型。 请注意,“使用情况”等效于“ActualCost”,适用于尚未提供服务预留费用或摊销数据的导出。

KnownExternalCloudProviderType

服务接受的 已知ExternalCloudProviderType 值。

KnownFileFormat

视图数据的目标。 目前仅支持 CSV 格式。

KnownFilterItemNames

筛选器的名称。 目前仅支持 ReservationRecommendations 的导出定义类型。 支持的名称为 ['ReservationScope', 'LookBackPeriod', 'ResourceType']

KnownForecastOperatorType

用于比较的运算符。

KnownForecastTimeframe

为预测拉取数据的时间范围。

KnownForecastType

预测的类型。

KnownFormatType

要传递的导出的格式。

KnownFrequency

通知的频率。 表示在触发阈值违规警报后,通知将保持静默的时间。 如果未指定,则默认根据 timeGrain 设置频率(当 timeGrain: Last7Days 时为每周,当 timeGrain: Last30Days 时为每月)。

CategoryType(s) 支持:ReservationUtilization。

KnownFunctionName

要聚合的列的名称。

KnownFunctionType

要使用的聚合函数的名称。

KnownGenerateDetailedCostReportMetricType

详细报表的类型。 默认情况下提供 ActualCost

KnownGrain

谷物,对应于价值。

KnownGrainParameter

服务接受的 已知 GrainParameter 值。

KnownGranularityType

导出中的行粒度。 目前,大多数情况下支持“每日”。

KnownKpiType

KPI 类型(预测、预算)。

KnownLookBackPeriod

过去回头看的天数。

KnownMetricType

显示成本时使用的度量。

KnownOperationStatusType

枚举表示异步作的状态。

KnownOperatorType

用于比较的运算符。

KnownOrigin

操作的预期执行者;例如在基于资源的访问控制(RBAC)和审核日志的用户体验中。 默认值为“user,system”

KnownPivotType

要在视图中显示的数据类型。

KnownQueryColumnType

报告中专栏的类型。

KnownQueryOperatorType

用于比较的运算符。

KnownReason

此名称不可用的原因。

KnownRecurrenceType

计划重复周期。

KnownReportConfigSortingType

排序方向。

KnownReportGranularityType

报表中行的粒度。

KnownReportOperationStatusType

长时间运行的操作的状态。

KnownReportTimeframeType

为报表拉取数据的时间范围。 如果为自定义,则必须提供特定的时间段。

KnownReportType

报表的类型。 Usage 表示实际使用情况,forecast 表示预测数据,UsageAndForecast 表示使用情况和预测数据。 可以根据日期区分实际使用情况和预测数据。

KnownReservationReportSchema

reportUrl blob链接中的CSV文件包含预订使用数据,按每日粒度为以下模式

KnownRuleStatus

规则的当前状态。

KnownScheduleFrequency

计划的频率。

KnownScheduledActionKind

Kind of the scheduled action(计划作的种类)。

KnownScheduledActionStatus

计划作的状态。

KnownScope

大致上是推荐范围。

KnownSettingType

服务接受的已知 SettingType 值。

KnownSettingsKind

指定设置的类型。

KnownStatusType

导出计划的状态。 如果为“非活动”,则导出的计划将暂停。 若要启用导出,请将状态设置为“活动”,然后发出 PUT 请求。

KnownSystemAssignedServiceIdentityType

托管服务标识的类型(系统分配或无)。

KnownTerm

谷物,对应于价值。

KnownThresholdType

阈值的类型。

CategoryType(s) 支持:Cost。

KnownTimeGrainType

预算涵盖的时间。 将根据时间粒度重置对金额的跟踪。

支持 CategoryType:Cost、ReservationUtilization。

CategoryType: Cost 支持的 timeGrainTypes

  • 每月
  • 每季度一次
  • 每年
  • BillingMonth*
  • BillingQuarter*
  • BillingAnnual*

*仅支持 Web Direct 客户。

CategoryType 支持的 timeGrainTypes:ReservationUtilization

  • Last7Days
  • Last30Days

CategoryType(s) 是必需的:Cost、ReservationUtilization。

KnownTimeframeType

为导出拉取数据的时间范围。 如果为自定义,则必须提供特定的时间段。

KnownVersions

可用的 API 版本。

KnownWeeksOfMonth

月数周。

函数

isRestError(unknown)

RestError 的 Typeguard

restorePoller<TResponse, TResult>(CostManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

从另一轮询程序的序列化状态创建轮询器。 如果要在不同的主机上创建轮询器,或者在原始轮询器不在范围内后构造轮询器,这非常有用。

变量

RestError

失败管道请求的自定义错误类型。

函数详细信息

isRestError(unknown)

RestError 的 Typeguard

function isRestError(e: unknown): e

参数

e

unknown

catch 子句捕获的内容。

返回

e

restorePoller<TResponse, TResult>(CostManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

从另一轮询程序的序列化状态创建轮询器。 如果要在不同的主机上创建轮询器,或者在原始轮询器不在范围内后构造轮询器,这非常有用。

function restorePoller<TResponse, TResult>(client: CostManagementClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

参数

serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

返回

PollerLike<OperationState<TResult>, TResult>

变量详细信息

RestError

失败管道请求的自定义错误类型。

RestError: RestErrorConstructor

类型