Alerts - List For Scope

Reference

Služba:: Authorization

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

Získá výstrahy pro obor prostředku.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
scope	path	True	string	Rozsah výstrahy.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Odpovědi

Name	Typ	Description
200 OK	AlertListResult	OK – Vrátí pole výstrah.
Other Status Codes	CloudError	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Azure Active Directory OAuth2 Flow

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

GetAlerts

Ukázkový požadavek

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

package armauthorization_test

import (
	"context"
	"log"

	"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/GetAlerts.json
func ExampleAlertsClient_NewListForScopePager() {
	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)
	}
	pager := clientFactory.NewAlertsClient().NewListForScopePager("subscriptions/afa2a084-766f-4003-8ae1-c4aeb893a99f", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.AlertListResult = armauthorization.AlertListResult{
		// 	Value: []*armauthorization.Alert{
		// 		{
		// 			Name: to.Ptr("TooManyPermanentOwnersAssignedToResource"),
		// 			Type: to.Ptr("Microsoft.Authorization/roleManagementAlerts"),
		// 			ID: to.Ptr("/subscriptions/afa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleManagementAlerts/TooManyPermanentOwnersAssignedToResource"),
		// 			Properties: &armauthorization.AlertProperties{
		// 				AlertConfiguration: &armauthorization.AlertConfiguration{
		// 					Name: to.Ptr("TooManyPermanentOwnersAssignedToResource"),
		// 					Type: to.Ptr("Microsoft.Authorization/roleManagementAlertConfigurations"),
		// 					ID: to.Ptr("/subscriptions/afa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleManagementAlertConfigurations/TooManyPermanentOwnersAssignedToResource"),
		// 					Properties: &armauthorization.TooManyPermanentOwnersAssignedToResourceAlertConfigurationProperties{
		// 						AlertConfigurationType: to.Ptr("TooManyPermanentOwnersAssignedToResourceAlertConfiguration"),
		// 						AlertDefinitionID: to.Ptr("TooManyPermanentOwnersAssignedToResource"),
		// 						IsEnabled: to.Ptr(true),
		// 						Scope: to.Ptr("subscriptions/afa2a084-766f-4003-8ae1-c4aeb893a99f"),
		// 						ThresholdNumberOfPermanentOwners: to.Ptr[int32](10),
		// 						ThresholdPercentageOfPermanentOwnersOutOfAllOwners: to.Ptr[int32](10),
		// 					},
		// 				},
		// 				AlertDefinition: &armauthorization.AlertDefinition{
		// 					Name: to.Ptr("TooManyPermanentOwnersAssignedToResource"),
		// 					Type: to.Ptr("Microsoft.Authorization/roleManagementAlertDefinitions"),
		// 					ID: to.Ptr("/subscriptions/afa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleManagementAlertDefinitions/TooManyPermanentOwnersAssignedToResource"),
		// 					Properties: &armauthorization.AlertDefinitionProperties{
		// 						Description: to.Ptr("The number of users set to never expire is too high. To enhance the security of your resources, we recommend requiring activation for role use. Take a moment to review the list of users, and suggested changes here."),
		// 						DisplayName: to.Ptr("Too many permanent owners assigned to a resource"),
		// 						HowToPrevent: to.Ptr("Enable “Activation Required” in the role settings menu. This will ensure newly added users must activate their role."),
		// 						IsConfigurable: to.Ptr(true),
		// 						IsRemediatable: to.Ptr(true),
		// 						MitigationSteps: to.Ptr("To mitigate this issue, require the user to activate the role before use."),
		// 						Scope: to.Ptr("subscriptions/afa2a084-766f-4003-8ae1-c4aeb893a99f"),
		// 						SecurityImpact: to.Ptr("Providing users permanent access in a role may leave resources vulnerable to accidental or malicious activity."),
		// 						SeverityLevel: to.Ptr(armauthorization.SeverityLevelMedium),
		// 					},
		// 				},
		// 				AlertIncidents: []*armauthorization.AlertIncident{
		// 					{
		// 						Name: to.Ptr("a9f38501-74ec-43ea-8663-6c538602150d"),
		// 						Type: to.Ptr("Microsoft.Authorization/roleManagementAlerts/alertIncidents"),
		// 						ID: to.Ptr("/subscriptions/afa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleManagementAlerts/TooManyPermanentOwnersAssignedToResource/alertIncidents/a9f38501-74ec-43ea-8663-6c538602150d"),
		// 						Properties: &armauthorization.TooManyPermanentOwnersAssignedToResourceAlertIncidentProperties{
		// 							AlertIncidentType: to.Ptr("TooManyPermanentOwnersAssignedToResourceAlertIncident"),
		// 							AssigneeName: to.Ptr("testUser"),
		// 							AssigneeType: to.Ptr("User"),
		// 						},
		// 				}},
		// 				IncidentCount: to.Ptr[int32](1),
		// 				IsActive: to.Ptr(true),
		// 				LastModifiedDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-04-05T03:04:06.467Z"); return t}()),
		// 				LastScannedDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-04-06T18:25:00.380Z"); return t}()),
		// 				Scope: to.Ptr("subscriptions/afa2a084-766f-4003-8ae1-c4aeb893a99f"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("TooManyOwnersAssignedToResource"),
		// 			Type: to.Ptr("Microsoft.Authorization/roleManagementAlerts"),
		// 			ID: to.Ptr("/subscriptions/afa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleManagementAlerts/TooManyOwnersAssignedToResource"),
		// 			Properties: &armauthorization.AlertProperties{
		// 				AlertConfiguration: &armauthorization.AlertConfiguration{
		// 					Name: to.Ptr("TooManyOwnersAssignedToResource"),
		// 					Type: to.Ptr("Microsoft.Authorization/roleManagementAlertConfigurations"),
		// 					ID: to.Ptr("/subscriptions/afa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleManagementAlertConfigurations/TooManyOwnersAssignedToResource"),
		// 					Properties: &armauthorization.TooManyOwnersAssignedToResourceAlertConfigurationProperties{
		// 						AlertConfigurationType: to.Ptr("TooManyOwnersAssignedToResourceAlertConfiguration"),
		// 						AlertDefinitionID: to.Ptr("TooManyOwnersAssignedToResource"),
		// 						IsEnabled: to.Ptr(true),
		// 						Scope: to.Ptr("subscriptions/afa2a084-766f-4003-8ae1-c4aeb893a99f"),
		// 						ThresholdNumberOfOwners: to.Ptr[int32](2),
		// 						ThresholdPercentageOfOwnersOutOfAllRoleMembers: to.Ptr[int32](3),
		// 					},
		// 				},
		// 				AlertDefinition: &armauthorization.AlertDefinition{
		// 					Name: to.Ptr("TooManyOwnersAssignedToResource"),
		// 					Type: to.Ptr("Microsoft.Authorization/roleManagementAlertDefinitions"),
		// 					ID: to.Ptr("/subscriptions/afa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleManagementAlertDefinitions/TooManyOwnersAssignedToResource"),
		// 					Properties: &armauthorization.AlertDefinitionProperties{
		// 						Description: to.Ptr("The number of users with the Owner role is too high. We recommend assigning these individuals to less privileged roles or roles more suitable to their daily needs. Take a moment to review the current assignments, and suggested changes here."),
		// 						DisplayName: to.Ptr("Too many owners assigned to a resource"),
		// 						HowToPrevent: to.Ptr("Choose a role that provides the fewest privileges necessary for a user or group to complete their tasks."),
		// 						IsConfigurable: to.Ptr(true),
		// 						IsRemediatable: to.Ptr(true),
		// 						MitigationSteps: to.Ptr("To mitigate this issue, reduce the number of users in the Owner role. Review the list of users in the list, and reassign them to a less privileged role such as Contributor."),
		// 						Scope: to.Ptr("subscriptions/afa2a084-766f-4003-8ae1-c4aeb893a99f"),
		// 						SecurityImpact: to.Ptr("As the number of users with the owner role increases, so does the potential for malicious or mistaken actions affecting your resource."),
		// 						SeverityLevel: to.Ptr(armauthorization.SeverityLevelMedium),
		// 					},
		// 				},
		// 				AlertIncidents: []*armauthorization.AlertIncident{
		// 					{
		// 						Name: to.Ptr("a9f38501-74ec-43ea-8663-6c538602150d"),
		// 						Type: to.Ptr("Microsoft.Authorization/roleManagementAlerts/alertIncidents"),
		// 						ID: to.Ptr("/subscriptions/afa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleManagementAlerts/TooManyOwnersAssignedToResource/alertIncidents/a9f38501-74ec-43ea-8663-6c538602150d"),
		// 						Properties: &armauthorization.TooManyOwnersAssignedToResourceAlertIncidentProperties{
		// 							AlertIncidentType: to.Ptr("TooManyOwnersAssignedToResourceAlertIncident"),
		// 							AssigneeName: to.Ptr("testUser"),
		// 							AssigneeType: to.Ptr("User"),
		// 						},
		// 				}},
		// 				IncidentCount: to.Ptr[int32](1),
		// 				IsActive: to.Ptr(true),
		// 				LastModifiedDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-04-05T03:04:06.467Z"); return t}()),
		// 				LastScannedDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-04-06T18:25:00.380Z"); return t}()),
		// 				Scope: to.Ptr("subscriptions/afa2a084-766f-4003-8ae1-c4aeb893a99f"),
		// 			},
		// 	}},
		// }
	}
}

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 Gets alerts for a resource scope.
 *
 * @summary Gets alerts for a resource scope.
 * x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/preview/2022-08-01-preview/examples/GetAlerts.json
 */
async function getAlerts() {
  const scope = "subscriptions/afa2a084-766f-4003-8ae1-c4aeb893a99f";
  const credential = new DefaultAzureCredential();
  const client = new AuthorizationManagementClient(credential);
  const resArray = new Array();
  for await (let item of client.alerts.listForScope(scope)) {
    resArray.push(item);
  }
  console.log(resArray);
}

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:: 200

{
  "value": [
    {
      "properties": {
        "scope": "subscriptions/afa2a084-766f-4003-8ae1-c4aeb893a99f",
        "incidentCount": 1,
        "lastModifiedDateTime": "2022-04-05T03:04:06.467+00:00",
        "lastScannedDateTime": "2022-04-06T18:25:00.38+00:00",
        "isActive": true,
        "alertDefinition": {
          "properties": {
            "displayName": "Too many permanent owners assigned to a resource",
            "scope": "subscriptions/afa2a084-766f-4003-8ae1-c4aeb893a99f",
            "description": "The number of users set to never expire is too high. To enhance the security of your resources, we recommend requiring activation for role use. Take a moment to review the list of users, and suggested changes here.",
            "severityLevel": "Medium",
            "securityImpact": "Providing users permanent access in a role may leave resources vulnerable to accidental or malicious activity.",
            "mitigationSteps": "To mitigate this issue, require the user to activate the role before use.",
            "howToPrevent": "Enable “Activation Required” in the role settings menu. This will ensure newly added users must activate their role.",
            "isRemediatable": true,
            "isConfigurable": true
          },
          "name": "TooManyPermanentOwnersAssignedToResource",
          "id": "/subscriptions/afa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleManagementAlertDefinitions/TooManyPermanentOwnersAssignedToResource",
          "type": "Microsoft.Authorization/roleManagementAlertDefinitions"
        },
        "alertIncidents": [
          {
            "properties": {
              "alertIncidentType": "TooManyPermanentOwnersAssignedToResourceAlertIncident",
              "assigneeName": "testUser",
              "assigneeType": "User"
            },
            "name": "a9f38501-74ec-43ea-8663-6c538602150d",
            "type": "Microsoft.Authorization/roleManagementAlerts/alertIncidents",
            "id": "/subscriptions/afa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleManagementAlerts/TooManyPermanentOwnersAssignedToResource/alertIncidents/a9f38501-74ec-43ea-8663-6c538602150d"
          }
        ],
        "alertConfiguration": {
          "properties": {
            "alertConfigurationType": "TooManyPermanentOwnersAssignedToResourceAlertConfiguration",
            "alertDefinitionId": "TooManyPermanentOwnersAssignedToResource",
            "scope": "subscriptions/afa2a084-766f-4003-8ae1-c4aeb893a99f",
            "isEnabled": true,
            "thresholdNumberOfPermanentOwners": 10,
            "thresholdPercentageOfPermanentOwnersOutOfAllOwners": 10
          },
          "name": "TooManyPermanentOwnersAssignedToResource",
          "id": "/subscriptions/afa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleManagementAlertConfigurations/TooManyPermanentOwnersAssignedToResource",
          "type": "Microsoft.Authorization/roleManagementAlertConfigurations"
        }
      },
      "name": "TooManyPermanentOwnersAssignedToResource",
      "id": "/subscriptions/afa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleManagementAlerts/TooManyPermanentOwnersAssignedToResource",
      "type": "Microsoft.Authorization/roleManagementAlerts"
    },
    {
      "properties": {
        "scope": "subscriptions/afa2a084-766f-4003-8ae1-c4aeb893a99f",
        "incidentCount": 1,
        "lastModifiedDateTime": "2022-04-05T03:04:06.467+00:00",
        "lastScannedDateTime": "2022-04-06T18:25:00.38+00:00",
        "isActive": true,
        "alertDefinition": {
          "properties": {
            "displayName": "Too many owners assigned to a resource",
            "scope": "subscriptions/afa2a084-766f-4003-8ae1-c4aeb893a99f",
            "description": "The number of users with the Owner role is too high. We recommend assigning these individuals to less privileged roles or roles more suitable to their daily needs. Take a moment to review the current assignments, and suggested changes here.",
            "severityLevel": "Medium",
            "securityImpact": "As the number of users with the owner role increases, so does the potential for malicious or mistaken actions affecting your resource.",
            "mitigationSteps": "To mitigate this issue, reduce the number of users in the Owner role. Review the list of users in the list, and reassign them to a less privileged role such as Contributor.",
            "howToPrevent": "Choose a role that provides the fewest privileges necessary for a user or group to complete their tasks.",
            "isRemediatable": true,
            "isConfigurable": true
          },
          "name": "TooManyOwnersAssignedToResource",
          "id": "/subscriptions/afa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleManagementAlertDefinitions/TooManyOwnersAssignedToResource",
          "type": "Microsoft.Authorization/roleManagementAlertDefinitions"
        },
        "alertIncidents": [
          {
            "properties": {
              "alertIncidentType": "TooManyOwnersAssignedToResourceAlertIncident",
              "assigneeName": "testUser",
              "assigneeType": "User"
            },
            "name": "a9f38501-74ec-43ea-8663-6c538602150d",
            "type": "Microsoft.Authorization/roleManagementAlerts/alertIncidents",
            "id": "/subscriptions/afa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleManagementAlerts/TooManyOwnersAssignedToResource/alertIncidents/a9f38501-74ec-43ea-8663-6c538602150d"
          }
        ],
        "alertConfiguration": {
          "properties": {
            "alertConfigurationType": "TooManyOwnersAssignedToResourceAlertConfiguration",
            "alertDefinitionId": "TooManyOwnersAssignedToResource",
            "scope": "subscriptions/afa2a084-766f-4003-8ae1-c4aeb893a99f",
            "isEnabled": true,
            "thresholdNumberOfOwners": 2,
            "thresholdPercentageOfOwnersOutOfAllRoleMembers": 3
          },
          "name": "TooManyOwnersAssignedToResource",
          "id": "/subscriptions/afa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleManagementAlertConfigurations/TooManyOwnersAssignedToResource",
          "type": "Microsoft.Authorization/roleManagementAlertConfigurations"
        }
      },
      "name": "TooManyOwnersAssignedToResource",
      "id": "/subscriptions/afa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleManagementAlerts/TooManyOwnersAssignedToResource",
      "type": "Microsoft.Authorization/roleManagementAlerts"
    }
  ]
}

Definice

Name	Description
Alert	Výstraha.
AlertConfiguration	Konfigurace výstrah
AlertDefinition	Definice výstrahy
AlertIncident	Incident upozornění
AlertListResult	Výsledek operace seznamu výstrah.
CloudError	Chybová odpověď ze služby.
CloudErrorBody	Chybová odpověď ze služby.
SeverityLevel	Úroveň závažnosti výstrahy

Alert

Objekt

Výstraha.

Name	Typ	Description
id	string	ID výstrahy.
name	string	Název výstrahy.
properties.alertConfiguration	AlertConfiguration	Konfigurace výstrahy.
properties.alertDefinition	AlertDefinition	Definice výstrahy.
properties.alertIncidents	AlertIncident[]	Incidenty upozornění.
properties.incidentCount	integer (int32)	Počet vygenerovaných incidentů výstrahy.
properties.isActive	boolean	False ve výchozím nastavení; true Pokud je výstraha aktivní.
properties.lastModifiedDateTime	string (date-time)	Datum, kdy se konfigurace výstrahy aktualizovala nebo se vygenerovaly nové incidenty.
properties.lastScannedDateTime	string (date-time)	Datum, kdy byla výstraha naposledy zkontrolována.
properties.scope	string	Obor výstrahy.
type	string	Typ výstrahy.

AlertConfiguration

Objekt

Konfigurace výstrah

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

AlertDefinition

Objekt

Definice výstrahy

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

AlertIncident

Objekt

Incident upozornění

Name	Typ	Description
id	string	ID incidentu výstrahy.
name	string	Název incidentu upozornění.
properties.alertIncidentType	string	Typ incidentu výstrahy.
type	string	Typ incidentu výstrahy.

AlertListResult

Objekt

Výsledek operace seznamu výstrah.

Name	Typ	Description
nextLink	string	Adresa URL, která se má použít k získání další sady výsledků.
value	Alert[]	Seznam upozornění

CloudError

Objekt

Chybová odpověď ze služby.

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

CloudErrorBody

Objekt

Chybová odpověď ze služby.

Name	Typ	Description
code	string	Identifikátor chyby. Kódy jsou invariantní a mají být využity programově.
message	string	Zpráva popisující chybu, která má být vhodná pro zobrazení v uživatelském rozhraní.

SeverityLevel

Výčet

Úroveň závažnosti výstrahy

Hodnota	Description
High
Low
Medium

Sdílet prostřednictvím

Alerts - List For Scope

Parametry identifikátoru URI

Odpovědi

Zabezpečení

azure_auth

Rozsahy

Příklady

GetAlerts

Ukázkový požadavek

Ukázková odpověď

Definice

Alert

AlertConfiguration

AlertDefinition

AlertIncident

AlertListResult

CloudError

CloudErrorBody

SeverityLevel

Další materiály