az monitor data-collection rule syslog

Note

This reference is part of the monitor-control-service extension for the Azure CLI (version 2.61.0 or higher). 拡張機能は、az monitor data-collection rule syslog コマンドを初めて実行するときに自動的にインストールされます。 Learn more about extensions.

Syslog データ ソースを管理します。

コマンド

名前	説明	型	状態
az monitor data-collection rule syslog add	Syslog データ ソースを追加します。	Extension	GA
az monitor data-collection rule syslog delete	Syslog データ ソースを削除します。	Extension	GA
az monitor data-collection rule syslog list	Syslog データ ソースを一覧表示します。	Extension	GA
az monitor data-collection rule syslog show	Syslog データ ソースを表示します。	Extension	GA
az monitor data-collection rule syslog update	Syslog データ ソースを更新します。	Extension	GA

az monitor data-collection rule syslog add

Syslog データ ソースを追加します。

az monitor data-collection rule syslog add --data-collection-rule-name --rule-name
                                           --name
                                           --resource-group
                                           [--facility-names]
                                           [--log-levels]
                                           [--streams]
                                           [--transform-kql]

例

Syslog データ ソースを追加する

az monitor data-collection rule syslog add --rule-name myCollectionRule --resource-group myResourceGroup --name syslogBase --facility-names syslog --log-levels Alert Critical --streams Microsoft-Syslog

必須のパラメーター

--data-collection-rule-name --rule-name

データ収集規則の名前。 名前では大文字と小文字が区別されません。

--name -n

データ ソースのフレンドリ名。 この名前は、データ収集規則内のすべてのデータ ソース (種類に関係なく) で一意である必要があります。

--resource-group -g

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

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--facility-names

施設名の一覧。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--log-levels

収集するログ レベル。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--streams

このデータ ソースが送信されるストリームの一覧。 ストリームは、このデータに使用されるスキーマと、通常、データの送信先となる Log Analytics のテーブルを示します。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--transform-kql

データ ソースを変換する KQL クエリ。

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--subscription

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False

az monitor data-collection rule syslog delete

Syslog データ ソースを削除します。

az monitor data-collection rule syslog delete --data-collection-rule-name --rule-name
                                              --name
                                              --resource-group

例

Syslog データ ソースを削除する

az monitor data-collection rule syslog delete --rule-name myCollectionRule --resource-group myResourceGroup --name syslogBase

必須のパラメーター

--data-collection-rule-name --rule-name

データ収集規則の名前。 名前では大文字と小文字が区別されません。

--name -n

データ ソースのフレンドリ名。 この名前は、データ収集規則内のすべてのデータ ソース (種類に関係なく) で一意である必要があります。

--resource-group -g

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

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--subscription

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False

az monitor data-collection rule syslog list

Syslog データ ソースを一覧表示します。

az monitor data-collection rule syslog list --data-collection-rule-name --rule-name
                                            --resource-group

例

Syslog データ ソースの一覧表示

az monitor data-collection rule syslog list --rule-name myCollectionRule --resource-group myResourceGroup

必須のパラメーター

--data-collection-rule-name --rule-name

データ収集規則の名前。 名前では大文字と小文字が区別されません。

--resource-group -g

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

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--subscription

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False

az monitor data-collection rule syslog show

Syslog データ ソースを表示します。

az monitor data-collection rule syslog show --data-collection-rule-name --rule-name
                                            --name
                                            --resource-group

例

Syslog データ ソースを表示する

az monitor data-collection rule syslog show --rule-name myCollectionRule --resource-group myResourceGroup --name syslogBase

必須のパラメーター

--data-collection-rule-name --rule-name

データ収集規則の名前。 名前では大文字と小文字が区別されません。

--name -n

データ ソースのフレンドリ名。 この名前は、データ収集規則内のすべてのデータ ソース (種類に関係なく) で一意である必要があります。

--resource-group -g

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

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--subscription

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False

az monitor data-collection rule syslog update

Syslog データ ソースを更新します。

az monitor data-collection rule syslog update --data-collection-rule-name --rule-name
                                              --name
                                              --resource-group
                                              [--add]
                                              [--facility-names]
                                              [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                              [--log-levels]
                                              [--remove]
                                              [--set]
                                              [--streams]
                                              [--transform-kql]

例

Syslog データ ソースを更新する

az monitor data-collection rule syslog update --rule-name myCollectionRule --resource-group myResourceGroup --name syslogBase --facility-names syslog --log-levels Emergency Critical

必須のパラメーター

--data-collection-rule-name --rule-name

データ収集規則の名前。 名前では大文字と小文字が区別されません。

--name -n

データ ソースのフレンドリ名。 この名前は、データ収集規則内のすべてのデータ ソース (種類に関係なく) で一意である必要があります。

--resource-group -g

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

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--add

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

プロパティ	値
Parameter group:	Generic Update Arguments

--facility-names

施設名の一覧。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--force-string

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

プロパティ	値
Parameter group:	Generic Update Arguments
指定可能な値:	0, 1, f, false, n, no, t, true, y, yes

--log-levels

収集するログ レベル。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--remove

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

プロパティ	値
Parameter group:	Generic Update Arguments

--set

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

プロパティ	値
Parameter group:	Generic Update Arguments

--streams

このデータ ソースが送信されるストリームの一覧。 ストリームは、このデータに使用されるスキーマと、通常、データの送信先となる Log Analytics のテーブルを示します。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--transform-kql

データ ソースを変換する KQL クエリ。

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--subscription

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False