Security Contacts - Get

Référence

Service:: Defender for Cloud

API Version:: 2023-12-01-preview

Obtenir les configurations de contact de sécurité par défaut pour l’abonnement

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

Paramètres URI

Nom Dans Obligatoire Type Description

Nom	Dans	Obligatoire	Type	Description
securityContactName	path	True	securityContactName	Nom de l’objet contact de sécurité Regex pattern: `^(default)$`
subscriptionId	path	True	string	ID d’abonnement Azure Regex pattern: `^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$`
api-version	query	True	string	Version de l’API pour l’opération

securityContactName

path

True

securityContactName

Nom de l’objet contact de sécurité

Regex pattern: ^(default)$

subscriptionId

path

True

string

ID d’abonnement Azure

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

api-version

query

True

string

Version de l’API pour l’opération

Réponses

Nom	Type	Description
200 OK	SecurityContact	Ok
Other Status Codes	CloudError	Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

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

Scopes

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

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

Définitions

Nom	Description
CloudError	Réponse d’erreur courante pour toutes les API Azure Resource Manager pour retourner les détails de l’erreur concernant les opérations ayant échoué. (Cela suit également le format de réponse d’erreur OData.).
CloudErrorBody	Détail de l’erreur.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
minimalRiskLevel	Définit le niveau de risque minimal du chemin d’attachement qui sera envoyé en tant que Notifications par e-mail
minimalSeverity
NotificationsByRole	Définit s’il faut envoyer des Notifications par e-mail à partir de Microsoft Defender pour le cloud aux personnes disposant de rôles RBAC spécifiques sur l’abonnement.
NotificationsSourceAlert	Source de notification d’alerte
NotificationsSourceAttackPath	Source de notification du chemin d’attaque
SecurityContact	Coordonnées et configurations pour les notifications provenant de Microsoft Defender pour le cloud.
securityContactName	Nom de l’objet contact de sécurité
securityContactRole	Définit les rôles RBAC qui recevront Notifications par e-mail de Microsoft Defender pour le cloud. Liste des rôles RBAC autorisés :
state	Définit s’il faut envoyer des Notifications par e-mail à partir d’AMicrosoft Defender pour le cloud à des personnes disposant de rôles RBAC spécifiques sur l’abonnement.

CloudError

Réponse d’erreur courante pour toutes les API Azure Resource Manager pour retourner les détails de l’erreur concernant les opérations ayant échoué. (Cela suit également le format de réponse d’erreur OData.).

Nom	Type	Description
error.additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
error.code	string	Code d'erreur.
error.details	CloudErrorBody[]	Détails de l’erreur.
error.message	string	Message d’erreur.
error.target	string	Cible d’erreur.

CloudErrorBody

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d'erreur.
details	CloudErrorBody[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires
type	string	Type d’informations supplémentaires.

minimalRiskLevel

Définit le niveau de risque minimal du chemin d’attachement qui sera envoyé en tant que Notifications par e-mail

Nom	Type	Description
Critical	string	Recevoir des notifications sur les nouveaux chemins d’attaque avec le niveau de risque critique
High	string	Recevoir des notifications sur les nouveaux chemins d’attaque avec un niveau de risque élevé ou critique
Low	string	Recevoir des notifications sur les nouveaux chemins d’attachement avec un niveau de risque faible, moyen, élevé ou critique
Medium	string	Recevoir des notifications sur les nouveaux chemins d’attachement avec un niveau de risque moyen, élevé ou critique

minimalSeverity

Nom	Type	Description
High	string	Recevoir des notifications sur les nouvelles alertes avec une gravité élevée
Low	string	Recevoir des notifications sur les nouvelles alertes avec une gravité faible, moyenne ou élevée
Medium	string	Recevoir des notifications sur les nouvelles alertes avec une gravité moyenne ou élevée

NotificationsByRole

Définit s’il faut envoyer des Notifications par e-mail à partir de Microsoft Defender pour le cloud aux personnes disposant de rôles RBAC spécifiques sur l’abonnement.

Nom	Type	Description
roles	securityContactRole[]	Définit les rôles RBAC qui recevront Notifications par e-mail de Microsoft Defender pour le cloud. Liste des rôles RBAC autorisés :
state	state	Définit s’il faut envoyer des Notifications par e-mail à partir d’AMicrosoft Defender pour le cloud à des personnes disposant de rôles RBAC spécifiques sur l’abonnement.

NotificationsSourceAlert

Source de notification d’alerte

Nom	Type	Description
minimalSeverity	minimalSeverity
sourceType	string: Alert	Type de source qui déclenchera la notification

NotificationsSourceAttackPath

Source de notification du chemin d’attaque

Nom	Type	Description
minimalRiskLevel	minimalRiskLevel	Définit le niveau de risque minimal du chemin d’attachement qui sera envoyé en tant que Notifications par e-mail
sourceType	string: AttackPath	Type de source qui déclenchera la notification