Alerts - Refresh

Serviço:

Authorization

Versão da API:

2022-08-01-preview

Atualizar um alerta.

POST https://management.azure.com/{scope}/providers/Microsoft.Authorization/roleManagementAlerts/{alertId}/refresh?api-version=2022-08-01-preview

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
alertId	path	True	string	O nome do alerta a atualizar.
scope	path	True	string	O âmbito do alerta.
api-version	query	True	string	A versão da API a utilizar para esta operação.

Respostas

Name	Tipo	Description
202 Accepted	AlertOperationResult	Aceite. A resposta indica que o alerta está a ser atualizado. Cabeçalhos Location: string
Other Status Codes	CloudError	Resposta de erro que descreve a razão pela qual a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

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

Âmbitos

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

RefreshAlert

Pedido de amostra

HTTP

POST https://management.azure.com/subscriptions/afa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleManagementAlerts/AzureRolesAssignedOutsidePimAlert/refresh?api-version=2022-08-01-preview

Go

package armauthorization_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/authorization/armauthorization/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/310a0100f5b020c1900c527a6aa70d21992f078a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2022-08-01-preview/examples/RefreshAlert.json
func ExampleAlertsClient_BeginRefresh() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armauthorization.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewAlertsClient().BeginRefresh(ctx, "subscriptions/afa2a084-766f-4003-8ae1-c4aeb893a99f", "AzureRolesAssignedOutsidePimAlert", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}

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

JavaScript

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

/**
 * This sample demonstrates how to Refresh an alert.
 *
 * @summary Refresh an alert.
 * x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/preview/2022-08-01-preview/examples/RefreshAlert.json
 */
async function refreshAlert() {
  const scope = "subscriptions/afa2a084-766f-4003-8ae1-c4aeb893a99f";
  const alertId = "AzureRolesAssignedOutsidePimAlert";
  const credential = new DefaultAzureCredential();
  const client = new AuthorizationManagementClient(credential);
  const result = await client.alerts.beginRefreshAndWait(scope, alertId);
  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 da amostra

Código de estado:

202

Location: https://management.azure.com/subscriptions/afa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleManagementAlertOperations/{operationId}?api-version=2022-04-01-preview

{
  "id": "{operationId}",
  "status": "Running",
  "statusDetail": "{\"result\":[{\"name\":\"AzureRolesAssignedOutsidePimAlert\",\"statusDetail\":\"Alert scan is running.\"}]}",
  "lastActionDateTime": "2022-04-05T03:04:06.467+00:00",
  "createdDateTime": "2022-04-05T03:04:06.467+00:00",
  "resourceLocation": "https://management.azure.com/providers/Microsoft.Subscription/subscriptions/afa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleManagementAlerts/AzureRolesAssignedOutsidePimAlert?api-version=2022-08-01-preview"
}

Definições

Name	Description
AlertOperationResult	Resultado da operação de alerta
CloudError	Uma resposta de erro do serviço.
CloudErrorBody	Uma resposta de erro do serviço.

AlertOperationResult

Resultado da operação de alerta

Name	Tipo	Description
createdDateTime	string	A data de criação da operação de alerta.
id	string	O ID da operação de alerta.
lastActionDateTime	string	A data da última ação da operação de alerta.
resourceLocation	string	A localização do alerta associado à operação.
status	string	O estado da operação de alerta.
statusDetail	string	O detalhe do estado da operação de alerta.

CloudError

Uma resposta de erro do serviço.

Name	Tipo	Description
error	CloudErrorBody	Uma resposta de erro do serviço.

CloudErrorBody

Uma resposta de erro do serviço.

Name	Tipo	Description
code	string	Um identificador para o erro. Os códigos são invariantes e destinam-se a ser consumidos programaticamente.
message	string	Uma mensagem que descreve o erro, destinada a ser adequada para ser apresentada numa interface de utilizador.