Alert Rules - Get

クラシック メトリック アラート ルールを取得します。

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

URI パラメーター

Name In Required Type Description
resourceGroupName
path True
  • string

リソース グループの名前。 名前の大文字と小文字は区別されます。

ruleName
path True
  • string

ルールの名前です。

subscriptionId
path True
  • string

ターゲット サブスクリプションの ID。

api-version
query True
  • string

この操作に使用する API バージョン。

応答

Name Type Description
200 OK

アラート ルールを取得するための要求が成功しました

Other Status Codes

操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

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

Scopes

Name Description
user_impersonation ユーザー アカウントを偽装する

Get an alert rule

Sample Request

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

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

定義

AlertRuleResource

アラート ルール リソース。

ConditionOperator

ルール条件で使用できる演算子。

ErrorResponse

エラー応答の形式について説明します。

LocationThresholdRuleCondition

特定の数の場所に基づくルール条件が失敗しました。

ManagementEventAggregationCondition

収集されたデータの経時的な結合方法。

ManagementEventRuleCondition

管理イベント ルールの条件。

RuleEmailAction

ルール条件が評価されたときに電子メールを送信するアクションを指定します。 この場合、識別子は常に RuleEmailAction です。

RuleManagementEventClaimsDataSource

ルール管理イベント データ ソースの要求。

RuleManagementEventDataSource

ルール管理イベント データ ソース。 この場合、識別子フィールドは常に RuleManagementEventDataSource です。

RuleMetricDataSource

ルール メトリック データ ソース。 識別子の値は、この場合は常に RuleMetricDataSource です。

RuleWebhookAction

ルール条件が評価されたときにサービスに投稿するアクションを指定します。 この場合、識別子は常に RuleWebhookAction です。

ThresholdRuleCondition

しきい値を超えるメトリックに基づくルール条件。

TimeAggregationOperator

ルールで使用できる集計演算子。

AlertRuleResource

アラート ルール リソース。

Name Type Description
id
  • string

Azure リソース ID

location
  • string

リソースの場所

name
  • string

Azure リソース名

properties.action RuleAction:

アラート ルールがアクティブになったとき、およびアラート条件が解決されたときに実行されるアクション。

properties.actions RuleAction[]:

アラート ルールがアクティブになったとき、およびアラート条件が解決されたときに実行されるアクションの配列。

properties.condition RuleCondition:

アラート ルールがアクティブになる条件。

properties.description
  • string

アラート メールに含まれるアラート ルールの説明。

properties.isEnabled
  • boolean

アラート ルールが有効かどうかを示すフラグ。

properties.lastUpdatedTime
  • string

規則が ISO8601 形式で最後に更新された時刻。

properties.name
  • string

アラート ルールの名前。

properties.provisioningState
  • string

プロビジョニング状態。

tags
  • object

リソース タグ

type
  • string

Azure リソースタイプ

ConditionOperator

ルール条件で使用できる演算子。

Name Type Description
GreaterThan
  • string
GreaterThanOrEqual
  • string
LessThan
  • string
LessThanOrEqual
  • string

ErrorResponse

エラー応答の形式について説明します。

Name Type Description
code
  • string

エラー コード

message
  • string

操作が失敗した理由を示すエラー メッセージ。

LocationThresholdRuleCondition

特定の数の場所に基づくルール条件が失敗しました。

Name Type Description
dataSource RuleDataSource:

ルールがデータを収集するリソース。 この型の場合、dataSource は常に RuleMetricDataSource 型になります。

failedLocationCount
  • integer

アラートのアクティブ化に失敗する必要がある場所の数。

odata.type string:
  • Microsoft.Azure.Management.Insights.Models.LocationThresholdRuleCondition

は条件の種類を指定します。 これは、ManagementEventRuleCondition (管理イベントの発生)、LocationThresholdRuleCondition (Web テストの失敗の数に基づく)、ThresholdRuleCondition (メトリックのしきい値に基づく) の 3 種類のいずれかです。

windowSize
  • string

しきい値に基づいてアラート アクティビティを監視するために使用される期間 (ISO 8601 期間形式)。 指定する場合は、5 分から 1 日の間にする必要があります。

ManagementEventAggregationCondition

収集されたデータの経時的な結合方法。

Name Type Description
operator

条件演算子。

threshold
  • number

アラートを有効にするしきい値。

windowSize
  • string

しきい値に基づいてアラート アクティビティを監視するために使用される期間 (ISO 8601 期間形式)。 指定する場合は、5 分から 1 日の間にする必要があります。

ManagementEventRuleCondition

管理イベント ルールの条件。

Name Type Description
aggregation

収集されるデータの組み合わせ方法は、時間の経過とアラートがアクティブ化されるタイミングです。 管理イベントのアラートの集計は省略可能です。指定しない場合は、すべてのイベントによってアラートがアクティブ化されます。

dataSource RuleDataSource:

ルールがデータを収集するリソース。 この型の場合、dataSource は常に RuleMetricDataSource 型になります。

odata.type string:
  • Microsoft.Azure.Management.Insights.Models.ManagementEventRuleCondition

は条件の種類を指定します。 これは、ManagementEventRuleCondition (管理イベントの発生)、LocationThresholdRuleCondition (Web テストの失敗の数に基づく)、ThresholdRuleCondition (メトリックのしきい値に基づく) の 3 種類のいずれかです。

RuleEmailAction

ルール条件が評価されたときに電子メールを送信するアクションを指定します。 この場合、識別子は常に RuleEmailAction です。

Name Type Description
customEmails
  • string[]

アラートのアクティブ化を通知する管理者のカスタム 電子メール アドレスの一覧。

odata.type string:
  • Microsoft.Azure.Management.Insights.Models.RuleEmailAction

はアクションの種類を指定します。 アクションには、RuleEmailAction と RuleWebhookAction の 2 種類があります。

sendToServiceOwners
  • boolean

アラートがアクティブ化されたときにサービスの管理者 (サービスと共同管理者) に通知する必要があるかどうか。

RuleManagementEventClaimsDataSource

ルール管理イベント データ ソースの要求。

Name Type Description
emailAddress
  • string

電子メール アドレス。

RuleManagementEventDataSource

ルール管理イベント データ ソース。 この場合、識別子フィールドは常に RuleManagementEventDataSource です。

Name Type Description
claims

要求。

eventName
  • string

イベント名。

eventSource
  • string

イベント ソース。

legacyResourceId
  • string

ルールが監視するリソースのレガシ リソース識別子。 : このプロパティは、既存のルールに対しては更新できません。

level
  • string

レベルを指定します。

metricNamespace
  • string

メトリックの名前空間。

odata.type string:
  • Microsoft.Azure.Management.Insights.Models.RuleManagementEventDataSource

では、データ ソースの種類を指定します。 ルール データ ソースには、RuleMetricDataSource と RuleManagementEventDataSource の 2 種類があります。

operationName
  • string

確認する必要がある操作の名前。 名前を指定しない場合は、すべての操作が一致します。

resourceGroupName
  • string

リソース グループ名。

resourceLocation
  • string

リソースの場所。

resourceProviderName
  • string

リソース プロバイダー名。

resourceUri
  • string

ルールが監視するリソースのリソース識別子。 : このプロパティは、既存のルールに対しては更新できません。

status
  • string

確認する必要がある操作の状態。 状態を指定しない場合は、すべての状態が一致します。

subStatus
  • string

サブステータス。

RuleMetricDataSource

ルール メトリック データ ソース。 識別子の値は、この場合は常に RuleMetricDataSource です。

Name Type Description
legacyResourceId
  • string

ルールが監視するリソースのレガシ リソース識別子。 : このプロパティは、既存のルールに対しては更新できません。

metricName
  • string

ルールが監視する内容を定義するメトリックの名前。

metricNamespace
  • string

メトリックの名前空間。

odata.type string:
  • Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource

では、データ ソースの種類を指定します。 ルール データ ソースには、RuleMetricDataSource と RuleManagementEventDataSource の 2 種類があります。

resourceLocation
  • string

リソースの場所。

resourceUri
  • string

ルールが監視するリソースのリソース識別子。 : このプロパティは、既存のルールに対しては更新できません。

RuleWebhookAction

ルール条件が評価されたときにサービスに投稿するアクションを指定します。 この場合、識別子は常に RuleWebhookAction です。

Name Type Description
odata.type string:
  • Microsoft.Azure.Management.Insights.Models.RuleWebhookAction

はアクションの種類を指定します。 アクションには、RuleEmailAction と RuleWebhookAction の 2 種類があります。

properties
  • object

post 操作に含めるカスタム プロパティのディクショナリ。 これらのデータは、Webhook ペイロードに追加されます。

serviceUri
  • string

アラートがアクティブ化または解決されたときに通知を投稿するサービス URI。

ThresholdRuleCondition

しきい値を超えるメトリックに基づくルール条件。

Name Type Description
dataSource RuleDataSource:

ルールがデータを収集するリソース。 この型の場合、dataSource は常に RuleMetricDataSource 型になります。

odata.type string:
  • Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition

は条件の種類を指定します。 これは、ManagementEventRuleCondition (管理イベントの発生)、LocationThresholdRuleCondition (Web テストの失敗の数に基づく)、ThresholdRuleCondition (メトリックのしきい値に基づく) の 3 種類のいずれかです。

operator

データとしきい値の比較に使用される演算子。

threshold
  • number

アラートをアクティブにするしきい値。

timeAggregation

時間集計演算子。 収集されるデータを時間の経過と同時に組み合わせる方法。 既定値は、メトリックの PrimaryAggregationType です。

windowSize
  • string

しきい値に基づいてアラート アクティビティを監視するために使用される期間 (ISO 8601 期間形式)。 指定する場合は、5 分から 1 日の間にする必要があります。

TimeAggregationOperator

ルールで使用できる集計演算子。

Name Type Description
Average
  • string
Last
  • string
Maximum
  • string
Minimum
  • string
Total
  • string