az iot ops schema registry

Note

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

コマンド グループ 'iot ops' はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

スキーマ レジストリの管理。

スキーマ レジストリは、スキーマを管理するための一元化されたリポジトリです。 スキーマ レジストリを使用すると、エッジとクラウドの両方でスキーマの生成と取得が可能になります。 スキーマ定義の信頼できる 1 つのソースを提供することで、システム間の一貫性と互換性を確保します。

コマンド

名前	説明	型	状態
az iot ops schema registry create	スキーマ レジストリを作成する。	拡張子	プレビュー
az iot ops schema registry delete	ターゲット スキーマ レジストリを削除します。	拡張子	プレビュー
az iot ops schema registry list	リソース グループまたはサブスクリプション内のスキーマ レジストリを一覧表示します。	拡張子	プレビュー
az iot ops schema registry show	スキーマ レジストリの詳細を表示します。	拡張子	プレビュー

az iot ops schema registry create

プレビュー

コマンド グループ 'iot ops' はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

スキーマ レジストリを作成する。

この操作により、システム マネージド ID が有効になっているスキーマ レジストリが作成されます。

その後、システム ID に、既定でストレージ アカウント コンテナー スコープに対して組み込みの "ストレージ BLOB データ共同作成者" ロールが割り当てられます。 必要に応じて、代わりに使用する --custom-role-id を使用してカスタム ロールを指定できます。

指定されたストレージ アカウント コンテナーが存在しない場合は、既定の設定で作成されます。

この操作では、Microsoft.DeviceRegistry リソース プロバイダーが登録されていない場合も登録されます。

az iot ops schema registry create --name
                                  --registry-namespace
                                  --resource-group
                                  --sa-resource-id
                                  [--custom-role-id]
                                  [--desc]
                                  [--display-name]
                                  [--location]
                                  [--sa-container]
                                  [--tags]

例

最小入力を使用して、"myregistry" という名前のスキーマ レジストリを作成します。

az iot ops schema registry create -n myregistry -g myresourcegroup --registry-namespace myschemas --sa-resource-id $STORAGE_ACCOUNT_RESOURCE_ID

追加のカスタマイズを使用して、リージョン westus2 に "myregistry" という名前のスキーマ レジストリを作成します。

az iot ops schema registry create -n myregistry -g myresourcegroup --registry-namespace myschemas --sa-resource-id $STORAGE_ACCOUNT_RESOURCE_ID --sa-container myschemacontainer -l westus2 --desc 'Contoso factory X1 schemas' --display-name 'Contoso X1' --tags env=prod

必須のパラメーター

--name -n

スキーマ レジストリ名。

--registry-namespace --rn

スキーマ レジストリ名前空間。 テナント内のスキーマ レジストリを一意に識別します。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--sa-resource-id

スキーマ レジストリで使用するストレージ アカウントリソース ID。

省略可能のパラメーター

--custom-role-id

/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/roleDefinitions/{roleId} の形式の完全修飾ロール定義 ID。

--desc

スキーマ レジストリの説明。

--display-name

スキーマ レジストリの表示名。

--location -l

スキーマ レジストリを作成するリージョン。 場所が指定されていない場合は、リソース グループの場所が使用されます。

--sa-container

スキーマが格納されるストレージ アカウント コンテナー名。

規定値: schemas

--tags

スキーマ レジストリ タグ。 次の形式のキーと値のペアのプロパティ バッグ: a=b c=d。 --tags "" を使用して、すべてのタグを削除します。

グローバル パラメーター

--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 ops schema registry delete

プレビュー

コマンド グループ 'iot ops' はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

ターゲット スキーマ レジストリを削除します。

az iot ops schema registry delete --name
                                  [--resource-group]
                                  [--yes {false, true}]

例

スキーマ レジストリ 'myregistry' を削除します。

az iot ops schema registry delete -n myregistry -g myresourcegroup

必須のパラメーター

--name -n

スキーマ レジストリ名。

省略可能のパラメーター

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--yes -y

プロンプトなしで [y] es を確認します。 CI と自動化のシナリオに役立ちます。

指定可能な値: false, true

グローバル パラメーター

--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 ops schema registry list

プレビュー

コマンド グループ 'iot ops' はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

リソース グループまたはサブスクリプション内のスキーマ レジストリを一覧表示します。

az iot ops schema registry list [--resource-group]

例

リソース グループ 'myresourcegroup' のスキーマ レジスタを一覧表示します。

az iot ops schema registry list -g myresourcegroup

特定のタグに対する既定のサブスクリプション フィルター処理でスキーマ レジスタを一覧表示します。

az iot ops schema registry list --query "[?tags.env == 'prod']"

省略可能のパラメーター

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

グローバル パラメーター

--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 ops schema registry show

プレビュー

コマンド グループ 'iot ops' はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

スキーマ レジストリの詳細を表示します。

az iot ops schema registry show --name
                                --resource-group

例

ターゲット スキーマ レジストリ 'myregistry' の詳細を表示します。

az iot ops schema registry show --name myregistry -g myresourcegroup

必須のパラメーター

--name -n

スキーマ レジストリ名。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

グローバル パラメーター

--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 を使います。