Obtém um incidente associado a uma regra de alerta
GET https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/microsoft.insights/alertrules/{ruleName}/incidents/{incidentName}?api-version=2016-03-01
Parâmetros de URI
| Nome |
Em |
Obrigatório |
Tipo |
Description |
|
incidentName
|
path |
True
|
string
|
O nome do incidente a ser recuperado.
|
|
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
|
Incident
|
Solicitação bem-sucedida para um incidente relacionado à regra de alerta
|
|
Other Status Codes
|
ErrorResponse
|
Resposta de erro que descreve por que a operação falhou.
|
Segurança
azure_auth
Fluxo do OAuth2 do Azure Active Directory
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
| Nome |
Description |
|
user_impersonation
|
representar sua conta de usuário
|
Exemplos
Get a single alert rule incident
Sample Request
GET https://management.azure.com/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourcegroups/Rac46PostSwapRG/providers/microsoft.insights/alertrules/myRuleName/incidents/Website_started?api-version=2016-03-01
/**
* Samples for AlertRuleIncidents Get.
*/
public final class Main {
/*
* x-ms-original-file:
* specification/monitor/resource-manager/Microsoft.Insights/stable/2016-03-01/examples/getAlertRuleIncident.json
*/
/**
* Sample code: Get a single alert rule incident.
*
* @param azure The entry point for accessing resource management APIs in Azure.
*/
public static void getASingleAlertRuleIncident(com.azure.resourcemanager.AzureResourceManager azure) {
azure.diagnosticSettings().manager().serviceClient().getAlertRuleIncidents().getWithResponse("Rac46PostSwapRG",
"myRuleName", "Website_started", com.azure.core.util.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/blob/969fd0c2634fbcc1975d7abe3749330a5145a97c/specification/monitor/resource-manager/Microsoft.Insights/stable/2016-03-01/examples/getAlertRuleIncident.json
func ExampleAlertRuleIncidentsClient_Get() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armmonitor.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewAlertRuleIncidentsClient().Get(ctx, "Rac46PostSwapRG", "myRuleName", "Website_started", nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.Incident = armmonitor.Incident{
// Name: to.Ptr("Website_started"),
// ActivatedTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-09-13T15:45:26.979Z"); return t}()),
// IsActive: to.Ptr(true),
// ResolvedTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-09-13T22:14:28.979Z"); return t}()),
// RuleName: to.Ptr("myRuleName"),
// }
}
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 incident associated to an alert rule
*
* @summary Gets an incident associated to an alert rule
* x-ms-original-file: specification/monitor/resource-manager/Microsoft.Insights/stable/2016-03-01/examples/getAlertRuleIncident.json
*/
async function getASingleAlertRuleIncident() {
const subscriptionId =
process.env["MONITOR_SUBSCRIPTION_ID"] || "b67f7fec-69fc-4974-9099-a26bd6ffeda3";
const resourceGroupName = process.env["MONITOR_RESOURCE_GROUP"] || "Rac46PostSwapRG";
const ruleName = "myRuleName";
const incidentName = "Website_started";
const credential = new DefaultAzureCredential();
const client = new MonitorClient(credential, subscriptionId);
const result = await client.alertRuleIncidents.get(resourceGroupName, ruleName, incidentName);
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
using System;
using System.Threading.Tasks;
using System.Xml;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Monitor;
using Azure.ResourceManager.Monitor.Models;
using Azure.ResourceManager.Resources;
// Generated from example definition: specification/monitor/resource-manager/Microsoft.Insights/stable/2016-03-01/examples/getAlertRuleIncident.json
// this example is just showing the usage of "AlertRuleIncidents_Get" operation, for the dependent resources, they will have to be created separately.
// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);
// this example assumes you already have this AlertRuleResource created on azure
// for more information of creating AlertRuleResource, please refer to the document of AlertRuleResource
string subscriptionId = "b67f7fec-69fc-4974-9099-a26bd6ffeda3";
string resourceGroupName = "Rac46PostSwapRG";
string ruleName = "myRuleName";
ResourceIdentifier alertRuleResourceId = AlertRuleResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, ruleName);
AlertRuleResource alertRule = client.GetAlertRuleResource(alertRuleResourceId);
// invoke the operation
string incidentName = "Website_started";
MonitorIncident result = await alertRule.GetAlertRuleIncidentAsync(incidentName);
Console.WriteLine($"Succeeded: {result}");
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
Sample Response
{
"name": "Website_started",
"ruleName": "myRuleName",
"isActive": true,
"activatedTime": "2017-09-13T15:45:26.9792776Z",
"resolvedTime": "2017-09-13T22:14:28.9792776Z"
}
Definições
| Nome |
Description |
|
ErrorResponse
|
Descreve o formato da resposta de erro.
|
|
Incident
|
Um incidente de alerta indica o status de ativação de uma regra de alerta.
|
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.
|
Incident
Um incidente de alerta indica o status de ativação de uma regra de alerta.
| Nome |
Tipo |
Description |
|
activatedTime
|
string
|
A hora em que o incidente foi ativado no formato ISO8601.
|
|
isActive
|
boolean
|
Um booliano para indicar se o incidente está ativo ou resolvido.
|
|
name
|
string
|
Nome do incidente.
|
|
resolvedTime
|
string
|
A hora em que o incidente foi resolvido no formato ISO8601. Se for nulo, significa que o incidente ainda está ativo.
|
|
ruleName
|
string
|
Nome da regra associado ao incidente.
|