Alerts - Refresh

Service:

Authorization

API Version:

2022-08-01-preview

Refresh an alert.

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

URI Parameters

Name	In	Required	Type	Description
alertId	path	True	string	The name of the alert to get.
scope	path	True	string	The fully qualified Azure Resource manager identifier of the resource.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Responses

Name	Type	Description
202 Accepted	AlertOperationResult	The request has been accepted for processing, but processing has not yet completed. Headers Location: string Retry-After: integer
Other Status Codes	Microsoft.Common.CloudError	An unexpected error response.

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

RefreshAlert

Sample request

HTTP

POST https://management.azure.com/subscriptions/afa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleManagementAlerts/AzureRolesAssignedOutsidePimAlert/refresh?api-version=2022-08-01-preview

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.authorization import AuthorizationManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-authorization
# USAGE
    python refresh_alert.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = AuthorizationManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.alerts.begin_refresh(
        scope="subscriptions/afa2a084-766f-4003-8ae1-c4aeb893a99f",
        alert_id="AzureRolesAssignedOutsidePimAlert",
    ).result()
    print(response)


# x-ms-original-file: 2022-08-01-preview/RefreshAlert.json
if __name__ == "__main__":
    main()

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:

202

Location: https://management.azure.com/subscriptions/afa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleManagementAlertOperations/{operationId}?api-version=2022-04-01-preview

{
  "createdDateTime": "2022-04-05T03:04:06.467+00:00",
  "id": "{operationId}",
  "lastActionDateTime": "2022-04-05T03:04:06.467+00:00",
  "resourceLocation": "https://management.azure.com/providers/Microsoft.Subscription/subscriptions/afa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleManagementAlerts/AzureRolesAssignedOutsidePimAlert?api-version=2022-08-01-preview",
  "status": "Running",
  "statusDetail": "{\"result\":[{\"name\":\"AzureRolesAssignedOutsidePimAlert\",\"statusDetail\":\"Alert scan is running.\"}]}"
}

Definitions

Name	Description
AlertOperationResult	Alert operation result
Microsoft.Common.CloudError	An error response from the service.
Microsoft.Common.CloudErrorBody	An error response from the service.

AlertOperationResult

Object

Alert operation result

Name	Type	Description
createdDateTime	string (date-time)	The created date of the alert operation.
id	string	The id of the alert operation.
lastActionDateTime	string (date-time)	The last action date of the alert operation.
resourceLocation	string	The location of the alert associated with the operation.
status	string	The status of the alert operation.
statusDetail	string	The status detail of the alert operation.

Microsoft.Common.CloudError

Object

An error response from the service.

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

Microsoft.Common.CloudErrorBody

Object

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.