Alert Configurations - Update

Serviço:

Authorization

Versão da API:

2022-08-01-preview

Atualizar uma configuração de alerta.

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

Parâmetros do URI

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

Corpo do Pedido

Name	Necessário	Tipo	Description
properties.alertConfigurationType	True	string	O tipo de configuração de alerta.
properties.isEnabled		boolean	Verdadeiro se o alerta estiver ativado, falso desativará a análise do alerta específico.

Respostas

Name	Tipo	Description
204 No Content		NoContent – o alerta foi atualizado com êxito.
Other Status Codes	CloudError	Resposta de erro que descreve o motivo 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

UpdateAlertConfiguration

Pedido de amostra

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

Resposta da amostra

Código de estado:

204

Definições

Name	Description
AlertConfiguration	Configuração de alertas.
AlertDefinition	Definição de alerta
CloudError	Uma resposta de erro do serviço.
CloudErrorBody	Uma resposta de erro do serviço.
SeverityLevel	Nível de gravidade do alerta.

AlertConfiguration

Configuração de alertas.

Name	Tipo	Description
id	string	O 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	O ID de definição de alerta.
properties.isEnabled	boolean	Verdadeiro se o alerta estiver ativado, falso desativará a análise do alerta específico.
properties.scope	string	O âmbito do alerta.
type	string	O tipo de configuração de alerta.

AlertDefinition

Definição de alerta

Name	Tipo	Description
id	string	O ID de definição de alerta.
name	string	O nome da definição de alerta.
properties.description	string	A descrição do alerta.
properties.displayName	string	O nome a apresentar do alerta.
properties.howToPrevent	string	As formas de impedir o alerta.
properties.isConfigurable	boolean	Verdadeiro se a configuração do alerta puder ser configurada; falso, caso contrário.
properties.isRemediatable	boolean	Verdadeiro se o alerta puder ser remediado; falso, caso contrário.
properties.mitigationSteps	string	Os métodos para mitigar o alerta.
properties.scope	string	O âmbito do alerta.
properties.securityImpact	string	Impacto de segurança do alerta.
properties.severityLevel	SeverityLevel	Nível de gravidade do alerta.
type	string	O tipo de definiçã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, que se destina a ser adequada para ser apresentada numa interface de utilizador.

SeverityLevel

Nível de gravidade do alerta.

Name	Tipo	Description
High	string
Low	string
Medium	string