Scheduled Query Rules - Get

Referência

Serviço:: Monitor

Versão da API:: 2018-04-16

Obtém uma regra de Pesquisa de Logs

GET https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Insights/scheduledQueryRules/{ruleName}?api-version=2018-04-16

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
resourceGroupName	path	True	string	O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.
ruleName	path	True	string	O nome da regra.
subscriptionId	path	True	string	A ID da assinatura de destino.
api-version	query	True	string	A versão da API a ser usada para esta operação.

Respostas

Nome	Tipo	Description
200 OK	LogSearchRuleResource	Solicitação bem-sucedida para obter uma regra de Pesquisa de Logs
Other Status Codes	ErrorContract	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

Get rule

Solicitação de exemplo

GET https://management.azure.com/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourcegroups/Rac46PostSwapRG/providers/Microsoft.Insights/scheduledQueryRules/logalertfoo?api-version=2018-04-16

import com.azure.core.util.Context;

/** Samples for ScheduledQueryRules GetByResourceGroup. */
public final class Main {
    /*
     * x-ms-original-file: specification/monitor/resource-manager/Microsoft.Insights/stable/2018-04-16/examples/getScheduledQueryRules.json
     */
    /**
     * Sample code: Get rule.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getRule(com.azure.resourcemanager.AzureResourceManager azure) {
        azure
            .diagnosticSettings()
            .manager()
            .serviceClient()
            .getScheduledQueryRules()
            .getByResourceGroupWithResponse("Rac46PostSwapRG", "logalertfoo", Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armmonitor_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/monitor/armmonitor"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-04-16/examples/getScheduledQueryRules.json
func ExampleScheduledQueryRulesClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armmonitor.NewScheduledQueryRulesClient("b67f7fec-69fc-4974-9099-a26bd6ffeda3", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"Rac46PostSwapRG",
		"logalertfoo",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { MonitorClient } = require("@azure/arm-monitor");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets an Log Search rule
 *
 * @summary Gets an Log Search rule
 * x-ms-original-file: specification/monitor/resource-manager/Microsoft.Insights/stable/2018-04-16/examples/getScheduledQueryRules.json
 */
async function getRule() {
  const subscriptionId =
    process.env["MONITOR_SUBSCRIPTION_ID"] || "b67f7fec-69fc-4974-9099-a26bd6ffeda3";
  const resourceGroupName = process.env["MONITOR_RESOURCE_GROUP"] || "Rac46PostSwapRG";
  const ruleName = "logalertfoo";
  const credential = new DefaultAzureCredential();
  const client = new MonitorClient(credential, subscriptionId);
  const result = await client.scheduledQueryRules.get(resourceGroupName, ruleName);
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Resposta de exemplo

Código de status:: 200

{
  "id": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/microsoft.insights/scheduledQueryRules/logalertfoo",
  "name": "logalertfoo",
  "type": "Microsoft.Insights/scheduledQueryRules",
  "location": "West US",
  "tags": {},
  "properties": {
    "description": "log alert description",
    "enabled": "true",
    "lastUpdatedTime": "2017-06-23T21:23:52.0221265Z",
    "provisioningState": "Succeeded",
    "source": {
      "query": "requests",
      "queryType": "ResultCount",
      "dataSourceId": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/microsoft.insights/components/sampleAI"
    },
    "schedule": {
      "frequencyInMinutes": 15,
      "timeWindowInMinutes": 15
    },
    "action": {
      "odata.type": "Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction",
      "severity": "1",
      "trigger": {
        "thresholdOperator": "GreaterThan",
        "threshold": 3
      },
      "aznsAction": {
        "actionGroup": [],
        "emailSubject": "Email Header",
        "customWebhookPayload": "{}"
      }
    }
  }
}

Definições

Nome	Description
AlertingAction	Especifique a ação que precisa ser tomada quando o tipo de regra é Alerta
AlertSeverity	Nível de gravidade do alerta
AzNsActionGroup	Grupo de ações do Azure
ConditionalOperator	Critérios de Avaliação da Condição de Resultado.
Criteria	Especifica os critérios para converter log em métrica.
Dimension	Especifica os critérios para converter log em métrica.
enabled	O sinalizador que indica se a regra de Pesquisa de Logs está habilitada. O valor deve ser true ou false
ErrorContract	Descreve o formato da resposta de erro.
ErrorResponse	Descreve o formato da resposta de erro.
LogMetricTrigger	Um descritor de gatilho de métricas de log.
LogSearchRuleResource	O recurso regra de pesquisa de log.
LogToMetricAction	Especifique a ação que precisa ser tomada quando o tipo de regra está convertendo log em métrica
metricTriggerType	Tipo de gatilho de métrica – 'Consecutivo' ou 'Total'
operator	Operador para valores de dimensão
provisioningState	Estado de provisionamento da regra de consulta agendada
QueryType	Definir valor como 'ResultAccount'
Schedule	Define a frequência com que a pesquisa e o intervalo de tempo são executados.
Source	Especifica a consulta de pesquisa de logs.
TriggerCondition	A condição que resulta na regra de Pesquisa de Logs.

AlertingAction

Especifique a ação que precisa ser tomada quando o tipo de regra é Alerta

Nome	Tipo	Description
aznsAction	AzNsActionGroup	Referência do grupo de ações do Azure.
odata.type	string: Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction	Especifica a ação. Valores com suporte - AlertingAction, LogToMetricAction
severity	AlertSeverity	Severidade do alerta
throttlingInMin	integer	tempo (em minutos) para o qual os alertas devem ser limitados ou suprimidos.
trigger	TriggerCondition	A condição de gatilho que resulta na regra de alerta.

AlertSeverity

Nível de gravidade do alerta

Nome	Tipo	Description
0	string
1	string
2	string
3	string
4	string

AzNsActionGroup

Grupo de ações do Azure

Nome	Tipo	Description
actionGroup	string[]	Referência do Grupo de Ações do Azure.
customWebhookPayload	string	Conteúdo personalizado a ser enviado para todo o URI do webhook no grupo de ações do Azure
emailSubject	string	Substituição de assunto personalizado para todas as IDs de email no grupo de ações do Azure

ConditionalOperator

Critérios de Avaliação da Condição de Resultado.

Nome	Tipo	Description
Equal	string
GreaterThan	string
GreaterThanOrEqual	string
LessThan	string
LessThanOrEqual	string

Criteria

Especifica os critérios para converter log em métrica.

Nome	Tipo	Description
dimensions	Dimension[]	Lista de dimensões para criar a métrica
metricName	string	Nome da métrica

Dimension

Especifica os critérios para converter log em métrica.

Nome	Tipo	Description
name	string	Nome da dimensão
operator	operator	Operador para valores de dimensão
values	string[]	Lista de valores de dimensão

enabled

O sinalizador que indica se a regra de Pesquisa de Logs está habilitada. O valor deve ser true ou false

Nome	Tipo	Description
false	string
true	string

ErrorContract

Descreve o formato da resposta de erro.

Nome	Tipo	Description
error	ErrorResponse	Os detalhes do erro.

ErrorResponse

Descreve o formato da resposta de erro.

Nome	Tipo	Description
code	string	Código do erro
message	string	Mensagem de erro indicando por que a operação falhou.

LogMetricTrigger

Um descritor de gatilho de métricas de log.

Nome	Tipo	Valor padrão	Description
metricColumn	string		Avaliação da métrica em uma coluna específica
metricTriggerType	metricTriggerType	Consecutive	Tipo de gatilho de métrica – 'Consecutivo' ou 'Total'
threshold	number		O limite do gatilho de métrica.
thresholdOperator	ConditionalOperator	GreaterThanOrEqual	Operação de avaliação para Métrica -'GreaterThan' ou 'LessThan' ou 'Equal'.

LogSearchRuleResource

O recurso regra de pesquisa de log.

Nome	Tipo	Valor padrão	Description
etag	string		O campo de etag não é necessário. Se for fornecido no corpo da resposta, ele também deverá ser fornecido como um cabeçalho de acordo com a convenção de etag normal. As marcas de entidade são usadas para comparar duas ou mais entidades do mesmo recurso solicitado. HTTP/1.1 usa marcas de entidade nos campos de cabeçalho etag (seção 14.19), If-Match (seção 14.24), If-None-Match (seção 14.26) e If-Range (seção 14.27).
id	string		ID do recurso do Azure
kind	string		Metadados usados pelo portal/ferramentas/etc para renderizar experiências de experiência de usuário diferentes para recursos do mesmo tipo; Por exemplo, ApiApps são um tipo de Microsoft.Web/sites. Se houver suporte, o provedor de recursos deverá validar e persistir esse valor.
location	string		Localização do recurso
name	string		Nome do recurso do Azure
properties.action	Action: AlertingAction LogToMetricAction		A ação precisa ser tomada na execução da regra.
properties.autoMitigate	boolean	False	O sinalizador que indica se o alerta deve ser resolvido automaticamente ou não. O padrão é false.
properties.createdWithApiVersion	string		A versão da API usada ao criar essa regra de alerta
properties.description	string		A descrição da regra de Pesquisa de Logs.
properties.displayName	string		O nome de exibição da regra de alerta
properties.enabled	enabled		O sinalizador que indica se a regra de Pesquisa de Logs está habilitada. O valor deve ser true ou false
properties.isLegacyLogAnalyticsRule	boolean		True se a regra de alerta for uma regra herdada do Log Analytic
properties.lastUpdatedTime	string		Última vez em que a regra foi atualizada no formato IS08601.
properties.provisioningState	provisioningState		Estado de provisionamento da regra de consulta agendada
properties.schedule	Schedule		Agendamento (Frequência, Janela de Tempo) para a regra. Necessário para o tipo de ação – AlertingAction
properties.source	Source		Fonte de dados em relação a qual regra consultará dados
tags	object		Marcações de recursos
type	string		Tipo de recurso do Azure

LogToMetricAction

Especifique a ação que precisa ser tomada quando o tipo de regra está convertendo log em métrica

Nome	Tipo	Description
criteria	Criteria[]	Critérios de métrica
odata.type	string: Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction	Especifica a ação. Valores com suporte - AlertingAction, LogToMetricAction

metricTriggerType

Tipo de gatilho de métrica – 'Consecutivo' ou 'Total'

Nome	Tipo	Description
Consecutive	string
Total	string

operator

Operador para valores de dimensão

Nome	Tipo	Description
Include	string

provisioningState

Estado de provisionamento da regra de consulta agendada

Nome	Tipo	Description
Canceled	string
Deploying	string
Failed	string
Succeeded	string

QueryType

Definir valor como 'ResultAccount'

Nome	Tipo	Description
ResultCount	string

Schedule

Define a frequência com que a pesquisa e o intervalo de tempo são executados.

Nome	Tipo	Description
frequencyInMinutes	integer	frequência (em minutos) na qual a condição da regra deve ser avaliada.
timeWindowInMinutes	integer	Janela de tempo para a qual os dados precisam ser buscados para consulta (deve ser maior ou igual a frequencyInMinutes).

Source

Especifica a consulta de pesquisa de logs.

Nome	Tipo	Description
authorizedResources	string[]	Lista de recursos referenciados na consulta
dataSourceId	string	O URI do recurso sobre o qual a consulta de pesquisa de log deve ser executada.
query	string	Consulta de pesquisa de log. Necessário para o tipo de ação – AlertingAction
queryType	QueryType	Defina o valor como 'ResultCount'.

TriggerCondition

A condição que resulta na regra de Pesquisa de Logs.

Nome	Tipo	Valor padrão	Description
metricTrigger	LogMetricTrigger		Condição de gatilho para a regra de consulta de métrica
threshold	number		Limite de resultado ou contagem com base em qual regra deve ser disparada.
thresholdOperator	ConditionalOperator	GreaterThanOrEqual	Operação de avaliação para regra – 'GreaterThan' ou 'LessThan.

Compartilhar via

Scheduled Query Rules - Get

Parâmetros de URI

Respostas

Segurança

azure_auth

Escopos

Exemplos

Get rule

Solicitação de exemplo

Resposta de exemplo

Definições

AlertingAction

AlertSeverity

AzNsActionGroup

ConditionalOperator

Criteria

Dimension

enabled

ErrorContract

ErrorResponse

LogMetricTrigger

LogSearchRuleResource

LogToMetricAction

metricTriggerType

operator

provisioningState

QueryType

Schedule

Source

TriggerCondition

Recursos adicionais