共用方式為

Cloud for Sustainability API (預覽版) OData 查詢範例

  • 發行項

免費試用

重要

這其中部分或所有的功能會做為預覽版本的一部分來提供。 內容和功能隨時可能變更。

開放式資料通訊協定 (OData) 是建立在核心通訊協定 (例如 HTTP) 基礎上的資料存取通訊協定。 它使用普遍接受的方法 (例如網站的 REST)。 您可以使用各種程式庫和工具來使用 OData 服務。

為了協助您自行建置以 Microsoft Cloud for Sustainability API 為基礎的實作，您可以檢閱其中一些經常要求的範例查詢。

修改查詢範例，讓這些範例可在目標環境中正常運作：

  • {serviceRoot}: https://api.mcfs.microsoft.com/api/v1.0/instances/{instanceId}

  • {instanceId}：您要查詢的 Cloud for Sustainability 環境的 GUID，例如 20aec369-f1c8-4814-a89d-4d449dd7e8a1。

  • {serviceRootM365}: {serviceRoot}/m365

  • {serviceRootAzure}: {serviceRoot}/enrollments/{enrollmentId}

  • {enrollmentId}：註冊 ID，也稱為計費帳戶 ID。 範例：12345678。

  • {tenantId}： Microsoft 365 tenant ID 的 ID 中。

注意

有些 API 查詢會包含許多結果，並分散在多個頁面上。 API 會傳回每頁最多 1000 個結果。 如果找到更多的結果，API 會傳回 @odata.nextLink 屬性，其中包含指向下一頁結果的 URL。

EnrollmentEmission 實體 (適用于 Azure 排放)

表示計費帳戶的排放資料，也稱為註冊。

屬性 類型​ 注意事項
dateKey int32 yyyymmdd 格式的日期；dd 永遠為 01。
enrollmentId 字串 也稱為計費帳戶識別碼。
orgName 字串 與 TP 名稱或最上層名稱相同。
subscriptionId 字串 訂閱的識別碼。
subscriptionName 字串 訂閱的名稱。
azureServiceName 字串 Azure 服務的名稱，例如 App Service
subService 字串 例如，Azure 儲存體或 Azure 計算。
azureRegionName 字串 部署服務的 Azure 區域。
範圍 字串 溫室氣體範圍，例如範圍 1、範圍 2 或範圍 3。
scopeId int32 範圍的識別碼。
totalEmissions 雙精確度 記錄的總排放 (公噸二氧化碳當量)。

EnrollmentEmission 實體的範例查詢 (適用於 Azure 排放)

查詢類型 範例
依註冊之排放 {serviceRootAzure}/排放
選取特定欄位 {serviceRootAzure}/emissions？$select=enrollmentId，totalEmissions，scopeId
包含計數 {serviceRootAzure}/emissions？$count=true
限制結果計數 {serviceRootAzure}/排放量？$top=100
分頁 {serviceRootAzure}/排放量？$skip=100&$top=50
依範圍篩選 {serviceRootAzure}/emissions？$filter=ScopeId eq 1
篩選並彙總 {serviceRootAzure}/emissions？$apply=filter (ScopeId eq 1)/aggregate（$count 作為 Count，totalEmissions 作為平均值，totalEmissions 和 sum 作為 Sum）
篩選並組成群組 {serviceRootAzure}/emissions？$apply=filter (totalEmissions gt 0.05)/groupby ((ScopeId)，aggregate ($count as Count)) '

Microsoft365Emission 實體 (適用於 Microsoft 365 排放)

表示與下列應用程式相關聯的 Microsoft 365 資料中心排放：

  • Exchange Online
  • SharePoint
  • OneDrive
  • Microsoft Teams
  • Word
  • Excel
  • PowerPoint
  • Outlook
屬性 類型​ 注意事項
dateKey int32 yyyymmdd 格式的日期；dd 永遠為 01。
tenantId 字串 租用戶的識別碼。
tenantName 字串 租用戶的名稱。
officeRegionName 字串 Microsoft 365 資料中心區域，
範圍 字串 溫室氣體範圍，例如範圍 1、範圍 2 或範圍 3。
totalEmissions 雙精確度 記錄的總排放 (公噸二氧化碳當量)。

Microsoft365Emission 實體的範例查詢 (適用於 Microsoft 365 排放)

查詢類型 範例
租用戶排放 {serviceRootM365}/tenant 排放
選取特定欄位 {serviceRootM365}/emissions？$select=tenantId，totalEmissions，範圍
包含計數 {serviceRootM365}/tenantemissions？$count=true
限制結果計數 {serviceRootM365}/tenantemissions？$top=100
分頁 {serviceRootM365}/tenantemissions？$skip=100&$top=50
依範圍篩選 {serviceRootM365}/tenantemissions？$filter=範圍 eq 'FILLMEIN'
篩選並彙總 {serviceRootserviceRootM365Azure}/tenantemissions？$apply=filter (scope eq 'FILLMEIN')/aggregate（$count 作為 Count，totalEmissions 和 average 作為 Average，totalEmissions 和 sum 作為 Sum）
篩選並組成群組 {serviceRootM365}/tenantemissions？$apply=filter (totalEmissions gt 0.05)/groupby ((範圍)，aggregate ($count as Count)) '

EnrollmentUsage 實體 (適用於 Azure 排放)

表示 Microsoft 雲端資源的計算使用係數。

屬性 類型​ 注意事項
dateKey int32 yyyymmdd 格式的日期；dd 永遠為 01。
enrollmentId 字串 也稱為計費帳戶識別碼。
orgName 字串 與 TP 名稱或最上層名稱相同。
subscriptionId 字串 訂閱的識別碼。
subscriptionName 字串 訂閱的名稱。
subService 字串 例如，Azure 儲存體或 Azure 計算。
azureRegionName 字串 部署服務的 Azure 區域。
使用量 雙精確度 記錄的總使用量。 沒有單位，因為這表示指定區域中服務的標準化使用量。

如需 Microsoft 計算方法的詳細資訊，請移至 Microsoft Cloud for Sustainability API 計算方法。|

EnrollmentUsage 實體的範例查詢

查詢類型 範例 注意
所有使用方式資料 {serviceRootAzure}/用法
每個訂閱每月的總使用量 {serviceRootAzure}/usage？$apply=groupby ((SubscriptionName，DateKey)，aggregate (總和為 TotalUsage)) &$orderby=SubscriptionName，DateKey

EnrollmentProjection 實體 (適用於 Azure 排放)

表示日曆年剩餘時間根據前五個月移動平均預計的排放。 適用於年度視覺效果。

屬性 類型​ 注意事項
dateKey int32 yyyymmdd 格式的日期；dd 永遠為 01。
enrollmentId 字串 也稱為計費帳戶識別碼。
actualEmissions 雙精確度 僅包含過去的日期 (公噸二氧化碳當量)。
projectedEmissions 雙精確度 以當年度可用實際資料為準，根據前五個月或更短時間得出的移動平均 (公噸二氧化碳當量)。
actualUsage 雙精確度 僅包含過去的日期。
projectedUsage 雙精確度 以當年度可用實際資料為準，根據前五個月或更短時間得出的移動平均。

EnrollmentProjection 實體的範例查詢 (適用於 Azure 排放)

查詢類型 範例 注意
2022 年 7 月以後的推估 {serviceRootAzure}/projections？$filter=dateKey gt 20220701
年度的所有推估 {serviceRootAzure}/預測

重要

Microsoft Cloud for Sustainability API 目前為預覽版，隨時可能會變更。 隨著 Microsoft 對資料正確性和完整性的改進，您的歷史排放數據也可能會更新。

常見問題

Microsoft 如何計算排放和使用量？

如需 Microsoft 計算方法的詳細資訊，請移至 Microsoft Cloud for Sustainability API 計算方法。

什麼是 Rownum？

API 使用 rownum 來保持一致的分頁。 此值可能會變更，因此應用程式不應對其有相依性。

什麼是註冊識別碼？

註冊識別碼是指計費帳戶識別碼。 在 Azure 門戶中查找註冊 ID 和計費帳戶 ID 。

如何取得目標環境的授權權杖？

API 需要 OAuth 授權權杖。 建議使用 Microsoft 驗證庫 (MSAL)。

如果結果多於目前回覆中傳回的結果，則 API 會傳回 @odata.nextLink 屬性。 應用程式應該對此 nextLink 執行另一個 GET，以取得下一頁的結果。 最後一頁不包含 nextLink。 如需有關使用 OData 用戶端程式庫進行分頁的詳細資訊，請瀏覽此程式碼範例。

📄 培訓產品頁面
🎓

✅ 免費試用
🎥 YouTube 頻道

💻 社區
LinkedIn 圖示。LinkedIn 組