使用資源提供者 REST API 建立 IoT 中樞 (.NET)

發行項
03/17/2023

您可以使用 IoT 中樞資源 REST API，透過程式設計方式建立和管理 Azure IoT 中樞。此文章說明如何使用 IoT 中樞資源，使用 Postman 建立 IoT 中樞。或者，您可以使用 cURL。如果其中任何一個 REST 命令失敗，請透過 IoT 中樞 API 常見錯誤碼取得協助。

注意

建議您使用 Azure Az PowerShell 模組來與 Azure 互動。請參閱安裝 Azure PowerShell 以開始使用。若要了解如何遷移至 Az PowerShell 模組，請參閱將 Azure PowerShell 從 AzureRM 遷移至 Az。

必要條件

Azure PowerShell 模組或 Azure Cloud Shell
Postman 或 cURL (英文)

取得 Azure 存取權杖

在 Azure PowerShell Cmdlet 或 Azure Cloud Shell 中，使用下列命令登入並擷取權杖。如果您使用 Cloud Shell，代表您已經登入，因此請略過此步驟。

az account get-access-token --resource https://management.azure.com

您應該會在主控台中看到類似此 JSON 的回應 (但存取權杖較長)：

{
    "accessToken": "eyJ ... pZA",
    "expiresOn": "2022-09-16 20:57:52.000000",
    "subscription": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "tenant": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "tokenType": "Bearer"
}

在新的 Postman 要求中，從 [Auth] \(驗證\) 索引標籤，選取 [Type] \(類型\) 下拉式清單，然後選擇 [Bearer Token] \(持有人權杖\)。
將存取權杖貼到標示為 [Token] \(權杖\) 的欄位中。

請記住，存取權杖會在 5-60 分鐘後到期，因此您可能需要產生另一個權杖。

建立 IoT 中樞

選取 REST 命令下拉式清單，然後選擇 PUT 命令。複製下列 URL，以您自己的值取代 {} 中的值。 {resourceName} 值是您想要為新 IoT 中樞命名的名稱。將 URL 貼到 PUT 命令旁的欄位中。
```
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}?api-version=2021-04-12
```
請參閱 IoT 中樞資源中的 PUT 命令。
從 [Body] \(本文\) 索引標籤，從下拉式清單中選取 [raw] \(原始\) 和 [JSON]。
複製下列 JSON，以您自己的值取代 <> 中的值。將 JSON 貼到 Postman 的 [Body] \(本文\) 索引標籤上的方塊中。請確定您的 IoT 中樞名稱符合 PUT URL 中的名稱。將位置變更為您的位置 (您指派給資源群組的位置)。
```
{
    "name": "<my-iot-hub>",
    "location": "<region>",
    "tags": {},
    "properties": {},
    "sku": {
        "name": "S1",
        "tier": "Standard",
        "capacity": 1
    }
}
```
請參閱 IoT 中樞資源中的 PUT 命令。
選取 [Send] \(傳送\) 以傳送您的要求，並建立新的 IoT 中樞。成功的要求會傳回 [201 Created] \(201 已建立\) 回應，其中包含 IoT 中樞規格的 JSON 列印。如果您使用 Postman，可以儲存您的要求。

檢視 IoT 中樞

若要查看新 IoT 中樞的所有規格，請使用 GET 要求。您可以使用與 PUT 要求搭配使用的相同 URL，但必須清除該要求的本文 (若尚未是空白的話)，因為 GET 要求不能有本文。以下是 GET 要求範本：

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}?api-version=2018-04-01

請參閱 IoT 中樞資源中的 GET 命令。

更新 IoT 中樞

更新只需要使用與建立 IoT 中樞時相同的 PUT 要求，並編輯 JSON 本文以包含您選擇的參數。新增 tags 屬性來編輯要求本文，然後執行 PUT 要求。

{
    "name": "<my-iot-hub>",
    "location": "westus2",
    "tags": {
        "Animal": "Cat"
    },
    "properties": {},
    "sku": {
        "name": "S1",
        "tier": "Standard",
        "capacity": 1
    }
}

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}?api-version=2018-04-01

回應會在主控台中顯示新增的新標籤。請記住，如果您上次產生存取權杖之後已經經過太多時間，您可能需要重新整理存取權杖。

請參閱 IoT 中樞資源中的 PUT 命令。

或者，使用 IoT 中樞資源中的 PATCH 命令來更新標籤。

刪除 IoT 中樞

如果您只是測試，建議您傳送 DELETE 要求來清除資源並刪除新的 IoT 中樞。請務必將 {} 中的值取代為您自己的值。 {resourceName} 值是您 IoT 中樞的名稱。

DELETE https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}?api-version=2018-04-01

請參閱 IoT 中樞資源中的 DELETE 命令。