Security Contacts - Get

Ссылка

Service:: Defender for Cloud

API Version:: 2023-12-01-preview

Получение конфигураций контактов по безопасности по умолчанию для подписки

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

Параметры URI

Имя В Обязательно Тип Описание

Имя	В	Обязательно	Тип	Описание
securityContactName	path	True	securityContactName	Имя объекта контакта по безопасности Regex pattern: `^(default)$`
subscriptionId	path	True	string	Идентификатор подписки Azure. Regex pattern: `^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$`
api-version	query	True	string	Версия API для операции

securityContactName

path

True

securityContactName

Имя объекта контакта по безопасности

Regex pattern: ^(default)$

subscriptionId

path

True

string

Идентификатор подписки Azure.

Regex pattern: ^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$

api-version

query

True

string

Версия API для операции

Ответы

Имя	Тип	Описание
200 OK	SecurityContact	ОК
Other Status Codes	CloudError	Ответ об ошибке, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory

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

Scopes

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

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

Определения

Имя	Описание
CloudError	Общие ответы об ошибках для всех API Azure Resource Manager, возвращающие сведения об ошибке для неудачных операций. (Он также соответствует формату ответа об ошибке OData.)
CloudErrorBody	Сведения об ошибке.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
minimalRiskLevel	Определяет минимальный уровень риска пути присоединения, который будет отправлен как Уведомления по электронной почте
minimalSeverity
NotificationsByRole	Определяет, следует ли отправлять Уведомления по электронной почте из Microsoft Defender для облака пользователям с определенными ролями RBAC в подписке.
NotificationsSourceAlert	Источник оповещений
NotificationsSourceAttackPath	Источник уведомлений о пути атаки
SecurityContact	Контактные данные и конфигурации уведомлений, поступающих от Microsoft Defender для облака.
securityContactName	Имя объекта контакта по безопасности
securityContactRole	Определяет, какие роли RBAC будут получать Уведомления по электронной почте из Microsoft Defender для облака. Список разрешенных ролей RBAC:
state	Определяет, следует ли отправлять Уведомления по электронной почте из AMicrosoft Defender для облака пользователям с определенными ролями RBAC в подписке.

CloudError

Общие ответы об ошибках для всех API Azure Resource Manager, возвращающие сведения об ошибке для неудачных операций. (Он также соответствует формату ответа об ошибке OData.)

Имя	Тип	Описание
error.additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
error.code	string	Код ошибки.
error.details	CloudErrorBody[]	Сведения об ошибке.
error.message	string	Сообщение об ошибке.
error.target	string	Целевой объект ошибки.

CloudErrorBody

Сведения об ошибке.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	CloudErrorBody[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Тип дополнительных сведений.

minimalRiskLevel

Определяет минимальный уровень риска пути присоединения, который будет отправлен как Уведомления по электронной почте

Имя	Тип	Описание
Critical	string	Получение уведомлений о новых путях атаки с уровнем критического риска
High	string	Получение уведомлений о новых путях атаки с высоким или критическим уровнем риска
Low	string	Получение уведомлений о новых путях присоединения с низким, средним, высоким или критическим уровнем риска
Medium	string	Получение уведомлений о новых путях присоединения со средним, высоким или критическим уровнем риска

minimalSeverity

Имя	Тип	Описание
High	string	Получение уведомлений о новых оповещениях с высоким уровнем серьезности
Low	string	Получение уведомлений о новых оповещениях с низким, средним или высоким уровнем серьезности
Medium	string	Получение уведомлений о новых оповещениях со средним или высоким уровнем серьезности

NotificationsByRole

Определяет, следует ли отправлять Уведомления по электронной почте из Microsoft Defender для облака пользователям с определенными ролями RBAC в подписке.

Имя	Тип	Описание
roles	securityContactRole[]	Определяет, какие роли RBAC будут получать Уведомления по электронной почте из Microsoft Defender для облака. Список разрешенных ролей RBAC:
state	state	Определяет, следует ли отправлять Уведомления по электронной почте из AMicrosoft Defender для облака пользователям с определенными ролями RBAC в подписке.

NotificationsSourceAlert

Источник оповещений

Имя	Тип	Описание
minimalSeverity	minimalSeverity
sourceType	string: Alert	Тип источника, который активирует уведомление.

NotificationsSourceAttackPath

Источник уведомлений о пути атаки

Имя	Тип	Описание
minimalRiskLevel	minimalRiskLevel	Определяет минимальный уровень риска пути присоединения, который будет отправлен как Уведомления по электронной почте
sourceType	string: AttackPath	Тип источника, который активирует уведомление.