Alerts - Refresh

Reference

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 refresh.
scope	path	True	string	The scope of the alert.
api-version	query	True	string	The API version to use for this operation.

Responses

Name	Type	Description
202 Accepted	AlertOperationResult	Accepted. The response indicates the alert is refreshing. Headers Location: string
Other Status Codes	CloudError	Error response describing why the operation failed.

Name

Type

Description

202 Accepted

AlertOperationResult

Accepted. The response indicates the alert is refreshing.

Headers

Location: string

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

RefreshAlert

Sample request

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

package armauthorization_test

import (
	"context"
	"log"

	"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/RefreshAlert.json
func ExampleAlertsClient_BeginRefresh() {
	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)
	}
	poller, err := clientFactory.NewAlertsClient().BeginRefresh(ctx, "subscriptions/afa2a084-766f-4003-8ae1-c4aeb893a99f", "AzureRolesAssignedOutsidePimAlert", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %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 Refresh an alert.
 *
 * @summary Refresh an alert.
 * x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/preview/2022-08-01-preview/examples/RefreshAlert.json
 */
async function refreshAlert() {
  const scope = "subscriptions/afa2a084-766f-4003-8ae1-c4aeb893a99f";
  const alertId = "AzureRolesAssignedOutsidePimAlert";
  const credential = new DefaultAzureCredential();
  const client = new AuthorizationManagementClient(credential);
  const result = await client.alerts.beginRefreshAndWait(scope, alertId);
  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:: 202

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

{
  "id": "{operationId}",
  "status": "Running",
  "statusDetail": "{\"result\":[{\"name\":\"AzureRolesAssignedOutsidePimAlert\",\"statusDetail\":\"Alert scan is running.\"}]}",
  "lastActionDateTime": "2022-04-05T03:04:06.467+00:00",
  "createdDateTime": "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"
}

Definitions

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

AlertOperationResult

Alert operation result

Name	Type	Description
createdDateTime	string	The created date of the alert operation.
id	string	The id of the alert operation.
lastActionDateTime	string	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.

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.

Share via

Alerts - Refresh

URI Parameters

Responses

Security

azure_auth

Scopes

Examples

RefreshAlert

Sample request

Sample response

Definitions

AlertOperationResult

CloudError

CloudErrorBody

Additional resources