Security Contacts - List

Odwołanie

Usługa:: Defender for Cloud

Wersja interfejsu API:: 2023-12-01-preview

Wyświetlanie listy wszystkich konfiguracji kontaktu 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

Nazwa	W	Wymagane	Typ	Opis
subscriptionId	path	True	string	Identyfikator subskrypcji platformy Azure Wzorzec wyrażenia regularnego: `^[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

subscriptionId

path

True

string

Identyfikator subskrypcji platformy Azure

Wzorzec wyrażenia regularnego: ^[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 protokołu OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

List security contact data

Przykładowe żądanie

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


/**
 * Samples for SecurityContacts List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/security/resource-manager/Microsoft.Security/preview/2023-12-01-preview/examples/SecurityContacts/
     * GetSecurityContactsSubscription_example.json
     */
    /**
     * Sample code: List security contact data.
     * 
     * @param manager Entry point to SecurityManager.
     */
    public static void listSecurityContactData(com.azure.resourcemanager.security.SecurityManager manager) {
        manager.securityContacts().list(com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armsecurity_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/security/armsecurity"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ac34f238dd6b9071f486b57e9f9f1a0c43ec6f6/specification/security/resource-manager/Microsoft.Security/preview/2023-12-01-preview/examples/SecurityContacts/GetSecurityContactsSubscription_example.json
func ExampleContactsClient_NewListPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsecurity.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewContactsClient().NewListPager(nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ContactList = armsecurity.ContactList{
		// 	Value: []*armsecurity.Contact{
		// 		{
		// 			Name: to.Ptr("default"),
		// 			Type: to.Ptr("Microsoft.Security/securityContact"),
		// 			ID: to.Ptr("/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/securityContact/default"),
		// 			Properties: &armsecurity.ContactProperties{
		// 				Emails: to.Ptr("john@contoso.com;Jane@contoso.com"),
		// 				IsEnabled: to.Ptr(true),
		// 				NotificationsByRole: &armsecurity.ContactPropertiesNotificationsByRole{
		// 					Roles: []*armsecurity.SecurityContactRole{
		// 						to.Ptr(armsecurity.SecurityContactRoleOwner),
		// 						to.Ptr(armsecurity.SecurityContactRole("Admin"))},
		// 						State: to.Ptr(armsecurity.State("On")),
		// 					},
		// 					NotificationsSources: []armsecurity.NotificationsSourceClassification{
		// 						&armsecurity.NotificationsSourceAttackPath{
		// 							SourceType: to.Ptr(armsecurity.SourceTypeAttackPath),
		// 							MinimalRiskLevel: to.Ptr(armsecurity.MinimalRiskLevelCritical),
		// 						},
		// 						&armsecurity.NotificationsSourceAlert{
		// 							SourceType: to.Ptr(armsecurity.SourceTypeAlert),
		// 							MinimalSeverity: to.Ptr(armsecurity.MinimalSeverityMedium),
		// 					}},
		// 					Phone: to.Ptr("(214)275-4038"),
		// 				},
		// 		}},
		// 	}
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { SecurityCenter } = require("@azure/arm-security");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to List all security contact configurations for the subscription
 *
 * @summary List all security contact configurations for the subscription
 * x-ms-original-file: specification/security/resource-manager/Microsoft.Security/preview/2023-12-01-preview/examples/SecurityContacts/GetSecurityContactsSubscription_example.json
 */
async function listSecurityContactData() {
  const subscriptionId =
    process.env["SECURITY_SUBSCRIPTION_ID"] || "20ff7fc3-e762-44dd-bd96-b71116dcdc23";
  const credential = new DefaultAzureCredential();
  const client = new SecurityCenter(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.securityContacts.list()) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Przykładowa odpowiedź

Kod stanu:: 200

{
  "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łędy dla wszystkich interfejsów API usługi Azure Resource Manager w celu zwrócenia szczegółów błędu dla operacji, które zakończyły się niepowodzeniem. (Jest to również zgodne z formatem odpowiedzi na błąd 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 będzie wysyłany jako powiadomienia e-mail
minimalSeverity
NotificationsByRole	Określa, czy wysyłać powiadomienia e-mail z usługi Microsoft Defender for Cloud do osób z określonymi rolami RBAC w ramach 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 usługi Microsoft Defender for Cloud.
SecurityContactList	Lista odpowiedzi kontaktów zabezpieczeń
securityContactRole	Określa, które role RBAC będą otrzymywać powiadomienia e-mail z usługi 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łędy dla wszystkich interfejsów API usługi Azure Resource Manager w celu zwrócenia szczegółów błędu dla operacji, które zakończyły się niepowodzeniem. (Jest to również zgodne z formatem odpowiedzi na błąd 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 będzie wysył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 z wysokim lub krytycznym poziomem ryzyka
Low	string	Otrzymywanie powiadomień o nowych ścieżkach dołączania przy użyciu poziomu ryzyka niskiego, średniego, wysokiego lub krytycznego
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 usługi Microsoft Defender for Cloud do osób z określonymi rolami RBAC w ramach subskrypcji.

Nazwa	Typ	Opis
roles	securityContactRole[]	Określa, które role RBAC będą otrzymywać powiadomienia e-mail z usługi 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 będzie wysyłany jako powiadomienia e-mail
sourceType	string: AttackPath	Typ źródła, który wyzwoli powiadomienie