@azure/arm-carbonoptimization package

对于不同的查询报告的基本响应，所有查询报告结果都会有这些信息

有关碳排放数据可用日期范围的响应

碳排放结果列表

详细碳排放响应

每月碳排放摘要的响应

总体碳排放摘要响应

按月对顶级项目碳排放的响应

按类别类型对热门项的响应

客户端的可选参数。

表示 CarbonService作的接口。

可选参数。

可选参数。

要与 QueryParameter 一起使用的日期范围，应在开始日期和结束日期之间的 12 个月内。 在某些情况下，开始日期和结束日期必须相同。

资源管理错误附加信息。

错误详细信息。

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

ItemDetailsReport 的查询参数

用于配置 MonthlySummaryReport 查询的查询筛选器参数。

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

本地化的显示信息和操作。

可选参数。

表示操作操作的接口。

用于配置 OverallSummaryReport 查询的查询筛选器参数。

byPage 方法的选项

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

共享查询筛选条件参数，用于为 ReportTypeEnum 中定义的所有不同报表类型配置碳排放数据查询。

资源详细碳排放响应

按月对资源碳排放量排名靠前的响应

资源类别的顶级项的响应

资源组的详细碳排放响应

资源组按月对顶级项目碳排放的响应

ResourceGroup 的顶级项的响应

每个订阅的访问决策

用于配置 TopItemsMonthlySummaryReport 查询的查询筛选器参数。

用于配置 TopItemsSummaryReport 查询的查询筛选器参数。

用于访问决策的枚举
KnownAccessDecisionEnum 可以与 AccessDecisionEnum 互换使用，此枚举包含服务支持的已知值。

服务支持的已知值

允许：允许访问
Denied：访问被拒绝

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

服务支持的已知值

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

CarbonEmissionDataUnion 的别名

要与 QueryParameter 一起使用的受支持类别类型。 每种类型表示不同级别的排放数据聚合。
KnownCategoryTypeEnum 可以与 CategoryTypeEnum 互换使用，此枚举包含服务支持的已知值。

服务支持的已知值

订阅：在订阅级别汇总的排放量。
资源组：在资源组级别聚合的排放量。
位置：在位置级别汇总的排放量。
资源：在资源层面汇总的排放量。
ResourceType：在资源类型级别聚合的排放量。

描述结果页的接口。

支持用于 QueryParameter 的碳排放范围，如 GHG 协议所定义。 必须至少指定一个作用域。 输出将返回所有指定范围的总数。
KnownEmissionScopeEnum 可以与 EmissionScopeEnum 互换使用，此枚举包含服务支持的已知值。

服务支持的已知值

范围1：范围1碳排放
范围二：范围二碳排放
Scope3：Scope3碳排放

ItemDetailsReport 中的列支持排序。 此对象包括允许排序的列名。 选择以下支持的值之一
KnownOrderByColumnEnum 可以与 OrderByColumnEnum 互换使用，此枚举包含服务支持的已知值。

服务支持的已知值

ItemName：ItemDetailsReport 结果中归档的 itemName，更多信息请参见 CarbonEmissionItemDetailData。
LatestMonthEmissions：ItemDetailsReport 结果中归档的 latestMonthEmissions，更多信息请参见 CarbonEmissionItemDetailData。
PreviousMonthEmissions：ItemDetailsReport 结果中归档的 previousMonthEmissions，更多信息请参见 CarbonEmissionItemDetailData。
MonthOverMonthEmissionsChangeRatio：ItemDetailsReport 结果中归档的 monthOverMonthEmissionsChangeRatio，更多信息请参见 CarbonEmissionItemDetailData。
MonthlyEmissionsChangeValue：ItemDetailsReport 结果中归档的 monthlyEmissionsChangeValue，更多信息请参见 CarbonEmissionItemDetailData。
ResourceGroup：ResourceCarbonEmissionItemDetailData 结果中归档的 resourceGroup，更多信息请参见 ResourceCarbonEmissionItemDetailData。

操作的预期执行程序;与基于资源的访问控制 （RBAC） 和审核日志 UX 中一样。 默认值为“user，system”
KnownOrigin 可以与 Origin 互换使用，此枚举包含服务支持的已知值。

服务支持的已知值

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

QueryFilterUnion 的别名

报告类型的枚举，为碳排放数据指定不同的报告格式。 每个报告类型返回不同类别、日期范围、排放范围和其他参数的碳排放聚合。
KnownReportTypeEnum 可以与 ReportTypeEnum 互换使用，此枚举包含服务支持的已知值。

服务支持的已知值

OverallSummaryReport：总体摘要报告提供指定日期范围和查询参数的总碳排放量，以及用于高级概述的比较值。 此报表类型可以接受 DateRange 中的开始和结束字段中的不同值（例如，start： 2024-03-01 和 end： 2024-06-01）。
MonthlySummaryReport：MonthlySummaryReport 为指定的查询参数提供按月的碳排放数据。 此报表类型可以接受 DateRange 中的开始和结束字段中的不同值（例如，start： 2024-03-01 和 end： 2024-06-01）。
TopItemsSummaryReport：TopItemsSummaryReport 为指定的查询筛选条件提供 N 个发射量最高的项目。 此报表一次返回单个月的数据，因此它需要 DateRange 中开始和结束字段的相同值。 一次最多可以返回 N=10 个项目。
TopItemsMonthlySummaryReport：TopItemsMonthlyReport 为指定的查询筛选条件按月提供 N 个排放最高的项目。 按给定日期范围内月份返回前 N 项的排放数据。 一次最多可以返回 N=10 个项目。
ItemDetailsReport：ItemDetailsReport 根据查询筛选条件的指定 CategoryType（例如，Resource、ResourceGroup、ResourceType、Location 或 Subscription）提供项目的精细列表。 此报表一次只能查询一个月，需要在 DateRange 的开始和结束字段中具有相同的值。

碳排放数据的响应数据类型
KnownResponseDataTypeEnum 可以与 ResponseDataTypeEnum 互换使用，此枚举包含服务支持的已知值。

服务支持的已知值

OverallSummaryData：OverallSummaryReport 的响应数据类型
MonthlySummaryData：MonthlySummaryReport 的响应数据类型
TopItemsSummaryData：TopItemsSummaryReport 的响应数据类型
ResourceTopItemsSummaryData：资源的 TopItemsSummaryReport 的响应数据类型
ResourceGroupTopItemsSummaryData：ResourceGroup 的 TopItemsSummaryReport 的响应数据类型
TopItemsMonthlySummaryData：TopItemsMonthlySummaryReport 的响应数据类型
ResourceTopItemsMonthlySummaryData：资源的 TopItemsMonthlySummaryReport 的响应数据类型
ResourceGroupTopItemsMonthlySummaryData：ResourceGroup 的 TopItemsMonthlySummaryReport 的响应数据类型
ItemDetailsData：ItemDetailsReport 的响应数据类型
ResourceItemDetailsData：资源的 ItemDetailsReport 的响应数据类型
ResourceGroupItemDetailsData：ResourceGroup 的 ItemDetailsReport 的响应数据类型

ItemDetailsReport 中的列支持排序。 此对象定义排序方向。
KnownSortDirectionEnum 可以与 SortDirectionEnum 互换使用，此枚举包含服务支持的已知值。

服务支持的已知值

Desc：查询结果的降序。
asc：查询结果的升序。

访问决策枚举

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

要与 QueryParameter 一起使用的受支持类别类型。 每种类型表示不同级别的排放数据聚合。

支持用于 QueryParameter 的碳排放范围，如 GHG 协议所定义。 必须至少指定一个作用域。 输出将返回所有指定范围的总数。

ItemDetailsReport 中的列支持排序。 此对象包括允许排序的列名。 选择其中一个受支持的值

操作的预期执行程序;与基于资源的访问控制 （RBAC） 和审核日志 UX 中一样。 默认值为“user，system”

报告类型的枚举，为碳排放数据指定不同的报告格式。 每个报告类型返回不同类别、日期范围、排放范围和其他参数的碳排放聚合。

碳排放数据的响应数据类型

ItemDetailsReport 中的列支持排序。 此对象定义排序方向。

可用的 API 版本。