az iot central device twin

參考

注意

此參考是 Azure CLI 的 azure-iot 延伸模組的一部分（2.46.0 版或更高版本）。擴充功能會在您第一次執行 az iot central device twin 命令時自動安裝。深入了解擴充功能。

管理 IoT Central 裝置對應項。

命令

名稱	Description	類型	狀態
az iot central device twin replace	取代裝置、裝置元件或裝置模組或裝置模組元件的可寫入屬性值。	副檔名	GA
az iot central device twin show	取得裝置、裝置元件、裝置模組或裝置模組元件的所有屬性值。	副檔名	GA
az iot central device twin update	更新裝置、裝置元件、裝置模組或裝置模組元件的可寫入屬性值。	副檔名	GA

az iot central device twin replace

取代裝置、裝置元件或裝置模組或裝置模組元件的可寫入屬性值。

提供 --component-name、--module-name 或兩者來取代裝置元件屬性、裝置模組屬性或裝置模組元件屬性。

az iot central device twin replace --app-id
                                   --content
                                   --device-id
                                   [--api-version {2022-06-30-preview, 2022-07-31}]
                                   [--central-api-uri]
                                   [--co]
                                   [--mn]
                                   [--token]

範例

取代裝置屬性

az iot central device twin replace --app-id {appid} --device-id {deviceid} -k {content}

取代裝置元件屬性

az iot central device twin replace --app-id {appid} --device-id {deviceid} --co {componentname} -k {content}

取代裝置模組元件屬性

az iot central device twin replace --app-id {appid} --device-id {deviceid} --mn {modulename} --co {componentname} -k {content}

必要參數

--app-id -n

您要管理的 IoT Central 應用程式的應用程式識別碼。您可以在應用程式[關於] 頁面的 [說明] 選單下找到應用程式識別碼。

--content -k

要求的組態。提供 JSON 檔案或原始字串化 JSON 的路徑。 [檔案路徑範例：./path/to/file.json][字串化 JSON 範例： {'a'： 'b'}]。

--device-id -d

目標裝置的裝置識別碼。按兩下 [裝置詳細資料] 頁面上的 [連線] 按鈕，即可找到裝置標識碼。

選擇性參數

--api-version --av

已被取代

自變數 'api_version' 已被取代，並將在未來版本中移除。

此命令參數已被取代，將會忽略。在未來版本中，我們只會支援最新 GA 版本的 IoT Central API。如果任何 API 尚未正式運作，我們將呼叫最新的預覽版本。

接受的值: 2022-06-30-preview, 2022-07-31

預設值: 2022-07-31

--central-api-uri --central-dns-suffix

與您的應用程式相關聯的IoT Central DNS後綴。

預設值: azureiotcentral.com

--co --component-name

裝置元件的名稱。

--mn --module-name

裝置模組的名稱。

--token

如果您想要提交要求而不向 Azure CLI 進行驗證，您可以指定有效的使用者令牌來驗證您的要求。您必須將金鑰類型指定為要求的一部分。請至https://aka.ms/iotcentraldocsapi，即可深入瞭解。

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。您可以使用 az account set -s NAME_OR_ID 設定預設訂用帳戶。

--verbose

增加記錄詳細資訊。使用 --debug 來取得完整偵錯記錄。

az iot central device twin show

取得裝置、裝置元件、裝置模組或裝置模組元件的所有屬性值。

提供 --component-name、-module-name 或兩者來取得裝置元件屬性、裝置模組屬性或裝置模組元件屬性。

az iot central device twin show --app-id
                                --device-id
                                [--api-version {2022-06-30-preview, 2022-07-31}]
                                [--central-api-uri]
                                [--co]
                                [--mn]
                                [--token]

範例

取得裝置屬性

az iot central device twin show --app-id {appid} --device-id {deviceid}

取得裝置元件屬性

az iot central device twin show --app-id {appid} --device-id {deviceid} --co {componentname}

取得裝置模組元件屬性

az iot central device twin show --app-id {appid} --device-id {deviceid} --mn {modulename} --co {componentname}

必要參數

--app-id -n

您要管理的 IoT Central 應用程式的應用程式識別碼。您可以在應用程式[關於] 頁面的 [說明] 選單下找到應用程式識別碼。

--device-id -d

目標裝置的裝置識別碼。按兩下 [裝置詳細資料] 頁面上的 [連線] 按鈕，即可找到裝置標識碼。

選擇性參數

--api-version --av

已被取代

自變數 'api_version' 已被取代，並將在未來版本中移除。

此命令參數已被取代，將會忽略。在未來版本中，我們只會支援最新 GA 版本的 IoT Central API。如果任何 API 尚未正式運作，我們將呼叫最新的預覽版本。

接受的值: 2022-06-30-preview, 2022-07-31

預設值: 2022-07-31

--central-api-uri --central-dns-suffix

與您的應用程式相關聯的IoT Central DNS後綴。

預設值: azureiotcentral.com

--co --component-name

裝置元件的名稱。

--mn --module-name

裝置模組的名稱。

--token

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。您可以使用 az account set -s NAME_OR_ID 設定預設訂用帳戶。

--verbose

增加記錄詳細資訊。使用 --debug 來取得完整偵錯記錄。

az iot central device twin update

更新裝置、裝置元件、裝置模組或裝置模組元件的可寫入屬性值。

提供 --component-name、-module-name 或兩者來更新裝置元件屬性、裝置模組屬性或裝置模組元件屬性。

az iot central device twin update --app-id
                                  --content
                                  --device-id
                                  [--api-version {2022-06-30-preview, 2022-07-31}]
                                  [--central-api-uri]
                                  [--co]
                                  [--mn]
                                  [--token]

範例

更新裝置屬性

az iot central device twin update --app-id {appid} --device-id {deviceid} -k {content}

更新裝置元件屬性

az iot central device twin update --app-id {appid} --device-id {deviceid} --co {componentname} -k {content}

更新裝置模組元件屬性

az iot central device twin update --app-id {appid} --device-id {deviceid} --mn {modulename} --co {componentname} -k {content}

必要參數

--app-id -n

您要管理的 IoT Central 應用程式的應用程式識別碼。您可以在應用程式[關於] 頁面的 [說明] 選單下找到應用程式識別碼。

--content -k

要求的組態。提供 JSON 檔案或原始字串化 JSON 的路徑。 [檔案路徑範例：./path/to/file.json][字串化 JSON 範例： {'a'： 'b'}]。

--device-id -d

目標裝置的裝置識別碼。按兩下 [裝置詳細資料] 頁面上的 [連線] 按鈕，即可找到裝置標識碼。

選擇性參數

--api-version --av

已被取代

自變數 'api_version' 已被取代，並將在未來版本中移除。

此命令參數已被取代，將會忽略。在未來版本中，我們只會支援最新 GA 版本的 IoT Central API。如果任何 API 尚未正式運作，我們將呼叫最新的預覽版本。

接受的值: 2022-06-30-preview, 2022-07-31

預設值: 2022-07-31

--central-api-uri --central-dns-suffix

與您的應用程式相關聯的IoT Central DNS後綴。

預設值: azureiotcentral.com

--co --component-name

裝置元件的名稱。

--mn --module-name

裝置模組的名稱。

--token

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。您可以使用 az account set -s NAME_OR_ID 設定預設訂用帳戶。

--verbose

增加記錄詳細資訊。使用 --debug 來取得完整偵錯記錄。

共用方式為

az iot central device twin

命令

az iot central device twin replace

範例

必要參數

選擇性參數

az iot central device twin show

範例

必要參數

選擇性參數

az iot central device twin update

範例

必要參數

選擇性參數

其他資源