Alert Configurations - Update

Reference

Služba:: Authorization

Verze rozhraní API:: 2022-08-01-preview

Aktualizujte konfiguraci upozornění.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
alertId	path	True	string	Název konfigurace upozornění, která se má aktualizovat.
scope	path	True	string	Rozsah konfigurace upozornění.
api-version	query	True	string	Verze rozhraní API, která se má použít pro tuto operaci.

Text požadavku

Name	Vyžadováno	Typ	Description
properties.alertConfigurationType	True	string	Typ konfigurace upozornění.
properties.isEnabled		boolean	True, pokud je výstraha povolená, false zakáže vyhledávání konkrétní výstrahy.

Odpovědi

Name	Typ	Description
204 No Content		NoContent – výstraha se úspěšně aktualizovala.
Other Status Codes	CloudError	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

UpdateAlertConfiguration

Ukázkový požadavek

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

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

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

Ukázková odpověď

Stavový kód:: 204

Definice

Name	Description
AlertConfiguration	Konfigurace upozornění.
AlertDefinition	Definice upozornění
CloudError	Chybová odpověď ze služby.
CloudErrorBody	Chybová odpověď ze služby.
SeverityLevel	Úroveň závažnosti výstrahy.

AlertConfiguration

Konfigurace upozornění.

Name	Typ	Description
id	string	ID konfigurace upozornění.
name	string	Název konfigurace upozornění.
properties.alertConfigurationType	string	Typ konfigurace upozornění.
properties.alertDefinition	AlertDefinition	Definice upozornění.
properties.alertDefinitionId	string	ID definice upozornění.
properties.isEnabled	boolean	True, pokud je výstraha povolená, false zakáže vyhledávání konkrétní výstrahy.
properties.scope	string	Obor upozornění.
type	string	Typ konfigurace upozornění.

AlertDefinition

Definice upozornění

Name	Typ	Description
id	string	ID definice upozornění.
name	string	Název definice upozornění.
properties.description	string	Popis upozornění
properties.displayName	string	Zobrazovaný název upozornění
properties.howToPrevent	string	Způsoby, jak zabránit upozornění.
properties.isConfigurable	boolean	True, pokud je možné nakonfigurovat konfiguraci upozornění; false, jinak.
properties.isRemediatable	boolean	True, pokud výstraha může být napravena; false, jinak.
properties.mitigationSteps	string	Metody pro zmírnění výstrahy
properties.scope	string	Obor upozornění.
properties.securityImpact	string	Dopad výstrahy na zabezpečení.
properties.severityLevel	SeverityLevel	Úroveň závažnosti výstrahy.
type	string	Typ definice výstrahy.

CloudError

Chybová odpověď ze služby.

Name	Typ	Description
error	CloudErrorBody	Chybová odpověď ze služby.

CloudErrorBody