Microsoft.AlertsManagement actionRules
Definição de recursos do bíceps
O tipo de recurso actionRules pode ser implantado com operações que visam:
- Grupos de recursos - Consulte comandos de implantação de grupo de recursos
Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.
Formato do recurso
Para criar um recurso Microsoft.AlertsManagement/actionRules, adicione o seguinte Bíceps ao seu modelo.
resource symbolicname 'Microsoft.AlertsManagement/actionRules@2024-03-01-preview' = {
location: 'string'
name: 'string'
properties: {
actions: [
{
actionType: 'string'
// For remaining properties, see Action objects
}
]
conditions: [
{
field: 'string'
operator: 'string'
values: [
'string'
]
}
]
description: 'string'
enabled: bool
schedule: {
effectiveFrom: 'string'
effectiveUntil: 'string'
recurrences: [
{
endTime: 'string'
startTime: 'string'
recurrenceType: 'string'
// For remaining properties, see Recurrence objects
}
]
timeZone: 'string'
}
scopes: [
'string'
]
}
tags: {
{customized property}: 'string'
}
}
Objetos de ação
Defina a propriedade actionType para especificar o tipo de objeto.
Para AddActionGroups, use:
{
actionGroupIds: [
'string'
]
actionType: 'AddActionGroups'
}
Para CorrelateAlerts , use:
{
actionType: 'CorrelateAlerts'
correlateBy: [
{
field: 'string'
}
]
correlationInterval: 'string'
correlationUpdates: {
actionGroups: [
'string'
]
updateInterval: 'string'
updateType: 'string'
}
notificationsForCorrelatedAlerts: 'string'
priority: int
}
Para RemoveAllActionGroups, use:
{
actionType: 'RemoveAllActionGroups'
}
Objetos de recorrência
Defina a propriedade recurrenceType para especificar o tipo de objeto.
Para diária, utilize:
{
recurrenceType: 'Daily'
}
Para Mensal, utilize:
{
daysOfMonth: [
int
]
recurrenceType: 'Monthly'
}
Para semanal, utilize:
{
daysOfWeek: [
'string'
]
recurrenceType: 'Weekly'
}
Valores de propriedade
Ação
Designação | Descrição | Valor |
---|---|---|
actionType | Defina como 'AddActionGroups' para o tipo AddActionGroups. Defina como 'CorrelateAlerts' para o tipo CorrelateAlerts. Defina como 'RemoveAllActionGroups' para o tipo RemoveAllActionGroups. | 'AddActionGroups' 'CorrelateAlerts' 'RemoveAllActionGroups' (obrigatório) |
AddActionGroups
Designação | Descrição | Valor |
---|---|---|
açãoGroupIds | Lista de IDs do grupo de ações a serem adicionados à regra de processamento de alertas. | string[] (obrigatório) |
actionType | Ação que deve ser aplicada. | 'AddActionGroups' (obrigatório) |
AlertProcessingRuleProperties
Designação | Descrição | Valor |
---|---|---|
ações | Ações a aplicar. | Ação[] (obrigatório) |
condições | Condições em que os alertas serão filtrados. | Condição[] |
Descrição | Descrição da regra de processamento de alertas. | string |
ativado | Indica se a regra de processamento de alerta fornecida está habilitada ou desabilitada. | Bool |
Horário | Agendamento para regra de processamento de alerta. | Horário |
Âmbitos de aplicação | Escopos aos quais a regra de processamento de alertas será aplicada. | string[] (obrigatório) |
Condição
Designação | Descrição | Valor |
---|---|---|
campo | Campo para uma determinada condição. | 'AlertContext' 'AlertRuleId' 'AlertRuleName' 'Descrição' 'MonitorCondition' 'MonitorService' 'Gravidade' 'Tipo de sinal' 'TargetResource' 'TargetResourceGroup' 'TargetResourceType' |
Operador | Operador para uma determinada condição. | «Contém» 'Não contém' 'Iguais' 'NãoIguais' |
valores | Lista de valores a corresponder para uma determinada condição. | string[] |
CorrelateAlerts
Designação | Descrição | Valor |
---|---|---|
actionType | Ação que deve ser aplicada. | 'CorrelateAlerts' (obrigatório) |
correlateBy | A lista de condições para as correlações de alertas. | CorrelateBy[] (obrigatório) |
correlaçãoIntervalo | A duração necessária (em formato ISO8601) para a correlação de alertas. | string (obrigatório) |
correlaçãoAtualizações | Define as atualizações a serem aplicadas para correlação. | CorrelationUpdates |
notificaçõesForCorrelatedAlerts | Indica como lidar com notificações de alertas filho. | 'NotificarSempre' 'SuprimirSempre' |
prioridade | A prioridade desta correlação. | int (obrigatório) |
CorrelateBy
Designação | Descrição | Valor |
---|---|---|
campo | O JPath da propriedade pela qual os alertas devem ser correlacionados. | string |
CorrelaçãoAtualizações
Designação | Descrição | Valor |
---|---|---|
açãoGrupos | As ids do grupo de ação. | string[] (obrigatório) |
updateInterval | O intervalo de atualização para atualizações de notificação no formato ISO8601. | string (obrigatório) |
updateType | O tipo de atualização que precisa ser executada. | 'timeBased' (obrigatório) |
Recorrência Diária
Designação | Descrição | Valor |
---|---|---|
Tipo de recorrência | Especifica quando a recorrência deve ser aplicada. | 'Diariamente' (obrigatório) |
ManagedResourceTags
Designação | Descrição | Valor |
---|
Microsoft.AlertsManagement/actionRules
Designação | Descrição | Valor |
---|---|---|
Localização | Localização do recurso | string (obrigatório) |
Designação | O nome do recurso | string (obrigatório) |
propriedades | Propriedades da regra de processamento de alertas. | AlertProcessingRuleProperties |
Etiquetas | Tags de recursos | Dicionário de nomes e valores de tags. Consulte Tags em modelos |
Recorrência Mensal
Designação | Descrição | Valor |
---|---|---|
diasdeMês | Especifica os valores para o padrão de recorrência mensal. | int[] (obrigatório) |
Tipo de recorrência | Especifica quando a recorrência deve ser aplicada. | 'Mensal' (obrigatório) |
Recorrência
Designação | Descrição | Valor |
---|---|---|
Tempo de Fim | Tempo de fim para a recorrência. | string |
Tipo de recorrência | Defina como 'Daily' para o tipo DailyRecurrence. Defina como 'Mensal' para o tipo MonthlyRecurrence. Defina como 'Semanal' para o tipo WeeklyRecurrence. | 'Diário' 'Mensal' 'Semanal' (obrigatório) |
startTime | Hora de início da recorrência. | string |
RemoveAllActionGroups
Designação | Descrição | Valor |
---|---|---|
actionType | Ação que deve ser aplicada. | 'RemoveAllActionGroups' (obrigatório) |
Horário
Designação | Descrição | Valor |
---|---|---|
eficazDe | Agendamento efetivo a partir do tempo. Date-Time no formato ISO-8601 sem sufixo de fuso horário. | string Restrições: Padrão = ^(?:(\d{4}-\d{2}-\d{2})T(\d{2}:\d{2}:\d{2}(?:\.\d+)?))$ |
eficazAté | Agendamento efetivo até o momento. Date-Time no formato ISO-8601 sem sufixo de fuso horário. | string Restrições: Padrão = ^(?:(\d{4}-\d{2}-\d{2})T(\d{2}:\d{2}:\d{2}(?:\.\d+)?))$ |
Recorrências | Lista de recorrências. | Recorrência[] |
Fuso horário | Fuso horário de agendamento. | string |
Recorrência Semanal
Designação | Descrição | Valor |
---|---|---|
diasdesemana | Especifica os valores para o padrão de recorrência semanal. | Matriz de cadeia de caracteres contendo qualquer uma das: 'Sexta-feira' 'Segunda-feira' 'Sábado' 'Domingo' 'Quinta-feira' 'Terça-feira' 'Quarta-feira' (obrigatório) |
Tipo de recorrência | Especifica quando a recorrência deve ser aplicada. | 'Semanal' (obrigatório) |
Exemplos de início rápido
Os exemplos de início rápido a seguir implantam esse tipo de recurso.
Arquivo Bicep | Descrição |
---|---|
Notificações de instalação para alertas de backup usando o Azure Monitor | Este modelo permite configurar notificações por email para seus cofres dos Serviços de Recuperação usando o Azure Monitor, implantando uma regra de processamento de alertas e um grupo de ações |
Definição de recurso de modelo ARM
O tipo de recurso actionRules pode ser implantado com operações que visam:
- Grupos de recursos - Consulte comandos de implantação de grupo de recursos
Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.
Formato do recurso
Para criar um recurso Microsoft.AlertsManagement/actionRules, adicione o seguinte JSON ao seu modelo.
{
"type": "Microsoft.AlertsManagement/actionRules",
"apiVersion": "2024-03-01-preview",
"name": "string",
"location": "string",
"properties": {
"actions": [ {
"actionType": "string"
// For remaining properties, see Action objects
} ],
"conditions": [
{
"field": "string",
"operator": "string",
"values": [ "string" ]
}
],
"description": "string",
"enabled": "bool",
"schedule": {
"effectiveFrom": "string",
"effectiveUntil": "string",
"recurrences": [ {
"endTime": "string",
"startTime": "string",
"recurrenceType": "string"
// For remaining properties, see Recurrence objects
} ],
"timeZone": "string"
},
"scopes": [ "string" ]
},
"tags": {
"{customized property}": "string"
}
}
Objetos de ação
Defina a propriedade actionType para especificar o tipo de objeto.
Para AddActionGroups, use:
{
"actionGroupIds": [ "string" ],
"actionType": "AddActionGroups"
}
Para CorrelateAlerts , use:
{
"actionType": "CorrelateAlerts",
"correlateBy": [
{
"field": "string"
}
],
"correlationInterval": "string",
"correlationUpdates": {
"actionGroups": [ "string" ],
"updateInterval": "string",
"updateType": "string"
},
"notificationsForCorrelatedAlerts": "string",
"priority": "int"
}
Para RemoveAllActionGroups, use:
{
"actionType": "RemoveAllActionGroups"
}
Objetos de recorrência
Defina a propriedade recurrenceType para especificar o tipo de objeto.
Para diária, utilize:
{
"recurrenceType": "Daily"
}
Para Mensal, utilize:
{
"daysOfMonth": [ "int" ],
"recurrenceType": "Monthly"
}
Para semanal, utilize:
{
"daysOfWeek": [ "string" ],
"recurrenceType": "Weekly"
}
Valores de propriedade
Ação
Designação | Descrição | Valor |
---|---|---|
actionType | Defina como 'AddActionGroups' para o tipo AddActionGroups. Defina como 'CorrelateAlerts' para o tipo CorrelateAlerts. Defina como 'RemoveAllActionGroups' para o tipo RemoveAllActionGroups. | 'AddActionGroups' 'CorrelateAlerts' 'RemoveAllActionGroups' (obrigatório) |
AddActionGroups
Designação | Descrição | Valor |
---|---|---|
açãoGroupIds | Lista de IDs do grupo de ações a serem adicionados à regra de processamento de alertas. | string[] (obrigatório) |
actionType | Ação que deve ser aplicada. | 'AddActionGroups' (obrigatório) |
AlertProcessingRuleProperties
Designação | Descrição | Valor |
---|---|---|
ações | Ações a aplicar. | Ação[] (obrigatório) |
condições | Condições em que os alertas serão filtrados. | Condição[] |
Descrição | Descrição da regra de processamento de alertas. | string |
ativado | Indica se a regra de processamento de alerta fornecida está habilitada ou desabilitada. | Bool |
Horário | Agendamento para regra de processamento de alerta. | Horário |
Âmbitos de aplicação | Escopos aos quais a regra de processamento de alertas será aplicada. | string[] (obrigatório) |
Condição
Designação | Descrição | Valor |
---|---|---|
campo | Campo para uma determinada condição. | 'AlertContext' 'AlertRuleId' 'AlertRuleName' 'Descrição' 'MonitorCondition' 'MonitorService' 'Gravidade' 'Tipo de sinal' 'TargetResource' 'TargetResourceGroup' 'TargetResourceType' |
Operador | Operador para uma determinada condição. | «Contém» 'Não contém' 'Iguais' 'NãoIguais' |
valores | Lista de valores a corresponder para uma determinada condição. | string[] |
CorrelateAlerts
Designação | Descrição | Valor |
---|---|---|
actionType | Ação que deve ser aplicada. | 'CorrelateAlerts' (obrigatório) |
correlateBy | A lista de condições para as correlações de alertas. | CorrelateBy[] (obrigatório) |
correlaçãoIntervalo | A duração necessária (em formato ISO8601) para a correlação de alertas. | string (obrigatório) |
correlaçãoAtualizações | Define as atualizações a serem aplicadas para correlação. | CorrelationUpdates |
notificaçõesForCorrelatedAlerts | Indica como lidar com notificações de alertas filho. | 'NotificarSempre' 'SuprimirSempre' |
prioridade | A prioridade desta correlação. | int (obrigatório) |
CorrelateBy
Designação | Descrição | Valor |
---|---|---|
campo | O JPath da propriedade pela qual os alertas devem ser correlacionados. | string |
CorrelaçãoAtualizações
Designação | Descrição | Valor |
---|---|---|
açãoGrupos | As ids do grupo de ação. | string[] (obrigatório) |
updateInterval | O intervalo de atualização para atualizações de notificação no formato ISO8601. | string (obrigatório) |
updateType | O tipo de atualização que precisa ser executada. | 'timeBased' (obrigatório) |
Recorrência Diária
Designação | Descrição | Valor |
---|---|---|
Tipo de recorrência | Especifica quando a recorrência deve ser aplicada. | 'Diariamente' (obrigatório) |
ManagedResourceTags
Designação | Descrição | Valor |
---|
Microsoft.AlertsManagement/actionRules
Designação | Descrição | Valor |
---|---|---|
apiVersion | A versão api | '2024-03-01-pré-visualização' |
Localização | Localização do recurso | string (obrigatório) |
Designação | O nome do recurso | string (obrigatório) |
propriedades | Propriedades da regra de processamento de alertas. | AlertProcessingRuleProperties |
Etiquetas | Tags de recursos | Dicionário de nomes e valores de tags. Consulte Tags em modelos |
tipo | O tipo de recurso | 'Microsoft.AlertsManagement/actionRules' |
Recorrência Mensal
Designação | Descrição | Valor |
---|---|---|
diasdeMês | Especifica os valores para o padrão de recorrência mensal. | int[] (obrigatório) |
Tipo de recorrência | Especifica quando a recorrência deve ser aplicada. | 'Mensal' (obrigatório) |
Recorrência
Designação | Descrição | Valor |
---|---|---|
Tempo de Fim | Tempo de fim para a recorrência. | string |
Tipo de recorrência | Defina como 'Daily' para o tipo DailyRecurrence. Defina como 'Mensal' para o tipo MonthlyRecurrence. Defina como 'Semanal' para o tipo WeeklyRecurrence. | 'Diário' 'Mensal' 'Semanal' (obrigatório) |
startTime | Hora de início da recorrência. | string |
RemoveAllActionGroups
Designação | Descrição | Valor |
---|---|---|
actionType | Ação que deve ser aplicada. | 'RemoveAllActionGroups' (obrigatório) |
Horário
Designação | Descrição | Valor |
---|---|---|
eficazDe | Agendamento efetivo a partir do tempo. Date-Time no formato ISO-8601 sem sufixo de fuso horário. | string Restrições: Padrão = ^(?:(\d{4}-\d{2}-\d{2})T(\d{2}:\d{2}:\d{2}(?:\.\d+)?))$ |
eficazAté | Agendamento efetivo até o momento. Date-Time no formato ISO-8601 sem sufixo de fuso horário. | string Restrições: Padrão = ^(?:(\d{4}-\d{2}-\d{2})T(\d{2}:\d{2}:\d{2}(?:\.\d+)?))$ |
Recorrências | Lista de recorrências. | Recorrência[] |
Fuso horário | Fuso horário de agendamento. | string |
Recorrência Semanal
Designação | Descrição | Valor |
---|---|---|
diasdesemana | Especifica os valores para o padrão de recorrência semanal. | Matriz de cadeia de caracteres contendo qualquer uma das: 'Sexta-feira' 'Segunda-feira' 'Sábado' 'Domingo' 'Quinta-feira' 'Terça-feira' 'Quarta-feira' (obrigatório) |
Tipo de recorrência | Especifica quando a recorrência deve ser aplicada. | 'Semanal' (obrigatório) |
Modelos de início rápido
Os modelos de início rápido a seguir implantam esse tipo de recurso.
Modelo | Descrição |
---|---|
Notificações de instalação para alertas de backup usando o Azure Monitor |
Este modelo permite configurar notificações por email para seus cofres dos Serviços de Recuperação usando o Azure Monitor, implantando uma regra de processamento de alertas e um grupo de ações |
Definição de recursos Terraform (provedor AzAPI)
O tipo de recurso actionRules pode ser implantado com operações que visam:
- Grupos de recursos
Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.
Formato do recurso
Para criar um recurso Microsoft.AlertsManagement/actionRules, adicione o seguinte Terraform ao seu modelo.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.AlertsManagement/actionRules@2024-03-01-preview"
name = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
actions = [
{
actionType = "string"
// For remaining properties, see Action objects
}
]
conditions = [
{
field = "string"
operator = "string"
values = [
"string"
]
}
]
description = "string"
enabled = bool
schedule = {
effectiveFrom = "string"
effectiveUntil = "string"
recurrences = [
{
endTime = "string"
startTime = "string"
recurrenceType = "string"
// For remaining properties, see Recurrence objects
}
]
timeZone = "string"
}
scopes = [
"string"
]
}
})
}
Objetos de ação
Defina a propriedade actionType para especificar o tipo de objeto.
Para AddActionGroups, use:
{
actionGroupIds = [
"string"
]
actionType = "AddActionGroups"
}
Para CorrelateAlerts , use:
{
actionType = "CorrelateAlerts"
correlateBy = [
{
field = "string"
}
]
correlationInterval = "string"
correlationUpdates = {
actionGroups = [
"string"
]
updateInterval = "string"
updateType = "string"
}
notificationsForCorrelatedAlerts = "string"
priority = int
}
Para RemoveAllActionGroups, use:
{
actionType = "RemoveAllActionGroups"
}
Objetos de recorrência
Defina a propriedade recurrenceType para especificar o tipo de objeto.
Para diária, utilize:
{
recurrenceType = "Daily"
}
Para Mensal, utilize:
{
daysOfMonth = [
int
]
recurrenceType = "Monthly"
}
Para semanal, utilize:
{
daysOfWeek = [
"string"
]
recurrenceType = "Weekly"
}
Valores de propriedade
Ação
Designação | Descrição | Valor |
---|---|---|
actionType | Defina como 'AddActionGroups' para o tipo AddActionGroups. Defina como 'CorrelateAlerts' para o tipo CorrelateAlerts. Defina como 'RemoveAllActionGroups' para o tipo RemoveAllActionGroups. | 'AddActionGroups' 'CorrelateAlerts' 'RemoveAllActionGroups' (obrigatório) |
AddActionGroups
Designação | Descrição | Valor |
---|---|---|
açãoGroupIds | Lista de IDs do grupo de ações a serem adicionados à regra de processamento de alertas. | string[] (obrigatório) |
actionType | Ação que deve ser aplicada. | 'AddActionGroups' (obrigatório) |
AlertProcessingRuleProperties
Designação | Descrição | Valor |
---|---|---|
ações | Ações a aplicar. | Ação[] (obrigatório) |
condições | Condições em que os alertas serão filtrados. | Condição[] |
Descrição | Descrição da regra de processamento de alertas. | string |
ativado | Indica se a regra de processamento de alerta fornecida está habilitada ou desabilitada. | Bool |
Horário | Agendamento para regra de processamento de alerta. | Horário |
Âmbitos de aplicação | Escopos aos quais a regra de processamento de alertas será aplicada. | string[] (obrigatório) |
Condição
Designação | Descrição | Valor |
---|---|---|
campo | Campo para uma determinada condição. | 'AlertContext' 'AlertRuleId' 'AlertRuleName' 'Descrição' 'MonitorCondition' 'MonitorService' 'Gravidade' 'Tipo de sinal' 'TargetResource' 'TargetResourceGroup' 'TargetResourceType' |
Operador | Operador para uma determinada condição. | «Contém» 'Não contém' 'Iguais' 'NãoIguais' |
valores | Lista de valores a corresponder para uma determinada condição. | string[] |
CorrelateAlerts
Designação | Descrição | Valor |
---|---|---|
actionType | Ação que deve ser aplicada. | 'CorrelateAlerts' (obrigatório) |
correlateBy | A lista de condições para as correlações de alertas. | CorrelateBy[] (obrigatório) |
correlaçãoIntervalo | A duração necessária (em formato ISO8601) para a correlação de alertas. | string (obrigatório) |
correlaçãoAtualizações | Define as atualizações a serem aplicadas para correlação. | CorrelationUpdates |
notificaçõesForCorrelatedAlerts | Indica como lidar com notificações de alertas filho. | 'NotificarSempre' 'SuprimirSempre' |
prioridade | A prioridade desta correlação. | int (obrigatório) |
CorrelateBy
Designação | Descrição | Valor |
---|---|---|
campo | O JPath da propriedade pela qual os alertas devem ser correlacionados. | string |
CorrelaçãoAtualizações
Designação | Descrição | Valor |
---|---|---|
açãoGrupos | As ids do grupo de ação. | string[] (obrigatório) |
updateInterval | O intervalo de atualização para atualizações de notificação no formato ISO8601. | string (obrigatório) |
updateType | O tipo de atualização que precisa ser executada. | 'timeBased' (obrigatório) |
Recorrência Diária
Designação | Descrição | Valor |
---|---|---|
Tipo de recorrência | Especifica quando a recorrência deve ser aplicada. | 'Diariamente' (obrigatório) |
ManagedResourceTags
Designação | Descrição | Valor |
---|
Microsoft.AlertsManagement/actionRules
Recorrência Mensal
Designação | Descrição | Valor |
---|---|---|
diasdeMês | Especifica os valores para o padrão de recorrência mensal. | int[] (obrigatório) |
Tipo de recorrência | Especifica quando a recorrência deve ser aplicada. | 'Mensal' (obrigatório) |
Recorrência
Designação | Descrição | Valor |
---|---|---|
Tempo de Fim | Tempo de fim para a recorrência. | string |
Tipo de recorrência | Defina como 'Daily' para o tipo DailyRecurrence. Defina como 'Mensal' para o tipo MonthlyRecurrence. Defina como 'Semanal' para o tipo WeeklyRecurrence. | 'Diário' 'Mensal' 'Semanal' (obrigatório) |
startTime | Hora de início da recorrência. | string |
RemoveAllActionGroups
Designação | Descrição | Valor |
---|---|---|
actionType | Ação que deve ser aplicada. | 'RemoveAllActionGroups' (obrigatório) |
Horário
Designação | Descrição | Valor |
---|---|---|
eficazDe | Agendamento efetivo a partir do tempo. Date-Time no formato ISO-8601 sem sufixo de fuso horário. | string Restrições: Padrão = ^(?:(\d{4}-\d{2}-\d{2})T(\d{2}:\d{2}:\d{2}(?:\.\d+)?))$ |
eficazAté | Agendamento efetivo até o momento. Date-Time no formato ISO-8601 sem sufixo de fuso horário. | string Restrições: Padrão = ^(?:(\d{4}-\d{2}-\d{2})T(\d{2}:\d{2}:\d{2}(?:\.\d+)?))$ |
Recorrências | Lista de recorrências. | Recorrência[] |
Fuso horário | Fuso horário de agendamento. | string |
Recorrência Semanal
Designação | Descrição | Valor |
---|---|---|
diasdesemana | Especifica os valores para o padrão de recorrência semanal. | Matriz de cadeia de caracteres contendo qualquer uma das: 'Sexta-feira' 'Segunda-feira' 'Sábado' 'Domingo' 'Quinta-feira' 'Terça-feira' 'Quarta-feira' (obrigatório) |
Tipo de recorrência | Especifica quando a recorrência deve ser aplicada. | 'Semanal' (obrigatório) |