Alert Configurations - Update

Dienst:

Authorization

API-Version:

2022-08-01-preview

Aktualisieren Sie eine Warnungskonfiguration.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
alertId	path	True	string	Der Name der zu aktualisierenden Warnungskonfiguration.
scope	path	True	string	Der Bereich der Warnungskonfiguration.
api-version	query	True	string	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
properties.alertConfigurationType	True	string	Der Warnungskonfigurationstyp.
properties.isEnabled		boolean	True, wenn die Warnung aktiviert ist, deaktiviert false die Überprüfung für die spezifische Warnung.

Antworten

Name	Typ	Beschreibung
204 No Content		NoContent: Die Warnung wurde erfolgreich aktualisiert.
Other Status Codes	CloudError	Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

UpdateAlertConfiguration

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:

204

Definitionen

Name	Beschreibung
AlertConfiguration	Warnungskonfiguration.
AlertDefinition	Warnungsdefinition
CloudError	Eine Fehlerantwort vom Dienst.
CloudErrorBody	Eine Fehlerantwort vom Dienst.
SeverityLevel	Schweregrad der Warnung.

AlertConfiguration

Warnungskonfiguration.

Name	Typ	Beschreibung
id	string	Die Warnungskonfigurations-ID.
name	string	Der Name der Warnungskonfiguration.
properties.alertConfigurationType	string	Der Warnungskonfigurationstyp.
properties.alertDefinition	AlertDefinition	Die Warnungsdefinition.
properties.alertDefinitionId	string	Die Warnungsdefinitions-ID.
properties.isEnabled	boolean	True, wenn die Warnung aktiviert ist, deaktiviert false die Überprüfung für die spezifische Warnung.
properties.scope	string	Der Warnungsbereich.
type	string	Der Warnungskonfigurationstyp.

AlertDefinition

Warnungsdefinition

Name	Typ	Beschreibung
id	string	Die Warnungsdefinitions-ID.
name	string	Der Name der Warnungsdefinition.
properties.description	string	Die Beschreibung der Warnung
properties.displayName	string	Der Name der Warnungsanzeige.
properties.howToPrevent	string	Die Möglichkeiten, die Warnung zu verhindern.
properties.isConfigurable	boolean	True, wenn die Warnungskonfiguration konfiguriert werden kann; false, andernfalls.
properties.isRemediatable	boolean	True, wenn die Warnung behoben werden kann; false, andernfalls.
properties.mitigationSteps	string	Die Methoden zum Minimieren der Warnung.
properties.scope	string	Der Warnungsbereich.
properties.securityImpact	string	Auswirkungen der Warnung auf die Sicherheit.
properties.severityLevel	SeverityLevel	Schweregrad der Warnung.
type	string	Der Warnungsdefinitionstyp.

CloudError

Eine Fehlerantwort vom Dienst.

Name	Typ	Beschreibung
error	CloudErrorBody	Eine Fehlerantwort vom Dienst.

CloudErrorBody

Eine Fehlerantwort vom Dienst.

Name	Typ	Beschreibung
code	string	Ein Bezeichner für den Fehler. Codes sind unveränderlich und sollten programmgesteuert verwendet werden.
message	string	Eine Meldung, die den Fehler beschreibt, der für die Anzeige in einer Benutzeroberfläche geeignet sein soll.

SeverityLevel

Schweregrad der Warnung.

Name	Typ	Beschreibung
High	string
Low	string
Medium	string