Alerts - List For Scope

Usługa:

Authorization

Wersja interfejsu API:

2022-08-01-preview

Pobiera alerty dotyczące zakresu zasobów.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
scope	path	True	string	W pełni kwalifikowany identyfikator menedżera zasobów Azure zasobu.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	AlertListResult	Operacja Azure zakończyła się pomyślnie.
Other Status Codes	Microsoft.Common.CloudError	Nieoczekiwana odpowiedź na błąd.

Zabezpieczenia

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

GetAlerts

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:

200

{
  "value": [
    {
      "name": "TooManyPermanentOwnersAssignedToResource",
      "type": "Microsoft.Authorization/roleManagementAlerts",
      "id": "/subscriptions/afa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleManagementAlerts/TooManyPermanentOwnersAssignedToResource",
      "properties": {
        "alertConfiguration": {
          "name": "TooManyPermanentOwnersAssignedToResource",
          "type": "Microsoft.Authorization/roleManagementAlertConfigurations",
          "id": "/subscriptions/afa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleManagementAlertConfigurations/TooManyPermanentOwnersAssignedToResource",
          "properties": {
            "alertConfigurationType": "TooManyPermanentOwnersAssignedToResourceAlertConfiguration",
            "alertDefinitionId": "TooManyPermanentOwnersAssignedToResource",
            "isEnabled": true,
            "scope": "subscriptions/afa2a084-766f-4003-8ae1-c4aeb893a99f",
            "thresholdNumberOfPermanentOwners": 10,
            "thresholdPercentageOfPermanentOwnersOutOfAllOwners": 10
          }
        },
        "alertDefinition": {
          "name": "TooManyPermanentOwnersAssignedToResource",
          "type": "Microsoft.Authorization/roleManagementAlertDefinitions",
          "id": "/subscriptions/afa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleManagementAlertDefinitions/TooManyPermanentOwnersAssignedToResource",
          "properties": {
            "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.",
            "displayName": "Too many permanent owners assigned to a resource",
            "howToPrevent": "Enable “Activation Required” in the role settings menu. This will ensure newly added users must activate their role.",
            "isConfigurable": true,
            "isRemediatable": true,
            "mitigationSteps": "To mitigate this issue, require the user to activate the role before use.",
            "scope": "subscriptions/afa2a084-766f-4003-8ae1-c4aeb893a99f",
            "securityImpact": "Providing users permanent access in a role may leave resources vulnerable to accidental or malicious activity.",
            "severityLevel": "Medium"
          }
        },
        "alertIncidents": [
          {
            "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",
            "properties": {
              "alertIncidentType": "TooManyPermanentOwnersAssignedToResourceAlertIncident",
              "assigneeName": "testUser",
              "assigneeType": "User"
            }
          }
        ],
        "incidentCount": 1,
        "isActive": true,
        "lastModifiedDateTime": "2022-04-05T03:04:06.467+00:00",
        "lastScannedDateTime": "2022-04-06T18:25:00.38+00:00",
        "scope": "subscriptions/afa2a084-766f-4003-8ae1-c4aeb893a99f"
      }
    },
    {
      "name": "TooManyOwnersAssignedToResource",
      "type": "Microsoft.Authorization/roleManagementAlerts",
      "id": "/subscriptions/afa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleManagementAlerts/TooManyOwnersAssignedToResource",
      "properties": {
        "alertConfiguration": {
          "name": "TooManyOwnersAssignedToResource",
          "type": "Microsoft.Authorization/roleManagementAlertConfigurations",
          "id": "/subscriptions/afa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleManagementAlertConfigurations/TooManyOwnersAssignedToResource",
          "properties": {
            "alertConfigurationType": "TooManyOwnersAssignedToResourceAlertConfiguration",
            "alertDefinitionId": "TooManyOwnersAssignedToResource",
            "isEnabled": true,
            "scope": "subscriptions/afa2a084-766f-4003-8ae1-c4aeb893a99f",
            "thresholdNumberOfOwners": 2,
            "thresholdPercentageOfOwnersOutOfAllRoleMembers": 3
          }
        },
        "alertDefinition": {
          "name": "TooManyOwnersAssignedToResource",
          "type": "Microsoft.Authorization/roleManagementAlertDefinitions",
          "id": "/subscriptions/afa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleManagementAlertDefinitions/TooManyOwnersAssignedToResource",
          "properties": {
            "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.",
            "displayName": "Too many owners assigned to a resource",
            "howToPrevent": "Choose a role that provides the fewest privileges necessary for a user or group to complete their tasks.",
            "isConfigurable": true,
            "isRemediatable": true,
            "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.",
            "scope": "subscriptions/afa2a084-766f-4003-8ae1-c4aeb893a99f",
            "securityImpact": "As the number of users with the owner role increases, so does the potential for malicious or mistaken actions affecting your resource.",
            "severityLevel": "Medium"
          }
        },
        "alertIncidents": [
          {
            "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",
            "properties": {
              "alertIncidentType": "TooManyOwnersAssignedToResourceAlertIncident",
              "assigneeName": "testUser",
              "assigneeType": "User"
            }
          }
        ],
        "incidentCount": 1,
        "isActive": true,
        "lastModifiedDateTime": "2022-04-05T03:04:06.467+00:00",
        "lastScannedDateTime": "2022-04-06T18:25:00.38+00:00",
        "scope": "subscriptions/afa2a084-766f-4003-8ae1-c4aeb893a99f"
      }
    }
  ]
}

Definicje

Nazwa	Opis
Alert	Alert.
AlertConfiguration	Konfiguracja alertu.
AlertDefinition	Definicja alertu
AlertIncident	Zdarzenie alertu
AlertListResult	Odpowiedź w postaci operacji listy alarmowej.
AzureRolesAssignedOutsidePimAlertConfigurationProperties	Role Azure przypisują zewnętrzne właściwości konfiguracyjne alertów PIM.
AzureRolesAssignedOutsidePimAlertIncidentProperties	Azure roles assigned outside PIM alert incident properties.
createdByType	Typ tożsamości, która utworzyła zasób.
DuplicateRoleCreatedAlertConfigurationProperties	Duplikowana rola tworzyła konfigurację alertów.
DuplicateRoleCreatedAlertIncidentProperties	Duplikat roli tworzył alert właściwości incydentów.
Microsoft.Common.CloudError	Odpowiedź na błąd z usługi.
Microsoft.Common.CloudErrorBody	Odpowiedź na błąd z usługi.
SeverityLevel	Poziom ważności alertu.
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.
TooManyOwnersAssignedToResourceAlertConfigurationProperties	Zbyt wielu właścicieli przypisanych do ustawień ustawień alertów zasobów.
TooManyOwnersAssignedToResourceAlertIncidentProperties	Zbyt wielu właścicieli przypisanych do obiektów alertów o zasobach.
TooManyPermanentOwnersAssignedToResourceAlertConfigurationProperties	Zbyt wielu stałych właścicieli przypisanych do konfiguracji alertów zasobów.
TooManyPermanentOwnersAssignedToResourceAlertIncidentProperties	Zbyt wielu stałych właścicieli przypisanych do obiektów alertów o zasobach.

Alert

Objekt

Alert.

Nazwa	Typ	Opis
id	string	W pełni kwalifikowany identyfikator zasobu dla zasobu. Przykład - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nazwa zasobu
properties.alertConfiguration	AlertConfiguration	Konfiguracja alertu.
properties.alertDefinition	AlertDefinition	Definicja alertu.
properties.alertIncidents	AlertIncident[]	Zdarzenia alertu.
properties.incidentCount	integer (int32)	Liczba wygenerowanych zdarzeń alertu.
properties.isActive	boolean	Wartość false domyślnie; wartość true, jeśli alert jest aktywny.
properties.lastModifiedDateTime	string (date-time)	Data wygenerowania konfiguracji alertu lub wygenerowanie nowych zdarzeń.
properties.lastScannedDateTime	string (date-time)	Data i godzina ostatniego skanowania alertu.
properties.scope	string	Zakres alertu.
systemData	systemData	Metadane Azure Resource Manager zawierające informacje createdBy i modifiedBy.
type	string	Typ zasobu. Np. "Microsoft. Compute/virtualMachines" lub "Microsoft. Storage/storageAccounts"

AlertConfiguration

Objekt

Konfiguracja alertu.

Nazwa	Typ	Opis
id	string	W pełni kwalifikowany identyfikator zasobu dla zasobu. Przykład - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nazwa zasobu
properties	AlertConfigurationProperties: AzureRolesAssignedOutsidePimAlertConfigurationProperties DuplicateRoleCreatedAlertConfigurationProperties TooManyOwnersAssignedToResourceAlertConfigurationProperties TooManyPermanentOwnersAssignedToResourceAlertConfigurationProperties	Właściwości konfiguracji alertu.
systemData	systemData	Metadane Azure Resource Manager zawierające informacje createdBy i modifiedBy.
type	string	Typ zasobu. Np. "Microsoft. Compute/virtualMachines" lub "Microsoft. Storage/storageAccounts"

AlertDefinition

Objekt

Definicja alertu

Nazwa	Typ	Opis
id	string	W pełni kwalifikowany identyfikator zasobu dla zasobu. Przykład - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nazwa zasobu
properties.description	string	Opis alertu.
properties.displayName	string	Nazwa wyświetlana alertu.
properties.howToPrevent	string	Sposoby zapobiegania alertowi.
properties.isConfigurable	boolean	Prawda, jeśli można skonfigurować konfigurację alertu; false, w przeciwnym razie.
properties.isRemediatable	boolean	Wartość true, jeśli alert można skorygować; false, w przeciwnym razie.
properties.mitigationSteps	string	Metody ograniczania alertu.
properties.scope	string	Zakres alertu.
properties.securityImpact	string	Wpływ alertu na zabezpieczenia.
properties.severityLevel	SeverityLevel	Poziom ważności alertu.
systemData	systemData	Metadane Azure Resource Manager zawierające informacje createdBy i modifiedBy.
type	string	Typ zasobu. Np. "Microsoft. Compute/virtualMachines" lub "Microsoft. Storage/storageAccounts"

AlertIncident

Objekt

Zdarzenie alertu

Nazwa	Typ	Opis
id	string	W pełni kwalifikowany identyfikator zasobu dla zasobu. Przykład - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nazwa zasobu
properties	AlertIncidentProperties: AzureRolesAssignedOutsidePimAlertIncidentProperties DuplicateRoleCreatedAlertIncidentProperties TooManyOwnersAssignedToResourceAlertIncidentProperties TooManyPermanentOwnersAssignedToResourceAlertIncidentProperties	Zwróć uwagę na właściwości zdarzenia.
systemData	systemData	Metadane Azure Resource Manager zawierające informacje createdBy i modifiedBy.
type	string	Typ zasobu. Np. "Microsoft. Compute/virtualMachines" lub "Microsoft. Storage/storageAccounts"

AlertListResult

Objekt

Odpowiedź w postaci operacji listy alarmowej.

Nazwa	Typ	Opis
nextLink	string (uri)	Link do następnej strony elementów
value	Alert[]	Elementy alertu na tej stronie

AzureRolesAssignedOutsidePimAlertConfigurationProperties

Objekt

Role Azure przypisują zewnętrzne właściwości konfiguracyjne alertów PIM.

Nazwa	Typ	Opis
alertConfigurationType	string: AzureRolesAssignedOutsidePimAlertConfiguration	Typ konfiguracji alertu.
alertDefinition	AlertDefinition	Definicja alertu.
alertDefinitionId	string	Identyfikator definicji alertu.
isEnabled	boolean	Wartość True, jeśli alert jest włączony, wartość false spowoduje wyłączenie skanowania dla określonego alertu.
scope	string	Zakres alertu.

AzureRolesAssignedOutsidePimAlertIncidentProperties

Objekt

Azure roles assigned outside PIM alert incident properties.

Nazwa	Typ	Opis
alertIncidentType	string: AzureRolesAssignedOutsidePimAlertIncident	Typ zdarzenia alertu.
assigneeDisplayName	string	Imię wyświetlające się odbiorcy.
assigneeId	string	Identyfikator przydziału.
assigneeUserPrincipalName	string	Główne imię użytkownika przypisanego.
assignmentActivatedDate	string (date-time)	Data aktywacji zadania.
requestorDisplayName	string	Nazwa wyświetlana żądającego.
requestorId	string	ID żądającego.
requestorUserPrincipalName	string	Główne imię użytkownika żądającego.
roleDefinitionId	string	Identyfikator definicji roli.
roleDisplayName	string	Nazwa wyświetlana w roli.
roleTemplateId	string	ID szablonu roli.

createdByType

Wyliczenie

Typ tożsamości, która utworzyła zasób.

Wartość	Opis
User
Application
ManagedIdentity
Key

DuplicateRoleCreatedAlertConfigurationProperties

Objekt

Duplikowana rola tworzyła konfigurację alertów.

Nazwa	Typ	Opis
alertConfigurationType	string: DuplicateRoleCreatedAlertConfiguration	Typ konfiguracji alertu.
alertDefinition	AlertDefinition	Definicja alertu.
alertDefinitionId	string	Identyfikator definicji alertu.
isEnabled	boolean	Wartość True, jeśli alert jest włączony, wartość false spowoduje wyłączenie skanowania dla określonego alertu.
scope	string	Zakres alertu.

DuplicateRoleCreatedAlertIncidentProperties

Objekt

Duplikat roli tworzył alert właściwości incydentów.

Nazwa	Typ	Opis
alertIncidentType	string: DuplicateRoleCreatedAlertIncident	Typ zdarzenia alertu.
duplicateRoles	string	Podwójne role.
reason	string	Powód incydentu.
roleName	string	Nazwa roli.

Microsoft.Common.CloudError

Objekt

Odpowiedź na błąd z usługi.

Nazwa	Typ	Opis
error	Microsoft.Common.CloudErrorBody	Odpowiedź na błąd z usługi.

Microsoft.Common.CloudErrorBody

Objekt

Odpowiedź na błąd z usługi.

Nazwa	Typ	Opis
code	string	Identyfikator błędu. Kody są niezmienne i mają być używane programowo.
message	string	Komunikat opisujący błąd, który ma być odpowiedni do wyświetlania w interfejsie użytkownika.

SeverityLevel

Wyliczenie

Poziom ważności alertu.

Wartość	Opis
Low	Low
Medium	Średni
High	High

systemData

Objekt

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string (date-time)	Sygnatura czasowa tworzenia zasobu (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string (date-time)	Sygnatura czasowa ostatniej modyfikacji zasobu (UTC)
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.

TooManyOwnersAssignedToResourceAlertConfigurationProperties

Objekt

Zbyt wielu właścicieli przypisanych do ustawień ustawień alertów zasobów.

Nazwa	Typ	Opis
alertConfigurationType	string: TooManyOwnersAssignedToResourceAlertConfiguration	Typ konfiguracji alertu.
alertDefinition	AlertDefinition	Definicja alertu.
alertDefinitionId	string	Identyfikator definicji alertu.
isEnabled	boolean	Wartość True, jeśli alert jest włączony, wartość false spowoduje wyłączenie skanowania dla określonego alertu.
scope	string	Zakres alertu.
thresholdNumberOfOwners	integer (int32)	Próg liczby właścicieli.
thresholdPercentageOfOwnersOutOfAllRoleMembers	integer (int32)	Progowy procent właścicieli spośród wszystkich członków roli.

TooManyOwnersAssignedToResourceAlertIncidentProperties

Objekt

Zbyt wielu właścicieli przypisanych do obiektów alertów o zasobach.

Nazwa	Typ	Opis
alertIncidentType	string: TooManyOwnersAssignedToResourceAlertIncident	Typ zdarzenia alertu.
assigneeName	string	Imię cedilera.
assigneeType	string	Typ osoby.

TooManyPermanentOwnersAssignedToResourceAlertConfigurationProperties

Objekt

Zbyt wielu stałych właścicieli przypisanych do konfiguracji alertów zasobów.

Nazwa	Typ	Opis
alertConfigurationType	string: TooManyPermanentOwnersAssignedToResourceAlertConfiguration	Typ konfiguracji alertu.
alertDefinition	AlertDefinition	Definicja alertu.
alertDefinitionId	string	Identyfikator definicji alertu.
isEnabled	boolean	Wartość True, jeśli alert jest włączony, wartość false spowoduje wyłączenie skanowania dla określonego alertu.
scope	string	Zakres alertu.
thresholdNumberOfPermanentOwners	integer (int32)	Próg liczby stałych właścicieli.
thresholdPercentageOfPermanentOwnersOutOfAllOwners	integer (int32)	Progowy procent stałych właścicieli spośród wszystkich właścicieli.

TooManyPermanentOwnersAssignedToResourceAlertIncidentProperties

Objekt

Zbyt wielu stałych właścicieli przypisanych do obiektów alertów o zasobach.

Nazwa	Typ	Opis
alertIncidentType	string: TooManyPermanentOwnersAssignedToResourceAlertIncident	Typ zdarzenia alertu.
assigneeName	string	Imię cedilera.
assigneeType	string	Typ osoby.