Compartir a través de

Alerts - List For Scope

  • Referencia
Servicio:
Authorization
Versión de la API:
2022-08-01-preview

Obtiene alertas para un ámbito de recurso.

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
scope
 path True

string

Ámbito de la alerta.
api-version
 query True

string

Versión de API que se usará para la operación.

Respuestas

Nombre Tipo Description
200 OK

AlertListResult

Aceptar: devuelve una matriz de alertas.
Other Status Codes

CloudError

Respuesta de error que describe el motivo del error de la operación.

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre Description
user_impersonation suplantación de su cuenta de usuario

Ejemplos

GetAlerts

Solicitud de ejemplo

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

Respuesta de muestra

status code:
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"
    }
  ]
}

Definiciones

Nombre Description
Alert

La alerta.
AlertConfiguration

Configuración de alertas.
AlertDefinition

Definición de la alerta
AlertIncident

Incidente de alerta
AlertListResult

Resultado de la operación de lista de alertas.
CloudError

Respuesta de error del servicio.
CloudErrorBody

Respuesta de error del servicio.
SeverityLevel

Nivel de gravedad de la alerta.

Alert

La alerta.

Nombre Tipo Description
id

string

Id. de la alerta
name

string

Nombre de la alerta
properties.alertConfiguration

AlertConfiguration

Configuración de alertas.
properties.alertDefinition

AlertDefinition

Definición de la alerta.
properties.alertIncidents

AlertIncident[]

Los incidentes de alerta.
properties.incidentCount

integer

Número de incidentes generados de la alerta.
properties.isActive

boolean

False de forma predeterminada; True si la alerta está activa.
properties.lastModifiedDateTime

string

Fecha y hora en que se actualizó la configuración de la alerta o se generaron nuevos incidentes.
properties.lastScannedDateTime

string

Fecha y hora en que se examinó por última vez la alerta.
properties.scope

string

Ámbito de alerta.
type

string

Tipo de alerta.

AlertConfiguration

Configuración de alertas.

Nombre Tipo Description
id

string

Identificador de configuración de alerta.
name

string

Nombre de configuración de alerta.
properties.alertConfigurationType

string

Tipo de configuración de alerta.
properties.alertDefinition

AlertDefinition

Definición de la alerta.
properties.alertDefinitionId

string

Identificador de la definición de alerta.
properties.isEnabled

boolean

True si la alerta está habilitada, false deshabilitará el examen de la alerta específica.
properties.scope

string

Ámbito de alerta.
type

string

Tipo de configuración de alerta.

AlertDefinition

Definición de la alerta

Nombre Tipo Description
id

string

Identificador de la definición de alerta.
name

string

Nombre de la definición de alerta.
properties.description

string

La descripción de la alerta.
properties.displayName

string

Nombre para mostrar de la alerta.
properties.howToPrevent

string

Formas de evitar la alerta.
properties.isConfigurable

boolean

True si se puede configurar la configuración de alertas; False, en caso contrario.
properties.isRemediatable

boolean

True si se puede corregir la alerta; False, en caso contrario.
properties.mitigationSteps

string

Métodos para mitigar la alerta.
properties.scope

string

Ámbito de alerta.
properties.securityImpact

string

Impacto en la seguridad de la alerta.
properties.severityLevel

SeverityLevel

Nivel de gravedad de la alerta.
type

string

Tipo de definición de alerta.

AlertIncident

Incidente de alerta

Nombre Tipo Description
id

string

Identificador del incidente de alerta.
name

string

Nombre del incidente de alerta.
properties.alertIncidentType

string

Tipo de incidente de alerta.
type

string

Tipo de incidente de alerta.

AlertListResult

Resultado de la operación de lista de alertas.

Nombre Tipo Description
nextLink

string

Dirección URL que se va a usar para obtener el siguiente conjunto de resultados.
value

Alert[]

Lista de alertas

CloudError

Respuesta de error del servicio.

Nombre Tipo Description
error

CloudErrorBody

Respuesta de error del servicio.

CloudErrorBody

Respuesta de error del servicio.

Nombre Tipo Description
code

string

Identificador del error. Los códigos son invariables y están diseñados para consumirse mediante programación.
message

string

Mensaje que describe el error, diseñado para ser adecuado para mostrarse en una interfaz de usuario.

SeverityLevel

Nivel de gravedad de la alerta.

Nombre Tipo Description
High

string

Low

string

Medium

string