Security Contacts - Get

Odwołanie

Service:: Defender for Cloud

API Version:: 2023-12-01-preview

Pobieranie domyślnych konfiguracji kontaktów zabezpieczeń dla subskrypcji

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis

Nazwa	W	Wymagane	Typ	Opis
securityContactName	path	True	securityContactName	Nazwa obiektu kontaktu zabezpieczeń Regex pattern: `^(default)$`
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

securityContactName

path

True

securityContactName

Nazwa obiektu kontaktu zabezpieczeń

Regex pattern: ^(default)$

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	SecurityContact	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

Get a security contact

Sample Request

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


import com.azure.resourcemanager.security.models.SecurityContactName;

/**
 * Samples for SecurityContacts Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/security/resource-manager/Microsoft.Security/preview/2023-12-01-preview/examples/SecurityContacts/
     * GetSecurityContact_example.json
     */
    /**
     * Sample code: Get a security contact.
     * 
     * @param manager Entry point to SecurityManager.
     */
    public static void getASecurityContact(com.azure.resourcemanager.security.SecurityManager manager) {
        manager.securityContacts().getWithResponse(SecurityContactName.DEFAULT, 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/GetSecurityContact_example.json
func ExampleContactsClient_Get() {
	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)
	}
	res, err := clientFactory.NewContactsClient().Get(ctx, armsecurity.SecurityContactNameDefault, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Contact = armsecurity.Contact{
	// 	Name: to.Ptr("default"),
	// 	Type: to.Ptr("Microsoft.Security/securityContacts"),
	// 	ID: to.Ptr("/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/securityContacts/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)},
	// 				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 Get Default Security contact configurations for the subscription
 *
 * @summary Get Default Security contact configurations for the subscription
 * x-ms-original-file: specification/security/resource-manager/Microsoft.Security/preview/2023-12-01-preview/examples/SecurityContacts/GetSecurityContact_example.json
 */
async function getASecurityContact() {
  const subscriptionId =
    process.env["SECURITY_SUBSCRIPTION_ID"] || "20ff7fc3-e762-44dd-bd96-b71116dcdc23";
  const securityContactName = "default";
  const credential = new DefaultAzureCredential();
  const client = new SecurityCenter(credential, subscriptionId);
  const result = await client.securityContacts.get(securityContactName);
  console.log(result);
}

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

Sample Response

Status code:: 200

{
  "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/securityContacts/default",
  "name": "default",
  "type": "Microsoft.Security/securityContacts",
  "properties": {
    "notificationsByRole": {
      "state": "On",
      "roles": [
        "Owner"
      ]
    },
    "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 zwraca szczegóły 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 dołączania ścieżki, który będzie wysyłany jako powiadomienia e-mail
minimalSeverity
NotificationsByRole	Określa, czy wysyłać powiadomienia e-mail z Microsoft Defender dla chmury 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.
securityContactName	Nazwa obiektu kontaktu zabezpieczeń
securityContactRole	Określa, 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łędy 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 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 dołączania ścieżki, który będzie wysyłany jako powiadomienia e-mail

Nazwa	Typ	Opis
Critical	string	Otrzymywanie powiadomień o nowych ścieżkach ataków z poziomem 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 z poziomem ryzyka Niski, Średni, Wysoki lub Krytyczny
Medium	string	Otrzymywanie powiadomień o nowych ścieżkach dołączania na poziomie ryzyka średni, wysoki lub krytyczny

minimalSeverity

Nazwa	Typ	Opis
High	string	Otrzymywanie powiadomień dotyczących nowych alertów o wysokiej ważności
Low	string	Otrzymywanie powiadomień dotyczących nowych alertów o niskiej, średniej lub wysokiej ważności
Medium	string	Otrzymywanie powiadomień dotyczących nowych alertów o średniej lub wysokiej ważności

NotificationsByRole

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

Nazwa	Typ	Opis
roles	securityContactRole[]	Określa, 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 dołączania ścieżki, który będzie wysyłany jako powiadomienia e-mail
sourceType	string: AttackPath	Typ źródła, który wyzwoli powiadomienie