@azure/arm-carbonoptimization package

對於不同的查詢報告的基本回應，所有查詢報告結果都會有這些資訊

碳排放數據可用日期範圍的回應

碳排放結果清單

詳細的碳排放回應

每月碳排放摘要的回應

整體碳排放摘要的回應

依月份的頂級專案碳排放回應

依類別類型排序的最上層項目的回應

用戶端的選擇性參數。

表示 CarbonService作的介面。

選擇性參數。

選擇性參數。

要與 QueryParameter 搭配使用的日期範圍，應該在開始和結束日期之間的 12 個月內。 在某些情況下，開始和結束日期必須是相同的日期。

資源管理錯誤其他資訊。

錯誤詳細數據。

所有 Azure Resource Manager API 的常見錯誤回應，以傳回失敗作業的錯誤詳細數據。

ItemDetailsReport 的查詢參數

設定 MonthlySummaryReport 查詢的查詢篩選參數。

從資源提供者作業 API 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 版本。