Scheduled Query Rules - List By Subscription

Başvuru

Service:: Monitor

API Version:: 2021-08-01

Abonelikte zamanlanmış sorgu kuralı tanımlarını alma.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Insights/scheduledQueryRules?api-version=2021-08-01

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
subscriptionId	path	True	string	Hedef aboneliğin kimliği.
api-version	query	True	string	Bu işlem için kullanılacak API sürümü.

Yanıtlar

Name	Tür	Description
200 OK	ScheduledQueryRuleResourceCollection	Zamanlanmış sorgu kurallarının listesi için başarılı istek
Other Status Codes	ErrorContract	BadRequest

Güvenlik

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	kullanıcı hesabınızın kimliğine bürünme

Örnekler

List scheduled query rules by subscription

Sample Request

HTTP

GET https://management.azure.com/subscriptions/dd4bfc94-a096-412b-9c43-4bd13e35afbc/providers/Microsoft.Insights/scheduledQueryRules?api-version=2021-08-01

Sample Response

Status code:: 200

{
  "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"
        ],
        "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/MyResourceGroupName2/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"
        ],
        "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
      }
    }
  ]
}

Tanımlar

Name	Description
Actions	Uyarı tetiklendiğinde çağrılacak eylemler.
AlertSeverity	Uyarının önem derecesi. [0-4] arasında bir tamsayı olmalıdır. 0 değeri en severest değeridir. İlgili ve yalnızca LogAlert türündeki kurallar için gereklidir.
Condition	Zamanlanmış sorgu kuralının koşulu.
conditionOperator	Ölçüt işleci. İlgili ve yalnızca LogAlert türündeki kurallar için gereklidir.
createdByType	Kaynağı oluşturan kimliğin türü.
Dimension	Boyut bölme ve filtreleme tanımı
dimensionOperator	Boyut değerleri için işleç
ErrorAdditionalInfo	Kaynak yönetimi hatası ek bilgileri.
ErrorContract	Hata yanıtının biçimini açıklar.
ErrorResponse	Hata Yanıtı
FailingPeriods	Seçilen geri arama zamanı penceresinde uyarı vermek için gereken en düşük ihlal sayısı. Yalnızca LogAlert türündeki kurallar için geçerlidir.
Kind	Zamanlanmış sorgu kuralının türünü gösterir. Varsayılan değer LogAlert'tır.
ScheduledQueryRuleCriteria	Zamanlanmış sorgu kuralının koşullarını tanımlayan kural ölçütleri.
ScheduledQueryRuleResource	Zamanlanmış sorgu kuralı kaynağı.
ScheduledQueryRuleResourceCollection	Zamanlanmış sorgu kuralı kaynaklarından oluşan bir koleksiyonu temsil eder.
systemData	Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.
timeAggregation	Toplama türü. İlgili ve yalnızca LogAlert türündeki kurallar için gereklidir.

Actions

Uyarı tetiklendiğinde çağrılacak eylemler.

Name	Tür	Description
actionGroups	string[]	Uyarı tetiklendiğinde çağrılacak Eylem Grubu kaynak kimlikleri.
customProperties	object	Uyarı yükünün özellikleri.

AlertSeverity

Uyarının önem derecesi. [0-4] arasında bir tamsayı olmalıdır. 0 değeri en severest değeridir. İlgili ve yalnızca LogAlert türündeki kurallar için gereklidir.

Name	Tür	Description
0	Integer
1	Integer
2	Integer
3	Integer
4	Integer

Condition

Zamanlanmış sorgu kuralının koşulu.

Name	Tür	Description
dimensions	Dimension[]	Boyutlar koşullarının listesi
failingPeriods	FailingPeriods	Uyarı vermek için gereken, seçilen geri arama zamanı penceresinde gereken en az ihlal sayısı. Yalnızca LogAlert türündeki kurallarla ilgilidir.
metricMeasureColumn	string	Ölçüm ölçü numarasını içeren sütun. Yalnızca LogAlert türündeki kurallarla ilgilidir.
metricName	string	Gönderilecek ölçümün adı. İlgili ve yalnızca LogToMetric türündeki kurallar için gereklidir.
operator	conditionOperator	Ölçüt işleci. İlgili ve yalnızca LogAlert türündeki kurallar için gereklidir.
query	string	Günlük sorgusu uyarısı
resourceIdColumn	string	Kaynak kimliğini içeren sütun. Sütunun içeriği kaynak kimliği olarak biçimlendirilmiş bir uri olmalıdır. Yalnızca LogAlert türündeki kurallarla ilgilidir.
threshold	number	uyarıyı etkinleştiren ölçüt eşiği değeri. İlgili ve yalnızca LogAlert türündeki kurallar için gereklidir.
timeAggregation	timeAggregation	Toplama türü. İlgili ve yalnızca LogAlert türündeki kurallar için gereklidir.

conditionOperator

Ölçüt işleci. İlgili ve yalnızca LogAlert türündeki kurallar için gereklidir.

Name	Tür	Description
Equals	string
GreaterThan	string
GreaterThanOrEqual	string
LessThan	string
LessThanOrEqual	string

createdByType

Kaynağı oluşturan kimliğin türü.

Name	Tür	Description
Application	string
Key	string
ManagedIdentity	string
User	string

Dimension

Boyut bölme ve filtreleme tanımı

Name	Tür	Description
name	string	Boyutun adı
operator	dimensionOperator	Boyut değerleri için işleç
values	string[]	Boyut değerleri listesi

dimensionOperator

Boyut değerleri için işleç

Name	Tür	Description
Exclude	string
Include	string

ErrorAdditionalInfo

Kaynak yönetimi hatası ek bilgileri.

Name	Tür	Description
info	object	Ek bilgiler.
type	string	Ek bilgi türü.

ErrorContract

Hata yanıtının biçimini açıklar.

Name	Tür	Description
error	ErrorResponse	Hata Yanıtı Hata ayrıntıları.

ErrorResponse

Hata Yanıtı

Name	Tür	Description
additionalInfo	ErrorAdditionalInfo[]	Hata ek bilgileri.
code	string	Hata kodu.
details	ErrorResponse[]	Hata ayrıntıları.
message	string	Hata iletisi.
target	string	Hata hedefi.

FailingPeriods

Seçilen geri arama zamanı penceresinde uyarı vermek için gereken en düşük ihlal sayısı. Yalnızca LogAlert türündeki kurallar için geçerlidir.

Name	Tür	Varsayılan değer	Description
minFailingPeriodsToAlert	integer	1	Uyarı tetikleme ihlallerinin sayısı. NumberOfEvaluationPeriods değerinden küçük veya buna eşit olmalıdır. Varsayılan değer 1'dir
numberOfEvaluationPeriods	integer	1	Toplanan geri arama noktalarının sayısı. Geri arama zamanı penceresi, toplama ayrıntı düzeyi (windowSize) ve seçilen toplam nokta sayısına göre hesaplanır. Varsayılan değer 1'dir

Kind

Zamanlanmış sorgu kuralının türünü gösterir. Varsayılan değer LogAlert'tır.

Name	Tür	Description
LogAlert	string
LogToMetric	string

ScheduledQueryRuleCriteria

Zamanlanmış sorgu kuralının koşullarını tanımlayan kural ölçütleri.

Name	Tür	Description
allOf	Condition[]	Belirtilen kapsamlara göre değerlendirilecek koşulların listesi

ScheduledQueryRuleResource

Zamanlanmış sorgu kuralı kaynağı.

Name	Tür	Description
etag	string	Etag alanı gerekli değildir . Yanıt gövdesinde sağlanıyorsa, normal etag kuralına göre üst bilgi olarak da sağlanmalıdır. Varlık etiketleri, aynı istenen kaynaktan iki veya daha fazla varlığı karşılaştırmak için kullanılır. HTTP/1.1, etag (bölüm 14.19), If-Match (bölüm 14.24), If-None-Match (bölüm 14.26) ve If-Range (bölüm 14.27) üst bilgi alanlarında varlık etiketlerini kullanır.
id	string	Kaynağın tam kaynak kimliği. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind	Kind	Zamanlanmış sorgu kuralının türünü gösterir. Varsayılan değer LogAlert'tır.
location	string	Kaynağın bulunduğu coğrafi konum
name	string	Kaynağın adı
properties.actions	Actions	Uyarı tetiklendiğinde çağrılacak eylemler.
properties.autoMitigate	boolean	Uyarının otomatik olarak çözümlenip çözümlenmeyeceğini gösteren bayrak. Varsayılan değer true'dur. Yalnızca LogAlert türündeki kurallarla ilgilidir.
properties.checkWorkspaceAlertsStorageConfigured	boolean	Bu zamanlanmış sorgu kuralının müşterinin depolama alanında depolanıp depolanmayacağını gösteren bayrak. Varsayılan değer false. Yalnızca LogAlert türündeki kurallarla ilgilidir.
properties.createdWithApiVersion	string	Bu uyarı kuralını oluştururken kullanılan api sürümü
properties.criteria	ScheduledQueryRuleCriteria	Zamanlanmış sorgu kuralının koşullarını tanımlayan kural ölçütleri.
properties.description	string	Zamanlanmış sorgu kuralının açıklaması.
properties.displayName	string	Uyarı kuralının görünen adı
properties.enabled	boolean	Bu zamanlanmış sorgu kuralının etkinleştirilip etkinleştirilmediğini gösteren bayrak. Değer true veya false olmalıdır
properties.evaluationFrequency	string	Zamanlanan sorgu kuralının ISO 8601 süre biçiminde ne sıklıkta temsil edilir? İlgili ve yalnızca LogAlert türündeki kurallar için gereklidir.
properties.isLegacyLogAnalyticsRule	boolean	Uyarı kuralı eski Log Analytic kuralıysa True
properties.isWorkspaceAlertsStorageConfigured	boolean	Bu zamanlanmış sorgu kuralının müşterinin depolama alanında depolanacak şekilde yapılandırılıp yapılandırılmadığını gösteren bayrak. Varsayılan değer false.
properties.muteActionsDuration	string	Uyarı tetiklendiğinde seçilen süre (ISO 8601 süre biçiminde) için eylemlerin sesini kapatın. Yalnızca LogAlert türündeki kurallarla ilgilidir.
properties.overrideQueryTimeRange	string	Belirtilirse sorgu zaman aralığını geçersiz kılar (varsayılan değer WindowSize*NumberOfEvaluationPeriods'tır). Yalnızca LogAlert türündeki kurallarla ilgilidir.
properties.scopes	string[]	Bu zamanlanmış sorgu kuralının kapsamına alınan kaynak kimliklerinin listesi.
properties.severity	AlertSeverity	Uyarının önem derecesi. [0-4] arasında bir tamsayı olmalıdır. 0 değeri en severest değeridir. İlgili ve yalnızca LogAlert türündeki kurallar için gereklidir.
properties.skipQueryValidation	boolean	Sağlanan sorgunun doğrulanıp doğrulanmayacağını gösteren bayrak. Varsayılan değer false. Yalnızca LogAlert türündeki kurallarla ilgilidir.
properties.targetResourceTypes	string[]	Uyarının oluşturulduğu/güncelleştirildiği hedef kaynakların kaynak türü listesi. Örneğin, kapsam bir kaynak grubuysa ve targetResourceTypes Microsoft.Compute/virtualMachines ise, kaynak grubundaki uyarı ölçütlerini karşılayan her sanal makine için farklı bir uyarı tetiklenir. Yalnızca LogAlert türündeki kurallarla ilgilidir
properties.windowSize	string	Uyarı sorgusunun yürütüleceği süre (depo gözü boyutu) (ISO 8601 süre biçiminde). İlgili ve yalnızca LogAlert türündeki kurallar için gereklidir.
systemData	systemData	ScheduledQueryRule SystemData.
tags	object	Kaynak etiketleri.
type	string	Kaynağın türü. Örneğin, "Microsoft.Compute/virtualMachines" veya "Microsoft.Storage/storageAccounts"

ScheduledQueryRuleResourceCollection

Zamanlanmış sorgu kuralı kaynaklarından oluşan bir koleksiyonu temsil eder.

Name	Tür	Description
nextLink	string	Sonraki öğe kümesini almak için bağlantı sağlar.
value	ScheduledQueryRuleResource[]	Zamanlanmış sorgu kuralı kaynaklarının değerleri.

systemData

Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

Name	Tür	Description
createdAt	string	Kaynak oluşturma (UTC) zaman damgası.
createdBy	string	Kaynağı oluşturan kimlik.
createdByType	createdByType	Kaynağı oluşturan kimliğin türü.
lastModifiedAt	string	Kaynağın son değişikliğinin zaman damgası (UTC)
lastModifiedBy	string	Kaynağı son değiştiren kimlik.
lastModifiedByType	createdByType	Kaynağı en son değiştiren kimliğin türü.

timeAggregation

Toplama türü. İlgili ve yalnızca LogAlert türündeki kurallar için gereklidir.

Name	Tür	Description
Average	string
Count	string
Maximum	string
Minimum	string
Total	string