Compartilhar via


az alerts-management prometheus-rule-group

Note

Essa referência faz parte da extensão alertsmanagement para a CLI do Azure (versão 2.45.0 ou superior). A extensão instalará automaticamente a primeira vez que você executar um comando az alerts-management prometheus-rule-group comando. Saiba mais sobre extensões.

Gerenciar o Grupo de Regras do Prometheus.

Comandos

Nome Description Tipo Status
az alerts-management prometheus-rule-group create

Crie uma definição de grupo de regras do Prometheus.

Extension GA
az alerts-management prometheus-rule-group delete

Exclua uma definição de grupo de regras do Prometheus.

Extension GA
az alerts-management prometheus-rule-group list

Liste todas as definições de grupo de regras do Prometheus em uma assinatura.

Extension GA
az alerts-management prometheus-rule-group show

Obtenha uma definição de grupo de regras do Prometheus.

Extension GA
az alerts-management prometheus-rule-group update

Atualize uma definição de grupo de regras do Prometheus.

Extension GA

az alerts-management prometheus-rule-group create

Crie uma definição de grupo de regras do 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]

Exemplos

Crie uma definição de grupo de regras do 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"}}]}]

Parâmetros Exigidos

--name -n

O nome do grupo de regras.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--rules

Define as regras no grupo de regras Prometheus. Suporte a sintaxe abreviada, arquivo json e yaml-file. Tente "??" para mostrar mais.

Propriedade Valor
Grupo de parâmetros: Properties Arguments
--scopes

IDs de recurso de workspaces do Azure Monitor de destino. Atualmente, essa versão de API está limitada à criação com um escopo. Isso pode mudar no futuro. Suporte a sintaxe abreviada, arquivo json e yaml-file. Tente "??" para mostrar mais.

Propriedade Valor
Grupo de parâmetros: Properties Arguments

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--cluster-name

Aplicar regra a dados de um cluster específico.

Propriedade Valor
Grupo de parâmetros: Properties Arguments
--description

Descrição do grupo de regras.

Propriedade Valor
Grupo de parâmetros: Properties Arguments
--enabled

Habilitar/desabilitar o grupo de regras.

Propriedade Valor
Grupo de parâmetros: Properties Arguments
Valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--interval

O intervalo no qual executar o grupo de regras Prometheus representado no formato de duração ISO 8601. Deve ser entre 1 e 15 minutos.

Propriedade Valor
Grupo de parâmetros: Properties Arguments
--location -l

A localização geográfica onde o recurso reside Quando não especificado, o local do grupo de recursos será usado.

Propriedade Valor
Grupo de parâmetros: Parameters Arguments
--tags

Tags de recursos. Suporte a sintaxe abreviada, arquivo json e yaml-file. Tente "??" para mostrar mais.

Propriedade Valor
Grupo de parâmetros: Parameters Arguments
Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

az alerts-management prometheus-rule-group delete

Exclua uma definição de grupo de regras do Prometheus.

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

Exemplos

Exclua uma definição de grupo de regras do Prometheus.

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

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de 'ID do recurso'. Você deve fornecer --ids ou outros argumentos de 'ID de recurso'.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--name -n

O nome do grupo de regras.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

az alerts-management prometheus-rule-group list

Liste todas as definições de grupo de regras do Prometheus em uma assinatura.

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

Exemplos

Listar uma definição de grupo de regras do Prometheus.

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

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

az alerts-management prometheus-rule-group show

Obtenha uma definição de grupo de regras do Prometheus.

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

Exemplos

Mostrar uma definição de grupo de regras do Prometheus.

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

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de 'ID do recurso'. Você deve fornecer --ids ou outros argumentos de 'ID de recurso'.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--name -n

O nome do grupo de regras.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

az alerts-management prometheus-rule-group update

Atualize uma definição de grupo de regras do 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]

Exemplos

Atualize uma definição de grupo de regras do Prometheus.

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

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--add

Adicione um objeto a uma lista de objetos especificando um caminho e pares de valor de chave. Exemplo: --add property.listProperty <key=value, string or JSON string>.

Propriedade Valor
Grupo de parâmetros: Generic Update Arguments
--cluster-name

Aplicar regra a dados de um cluster específico.

Propriedade Valor
Grupo de parâmetros: Properties Arguments
--description

Descrição do grupo de regras.

Propriedade Valor
Grupo de parâmetros: Properties Arguments
--enabled

Habilitar/desabilitar o grupo de regras.

Propriedade Valor
Grupo de parâmetros: Properties Arguments
Valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--force-string

Ao usar 'set' ou 'add', preserve literais de cadeia de caracteres em vez de tentar converter em JSON.

Propriedade Valor
Grupo de parâmetros: Generic Update Arguments
Valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de 'ID do recurso'. Você deve fornecer --ids ou outros argumentos de 'ID de recurso'.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--interval

O intervalo no qual executar o grupo de regras Prometheus representado no formato de duração ISO 8601. Deve ser entre 1 e 15 minutos.

Propriedade Valor
Grupo de parâmetros: Properties Arguments
--name -n

O nome do grupo de regras.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--remove

Remova uma propriedade ou um elemento de uma lista. Exemplo: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Propriedade Valor
Grupo de parâmetros: Generic Update Arguments
--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--rules

Define as regras no grupo de regras Prometheus. Suporte a sintaxe abreviada, arquivo json e yaml-file. Tente "??" para mostrar mais.

Propriedade Valor
Grupo de parâmetros: Properties Arguments
--scopes

IDs de recurso de workspaces do Azure Monitor de destino. Atualmente, essa versão de API está limitada à criação com um escopo. Isso pode mudar no futuro. Suporte a sintaxe abreviada, arquivo json e yaml-file. Tente "??" para mostrar mais.

Propriedade Valor
Grupo de parâmetros: Properties Arguments
--set

Atualize um objeto especificando um caminho de propriedade e um valor a ser definido. Exemplo: --set property1.property2=<value>.

Propriedade Valor
Grupo de parâmetros: Generic Update Arguments
--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--tags

Tags de recursos. Suporte a sintaxe abreviada, arquivo json e yaml-file. Tente "??" para mostrar mais.

Propriedade Valor
Grupo de parâmetros: Parameters Arguments
Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False