Security Contacts - Get

Serviço:

Defender for Cloud

Versão da API:

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 do URI

Name	Em	Necessário	Tipo	Description
securityContactName	path	True	SecurityContactName minLength: 7 maxLength: 7 pattern: ^(default)$	Nome do objeto de contato de segurança
subscriptionId	path	True	string (uuid)	O ID da assinatura de destino. O valor deve ser um UUID.
api-version	query	True	string minLength: 1	A versão da API a utilizar para esta operação.

Respostas

Name	Tipo	Description
200 OK	SecurityContact	Operação do Azure concluída com sucesso.
Other Status Codes	Common.CloudError	Uma resposta de erro inesperada.

Segurança

azure_auth

Azure Active Directory OAuth2 Flow.

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

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

Get a security contact

Pedido de amostra

HTTP

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

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: 2023-12-01-preview/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("20ff7fc3-e762-44dd-bd96-b71116dcdc23", 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 = armsecurity.ContactsClientGetResponse{
	// 	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.StateOn),
	// 			},
	// 			NotificationsSources: []armsecurity.NotificationsSourceClassification{
	// 				&armsecurity.NotificationsSourceAttackPath{
	// 					MinimalRiskLevel: to.Ptr(armsecurity.MinimalRiskLevelCritical),
	// 					SourceType: to.Ptr(armsecurity.SourceTypeAttackPath),
	// 				},
	// 				&armsecurity.NotificationsSourceAlert{
	// 					MinimalSeverity: to.Ptr(armsecurity.MinimalSeverityMedium),
	// 					SourceType: to.Ptr(armsecurity.SourceTypeAlert),
	// 				},
	// 			},
	// 			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 get Default Security contact configurations for the subscription
 *
 * @summary get Default Security contact configurations for the subscription
 * x-ms-original-file: 2023-12-01-preview/SecurityContacts/GetSecurityContact_example.json
 */
async function getASecurityContact() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "20ff7fc3-e762-44dd-bd96-b71116dcdc23";
  const client = new SecurityCenter(credential, subscriptionId);
  const result = await client.securityContacts.get("default");
  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

Resposta da amostra

Código de estado:

200

{
  "name": "default",
  "type": "Microsoft.Security/securityContacts",
  "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/securityContacts/default",
  "properties": {
    "emails": "john@contoso.com;jane@contoso.com",
    "isEnabled": true,
    "notificationsByRole": {
      "roles": [
        "Owner"
      ],
      "state": "On"
    },
    "notificationsSources": [
      {
        "minimalRiskLevel": "Critical",
        "sourceType": "AttackPath"
      },
      {
        "minimalSeverity": "Medium",
        "sourceType": "Alert"
      }
    ],
    "phone": "(214)275-4038"
  }
}

Definições

Name	Description
Common.CloudError	Resposta de erro comum para todas as APIs do Azure Resource Manager para retornar detalhes de erro para operações com falha. (Isso também segue o formato de resposta de erro OData.)
Common.CloudErrorBody	O detalhe do erro.
createdByType	O tipo de identidade que criou o recurso.
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
MinimalRiskLevel	Define o nível mínimo de risco do caminho de ataque que será enviado como notificações por email
MinimalSeverity	Define a severidade mínima do alerta que será enviada como notificações por e-mail
NotificationsSourceAlert	Fonte de notificação de alerta
NotificationsSourceAttackPath	Origem da notificação do caminho de ataque
SecurityContact	Detalhes de contato e configurações para notificações provenientes do Microsoft Defender para a Cloud.
SecurityContactName	Nome do objeto de contato de segurança
SecurityContactPropertiesNotificationsByRole	Define se as notificações por email do Microsoft Defender para a Cloud devem ser enviadas para pessoas com funções RBAC específicas na assinatura.
SecurityContactRole	Um possível papel para configurar o envio de alertas de notificação de segurança a
SourceType	O tipo de fonte que acionará a notificação
State	Define se as notificações por e-mail devem ser enviadas do AMicrosoft Defender para a Cloud para pessoas com funções RBAC específicas na assinatura.
systemData	Metadados referentes à criação e última modificação do recurso.

Common.CloudError

Object

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

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

Common.CloudErrorBody

Object

O detalhe do erro.

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

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

O erro de gerenciamento de recursos informações adicionais.

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

MinimalRiskLevel

Enumeração

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

Valor	Description
Critical	Receba notificações sobre novos caminhos de ataque com nível de risco crítico
High	Receba notificações sobre novos caminhos de ataque com nível de risco Alto ou Crítico
Medium	Receba notificações sobre novos caminhos anexados com nível de risco Médio, Alto ou Crítico
Low	Receba notificações sobre novos caminhos anexados com nível de risco Baixo, Médio, Alto ou Crítico

MinimalSeverity

Enumeração

Define a severidade mínima do alerta que será enviada como notificações por e-mail

Valor	Description
High	Receba notificações sobre novos alertas com alta severidade
Medium	Receba notificações sobre novos alertas com gravidade Média ou Alta
Low	Receba notificações sobre novos alertas com gravidade Baixa, Média ou Alta

NotificationsSourceAlert

Object

Fonte de notificação de alerta

Name	Tipo	Description
minimalSeverity	MinimalSeverity	Define a severidade mínima do alerta que será enviada como notificações por e-mail
sourceType	string: Alert	O tipo de fonte que acionará a notificação

NotificationsSourceAttackPath

Object

Origem da notificação do caminho de ataque

Name	Tipo	Description
minimalRiskLevel	MinimalRiskLevel	Define o nível mínimo de risco do caminho de anexação que será enviado como notificações por e-mail
sourceType	string: AttackPath	O tipo de fonte que acionará a notificação

SecurityContact

Object

Detalhes de contato e configurações para notificações provenientes do Microsoft Defender para a Cloud.

Name	Tipo	Description
id	string (arm-id)	ID de recurso totalmente qualificado para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	O nome do recurso
properties.emails	string	Lista de endereços de e-mail que receberão notificações do Microsoft Defender para a Cloud pelas configurações definidas neste contato de segurança.
properties.isEnabled	boolean	Indica se o contato de segurança está habilitado.
properties.notificationsByRole	SecurityContactPropertiesNotificationsByRole	Define se as notificações por email do Microsoft Defender para a Cloud devem ser enviadas 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 e-mail.
properties.phone	string	O número de telefone do contacto de segurança
systemData	systemData	Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy.
type	string	O tipo do recurso. Por exemplo, "Microsoft. Computação/Máquinas Virtuais" ou "Microsoft. ContasArmazenamento/Armazenamento"

SecurityContactName

Enumeração

Nome do objeto de contato de segurança

Valor	Description
default	O único nome aplicável do objeto de contato de segurança

SecurityContactPropertiesNotificationsByRole

Object

Define se as notificações por email do Microsoft Defender para a Cloud devem ser enviadas para pessoas com funções RBAC específicas na assinatura.

Name	Tipo	Description
roles	SecurityContactRole[]	Define quais funções RBAC receberão notificações por email do Microsoft Defender para a Cloud. Lista de funções RBAC permitidas:
state	State	Define se as notificações por e-mail devem ser enviadas do AMicrosoft Defender para a Cloud para pessoas com funções RBAC específicas na assinatura.

SecurityContactRole

Enumeração

Um possível papel para configurar o envio de alertas de notificação de segurança a

Valor	Description
AccountAdmin	Se habilitado, envie notificações sobre novos alertas para os administradores da conta
ServiceAdmin	Se habilitado, envie uma notificação sobre novos alertas para os administradores do serviço
Owner	Se habilitado, envie notificações sobre novos alertas para os proprietários da assinatura
Contributor	Se habilitado, envie uma notificação sobre novos alertas para os colaboradores da assinatura

SourceType

Enumeração

O tipo de fonte que acionará a notificação

Valor	Description
Alert	Alert
AttackPath	AttackPath

State

Enumeração

Define se as notificações por e-mail devem ser enviadas do AMicrosoft Defender para a Cloud para pessoas com funções RBAC específicas na assinatura.

Valor	Description
Passed	Todos os controlos de conformidade regulatória suportados na determinada norma têm um estado aprovado
Failed	Pelo menos um controlo de conformidade regulatória suportado na determinada norma encontra-se em estado de falha
Skipped	Todos os controlos de conformidade regulatória suportados na determinada norma têm um estado de ignorado
Unsupported	Não há dados de conformidade regulatória suportados para a norma em questão
On	Enviar notificação sobre novos alertas aos administradores da subscrição
Off	Não envie notificações sobre novos alertas aos administradores da subscrição

systemData

Object

Metadados referentes à criação e última modificação do recurso.

Name	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.