Partilhar via

Alerts - List For Scope

  • Referência
Serviço:
Authorization
Versão da API:
2022-08-01-preview

Obtém alertas para um âmbito de recurso.

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

Parâmetros do URI

Name Em Necessário Tipo Description
scope
 path True

string

O âmbito do alerta.
api-version
 query True

string

A versão da API a utilizar para esta operação.

Respostas

Name Tipo Description
200 OK

AlertListResult

OK - Devolve uma matriz de alertas.
Other Status Codes

CloudError

Resposta de erro que descreve a razão pela qual a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name Description
user_impersonation representar a sua conta de utilizador

Exemplos

GetAlerts

Pedido de amostra

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

Resposta da amostra

Código de estado:
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"
    }
  ]
}

Definições

Name Description
Alert

O alerta.
AlertConfiguration

Configuração de alertas.
AlertDefinition

Definição de alerta
AlertIncident

Incidente de alerta
AlertListResult

Resultado da operação da lista de alertas.
CloudError

Uma resposta de erro do serviço.
CloudErrorBody

Uma resposta de erro do serviço.
SeverityLevel

Nível de gravidade do alerta.

Alert

O alerta.

Name Tipo Description
id

string

O ID do alerta.
name

string

O nome do alerta.
properties.alertConfiguration

AlertConfiguration

A configuração do alerta.
properties.alertDefinition

AlertDefinition

A definição de alerta.
properties.alertIncidents

AlertIncident[]

Os incidentes de alerta.
properties.incidentCount

integer

O número de incidentes gerados do alerta.
properties.isActive

boolean

Falso por predefinição; true se o alerta estiver ativo.
properties.lastModifiedDateTime

string

A data em que a configuração do alerta foi atualizada ou foram gerados novos incidentes.
properties.lastScannedDateTime

string

A data em que o alerta foi analisado pela última vez.
properties.scope

string

O âmbito do alerta.
type

string

O tipo de alerta.

AlertConfiguration

Configuração de alertas.

Name Tipo Description
id

string

O ID de configuração do alerta.
name

string

O nome da configuração do alerta.
properties.alertConfigurationType

string

O tipo de configuração de alerta.
properties.alertDefinition

AlertDefinition

A definição de alerta.
properties.alertDefinitionId

string

O ID da definição de alerta.
properties.isEnabled

boolean

Verdadeiro se o alerta estiver ativado, falso desativará a análise do alerta específico.
properties.scope

string

O âmbito do alerta.
type

string

O tipo de configuração de alerta.

AlertDefinition

Definição de alerta

Name Tipo Description
id

string

O ID da definição de alerta.
name

string

O nome da definição de alerta.
properties.description

string

A descrição do alerta.
properties.displayName

string

O nome a apresentar do alerta.
properties.howToPrevent

string

As formas de impedir o alerta.
properties.isConfigurable

boolean

Verdadeiro se a configuração do alerta puder ser configurada; falso, caso contrário.
properties.isRemediatable

boolean

Verdadeiro se o alerta puder ser remediado; falso, caso contrário.
properties.mitigationSteps

string

Os métodos para mitigar o alerta.
properties.scope

string

O âmbito do alerta.
properties.securityImpact

string

Impacto de segurança do alerta.
properties.severityLevel

SeverityLevel

Nível de gravidade do alerta.
type

string

O tipo de definição de alerta.

AlertIncident

Incidente de alerta

Name Tipo Description
id

string

O ID do incidente de alerta.
name

string

O nome do incidente de alerta.
properties.alertIncidentType

string

O tipo de incidente de alerta.
type

string

O tipo de incidente de alerta.

AlertListResult

Resultado da operação da lista de alertas.

Name Tipo Description
nextLink

string

O URL a utilizar para obter o próximo conjunto de resultados.
value

Alert[]

Lista de alertas

CloudError

Uma resposta de erro do serviço.

Name Tipo Description
error

CloudErrorBody

Uma resposta de erro do serviço.

CloudErrorBody

Uma resposta de erro do serviço.

Name Tipo Description
code

string

Um identificador para o erro. Os códigos são invariantes e destinam-se a ser consumidos programaticamente.
message

string

Uma mensagem que descreve o erro, destinada a ser adequada para ser apresentada numa interface de utilizador.

SeverityLevel

Nível de gravidade do alerta.

Name Tipo Description
High

string

Low

string

Medium

string