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 minLength: 1	この操作に使用する API バージョン。

要求本文

名前	型	説明
properties.isActive	boolean	既定では False。アラートがアクティブな場合は true。

応答

名前	型	説明
204 No Content		NoContent - アラートが正常に更新されました。
Other Status Codes	CloudError	操作が失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザー アカウントを偽装する

例

DeactivateAlert

要求のサンプル

HTTP

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

Go

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

JavaScript

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

Object

アラート。

名前	型	説明
id	string	アラート ID。
name	string	アラート名。
properties.alertConfiguration	AlertConfiguration	アラートの構成。
properties.alertDefinition	AlertDefinition	アラート定義。
properties.alertIncidents	AlertIncident[]	アラート インシデント。
properties.incidentCount	integer (int32)	アラートの生成されたインシデントの数。
properties.isActive	boolean	既定では False。アラートがアクティブな場合は true。
properties.lastModifiedDateTime	string (date-time)	アラート構成が更新された日時、または新しいインシデントが生成された日時。
properties.lastScannedDateTime	string (date-time)	アラートが最後にスキャンされた日時。
properties.scope	string	アラート スコープ。
type	string	アラートの種類。

AlertConfiguration

Object

アラートの構成。

名前	型	説明
id	string	アラート構成 ID。
name	string	アラート構成名。
properties.alertConfigurationType	string	アラート構成の種類。
properties.alertDefinition	AlertDefinition	アラート定義。
properties.alertDefinitionId	string	アラート定義 ID。
properties.isEnabled	boolean	アラートが有効な場合は True、false は特定のアラートのスキャンを無効にします。
properties.scope	string	アラート スコープ。
type	string	アラート構成の種類。

AlertDefinition

Object

アラートの定義

名前	型	説明
id	string	アラート定義 ID。
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

Object

アラート インシデント

名前	型	説明
id	string	アラート インシデント ID。
name	string	アラート インシデント名。
properties.alertIncidentType	string	アラート インシデントの種類。
type	string	アラート インシデントの種類。

CloudError

Object

サービスからのエラー応答。

名前	型	説明
error	CloudErrorBody	サービスからのエラー応答。

CloudErrorBody

Object

サービスからのエラー応答。

名前	型	説明
code	string	エラーの識別子。 コードは不変であり、プログラムで使用することを目的としています。
message	string	ユーザー インターフェイスでの表示に適したエラーを説明するメッセージ。

SeverityLevel

列挙

アラートの重大度レベル。

値	説明
High
Low
Medium