Incidents - Run Playbook

Serviço:

Sentinel

Versão da API:

2024-01-01-preview

Dispara o guia estratégico em um incidente específico

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentIdentifier}/runPlaybook?api-version=2024-01-01-preview

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
incidentIdentifier	path	True	string
resourceGroupName	path	True	string	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string	A ID da assinatura de destino.
workspaceName	path	True	string	O nome do workspace. Padrão Regex: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$
api-version	query	True	string	A versão da API a ser usada para esta operação.

Corpo da solicitação

Nome	Tipo	Description
requestBody	ManualTriggerRequestBody

Respostas

Nome	Tipo	Description
204 No Content	object	Êxito
Other Status Codes	CloudError	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo 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

Incidents_RunPlaybook

Solicitação de exemplo

HTTP

POST https://management.azure.com/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/73e01a99-5cd7-4139-a149-9f2736ff2ar4/runPlaybook?api-version=2024-01-01-preview

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.SecurityInsights.Models;
using Azure.ResourceManager.SecurityInsights;

// Generated from example definition: specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-01-01-preview/examples/manualTrigger/Incidents_RunPlaybook.json
// this example is just showing the usage of "Incidents_RunPlaybook" 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 SecurityInsightsIncidentResource created on azure
// for more information of creating SecurityInsightsIncidentResource, please refer to the document of SecurityInsightsIncidentResource
string subscriptionId = "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0";
string resourceGroupName = "myRg";
string workspaceName = "myWorkspace";
string incidentIdentifier = "73e01a99-5cd7-4139-a149-9f2736ff2ar4";
ResourceIdentifier securityInsightsIncidentResourceId = SecurityInsightsIncidentResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, workspaceName, incidentIdentifier);
SecurityInsightsIncidentResource securityInsightsIncident = client.GetSecurityInsightsIncidentResource(securityInsightsIncidentResourceId);

// invoke the operation
BinaryData result = await securityInsightsIncident.RunPlaybookAsync();

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

Resposta de exemplo

Código de status:

204

{}

Definições

Nome	Description
CloudError	Estrutura de resposta de erro.
CloudErrorBody	Detalhes do erro.
ManualTriggerRequestBody

CloudError

Objeto

Estrutura de resposta de erro.

Nome	Tipo	Description
error	CloudErrorBody	Dados de erro

CloudErrorBody

Objeto

Detalhes do erro.

Nome	Tipo	Description
code	string	Um identificador para o erro. Os códigos são invariáveis e devem ser consumidos programaticamente.
message	string	Uma mensagem que descreve o erro, destinada a ser adequada para exibição em uma interface do usuário.

ManualTriggerRequestBody

Objeto

Nome	Tipo	Description
logicAppsResourceId	string
tenantId	string