az monitor data-collection rule
Note
このリファレンスは、Azure CLI (バージョン 2.57.0 以降) の monitor-control-service 拡張機能の一部です。 拡張機能は、az monitor data-collection rule コマンドを初めて実行するときに自動的にインストールされます。 拡張機能の詳細をご覧ください。
監視コントロール サービスのデータ収集ルールを管理します。
コマンド
az monitor data-collection rule create
データ収集ルールを作成する。
az monitor data-collection rule create --data-collection-rule-name
--resource-group
[--data-collection-endpoint-id]
[--data-flows]
[--data-sources]
[--description]
[--destinations]
[--identity]
[--kind]
[--location]
[--rule-file]
[--stream-declarations]
[--tags]例
データ収集ルールを作成する
az monitor data-collection rule create --resource-group "myResourceGroup" --location "eastus" --name "myCollectionRule" --rule-file "C:\samples\dcrEx1.json"必須のパラメーター
データ収集規則の名前。 名前の大文字と小文字は区別されます。
リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。
省略可能のパラメーター
関連付けるデータ収集エンドポイントのリソース ID。
データ フローの仕様。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。
データ ソースの仕様。 このプロパティは省略可能であり、ルールがプロビジョニングされたエンドポイントへの直接呼び出しで使用される場合は省略できます。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。
関連付けの説明。
変換先の指定。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。
リソースのマネージド サービス ID。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。
リソースの種類。 Linuxなど、Windows.
リソースが存在する地理的な場所。
ルール パラメーターの json ファイル。 指定した場合、対応するパラメーターはルール ファイルの Usage から値によって上書きされます。--rule-file sample.json rule json ファイルは、json 形式で編成されたルール パラメーターにする必要があります。 以下のように: { "properties": { "destinations": { "azureMonitorMetrics": { "name": "azureMonitorMetrics-default" } }, "dataFlows": [ { "streams": [ "Microsoft-インサイトMetrics" ], "destinations": [ "azureMonitorMetrics-default" } ] } } } }
この規則で使用されるカスタム ストリームの宣言。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。
リソース タグ。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az monitor data-collection rule delete
データ収集ルールを削除します。
az monitor data-collection rule delete [--data-collection-rule-name]
[--ids]
[--resource-group]
[--subscription]
[--yes]例
データ収集ルールを削除する
az monitor data-collection rule delete --name "myCollectionRule" --resource-group "myResourceGroup"省略可能のパラメーター
データ収集規則の名前。 名前の大文字と小文字は区別されます。
1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。
リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。
確認のダイアログを表示しません。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az monitor data-collection rule list
指定したリソース グループ内のすべてのデータ収集規則を一覧表示します。 指定したサブスクリプション内のすべてのデータ収集規則を一覧表示します。
az monitor data-collection rule list [--max-items]
[--next-token]
[--resource-group]例
リソース グループ別にデータ収集ルールを一覧表示する
az monitor data-collection rule list --resource-group "myResourceGroup"サブスクリプション別にデータ収集ルールを一覧表示する
az monitor data-collection rule list省略可能のパラメーター
コマンドの出力で返される項目の合計数。 使用可能な項目の合計数が指定された値を超える場合は、コマンドの出力にトークンが提供されます。 改ページ位置の変更を再開するには、後続のコマンドの引数に --next-token トークン値を指定します。
ページ分割を開始する場所を指定するトークン。 これは、以前に切り捨てられた応答からのトークン値です。
リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az monitor data-collection rule show
指定したデータ収集規則を返します。
az monitor data-collection rule show [--data-collection-rule-name]
[--ids]
[--resource-group]
[--subscription]例
データ収集ルールを取得する
az monitor data-collection rule show --name "myCollectionRule" --resource-group "myResourceGroup"省略可能のパラメーター
データ収集規則の名前。 名前の大文字と小文字は区別されます。
1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。
リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az monitor data-collection rule update
データ収集ルールを更新します。
az monitor data-collection rule update [--add]
[--data-collection-endpoint-id]
[--data-collection-rule-name]
[--data-flows]
[--data-flows-raw]
[--data-sources]
[--description]
[--destinations]
[--extensions]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--identity]
[--ids]
[--kind]
[--log-analytics]
[--monitor-metrics]
[--performance-counters]
[--remove]
[--resource-group]
[--set]
[--stream-declarations]
[--subscription]
[--syslog]
[--tags]
[--windows-event-logs]例
データ収集ルールを更新する
az monitor data-collection rule update --resource-group "myResourceGroup" --name "myCollectionRule" --data-flows destinations="centralWorkspace" streams="Microsoft-Perf" streams="Microsoft-Syslog" streams="Microsoft-WindowsEvent" --log-analytics name="centralWorkspace" resource-id="/subscriptions/703362b3-f278-4e4b-9179- c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.OperationalInsights/workspac es/centralTeamWorkspace" --performance-counters name="appTeamExtraCounters" counter- specifiers="\Process(_Total)\Thread Count" sampling-frequency=30 streams="Microsoft-Perf" --syslog name="cronSyslog" facility-names="cron" log-levels="Debug" log-levels="Critical" log-levels="Emergency" streams="Microsoft-Syslog" --windows-event-logs name="cloudSecurityTeamEvents" streams="Microsoft-WindowsEvent" x-path-queries="Security!"省略可能のパラメーター
パスとキー値のペアを指定して、オブジェクトの一覧にオブジェクトを追加します。 例: --add property.listProperty <key=value、string、または JSON 文字列>。
関連付けるデータ収集エンドポイントのリソース ID。
データ収集規則の名前。 名前の大文字と小文字は区別されます。
データ フローの仕様。 使用法: --data-flows streams=XX1 streams=XX2 destinations=XX1 destinations=XX2 streams: Required。 このデータ フローのストリームの一覧。 destinations: 必須。 このデータ フローの宛先の一覧。 複数の --data-flows 引数を使用して、複数のアクションを指定できます。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。
データ フローの仕様。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。
データ ソースの仕様。 このプロパティは省略可能であり、ルールがプロビジョニングされたエンドポイントへの直接呼び出しで使用される場合は省略できます。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。
関連付けの説明。
変換先の指定。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。
Azure VM 拡張機能のデータ ソース構成の一覧。 予期される値: json-string/@json-file。
'set' または 'add' を使用する場合は、JSON に変換するのではなく、文字列リテラルを保持します。
リソースのマネージド サービス ID。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。
1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。
リソースの種類。 Linuxなど、Windows.
Log Analytics の宛先の一覧。 使用法: --log-analytics resource-id=XX name=XX resource-id: 必須。 Log Analytics ワークスペースのリソース ID。 name:必須。 宛先のフレンドリ名。 この名前は、データ収集規則内のすべての宛先 (種類に関係なく) で一意である必要があります。 複数の --log-analytics 引数を使用して、複数のアクションを指定できます。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。
Azure Monitor メトリックの宛先。 使用法: --monitor-metrics name=XX name: 必須。 宛先のフレンドリ名。 この名前は、データ収集規則内のすべての宛先 (種類に関係なく) で一意である必要があります。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。
パフォーマンス カウンターのデータ ソース構成の一覧。 使用法: --performance-counters streams=XX1 streams=XX2 sampling-frequency=XX counter-specifiers=XX1 counter-specifiers=XX2 name=XX streams: Required。 このデータ ソースが送信されるストリームの一覧。 ストリームは、このデータに使用されるスキーマと、通常、データの送信先となる Log Analytics のテーブルを示します。サンプリング頻度: 必須。 連続するカウンター測定 (サンプル) の間の秒数。 counter-specifiers: 必須。 収集するパフォーマンス カウンターの指定子名の一覧。 すべてのインスタンスのカウンターを収集するには、wildカード (*) を使用します。 Windows でパフォーマンス カウンターの一覧を取得するには、コマンド 'typeperf' を実行します。 name:必須。 データ ソースのフレンドリ名。 この名前は、データ収集規則内のすべてのデータ ソース (種類に関係なく) で一意である必要があります。 複数の --performance-counters 引数を使用して、複数のアクションを指定できます。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。
リストからプロパティまたは要素を削除します。 例: --remove property.list OR --remove propertyToRemove。
リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。
設定するプロパティ パスと値を指定して、オブジェクトを更新します。 例: --set property1.property2=。
この規則で使用されるカスタム ストリームの宣言。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。
Syslog データ ソース構成の一覧。 使用法: --syslog streams=XX1 streams=XX2 facility-names=XX1 facility-names=XX2 log-levels=XX1 log-levels=XX2 name=XX streams: Required。 このデータ ソースが送信されるストリームの一覧。 ストリームは、このデータに使用されるスキーマと、通常、データの送信先となる Log Analytics のテーブルを示します。facility-names: 必須。 施設名の一覧。 log-levels: 収集するログ レベル。 name:必須。 データ ソースのフレンドリ名。 この名前は、データ収集規則内のすべてのデータ ソース (種類に関係なく) で一意である必要があります。 複数の --syslog 引数を使用して、複数のアクションを指定できます。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。
リソース タグ。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。
Windows イベント ログのデータ ソース構成の一覧。 使用法: --windows-event-logs streams=XX1 streams=XX2 x-path-queries=XX1 x-path-queries=XX2 name=XX streams: Required。 このデータ ソースが送信されるストリームの一覧。 ストリームは、このデータに使用されるスキーマと、通常、データの送信先となる Log Analytics のテーブルを示します。x-path-queries: 必須。 XPATH 形式の Windows イベント ログ クエリの一覧。 name:必須。 データ ソースのフレンドリ名。 この名前は、データ収集規則内のすべてのデータ ソース (種類に関係なく) で一意である必要があります。 複数の --windows-event-logs 引数を使用して、複数のアクションを指定できます。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。