Alerts - Update

Référence

Service:: Authorization

Version d'API:: 2022-08-01-preview

Mettre à jour une alerte.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
alertId	path	True	string	Nom de l’alerte à ignorer.
scope	path	True	string	Étendue de l’alerte.
api-version	query	True	string	Version de l’API à utiliser pour cette opération.

Corps de la demande

Nom	Type	Description
properties.isActive	boolean	False par défaut ; true si l’alerte est active.

Réponses

Nom	Type	Description
204 No Content		NoContent : mise à jour réussie de l’alerte.
Other Status Codes	CloudError	Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

DeactivateAlert

Exemple de requête

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

Exemple de réponse

Code d’état:: 204

Définitions

Nom	Description
Alert	Alerte.
AlertConfiguration	Configuration de l’alerte.
AlertDefinition	Définition d’alerte
AlertIncident	Incident d’alerte
CloudError	Réponse d’erreur du service.
CloudErrorBody	Réponse d’erreur du service.
SeverityLevel	Niveau de gravité de l’alerte.

Alert

Alerte.

Nom	Type	Description
id	string	ID d’alerte.
name	string	Nom de l’alerte.
properties.alertConfiguration	AlertConfiguration	Configuration de l’alerte.
properties.alertDefinition	AlertDefinition	Définition d'alerte.
properties.alertIncidents	AlertIncident[]	Incidents d’alerte.
properties.incidentCount	integer	Nombre d’incidents générés de l’alerte.
properties.isActive	boolean	False par défaut ; true si l’alerte est active.
properties.lastModifiedDateTime	string	Date à laquelle la configuration de l’alerte a été mise à jour ou de nouveaux incidents ont été générés.
properties.lastScannedDateTime	string	Date de la dernière analyse de l’alerte.
properties.scope	string	Étendue de l’alerte.
type	string	Type d’alerte.

AlertConfiguration

Configuration de l’alerte.

Nom	Type	Description
id	string	ID de configuration de l’alerte.
name	string	Nom de la configuration de l’alerte.
properties.alertConfigurationType	string	Type de configuration d’alerte.
properties.alertDefinition	AlertDefinition	Définition d'alerte.
properties.alertDefinitionId	string	ID de définition d'alerte.
properties.isEnabled	boolean	True si l’alerte est activée, false désactive l’analyse de l’alerte spécifique.
properties.scope	string	Étendue de l’alerte.
type	string	Type de configuration d’alerte.

AlertDefinition

Définition d’alerte

Nom	Type	Description
id	string	ID de définition d'alerte.
name	string	Nom de la définition d’alerte.
properties.description	string	Description de l’alerte.
properties.displayName	string	Nom complet de l’alerte.
properties.howToPrevent	string	Moyens d’empêcher l’alerte.
properties.isConfigurable	boolean	True si la configuration de l’alerte peut être configurée ; false, sinon.
properties.isRemediatable	boolean	True si l’alerte peut être corrigée ; false, sinon.
properties.mitigationSteps	string	Méthodes permettant d’atténuer l’alerte.
properties.scope	string	Étendue de l’alerte.
properties.securityImpact	string	Impact sur la sécurité de l’alerte.
properties.severityLevel	SeverityLevel	Niveau de gravité de l’alerte.
type	string	Type de définition d’alerte.

AlertIncident

Incident d’alerte

Nom	Type	Description
id	string	ID d’incident d’alerte.
name	string	Nom de l’incident d’alerte.
properties.alertIncidentType	string	Type d’incident d’alerte.
type	string	Type d’incident d’alerte.

CloudError

Réponse d’erreur du service.

Nom	Type	Description
error	CloudErrorBody	Réponse d’erreur du service.

CloudErrorBody