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 de URI

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

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
properties.alertConfigurationType	True	string	O tipo de configuração de alerta.
properties.isEnabled		boolean	True se o alerta estiver habilitado, false desabilitará a verificação do alerta específico.

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

UpdateAlertConfiguration

Solicitação de exemplo

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 de exemplo

Código de status:

204

Definições

Nome	Description
AlertConfiguration	Configuração de alerta.
AlertDefinition	Definição do alerta
CloudError	Uma resposta de erro do serviço.
CloudErrorBody	Uma resposta de erro do serviço.
SeverityLevel	Nível de severidade do 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.

CloudError

Uma resposta de erro do serviço.

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

CloudErrorBody

Uma resposta de erro do serviço.

Nome	Tipo	Description
code	string	Um identificador para o erro. Os códigos são invariáveis e devem ser consumidos programaticamente.
message	string	Uma mensagem que descreve o erro, destinada a ser adequada para exibição em uma interface do usuário.

SeverityLevel

Nível de severidade do alerta.

Nome	Tipo	Description
High	string
Low	string
Medium	string