Security Contacts - List

Serviço:

Defender for Cloud

Versão da API:

2023-12-01-preview

Listar todas as configurações de contato de segurança para a assinatura

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
subscriptionId	path	True	string	ID da assinatura do Azure Padrão Regex: ^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$
api-version	query	True	string	Versão da API para a operação

Respostas

Nome	Tipo	Description
200 OK	SecurityContactList	OKEY
Other Status Codes	CloudError	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

List security contact data

Solicitação de exemplo

HTTP

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

Java

/**
 * 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

Go

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

JavaScript

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

Resposta de exemplo

Código de status:

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

Definições

Nome	Description
CloudError	Resposta de erro comum para todas as APIs do Azure Resource Manager retornarem detalhes de erro para operações com falha. (Isso também segue o formato de resposta de erro OData.).
CloudErrorBody	O detalhe do erro.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
minimalRiskLevel	Define o nível mínimo de risco do caminho de anexação que será enviado como notificações por email
minimalSeverity
NotificationsByRole	Define se enviar notificações por email do Microsoft Defender para Nuvem para pessoas com funções RBAC específicas na assinatura.
NotificationsSourceAlert	Origem da notificação de alerta
NotificationsSourceAttackPath	Origem da notificação do caminho de ataque
SecurityContact	Contate detalhes e configurações para notificações provenientes do Microsoft Defender para Nuvem.
SecurityContactList	Lista de resposta de contatos de segurança
securityContactRole	Define quais funções RBAC receberão notificações por email do Microsoft Defender para Nuvem. Lista de funções RBAC permitidas:
state	Define se enviar notificações por email do AMicrosoft Defender para Nuvem para pessoas com funções RBAC específicas na assinatura.

CloudError

Resposta de erro comum para todas as APIs do Azure Resource Manager retornarem detalhes de erro para operações com falha. (Isso também segue o formato de resposta de erro OData.).

Nome	Tipo	Description
error.additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
error.code	string	O código de erro.
error.details	CloudErrorBody[]	Os detalhes do erro.
error.message	string	A mensagem de erro.
error.target	string	O destino do erro.

CloudErrorBody

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	CloudErrorBody[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

minimalRiskLevel

Define o nível mínimo de risco do caminho de anexação que será enviado como notificações por email

Nome	Tipo	Description
Critical	string	Obter notificações em novos caminhos de ataque com nível de risco crítico
High	string	Obter notificações em novos caminhos de ataque com nível de risco alto ou crítico
Low	string	Obter notificações em novos caminhos de anexação com nível de risco Baixo, Médio, Alto ou Crítico
Medium	string	Obter notificações em novos caminhos de anexação com nível de risco Médio, Alto ou Crítico

minimalSeverity

Nome	Tipo	Description
High	string	Obter notificações em novos alertas com alta gravidade
Low	string	Obter notificações em novos alertas com gravidade baixa, média ou alta
Medium	string	Obter notificações em novos alertas com severidade média ou alta

NotificationsByRole

Define se enviar notificações por email do Microsoft Defender para Nuvem para pessoas com funções RBAC específicas na assinatura.

Nome	Tipo	Description
roles	securityContactRole[]	Define quais funções RBAC receberão notificações por email do Microsoft Defender para Nuvem. Lista de funções RBAC permitidas:
state	state	Define se enviar notificações por email do AMicrosoft Defender para Nuvem para pessoas com funções RBAC específicas na assinatura.

NotificationsSourceAlert

Origem da notificação de alerta

Nome	Tipo	Description
minimalSeverity	minimalSeverity
sourceType	string: Alert	O tipo de origem que disparará a notificação

NotificationsSourceAttackPath

Origem da notificação do caminho de ataque

Nome	Tipo	Description
minimalRiskLevel	minimalRiskLevel	Define o nível mínimo de risco do caminho de anexação que será enviado como notificações por email
sourceType	string: AttackPath	O tipo de origem que disparará a notificação

SecurityContact

Contate detalhes e configurações para notificações provenientes do Microsoft Defender para Nuvem.

Nome	Tipo	Description
id	string	ID do recurso
name	string	Nome do recurso
properties.emails	string	Lista de endereços de email que receberão notificações do Microsoft Defender para Nuvem pelas configurações definidas neste contato de segurança.
properties.isEnabled	boolean	Indica se o contato de segurança está habilitado.
properties.notificationsByRole	NotificationsByRole	Define se enviar notificações por email do Microsoft Defender para Nuvem para pessoas com funções RBAC específicas na assinatura.
properties.notificationsSources	NotificationsSource[]: NotificationsSourceAlert[] NotificationsSourceAttackPath[]	Uma coleção de tipos de fontes que avaliam a notificação por email.
properties.phone	string	O número de telefone do contato de segurança
type	string	Tipo de recurso

SecurityContactList

Lista de resposta de contatos de segurança

Nome	Tipo	Description
nextLink	string	O URI a ser buscado na próxima página.
value	SecurityContact[]	Lista de contatos de segurança

securityContactRole

Define quais funções RBAC receberão notificações por email do Microsoft Defender para Nuvem. Lista de funções RBAC permitidas:

Nome	Tipo	Description
AccountAdmin	string	Se habilitado, envie a notificação em novos alertas para os administradores da conta
Contributor	string	Se habilitado, envie a notificação em novos alertas para os colaboradores da assinatura
Owner	string	Se habilitado, envie a notificação em novos alertas para os proprietários da assinatura
ServiceAdmin	string	Se habilitado, envie a notificação em novos alertas para os administradores de serviço

state

Define se enviar notificações por email do AMicrosoft Defender para Nuvem para pessoas com funções RBAC específicas na assinatura.

Nome	Tipo	Description
Off	string	Não envie notificação sobre novos alertas para os administradores da assinatura
On	string	Enviar notificação em novos alertas para os administradores da assinatura