Alert Configurations - Update

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

Sample response

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

An error response from the service.

Name Type Description
code

string

An identifier for the error. Codes are invariant and are intended to be consumed programmatically.

message

string

A message describing the error, intended to be suitable for display in a user interface.

SeverityLevel

Severity level of the alert.

Name Type Description
High

string

Low

string

Medium

string