Dela via


Alerts - List For Scope

Hämtar aviseringar för ett resursomfång.

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

URI-parametrar

Namn I Krävs Typ Beskrivning
scope
path True

string

Aviseringens omfattning.

api-version
query True

string

minLength: 1

DEN API-version som ska användas för den här åtgärden.

Svaren

Namn Typ Beskrivning
200 OK

AlertListResult

OK – Returnerar en matris med aviseringar.

Other Status Codes

CloudError

Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2-flöde

Typ: oauth2
Rinna: implicit
Auktorisations-URL: https://login.microsoftonline.com/common/oauth2/authorize

Scope

Namn Beskrivning
user_impersonation personifiera ditt användarkonto

Exempel

GetAlerts

Exempelförfrågan

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

Exempelsvar

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

Definitioner

Namn Beskrivning
Alert

Aviseringen.

AlertConfiguration

Aviseringskonfiguration.

AlertDefinition

Aviseringsdefinition

AlertIncident

Aviseringsincident

AlertListResult

Resultat av aviseringslistans åtgärd.

CloudError

Ett felsvar från tjänsten.

CloudErrorBody

Ett felsvar från tjänsten.

SeverityLevel

Allvarlighetsgrad för aviseringen.

Alert

Aviseringen.

Namn Typ Beskrivning
id

string

Aviserings-ID:t.

name

string

Aviseringsnamnet.

properties.alertConfiguration

AlertConfiguration

Aviseringskonfigurationen.

properties.alertDefinition

AlertDefinition

Aviseringsdefinitionen.

properties.alertIncidents

AlertIncident[]

Aviseringsincidenterna.

properties.incidentCount

integer (int32)

Antalet genererade incidenter i aviseringen.

properties.isActive

boolean

Falskt som standard; sant om aviseringen är aktiv.

properties.lastModifiedDateTime

string (date-time)

Datum då aviseringskonfigurationen uppdaterades eller nya incidenter genererades.

properties.lastScannedDateTime

string (date-time)

Datum då aviseringen senast genomsökdes.

properties.scope

string

Aviseringsomfånget.

type

string

Aviseringstypen.

AlertConfiguration

Aviseringskonfiguration.

Namn Typ Beskrivning
id

string

Konfigurations-ID för avisering.

name

string

Aviseringskonfigurationsnamnet.

properties.alertConfigurationType

string

Aviseringskonfigurationstypen.

properties.alertDefinition

AlertDefinition

Aviseringsdefinitionen.

properties.alertDefinitionId

string

Aviseringsdefinitions-ID:t.

properties.isEnabled

boolean

Sant om aviseringen är aktiverad inaktiverar false genomsökningen efter den specifika aviseringen.

properties.scope

string

Aviseringsomfånget.

type

string

Aviseringskonfigurationstypen.

AlertDefinition

Aviseringsdefinition

Namn Typ Beskrivning
id

string

Aviseringsdefinitions-ID:t.

name

string

Aviseringsdefinitionens namn.

properties.description

string

Aviseringsbeskrivningen.

properties.displayName

string

Aviseringsvisningsnamnet.

properties.howToPrevent

string

Sätt att förhindra aviseringen.

properties.isConfigurable

boolean

Sant om aviseringskonfigurationen kan konfigureras. falskt, annars.

properties.isRemediatable

boolean

Sant om aviseringen kan åtgärdas. falskt, annars.

properties.mitigationSteps

string

Metoder för att minimera aviseringen.

properties.scope

string

Aviseringsomfånget.

properties.securityImpact

string

Säkerhetspåverkan av aviseringen.

properties.severityLevel

SeverityLevel

Allvarlighetsgrad för aviseringen.

type

string

Aviseringsdefinitionstypen.

AlertIncident

Aviseringsincident

Namn Typ Beskrivning
id

string

Aviseringsincidentens ID.

name

string

Namnet på aviseringsincidenten.

properties.alertIncidentType

string

Typen av aviseringsincident.

type

string

Typen av aviseringsincident.

AlertListResult

Resultat av aviseringslistans åtgärd.

Namn Typ Beskrivning
nextLink

string

Den URL som ska användas för att hämta nästa uppsättning resultat.

value

Alert[]

Aviseringslista

CloudError

Ett felsvar från tjänsten.

Namn Typ Beskrivning
error

CloudErrorBody

Ett felsvar från tjänsten.

CloudErrorBody

Ett felsvar från tjänsten.

Namn Typ Beskrivning
code

string

En identifierare för felet. Koder är invarianta och är avsedda att användas programmatiskt.

message

string

Ett meddelande som beskriver felet, avsett att vara lämpligt för visning i ett användargränssnitt.

SeverityLevel

Allvarlighetsgrad för aviseringen.

Värde Beskrivning
Low
Medium
High