Alert Rules - List By Subscription

Uveďte seznam klasických pravidel upozornění na metriky v rámci předplatného.

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
subscriptionId
path True

string

ID cílového předplatného.

api-version
query True

string

Verze rozhraní API, která se má použít pro tuto operaci.

Odpovědi

Name Typ Description
200 OK

AlertRuleResourceCollection

Úspěšná žádost o seznam pravidel upozornění

Other Status Codes

ErrorResponse

Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

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

Scopes

Name Description
user_impersonation zosobnění uživatelského účtu

Příklady

List alert rules

Sample Request

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

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/microsoft.insights/alertrules/myRuleName",
      "name": "myRuleName",
      "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": "myRuleName",
        "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": 2,
          "windowSize": "PT5M",
          "timeAggregation": "Total"
        },
        "lastUpdatedTime": "2016-11-10T21:04:39.0005255Z",
        "actions": [
          {
            "odata.type": "Microsoft.Azure.Management.Insights.Models.RuleEmailAction",
            "sendToServiceOwners": true,
            "customEmails": [
              "gu@ms.com",
              "su@ms.net"
            ]
          }
        ]
      }
    },
    {
      "id": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/microsoft.insights/alertrules/chiricutin0",
      "name": "chiricutin0",
      "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": "chiricutin0",
        "description": "Pura Vida 0",
        "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": 2,
          "windowSize": "PT5M",
          "timeAggregation": "Total"
        },
        "lastUpdatedTime": "2016-11-10T21:04:39.1082596Z",
        "actions": []
      }
    }
  ]
}

Definice

Name Description
AlertRuleResource

Prostředek pravidla upozornění.

AlertRuleResourceCollection

Představuje kolekci prostředků pravidla upozornění.

ConditionOperator

Operátory povolené v podmínce pravidla

ErrorResponse

Popisuje formát chybové odpovědi.

LocationThresholdRuleCondition

Podmínka pravidla založená na určitém počtu umístění, která selhávají.

ManagementEventAggregationCondition

Způsob kombinování shromažďovaných dat v průběhu času.

ManagementEventRuleCondition

Podmínka pravidla události správy.

RuleEmailAction

Určuje akci pro odeslání e-mailu při vyhodnocení podmínky pravidla. Diskriminátor je v tomto případě vždy RuleEmailAction.

RuleManagementEventClaimsDataSource

Deklarace identity pro zdroj dat událostí správy pravidel.

RuleManagementEventDataSource

Zdroj dat události správy pravidel. Diskriminující pole jsou v tomto případě vždy RuleManagementEventDataSource.

RuleMetricDataSource

Zdroj dat metriky pravidla. Diskriminující hodnota je v tomto případě vždy RuleMetricDataSource.

RuleWebhookAction

Určuje akci, která se má odeslat do služby při vyhodnocení podmínky pravidla. Diskriminátor je v tomto případě vždy RuleWebhookAction.

ThresholdRuleCondition

Podmínka pravidla založená na metrice překračující prahovou hodnotu.

TimeAggregationOperator

Povolené operátory agregace v pravidle

AlertRuleResource

Prostředek pravidla upozornění.

Name Typ Description
id

string

ID prostředku Azure

location

string

Umístění prostředku

name

string

Název prostředku Azure

properties.action RuleAction:

akce, která se provede, když se pravidlo upozornění aktivuje a když se vyřeší podmínka upozornění.

properties.actions RuleAction[]:

pole akcí, které se provedou, když se pravidlo upozornění aktivuje a když se vyřeší podmínka upozornění.

properties.condition RuleCondition:

podmínka, která má za následek aktivaci pravidla upozornění.

properties.description

string

popis pravidla upozornění, které bude součástí e-mailu s upozorněním.

properties.isEnabled

boolean

příznak označující, jestli je pravidlo upozornění povolené.

properties.lastUpdatedTime

string

Čas poslední aktualizace pravidla ve formátu ISO8601.

properties.name

string

název pravidla upozornění.

properties.provisioningState

string

stav zřizování.

tags

object

Značky prostředků

type

string

Typ prostředku Azure

AlertRuleResourceCollection

Představuje kolekci prostředků pravidla upozornění.

Name Typ Description
value

AlertRuleResource[]

hodnoty pro prostředky pravidla upozornění.

ConditionOperator

Operátory povolené v podmínce pravidla

Name Typ Description
GreaterThan

string

GreaterThanOrEqual

string

LessThan

string

LessThanOrEqual

string

ErrorResponse

Popisuje formát chybové odpovědi.

Name Typ Description
code

string

Kód chyby

message

string

Chybová zpráva s informacemi o tom, proč operace selhala.

LocationThresholdRuleCondition

Podmínka pravidla založená na určitém počtu umístění, která selhávají.

Name Typ Description
dataSource RuleDataSource:

prostředek, ze kterého pravidlo shromažďuje svá data. Pro tento typ bude zdroj datSource vždy typu RuleMetricDataSource.

failedLocationCount

integer

počet umístění, u kterého se musí nezdařit aktivace výstrahy.

odata.type string:

Microsoft.Azure.Management.Insights.Models.LocationThresholdRuleCondition

určuje typ podmínky. Může se jednat o jeden ze tří typů: ManagementEventRuleCondition (výskyty událostí správy), LocationThresholdRuleCondition (na základě počtu selhání webového testu) a ThresholdRuleCondition (na základě prahové hodnoty metriky).

windowSize

string

časové období (ve formátu doby trvání ISO 8601), které se používá k monitorování aktivity výstrah na základě prahové hodnoty. Pokud je zadaný, musí to být 5 minut až 1 den.

ManagementEventAggregationCondition

Způsob kombinování shromažďovaných dat v průběhu času.

Name Typ Description
operator

ConditionOperator

operátor podmínky.

threshold

number

Prahová hodnota, která aktivuje upozornění.

windowSize

string

časové období (ve formátu doby trvání ISO 8601), které se používá k monitorování aktivity výstrah na základě prahové hodnoty. Pokud je zadaný, musí to být 5 minut až 1 den.

ManagementEventRuleCondition

Podmínka pravidla události správy.

Name Typ Description
aggregation

ManagementEventAggregationCondition

Způsob kombinování shromažďovaných dat v průběhu času a při aktivaci výstrahy Všimněte si, že pro správu je agregace upozornění událostí volitelná – pokud není k dispozici, jakákoli událost způsobí aktivaci upozornění.

dataSource RuleDataSource:

prostředek, ze kterého pravidlo shromažďuje svá data. Pro tento typ bude zdroj datSource vždy typu RuleMetricDataSource.

odata.type string:

Microsoft.Azure.Management.Insights.Models.ManagementEventRuleCondition

určuje typ podmínky. Může se jednat o jeden ze tří typů: ManagementEventRuleCondition (výskyty událostí správy), LocationThresholdRuleCondition (na základě počtu selhání webového testu) a ThresholdRuleCondition (na základě prahové hodnoty metriky).

RuleEmailAction

Určuje akci pro odeslání e-mailu při vyhodnocení podmínky pravidla. Diskriminátor je v tomto případě vždy RuleEmailAction.

Name Typ Description
customEmails

string[]

seznam vlastních e-mailových adres správce pro oznámení o aktivaci výstrahy.

odata.type string:

Microsoft.Azure.Management.Insights.Models.RuleEmailAction

určuje typ akce. Existují dva typy akcí: RuleEmailAction a RuleWebhookAction.

sendToServiceOwners

boolean

Určuje, zda mají být správci (správci služby a spolusprávci) služby upozorněni na aktivaci výstrahy.

RuleManagementEventClaimsDataSource

Deklarace identity pro zdroj dat událostí správy pravidel.

Name Typ Description
emailAddress

string

e-mailovou adresu.

RuleManagementEventDataSource

Zdroj dat události správy pravidel. Diskriminující pole jsou v tomto případě vždy RuleManagementEventDataSource.

Name Typ Description
claims

RuleManagementEventClaimsDataSource

deklarací identity.

eventName

string

název události.

eventSource

string

zdroj události.

legacyResourceId

string

starší verze identifikátoru prostředku, který pravidlo monitoruje. POZNÁMKA: Tuto vlastnost nelze aktualizovat pro existující pravidlo.

level

string

úroveň.

metricNamespace

string

obor názvů metriky.

odata.type string:

Microsoft.Azure.Management.Insights.Models.RuleManagementEventDataSource

určuje typ zdroje dat. Existují dva typy zdrojů dat pravidel: RuleMetricDataSource a RuleManagementEventDataSource.

operationName

string

Název operace, která se má zkontrolovat. Pokud není zadaný žádný název, všechny operace se budou shodovat.

resourceGroupName

string

název skupiny prostředků.

resourceLocation

string

umístění prostředku.

resourceProviderName

string

název poskytovatele prostředků.

resourceUri

string

identifikátor prostředku, který pravidlo monitoruje. POZNÁMKA: Tuto vlastnost nelze aktualizovat pro existující pravidlo.

status

string

Stav operace, která se má zkontrolovat. Pokud není zadaný žádný stav, bude se shodovat jakýkoli stav.

subStatus

string

dílčí stav.

RuleMetricDataSource

Zdroj dat metriky pravidla. Diskriminující hodnota je v tomto případě vždy RuleMetricDataSource.

Name Typ Description
legacyResourceId

string

starší verze identifikátoru prostředku, který pravidlo monitoruje. POZNÁMKA: Tuto vlastnost nelze aktualizovat pro existující pravidlo.

metricName

string

název metriky, která definuje, co pravidlo monitoruje.

metricNamespace

string

obor názvů metriky.

odata.type string:

Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource

určuje typ zdroje dat. Existují dva typy zdrojů dat pravidel: RuleMetricDataSource a RuleManagementEventDataSource.

resourceLocation

string

umístění prostředku.

resourceUri

string

identifikátor prostředku, který pravidlo monitoruje. POZNÁMKA: Tuto vlastnost nelze aktualizovat pro existující pravidlo.

RuleWebhookAction

Určuje akci, která se má odeslat do služby při vyhodnocení podmínky pravidla. Diskriminátor je v tomto případě vždy RuleWebhookAction.

Name Typ Description
odata.type string:

Microsoft.Azure.Management.Insights.Models.RuleWebhookAction

určuje typ akce. Existují dva typy akcí: RuleEmailAction a RuleWebhookAction.

properties

object

slovník vlastních vlastností, které se mají zahrnout do operace post. Tato data se připojí k datové části webhooku.

serviceUri

string

identifikátor URI služby, který odešle oznámení, když se výstraha aktivuje nebo vyřeší.

ThresholdRuleCondition

Podmínka pravidla založená na metrice překračující prahovou hodnotu.

Name Typ Description
dataSource RuleDataSource:

prostředek, ze kterého pravidlo shromažďuje svá data. Pro tento typ bude zdroj datSource vždy typu RuleMetricDataSource.

odata.type string:

Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition

určuje typ podmínky. Může se jednat o jeden ze tří typů: ManagementEventRuleCondition (výskyty událostí správy), LocationThresholdRuleCondition (na základě počtu selhání webového testu) a ThresholdRuleCondition (na základě prahové hodnoty metriky).

operator

ConditionOperator

operátor použitý k porovnání dat a prahové hodnoty.

threshold

number

prahová hodnota, která aktivuje výstrahu.

timeAggregation

TimeAggregationOperator

operátor časové agregace. Způsob kombinování shromažďovaných dat v průběhu času Výchozí hodnota je PrimaryAggregationType metriky.

windowSize

string

časové období (ve formátu doby trvání ISO 8601), které se používá k monitorování aktivity výstrah na základě prahové hodnoty. Pokud je zadaný, musí to být 5 minut až 1 den.

TimeAggregationOperator

Povolené operátory agregace v pravidle

Name Typ Description
Average

string

Last

string

Maximum

string

Minimum

string

Total

string