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 erhaltenen Alarmkonfiguration.
scope	path	True	string	Die vollständig qualifizierte Azure Resource Manager-Kennung der Ressource.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungstext

Name	Typ	Beschreibung
properties	AlertConfigurationProperties: AzureRolesAssignedOutsidePimAlertConfigurationProperties DuplicateRoleCreatedAlertConfigurationProperties TooManyOwnersAssignedToResourceAlertConfigurationProperties TooManyPermanentOwnersAssignedToResourceAlertConfigurationProperties	Benachrichtigung um Konfigurationseigenschaften.

Antworten

Name	Typ	Beschreibung
204 No Content		Der Vorgang wurde erfolgreich abgeschlossen.
Other Status Codes	Microsoft.Common.CloudError	Unerwartete Fehlerantwort.

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

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

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

from azure.identity import DefaultAzureCredential

from azure.mgmt.authorization import AuthorizationManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-authorization
# USAGE
    python update_alert_configuration.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = AuthorizationManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    client.alert_configurations.update(
        scope="subscriptions/afa2a084-766f-4003-8ae1-c4aeb893a99f",
        alert_id="TooManyOwnersAssignedToResource",
        parameters={
            "properties": {
                "alertConfigurationType": "TooManyOwnersAssignedToResourceAlertConfiguration",
                "isEnabled": True,
                "thresholdNumberOfOwners": 2,
            }
        },
    )


# x-ms-original-file: 2022-08-01-preview/UpdateAlertConfiguration.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

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: 2022-08-01-preview/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("<subscriptionID>", 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

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: 2022-08-01-preview/UpdateAlertConfiguration.json
 */
async function updateAlertConfiguration() {
  const credential = new DefaultAzureCredential();
  const client = new AuthorizationManagementClient(credential);
  await client.alertConfigurations.update(
    "subscriptions/afa2a084-766f-4003-8ae1-c4aeb893a99f",
    "TooManyOwnersAssignedToResource",
    {
      properties: {
        alertConfigurationType: "TooManyOwnersAssignedToResourceAlertConfiguration",
        isEnabled: true,
        thresholdNumberOfOwners: 2,
      },
    },
  );
}

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
AzureRolesAssignedOutsidePimAlertConfigurationProperties	Die Azure-Rollen, die außerhalb der PIM-Alarm-Konfigurationseigenschaften zugewiesen werden.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
DuplicateRoleCreatedAlertConfigurationProperties	Die doppelte Rolle erzeugte die Alarmkonfiguration.
Microsoft.Common.CloudError	Eine Fehlerantwort des Diensts.
Microsoft.Common.CloudErrorBody	Eine Fehlerantwort des Diensts.
SeverityLevel	Schweregrad der Warnung.
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.
TooManyOwnersAssignedToResourceAlertConfigurationProperties	Zu viele Eigentümer haben den Konfigurationseigenschaften von Ressourcenwarnungen zugewiesen.
TooManyPermanentOwnersAssignedToResourceAlertConfigurationProperties	Zu viele permanente Eigentümer wurden den Konfigurationseigenschaften von Ressourcenalarmen zugewiesen.

AlertConfiguration

Objekt

Warnungskonfiguration.

Name	Typ	Beschreibung
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Zum Beispiel - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Der Name der Ressource
properties	AlertConfigurationProperties: AzureRolesAssignedOutsidePimAlertConfigurationProperties DuplicateRoleCreatedAlertConfigurationProperties TooManyOwnersAssignedToResourceAlertConfigurationProperties TooManyPermanentOwnersAssignedToResourceAlertConfigurationProperties	Benachrichtigung um Konfigurationseigenschaften.
systemData	systemData	Azure Resource Manager-Metadaten, die createdBy und modifiedBy-Informationen enthalten.
type	string	Der Typ der Ressource. Zum Beispiel "Microsoft. Compute/virtualMachines" oder "Microsoft. Speicher/Speicherkonten"

AlertDefinition

Objekt

Warnungsdefinition

Name	Typ	Beschreibung
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Zum Beispiel - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Der Name der Ressource
properties.description	string	Die Warnungsbeschreibung.
properties.displayName	string	Der Anzeigename der Warnung.
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 Mindern der Warnung.
properties.scope	string	Der Warnungsbereich.
properties.securityImpact	string	Auswirkungen auf die Sicherheit der Warnung.
properties.severityLevel	SeverityLevel	Schweregrad der Warnung.
systemData	systemData	Azure Resource Manager-Metadaten, die createdBy und modifiedBy-Informationen enthalten.
type	string	Der Typ der Ressource. Zum Beispiel "Microsoft. Compute/virtualMachines" oder "Microsoft. Speicher/Speicherkonten"

AzureRolesAssignedOutsidePimAlertConfigurationProperties

Objekt

Die Azure-Rollen, die außerhalb der PIM-Alarm-Konfigurationseigenschaften zugewiesen werden.

Name	Typ	Beschreibung
alertConfigurationType	string: AzureRolesAssignedOutsidePimAlertConfiguration	Der Konfigurationstyp der Warnung.
alertDefinition	AlertDefinition	Die Warnungsdefinition.
alertDefinitionId	string	Die Id der Warnungsdefinition.
isEnabled	boolean	True, wenn die Warnung aktiviert ist, deaktiviert false die Überprüfung auf die jeweilige Warnung.
scope	string	Der Warnungsbereich.

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
User
Application
ManagedIdentity
Key

DuplicateRoleCreatedAlertConfigurationProperties

Objekt

Die doppelte Rolle erzeugte die Alarmkonfiguration.

Name	Typ	Beschreibung
alertConfigurationType	string: DuplicateRoleCreatedAlertConfiguration	Der Konfigurationstyp der Warnung.
alertDefinition	AlertDefinition	Die Warnungsdefinition.
alertDefinitionId	string	Die Id der Warnungsdefinition.
isEnabled	boolean	True, wenn die Warnung aktiviert ist, deaktiviert false die Überprüfung auf die jeweilige Warnung.
scope	string	Der Warnungsbereich.

Microsoft.Common.CloudError

Objekt

Eine Fehlerantwort des Diensts.

Name	Typ	Beschreibung
error	Microsoft.Common.CloudErrorBody	Eine Fehlerantwort des Diensts.

Microsoft.Common.CloudErrorBody

Objekt

Eine Fehlerantwort des Diensts.

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

SeverityLevel

Enumeration

Schweregrad der Warnung.

Wert	Beschreibung
Low	Niedrig
Medium	Mittelstufe
High	Hoch

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.

TooManyOwnersAssignedToResourceAlertConfigurationProperties

Objekt

Zu viele Eigentümer haben den Konfigurationseigenschaften von Ressourcenwarnungen zugewiesen.

Name	Typ	Beschreibung
alertConfigurationType	string: TooManyOwnersAssignedToResourceAlertConfiguration	Der Konfigurationstyp der Warnung.
alertDefinition	AlertDefinition	Die Warnungsdefinition.
alertDefinitionId	string	Die Id der Warnungsdefinition.
isEnabled	boolean	True, wenn die Warnung aktiviert ist, deaktiviert false die Überprüfung auf die jeweilige Warnung.
scope	string	Der Warnungsbereich.
thresholdNumberOfOwners	integer (int32)	Die Schwellenzahl der Besitzer.
thresholdPercentageOfOwnersOutOfAllRoleMembers	integer (int32)	Der Schwellenwert von Eigentümern aus allen Rollenmitgliedern.

TooManyPermanentOwnersAssignedToResourceAlertConfigurationProperties

Objekt

Zu viele permanente Eigentümer wurden den Konfigurationseigenschaften von Ressourcenalarmen zugewiesen.

Name	Typ	Beschreibung
alertConfigurationType	string: TooManyPermanentOwnersAssignedToResourceAlertConfiguration	Der Konfigurationstyp der Warnung.
alertDefinition	AlertDefinition	Die Warnungsdefinition.
alertDefinitionId	string	Die Id der Warnungsdefinition.
isEnabled	boolean	True, wenn die Warnung aktiviert ist, deaktiviert false die Überprüfung auf die jeweilige Warnung.
scope	string	Der Warnungsbereich.
thresholdNumberOfPermanentOwners	integer (int32)	Die Schwellenzahl der ständigen Eigentümer.
thresholdPercentageOfPermanentOwnersOutOfAllOwners	integer (int32)	Der Schwellenwert ist der Prozentsatz der dauerhaften Eigentümer von allen Eigentümern.