az sentinel metadata

Note

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

Sentinel を使用してメタデータを管理します。

コマンド

名前	説明	型	Status
az sentinel metadata create	メタデータを作成します。	拡張	Experimental
az sentinel metadata delete	メタデータを削除します。	拡張	Experimental
az sentinel metadata list	すべてのメタデータの一覧。	拡張	Experimental
az sentinel metadata show	メタデータを取得します。	拡張	Experimental
az sentinel metadata update	メタデータを更新します。	拡張	Experimental

az sentinel metadata create

実験用

このコマンドは試験段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

メタデータを作成します。

az sentinel metadata create --metadata-name
                            --resource-group
                            --workspace-name
                            [--author]
                            [--categories]
                            [--content-id]
                            [--content-schema-version]
                            [--custom-version]
                            [--dependencies]
                            [--etag]
                            [--first-publish-date]
                            [--icon]
                            [--kind {AnalyticsRule, AnalyticsRuleTemplate, AutomationRule, AzureFunction, DataConnector, DataType, HuntingQuery, InvestigationQuery, LogicAppsCustomConnector, Parser, Playbook, PlaybookTemplate, Solution, Watchlist, WatchlistTemplate, Workbook, WorkbookTemplate}]
                            [--last-publish-date]
                            [--parent-id]
                            [--preview-images]
                            [--preview-images-dark]
                            [--providers]
                            [--source]
                            [--support]
                            [--threat-tactics]
                            [--threat-techniques]
                            [--version]

必須のパラメーター

--metadata-name --name -n

メタデータ名。

--resource-group -g

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

--workspace-name -w

実験用

ワークスペースの名前。

省略可能のパラメーター

--author

コンテンツ アイテムの作成者。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--categories

ソリューション コンテンツ項目のカテゴリは、短縮構文、json ファイル、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--content-id

コンテンツの静的 ID。 ソリューションまたはコミュニティからの依存関係とコンテンツを識別するために使用されます。 すぐに使用するコンテンツとソリューション用にハードコーディング/静的。 ユーザーが作成した場合は動的。 これはリソース名です。

--content-schema-version

コンテンツのスキーマ バージョン。 スキーマのバージョンに基づいて異なるフローを区別するために使用できます。

--custom-version

コンテンツのカスタム バージョン。 省略可能なフリー テキスト。

--dependencies

コンテンツ アイテムの依存関係。動作するために必要なその他のコンテンツ 項目。 再帰/入れ子構造を使用して、より複雑な依存関係を記述できます。 単一の依存関係の場合、id/kind/version を指定するか、複雑な形式の演算子/条件を指定できます。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--etag

Azure リソースの Etag。

--first-publish-date

最初の発行日ソリューション コンテンツ 項目。

--icon

アイコン識別子。 この ID は、後でソリューション テンプレートからフェッチできます。

--kind

メタデータの対象となるコンテンツの種類。

承認された値: AnalyticsRule, AnalyticsRuleTemplate, AutomationRule, AzureFunction, DataConnector, DataType, HuntingQuery, InvestigationQuery, LogicAppsCustomConnector, Parser, Playbook, PlaybookTemplate, Solution, Watchlist, WatchlistTemplate, Workbook, WorkbookTemplate

--last-publish-date

ソリューション コンテンツ アイテムの最終発行日。

--parent-id

メタデータの対象となるコンテンツ アイテムの完全な親リソース ID。 これは、スコープ (サブスクリプションとリソース グループ) を含む完全なリソース ID です。

--preview-images

イメージ ファイル名をプレビューします。 これらは、ソリューション成果物から取得されます。短縮構文、json ファイル、yaml-file がサポートされます。 詳細を表示するには、"??" を試してください。

--preview-images-dark

イメージ ファイル名をプレビューします。 これらはソリューション成果物から取得されます。 ダーク テーマのサポートに使用される短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--providers

ソリューション コンテンツ項目のプロバイダーは、短縮構文、json ファイル、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--source

コンテンツのソース。 これが作成された場所/方法です。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--support

メタデータのサポート情報 - 型、名前、連絡先情報 サポート短縮構文、json ファイル、yaml-file。 詳細を表示するには、"??" を試してください。

--threat-tactics

このリソースの戦術では、サポートの短縮構文、json-file、yaml-file について説明します。 詳細を表示するには、"??" を試してください。

--threat-techniques

リソースがカバーする手法は、短縮構文、json ファイル、yaml-file をサポートするために使用されている戦術に合わせる必要があります。 詳細を表示するには、"??" を試してください。

--version

コンテンツのバージョン。 ARM テンプレートのベスト プラクティスに従って、既定で推奨される形式は数値 (1、1.0、1.0.0、1.0.0、1.0.0 など) です。 任意の文字列を指定することもできますが、バージョンチェックを保証することはできません。

グローバル パラメーター

--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 sentinel metadata delete

実験用

このコマンドは試験段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

メタデータを削除します。

az sentinel metadata delete [--ids]
                            [--metadata-name]
                            [--resource-group]
                            [--subscription]
                            [--workspace-name]
                            [--yes]

省略可能のパラメーター

--ids

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--metadata-name --name -n

メタデータ名。

--resource-group -g

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

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--workspace-name -w

実験用

ワークスペースの名前。

--yes -y

確認のダイアログを表示しません。

既定値: False

グローバル パラメーター

--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 sentinel metadata list

実験用

このコマンドは試験段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

すべてのメタデータの一覧。

az sentinel metadata list --resource-group
                          --workspace-name
                          [--filter]
                          [--orderby]
                          [--skip]
                          [--top]

必須のパラメーター

--resource-group -g

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

--workspace-name -w

実験用

ワークスペースの名前。

省略可能のパラメーター

--filter

ブール条件に基づいて結果をフィルターします。 オプション。

--orderby

結果を並べ替えます。 オプション。

--skip

OData クエリ (オフセット) の n 個の要素をスキップするために使用されます。 残っている場合は、結果の次のページに nextLink を返します。

--top

最初の n 件の結果のみを返します。 オプション。

グローバル パラメーター

--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 sentinel metadata show

実験用

このコマンドは試験段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

メタデータを取得します。

az sentinel metadata show [--ids]
                          [--metadata-name]
                          [--resource-group]
                          [--subscription]
                          [--workspace-name]

省略可能のパラメーター

--ids

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--metadata-name --name -n

メタデータ名。

--resource-group -g

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

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--workspace-name -w

実験用

ワークスペースの名前。

グローバル パラメーター

--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 sentinel metadata update

実験用

このコマンドは試験段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

メタデータを更新します。

az sentinel metadata update [--add]
                            [--author]
                            [--categories]
                            [--content-id]
                            [--content-schema-version]
                            [--custom-version]
                            [--dependencies]
                            [--etag]
                            [--first-publish-date]
                            [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                            [--icon]
                            [--ids]
                            [--kind {AnalyticsRule, AnalyticsRuleTemplate, AutomationRule, AzureFunction, DataConnector, DataType, HuntingQuery, InvestigationQuery, LogicAppsCustomConnector, Parser, Playbook, PlaybookTemplate, Solution, Watchlist, WatchlistTemplate, Workbook, WorkbookTemplate}]
                            [--last-publish-date]
                            [--metadata-name]
                            [--parent-id]
                            [--preview-images]
                            [--preview-images-dark]
                            [--providers]
                            [--remove]
                            [--resource-group]
                            [--set]
                            [--source]
                            [--subscription]
                            [--support]
                            [--threat-tactics]
                            [--threat-techniques]
                            [--version]
                            [--workspace-name]

省略可能のパラメーター

--add

パスとキー値のペアを指定して、オブジェクトの一覧にオブジェクトを追加します。 例: --add property.listProperty <key=value、string、または JSON 文字列>。

--author

コンテンツ アイテムの作成者。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--categories

ソリューション コンテンツ項目のカテゴリは、短縮構文、json ファイル、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--content-id

コンテンツの静的 ID。 ソリューションまたはコミュニティからの依存関係とコンテンツを識別するために使用されます。 すぐに使用するコンテンツとソリューション用にハードコーディング/静的。 ユーザーが作成した場合は動的。 これはリソース名です。

--content-schema-version

コンテンツのスキーマ バージョン。 スキーマのバージョンに基づいて異なるフローを区別するために使用できます。

--custom-version

コンテンツのカスタム バージョン。 省略可能なフリー テキスト。

--dependencies

コンテンツ アイテムの依存関係。動作するために必要なその他のコンテンツ 項目。 再帰/入れ子構造を使用して、より複雑な依存関係を記述できます。 単一の依存関係の場合、id/kind/version を指定するか、複雑な形式の演算子/条件を指定できます。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--etag

Azure リソースの Etag。

--first-publish-date

最初の発行日ソリューション コンテンツ 項目。

--force-string

'set' または 'add' を使用する場合は、JSON に変換するのではなく、文字列リテラルを保持します。

承認された値: 0, 1, f, false, n, no, t, true, y, yes

--icon

アイコン識別子。 この ID は、後でソリューション テンプレートからフェッチできます。

--ids

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--kind

メタデータの対象となるコンテンツの種類。

承認された値: AnalyticsRule, AnalyticsRuleTemplate, AutomationRule, AzureFunction, DataConnector, DataType, HuntingQuery, InvestigationQuery, LogicAppsCustomConnector, Parser, Playbook, PlaybookTemplate, Solution, Watchlist, WatchlistTemplate, Workbook, WorkbookTemplate

--last-publish-date

ソリューション コンテンツ アイテムの最終発行日。

--metadata-name --name -n

メタデータ名。

--parent-id

メタデータの対象となるコンテンツ アイテムの完全な親リソース ID。 これは、スコープ (サブスクリプションとリソース グループ) を含む完全なリソース ID です。

--preview-images

イメージ ファイル名をプレビューします。 これらは、ソリューション成果物から取得されます。短縮構文、json ファイル、yaml-file がサポートされます。 詳細を表示するには、"??" を試してください。

--preview-images-dark

イメージ ファイル名をプレビューします。 これらはソリューション成果物から取得されます。 ダーク テーマのサポートに使用される短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--providers

ソリューション コンテンツ項目のプロバイダーは、短縮構文、json ファイル、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--remove

リストからプロパティまたは要素を削除します。 例: --remove property.list OR --remove propertyToRemove。

--resource-group -g

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

--set

設定するプロパティ パスと値を指定して、オブジェクトを更新します。 例: --set property1.property2=。

--source

コンテンツのソース。 これが作成された場所/方法です。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--support

メタデータのサポート情報 - 型、名前、連絡先情報 サポート短縮構文、json ファイル、yaml-file。 詳細を表示するには、"??" を試してください。

--threat-tactics

このリソースの戦術では、サポートの短縮構文、json-file、yaml-file について説明します。 詳細を表示するには、"??" を試してください。

--threat-techniques

リソースがカバーする手法は、短縮構文、json ファイル、yaml-file をサポートするために使用されている戦術に合わせる必要があります。 詳細を表示するには、"??" を試してください。

--version

コンテンツのバージョン。 ARM テンプレートのベスト プラクティスに従って、既定で推奨される形式は数値 (1、1.0、1.0.0、1.0.0、1.0.0 など) です。 任意の文字列を指定することもできますが、バージョンチェックを保証することはできません。

--workspace-name -w

実験用

ワークスペースの名前。

グローバル パラメーター

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