Alerts - List For Scope

サービス:: Authorization

API バージョン:: 2022-08-01-preview

リソーススコープのアラートを取得します。

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

URI パラメーター

名前	/	必須	型	説明
scope	path	True	string	アラートのスコープ。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

応答

名前	型	説明
200 OK	AlertListResult	OK - アラートの配列を返します。
Other Status Codes	CloudError	操作が失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザーアカウントを偽装する

例

GetAlerts

要求のサンプル

HTTP

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

応答のサンプル

状態コード:: 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"
    }
  ]
}

定義

名前	説明
Alert	アラート。
AlertConfiguration	アラートの構成。
AlertDefinition	アラートの定義
AlertIncident	アラートインシデント
AlertListResult	アラートリスト操作の結果。
CloudError	サービスからのエラー応答。
CloudErrorBody	サービスからのエラー応答。
SeverityLevel	アラートの重大度レベル。

Alert

Object

アラート。

名前	型	説明
id	string	アラート ID。
name	string	アラート名。
properties.alertConfiguration	AlertConfiguration	アラートの構成。
properties.alertDefinition	AlertDefinition	アラート定義。
properties.alertIncidents	AlertIncident[]	アラートインシデント。
properties.incidentCount	integer (int32)	アラートの生成されたインシデントの数。
properties.isActive	boolean	既定では False。アラートがアクティブな場合は true。
properties.lastModifiedDateTime	string (date-time)	アラート構成が更新された日時、または新しいインシデントが生成された日時。
properties.lastScannedDateTime	string (date-time)	アラートが最後にスキャンされた日時。
properties.scope	string	アラートスコープ。
type	string	アラートの種類。

AlertConfiguration

Object

アラートの構成。

名前	型	説明
id	string	アラート構成 ID。
name	string	アラート構成名。
properties.alertConfigurationType	string	アラート構成の種類。
properties.alertDefinition	AlertDefinition	アラート定義。
properties.alertDefinitionId	string	アラート定義 ID。
properties.isEnabled	boolean	アラートが有効な場合は True、false は特定のアラートのスキャンを無効にします。
properties.scope	string	アラートスコープ。
type	string	アラート構成の種類。

AlertDefinition

Object

アラートの定義

名前	型	説明
id	string	アラート定義 ID。
name	string	アラート定義名。
properties.description	string	アラートの説明。
properties.displayName	string	アラートの表示名。
properties.howToPrevent	string	アラートを防ぐ方法。
properties.isConfigurable	boolean	True の場合は、アラートの構成を構成できます。false、それ以外の場合。
properties.isRemediatable	boolean	True の場合は、アラートを修復できます。false、それ以外の場合。
properties.mitigationSteps	string	アラートを軽減する方法。
properties.scope	string	アラートスコープ。
properties.securityImpact	string	アラートのセキュリティへの影響。
properties.severityLevel	SeverityLevel	アラートの重大度レベル。
type	string	アラート定義の種類。

AlertIncident

Object

アラートインシデント

名前	型	説明
id	string	アラートインシデント ID。
name	string	アラートインシデント名。
properties.alertIncidentType	string	アラートインシデントの種類。
type	string	アラートインシデントの種類。

AlertListResult

Object

アラートリスト操作の結果。

名前	型	説明
nextLink	string	次の結果セットの取得に使用する URL。
value	Alert[]	アラートの一覧

CloudError

Object

サービスからのエラー応答。

名前	型	説明
error	CloudErrorBody	サービスからのエラー応答。

CloudErrorBody

Object

サービスからのエラー応答。

名前	型	説明
code	string	エラーの識別子。コードは不変であり、プログラムで使用することを目的としています。
message	string	ユーザーインターフェイスでの表示に適したエラーを説明するメッセージ。

SeverityLevel

列挙

アラートの重大度レベル。

値	説明
Low
Medium
High

次の方法で共有

Alerts - List For Scope

URI パラメーター

応答

セキュリティ

azure_auth

スコープ

例

GetAlerts

要求のサンプル

応答のサンプル

定義

Alert

AlertConfiguration

AlertDefinition

AlertIncident

AlertListResult

CloudError

CloudErrorBody

SeverityLevel