Condividi tramite

Alert Rules - Create Or Update

  • Riferimento
Servizio:
Monitor
Versione API:
2016-03-01

Crea o aggiorna una regola di avviso della metrica classica.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Insights/alertrules/{ruleName}?api-version=2016-03-01

Parametri dell'URI

Nome In Necessario Tipo Descrizione
resourceGroupName
 path True

string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.
ruleName
 path True

string

Nome della regola.
subscriptionId
 path True

string

ID della sottoscrizione di destinazione.
api-version
 query True

string

Versione dell'API da usare per questa operazione.

Corpo della richiesta

Nome Necessario Tipo Descrizione
location True

string

Posizione risorsa
properties.condition True RuleCondition:

condizione che determina l'attivazione della regola di avviso.
properties.isEnabled True

boolean

flag che indica se la regola di avviso è abilitata.
properties.name True

string

nome della regola di avviso.
properties.action RuleAction:

azione eseguita quando la regola di avviso diventa attiva e quando viene risolta una condizione di avviso.
properties.actions RuleAction[]:

matrice di azioni eseguite quando la regola di avviso diventa attiva e quando viene risolta una condizione di avviso.
properties.description

string

descrizione della regola di avviso che verrà inclusa nel messaggio di posta elettronica dell'avviso.
properties.provisioningState

string

stato del provisioning.
tags

object

Tag delle risorse

Risposte

Nome Tipo Descrizione
200 OK

AlertRuleResource

Richiesta riuscita per aggiornare una regola di avviso
201 Created

AlertRuleResource

Regola di avviso creata
Other Status Codes

ErrorResponse

Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome Descrizione
user_impersonation rappresentare l'account utente

Esempio

Create or update an alert rule

Esempio di richiesta

PUT https://management.azure.com/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourcegroups/Rac46PostSwapRG/providers/Microsoft.Insights/alertrules/chiricutin?api-version=2016-03-01

{
  "location": "West US",
  "tags": {},
  "properties": {
    "name": "chiricutin",
    "description": "Pura Vida",
    "isEnabled": true,
    "condition": {
      "odata.type": "Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition",
      "dataSource": {
        "odata.type": "Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource",
        "resourceUri": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/leoalerttest",
        "metricName": "Requests"
      },
      "operator": "GreaterThan",
      "threshold": 3,
      "windowSize": "PT5M",
      "timeAggregation": "Total"
    },
    "actions": []
  }
}

Risposta di esempio

Codice di stato:
200 
{
  "id": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/microsoft.insights/alertrules/chiricutin",
  "name": "chiricutin",
  "type": "Microsoft.Insights/alertRules",
  "location": "West US",
  "tags": {
    "$type": "Microsoft.WindowsAzure.Management.Common.Storage.CasePreservedDictionary, Microsoft.WindowsAzure.Management.Common.Storage",
    "hidden-link:/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/leoalerttest": "Resource"
  },
  "properties": {
    "name": "chiricutin",
    "description": "Pura Vida",
    "isEnabled": true,
    "condition": {
      "odata.type": "Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition",
      "dataSource": {
        "odata.type": "Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource",
        "resourceUri": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/leoalerttest",
        "metricName": "Requests"
      },
      "operator": "GreaterThan",
      "threshold": 3,
      "windowSize": "PT5M",
      "timeAggregation": "Total"
    },
    "lastUpdatedTime": "2016-11-23T21:23:52.0221265Z",
    "actions": []
  }
}
Codice di stato:
201 
{
  "id": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/microsoft.insights/alertrules/chiricutin",
  "name": "chiricutin",
  "type": "Microsoft.Insights/alertRules",
  "location": "West US",
  "tags": {
    "$type": "Microsoft.WindowsAzure.Management.Common.Storage.CasePreservedDictionary, Microsoft.WindowsAzure.Management.Common.Storage",
    "hidden-link:/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/leoalerttest": "Resource"
  },
  "properties": {
    "name": "chiricutin",
    "description": "Pura Vida",
    "isEnabled": true,
    "condition": {
      "odata.type": "Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition",
      "dataSource": {
        "odata.type": "Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource",
        "resourceUri": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/leoalerttest",
        "metricName": "Requests"
      },
      "operator": "GreaterThan",
      "threshold": 3,
      "windowSize": "PT5M",
      "timeAggregation": "Total"
    },
    "lastUpdatedTime": "2016-11-23T21:23:52.0221265Z",
    "actions": []
  }
}

Definizioni

Nome Descrizione
AlertRuleResource

Risorsa regola di avviso.
ConditionOperator

Operatori consentiti nella condizione della regola.
ErrorResponse

Descrive il formato della risposta di errore.
LocationThresholdRuleCondition

Condizione della regola basata su un determinato numero di posizioni non riuscite.
ManagementEventAggregationCondition

Definisce come i dati raccolti devono essere combinati nel tempo.
ManagementEventRuleCondition

Condizione della regola degli eventi di gestione.
RuleEmailAction

Specifica l'azione da inviare tramite posta elettronica quando viene valutata la condizione della regola. Il discriminatorio è sempre RuleEmailAction in questo caso.
RuleManagementEventClaimsDataSource

Attestazioni per un'origine dati dell'evento di gestione delle regole.
RuleManagementEventDataSource

Origine dati dell'evento di gestione delle regole. In questo caso, i campi discriminatori sono sempre RuleManagementEventDataSource.
RuleMetricDataSource

Origine dati della metrica della regola. Il valore discriminatorio è sempre RuleMetricDataSource in questo caso.
RuleWebhookAction

Specifica l'azione da inviare al servizio quando viene valutata la condizione della regola. Il discriminatorio è sempre RuleWebhookAction in questo caso.
ThresholdRuleCondition

Condizione della regola basata su una metrica che supera una soglia.
TimeAggregationOperator

Operatori di aggregazione consentiti in una regola.

AlertRuleResource

Risorsa regola di avviso.

Nome Tipo Descrizione
id

string

ID risorsa di Azure
location

string

Posizione risorsa
name

string

Nome risorsa di Azure
properties.action RuleAction:

azione eseguita quando la regola di avviso diventa attiva e quando viene risolta una condizione di avviso.
properties.actions RuleAction[]:

matrice di azioni eseguite quando la regola di avviso diventa attiva e quando viene risolta una condizione di avviso.
properties.condition RuleCondition:

condizione che determina l'attivazione della regola di avviso.
properties.description

string

descrizione della regola di avviso che verrà inclusa nel messaggio di posta elettronica dell'avviso.
properties.isEnabled

boolean

flag che indica se la regola di avviso è abilitata.
properties.lastUpdatedTime

string

Ora dell'ultimo aggiornamento della regola nel formato ISO8601.
properties.name

string

nome della regola di avviso.
properties.provisioningState

string

stato del provisioning.
tags

object

Tag delle risorse
type

string

Tipo di risorsa di Azure

ConditionOperator

Operatori consentiti nella condizione della regola.

Nome Tipo Descrizione
GreaterThan

string

GreaterThanOrEqual

string

LessThan

string

LessThanOrEqual

string

ErrorResponse

Descrive il formato della risposta di errore.

Nome Tipo Descrizione
code

string

Codice di errore
message

string

Messaggio di errore che indica il motivo per cui l'operazione non è riuscita.

LocationThresholdRuleCondition

Condizione della regola basata su un determinato numero di posizioni non riuscite.

Nome Tipo Descrizione
dataSource RuleDataSource:

risorsa da cui la regola raccoglie i dati. Per questo tipo dataSource sarà sempre di tipo RuleMetricDataSource.
failedLocationCount

integer

numero di posizioni che devono non riuscire ad attivare l'avviso.
odata.type string:

Microsoft.Azure.Management.Insights.Models.LocationThresholdRuleCondition

specifica il tipo di condizione. Può trattarsi di uno dei tre tipi: ManagementEventRuleCondition (occorrenze degli eventi di gestione), LocationThresholdRuleCondition (in base al numero di errori di un test Web) e ThresholdRuleCondition (in base alla soglia di una metrica).
windowSize

string

periodo di tempo (in formato di durata ISO 8601) usato per monitorare l'attività di avviso in base alla soglia. Se specificato, deve essere compreso tra 5 minuti e 1 giorno.

ManagementEventAggregationCondition

Definisce come i dati raccolti devono essere combinati nel tempo.

Nome Tipo Descrizione
operator

ConditionOperator

l'operatore condition.
threshold

number

Valore soglia che attiva l'avviso.
windowSize

string

periodo di tempo (in formato di durata ISO 8601) usato per monitorare l'attività di avviso in base alla soglia. Se specificato, deve essere compreso tra 5 minuti e 1 giorno.

ManagementEventRuleCondition

Condizione della regola degli eventi di gestione.

Nome Tipo Descrizione
aggregation

ManagementEventAggregationCondition

Modalità di combinazione dei dati raccolti nel tempo e dell'attivazione dell'avviso. Si noti che per gli avvisi di eventi di gestione l'elemento aggregation è facoltativo; se non viene fornito, qualsiasi evento determinerà l'attivazione dell'avviso.
dataSource RuleDataSource:

risorsa da cui la regola raccoglie i dati. Per questo tipo dataSource sarà sempre di tipo RuleMetricDataSource.
odata.type string:

Microsoft.Azure.Management.Insights.Models.ManagementEventRuleCondition

specifica il tipo di condizione. Può trattarsi di uno dei tre tipi: ManagementEventRuleCondition (occorrenze degli eventi di gestione), LocationThresholdRuleCondition (in base al numero di errori di un test Web) e ThresholdRuleCondition (in base alla soglia di una metrica).

RuleEmailAction

Specifica l'azione da inviare tramite posta elettronica quando viene valutata la condizione della regola. Il discriminatorio è sempre RuleEmailAction in questo caso.

Nome Tipo Descrizione
customEmails

string[]

l'elenco degli indirizzi di posta elettronica personalizzati dell'amministratore per notificare l'attivazione dell'avviso.
odata.type string:

Microsoft.Azure.Management.Insights.Models.RuleEmailAction

specifica il tipo dell'azione. Esistono due tipi di azioni: RuleEmailAction e RuleWebhookAction.
sendToServiceOwners

boolean

Indica se gli amministratori del servizio (inclusi i coamministratori) devono ricevere una notifica quando l'avviso viene attivato.

RuleManagementEventClaimsDataSource

Attestazioni per un'origine dati dell'evento di gestione delle regole.

Nome Tipo Descrizione
emailAddress

string

l'indirizzo di posta elettronica.

RuleManagementEventDataSource

Origine dati dell'evento di gestione delle regole. In questo caso, i campi discriminatori sono sempre RuleManagementEventDataSource.

Nome Tipo Descrizione
claims

RuleManagementEventClaimsDataSource

le attestazioni.
eventName

string

nome dell'evento.
eventSource

string

l'origine evento.
legacyResourceId

string

l'identificatore di risorsa legacy della risorsa monitorata dalla regola. NOTA: questa proprietà non può essere aggiornata per una regola esistente.
level

string

livello.
metricNamespace

string

spazio dei nomi della metrica.
odata.type string:

Microsoft.Azure.Management.Insights.Models.RuleManagementEventDataSource

specifica il tipo di origine dati. Esistono due tipi di origini dati delle regole: RuleMetricDataSource e RuleManagementEventDataSource
operationName

string

Nome dell'operazione che deve essere verificata. Se non viene fornito alcun nome, verrà restituita una corrispondenza per qualsiasi operazione.
resourceGroupName

string

nome del gruppo di risorse.
resourceLocation

string

la posizione della risorsa.
resourceProviderName

string

nome del provider di risorse.
resourceUri

string

identificatore di risorsa della risorsa monitorata dalla regola. NOTA: questa proprietà non può essere aggiornata per una regola esistente.
status

string

Lo stato dell'operazione che deve essere verificata. Se non viene fornito alcuno stato, verrà restituita una corrispondenza per qualsiasi stato.
subStatus

string

lo stato secondario.

RuleMetricDataSource

Origine dati della metrica della regola. Il valore discriminatorio è sempre RuleMetricDataSource in questo caso.

Nome Tipo Descrizione
legacyResourceId

string

l'identificatore di risorsa legacy della risorsa monitorata dalla regola. NOTA: questa proprietà non può essere aggiornata per una regola esistente.
metricName

string

nome della metrica che definisce il monitoraggio della regola.
metricNamespace

string

spazio dei nomi della metrica.
odata.type string:

Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource

specifica il tipo di origine dati. Esistono due tipi di origini dati delle regole: RuleMetricDataSource e RuleManagementEventDataSource
resourceLocation

string

la posizione della risorsa.
resourceUri

string

identificatore di risorsa della risorsa monitorata dalla regola. NOTA: questa proprietà non può essere aggiornata per una regola esistente.

RuleWebhookAction

Specifica l'azione da inviare al servizio quando viene valutata la condizione della regola. Il discriminatorio è sempre RuleWebhookAction in questo caso.

Nome Tipo Descrizione
odata.type string:

Microsoft.Azure.Management.Insights.Models.RuleWebhookAction

specifica il tipo dell'azione. Esistono due tipi di azioni: RuleEmailAction e RuleWebhookAction.
properties

object

dizionario delle proprietà personalizzate da includere con l'operazione post. Questi dati vengono aggiunti al payload del webhook.
serviceUri

string

l'URI del servizio per pubblicare la notifica quando l'avviso viene attivato o risolto.

ThresholdRuleCondition

Condizione della regola basata su una metrica che supera una soglia.

Nome Tipo Descrizione
dataSource RuleDataSource:

risorsa da cui la regola raccoglie i dati. Per questo tipo dataSource sarà sempre di tipo RuleMetricDataSource.
odata.type string:

Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition

specifica il tipo di condizione. Può trattarsi di uno dei tre tipi: ManagementEventRuleCondition (occorrenze degli eventi di gestione), LocationThresholdRuleCondition (in base al numero di errori di un test Web) e ThresholdRuleCondition (in base alla soglia di una metrica).
operator

ConditionOperator

operatore utilizzato per confrontare i dati e la soglia.
threshold

number

valore soglia che attiva l'avviso.
timeAggregation

TimeAggregationOperator

Operatore di aggregazione temporale. Modalità di combinazione dei dati raccolti nel tempo. Il valore predefinito è PrimaryAggregationType della metrica.
windowSize

string

periodo di tempo (in formato di durata ISO 8601) usato per monitorare l'attività di avviso in base alla soglia. Se specificato, deve essere compreso tra 5 minuti e 1 giorno.

TimeAggregationOperator

Operatori di aggregazione consentiti in una regola.

Nome Tipo Descrizione
Average

string

Last

string

Maximum

string

Minimum

string

Total

string