Alert Configurations - Update

サービス:

Authorization

API バージョン:

2022-08-01-preview

アラート構成を更新します。

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

URI パラメーター

名前	/	必須	型	説明
alertId	path	True	string	更新するアラート構成の名前。
scope	path	True	string	アラート構成のスコープ。
api-version	query	True	string	この操作に使用する API バージョン。

要求本文

名前	必須	型	説明
properties.alertConfigurationType	True	string	アラート構成の種類。
properties.isEnabled		boolean	True を指定すると、アラートが有効になり、false を指定すると、特定のアラートのスキャンが無効になります。

応答

名前	型	説明
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	ユーザー アカウントの借用

例

UpdateAlertConfiguration

要求のサンプル

HTTP

PATCH https://management.azure.com/subscriptions/afa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleManagementAlertConfigurations/TooManyOwnersAssignedToResource?api-version=2022-08-01-preview

{
  "properties": {
    "isEnabled": true,
    "thresholdNumberOfOwners": 2,
    "alertConfigurationType": "TooManyOwnersAssignedToResourceAlertConfiguration"
  }
}

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/UpdateAlertConfiguration.json
func ExampleAlertConfigurationsClient_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.NewAlertConfigurationsClient().Update(ctx, "subscriptions/afa2a084-766f-4003-8ae1-c4aeb893a99f", "TooManyOwnersAssignedToResource", armauthorization.AlertConfiguration{
		Properties: &armauthorization.TooManyOwnersAssignedToResourceAlertConfigurationProperties{
			AlertConfigurationType:  to.Ptr("TooManyOwnersAssignedToResourceAlertConfiguration"),
			IsEnabled:               to.Ptr(true),
			ThresholdNumberOfOwners: to.Ptr[int32](2),
		},
	}, 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 configuration.
 *
 * @summary Update an alert configuration.
 * x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/preview/2022-08-01-preview/examples/UpdateAlertConfiguration.json
 */
async function updateAlertConfiguration() {
  const scope = "subscriptions/afa2a084-766f-4003-8ae1-c4aeb893a99f";
  const alertId = "TooManyOwnersAssignedToResource";
  const parameters = {
    alertConfigurationType: "TooManyOwnersAssignedToResourceAlertConfiguration",
    isEnabled: true,
  };
  const credential = new DefaultAzureCredential();
  const client = new AuthorizationManagementClient(credential);
  const result = await client.alertConfigurations.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

定義

名前	説明
AlertConfiguration	アラートの構成。
AlertDefinition	アラートの定義
CloudError	サービスからのエラー応答。
CloudErrorBody	サービスからのエラー応答。
SeverityLevel	アラートの重大度。

AlertConfiguration

アラートの構成。

名前	型	説明
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

アラートの定義

名前	型	説明
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	アラート定義の種類。

CloudError

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

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

CloudErrorBody

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

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

SeverityLevel

アラートの重大度。

名前	型	説明
High	string
Low	string
Medium	string