Scheduled Query Rules - Create Or Update
Erstellt oder aktualisiert eine geplante Abfrageregel.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/scheduledQueryRules/{ruleName}?api-version=2021-08-01
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
resource
|
path | True |
string minLength: 1maxLength: 90 |
Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet. |
rule
|
path | True |
string |
Der Name der Regel. |
subscription
|
path | True |
string minLength: 1 |
Die ID des Zielabonnements. |
api-version
|
query | True |
string minLength: 1 |
Die API-Version, die für diesen Vorgang verwendet werden soll. |
Anforderungstext
Name | Erforderlich | Typ | Beschreibung |
---|---|---|---|
location | True |
string |
Der geografische Standort, an dem sich die Ressource befindet |
properties.criteria | True |
Die Regelkriterien, die die Bedingungen der geplanten Abfrageregel definieren. |
|
properties.enabled | True |
boolean |
Das Kennzeichen, das angibt, ob diese geplante Abfrageregel aktiviert ist. Der Wert sollte wahr oder falsch sein. |
properties.scopes | True |
string[] |
Die Liste der Ressourcen-IDs, auf die diese geplante Abfrageregel eingestellt ist. |
kind |
Gibt den Typ der geplanten Abfrageregel an. Der Standardwert ist LogAlert. |
||
properties.actions |
Aktionen, die beim Auslösen der Warnung aufgerufen werden sollen. |
||
properties.autoMitigate |
boolean |
Das Kennzeichen, das angibt, ob die Warnung automatisch aufgelöst werden soll oder nicht. Der Standardwert ist "true". Nur für Regeln der Art LogAlert relevant. |
|
properties.checkWorkspaceAlertsStorageConfigured |
boolean |
Das Kennzeichen, das angibt, ob diese geplante Abfrageregel im Speicher des Kunden gespeichert werden soll. Der Standardwert ist "false". Nur für Regeln der Art LogAlert relevant. |
|
properties.description |
string |
Die Beschreibung der geplanten Abfrageregel. |
|
properties.displayName |
string |
Der Anzeigename der Warnungsregel |
|
properties.evaluationFrequency |
string (duration) |
Wie oft die geplante Abfrageregel im ISO 8601-Dauerformat ausgewertet wird. Relevant und nur für Regeln der Art LogAlert erforderlich. |
|
properties.muteActionsDuration |
string (duration) |
Stummschalten sie Aktionen für den ausgewählten Zeitraum (im ISO 8601-Dauerformat), nachdem die Warnung ausgelöst wurde. Nur für Regeln der Art LogAlert relevant. |
|
properties.overrideQueryTimeRange |
string (duration) |
Wenn angegeben, wird der Abfragezeitbereich überschrieben (Standardwert ist WindowSize*NumberOfEvaluationPeriods). Nur für Regeln der Art LogAlert relevant. |
|
properties.severity |
Alert |
Schweregrad der Warnung. Sollte eine ganze Zahl zwischen [0-4] sein. Der Wert 0 ist am schwerwiegendsten. Relevant und nur für Regeln der Art LogAlert erforderlich. |
|
properties.skipQueryValidation |
boolean |
Das Kennzeichen, das angibt, ob die bereitgestellte Abfrage überprüft werden soll. Der Standardwert ist "false". Nur für Regeln der Art LogAlert relevant. |
|
properties.targetResourceTypes |
string[] |
Liste der Ressourcentypen der Zielressource(n), für die die Warnung erstellt/aktualisiert wird. Wenn der Bereich beispielsweise eine Ressourcengruppe ist und targetResourceTypes "Microsoft.Compute/virtualMachines" ist, wird für jeden virtuellen Computer in der Ressourcengruppe, der die Warnungskriterien erfüllt, eine andere Warnung ausgelöst. Nur für Regeln der Art LogAlert relevant |
|
properties.windowSize |
string (duration) |
Der Zeitraum (im ISO 8601-Dauerformat), für den die Warnungsabfrage ausgeführt wird (Bin-Größe). Relevant und nur für Regeln der Art LogAlert erforderlich. |
|
tags |
object |
Ressourcentags. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
Erfolgreiche Anforderung zum Aktualisieren einer geplanten Abfrageregel |
|
201 Created |
Erstellt eine geplante Abfrageregel |
|
Other Status Codes |
Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist. |
Sicherheit
azure_auth
Azure Active Directory OAuth2-Fluss
Typ:
oauth2
Ablauf:
implicit
Autorisierungs-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Bereiche
Name | Beschreibung |
---|---|
user_impersonation | Identitätswechsel ihres Benutzerkontos |
Beispiele
Create or update a scheduled query rule for Single Resource |
Create or update a scheduled query rule on Resource group(s) |
Create or update a scheduled query rule on Subscription |
Create or update a scheduled query rule for Single Resource
Beispielanforderung
PUT https://management.azure.com/subscriptions/dd4bfc94-a096-412b-9c43-4bd13e35afbc/resourceGroups/QueryResourceGroupName/providers/Microsoft.Insights/scheduledQueryRules/perf?api-version=2021-08-01
{
"location": "eastus",
"properties": {
"description": "Performance rule",
"severity": 4,
"enabled": true,
"evaluationFrequency": "PT5M",
"scopes": [
"/subscriptions/aaf177ed-1330-a9f2-80ea-fd3d7783b147/resourceGroups/scopeResourceGroup1/providers/Microsoft.Compute/virtualMachines/vm1"
],
"windowSize": "PT10M",
"criteria": {
"allOf": [
{
"query": "Perf | where ObjectName == \"Processor\"",
"timeAggregation": "Average",
"metricMeasureColumn": "% Processor Time",
"resourceIdColumn": "resourceId",
"dimensions": [
{
"name": "ComputerIp",
"operator": "Exclude",
"values": [
"192.168.1.1"
]
},
{
"name": "OSType",
"operator": "Include",
"values": [
"*"
]
}
],
"operator": "GreaterThan",
"threshold": 70,
"failingPeriods": {
"numberOfEvaluationPeriods": 1,
"minFailingPeriodsToAlert": 1
}
}
]
},
"muteActionsDuration": "PT30M",
"actions": {
"actionGroups": [
"/subscriptions/1cf177ed-1330-4692-80ea-fd3d7783b147/resourcegroups/sqrapi/providers/microsoft.insights/actiongroups/myactiongroup"
],
"customProperties": {
"key11": "value11",
"key12": "value12"
}
},
"autoMitigate": true,
"checkWorkspaceAlertsStorageConfigured": true,
"skipQueryValidation": true
}
}
Beispiel für eine Antwort
{
"id": "/subscriptions/dd4bfc94-a096-412b-9c43-4bd13e35afbc/resourcegroups/QueryResourceGroupName/providers/microsoft.insights/scheduledqueryrules/perf",
"name": "perf",
"type": "microsoft.insights/scheduledqueryrules",
"location": "eastus",
"tags": {},
"properties": {
"description": "Performance rule",
"severity": 4,
"enabled": true,
"evaluationFrequency": "PT5M",
"scopes": [
"/subscriptions/aaf177ed-1330-a9f2-80ea-fd3d7783b147/resourceGroups/scopeResourceGroup1/providers/Microsoft.Compute/virtualMachines/vm1"
],
"windowSize": "PT10M",
"criteria": {
"allOf": [
{
"query": "Perf | where ObjectName == \"Processor\"",
"timeAggregation": "Average",
"metricMeasureColumn": "% Processor Time",
"resourceIdColumn": "resourceId",
"dimensions": [
{
"name": "ComputerIp",
"operator": "Exclude",
"values": [
"192.168.1.1"
]
},
{
"name": "OSType",
"operator": "Include",
"values": [
"*"
]
}
],
"operator": "GreaterThan",
"threshold": 70,
"failingPeriods": {
"numberOfEvaluationPeriods": 1,
"minFailingPeriodsToAlert": 1
}
}
]
},
"muteActionsDuration": "PT30M",
"actions": {
"actionGroups": [
"/subscriptions/1cf177ed-1330-4692-80ea-fd3d7783b147/resourcegroups/sqrapi/providers/microsoft.insights/actiongroups/myactiongroup"
],
"customProperties": {
"key11": "value11",
"key12": "value12"
}
},
"autoMitigate": true,
"isWorkspaceAlertsStorageConfigured": true,
"checkWorkspaceAlertsStorageConfigured": true,
"skipQueryValidation": true
}
}
{
"id": "/subscriptions/dd4bfc94-a096-412b-9c43-4bd13e35afbc/resourcegroups/QueryResourceGroupName/providers/microsoft.insights/scheduledqueryrules/perf",
"name": "perf",
"type": "microsoft.insights/scheduledqueryrules",
"location": "eastus",
"tags": {},
"properties": {
"description": "Performance rule",
"severity": 4,
"enabled": true,
"evaluationFrequency": "PT5M",
"scopes": [
"/subscriptions/aaf177ed-1330-a9f2-80ea-fd3d7783b147/resourceGroups/scopeResourceGroup1/providers/Microsoft.Compute/virtualMachines/vm1"
],
"windowSize": "PT10M",
"criteria": {
"allOf": [
{
"query": "Perf | where ObjectName == \"Processor\"",
"timeAggregation": "Average",
"metricMeasureColumn": "% Processor Time",
"resourceIdColumn": "resourceId",
"dimensions": [
{
"name": "ComputerIp",
"operator": "Exclude",
"values": [
"192.168.1.1"
]
},
{
"name": "OSType",
"operator": "Include",
"values": [
"*"
]
}
],
"operator": "GreaterThan",
"threshold": 70,
"failingPeriods": {
"numberOfEvaluationPeriods": 1,
"minFailingPeriodsToAlert": 1
}
}
]
},
"muteActionsDuration": "PT30M",
"actions": {
"actionGroups": [
"/subscriptions/1cf177ed-1330-4692-80ea-fd3d7783b147/resourcegroups/sqrapi/providers/microsoft.insights/actiongroups/myactiongroup"
],
"customProperties": {
"key11": "value11",
"key12": "value12"
}
},
"autoMitigate": true,
"isWorkspaceAlertsStorageConfigured": true,
"checkWorkspaceAlertsStorageConfigured": true,
"skipQueryValidation": true
}
}
Create or update a scheduled query rule on Resource group(s)
Beispielanforderung
PUT https://management.azure.com/subscriptions/dd4bfc94-a096-412b-9c43-4bd13e35afbc/resourceGroups/QueryResourceGroupName/providers/Microsoft.Insights/scheduledQueryRules/heartbeat?api-version=2021-08-01
{
"location": "eastus",
"properties": {
"description": "Health check rule",
"severity": 4,
"enabled": true,
"evaluationFrequency": "PT5M",
"scopes": [
"/subscriptions/aaf177ed-1330-a9f2-80ea-fd3d7783b147/resourceGroups/scopeResourceGroup1"
],
"targetResourceTypes": [
"Microsoft.Compute/virtualMachines"
],
"windowSize": "PT10M",
"criteria": {
"allOf": [
{
"query": "Heartbeat",
"timeAggregation": "Count",
"dimensions": [],
"operator": "GreaterThan",
"threshold": 360,
"failingPeriods": {
"numberOfEvaluationPeriods": 1,
"minFailingPeriodsToAlert": 1
}
}
]
},
"muteActionsDuration": "PT30M",
"actions": {
"actionGroups": [
"/subscriptions/1cf177ed-1330-4692-80ea-fd3d7783b147/resourcegroups/sqrapi/providers/microsoft.insights/actiongroups/myactiongroup"
],
"customProperties": {
"key11": "value11",
"key12": "value12"
}
},
"autoMitigate": true,
"checkWorkspaceAlertsStorageConfigured": true,
"skipQueryValidation": true
}
}
Beispiel für eine Antwort
{
"id": "/subscriptions/dd4bfc94-a096-412b-9c43-4bd13e35afbc/resourcegroups/QueryResourceGroupName/providers/microsoft.insights/scheduledqueryrules/heartbeat",
"name": "heartbeat",
"type": "microsoft.insights/scheduledqueryrules",
"location": "eastus",
"tags": {},
"properties": {
"description": "Health check rule",
"severity": 4,
"enabled": true,
"evaluationFrequency": "PT5M",
"scopes": [
"/subscriptions/aaf177ed-1330-a9f2-80ea-fd3d7783b147/resourceGroups/scopeResourceGroup1"
],
"targetResourceTypes": [
"Microsoft.Compute/virtualMachines"
],
"windowSize": "PT10M",
"criteria": {
"allOf": [
{
"query": "Heartbeat",
"timeAggregation": "Count",
"dimensions": [],
"operator": "GreaterThan",
"threshold": 360,
"failingPeriods": {
"numberOfEvaluationPeriods": 1,
"minFailingPeriodsToAlert": 1
}
}
]
},
"muteActionsDuration": "PT30M",
"actions": {
"actionGroups": [
"/subscriptions/1cf177ed-1330-4692-80ea-fd3d7783b147/resourcegroups/sqrapi/providers/microsoft.insights/actiongroups/myactiongroup"
],
"customProperties": {
"key11": "value11",
"key12": "value12"
}
},
"autoMitigate": true,
"isWorkspaceAlertsStorageConfigured": true,
"checkWorkspaceAlertsStorageConfigured": true,
"skipQueryValidation": true
}
}
{
"id": "/subscriptions/dd4bfc94-a096-412b-9c43-4bd13e35afbc/resourcegroups/QueryResourceGroupName/providers/microsoft.insights/scheduledqueryrules/heartbeat",
"name": "heartbeat",
"type": "microsoft.insights/scheduledqueryrules",
"location": "eastus",
"tags": {},
"properties": {
"description": "Health check rule",
"severity": 4,
"enabled": true,
"evaluationFrequency": "PT5M",
"scopes": [
"/subscriptions/aaf177ed-1330-a9f2-80ea-fd3d7783b147/resourceGroups/scopeResourceGroup1"
],
"targetResourceTypes": [
"Microsoft.Compute/virtualMachines"
],
"windowSize": "PT10M",
"criteria": {
"allOf": [
{
"query": "Heartbeat",
"timeAggregation": "Count",
"dimensions": [],
"operator": "GreaterThan",
"threshold": 360,
"failingPeriods": {
"numberOfEvaluationPeriods": 1,
"minFailingPeriodsToAlert": 1
}
}
]
},
"muteActionsDuration": "PT30M",
"actions": {
"actionGroups": [
"/subscriptions/1cf177ed-1330-4692-80ea-fd3d7783b147/resourcegroups/sqrapi/providers/microsoft.insights/actiongroups/myactiongroup"
],
"customProperties": {
"key11": "value11",
"key12": "value12"
}
},
"autoMitigate": true,
"isWorkspaceAlertsStorageConfigured": true,
"checkWorkspaceAlertsStorageConfigured": true,
"skipQueryValidation": true
}
}
Create or update a scheduled query rule on Subscription
Beispielanforderung
PUT https://management.azure.com/subscriptions/dd4bfc94-a096-412b-9c43-4bd13e35afbc/resourceGroups/QueryResourceGroupName/providers/Microsoft.Insights/scheduledQueryRules/perf?api-version=2021-08-01
{
"location": "eastus",
"properties": {
"description": "Performance rule",
"severity": 4,
"enabled": true,
"evaluationFrequency": "PT5M",
"scopes": [
"/subscriptions/aaf177ed-1330-a9f2-80ea-fd3d7783b147"
],
"targetResourceTypes": [
"Microsoft.Compute/virtualMachines"
],
"windowSize": "PT10M",
"criteria": {
"allOf": [
{
"query": "Perf | where ObjectName == \"Processor\"",
"timeAggregation": "Average",
"metricMeasureColumn": "% Processor Time",
"resourceIdColumn": "resourceId",
"dimensions": [
{
"name": "ComputerIp",
"operator": "Exclude",
"values": [
"192.168.1.1"
]
},
{
"name": "OSType",
"operator": "Include",
"values": [
"*"
]
}
],
"operator": "GreaterThan",
"threshold": 70,
"failingPeriods": {
"numberOfEvaluationPeriods": 1,
"minFailingPeriodsToAlert": 1
}
}
]
},
"muteActionsDuration": "PT30M",
"actions": {
"actionGroups": [
"/subscriptions/1cf177ed-1330-4692-80ea-fd3d7783b147/resourcegroups/sqrapi/providers/microsoft.insights/actiongroups/myactiongroup"
],
"customProperties": {
"key11": "value11",
"key12": "value12"
}
},
"autoMitigate": true,
"checkWorkspaceAlertsStorageConfigured": true,
"skipQueryValidation": true
}
}
Beispiel für eine Antwort
{
"id": "/subscriptions/dd4bfc94-a096-412b-9c43-4bd13e35afbc/resourcegroups/QueryResourceGroupName/providers/microsoft.insights/scheduledqueryrules/perf",
"name": "perf",
"type": "microsoft.insights/scheduledqueryrules",
"location": "eastus",
"tags": {},
"properties": {
"description": "Performance rule",
"severity": 4,
"enabled": true,
"evaluationFrequency": "PT5M",
"scopes": [
"/subscriptions/aaf177ed-1330-a9f2-80ea-fd3d7783b147"
],
"targetResourceTypes": [
"Microsoft.Compute/virtualMachines"
],
"windowSize": "PT10M",
"criteria": {
"allOf": [
{
"query": "Perf | where ObjectName == \"Processor\"",
"timeAggregation": "Average",
"metricMeasureColumn": "% Processor Time",
"resourceIdColumn": "resourceId",
"dimensions": [
{
"name": "ComputerIp",
"operator": "Exclude",
"values": [
"192.168.1.1"
]
},
{
"name": "OSType",
"operator": "Include",
"values": [
"*"
]
}
],
"operator": "GreaterThan",
"threshold": 70,
"failingPeriods": {
"numberOfEvaluationPeriods": 1,
"minFailingPeriodsToAlert": 1
}
}
]
},
"muteActionsDuration": "PT30M",
"actions": {
"actionGroups": [
"/subscriptions/1cf177ed-1330-4692-80ea-fd3d7783b147/resourcegroups/sqrapi/providers/microsoft.insights/actiongroups/myactiongroup"
],
"customProperties": {
"key11": "value11",
"key12": "value12"
}
},
"autoMitigate": true,
"isWorkspaceAlertsStorageConfigured": true,
"checkWorkspaceAlertsStorageConfigured": true,
"skipQueryValidation": true
}
}
{
"id": "/subscriptions/dd4bfc94-a096-412b-9c43-4bd13e35afbc/resourcegroups/QueryResourceGroupName/providers/microsoft.insights/scheduledqueryrules/perf",
"name": "perf",
"type": "microsoft.insights/scheduledqueryrules",
"location": "eastus",
"tags": {},
"properties": {
"description": "Performance rule",
"severity": 4,
"enabled": true,
"evaluationFrequency": "PT5M",
"scopes": [
"/subscriptions/aaf177ed-1330-a9f2-80ea-fd3d7783b147"
],
"targetResourceTypes": [
"Microsoft.Compute/virtualMachines"
],
"windowSize": "PT10M",
"criteria": {
"allOf": [
{
"query": "Perf | where ObjectName == \"Processor\"",
"timeAggregation": "Average",
"metricMeasureColumn": "% Processor Time",
"resourceIdColumn": "resourceId",
"dimensions": [
{
"name": "ComputerIp",
"operator": "Exclude",
"values": [
"192.168.1.1"
]
},
{
"name": "OSType",
"operator": "Include",
"values": [
"*"
]
}
],
"operator": "GreaterThan",
"threshold": 70,
"failingPeriods": {
"numberOfEvaluationPeriods": 1,
"minFailingPeriodsToAlert": 1
}
}
]
},
"muteActionsDuration": "PT30M",
"actions": {
"actionGroups": [
"/subscriptions/1cf177ed-1330-4692-80ea-fd3d7783b147/resourcegroups/sqrapi/providers/microsoft.insights/actiongroups/myactiongroup"
],
"customProperties": {
"key11": "value11",
"key12": "value12"
}
},
"autoMitigate": true,
"isWorkspaceAlertsStorageConfigured": true,
"checkWorkspaceAlertsStorageConfigured": true,
"skipQueryValidation": true
}
}
Definitionen
Name | Beschreibung |
---|---|
Actions |
Aktionen, die beim Auslösen der Warnung aufgerufen werden sollen. |
Alert |
Schweregrad der Warnung. Sollte eine ganze Zahl zwischen [0-4] sein. Der Wert 0 ist am schwerwiegendsten. Relevant und nur für Regeln der Art LogAlert erforderlich. |
Condition |
Eine Bedingung der geplanten Abfrageregel. |
condition |
Der Kriterienoperator. Relevant und nur für Regeln der Art LogAlert erforderlich. |
created |
Der Identitätstyp, der die Ressource erstellt hat. |
Dimension |
Definition der Dimensionteilung und -filterung |
dimension |
Operator für Dimensionswerte |
Error |
Der Ressourcenverwaltungsfehler zusätzliche Informationen. |
Error |
Beschreibt das Format der Fehlerantwort. |
Error |
Fehlerantwort |
Failing |
Die minimale Anzahl von Verletzungen, die innerhalb des ausgewählten Nachschlagezeitfensters erforderlich sind, um eine Warnung auszuheben. Nur für Regeln der Art LogAlert relevant. |
Kind |
Gibt den Typ der geplanten Abfrageregel an. Der Standardwert ist LogAlert. |
Scheduled |
Die Regelkriterien, die die Bedingungen der geplanten Abfrageregel definieren. |
Scheduled |
Die geplante Abfrageregelressource. |
system |
Metadaten zur Erstellung und letzten Änderung der Ressource. |
time |
Aggregationstyp. Relevant und nur für Regeln der Art LogAlert erforderlich. |
Actions
Aktionen, die beim Auslösen der Warnung aufgerufen werden sollen.
Name | Typ | Beschreibung |
---|---|---|
actionGroups |
string[] |
Aktionsgruppenressourcen-IDs, die beim Auslösen der Warnung aufgerufen werden sollen. |
customProperties |
object |
Die Eigenschaften einer Warnungsnutzlast. |
AlertSeverity
Schweregrad der Warnung. Sollte eine ganze Zahl zwischen [0-4] sein. Der Wert 0 ist am schwerwiegendsten. Relevant und nur für Regeln der Art LogAlert erforderlich.
Wert | Beschreibung |
---|---|
0 | |
1 | |
2 | |
3 | |
4 |
Condition
Eine Bedingung der geplanten Abfrageregel.
Name | Typ | Beschreibung |
---|---|---|
dimensions |
Liste der Dimensionensbedingungen |
|
failingPeriods |
Die minimale Anzahl von Verletzungen, die innerhalb des ausgewählten Nachschlagezeitfensters erforderlich sind, um eine Warnung auszuheben. Nur für Regeln der Art LogAlert relevant. |
|
metricMeasureColumn |
string |
Die Spalte, die die Metrik-Measurenummer enthält. Nur für Regeln der Art LogAlert relevant. |
metricName |
string |
Der Name der zu sendenden Metrik. Relevant und nur für Regeln der Art LogToMetric erforderlich. |
operator |
Der Kriterienoperator. Relevant und nur für Regeln der Art LogAlert erforderlich. |
|
query |
string |
Protokollabfragebenachrichtigung |
resourceIdColumn |
string |
Die Spalte, die die Ressourcen-ID enthält. Der Inhalt der Spalte muss ein URI sein, der als Ressourcen-ID formatiert ist. Nur für Regeln der Art LogAlert relevant. |
threshold |
number (double) |
der Schwellenwert für Kriterien, der die Warnung aktiviert. Relevant und nur für Regeln der Art LogAlert erforderlich. |
timeAggregation |
Aggregationstyp. Relevant und nur für Regeln der Art LogAlert erforderlich. |
conditionOperator
Der Kriterienoperator. Relevant und nur für Regeln der Art LogAlert erforderlich.
Wert | Beschreibung |
---|---|
Equals | |
GreaterThan | |
GreaterThanOrEqual | |
LessThan | |
LessThanOrEqual |
createdByType
Der Identitätstyp, der die Ressource erstellt hat.
Wert | Beschreibung |
---|---|
Application | |
Key | |
ManagedIdentity | |
User |
Dimension
Definition der Dimensionteilung und -filterung
Name | Typ | Beschreibung |
---|---|---|
name |
string |
Name der Dimension |
operator |
Operator für Dimensionswerte |
|
values |
string[] |
Liste der Dimensionswerte |
dimensionOperator
Operator für Dimensionswerte
Wert | Beschreibung |
---|---|
Exclude | |
Include |
ErrorAdditionalInfo
Der Ressourcenverwaltungsfehler zusätzliche Informationen.
Name | Typ | Beschreibung |
---|---|---|
info |
object |
Die zusätzlichen Informationen. |
type |
string |
Der zusätzliche Informationstyp. |
ErrorContract
Beschreibt das Format der Fehlerantwort.
Name | Typ | Beschreibung |
---|---|---|
error |
Fehlerantwort |
ErrorResponse
Fehlerantwort
Name | Typ | Beschreibung |
---|---|---|
additionalInfo |
Die zusätzlichen Informationen des Fehlers. |
|
code |
string |
Der Fehlercode. |
details |
Die Fehlerdetails. |
|
message |
string |
Die Fehlermeldung. |
target |
string |
Das Fehlerziel. |
FailingPeriods
Die minimale Anzahl von Verletzungen, die innerhalb des ausgewählten Nachschlagezeitfensters erforderlich sind, um eine Warnung auszuheben. Nur für Regeln der Art LogAlert relevant.
Name | Typ | Standardwert | Beschreibung |
---|---|---|---|
minFailingPeriodsToAlert |
integer (int64) |
1 |
Die Anzahl der Verletzungen, um eine Warnung auszulösen. Sollte kleiner oder gleich "NumberOfEvaluationPeriods" sein. Standardwert ist 1 |
numberOfEvaluationPeriods |
integer (int64) |
1 |
Die Anzahl der aggregierten Lookbackpunkte. Das Nachschlagezeitfenster wird basierend auf der Aggregations granularität (windowSize) und der ausgewählten Anzahl aggregierter Punkte berechnet. Standardwert ist 1 |
Kind
Gibt den Typ der geplanten Abfrageregel an. Der Standardwert ist LogAlert.
Wert | Beschreibung |
---|---|
LogAlert | |
LogToMetric |
ScheduledQueryRuleCriteria
Die Regelkriterien, die die Bedingungen der geplanten Abfrageregel definieren.
Name | Typ | Beschreibung |
---|---|---|
allOf |
Eine Liste der Bedingungen, die für die angegebenen Bereiche ausgewertet werden sollen |
ScheduledQueryRuleResource
Die geplante Abfrageregelressource.
Name | Typ | Beschreibung |
---|---|---|
etag |
string |
Das Etag-Feld ist nicht erforderlich. Wenn sie im Antworttext angegeben wird, muss sie auch als Kopfzeile gemäß der normalen etag-Konvention bereitgestellt werden. Entitätstags werden zum Vergleichen von zwei oder mehr Entitäten aus derselben angeforderten Ressource verwendet. HTTP/1.1 verwendet Entitätstags im etag (Abschnitt 14.19), If-Match (Abschnitt 14.24), If-None-Match (Abschnitt 14.26) und If-Range (Abschnitt 14.27)-Kopfzeilenfelder. |
id |
string |
Vollqualifizierte Ressourcen-ID für die Ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
kind |
Gibt den Typ der geplanten Abfrageregel an. Der Standardwert ist LogAlert. |
|
location |
string |
Der geografische Standort, an dem sich die Ressource befindet |
name |
string |
Der Name der Ressource |
properties.actions |
Aktionen, die beim Auslösen der Warnung aufgerufen werden sollen. |
|
properties.autoMitigate |
boolean |
Das Kennzeichen, das angibt, ob die Warnung automatisch aufgelöst werden soll oder nicht. Der Standardwert ist "true". Nur für Regeln der Art LogAlert relevant. |
properties.checkWorkspaceAlertsStorageConfigured |
boolean |
Das Kennzeichen, das angibt, ob diese geplante Abfrageregel im Speicher des Kunden gespeichert werden soll. Der Standardwert ist "false". Nur für Regeln der Art LogAlert relevant. |
properties.createdWithApiVersion |
string |
Die api-Version, die beim Erstellen dieser Warnungsregel verwendet wird |
properties.criteria |
Die Regelkriterien, die die Bedingungen der geplanten Abfrageregel definieren. |
|
properties.description |
string |
Die Beschreibung der geplanten Abfrageregel. |
properties.displayName |
string |
Der Anzeigename der Warnungsregel |
properties.enabled |
boolean |
Das Kennzeichen, das angibt, ob diese geplante Abfrageregel aktiviert ist. Der Wert sollte wahr oder falsch sein. |
properties.evaluationFrequency |
string (duration) |
Wie oft die geplante Abfrageregel im ISO 8601-Dauerformat ausgewertet wird. Relevant und nur für Regeln der Art LogAlert erforderlich. |
properties.isLegacyLogAnalyticsRule |
boolean |
True, wenn warnungsregel legacy Log Analytic rule ist |
properties.isWorkspaceAlertsStorageConfigured |
boolean |
Das Kennzeichen, das angibt, ob diese geplante Abfrageregel so konfiguriert wurde, dass sie im Speicher des Kunden gespeichert wird. Der Standardwert ist "false". |
properties.muteActionsDuration |
string (duration) |
Stummschalten sie Aktionen für den ausgewählten Zeitraum (im ISO 8601-Dauerformat), nachdem die Warnung ausgelöst wurde. Nur für Regeln der Art LogAlert relevant. |
properties.overrideQueryTimeRange |
string (duration) |
Wenn angegeben, wird der Abfragezeitbereich überschrieben (Standardwert ist WindowSize*NumberOfEvaluationPeriods). Nur für Regeln der Art LogAlert relevant. |
properties.scopes |
string[] |
Die Liste der Ressourcen-IDs, auf die diese geplante Abfrageregel eingestellt ist. |
properties.severity |
Alert |
Schweregrad der Warnung. Sollte eine ganze Zahl zwischen [0-4] sein. Der Wert 0 ist am schwerwiegendsten. Relevant und nur für Regeln der Art LogAlert erforderlich. |
properties.skipQueryValidation |
boolean |
Das Kennzeichen, das angibt, ob die bereitgestellte Abfrage überprüft werden soll. Der Standardwert ist "false". Nur für Regeln der Art LogAlert relevant. |
properties.targetResourceTypes |
string[] |
Liste der Ressourcentypen der Zielressource(n), für die die Warnung erstellt/aktualisiert wird. Wenn der Bereich beispielsweise eine Ressourcengruppe ist und targetResourceTypes "Microsoft.Compute/virtualMachines" ist, wird für jeden virtuellen Computer in der Ressourcengruppe, der die Warnungskriterien erfüllt, eine andere Warnung ausgelöst. Nur für Regeln der Art LogAlert relevant |
properties.windowSize |
string (duration) |
Der Zeitraum (im ISO 8601-Dauerformat), für den die Warnungsabfrage ausgeführt wird (Bin-Größe). Relevant und nur für Regeln der Art LogAlert erforderlich. |
systemData |
SystemData von ScheduledQueryRule. |
|
tags |
object |
Ressourcentags. |
type |
string |
Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts" |
systemData
Metadaten zur Erstellung und letzten Änderung der Ressource.
Name | Typ | Beschreibung |
---|---|---|
createdAt |
string (date-time) |
Der Zeitstempel der Ressourcenerstellung (UTC). |
createdBy |
string |
Die Identität, die die Ressource erstellt hat. |
createdByType |
Der Identitätstyp, der die Ressource erstellt hat. |
|
lastModifiedAt |
string (date-time) |
Der Zeitstempel der letzten Änderung der Ressource (UTC) |
lastModifiedBy |
string |
Die Identität, die die Ressource zuletzt geändert hat. |
lastModifiedByType |
Der Identitätstyp, der die Ressource zuletzt geändert hat. |
timeAggregation
Aggregationstyp. Relevant und nur für Regeln der Art LogAlert erforderlich.
Wert | Beschreibung |
---|---|
Average | |
Count | |
Maximum | |
Minimum | |
Total |