az sphere catalog

Note

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

カタログを管理します。

コマンド

名前	説明	型	状態
az sphere catalog create	カタログを作成する。	拡張子	GA
az sphere catalog delete	カタログを削除する。	拡張子	GA
az sphere catalog download-error-report	選択したカタログの使用可能なエラー レポートを一覧表示またはダウンロードします。	拡張子	GA
az sphere catalog list	リソース グループまたはサブスクリプションで使用可能なカタログを一覧表示します。	拡張子	GA
az sphere catalog show	カタログの詳細を表示します。	拡張子	GA

az sphere catalog create

カタログを作成する。

az sphere catalog create --name
                         --resource-group

例

リソース グループ "MyResourceGroup" に新しいカタログ "MyCatalog" を作成します。

az sphere catalog create --resource-group MyResourceGroup --name MyCatalog

必須のパラメーター

--name -n

カタログの名前です。 英数字、アンダースコア、ハイフンを使用でき、30 文字未満にする必要があります。

--resource-group -g

Azure リソース グループの名前。 az config set defaults.group=<name> を使用して、既定のグループを構成できます。 値の由来: az group list。

グローバル パラメーター

--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 sphere catalog delete

カタログを削除する。

az sphere catalog delete --catalog
                         --resource-group

例

リソース グループとカタログ名を使用してカタログを削除します。

az sphere catalog delete --resource-group MyResourceGroup --catalog MyCatalog

必須のパラメーター

--catalog -c

カタログ名。

値の取得元: az sphere catalog list

--resource-group -g

Azure リソース グループの名前。 az config set defaults.group=<name> を使用して、既定のグループを構成できます。 値の由来: az group list。

グローバル パラメーター

--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 sphere catalog download-error-report

選択したカタログの使用可能なエラー レポートを一覧表示またはダウンロードします。

az sphere catalog download-error-report --catalog
                                        --resource-group
                                        [--output-file]

例

リソース グループとカタログ名を使用して、csv ファイルにエラー レポートをダウンロードします。

az sphere catalog download-error-report --resource-group MyResourceGroup --catalog MyCatalog --output-file myErrorReport.csv

必須のパラメーター

--catalog -c

この操作を実行する Azure Sphere カタログ。 Azure Sphere カタログ名を指定します。 を使用して、既定の Azure Sphere カタログを az config set defaults.sphere.catalog=<name>構成できます。 値の由来: az sphere catalog list。

--resource-group -g

Azure リソース グループの名前。 az config set defaults.group=<name> を使用して、既定のグループを構成できます。 値の由来: az group list。

省略可能のパラメーター

--output-file -of

エラー レポート データを含む、作成する新しい csv ファイルへのパス。 相対または絶対パスを指定できます。 このパラメーターが設定されていない場合、ファイルは既定の名前で現在のフォルダーに保存されます。 (パス)。

グローバル パラメーター

--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 sphere catalog list

リソース グループまたはサブスクリプションで使用可能なカタログを一覧表示します。

az sphere catalog list [--all]
                       [--resource-group]

例

リソース グループ内のすべてのカタログを一覧表示します。

az sphere catalog list --resource-group MyResourceGroup

サブスクリプション内のすべてのリソース グループ内のすべてのカタログを一覧表示します。

az sphere catalog list --all

省略可能のパラメーター

--all

サブスクリプション内のすべてのリソース グループ内のすべてのカタログを一覧表示します。

規定値: False

--resource-group -g

Azure リソース グループの名前。 az config set defaults.group=<name> を使用して、既定のグループを構成できます。 値の由来: az group list。

グローバル パラメーター

--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 sphere catalog show

カタログの詳細を表示します。

az sphere catalog show --catalog
                       --resource-group

例

リソース グループとカタログ名を使用して、カタログの詳細を表示します。

az sphere catalog show --resource-group MyResourceGroup --catalog MyCatalog

必須のパラメーター

--catalog -c

カタログ名。

値の取得元: az sphere catalog list

--resource-group -g

Azure リソース グループの名前。 az config set defaults.group=<name> を使用して、既定のグループを構成できます。 値の由来: az group list。

グローバル パラメーター

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