Security Contacts - Get

Referenz

Service:: Defender for Cloud

API Version:: 2023-12-01-preview

Abrufen von Standardkonfigurationen für Sicherheitskontakte für das Abonnement

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

URI-Parameter

Name In Erforderlich Typ Beschreibung

Name	In	Erforderlich	Typ	Beschreibung
securityContactName	path	True	securityContactName	Name des Sicherheitskontaktobjekts Regex pattern: `^(default)$`
subscriptionId	path	True	string	Azure-Abonnement-ID Regex pattern: `^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$`
api-version	query	True	string	API-Version für den Vorgang

securityContactName

path

True

securityContactName

Name des Sicherheitskontaktobjekts

Regex pattern: ^(default)$

subscriptionId

path

True

string

Azure-Abonnement-ID

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

api-version

query

True

string

API-Version für den Vorgang

Antworten

Name	Typ	Beschreibung
200 OK	SecurityContact	OK
Other Status Codes	CloudError	Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

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

Scopes

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

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"
      }
    ]
  }
}

Definitionen

Name	Beschreibung
CloudError	Allgemeine Fehlerantwort für alle Azure Resource Manager-APIs, zur Rückgabe von Fehlerdetails für fehlgeschlagene Vorgänge. (Dies folgt auch dem OData-Fehlerantwortformat.)
CloudErrorBody	Die Fehlerdetails.
ErrorAdditionalInfo	Zusätzliche Informationen zum Ressourcenverwaltungsfehler.
minimalRiskLevel	Definiert die minimale Risikostufe des Anfügungspfads, die als E-Mail-Benachrichtigungen gesendet wird.
minimalSeverity
NotificationsByRole	Definiert, ob E-Mail-Benachrichtigungen von Microsoft Defender für Cloud an Personen mit bestimmten RBAC-Rollen im Abonnement gesendet werden sollen.
NotificationsSourceAlert	Quelle für Warnungsbenachrichtigungen
NotificationsSourceAttackPath	Angriffspfad-Benachrichtigungsquelle
SecurityContact	Kontaktdetails und Konfigurationen für Benachrichtigungen von Microsoft Defender für Cloud.
securityContactName	Name des Sicherheitskontaktobjekts
securityContactRole	Definiert, welche RBAC-Rollen E-Mail-Benachrichtigungen von Microsoft Defender für Cloud erhalten. Liste der zulässigen RBAC-Rollen:
state	Definiert, ob E-Mail-Benachrichtigungen von AMicrosoft Defender für Cloud an Personen mit bestimmten RBAC-Rollen im Abonnement gesendet werden sollen.

CloudError

Allgemeine Fehlerantwort für alle Azure Resource Manager-APIs, zur Rückgabe von Fehlerdetails für fehlgeschlagene Vorgänge. (Dies folgt auch dem OData-Fehlerantwortformat.)

Name	Typ	Beschreibung
error.additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Fehlerinformationen.
error.code	string	Der Fehlercode.
error.details	CloudErrorBody[]	Die Fehlerdetails.
error.message	string	Die Fehlermeldung.
error.target	string	Das Fehlerziel.

CloudErrorBody

Die Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Fehlerinformationen.
code	string	Der Fehlercode.
details	CloudErrorBody[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

Name	Typ	Beschreibung
info	object	Zusätzliche Informationen.
type	string	Typ der zusätzlichen Informationen.

minimalRiskLevel

Definiert die minimale Risikostufe des Anfügungspfads, die als E-Mail-Benachrichtigungen gesendet wird.

Name	Typ	Beschreibung
Critical	string	Erhalten von Benachrichtigungen zu neuen Angriffspfaden mit kritischer Risikostufe
High	string	Abrufen von Benachrichtigungen zu neuen Angriffspfaden mit hoher oder kritischer Risikostufe
Low	string	Abrufen von Benachrichtigungen zu neuen Anfügungspfaden mit der Risikostufe "Niedrig", "Mittel", "Hoch" oder "Kritisch"
Medium	string	Abrufen von Benachrichtigungen zu neuen Anfügungspfaden mit der Risikostufe "Mittel", "Hoch" oder "Kritisch"

minimalSeverity

Name	Typ	Beschreibung
High	string	Abrufen von Benachrichtigungen zu neuen Warnungen mit hohem Schweregrad
Low	string	Abrufen von Benachrichtigungen zu neuen Warnungen mit dem Schweregrad "Niedrig", "Mittel" oder "Hoch"
Medium	string	Abrufen von Benachrichtigungen zu neuen Warnungen mit mittlerem oder hohem Schweregrad

NotificationsByRole

Definiert, ob E-Mail-Benachrichtigungen von Microsoft Defender für Cloud an Personen mit bestimmten RBAC-Rollen im Abonnement gesendet werden sollen.

Name	Typ	Beschreibung
roles	securityContactRole[]	Definiert, welche RBAC-Rollen E-Mail-Benachrichtigungen von Microsoft Defender für Cloud erhalten. Liste der zulässigen RBAC-Rollen:
state	state	Definiert, ob E-Mail-Benachrichtigungen von AMicrosoft Defender für Cloud an Personen mit bestimmten RBAC-Rollen im Abonnement gesendet werden sollen.

NotificationsSourceAlert

Quelle für Warnungsbenachrichtigungen

Name	Typ	Beschreibung
minimalSeverity	minimalSeverity
sourceType	string: Alert	Der Quelltyp, der die Benachrichtigung auslöst

NotificationsSourceAttackPath

Angriffspfad-Benachrichtigungsquelle

Name	Typ	Beschreibung
minimalRiskLevel	minimalRiskLevel	Definiert die minimale Risikostufe des Anfügungspfads, die als E-Mail-Benachrichtigungen gesendet wird.
sourceType	string: AttackPath	Der Quelltyp, der die Benachrichtigung auslöst