Share via


Alert Rules - Create Or Update

Skapar eller uppdaterar en klassisk måttaviseringsregel.

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

URI-parametrar

Name I Obligatorisk Typ Description
resourceGroupName
path True

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

ruleName
path True

string

Namnet på regeln.

subscriptionId
path True

string

ID för målprenumerationen.

api-version
query True

string

Den API-version som ska användas för den här åtgärden.

Begärandetext

Name Obligatorisk Typ Description
location True

string

Resursplats

properties.condition True RuleCondition:

villkoret som resulterar i att aviseringsregeln aktiveras.

properties.isEnabled True

boolean

flaggan som anger om aviseringsregeln är aktiverad.

properties.name True

string

namnet på aviseringsregeln.

properties.action RuleAction:

åtgärd som utförs när aviseringsregeln blir aktiv och när ett aviseringsvillkor har lösts.

properties.actions RuleAction[]:

matrisen med åtgärder som utförs när aviseringsregeln blir aktiv och när ett aviseringsvillkor har lösts.

properties.description

string

beskrivningen av aviseringsregeln som ska ingå i aviseringsmeddelandet.

properties.provisioningState

string

etableringstillståndet.

tags

object

Resurstaggar

Svar

Name Typ Description
200 OK

AlertRuleResource

Lyckad begäran om att uppdatera en aviseringsregel

201 Created

AlertRuleResource

Skapad aviseringsregel

Other Status Codes

ErrorResponse

Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name Description
user_impersonation personifiera ditt användarkonto

Exempel

Create or update an alert rule

Sample Request

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": []
  }
}

Sample Response

{
  "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": []
  }
}
{
  "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": []
  }
}

Definitioner

Name Description
AlertRuleResource

Resursen för aviseringsregeln.

ConditionOperator

Operatorer som tillåts i regelvillkoret.

ErrorResponse

Beskriver formatet felsvar.

LocationThresholdRuleCondition

Ett regelvillkor baserat på ett visst antal platser som misslyckas.

ManagementEventAggregationCondition

Hur de data som samlas in ska kombineras över tid.

ManagementEventRuleCondition

Ett regelvillkor för hanteringshändelser.

RuleEmailAction

Anger åtgärden för att skicka e-post när regelvillkoret utvärderas. Diskrimineringen är alltid RuleEmailAction i det här fallet.

RuleManagementEventClaimsDataSource

Anspråken för en regelhanteringshändelsedatakälla.

RuleManagementEventDataSource

En regelhanteringshändelsedatakälla. De diskriminerande fälten är alltid RuleManagementEventDataSource i det här fallet.

RuleMetricDataSource

En regelmåttdatakälla. Det diskriminerande värdet är alltid RuleMetricDataSource i det här fallet.

RuleWebhookAction

Anger vilken åtgärd som ska skickas till tjänsten när regelvillkoret utvärderas. Diskrimineringen är alltid RuleWebhookAction i det här fallet.

ThresholdRuleCondition

Ett regelvillkor baserat på ett mått som överskrider ett tröskelvärde.

TimeAggregationOperator

Aggregeringsoperatorer tillåts i en regel.

AlertRuleResource

Resursen för aviseringsregeln.

Name Typ Description
id

string

Azure-resurs-ID

location

string

Resursplats

name

string

Azure-resursnamn

properties.action RuleAction:

åtgärd som utförs när aviseringsregeln blir aktiv och när ett aviseringsvillkor har lösts.

properties.actions RuleAction[]:

matrisen med åtgärder som utförs när aviseringsregeln blir aktiv och när ett aviseringsvillkor har lösts.

properties.condition RuleCondition:

villkoret som resulterar i att aviseringsregeln aktiveras.

properties.description

string

beskrivningen av aviseringsregeln som ska ingå i aviseringsmeddelandet.

properties.isEnabled

boolean

flaggan som anger om aviseringsregeln är aktiverad.

properties.lastUpdatedTime

string

Senast uppdaterades regeln i ISO8601 format.

properties.name

string

namnet på aviseringsregeln.

properties.provisioningState

string

etableringstillståndet.

tags

object

Resurstaggar

type

string

Azure-resurstyp

ConditionOperator

Operatorer som tillåts i regelvillkoret.

Name Typ Description
GreaterThan

string

GreaterThanOrEqual

string

LessThan

string

LessThanOrEqual

string

ErrorResponse

Beskriver formatet felsvar.

Name Typ Description
code

string

Felkod

message

string

Felmeddelande som anger varför åtgärden misslyckades.

LocationThresholdRuleCondition

Ett regelvillkor baserat på ett visst antal platser som misslyckas.

Name Typ Description
dataSource RuleDataSource:

resursen som regeln samlar in sina data från. För den här typen är dataSource alltid av typen RuleMetricDataSource.

failedLocationCount

integer

antalet platser som måste misslyckas med att aktivera aviseringen.

odata.type string:

Microsoft.Azure.Management.Insights.Models.LocationThresholdRuleCondition

anger typ av villkor. Detta kan vara en av tre typer: ManagementEventRuleCondition (förekomster av hanteringshändelser), LocationThresholdRuleCondition (baserat på antalet fel i ett webbtest) och ThresholdRuleCondition (baserat på tröskelvärdet för ett mått).

windowSize

string

tidsperioden (i ISO 8601-varaktighetsformat) som används för att övervaka aviseringsaktivitet baserat på tröskelvärdet. Om det anges måste det vara mellan 5 minuter och 1 dag.

ManagementEventAggregationCondition

Hur de data som samlas in ska kombineras över tid.

Name Typ Description
operator

ConditionOperator

villkorsoperatorn.

threshold

number

Tröskelvärdet som aktiverar aviseringen.

windowSize

string

tidsperioden (i ISO 8601-varaktighetsformat) som används för att övervaka aviseringsaktivitet baserat på tröskelvärdet. Om det anges måste det vara mellan 5 minuter och 1 dag.

ManagementEventRuleCondition

Ett regelvillkor för hanteringshändelser.

Name Typ Description
aggregation

ManagementEventAggregationCondition

Hur de data som samlas in ska kombineras över tid och när aviseringen aktiveras. Observera att aggregering för hanteringshändelseaviseringar är valfritt – om det inte anges kommer någon händelse att göra så att aviseringen aktiveras.

dataSource RuleDataSource:

resursen som regeln samlar in sina data från. För den här typen är dataSource alltid av typen RuleMetricDataSource.

odata.type string:

Microsoft.Azure.Management.Insights.Models.ManagementEventRuleCondition

anger typ av villkor. Detta kan vara en av tre typer: ManagementEventRuleCondition (förekomster av hanteringshändelser), LocationThresholdRuleCondition (baserat på antalet fel i ett webbtest) och ThresholdRuleCondition (baserat på tröskelvärdet för ett mått).

RuleEmailAction

Anger åtgärden för att skicka e-post när regelvillkoret utvärderas. Diskrimineringen är alltid RuleEmailAction i det här fallet.

Name Typ Description
customEmails

string[]

listan över administratörens anpassade e-postadresser för att meddela om aktiveringen av aviseringen.

odata.type string:

Microsoft.Azure.Management.Insights.Models.RuleEmailAction

anger typen av åtgärd. Det finns två typer av åtgärder: RuleEmailAction och RuleWebhookAction.

sendToServiceOwners

boolean

Om administratörerna (tjänsten och medadministratörerna) för tjänsten ska meddelas när aviseringen aktiveras.

RuleManagementEventClaimsDataSource

Anspråken för en regelhanteringshändelsedatakälla.

Name Typ Description
emailAddress

string

e-postadressen.

RuleManagementEventDataSource

En regelhanteringshändelsedatakälla. De diskriminerande fälten är alltid RuleManagementEventDataSource i det här fallet.

Name Typ Description
claims

RuleManagementEventClaimsDataSource

anspråken.

eventName

string

händelsenamnet.

eventSource

string

händelsekällan.

legacyResourceId

string

den äldre resursidentifieraren för resursen som regeln övervakar. Obs! Den här egenskapen kan inte uppdateras för en befintlig regel.

level

string

nivån.

metricNamespace

string

måttets namnområde.

odata.type string:

Microsoft.Azure.Management.Insights.Models.RuleManagementEventDataSource

anger typen av datakälla. Det finns två typer av regeldatakällor: RuleMetricDataSource och RuleManagementEventDataSource

operationName

string

Namnet på den åtgärd som ska kontrolleras. Om inget namn anges matchar alla åtgärder.

resourceGroupName

string

resursgruppens namn.

resourceLocation

string

resursens plats.

resourceProviderName

string

resursproviderns namn.

resourceUri

string

resursidentifieraren för resursen som regeln övervakar. Obs! Den här egenskapen kan inte uppdateras för en befintlig regel.

status

string

Status för den åtgärd som ska kontrolleras. Om ingen status anges matchar statusen.

subStatus

string

understatusen.

RuleMetricDataSource

En regelmåttdatakälla. Det diskriminerande värdet är alltid RuleMetricDataSource i det här fallet.

Name Typ Description
legacyResourceId

string

den äldre resursidentifieraren för resursen som regeln övervakar. Obs! Den här egenskapen kan inte uppdateras för en befintlig regel.

metricName

string

namnet på måttet som definierar vad regeln övervakar.

metricNamespace

string

måttets namnområde.

odata.type string:

Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource

anger typen av datakälla. Det finns två typer av regeldatakällor: RuleMetricDataSource och RuleManagementEventDataSource

resourceLocation

string

resursens plats.

resourceUri

string

resursidentifieraren för resursen som regeln övervakar. Obs! Den här egenskapen kan inte uppdateras för en befintlig regel.

RuleWebhookAction

Anger vilken åtgärd som ska skickas till tjänsten när regelvillkoret utvärderas. Diskrimineringen är alltid RuleWebhookAction i det här fallet.

Name Typ Description
odata.type string:

Microsoft.Azure.Management.Insights.Models.RuleWebhookAction

anger typen av åtgärd. Det finns två typer av åtgärder: RuleEmailAction och RuleWebhookAction.

properties

object

ordlistan med anpassade egenskaper som ska inkluderas i poståtgärden. Dessa data läggs till webhook-nyttolasten.

serviceUri

string

tjänstens URI för att publicera meddelandet när aviseringen aktiveras eller löses.

ThresholdRuleCondition

Ett regelvillkor baserat på ett mått som överskrider ett tröskelvärde.

Name Typ Description
dataSource RuleDataSource:

resursen som regeln samlar in sina data från. För den här typen är dataSource alltid av typen RuleMetricDataSource.

odata.type string:

Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition

anger typ av villkor. Detta kan vara en av tre typer: ManagementEventRuleCondition (förekomster av hanteringshändelser), LocationThresholdRuleCondition (baserat på antalet fel i ett webbtest) och ThresholdRuleCondition (baserat på tröskelvärdet för ett mått).

operator

ConditionOperator

operatorn som används för att jämföra data och tröskelvärdet.

threshold

number

tröskelvärdet som aktiverar aviseringen.

timeAggregation

TimeAggregationOperator

tidsaggregeringsoperatorn. Hur de data som samlas in ska kombineras över tid. Standardvärdet är PrimaryAggregationType för måttet.

windowSize

string

tidsperioden (i ISO 8601-varaktighetsformat) som används för att övervaka aviseringsaktivitet baserat på tröskelvärdet. Om det anges måste det vara mellan 5 minuter och 1 dag.

TimeAggregationOperator

Aggregeringsoperatorer tillåts i en regel.

Name Typ Description
Average

string

Last

string

Maximum

string

Minimum

string

Total

string