【 Cloud 】透過 Postman 操作 Azure Digital Twins - Twin APIs

內容

• 學習目標
• 前置準備作業
• 新增 Twin
• 透過 Twin ID 列出特定 Twin 資訊
• 設定特定 Twin 的預設值
• 修改特定 Twin 的數值
• 刪除特定 Twin 的數值
• 刪除 Twin

學習目標

• 如何透過 Postman 操作 Azure Digital Twins - Twin APIs

前置準備作業

• 已建立 Azure 帳號並能正常登入與使用
• 已完成建立與設定 Azure Digital Twins、Azure Active Directory ( Azure AD )
  • Ref https://learningsky.io/azure-digital-twins-authenticates-using-azure-ad-security-tokens-based-on-oauth/
• 已於電腦端安裝 Postman
  • 下載網址 https://www.postman.com/
• 已上傳 DTDL
  • Ref https://learningsky.io/how-to-use-postman-to-send-requests-to-the-azure-digital-twins-models-apis/

新增 Twin

Step 1. 新增 Twin

• 點選 +

• 填寫 Request 資訊
  • Request Method 請選擇 PUT
  • Request URL 請在 Enter Request URL 的輸入框輸入 https://Adt-Host-Name/digitaltwins/TWIN-NAME?api-version=2020-10-31
    • ㊟ 將 URL 中的 Adt-Host-Name 修改成所建立的 Azure Digital Twins 所取得的 Host name
    • ㊟ 將 URL 中的 TWIN-NAME 修改成不重複且可識別的名稱，本範例使用 device001
  • Request Body
    • 請點選 Body 頁籤 > 再點選 raw > 再點選 JSON > 在輸入框輸入下方資訊
    • ㊟ 將 $model 的值修改成 DTDL 中 @id 的值，本範例為 dtmi:company:Device;1

• 點選 Send

• 執行結果

透過 Twin ID 列出特定 Twin 資訊

Step 1. 列出特定 Twin 資訊

• 點選 +

• 填寫 Request 資訊
  • Request Method 請選擇 GET
  • Request URL 請在 Enter Request URL 的輸入框輸入 https://Adt-Host-Name/digitaltwins/TWIN-NAME?api-version=2020-10-31
    • ㊟ 將 URL 中的 Adt-Host-Name 修改成所建立的 Azure Digital Twins 所取得的 Host name
    • ㊟ 將 URL 中的 TWIN-NAME 修改成要查詢的 Twin 名稱，本範例為 device001

• 點選 Send

• 執行結果

設定特定 Twin 的預設值

Step 1. 設定預設值

• 點選 +

• 填寫 Request 資訊
  • Request Method 請選擇 PATCH
  • Request URL 請在 Enter Request URL 的輸入框輸入 https://Adt-Host-Name/digitaltwins/TWIN-NAME?api-version=2020-10-31
    • ㊟ 將 URL 中的 Adt-Host-Name 修改成所建立的 Azure Digital Twins 所取得的 Host name
    • ㊟ 將 URL 中的 TWIN-NAME 修改成不重複且可識別的名稱，本範例使用 device001
  • Request Body
    • 請點選 Body 頁籤 > 再點選 raw > 再點選 JSON > 在輸入框輸入下方資訊
    • ㊟ 將 path 的值修改成 contents 的 name，本範例為 /Temperature
    • ㊟ 將 value 的值修改成 所要設定的值

• 點選 Send

• 執行結果

修改特定 Twin 的數值

Step 1. 修改數值

• 點選 +

• 填寫 Request 資訊
  • Request Method 請選擇 PATCH
  • Request URL 請在 Enter Request URL 的輸入框輸入 https://Adt-Host-Name/digitaltwins/TWIN-NAME?api-version=2020-10-31
    • ㊟ 將 URL 中的 Adt-Host-Name 修改成所建立的 Azure Digital Twins 所取得的 Host name
    • ㊟ 將 URL 中的 TWIN-NAME 修改成不重複且可識別的名稱，本範例使用 device001
  • Request Body
    • 請點選 Body 頁籤 > 再點選 raw > 再點選 JSON > 在輸入框輸入下方資訊
    • ㊟ 將 path 的值修改成 contents 的 name，本範例為 /Temperature
    • ㊟ 將 value 的值修改成 所要設定的值

• 點選 Send

• 執行結果

刪除特定 Twin 的數值

Step 1. 移除數值

• 點選 +

• 填寫 Request 資訊
  • Request Method 請選擇 PATCH
  • Request URL 請在 Enter Request URL 的輸入框輸入 https://Adt-Host-Name/digitaltwins/TWIN-NAME?api-version=2020-10-31
    • ㊟ 將 URL 中的 Adt-Host-Name 修改成所建立的 Azure Digital Twins 所取得的 Host name
    • ㊟ 將 URL 中的 TWIN-NAME 修改成不重複且可識別的名稱，本範例使用 device001
  • Request Body
    • 請點選 Body 頁籤 > 再點選 raw > 再點選 JSON > 在輸入框輸入下方資訊
    • ㊟ 將 path 的值修改成 contents 的 name，本範例為 /Temperature
    • ㊟ 將 value 的值修改成 所要設定的值

• 點選 Send

• 執行結果

刪除 Twin

Step 1. 移除 Twin

• 點選 +

• 填寫 Request 資訊
  • Request Method 請選擇 DELETE
  • Request URL 請在 Enter Request URL 的輸入框輸入 https://Adt-Host-Name/digitaltwins/TWIN-NAME?api-version=2020-10-31
    • ㊟ 將 URL 中的 Adt-Host-Name 修改成所建立的 Azure Digital Twins 所取得的 Host name
    • ㊟ 將 URL 中的 TWIN-NAME 修改成不重複且可識別的名稱，本範例使用 device001

• 點選 Send

• 執行結果

Reference

• https://docs.microsoft.com/en-us/rest/api/azure-digitaltwins/

GitHub

• ArcherHuang @ GitHub

List of blogs

• https://oranwind.org/author/archer/
• https://learningsky.io/author/archer/