Security Contacts - List

Wyświetlanie listy wszystkich konfiguracji kontaktów zabezpieczeń dla subskrypcji

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Security/securityContacts?api-version=2023-12-01-preview

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
subscriptionId
path True

string

Identyfikator subskrypcji platformy Azure

Regex pattern: ^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$

api-version
query True

string

Wersja interfejsu API dla operacji

Odpowiedzi

Nazwa Typ Opis
200 OK

SecurityContactList

OK

Other Status Codes

CloudError

Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nazwa Opis
user_impersonation personifikacja konta użytkownika

Przykłady

List security contact data

Sample Request

GET https://management.azure.com/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/securityContacts?api-version=2023-12-01-preview

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/securityContact/default",
      "name": "default",
      "type": "Microsoft.Security/securityContact",
      "properties": {
        "notificationsByRole": {
          "state": "On",
          "roles": [
            "Owner",
            "Admin"
          ]
        },
        "isEnabled": true,
        "emails": "john@contoso.com;Jane@contoso.com",
        "phone": "(214)275-4038",
        "notificationsSources": [
          {
            "sourceType": "AttackPath",
            "minimalRiskLevel": "Critical"
          },
          {
            "sourceType": "Alert",
            "minimalSeverity": "Medium"
          }
        ]
      }
    }
  ]
}

Definicje

Nazwa Opis
CloudError

Typowa odpowiedź na błąd dla wszystkich interfejsów API usługi Azure Resource Manager zwraca szczegóły błędu dla operacji, które zakończyły się niepowodzeniem. (Jest to również zgodne z formatem odpowiedzi oData).

CloudErrorBody

Szczegóły błędu.

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

minimalRiskLevel

Definiuje minimalny poziom ryzyka ścieżki dołączania, który zostanie wysłany jako powiadomienia e-mail

minimalSeverity
NotificationsByRole

Określa, czy wysyłać powiadomienia e-mail z Microsoft Defender for Cloud do osób z określonymi rolami RBAC w subskrypcji.

NotificationsSourceAlert

Źródło powiadomień o alertach

NotificationsSourceAttackPath

Źródło powiadomień o ścieżce ataku

SecurityContact

Dane kontaktowe i konfiguracje powiadomień pochodzących z Microsoft Defender for Cloud.

SecurityContactList

Lista odpowiedzi kontaktów zabezpieczeń

securityContactRole

Definiuje, które role RBAC będą otrzymywać powiadomienia e-mail z Microsoft Defender for Cloud. Lista dozwolonych ról RBAC:

state

Określa, czy wysyłać powiadomienia e-mail z usługi AMicrosoft Defender for Cloud do osób z określonymi rolami RBAC w subskrypcji.

CloudError

Typowa odpowiedź na błąd dla wszystkich interfejsów API usługi Azure Resource Manager zwraca szczegóły błędu dla operacji, które zakończyły się niepowodzeniem. (Jest to również zgodne z formatem odpowiedzi oData).

Nazwa Typ Opis
error.additionalInfo

ErrorAdditionalInfo[]

Dodatkowe informacje o błędzie.

error.code

string

Kod błędu.

error.details

CloudErrorBody[]

Szczegóły błędu.

error.message

string

Komunikat o błędzie.

error.target

string

Element docelowy błędu.

CloudErrorBody

Szczegóły błędu.

Nazwa Typ Opis
additionalInfo

ErrorAdditionalInfo[]

Dodatkowe informacje o błędzie.

code

string

Kod błędu.

details

CloudErrorBody[]

Szczegóły błędu.

message

string

Komunikat o błędzie.

target

string

Element docelowy błędu.

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa Typ Opis
info

object

Dodatkowe informacje.

type

string

Dodatkowy typ informacji.

minimalRiskLevel

Definiuje minimalny poziom ryzyka ścieżki dołączania, który zostanie wysłany jako powiadomienia e-mail

Nazwa Typ Opis
Critical

string

Otrzymywanie powiadomień o nowych ścieżkach ataków przy użyciu poziomu ryzyka krytycznego

High

string

Otrzymywanie powiadomień o nowych ścieżkach ataków przy użyciu wysokiego lub krytycznego poziomu ryzyka

Low

string

Otrzymywanie powiadomień o nowych ścieżkach dołączania przy użyciu niskiego, średniego, wysokiego lub krytycznego poziomu ryzyka

Medium

string

Otrzymywanie powiadomień o nowych ścieżkach dołączania przy użyciu poziomu ryzyka średniego, wysokiego lub krytycznego

minimalSeverity

Nazwa Typ Opis
High

string

Otrzymywanie powiadomień o nowych alertach o wysokiej ważności

Low

string

Otrzymywanie powiadomień o nowych alertach o niskiej, średniej lub wysokiej ważności

Medium

string

Otrzymywanie powiadomień o nowych alertach o średniej lub wysokiej ważności

NotificationsByRole

Określa, czy wysyłać powiadomienia e-mail z Microsoft Defender for Cloud do osób z określonymi rolami RBAC w subskrypcji.

Nazwa Typ Opis
roles

securityContactRole[]

Definiuje, które role RBAC będą otrzymywać powiadomienia e-mail z Microsoft Defender for Cloud. Lista dozwolonych ról RBAC:

state

state

Określa, czy wysyłać powiadomienia e-mail z usługi AMicrosoft Defender for Cloud do osób z określonymi rolami RBAC w subskrypcji.

NotificationsSourceAlert

Źródło powiadomień o alertach

Nazwa Typ Opis
minimalSeverity

minimalSeverity

sourceType string:

Alert

Typ źródła, który wyzwoli powiadomienie

NotificationsSourceAttackPath

Źródło powiadomień o ścieżce ataku

Nazwa Typ Opis
minimalRiskLevel

minimalRiskLevel

Definiuje minimalny poziom ryzyka ścieżki dołączania, który zostanie wysłany jako powiadomienia e-mail

sourceType string:

AttackPath

Typ źródła, który wyzwoli powiadomienie

SecurityContact

Dane kontaktowe i konfiguracje powiadomień pochodzących z Microsoft Defender for Cloud.

Nazwa Typ Opis
id

string

Identyfikator zasobu

name

string

Nazwa zasobu

properties.emails

string

Lista adresów e-mail, które będą otrzymywać powiadomienia z Microsoft Defender for Cloud przez konfiguracje zdefiniowane w tym kontakcie zabezpieczeń.

properties.isEnabled

boolean

Wskazuje, czy kontakt zabezpieczeń jest włączony.

properties.notificationsByRole

NotificationsByRole

Określa, czy wysyłać powiadomienia e-mail z Microsoft Defender for Cloud do osób z określonymi rolami RBAC w subskrypcji.

properties.notificationsSources NotificationsSource[]:

Kolekcja typów źródeł, które oceniają powiadomienie e-mail.

properties.phone

string

Numer telefonu kontaktu zabezpieczającego

type

string

Typ zasobu

SecurityContactList

Lista odpowiedzi kontaktów zabezpieczeń

Nazwa Typ Opis
nextLink

string

Identyfikator URI do pobrania następnej strony.

value

SecurityContact[]

Lista kontaktów zabezpieczeń

securityContactRole

Definiuje, które role RBAC będą otrzymywać powiadomienia e-mail z Microsoft Defender for Cloud. Lista dozwolonych ról RBAC:

Nazwa Typ Opis
AccountAdmin

string

W przypadku włączenia wyślij powiadomienie o nowych alertach do administratorów konta

Contributor

string

W przypadku włączenia wyślij powiadomienie o nowych alertach do współautorów subskrypcji

Owner

string

W przypadku włączenia wyślij powiadomienie o nowych alertach do właścicieli subskrypcji

ServiceAdmin

string

W przypadku włączenia wyślij powiadomienie o nowych alertach do administratorów usługi

state

Określa, czy wysyłać powiadomienia e-mail z usługi AMicrosoft Defender for Cloud do osób z określonymi rolami RBAC w subskrypcji.

Nazwa Typ Opis
Off

string

Nie wysyłaj powiadomień o nowych alertach do administratorów subskrypcji

On

string

Wysyłanie powiadomień o nowych alertach do administratorów subskrypcji