Security Contacts - List

Referencia

Servicio:: Defender for Cloud

Versión de la API:: 2023-12-01-preview

Enumerar todas las configuraciones de contacto de seguridad de la suscripción

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
subscriptionId	path	True	string pattern: ^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$	Identificador de suscripción de Azure
api-version	query	True	string	Versión de API para la operación

Respuestas

Nombre	Tipo	Description
200 OK	SecurityContactList	De acuerdo
Other Status Codes	CloudError	Respuesta de error que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

List security contact data

Solicitud de ejemplo

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

Respuesta de muestra

status code:: 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"
          }
        ]
      }
    }
  ]
}

Definiciones

Nombre	Description
CloudError	Respuesta de error común para todas las API de Azure Resource Manager para devolver los detalles de error de las operaciones con errores. (Esto también sigue el formato de respuesta de error de OData).
CloudErrorBody	Detalle del error.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
minimalRiskLevel	Define el nivel de riesgo mínimo de la ruta de acceso de asociación que se enviará como notificaciones por correo electrónico.
minimalSeverity
NotificationsByRole	Define si se envían notificaciones por correo electrónico de Microsoft Defender for Cloud a personas con roles de RBAC específicos en la suscripción.
NotificationsSourceAlert	Origen de notificación de alerta
NotificationsSourceAttackPath	Origen de notificación de ruta de acceso de ataque
SecurityContact	Detalles de contacto y configuraciones para las notificaciones procedentes de Microsoft Defender for Cloud.
SecurityContactList	Lista de respuestas de contactos de seguridad
securityContactRole	Define qué roles de RBAC recibirán notificaciones por correo electrónico de Microsoft Defender for Cloud. Lista de roles RBAC permitidos:
state	Define si se envían notificaciones por correo electrónico de AMicrosoft Defender for Cloud a personas con roles de RBAC específicos en la suscripción.

CloudError

Object

Respuesta de error común para todas las API de Azure Resource Manager para devolver los detalles de error de las operaciones con errores. (Esto también sigue el formato de respuesta de error de OData).

Nombre	Tipo	Description
error.additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
error.code	string	Código de error.
error.details	CloudErrorBody[]	Detalles del error.
error.message	string	Mensaje de error.
error.target	string	Destino del error.

CloudErrorBody

Object

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	CloudErrorBody[]	Detalles del error.
message	string	Mensaje de error.
target	string	Destino del error.

ErrorAdditionalInfo

Object

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

minimalRiskLevel

Enumeración

Define el nivel de riesgo mínimo de la ruta de acceso de asociación que se enviará como notificaciones por correo electrónico.

Valor	Description
Critical	Obtención de notificaciones en nuevas rutas de acceso de ataque con nivel de riesgo crítico
High	Obtención de notificaciones en nuevas rutas de acceso de ataque con nivel de riesgo alto o crítico
Low	Obtención de notificaciones en nuevas rutas de acceso de asociación con el nivel de riesgo Bajo, Medio, Alto o Crítico
Medium	Obtención de notificaciones en nuevas rutas de acceso de asociación con nivel de riesgo medio, alto o crítico

minimalSeverity

Enumeración

Valor	Description
High	Obtención de notificaciones sobre nuevas alertas con gravedad alta
Low	Obtención de notificaciones sobre nuevas alertas con gravedad baja, media o alta
Medium	Obtención de notificaciones sobre nuevas alertas con gravedad media o alta

NotificationsByRole

Object

Define si se envían notificaciones por correo electrónico de Microsoft Defender for Cloud a personas con roles de RBAC específicos en la suscripción.

Nombre	Tipo	Description
roles	securityContactRole[]	Define qué roles de RBAC recibirán notificaciones por correo electrónico de Microsoft Defender for Cloud. Lista de roles RBAC permitidos:
state	state	Define si se envían notificaciones por correo electrónico de AMicrosoft Defender for Cloud a personas con roles de RBAC específicos en la suscripción.

NotificationsSourceAlert

Object

Origen de notificación de alerta

Nombre	Tipo	Description
minimalSeverity	minimalSeverity
sourceType	string: Alert	Tipo de origen que desencadenará la notificación.

NotificationsSourceAttackPath

Object

Origen de notificación de ruta de acceso de ataque

Nombre	Tipo	Description
minimalRiskLevel	minimalRiskLevel	Define el nivel de riesgo mínimo de la ruta de acceso de asociación que se enviará como notificaciones por correo electrónico.
sourceType	string: AttackPath	Tipo de origen que desencadenará la notificación.