@azure/arm-costmanagement package
接口
类型别名
| AccumulatedType |
显示一段时间内累积的成本。 服务支持的已知值
true |
| ActionType |
可扩展枚举。 指示操作类型。 “内部”是指仅适用于内部 API 的操作。 服务支持的已知值内部:作适用于仅限内部的 API。 |
| AlertCategory |
警报类别 服务支持的已知值
Cost |
| AlertCriteria |
触发警报的标准 服务支持的已知值
CostThresholdExceeded |
| AlertOperator |
用于比较当前支出与金额的操作符 服务支持的已知值
没有 |
| AlertSource |
警报来源 服务支持的已知值
预设 |
| AlertStatus |
警报状态 服务支持的已知值
没有 |
| AlertTimeGrainType |
时间粒度节奏类型 服务支持的已知值
没有 |
| AlertType |
警报类型 服务支持的已知值
预算 |
| AzureSupportedClouds |
云设置为字符串文字类型的支持值 |
| BenefitKind |
福利的种类和类型。 服务支持的已知值
包含数量:利益包含数量。 |
| BenefitRecommendationPropertiesUnion |
福利别名推荐PropertiesUnion |
| BenefitUtilizationSummaryReportSchema |
reportUrl 和 secondaryReportUrl blob 链接中的 CSV 文件由以下权益利用率数据列组成。 UtilizedPercentage 将为 0,用于节省计划报告和非数据砖预留。 数据砖预留的利用率百分比将为 0。 服务支持的已知值
Kind |
| BenefitUtilizationSummaryUnion |
福利利用摘要Union的别名 |
| BudgetNotificationOperatorType |
比较运算符。 支持 CategoryType:Cost、ReservationUtilization。 CategoryType: Cost 支持的运算符
CategoryType 支持的运算符:ReservationUtilization
服务支持的已知值EqualTo:如果评估成本与阈值相同,将触发通知。 注意:不建议使用此 OperatorType,因为成本与阈值完全相同,从而导致警报缺失。 将来将弃用此 OperatorType。 CategoryType(s) 支持:Cost。 CategoryType(s) 支持:Cost。 CategoryType(s) 支持:Cost。 CategoryType(s) 支持:ReservationUtilization。 |
| BudgetOperatorType |
用于比较的运算符。 服务支持的已知值在 |
| CategoryType |
预算的类别。
服务支持的已知值
成本:一个预算,将 Azure 资源的货币成本与一定金额进行评估,并根据配置的通知阈值发出警报。 |
| ChartType |
成本分析中主视图的图表类型。 必填。 服务支持的已知值
Area |
| CheckNameAvailabilityReason |
名称不可用的可能原因。 服务支持的已知值
无效:名称无效。 |
| CompressionModeType |
允许客户选择压缩数据进行导出。 此设置将在运行时启用目标文件压缩方案。 默认情况下设置为“无”。 Gzip 适用于 csv 和 parquet 的 snappy。 服务支持的已知值
gzip |
| ContinuablePage |
描述结果页的接口。 |
| CostAllocationPolicyType |
用于分配成本的方法。 FixedProportion 指示将基于指定百分比值拆分成本。 服务支持的已知值固定比例 |
| CostAllocationResourceType |
要用于分配的资源类别。 服务支持的已知值
维度:表示正在分配中使用Azure维度,如订阅ID或资源组名称。 |
| CostDetailsDataFormat |
报告的数据格式 服务支持的已知值Csv:Csv 数据格式。 |
| CostDetailsMetricType |
详细报表的类型。 默认情况下,会提供实际成本 服务支持的已知值
实际成本:实际成本数据。 |
| CostDetailsStatusType |
成本详情操作的状态 服务支持的已知值
完成:操作完成。 |
| CreatedByType |
创建资源的实体类型。 服务支持的已知值
用户:实体是由用户创建的。 |
| CultureCode |
接收者接收通知的语言, 支持 CategoryType:Cost、ReservationUtilization。 服务支持的已知值
en-us |
| DataOverwriteBehaviorType |
允许客户选择覆盖数据(OverwritePreviousReport)进行导出。 此设置将在客户存储帐户中为同一个月启用覆盖数据。 默认情况下设置为 CreateNewReport。 服务支持的已知值
覆盖上一报告 |
| DaysOfWeek |
星期几。 服务支持的已知值
星期一 |
| DestinationType |
导出传递目标类型。 目前仅支持“AzureBlob”。 服务支持的已知值AzureBlob |
| ExecutionStatus |
导出运行的最后一个已知状态。 服务支持的已知值已排队 |
| ExecutionType |
导出运行的类型。 服务支持的已知值
按需 |
| ExportType |
导出的类型。 请注意,“使用情况”等效于“ActualCost”,适用于尚未提供服务预留费用或摊销数据的导出。 服务支持的已知值
用法 |
| ExternalCloudProviderType |
ExternalCloudProviderType 类型 |
| FileFormat |
视图数据的目标。 目前仅支持 CSV 格式。 服务支持的已知值csv |
| FilterItemNames |
筛选器的名称。 目前仅支持 ReservationRecommendations 的导出定义类型。 支持的名称有 ['ReservationScope', 'LookBackPeriod', 'ResourceType'] 服务支持的已知值
预约范围 |
| ForecastOperatorType |
用于比较的运算符。 服务支持的已知值在 |
| ForecastTimeframe |
为预测拉取数据的时间范围。 服务支持的已知值自定义 |
| ForecastType |
预测的类型。 服务支持的已知值
用法 |
| FormatType |
要传递的导出的格式。 服务支持的已知值
csv |
| Frequency |
通知的频率。 表示在触发阈值违规警报后,通知将保持静默的时间。 如果未指定,则默认根据 timeGrain 设置频率(当 timeGrain: Last7Days 时为每周,当 timeGrain: Last30Days 时为每月)。 CategoryType(s) 支持:ReservationUtilization。 服务支持的已知值
每日:在阈值突破并触发警报后,直到下一个日历日之前不会再发送新的警报。 |
| FunctionName |
要聚合的列的名称。 服务支持的已知值
税前CostUSD |
| FunctionType |
要使用的聚合函数的名称。 服务支持的已知值总和 |
| GenerateDetailedCostReportMetricType |
详细报表的类型。 默认情况下,会提供实际成本 服务支持的已知值
ActualCost |
| Grain |
谷物,对应于价值。 服务支持的已知值
按小时:每小时的粮食价值对应每小时的价值。 |
| GrainParameter |
颗粒参数类型 |
| GranularityType |
导出中的行粒度。 目前,大多数情况下支持“每日”。 服务支持的已知值
每天 |
| KpiType |
KPI 类型(预测、预算)。 服务支持的已知值
预测 |
| LookBackPeriod |
过去回头看的天数。 服务支持的已知值
过去7天:7天过去是回头。 |
| MetricType |
显示成本时使用的度量。 服务支持的已知值
ActualCost |
| OperationStatusType |
枚举表示异步作的状态。 服务支持的已知值
正在运行 |
| OperatorType |
用于比较的运算符。 服务支持的已知值
在 |
| Origin |
操作的预期执行者;例如在基于资源的访问控制(RBAC)和审核日志的用户体验中。 默认值为“user,system” 服务支持的已知值
user:指示作由用户发起。 |
| PivotType |
要在视图中显示的数据类型。 服务支持的已知值
维 度 |
| QueryColumnType |
报告中专栏的类型。 服务支持的已知值
TagKey:与成本数据相关的标签。 |
| QueryOperatorType |
用于比较的运算符。 服务支持的已知值在 |
| Reason |
此名称不可用的原因。 服务支持的已知值
无效的 |
| RecurrenceType |
计划重复周期。 服务支持的已知值
每天 |
| ReportConfigSortingType |
排序方向。 服务支持的已知值
上升 |
| ReportGranularityType |
报表中行的粒度。 服务支持的已知值
每天 |
| ReportOperationStatusType |
长时间运行的操作的状态。 服务支持的已知值
InProgress |
| ReportTimeframeType |
为报表拉取数据的时间范围。 如果为自定义,则必须提供特定的时间段。 服务支持的已知值
本周至日 |
| ReportType |
报表的类型。 Usage 表示实际使用情况,forecast 表示预测数据,UsageAndForecast 表示使用情况和预测数据。 可以根据日期区分实际使用情况和预测数据。 服务支持的已知值用法 |
| ReservationReportSchema |
reportUrl blob链接中的CSV文件包含预订使用数据,按每日粒度为以下模式 服务支持的已知值
实例灵活性集团 |
| RuleStatus |
规则的当前状态。 服务支持的已知值
非活跃:规则被保存,但不用于分配成本。 |
| ScheduleFrequency |
计划的频率。 服务支持的已知值
每日:成本分析数据将每天通过电子邮件发送。 |
| ScheduledActionKind |
Kind of the scheduled action(计划作的种类)。 服务支持的已知值
电子邮件:成本分析数据将通过电子邮件发送。 |
| ScheduledActionStatus |
计划作的状态。 服务支持的已知值
启用:计划操作已保存并执行。 |
| Scope |
大致上是推荐范围。 服务支持的已知值
单镜:单镜推荐。 |
| SettingType |
环境类型 |
| SettingUnion |
SettingUnion 的别名 |
| SettingsKind |
指定设置的类型。 服务支持的已知值标签继承 |
| StatusType |
导出计划的状态。 如果为“非活动”,则导出的计划将暂停。 若要启用导出,请将状态设置为“活动”,然后发出 PUT 请求。 服务支持的已知值
Active |
| SystemAssignedServiceIdentityType |
托管服务标识的类型(系统分配或无)。 服务支持的已知值
无:无托管系统标识。 |
| Term |
谷物,对应于价值。 服务支持的已知值
P1Y:福利期限为1年。 |
| ThresholdType |
阈值的类型。 CategoryType(s) 支持:Cost。 服务支持的已知值
实际成本:实际成本预算提醒会在实际应计成本超过分配预算时通知。 |
| TimeGrainType |
预算涵盖的时间。 将根据时间粒度重置对金额的跟踪。 支持 CategoryType:Cost、ReservationUtilization。 CategoryType: Cost 支持的 timeGrainTypes
*仅支持 Web Direct 客户。 CategoryType 支持的 timeGrainTypes:ReservationUtilization
CategoryType(s) 是必需的:Cost、ReservationUtilization。 服务支持的已知值月度:预算将当日历月的成本与金额进行跟踪。 CategoryType 支持:仅成本。 CategoryType 支持:仅成本。 CategoryType 支持:仅成本。 CategoryType 支持:仅限成本和 Web Direct 客户。 CategoryType 支持:仅限成本和 Web Direct 客户。 CategoryType 支持:仅限成本和 Web Direct 客户。 对 CategoryType 支持:仅 ReservationUtilization。 对 CategoryType 支持:仅 ReservationUtilization。 |
| TimeframeType |
为导出拉取数据的时间范围。 如果为自定义,则必须提供特定的时间段。 服务支持的已知值
本月至今 |
| 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 支持的运算符
CategoryType 支持的运算符:ReservationUtilization
|
| KnownBudgetOperatorType |
用于比较的运算符。 |
| KnownCategoryType |
预算的类别。
|
| 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
*仅支持 Web Direct 客户。 CategoryType 支持的 timeGrainTypes:ReservationUtilization
CategoryType(s) 是必需的:Cost、ReservationUtilization。 |
| KnownTimeframeType |
为导出拉取数据的时间范围。 如果为自定义,则必须提供特定的时间段。 |
| KnownVersions |
可用的 API 版本。 |
| KnownWeeksOfMonth |
月数周。 |
函数
| is |
RestError 的 Typeguard |
| restore |
从另一轮询程序的序列化状态创建轮询器。 如果要在不同的主机上创建轮询器,或者在原始轮询器不在范围内后构造轮询器,这非常有用。 |
变量
| Rest |
失败管道请求的自定义错误类型。 |
函数详细信息
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>
参数
- client
- CostManagementClient
- serializedState
-
string
- sourceOperation
-
(args: any[]) => PollerLike<OperationState<TResult>, TResult>
- options
-
RestorePollerOptions<TResult, PathUncheckedResponse>
返回
PollerLike<OperationState<TResult>, TResult>