az iot central device-template

リファレンス

Note

このリファレンスは、Azure CLI (バージョン 2.46.0 以降) の azure-iot 拡張機能の一部です。拡張機能は、az iot central device-template コマンドを初めて実行するときに自動的にインストールされます。拡張機能の詳細をご覧ください。

IoT Central デバイステンプレートを管理および構成します。

コマンド

名前	説明	型	Status
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 アプリのアプリ ID。アプリ ID は、アプリケーションの [バージョン情報] ページのヘルプメニューにあります。

--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 がまだ GA でない場合は、最新のプレビューバージョンを呼び出します。

承認された値: 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

サブスクリプションの名前または ID。 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 アプリのアプリ ID。アプリ ID は、アプリケーションの [バージョン情報] ページのヘルプメニューにあります。

--device-template-id --dtid

ターゲットデバイステンプレートの ID。例: somedevicetemplate。

省略可能のパラメーター

--api-version --av

非推奨

引数 'api_version' は非推奨となり、今後のリリースで削除される予定です。

承認された値: 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

サブスクリプションの名前または ID。 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]

例

アプリケーション内のすべてのデバイステンプレートをテンプレート ID で並べ替え (既定) で一覧表示する

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

必須のパラメーター

--app-id -n

管理する IoT Central アプリのアプリ ID。アプリ ID は、アプリケーションの [バージョン情報] ページのヘルプメニューにあります。

省略可能のパラメーター

--api-version --av

非推奨

引数 'api_version' は非推奨となり、今後のリリースで削除される予定です。

承認された値: 2022-06-30-preview, 2022-07-31

既定値: 2022-07-31

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

アプリケーションに関連付けられている IoT Central DNS サフィックス。

既定値: azureiotcentral.com

--compact -c

コンパクトモードでテンプレートを表示します。テンプレートごとに、ID、名前、モデルの種類のみが表示されます。

既定値: False

--token

グローバルパラメーター

--debug

すべてのデバッグログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 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 アプリのアプリ ID。アプリ ID は、アプリケーションの [バージョン情報] ページのヘルプメニューにあります。

--device-template-id --dtid

ターゲットデバイステンプレートの ID。例: somedevicetemplate。

省略可能のパラメーター

--api-version --av

非推奨

引数 'api_version' は非推奨となり、今後のリリースで削除される予定です。

承認された値: 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

サブスクリプションの名前または ID。 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 アプリのアプリ ID。アプリ ID は、アプリケーションの [バージョン情報] ページのヘルプメニューにあります。

--content -k

--device-template-id --dtid

ターゲットデバイステンプレートの ID。例: somedevicetemplate。

省略可能のパラメーター

--api-version --av

非推奨

引数 'api_version' は非推奨となり、今後のリリースで削除される予定です。

承認された値: 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

サブスクリプションの名前または ID。 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

例

必須のパラメーター

省略可能のパラメーター

その他のリソース