Alert Configurations - Update

Service:

Authorization

API-versie:

2022-08-01-preview

Een waarschuwingsconfiguratie bijwerken.

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

URI-parameters

Name	In	Vereist	Type	Description
alertId	path	True	string	De naam van de waarschuwingsconfiguratie die moet worden bijgewerkt.
scope	path	True	string	Het bereik van de waarschuwingsconfiguratie.
api-version	query	True	string	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagbody

Name	Vereist	Type	Description
properties.alertConfigurationType	True	string	Het type waarschuwingsconfiguratie.
properties.isEnabled		boolean	Waar als de waarschuwing is ingeschakeld, wordt het scannen voor de specifieke waarschuwing uitgeschakeld door onwaar.

Antwoorden

Name	Type	Description
204 No Content		NoContent : de waarschuwing is bijgewerkt.
Other Status Codes	CloudError	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	uw gebruikersaccount imiteren

Voorbeelden

UpdateAlertConfiguration

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:

204

Definities

Name	Description
AlertConfiguration	Waarschuwingsconfiguratie.
AlertDefinition	Waarschuwingsdefinitie
CloudError	Een foutreactie van de service.
CloudErrorBody	Een foutreactie van de service.
SeverityLevel	Ernstniveau van de waarschuwing.

AlertConfiguration

Waarschuwingsconfiguratie.

Name	Type	Description
id	string	De configuratie-id van de waarschuwing.
name	string	De naam van de waarschuwingsconfiguratie.
properties.alertConfigurationType	string	Het type waarschuwingsconfiguratie.
properties.alertDefinition	AlertDefinition	De waarschuwingsdefinitie.
properties.alertDefinitionId	string	De id van de waarschuwingsdefinitie.
properties.isEnabled	boolean	Waar als de waarschuwing is ingeschakeld, wordt het scannen voor de specifieke waarschuwing uitgeschakeld door onwaar.
properties.scope	string	Het waarschuwingsbereik.
type	string	Het type waarschuwingsconfiguratie.

AlertDefinition

Waarschuwingsdefinitie

Name	Type	Description
id	string	De id van de waarschuwingsdefinitie.
name	string	De naam van de waarschuwingsdefinitie.
properties.description	string	De beschrijving van de waarschuwing.
properties.displayName	string	De weergavenaam van de waarschuwing.
properties.howToPrevent	string	De manieren om de waarschuwing te voorkomen.
properties.isConfigurable	boolean	True als de waarschuwingsconfiguratie kan worden geconfigureerd; onwaar, anders.
properties.isRemediatable	boolean	Waar als de waarschuwing kan worden hersteld; onwaar, anders.
properties.mitigationSteps	string	De methoden om de waarschuwing te beperken.
properties.scope	string	Het waarschuwingsbereik.
properties.securityImpact	string	Beveiligingsimpact van de waarschuwing.
properties.severityLevel	SeverityLevel	Ernstniveau van de waarschuwing.
type	string	Het type waarschuwingsdefinitie.

CloudError

Een foutreactie van de service.

Name	Type	Description
error	CloudErrorBody	Een foutreactie van de service.

CloudErrorBody

Een foutreactie van de service.

Name	Type	Description
code	string	Een id voor de fout. Codes zijn invariant en zijn bedoeld om programmatisch te worden gebruikt.
message	string	Een bericht met een beschrijving van de fout, bedoeld om te worden weergegeven in een gebruikersinterface.

SeverityLevel

Ernstniveau van de waarschuwing.

Name	Type	Description
High	string
Low	string
Medium	string