Alert Configurations - Update

Servicio:

Authorization

Versión de la API:

2022-08-01-preview

Actualizar una configuración de alerta.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
alertId	path	True	string	Nombre de la configuración de alerta que se va a actualizar.
scope	path	True	string	Ámbito de la configuración de alerta.
api-version	query	True	string	Versión de API que se usará para la operación.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
properties.alertConfigurationType	True	string	Tipo de configuración de alerta.
properties.isEnabled		boolean	True si la alerta está habilitada, false deshabilitará el examen de la alerta específica.

Respuestas

Nombre	Tipo	Description
204 No Content		NoContent: actualizó correctamente la alerta.
Other Status Codes	CloudError	Respuesta de error que describe el motivo del error de la operación.

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

UpdateAlertConfiguration

Solicitud de ejemplo

HTTP

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

{
  "properties": {
    "isEnabled": true,
    "thresholdNumberOfOwners": 2,
    "alertConfigurationType": "TooManyOwnersAssignedToResourceAlertConfiguration"
  }
}

Go

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/UpdateAlertConfiguration.json
func ExampleAlertConfigurationsClient_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.NewAlertConfigurationsClient().Update(ctx, "subscriptions/afa2a084-766f-4003-8ae1-c4aeb893a99f", "TooManyOwnersAssignedToResource", armauthorization.AlertConfiguration{
		Properties: &armauthorization.TooManyOwnersAssignedToResourceAlertConfigurationProperties{
			AlertConfigurationType:  to.Ptr("TooManyOwnersAssignedToResourceAlertConfiguration"),
			IsEnabled:               to.Ptr(true),
			ThresholdNumberOfOwners: to.Ptr[int32](2),
		},
	}, 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

JavaScript

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

/**
 * This sample demonstrates how to Update an alert configuration.
 *
 * @summary Update an alert configuration.
 * x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/preview/2022-08-01-preview/examples/UpdateAlertConfiguration.json
 */
async function updateAlertConfiguration() {
  const scope = "subscriptions/afa2a084-766f-4003-8ae1-c4aeb893a99f";
  const alertId = "TooManyOwnersAssignedToResource";
  const parameters = {
    alertConfigurationType: "TooManyOwnersAssignedToResourceAlertConfiguration",
    isEnabled: true,
  };
  const credential = new DefaultAzureCredential();
  const client = new AuthorizationManagementClient(credential);
  const result = await client.alertConfigurations.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

Respuesta de muestra

status code:

204

Definiciones

Nombre	Description
AlertConfiguration	Configuración de alertas.
AlertDefinition	Definición de la alerta
CloudError	Respuesta de error del servicio.
CloudErrorBody	Respuesta de error del servicio.
SeverityLevel	Nivel de gravedad de la alerta.

AlertConfiguration

Configuración de alertas.

Nombre	Tipo	Description
id	string	Identificador de configuración de alerta.
name	string	Nombre de configuración de alerta.
properties.alertConfigurationType	string	Tipo de configuración de alerta.
properties.alertDefinition	AlertDefinition	Definición de la alerta.
properties.alertDefinitionId	string	Identificador de la definición de alerta.
properties.isEnabled	boolean	True si la alerta está habilitada, false deshabilitará el examen de la alerta específica.
properties.scope	string	Ámbito de alerta.
type	string	Tipo de configuración de alerta.

AlertDefinition

Definición de la alerta

Nombre	Tipo	Description
id	string	Identificador de la definición de alerta.
name	string	Nombre de la definición de alerta.
properties.description	string	La descripción de la alerta.
properties.displayName	string	Nombre para mostrar de la alerta.
properties.howToPrevent	string	Formas de evitar la alerta.
properties.isConfigurable	boolean	True si se puede configurar la configuración de la alerta; false, de lo contrario.
properties.isRemediatable	boolean	True si se puede corregir la alerta; false, de lo contrario.
properties.mitigationSteps	string	Métodos para mitigar la alerta.
properties.scope	string	Ámbito de alerta.
properties.securityImpact	string	Impacto en la seguridad de la alerta.
properties.severityLevel	SeverityLevel	Nivel de gravedad de la alerta.
type	string	Tipo de definición de alerta.

CloudError

Respuesta de error del servicio.

Nombre	Tipo	Description
error	CloudErrorBody	Respuesta de error del servicio.

CloudErrorBody

Respuesta de error del servicio.

Nombre	Tipo	Description
code	string	Identificador del error. Los códigos son invariables y están diseñados para consumirse mediante programación.
message	string	Mensaje que describe el error, diseñado para ser adecuado para su presentación en una interfaz de usuario.

SeverityLevel

Nivel de gravedad de la alerta.

Nombre	Tipo	Description
High	string
Low	string
Medium	string