Alerts - Update
Update an alert.
PATCH https://management.azure.com/{scope}/providers/Microsoft.Authorization/roleManagementAlerts/{alertId}?api-version=2022-08-01-preview
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
alert
|
path | True |
string |
The name of the alert to dismiss. |
scope
|
path | True |
string |
The scope of the alert. |
api-version
|
query | True |
string |
The API version to use for this operation. |
Request Body
Name | Type | Description |
---|---|---|
properties.isActive |
boolean |
False by default; true if the alert is active. |
Responses
Name | Type | Description |
---|---|---|
204 No Content |
NoContent - Successfully updated the alert. |
|
Other Status Codes |
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
DeactivateAlert
Sample request
PATCH https://management.azure.com/subscriptions/afa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleManagementAlerts/TooManyPermanentOwnersAssignedToResource?api-version=2022-08-01-preview
{
"properties": {
"isActive": false
}
}
Sample response
Definitions
Name | Description |
---|---|
Alert |
The alert. |
Alert |
Alert configuration. |
Alert |
Alert definition |
Alert |
Alert incident |
Cloud |
An error response from the service. |
Cloud |
An error response from the service. |
Severity |
Severity level of the alert. |
Alert
The alert.
Name | Type | Description |
---|---|---|
id |
string |
The alert ID. |
name |
string |
The alert name. |
properties.alertConfiguration |
The alert configuration. |
|
properties.alertDefinition |
The alert definition. |
|
properties.alertIncidents |
The alert incidents. |
|
properties.incidentCount |
integer |
The number of generated incidents of the alert. |
properties.isActive |
boolean |
False by default; true if the alert is active. |
properties.lastModifiedDateTime |
string |
The date time when the alert configuration was updated or new incidents were generated. |
properties.lastScannedDateTime |
string |
The date time when the alert was last scanned. |
properties.scope |
string |
The alert scope. |
type |
string |
The alert type. |
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 |
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 |
Severity level of the alert. |
|
type |
string |
The alert definition type. |
AlertIncident
Alert incident
Name | Type | Description |
---|---|---|
id |
string |
The alert incident ID. |
name |
string |
The alert incident name. |
properties.alertIncidentType |
string |
The alert incident type. |
type |
string |
The alert incident type. |
CloudError
An error response from the service.
Name | Type | Description |
---|---|---|
error |
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 |