Alerts - Update

Referência

Serviço:: Authorization

Versão da API:: 2022-08-01-preview

Atualizar um alerta.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
alertId	path	True	string	O nome do alerta a ser ignorado.
scope	path	True	string	O escopo do alerta.
api-version	query	True	string	A versão da API a ser usada para esta operação.

Corpo da solicitação

Nome	Tipo	Description
properties.isActive	boolean	False por padrão; true se o alerta estiver ativo.

Respostas

Nome	Tipo	Description
204 No Content		NoContent – o alerta foi atualizado com êxito.
Other Status Codes	CloudError	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

DeactivateAlert

Solicitação de exemplo

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

{
  "properties": {
    "isActive": false
  }
}

package armauthorization_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"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/UpdateAlert.json
func ExampleAlertsClient_Update() {
	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)
	}
	_, err = clientFactory.NewAlertsClient().Update(ctx, "subscriptions/afa2a084-766f-4003-8ae1-c4aeb893a99f", "TooManyPermanentOwnersAssignedToResource", armauthorization.Alert{
		Properties: &armauthorization.AlertProperties{
			IsActive: to.Ptr(false),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %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

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

/**
 * This sample demonstrates how to Update an alert.
 *
 * @summary Update an alert.
 * x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/preview/2022-08-01-preview/examples/UpdateAlert.json
 */
async function deactivateAlert() {
  const scope = "subscriptions/afa2a084-766f-4003-8ae1-c4aeb893a99f";
  const alertId = "TooManyPermanentOwnersAssignedToResource";
  const parameters = { isActive: false };
  const credential = new DefaultAzureCredential();
  const client = new AuthorizationManagementClient(credential);
  const result = await client.alerts.update(scope, alertId, parameters);
  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:: 204

Definições

Nome	Description
Alert	O alerta.
AlertConfiguration	Configuração de alerta.
AlertDefinition	Definição do alerta
AlertIncident	Incidente de alerta
CloudError	Uma resposta de erro do serviço.
CloudErrorBody	Uma resposta de erro do serviço.
SeverityLevel	Nível de severidade do alerta.

Alert

O alerta.

Nome	Tipo	Description
id	string	A ID do alerta.
name	string	O nome do alerta.
properties.alertConfiguration	AlertConfiguration	A configuração do alerta.
properties.alertDefinition	AlertDefinition	A definição de alerta.
properties.alertIncidents	AlertIncident[]	Os incidentes de alerta.
properties.incidentCount	integer	O número de incidentes gerados do alerta.
properties.isActive	boolean	False por padrão; true se o alerta estiver ativo.
properties.lastModifiedDateTime	string	A data e hora em que a configuração do alerta foi atualizada ou novos incidentes foram gerados.
properties.lastScannedDateTime	string	A data e hora em que o alerta foi verificado pela última vez.
properties.scope	string	O escopo do alerta.
type	string	O tipo de alerta.

AlertConfiguration

Configuração de alerta.

Nome	Tipo	Description
id	string	A ID de configuração do alerta.
name	string	O nome da configuração do alerta.
properties.alertConfigurationType	string	O tipo de configuração de alerta.
properties.alertDefinition	AlertDefinition	A definição de alerta.
properties.alertDefinitionId	string	A ID de definição de alerta.
properties.isEnabled	boolean	True se o alerta estiver habilitado, false desabilitará a verificação do alerta específico.
properties.scope	string	O escopo do alerta.
type	string	O tipo de configuração de alerta.

AlertDefinition

Definição do alerta

Nome	Tipo	Description
id	string	A ID de definição de alerta.
name	string	O nome da definição de alerta.
properties.description	string	Descrição do alerta.
properties.displayName	string	O nome de exibição do alerta.
properties.howToPrevent	string	As maneiras de evitar o alerta.
properties.isConfigurable	boolean	True se a configuração de alerta puder ser configurada; false, caso contrário.
properties.isRemediatable	boolean	True se o alerta puder ser corrigido; false, caso contrário.
properties.mitigationSteps	string	Os métodos para atenuar o alerta.
properties.scope	string	O escopo do alerta.
properties.securityImpact	string	Impacto de segurança do alerta.
properties.severityLevel	SeverityLevel	Nível de severidade do alerta.
type	string	O tipo de definição de alerta.

AlertIncident

Incidente de alerta

Nome	Tipo	Description
id	string	A ID do incidente de alerta.
name	string	O nome do incidente de alerta.
properties.alertIncidentType	string	O tipo de incidente de alerta.
type	string	O tipo de incidente de alerta.

CloudError

Uma resposta de erro do serviço.

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

CloudErrorBody