az iot central device-template

參考

注意

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

管理及設定IoT Central裝置範本。

命令

名稱	Description	類型	狀態
az iot central device-template create	在 IoT Central 中建立裝置範本。	副檔名	GA
az iot central device-template delete	從 IoT Central 刪除裝置範本。	副檔名	GA
az iot central device-template list	取得IoT Central應用程式的裝置範本清單。	副檔名	GA
az iot central device-template show	從 IoT Central 取得裝置範本。	副檔名	GA
az iot central device-template update	在 IoT Central 中更新裝置範本。	副檔名	GA

az iot central device-template create

在 IoT Central 中建立裝置範本。

az iot central device-template create --app-id
                                      --content
                                      --device-template-id
                                      [--api-version {2022-06-30-preview, 2022-07-31}]
                                      [--central-api-uri]
                                      [--token]

範例

建立具有從檔案讀取承載的裝置範本

az iot central device-template create --app-id {appid} --content {pathtofile} --device-template-id {devicetemplateid}

建立具有從原始 json 讀取承載的裝置範本

az iot central device-template create --app-id {appid} --content {json} --device-template-id {devicetemplateid}

必要參數

--app-id -n

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

--content -k

裝置範本定義。提供 JSON 檔案或原始字串化 JSON 的路徑。 [檔案路徑範例：./path/to/file.json][字串化的 JSON 範例： {}]。要求本文必須包含 CapabilityModel。

--device-template-id --dtid

裝置範本的數字對應項模型標識碼。請至https://aka.ms/iotcentraldtmi，即可深入瞭解。

選擇性參數

--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

--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-template delete

從 IoT Central 刪除裝置範本。

注意：如果有任何裝置仍然與此範本相關聯，這應該會失敗。

az iot central device-template delete --app-id
                                      --device-template-id
                                      [--api-version {2022-06-30-preview, 2022-07-31}]
                                      [--central-api-uri]
                                      [--token]

範例

從 IoT Central 刪除裝置範本

az iot central device-template delete --app-id {appid} --device-template-id {devicetemplateid}

必要參數

--app-id -n

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

--device-template-id --dtid

目標裝置範本的標識碼。範例：somedevicetemplate。

選擇性參數

--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

--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-template list

取得IoT Central應用程式的裝置範本清單。

az iot central device-template list --app-id
                                    [--api-version {2022-06-30-preview, 2022-07-31}]
                                    [--central-api-uri]
                                    [--compact]
                                    [--token]

範例

列出應用程式中的所有裝置範本，依樣本識別子排序（預設值）

az iot central device-template list --app-id {appid}

必要參數

--app-id -n

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

選擇性參數

--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

--compact -c

以精簡模式顯示範本。每個範本只會顯示識別碼、名稱和模型類型。

預設值: False

--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-template show

從 IoT Central 取得裝置範本。

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

範例

取得裝置範本

az iot central device-template show --app-id {appid} --device-template-id {devicetemplateid}

必要參數

--app-id -n

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

--device-template-id --dtid

目標裝置範本的標識碼。範例：somedevicetemplate。

選擇性參數

--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

--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-template update

在 IoT Central 中更新裝置範本。

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

範例

使用從檔案讀取的承載更新裝置範本

az iot central device-template update --app-id {appid} --content {pathtofile} --device-template-id {devicetemplateid}

使用從原始 json 讀取的承載更新裝置範本

az iot central device-template update --app-id {appid} --content {json} --device-template-id {devicetemplateid}

必要參數

--app-id -n

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

--content -k

裝置範本定義。提供 JSON 檔案或原始字串化 JSON 的路徑。 [檔案路徑範例：./path/to/file.json][字串化的 JSON 範例： {}]。要求本文必須包含 CapabilityModel。

--device-template-id --dtid

目標裝置範本的標識碼。範例：somedevicetemplate。

選擇性參數

--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

--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-template

命令

az iot central device-template create

範例

必要參數

選擇性參數

az iot central device-template delete

範例

必要參數

選擇性參數

az iot central device-template list

範例

必要參數

選擇性參數

az iot central device-template show

範例

必要參數

選擇性參數

az iot central device-template update

範例

必要參數

選擇性參數

其他資源