Scheduled Query Rules - List By Resource Group
リソース グループ内のスケジュールされたクエリ ルール定義を取得します。
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/scheduledQueryRules?api-version=2023-03-15-preview
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
resource
|
path | True |
string |
リソース グループの名前。 名前の大文字と小文字は区別されます。 |
subscription
|
path | True |
string |
ターゲット サブスクリプションの ID。 |
api-version
|
query | True |
string |
この操作に使用する API バージョン。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
スケジュールされたクエリ ルールの一覧に対する要求が成功しました |
|
Other Status Codes |
BadRequest |
セキュリティ
azure_auth
Azure Active Directory OAuth2 フロー
型:
oauth2
フロー:
implicit
Authorization URL (承認 URL):
https://login.microsoftonline.com/common/oauth2/authorize
スコープ
名前 | 説明 |
---|---|
user_impersonation | ユーザー アカウントの借用 |
例
List scheduled query rules by resource group
要求のサンプル
GET https://management.azure.com/subscriptions/dd4bfc94-a096-412b-9c43-4bd13e35afbc/resourceGroups/QueryResourceGroupName/providers/Microsoft.Insights/scheduledQueryRules?api-version=2023-03-15-preview
応答のサンプル
{
"value": [
{
"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"
],
"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"
}
},
"ruleResolveConfiguration": {
"autoResolved": true,
"timeToResolve": "PT10M"
},
"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"
}
},
"ruleResolveConfiguration": {
"autoResolved": true,
"timeToResolve": "PT10M"
},
"isWorkspaceAlertsStorageConfigured": true,
"checkWorkspaceAlertsStorageConfigured": true,
"skipQueryValidation": true
}
}
]
}
定義
名前 | 説明 |
---|---|
Actions |
アラートが発生したときに呼び出すアクション。 |
Alert |
アラートの重大度。 [0 から 4] の間の整数である必要があります。 値 0 は最も厳しいです。 LogAlert の種類のルールにのみ関連し、必須です。 |
Condition |
スケジュールされたクエリ ルールの条件。 |
condition |
criteria 演算子。 LogAlert の種類のルールにのみ関連し、必須です。 |
created |
リソースを作成した ID の種類。 |
Dimension |
ディメンションの分割とフィルター処理の定義 |
dimension |
ディメンション値の演算子 |
Error |
エラー応答の形式について説明します。 |
Error |
リソース管理エラーの追加情報。 |
Error |
エラー応答 |
Failing |
アラートの発生に必要な、選択したルックバック時間枠内で必要な違反の最小数。 LogAlert の種類のルールにのみ関連します。 |
Identity |
リソースの ID。 |
Identity |
マネージド サービス ID の種類。 |
Kind |
スケジュールされたクエリ ルールの種類を示します。 既定値は LogAlert です。 |
Rule |
TBD LogAlert の種類のルールにのみ関連します。 |
Scheduled |
スケジュールされたクエリ ルールの条件を定義するルールの条件。 |
Scheduled |
スケジュールされたクエリ ルール リソース。 |
Scheduled |
スケジュールされたクエリ ルール リソースのコレクションを表します。 |
system |
リソースの作成と最後の変更に関連するメタデータ。 |
time |
集計の種類。 LogAlert の種類のルールにのみ関連し、必須です。 |
User |
ユーザー割り当て ID プロパティ。 |
Actions
アラートが発生したときに呼び出すアクション。
名前 | 型 | 説明 |
---|---|---|
actionGroups |
string[] |
アラートが発生したときに呼び出すアクション グループ リソース ID。 |
actionProperties |
object |
アクション プロパティのプロパティ。 |
customProperties |
object |
アラート ペイロードのプロパティ。 |
AlertSeverity
アラートの重大度。 [0 から 4] の間の整数である必要があります。 値 0 は最も厳しいです。 LogAlert の種類のルールにのみ関連し、必須です。
名前 | 型 | 説明 |
---|---|---|
0 |
Integer |
|
1 |
Integer |
|
2 |
Integer |
|
3 |
Integer |
|
4 |
Integer |
Condition
スケジュールされたクエリ ルールの条件。
名前 | 型 | 説明 |
---|---|---|
dimensions |
ディメンション条件の一覧 |
|
failingPeriods |
アラートの発生に必要な、選択したルックバック時間枠内で必要な違反の最小数。 LogAlert の種類のルールにのみ関連します。 |
|
metricMeasureColumn |
string |
メトリック メジャー番号を含む列。 LogAlert の種類のルールにのみ関連します。 |
metricName |
string |
送信するメトリックの名前。 LogToMetric の種類のルールにのみ関連し、必須です。 |
operator |
criteria 演算子。 LogAlert の種類のルールにのみ関連し、必須です。 |
|
query |
string |
ログ クエリアラート |
resourceIdColumn |
string |
リソース ID を含む列。列の内容は、リソース ID として書式設定された URI である必要があります。LogAlert の種類のルールにのみ関連します。 |
threshold |
number |
アラートをアクティブにする条件しきい値。 LogAlert の種類のルールにのみ関連し、必須です。 |
timeAggregation |
集計の種類。 LogAlert の種類のルールにのみ関連し、必須です。 |
conditionOperator
criteria 演算子。 LogAlert の種類のルールにのみ関連し、必須です。
名前 | 型 | 説明 |
---|---|---|
Equals |
string |
|
GreaterThan |
string |
|
GreaterThanOrEqual |
string |
|
LessThan |
string |
|
LessThanOrEqual |
string |
createdByType
リソースを作成した ID の種類。
名前 | 型 | 説明 |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
Dimension
ディメンションの分割とフィルター処理の定義
名前 | 型 | 説明 |
---|---|---|
name |
string |
ディメンションの名前 |
operator |
ディメンション値の演算子 |
|
values |
string[] |
ディメンション値の一覧 |
dimensionOperator
ディメンション値の演算子
名前 | 型 | 説明 |
---|---|---|
Exclude |
string |
|
Include |
string |
ErrorContract
エラー応答の形式について説明します。
名前 | 型 | 説明 |
---|---|---|
error |
エラー応答 |
ErrorResponseAdditionalInfo
リソース管理エラーの追加情報。
名前 | 型 | 説明 |
---|---|---|
info |
object |
追加情報。 |
type |
string |
追加情報の種類。 |
ErrorResponseDetails
エラー応答
名前 | 型 | 説明 |
---|---|---|
additionalInfo |
エラーの追加情報。 |
|
code |
string |
エラー コード。 |
details |
エラーの詳細です。 |
|
message |
string |
エラー メッセージ。 |
target |
string |
エラーのターゲット。 |
FailingPeriods
アラートの発生に必要な、選択したルックバック時間枠内で必要な違反の最小数。 LogAlert の種類のルールにのみ関連します。
名前 | 型 | 規定値 | 説明 |
---|---|---|---|
minFailingPeriodsToAlert |
integer |
1 |
アラートをトリガーする違反の数。 numberOfEvaluationPeriods 以下にする必要があります。 既定値は 1。 |
numberOfEvaluationPeriods |
integer |
1 |
集計されたルックバック ポイントの数。 ルックバック タイム ウィンドウは、集計粒度 (windowSize) と、選択した集計ポイント数に基づいて計算されます。 既定値は 1。 |
Identity
リソースの ID。
名前 | 型 | 説明 |
---|---|---|
principalId |
string |
リソース ID のプリンシパル ID。 |
tenantId |
string |
リソースのテナント ID。 |
type |
マネージド サービス ID の種類。 |
|
userAssignedIdentities |
<string,
User |
リソースに関連付けられているユーザー ID の一覧。 ユーザー ID ディクショナリ キーの参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' という形式の ARM リソース ID になります。 |
IdentityType
マネージド サービス ID の種類。
名前 | 型 | 説明 |
---|---|---|
None |
string |
|
SystemAssigned |
string |
|
UserAssigned |
string |
Kind
スケジュールされたクエリ ルールの種類を示します。 既定値は LogAlert です。
名前 | 型 | 説明 |
---|---|---|
LogAlert |
string |
|
LogToMetric |
string |
RuleResolveConfiguration
TBD LogAlert の種類のルールにのみ関連します。
名前 | 型 | 説明 |
---|---|---|
autoResolved |
boolean |
発生したアラートを自動解決するかどうかを示すフラグ。 |
timeToResolve |
string |
発生したアラートが ISO 8601 期間形式で自動的に解決される前に、ルールが正常と評価する必要がある期間。 |
ScheduledQueryRuleCriteria
スケジュールされたクエリ ルールの条件を定義するルールの条件。
名前 | 型 | 説明 |
---|---|---|
allOf |
指定したスコープに対して評価する条件の一覧 |
ScheduledQueryRuleResource
スケジュールされたクエリ ルール リソース。
名前 | 型 | 説明 |
---|---|---|
etag |
string |
etag フィールドは必要 ありません 。 応答本文で指定する場合は、通常の etag 規則に従ってヘッダーとしても指定する必要があります。 エンティティ タグは、同じ要求されたリソースから 2 つ以上のエンティティを比較するために使用されます。 HTTP/1.1 では、etag (セクション 14.19)、If-Match (セクション 14.24)、If-None-Match (セクション 14.26)、および If-Range (セクション 14.27) ヘッダー フィールドでエンティティ タグを使用します。 |
id |
string |
リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
identity |
リソースの ID。 |
|
kind |
スケジュールされたクエリ ルールの種類を示します。 既定値は LogAlert です。 |
|
location |
string |
リソースが保存されている地理的な場所 |
name |
string |
リソースの名前 |
properties.actions |
アラートが発生したときに呼び出すアクション。 |
|
properties.autoMitigate |
boolean |
アラートを自動的に解決するかどうかを示すフラグ。 既定値は true です。 LogAlert の種類のルールにのみ関連します。 |
properties.checkWorkspaceAlertsStorageConfigured |
boolean |
このスケジュールされたクエリ ルールを顧客のストレージに格納するかどうかを示すフラグ。 既定値は false です。 LogAlert の種類のルールにのみ関連します。 |
properties.createdWithApiVersion |
string |
このアラート ルールの作成時に使用される API バージョン |
properties.criteria |
スケジュールされたクエリ ルールの条件を定義するルールの条件。 |
|
properties.description |
string |
スケジュールされたクエリ ルールの説明。 |
properties.displayName |
string |
アラート ルールの表示名 |
properties.enabled |
boolean |
このスケジュールされたクエリ ルールが有効になっているかどうかを示すフラグ。 値は true または false にする必要があります |
properties.evaluationFrequency |
string |
スケジュールされたクエリ ルールが評価される頻度は、ISO 8601 期間形式で表されます。 LogAlert の種類のルールにのみ関連し、必須です。 |
properties.isLegacyLogAnalyticsRule |
boolean |
アラート ルールが従来の Log Analytic ルールの場合は True |
properties.isWorkspaceAlertsStorageConfigured |
boolean |
このスケジュールされたクエリ ルールが顧客のストレージに格納されるように構成されているかどうかを示すフラグ。 既定値は false です。 |
properties.muteActionsDuration |
string |
アラートが発生した後、選択した期間 (ISO 8601 期間形式) のアクションをミュートします。 LogAlert の種類のルールにのみ関連します。 |
properties.overrideQueryTimeRange |
string |
指定した場合は、クエリの時間範囲をオーバーライドします (既定値は WindowSize*NumberOfEvaluationPeriods)。 LogAlert の種類のルールにのみ関連します。 |
properties.ruleResolveConfiguration |
発生したアラートを解決するための構成を定義します。 LogAlert の種類のルールにのみ関連します。 |
|
properties.scopes |
string[] |
このスケジュールされたクエリ ルールのスコープが設定されているリソース ID の一覧。 |
properties.severity |
アラートの重大度。 [0 から 4] の間の整数である必要があります。 値 0 は最も厳しいです。 LogAlert の種類のルールにのみ関連し、必須です。 |
|
properties.skipQueryValidation |
boolean |
指定されたクエリを検証する必要があるかどうかを示すフラグ。 既定値は false です。 LogAlert の種類のルールにのみ関連します。 |
properties.targetResourceTypes |
string[] |
アラートが作成または更新されるターゲット リソースのリソースの種類の一覧。 たとえば、スコープがリソース グループで targetResourceTypes が Microsoft.Compute/virtualMachines の場合、アラート条件を満たすリソース グループ内の仮想マシンごとに異なるアラートが発生します。 LogAlert の種類のルールにのみ関連します |
properties.windowSize |
string |
アラート クエリが実行される期間 (ISO 8601 期間形式) (ビン サイズ)。 LogAlert の種類のルールにのみ関連し、必須です。 |
systemData |
ScheduledQueryRule の SystemData。 |
|
tags |
object |
リソース タグ。 |
type |
string |
リソースの型。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts" |
ScheduledQueryRuleResourceCollection
スケジュールされたクエリ ルール リソースのコレクションを表します。
名前 | 型 | 説明 |
---|---|---|
nextLink |
string |
次の要素セットを取得するためのリンクを提供します。 |
value |
スケジュールされたクエリ ルール リソースの値。 |
systemData
リソースの作成と最後の変更に関連するメタデータ。
名前 | 型 | 説明 |
---|---|---|
createdAt |
string |
リソース作成のタイムスタンプ (UTC)。 |
createdBy |
string |
リソースを作成した ID。 |
createdByType |
リソースを作成した ID の種類。 |
|
lastModifiedAt |
string |
リソースの最終変更のタイムスタンプ (UTC) |
lastModifiedBy |
string |
リソースを最後に変更した ID。 |
lastModifiedByType |
リソースを最後に変更した ID の種類。 |
timeAggregation
集計の種類。 LogAlert の種類のルールにのみ関連し、必須です。
名前 | 型 | 説明 |
---|---|---|
Average |
string |
|
Count |
string |
|
Maximum |
string |
|
Minimum |
string |
|
Total |
string |
UserIdentityProperties
ユーザー割り当て ID プロパティ。
名前 | 型 | 説明 |
---|---|---|
clientId |
string |
ユーザー割り当て ID のクライアント ID。 |
principalId |
string |
ユーザー割り当て ID のプリンシパル ID。 |