API / SDK / developer guide
REST API families
| 目標讀者 TA | 後端整合者 |
|---|---|
| 官方文件能力 | 區分服務、裝置訊息及資源管理 API。 |
| 輸入 → 輸出 | 含版本的 HTTPS 請求 → 回應與請求 ID。 |
| 執行環境 | Hub 端點、各 API 版本與授權。 |
| 本站選型評估 | 不可把總覽單一 API 版本套用所有操作。 |
| 本站建議驗證 | 依操作文件的結構與 ETag 語意驗證。 |
工業 IoT／SCADA · API / SDK
Azure IoT Hub REST API
Microsoft
透過 IoT Hub 接口整合裝置與服務操作。
AZURE IOT HUB / DEVELOPER FIELD GUIDE
選對接口，定義可驗證的結果。
公司／專案背景、十個技術入口，以及每份引用的實作分析。
2026-10-08 · 串接尚未實測
公司／專案背景全貌
依官方公司或專案自述撰寫的原創概要；完整原文請見來源。
| 服務 | Microsoft Azure IoT Hub 是受管理的裝置雲端訊息與裝置管理整合服務。 |
|---|---|
| 邊界 | 遙測、期望設定、命令回覆與檔案上傳有不同完成標準；Hub 層級與用戶端支援決定可用功能。 |
| 適用角色 | 進行 AI 供應商初選的採購、合作夥伴與產品負責人。 |
|---|---|
| 本站評估 | 用定位與公司背景判斷初步適配度；另行取得專案部署、支援與商務條件。 |
已核對官方來源。未呼叫供應商 API 或執行推論；結果為內部契約示意。
十項技術入口比較
依實作決策選出的十個技術文件入口，非十套獨立 SDK 或官方排名。
| 接口 | 用途與 TA |
|---|---|
| 01 · REST API familiesAPI / SDK / developer guide | 區分服務、裝置訊息及資源管理 API。後端整合者 |
| 02 · Device/service/management SDKsAPI / SDK / developer guide | 依裝置、後端或 Hub 資源管理選 SDK。SDK 實作者 |
| 03 · Device twinsAPI / SDK / developer guide | 同步期望與回報屬性。裝置設定團隊 |
| 04 · Direct methodsAPI / SDK / developer guide | 呼叫裝置定義的請求／回覆操作。互動控制開發者 |
| 05 · Message routingAPI / SDK / developer guide | 將遙測／事件過濾至內建或自訂端點。遙測管線團隊 |
| 06 · Cloud-to-device messagesAPI / SDK / developer guide | 為個別裝置排入單向通知。通知整合者 |
| 07 · Identity registryAPI / SDK / developer guide | 管理可連線的裝置識別。裝置群識別工程師 |
| 08 · Scheduled jobsAPI / SDK / developer guide | 依裝置選集排程作業。裝置群維運者 |
| 09 · Microsoft Entra service accessAPI / SDK / developer guide | 透過 Entra 身分與角色授權服務存取。雲端資安團隊 |
| 10 · File uploadsAPI / SDK / developer guide | 協調裝置上傳至連結 Blob Storage。大型遙測／媒體團隊 |
逐份文件分析
能力摘要依據官方文件；限制與建議測試為本站工程評估。
API / SDK / developer guide
Device/service/management SDKs
| 目標讀者 TA | SDK 實作者 |
|---|---|
| 官方文件能力 | 依裝置、後端或 Hub 資源管理選 SDK。 |
| 輸入 → 輸出 | 型別化呼叫 → 遙測、狀態或管理回應。 |
| 執行環境 | 固定 SDK 與平台支援；受限裝置採嵌入式 SDK。 |
| 本站選型評估 | 統一 Azure IoT SDK 標示預覽，不視為正式替代品。 |
| 本站建議驗證 | 確認所選語言套件的協定與功能支援。 |
API / SDK / developer guide
Device twins
| 目標讀者 TA | 裝置設定團隊 |
|---|---|
| 官方文件能力 | 同步期望與回報屬性。 |
| 輸入 → 輸出 | JSON 期望更新 → 回報套用狀態。 |
| 執行環境 | Standard 層級功能；裝置與服務權限不同。 |
| 本站選型評估 | 最新回報屬性不是完整時序稽核紀錄。 |
| 本站建議驗證 | 檢查版本、ETag 與新的裝置確認。 |
API / SDK / developer guide
Direct methods
| 目標讀者 TA | 互動控制開發者 |
|---|---|
| 官方文件能力 | 呼叫裝置定義的請求／回覆操作。 |
| 輸入 → 輸出 | 方法名稱與 JSON → 裝置狀態／內容或逾時。 |
| 執行環境 | Standard 層級；HTTPS 服務與支援的裝置協定。 |
| 本站選型評估 | 不保證順序／並行語意；逾時並非取消證據。 |
| 本站建議驗證 | 同時判讀裝置應用狀態與傳輸狀態。 |
API / SDK / developer guide
Message routing
| 目標讀者 TA | 遙測管線團隊 |
|---|---|
| 官方文件能力 | 將遙測／事件過濾至內建或自訂端點。 |
| 輸入 → 輸出 | 訊息與路由條件 → 目的端傳送。 |
| 執行環境 | 目的端寫入權限與足夠吞吐量。 |
| 本站選型評估 | 符合多個路由不等於任意業務處理恰好一次。 |
| 本站建議驗證 | 核對符合／不符合訊息及目的端健康狀況。 |
API / SDK / developer guide
Cloud-to-device messages
| 目標讀者 TA | 通知整合者 |
|---|---|
| 官方文件能力 | 為個別裝置排入單向通知。 |
| 輸入 → 輸出 | 裝置目標訊息 → 生命週期與回饋。 |
| 執行環境 | Standard 層級；依協定有不同確認行為。 |
| 本站選型評估 | 至少一次傳送需要冪等；MQTT 不可拒絕或放棄訊息。 |
| 本站建議驗證 | 區分訊息完成與長時間業務作業完成。 |
API / SDK / developer guide
Identity registry
| 目標讀者 TA | 裝置群識別工程師 |
|---|---|
| 官方文件能力 | 管理可連線的裝置識別。 |
| 輸入 → 輸出 | 裝置／模組識別 → 登錄紀錄。 |
| 執行環境 | Hub 登錄權限與裝置認證。 |
| 本站選型評估 | 登錄存在不是目前連線證據。 |
| 本站建議驗證 | 驗證精確識別與啟用／認證設定。 |
API / SDK / developer guide
Scheduled jobs
| 目標讀者 TA | 裝置群維運者 |
|---|---|
| 官方文件能力 | 依裝置選集排程作業。 |
| 輸入 → 輸出 | 作業目標查詢與操作 → 各裝置作業結果。 |
| 執行環境 | 相容 Hub 層級與服務權限。 |
| 本站選型評估 | 已排程或接受不等於全群完成。 |
| 本站建議驗證 | 核對預定目標、成功與失敗。 |
API / SDK / developer guide
Microsoft Entra service access
| 目標讀者 TA | 雲端資安團隊 |
|---|---|
| 官方文件能力 | 透過 Entra 身分與角色授權服務存取。 |
| 輸入 → 輸出 | 身分權杖與指派角色 → 授權資料操作。 |
| 執行環境 | 設定租戶身分及適當 IoT Hub 角色。 |
| 本站選型評估 | 服務授權與裝置憑證不同。 |
| 本站建議驗證 | 驗證最小權限下允許及拒絕的操作。 |
API / SDK / developer guide
File uploads
| 目標讀者 TA | 大型遙測／媒體團隊 |
|---|---|
| 官方文件能力 | 協調裝置上傳至連結 Blob Storage。 |
| 輸入 → 輸出 | 初始化上傳 → SAS URI；Blob 上傳 → 完成通知。 |
| 執行環境 | 連結儲存體／容器、網路權限及有期限 SAS。 |
| 本站選型評估 | 取得 SAS URI 不代表位元組已上傳。 |
| 本站建議驗證 | 驗證 Blob 大小／雜湊並關聯完成通知；勿揭露 SAS。 |
Official documentation
| TA | 工程師與技術產品負責人 |
|---|---|
| 本站驗證建議 | 實作前固定版本並依目標環境核對支援條件。 |
04 / INPUT · EXPECTED OUTPUT · ACCEPTANCE
實作前先看懂預期結果
建議裝置設定與傳送契約，僅含虛構範例。未使用 Azure 請求、憑證或裝置。
示意契約 · 未呼叫 API 或執行模型 · 不是供應商實測輸出
設定已套用
| 輸入 | 更新期望遙測間隔；新的裝置回報符合。 |
|---|---|
| 預期結果 | application_acknowledged=true 並附對應版本。 |
| 驗收條件 | 要求回報套用證據，不只看 twin PATCH 成功。 |
無符合的裝置
| 輸入 | 有效目標查詢回傳零台裝置。 |
|---|---|
| 預期結果 | targets=[]；未啟動裝置操作。 |
| 驗收條件 | 呈現有效空選集，不宣稱全群成功。 |
直接方法逾時
| 輸入 | 裝置未於設定回覆期限前回應。 |
|---|---|
| 預期結果 | 逾時；實體結果未知。 |
| 驗收條件 | 不可假設回復原狀；重試非冪等命令前核對狀態。 |
已初始化但未完成上傳
| 輸入 | 取得 SAS 但 Blob 傳送失敗。 |
|---|---|
| 預期結果 | upload_complete=false；保留關聯 ID 與錯誤。 |
| 驗收條件 | 驗證內容前，內部契約不可出現檔案完成事件。 |
將預期結果對應至你的應用
將實際執行環境回應對應至此建議應用契約。所有數值皆為示意，不含憑證或真實執行。
預期輸出 JSON — 示意，非實測 · AzureIoTHub-expected-results.json
{
"schema_version": "1.0.0",
"example": true,
"provider": "Azure IoT Hub",
"status": "ok",
"input_id": "sample-001",
"data": {
"device_id": "demo-device-001",
"desired_interval_seconds": 60,
"reported_interval_seconds": 60,
"reported_version_matches": true,
"application_acknowledged": true
},
"error": null,
"verification": "illustrative-only;not-provider-response"
}| 狀態語意 | 有效空結果與錯誤不同；等待中的工作不可提前顯示成功。 |
|---|---|
| 證據 | 記錄服務與 SDK 版本、請求識別、設定及回應映射。此處未執行或量測效能。 |
| 建議驗收 | 以授權代表樣本測試前，先約定數值誤差與負載目標。 |
開發評估
設備狀態工作台
開發構想規格・串接尚未實測
接口能力依據官方文件或程式庫；以下產品方向、輸入、交付與驗收條件則是我們的開發評估。
需整合驗證
估算可交付產品前，需共同驗證執行環境、資料結構或硬體。
- 原型輸入規劃
- 測試設備或模擬器、訊號對照表與明確單位。
- 原型交付規劃
- 附時間、資料新鮮度、單位與連線狀態的設備數值。
- 驗收條件
- 對照來源驗證比例與時間；設備斷線時不得顯示正常。
- 依賴條件
- 閘道或服務帳號、設備資料結構與測試環境。
開發順序
- 確認 Azure IoT Hub REST API 的存取、授權與支援版本。
- 準備上述樣本，針對「設備狀態工作台」先實作一個有官方文件的操作。
- 整理輸出時保留來源、時間與錯誤狀態，並保留供應商回應供審核。
- 通過驗收條件後，再估算擴展投入與客戶交付。
如何驗證需求
記錄產品瀏覽、官方文件點擊、規格下載與技術 Hub 點擊。這些是事件次數，不等於獨立人數或已完成串接。
本次可行性評估依實作條件判斷；尚未給定流量排名或交期承諾。