Alert Configurations - Update

Reference

Service:: Authorization

API Version:: 2022-08-01-preview

Update an alert configuration.

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

URI Parameters

Name	In	Required	Type	Description
alertId	path	True	string	The name of the alert configuration to update.
scope	path	True	string	The scope of the alert configuration.
api-version	query	True	string	The API version to use for this operation.

Request Body

Name	Required	Type	Description
properties.alertConfigurationType	True	string	The alert configuration type.
properties.isEnabled		boolean	True if the alert is enabled, false will disable the scanning for the specific alert.

Responses

Name	Type	Description
204 No Content		NoContent - Successfully updated the alert.
Other Status Codes	CloudError	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

UpdateAlertConfiguration

Sample Request

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"
  }
}

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

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

Sample Response

Status code:: 204

Definitions

Name	Description
AlertConfiguration	Alert configuration.
AlertDefinition	Alert definition
CloudError	An error response from the service.
CloudErrorBody	An error response from the service.
SeverityLevel	Severity level of the alert.

AlertConfiguration

Alert configuration.

Name	Type	Description
id	string	The alert configuration ID.
name	string	The alert configuration name.
properties.alertConfigurationType	string	The alert configuration type.
properties.alertDefinition	AlertDefinition	The alert definition.
properties.alertDefinitionId	string	The alert definition ID.
properties.isEnabled	boolean	True if the alert is enabled, false will disable the scanning for the specific alert.
properties.scope	string	The alert scope.
type	string	The alert configuration type.

AlertDefinition

Alert definition

Name	Type	Description
id	string	The alert definition ID.
name	string	The alert definition name.
properties.description	string	The alert description.
properties.displayName	string	The alert display name.
properties.howToPrevent	string	The ways to prevent the alert.
properties.isConfigurable	boolean	True if the alert configuration can be configured; false, otherwise.
properties.isRemediatable	boolean	True if the alert can be remediated; false, otherwise.
properties.mitigationSteps	string	The methods to mitigate the alert.
properties.scope	string	The alert scope.
properties.securityImpact	string	Security impact of the alert.
properties.severityLevel	SeverityLevel	Severity level of the alert.
type	string	The alert definition type.

CloudError

An error response from the service.

Name	Type	Description
error	CloudErrorBody	An error response from the service.

CloudErrorBody