az monitor scheduled-query
Note
This reference is part of the scheduled-query extension for the Azure CLI (version 2.54.0 or higher). 拡張機能は、az monitor scheduled-query コマンド 初めて実行するときに自動的にインストールされます。 Learn more about extensions.
スケジュールされたクエリを管理するコマンド。
コマンド
名前 | 説明 | 型 | 状態 |
---|---|---|---|
az monitor scheduled-query create |
スケジュールされたクエリを作成します。 |
Extension | GA |
az monitor scheduled-query delete |
スケジュールされたクエリを削除します。 |
Extension | GA |
az monitor scheduled-query list |
スケジュールされたすべてのクエリを一覧表示します。 |
Extension | GA |
az monitor scheduled-query show |
スケジュールされたクエリの詳細を表示します。 |
Extension | GA |
az monitor scheduled-query update |
スケジュールされたクエリを更新します。 |
Extension | GA |
az monitor scheduled-query create
スケジュールされたクエリを作成します。
az monitor scheduled-query create --condition
--name
--resource-group
--scopes
[--action-groups]
[--auto-mitigate {false, true}]
[--check-ws-alerts-storage --cwas {false, true}]
[--condition-query]
[--custom-properties]
[--description]
[--disabled {false, true}]
[--evaluation-frequency]
[--___location]
[--mad --mute-actions-duration]
[--severity]
[--skip-query-validation {false, true}]
[--tags]
[--target-resource-type --type]
[--window-size]
例
VM のスケジュールされたクエリを作成します。
az monitor scheduled-query create -g {rg} -n {name1} --scopes {vm_id} --condition "count 'Placeholder_1' > 360 resource id _ResourceId at least 1 violations out of 5 aggregated points" --condition-query Placeholder_1="union Event, Syslog | where TimeGenerated > ago(1h) | where EventLevelName=='Error' or SeverityLevel=='err'" --description "Test rule"
リソース グループ内の VM のスケジュールされたクエリを作成します。
az monitor scheduled-query create -g {rg} -n {name1} --scopes {rg_id} --condition "count 'Placeholder_1' > 360 resource id _ResourceId at least 1 violations out of 5 aggregated points" --condition-query Placeholder_1="union Event, Syslog | where TimeGenerated > ago(1h) | where EventLevelName=='Error' or SeverityLevel=='err'" --description "Test rule"
必須のパラメーター
ルールをトリガーする条件。
使用法: --condition {avg,min,max,total,count} ["METRIC COLUMN" from] "QUERY_PLACEHOLDER" {=,!=,>,>=,<,<=} THRESHOLD [resource id RESOURCEID] [where DIMENSION {includes,excludes} VALUE [or VALUE ...][AND DIMENSION {includes,excludes} VALUE [or VALUE ...] ...]][EvaluationPeriod 集計ポイントから少なくとも MinTimeToFail 違反]' クエリ プレースホルダーは --condition-query 引数で定義できます。"where" キーワードを追加することでディメンションを照会でき、複数のディメンションを 'and' キーワードと組み合わせてクエリできます。
スケジュールされたクエリ ルールの名前。
リソース グループの名前。
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.
アラートが発生したときに呼び出すアクション グループ リソース ID。
使用法: --action-groups ACTION_GROUP_NAME_OR_ID [NAME_OR_ID,...]。
アラートを自動的に解決するかどうかを示すフラグ。 既定値は true です。
プロパティ | 値 |
---|---|
規定値: | True |
指定可能な値: | false, true |
このスケジュールされたクエリ ルールを顧客のストレージに格納するかどうかを示すフラグ。
プロパティ | 値 |
---|---|
規定値: | False |
指定可能な値: | false, true |
引数内のプレースホルダーを置き換えるクエリを実行 --condition
。
アラート ペイロードのプロパティ。
使用法: --custom-properties ALERT_PAYLOAD_PROPERTIES [KEY=VAL,KEY=VAL ...].
ルールの自由テキストの説明。
スケジュールされたクエリを無効にします。
プロパティ | 値 |
---|---|
規定値: | False |
指定可能な値: | false, true |
"##h##m##s" 形式でルールを評価する頻度。
プロパティ | 値 |
---|---|
規定値: | 5m |
Location. 値のソース: az account list-locations
az configure --defaults ___location=<___location>
を使用して、既定の場所を構成できます。
アラートが発生した後、選択した期間 (ISO 8601 期間形式) のアクションをミュートします。
アラートの重大度が 0 (重大) から 4 (詳細) です。
プロパティ | 値 |
---|---|
規定値: | 2 |
指定されたクエリを検証するかどうかを示すフラグ。
プロパティ | 値 |
---|---|
規定値: | False |
指定可能な値: | false, true |
スペース区切りのタグ: key[=value] [key[=value] ...]既存のタグをクリアするには、"" を使用します。
スコープ内のターゲット リソースのリソースの種類。 これは、スコープがリソース グループまたはサブスクリプションである場合に指定する必要があります。
メトリックを "##h##m##s" 形式で集計する時間。
プロパティ | 値 |
---|---|
規定値: | 5m |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
プロパティ | 値 |
---|---|
規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
プロパティ | 値 |
---|---|
規定値: | False |
Output format.
プロパティ | 値 |
---|---|
規定値: | json |
指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
プロパティ | 値 |
---|---|
規定値: | False |
az monitor scheduled-query delete
スケジュールされたクエリを削除します。
az monitor scheduled-query delete [--ids]
[--name]
[--resource-group]
[--subscription]
[--yes]
省略可能のパラメーター
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
スケジュールされたクエリ ルールの名前。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
確認を求めないでください。
プロパティ | 値 |
---|---|
規定値: | False |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
プロパティ | 値 |
---|---|
規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
プロパティ | 値 |
---|---|
規定値: | False |
Output format.
プロパティ | 値 |
---|---|
規定値: | json |
指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
プロパティ | 値 |
---|---|
規定値: | False |
az monitor scheduled-query list
スケジュールされたすべてのクエリを一覧表示します。
az monitor scheduled-query list [--resource-group]
省略可能のパラメーター
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
プロパティ | 値 |
---|---|
規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
プロパティ | 値 |
---|---|
規定値: | False |
Output format.
プロパティ | 値 |
---|---|
規定値: | json |
指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
プロパティ | 値 |
---|---|
規定値: | False |
az monitor scheduled-query show
スケジュールされたクエリの詳細を表示します。
az monitor scheduled-query show [--ids]
[--name]
[--resource-group]
[--subscription]
省略可能のパラメーター
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
スケジュールされたクエリ ルールの名前。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
プロパティ | 値 |
---|---|
規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
プロパティ | 値 |
---|---|
規定値: | False |
Output format.
プロパティ | 値 |
---|---|
規定値: | json |
指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
プロパティ | 値 |
---|---|
規定値: | False |
az monitor scheduled-query update
スケジュールされたクエリを更新します。
az monitor scheduled-query update [--action-groups]
[--add]
[--auto-mitigate {false, true}]
[--check-ws-alerts-storage --cwas {false, true}]
[--condition]
[--condition-query]
[--custom-properties]
[--description]
[--disabled {false, true}]
[--evaluation-frequency]
[--force-string]
[--ids]
[--mad --mute-actions-duration]
[--name]
[--remove]
[--resource-group]
[--set]
[--severity]
[--skip-query-validation {false, true}]
[--subscription]
[--tags]
[--target-resource-type --type]
[--window-size]
省略可能のパラメーター
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
アラートが発生したときに呼び出すアクション グループ リソース ID。
パスとキー値のペアを指定して、オブジェクトの一覧にオブジェクトを追加します。 例: --add property.listProperty <key=value, string or JSON string>
。
プロパティ | 値 |
---|---|
Parameter group: | Generic Update Arguments |
規定値: | [] |
アラートを自動的に解決するかどうかを示すフラグ。 既定値は true です。
プロパティ | 値 |
---|---|
指定可能な値: | false, true |
このスケジュールされたクエリ ルールを顧客のストレージに格納するかどうかを示すフラグ。
プロパティ | 値 |
---|---|
指定可能な値: | false, true |
ルールをトリガーする条件。
使用法: --condition {avg,min,max,total,count} ["METRIC COLUMN" from] "QUERY_PLACEHOLDER" {=,!=,>,>=,<,<=} THRESHOLD [resource id RESOURCEID] [where DIMENSION {includes,excludes} VALUE [or VALUE ...][AND DIMENSION {includes,excludes} VALUE [or VALUE ...] ...]][EvaluationPeriod 集計ポイントから少なくとも MinTimeToFail 違反]'
クエリ プレースホルダーは --condition-query 引数で定義できます。ディメンションは 、'where' キーワードを追加することでクエリできます。また、複数のディメンションを 'and' キーワードと組み合わせてクエリを実行できます。
引数内のプレースホルダーを置き換えるクエリを実行 --condition
。
アラート ペイロードのプロパティ。
使用法: --custom-properties ALERT_PAYLOAD_PROPERTIES [KEY=VAL,KEY=VAL ...].
ルールの自由テキストの説明。
スケジュールされたクエリを無効にします。
プロパティ | 値 |
---|---|
指定可能な値: | false, true |
"##h##m##s" 形式でルールを評価する頻度。
'set' または 'add' を使用する場合は、JSON に変換するのではなく、文字列リテラルを保持します。
プロパティ | 値 |
---|---|
Parameter group: | Generic Update Arguments |
規定値: | False |
1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
アラートが発生した後、選択した期間 (ISO 8601 期間形式) のアクションをミュートします。
スケジュールされたクエリ ルールの名前。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
リストからプロパティまたは要素を削除します。 例: --remove property.list <indexToRemove>
OR --remove propertyToRemove
。
プロパティ | 値 |
---|---|
Parameter group: | Generic Update Arguments |
規定値: | [] |
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
設定するプロパティ パスと値を指定して、オブジェクトを更新します。 例: --set property1.property2=<value>
。
プロパティ | 値 |
---|---|
Parameter group: | Generic Update Arguments |
規定値: | [] |
アラートの重大度が 0 (重大) から 4 (詳細) です。
指定されたクエリを検証するかどうかを示すフラグ。
プロパティ | 値 |
---|---|
指定可能な値: | false, true |
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
スペース区切りのタグ: key[=value] [key[=value] ...]既存のタグをクリアするには、"" を使用します。
スコープ内のターゲット リソースのリソースの種類。 これは、スコープがリソース グループまたはサブスクリプションである場合に指定する必要があります。
メトリックを "##h##m##s" 形式で集計する時間。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
プロパティ | 値 |
---|---|
規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
プロパティ | 値 |
---|---|
規定値: | False |
Output format.
プロパティ | 値 |
---|---|
規定値: | json |
指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
プロパティ | 値 |
---|---|
規定値: | False |