Alerts - Update

Ссылка

Служба:: Authorization

Версия API:: 2022-08-01-preview

Обновление оповещения.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
alertId	path	True	string	Имя оповещений, которые необходимо закрыть.
scope	path	True	string	Область оповещения.
api-version	query	True	string	Версия API, используемая для данной операции.

Текст запроса

Имя	Тип	Описание
properties.isActive	boolean	False по умолчанию; Значение true, если оповещение активно.

Ответы

Имя	Тип	Описание
204 No Content		NoContent — оповещение успешно обновлено.
Other Status Codes	CloudError	Ответ об ошибке, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

DeactivateAlert

Образец запроса

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

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/UpdateAlert.json
func ExampleAlertsClient_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.NewAlertsClient().Update(ctx, "subscriptions/afa2a084-766f-4003-8ae1-c4aeb893a99f", "TooManyPermanentOwnersAssignedToResource", armauthorization.Alert{
		Properties: &armauthorization.AlertProperties{
			IsActive: to.Ptr(false),
		},
	}, 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.
 *
 * @summary Update an alert.
 * x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/preview/2022-08-01-preview/examples/UpdateAlert.json
 */
async function deactivateAlert() {
  const scope = "subscriptions/afa2a084-766f-4003-8ae1-c4aeb893a99f";
  const alertId = "TooManyPermanentOwnersAssignedToResource";
  const parameters = { isActive: false };
  const credential = new DefaultAzureCredential();
  const client = new AuthorizationManagementClient(credential);
  const result = await client.alerts.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

Пример ответа

Код состояния:: 204

Определения

Имя	Описание
Alert	Оповещение.
AlertConfiguration	Конфигурация оповещений.
AlertDefinition	Определение оповещения
AlertIncident	Инцидент оповещения
CloudError	Ответ об ошибке от службы.
CloudErrorBody	Ответ об ошибке от службы.
SeverityLevel	Серьезность оповещения.

Alert

Оповещение.

Имя	Тип	Описание
id	string	Идентификатор оповещения.
name	string	Имя предупреждения.
properties.alertConfiguration	AlertConfiguration	Конфигурация оповещения.
properties.alertDefinition	AlertDefinition	Определение предупреждения.
properties.alertIncidents	AlertIncident[]	Инциденты оповещений.
properties.incidentCount	integer	Количество созданных инцидентов оповещения.
properties.isActive	boolean	False по умолчанию; Значение true, если оповещение активно.
properties.lastModifiedDateTime	string	Дата и время обновления конфигурации оповещений или создания новых инцидентов.
properties.lastScannedDateTime	string	Дата последнего сканирования оповещения.
properties.scope	string	Оповещение область.
type	string	Тип оповещения.

AlertConfiguration

Конфигурация оповещений.

Имя	Тип	Описание
id	string	Идентификатор конфигурации оповещения.
name	string	Имя конфигурации оповещения.
properties.alertConfigurationType	string	Тип конфигурации оповещения.
properties.alertDefinition	AlertDefinition	Определение предупреждения.
properties.alertDefinitionId	string	Идентификатор определения предупреждения.
properties.isEnabled	boolean	Значение True, если оповещение включено, значение false отключает проверку для конкретного оповещения.
properties.scope	string	Оповещение область.
type	string	Тип конфигурации оповещения.

AlertDefinition

Определение оповещения

Имя	Тип	Описание
id	string	Идентификатор определения предупреждения.
name	string	Имя определения оповещения.
properties.description	string	Описание оповещения.
properties.displayName	string	Отображаемое имя оповещения.
properties.howToPrevent	string	Способы предотвращения оповещения.
properties.isConfigurable	boolean	Значение true, если можно настроить конфигурацию оповещений; Значение false, в противном случае — значение .
properties.isRemediatable	boolean	Значение true, если оповещение можно исправить; Значение false, в противном случае — значение .
properties.mitigationSteps	string	Методы для устранения оповещений.
properties.scope	string	Оповещение область.
properties.securityImpact	string	Влияние оповещения на безопасность.
properties.severityLevel	SeverityLevel	Серьезность оповещения.
type	string	Тип определения оповещения.

AlertIncident

Инцидент оповещения

Имя	Тип	Описание
id	string	Идентификатор инцидента оповещения.
name	string	Имя инцидента оповещения.
properties.alertIncidentType	string	Тип инцидента оповещения.
type	string	Тип инцидента оповещения.

CloudError

Ответ об ошибке от службы.

Имя	Тип	Описание
error	CloudErrorBody	Ответ об ошибке от службы.

CloudErrorBody