Security Contacts - Get

Referência

Service:: Defender for Cloud

API Version:: 2023-12-01-preview

Obter configurações de contato de segurança padrão para a assinatura

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description

Nome	Em	Obrigatório	Tipo	Description
securityContactName	path	True	securityContactName	Nome do objeto de contato de segurança Regex pattern: `^(default)$`
subscriptionId	path	True	string	ID de assinatura do Azure Regex pattern: `^[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

securityContactName

path

True

securityContactName

Nome do objeto de contato de segurança

Regex pattern: ^(default)$

subscriptionId

path

True

string

ID de assinatura do Azure

Regex pattern: ^[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	SecurityContact	OK
Other Status Codes	CloudError	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

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

Scopes

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

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

Definições

Nome	Description
CloudError	Resposta de erro comum para todas as APIs do Azure Resource Manager para retornar detalhes de erro de operações com falha. (Isso também segue o formato de resposta de erro OData.).
CloudErrorBody	Os detalhes do erro.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
minimalRiskLevel	Define o nível de risco mínimo do caminho de anexação que será enviado como notificações por email
minimalSeverity
NotificationsByRole	Define se é necessário enviar notificações por email do Microsoft Defender for Cloud para pessoas com funções RBAC específicas na assinatura.
NotificationsSourceAlert	Fonte de notificação de alerta
NotificationsSourceAttackPath	Origem da notificação do caminho de ataque
SecurityContact	Detalhes e configurações de contato para notificações provenientes do Microsoft Defender para Nuvem.
securityContactName	Nome do objeto de contato de segurança
securityContactRole	Define quais funções RBAC receberão notificações por email do Microsoft Defender for Cloud. Lista de funções RBAC permitidas:
state	Define se é necessário 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 para retornar detalhes de erro de 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

Os detalhes 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 de risco mínimo do caminho de anexação que será enviado como notificações por email

Nome	Tipo	Description
Critical	string	Obter notificações sobre novos caminhos de ataque com nível de risco crítico
High	string	Obter notificações sobre novos caminhos de ataque com nível de risco alto ou crítico
Low	string	Obter notificações sobre novos caminhos de anexação com nível de risco Baixo, Médio, Alto ou Crítico
Medium	string	Obter notificações sobre 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 sobre novos alertas com Alta gravidade
Low	string	Obter notificações sobre novos alertas com severidade baixa, média ou alta
Medium	string	Obter notificações sobre novos alertas com severidade média ou alta

NotificationsByRole

Define se é necessário enviar notificações por email do Microsoft Defender for Cloud 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 for Cloud. Lista de funções RBAC permitidas:
state	state	Define se é necessário enviar notificações por email do AMicrosoft Defender para Nuvem para pessoas com funções RBAC específicas na assinatura.

NotificationsSourceAlert

Fonte de 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 de risco mínimo 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