使用 REST API 來建立和管理 IoT Central 應用程式

文章
05/11/2024

您可以使用控制平面 REST API 來建立和管理 IoT Central 應用程式。您也可以使用 REST API 將受控識別新增至您的應用程式。

若要使用此 API，您需要 management.azure.com 資源的持有人權杖。若要取得持有人權杖，您可以使用 Azure CLI：

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

若要了解如何使用 IoT Central UI 來管理 IoT Central 應用程式，請參閱建立 IoT Central 應用程式。

列出您的應用程式

若要取得訂用帳戶中 IoT Central 應用程式的清單：

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.IoTCentral/iotApps?api-version=2021-06-01

若要取得資源群組中 IoT Central 應用程式的清單：

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTCentral/iotApps?api-version=2021-06-01

您可以擷取個別應用程式的詳細資料：

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTCentral/iotApps/{applicationName}?api-version=2021-06-01

建立 IoT Central 應用程式

若要建立具有系統指派受控識別的 IoT Central 應用程式：

PUT https://management.azure.com/subscriptions/<your subscription id>/resourceGroups/<your resource group name>/providers/Microsoft.IoTCentral/iotApps/<your application name>?api-version=2021-06-01

下列承載顯示新應用程式的設定，包括受控識別：

{
  "location": "eastus",
  "sku": {
    "name": "ST2"
  },
  "properties": {
    "displayName": "Contoso IoT Central App",
    "subdomain": "my-iot-central-app",
    "template": "iotc-pnp-preview@1.0.0"
  },
  "identity": {
    "type": "SystemAssigned"
  }
}

修改 IoT Central 應用程式

您可以修改現有的 IoT Central 應用程式。下列範例示範如何變更顯示名稱，並啟用系統指派的受控識別：

PATCH https://management.azure.com/subscriptions/<your subscription id>/resourceGroups/<your resource group name>/providers/Microsoft.IoTCentral/iotApps/<your application name>?api-version=2021-06-01

使用下列承載來變更顯示名稱，並啟用系統指派的受控識別：

{
  "properties": {
    "displayName": "Contoso IoT Central App"
  },
  "identity": {
    "type": "SystemAssigned"
  }
}

注意

您只能將受控識別新增至區域中建立的 IoT Central 應用程式。所有新的應用程式都會在區域中建立。

刪除 IoT Central 應用程式

若要刪除 IoT Central 應用程式，請使用：

DELETE https://management.azure.com/subscriptions/<your subscription id>/resourceGroups/<your resource group name>/providers/Microsoft.IoTCentral/iotApps/<your application name>?api-version=2021-06-01

下一步

您現在已了解如何使用 REST API 來建立和管理 Azure IoT Central 應用程式，以下是建議的後續步驟:

如何使用 IoT Central REST API 來管理使用者和角色

分享方式：