az alerts-management prometheus-rule-group

Note

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

Prometheus ルール グループを管理します。

コマンド

名前	説明	型	Status
az alerts-management prometheus-rule-group create	Prometheus ルール グループ定義を作成します。	拡張	GA
az alerts-management prometheus-rule-group delete	Prometheus ルール グループ定義を削除します。	拡張	GA
az alerts-management prometheus-rule-group list	サブスクリプション内のすべてのルール グループ定義を一覧表示します。	拡張	GA
az alerts-management prometheus-rule-group show	Prometheus ルール グループ定義を取得します。	拡張	GA
az alerts-management prometheus-rule-group update	Prometheus ルール グループ定義を更新します。	拡張	GA

az alerts-management prometheus-rule-group create

Prometheus ルール グループ定義を作成します。

az alerts-management prometheus-rule-group create --name
                                                  --resource-group
                                                  --rules
                                                  --scopes
                                                  [--cluster-name]
                                                  [--description]
                                                  [--enabled {0, 1, f, false, n, no, t, true, y, yes}]
                                                  [--interval]
                                                  [--location]
                                                  [--tags]

例

Prometheus ルール グループ定義を作成します。

az alerts-management prometheus-rule-group create -n TestPrometheusRuleGroup -g TestResourceGroup -l westus --enabled --description "test" --interval PT10M --scopes "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/testrg/providers/microsoft.monitor/accounts/testaccount" --rules [{"record":"test","expression":"test","labels":{"team":"prod"}},{"alert":"Billing_Processing_Very_Slow","expression":"test","enabled":"true","severity":2,"for":"PT5M","labels":{"team":"prod"},"annotations":{"annotationName1":"annotationValue1"},"resolveConfiguration":{"autoResolved":"true","timeToResolve":"PT10M"},"actions":[{"actionGroupId":"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/microsoft.insights/actionGroups/test-action-group-name1","actionProperties":{"key11":"value11","key12":"value12"}},{"actionGroupId":"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/microsoft.insights/actionGroups/test-action-group-name2","actionProperties":{"key21":"value21","key22":"value22"}}]}]

必須のパラメーター

--name -n

ルール グループの名前。

--resource-group -g

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

--rules

Prometheus ルール グループのルールを定義します。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--scopes

Azure Monitor ワークスペースのリソース ID をターゲットにします。 この API バージョンは現在、1 つのスコープでの作成に制限されています。 これは将来変更される可能性があります。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

省略可能のパラメーター

--cluster-name

特定のクラスターのデータにルールを適用します。

--description

ルール グループの説明。

--enabled

ルール グループを有効または無効にします。

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

--interval

ISO 8601 期間形式で表される Prometheus ルール グループを実行する間隔。 1 ~ 15 分の間にする必要があります。

--location -l

リソースが存在する地理的な場所 を指定しない場合は、リソース グループの場所が使用されます。

--tags

リソース タグ。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

グローバル パラメーター

--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 alerts-management prometheus-rule-group delete

Prometheus ルール グループ定義を削除します。

az alerts-management prometheus-rule-group delete [--ids]
                                                  [--name]
                                                  [--resource-group]
                                                  [--subscription]

例

Prometheus ルール グループ定義を削除します。

az alerts-management prometheus-rule-group delete -n TestPrometheusRuleGroup -g MyResourceGroup

省略可能のパラメーター

--ids

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

--name -n

ルール グループの名前。

--resource-group -g

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

--subscription

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

グローバル パラメーター

--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 alerts-management prometheus-rule-group list

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

az alerts-management prometheus-rule-group list [--resource-group]

例

Prometheus ルール グループ定義を一覧表示します。

az alerts-management prometheus-rule-group list -g MyResourceGroup

省略可能のパラメーター

--resource-group -g

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

グローバル パラメーター

--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 alerts-management prometheus-rule-group show

Prometheus ルール グループ定義を取得します。

az alerts-management prometheus-rule-group show [--ids]
                                                [--name]
                                                [--resource-group]
                                                [--subscription]

例

Prometheus ルール グループ定義を表示します。

az alerts-management prometheus-rule-group show -n TestPrometheusRuleGroup -g MyResourceGroup

省略可能のパラメーター

--ids

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

--name -n

ルール グループの名前。

--resource-group -g

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

--subscription

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

グローバル パラメーター

--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 alerts-management prometheus-rule-group update

Prometheus ルール グループ定義を更新します。

az alerts-management prometheus-rule-group update [--add]
                                                  [--cluster-name]
                                                  [--description]
                                                  [--enabled {0, 1, f, false, n, no, t, true, y, yes}]
                                                  [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                                  [--ids]
                                                  [--interval]
                                                  [--name]
                                                  [--remove]
                                                  [--resource-group]
                                                  [--rules]
                                                  [--scopes]
                                                  [--set]
                                                  [--subscription]
                                                  [--tags]

例

Prometheus ルール グループ定義を更新します。

az alerts-management prometheus-rule-group update -n TestPrometheusRuleGroup -g MyResourceGroup --tags key=value

省略可能のパラメーター

--add

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

--cluster-name

特定のクラスターのデータにルールを適用します。

--description

ルール グループの説明。

--enabled

ルール グループを有効または無効にします。

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

--force-string

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

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

--ids

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

--interval

ISO 8601 期間形式で表される Prometheus ルール グループを実行する間隔。 1 ~ 15 分の間にする必要があります。

--name -n

ルール グループの名前。

--remove

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

--resource-group -g

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

--rules

Prometheus ルール グループのルールを定義します。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--scopes

Azure Monitor ワークスペースのリソース ID をターゲットにします。 この API バージョンは現在、1 つのスコープでの作成に制限されています。 これは将来変更される可能性があります。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--set

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

--subscription

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

--tags

リソース タグ。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

グローバル パラメーター

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