Security Contacts - List

Riferimento

Servizio:: Defender for Cloud

Versione API:: 2023-12-01-preview

Elencare tutte le configurazioni dei contatti di sicurezza per la sottoscrizione

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione

Nome	In	Necessario	Tipo	Descrizione
subscriptionId	path	True	string	ID sottoscrizione di Azure Criterio di espressione regolare: `^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$`
api-version	query	True	string	Versione dell'API per l'operazione

subscriptionId

path

True

string

ID sottoscrizione di Azure

Criterio di espressione regolare: ^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$

api-version

query

True

string

Versione dell'API per l'operazione

Risposte

Nome	Tipo	Descrizione
200 OK	SecurityContactList	OK
Other Status Codes	CloudError	Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

List security contact data

Esempio di richiesta

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

Risposta di esempio

Codice di stato:: 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"
          }
        ]
      }
    }
  ]
}

Definizioni

Nome	Descrizione
CloudError	Risposta di errore comune per tutte le API di Azure Resource Manager per restituire i dettagli dell'errore per le operazioni non riuscite. Questo segue anche il formato di risposta di errore OData.
CloudErrorBody	Dettagli dell'errore.
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
minimalRiskLevel	Definisce il livello di rischio minimo del percorso di collegamento che verrà inviato come notifiche tramite posta elettronica
minimalSeverity
NotificationsByRole	Definisce se inviare notifiche tramite posta elettronica da Microsoft Defender for Cloud a persone con ruoli di controllo degli accessi in base al ruolo specifici nella sottoscrizione.
NotificationsSourceAlert	Origine delle notifiche di avviso
NotificationsSourceAttackPath	Origine di notifica del percorso di attacco
SecurityContact	Dettagli di contatto e configurazioni per le notifiche provenienti da Microsoft Defender for Cloud.
SecurityContactList	Elenco delle risposte ai contatti di sicurezza
securityContactRole	Definisce i ruoli controllo degli accessi in base al ruolo che riceveranno notifiche tramite posta elettronica da Microsoft Defender for Cloud. Elenco dei ruoli controllo degli accessi in base al ruolo consentiti:
state	Definisce se inviare notifiche tramite posta elettronica da AMicrosoft Defender for Cloud a persone con ruoli di controllo degli accessi in base al ruolo specifici nella sottoscrizione.

CloudError

Risposta di errore comune per tutte le API di Azure Resource Manager per restituire i dettagli dell'errore per le operazioni non riuscite. Questo segue anche il formato di risposta di errore OData.

Nome	Tipo	Descrizione
error.additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
error.code	string	Codice di errore.
error.details	CloudErrorBody[]	Dettagli dell'errore.
error.message	string	Messaggio di errore.
error.target	string	Destinazione dell'errore.

CloudErrorBody

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	CloudErrorBody[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorAdditionalInfo

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

minimalRiskLevel

Definisce il livello di rischio minimo del percorso di collegamento che verrà inviato come notifiche tramite posta elettronica

Nome	Tipo	Descrizione
Critical	string	Ottenere notifiche sui nuovi percorsi di attacco con livello di rischio critico
High	string	Ricevere notifiche sui nuovi percorsi di attacco con livello di rischio elevato o critico
Low	string	Ricevere notifiche sui nuovi percorsi di collegamento con livello di rischio basso, medio, alto o critico
Medium	string	Ricevere notifiche sui nuovi percorsi di collegamento con livello di rischio medio, alto o critico

minimalSeverity

Nome	Tipo	Descrizione
High	string	Ricevere notifiche sui nuovi avvisi con gravità elevata
Low	string	Ricevere notifiche sui nuovi avvisi con gravità bassa, media o alta
Medium	string	Ricevere notifiche sui nuovi avvisi con gravità media o alta

NotificationsByRole

Definisce se inviare notifiche tramite posta elettronica da Microsoft Defender for Cloud a persone con ruoli di controllo degli accessi in base al ruolo specifici nella sottoscrizione.

Nome	Tipo	Descrizione
roles	securityContactRole[]	Definisce i ruoli controllo degli accessi in base al ruolo che riceveranno notifiche tramite posta elettronica da Microsoft Defender for Cloud. Elenco dei ruoli controllo degli accessi in base al ruolo consentiti:
state	state	Definisce se inviare notifiche tramite posta elettronica da AMicrosoft Defender for Cloud a persone con ruoli di controllo degli accessi in base al ruolo specifici nella sottoscrizione.

NotificationsSourceAlert

Origine delle notifiche di avviso

Nome	Tipo	Descrizione
minimalSeverity	minimalSeverity
sourceType	string: Alert	Tipo di origine che attiverà la notifica

NotificationsSourceAttackPath

Origine di notifica del percorso di attacco

Nome	Tipo	Descrizione
minimalRiskLevel	minimalRiskLevel	Definisce il livello di rischio minimo del percorso di collegamento che verrà inviato come notifiche tramite posta elettronica
sourceType	string: AttackPath	Tipo di origine che attiverà la notifica