Smart Detector Alert Rules - Patch

Referência

Service:: Monitor

API Version:: 2019-06-01

Aplicar patch a uma regra de alerta específica do Detector Inteligente.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.alertsManagement/smartDetectorAlertRules/{alertRuleName}?api-version=2019-06-01

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
alertRuleName	path	True	string	O nome da regra de alerta.
resourceGroupName	path	True	string	O nome do grupo de recursos.
subscriptionId	path	True	string	A ID da assinatura de destino.
api-version	query	True	string	Versão da API do cliente.

Corpo da solicitação

Nome	Tipo	Description
properties.actionGroups	ActionGroupsInformation	As ações da regra de alerta.
properties.description	string	A descrição da regra de alerta.
properties.frequency	string	A frequência da regra de alerta no formato ISO8601. A granularidade de tempo deve estar em minutos e o valor mínimo é de 5 minutos.
properties.severity	Severity	A gravidade da regra de alerta.
properties.state	AlertRuleState	O estado da regra de alerta.
properties.throttling	ThrottlingInformation	As informações de limitação da regra de alerta.
tags	object	As marcas do recurso.

Respostas

Nome	Tipo	Description
200 OK	AlertRule	Solicitação bem-sucedida para corrigir a regra de alerta do Detector Inteligente.
Other Status Codes	SmartDetectorErrorResponse	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

Patch alert rules

Sample Request

HTTP

PATCH https://management.azure.com/subscriptions/b368ca2f-e298-46b7-b0ab-012281956afa/resourceGroups/MyAlertRules/providers/microsoft.alertsManagement/smartDetectorAlertRules/MyAlertRule?api-version=2019-06-01

{
  "tags": {
    "newKey": "newVal"
  },
  "properties": {
    "description": "New description for patching",
    "frequency": "PT1M"
  }
}

Sample Response

Status code:: 200

{
  "id": "/subscriptions/b368ca2f-e298-46b7-b0ab-012281956afa/resourceGroups/MyAlertRules/providers/microsoft.alertsManagement/smartDetectorAlertRules/MyAlertRule",
  "type": "Microsoft.AlertsManagement/smartDetectorAlertRules",
  "name": "MyAlertRule",
  "location": "global",
  "tags": {
    "newKey": "newVal"
  },
  "properties": {
    "description": "New description for patching",
    "state": "Enabled",
    "severity": "Sev3",
    "frequency": "PT1M",
    "detector": {
      "id": "VMMemoryLeak"
    },
    "scope": [
      "/subscriptions/b368ca2f-e298-46b7-b0ab-012281956afa/resourceGroups/MyVms/providers/Microsoft.Compute/virtualMachines/vm1"
    ],
    "actionGroups": [
      {
        "actionGroupId": "/subscriptions/b368ca2f-e298-46b7-b0ab-012281956afa/resourcegroups/actionGroups/providers/microsoft.insights/actiongroups/MyActionGroup"
      }
    ],
    "throttling": {
      "duration": "PT20M"
    }
  }
}

Definições

Nome	Description
ActionGroupsInformation	As informações de Grupos de Ações, usadas pela regra de alerta.
AlertRule	As informações da regra de alerta
AlertRulePatchObject	As informações de patch da regra de alerta
AlertRuleState	O estado da regra de alerta.
Detector	As informações do detector. Por padrão, isso não é preenchido, a menos que seja especificado em expandDetector
Severity	A gravidade da regra de alerta.
SmartDetectorErrorResponse	Descrever o formato de uma resposta de erro.
ThrottlingInformation	Informações de limitação opcionais para a regra de alerta.

ActionGroupsInformation

As informações de Grupos de Ações, usadas pela regra de alerta.

Nome	Tipo	Description
customEmailSubject	string	Um assunto de email personalizado opcional a ser usado no notificações por email.
customWebhookPayload	string	Um conteúdo de web hook personalizado opcional a ser usado em notificações de web hook.
groupIds	string[]	As IDs de recurso do Grupo de Ações.

AlertRule

As informações da regra de alerta

Nome	Tipo	Valor padrão	Description
id	string		A ID do recurso.
location	string	global	O local do recurso.
name	string		O nome do recurso.
properties.actionGroups	ActionGroupsInformation		As ações da regra de alerta.
properties.description	string		A descrição da regra de alerta.
properties.detector	Detector		O detector da regra de alerta.
properties.frequency	string		A frequência da regra de alerta no formato ISO8601. A granularidade de tempo deve estar em minutos e o valor mínimo é de 5 minutos.
properties.scope	string[]		O escopo dos recursos da regra de alerta.
properties.severity	Severity		A gravidade da regra de alerta.
properties.state	AlertRuleState		O estado da regra de alerta.
properties.throttling	ThrottlingInformation		As informações de limitação da regra de alerta.
tags	object		As marcas do recurso.
type	string		O tipo de recurso.

AlertRulePatchObject

As informações de patch da regra de alerta

Nome	Tipo	Description
id	string	A ID do recurso.
name	string	O nome do recurso.
properties.actionGroups	ActionGroupsInformation	As ações da regra de alerta.
properties.description	string	A descrição da regra de alerta.
properties.frequency	string	A frequência da regra de alerta no formato ISO8601. A granularidade de tempo deve estar em minutos e o valor mínimo é de 5 minutos.
properties.severity	Severity	A gravidade da regra de alerta.
properties.state	AlertRuleState	O estado da regra de alerta.
properties.throttling	ThrottlingInformation	As informações de limitação da regra de alerta.
tags	object	As marcas do recurso.
type	string	O tipo de recurso.

AlertRuleState

O estado da regra de alerta.

Nome	Tipo	Description
Disabled	string
Enabled	string

Detector

As informações do detector. Por padrão, isso não é preenchido, a menos que seja especificado em expandDetector

Nome	Tipo	Description
description	string	A descrição do Detector Inteligente. Por padrão, isso não é preenchido, a menos que seja especificado em expandDetector
id	string	A ID do detector.
imagePaths	string[]	O caminho da imagem do Detector Inteligente. Por padrão, isso não é preenchido, a menos que seja especificado em expandDetector
name	string	O nome do Detector Inteligente. Por padrão, isso não é preenchido, a menos que seja especificado em expandDetector
parameters	object	Os parâmetros do detector.
supportedResourceTypes	string[]	Os tipos de recursos compatíveis com o Detector Inteligente. Por padrão, isso não é preenchido, a menos que seja especificado em expandDetector

Severity

A gravidade da regra de alerta.

Nome	Tipo	Description
Sev0	string
Sev1	string
Sev2	string
Sev3	string
Sev4	string

SmartDetectorErrorResponse

Descrever o formato de uma resposta de erro.

Nome	Tipo	Description
code	string	Código do erro
message	string	Mensagem de erro indicando por que a operação falhou.

ThrottlingInformation

Informações de limitação opcionais para a regra de alerta.

Nome	Tipo	Description
duration	string	A duração necessária (no formato ISO8601) para aguardar antes de notificar a regra de alerta novamente. A granularidade de tempo deve estar em minutos e o valor mínimo é 0 minutos

Share via