Security Contacts - Create

Ссылка

Service:: Defender for Cloud

API Version:: 2023-12-01-preview

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

PUT 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 для операции

Текст запроса

Имя	Тип	Описание
properties.emails	string	Список адресов электронной почты, которые будут получать уведомления от Microsoft Defender для облака в соответствии с конфигурациями, определенными в этом контакте по вопросам безопасности.
properties.isEnabled	boolean	Указывает, включен ли контакт безопасности.
properties.notificationsByRole	NotificationsByRole	Определяет, следует ли отправлять Уведомления по электронной почте из Microsoft Defender for Cloud пользователям с определенными ролями RBAC в подписке.
properties.notificationsSources	NotificationsSource[]: NotificationsSourceAlert[] NotificationsSourceAttackPath[]	Коллекция типов источников, которые оценивают уведомление по электронной почте.
properties.phone	string	Номер телефона контактного лица по безопасности

Ответы

Имя	Тип	Описание
200 OK	SecurityContact	ОК
201 Created	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	олицетворения учетной записи пользователя

Примеры

Create security contact data

Sample Request

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

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


import com.azure.resourcemanager.security.models.MinimalRiskLevel;
import com.azure.resourcemanager.security.models.MinimalSeverity;
import com.azure.resourcemanager.security.models.NotificationsSourceAlert;
import com.azure.resourcemanager.security.models.NotificationsSourceAttackPath;
import com.azure.resourcemanager.security.models.SecurityContactName;
import com.azure.resourcemanager.security.models.SecurityContactPropertiesNotificationsByRole;
import com.azure.resourcemanager.security.models.SecurityContactRole;
import com.azure.resourcemanager.security.models.State;
import java.util.Arrays;

/**
 * Samples for SecurityContacts Create.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/security/resource-manager/Microsoft.Security/preview/2023-12-01-preview/examples/SecurityContacts/
     * CreateSecurityContact_example.json
     */
    /**
     * Sample code: Create security contact data.
     * 
     * @param manager Entry point to SecurityManager.
     */
    public static void createSecurityContactData(com.azure.resourcemanager.security.SecurityManager manager) {
        manager.securityContacts().define(SecurityContactName.DEFAULT).withEmails("john@contoso.com;jane@contoso.com")
            .withPhone("(214)275-4038").withIsEnabled(true)
            .withNotificationsSources(
                Arrays.asList(new NotificationsSourceAttackPath().withMinimalRiskLevel(MinimalRiskLevel.CRITICAL),
                    new NotificationsSourceAlert().withMinimalSeverity(MinimalSeverity.MEDIUM)))
            .withNotificationsByRole(new SecurityContactPropertiesNotificationsByRole()
                .withState(State.fromString("On")).withRoles(Arrays.asList(SecurityContactRole.OWNER)))
            .create();
    }
}

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/azcore/to"
	"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/CreateSecurityContact_example.json
func ExampleContactsClient_Create() {
	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().Create(ctx, armsecurity.SecurityContactNameDefault, armsecurity.Contact{
		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"),
		},
	}, 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/securityContact"),
	// 	ID: to.Ptr("/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/securityContacts/default"),
	// 	Properties: &armsecurity.ContactProperties{
	// 		Emails: to.Ptr("john@microsoft.com;jane@microsoft.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 Create security contact configurations for the subscription
 *
 * @summary Create security contact configurations for the subscription
 * x-ms-original-file: specification/security/resource-manager/Microsoft.Security/preview/2023-12-01-preview/examples/SecurityContacts/CreateSecurityContact_example.json
 */
async function createSecurityContactData() {
  const subscriptionId =
    process.env["SECURITY_SUBSCRIPTION_ID"] || "20ff7fc3-e762-44dd-bd96-b71116dcdc23";
  const securityContactName = "default";
  const securityContact = {
    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",
  };
  const credential = new DefaultAzureCredential();
  const client = new SecurityCenter(credential, subscriptionId);
  const result = await client.securityContacts.create(securityContactName, securityContact);
  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:: 201

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

Status code:: 200

{
  "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/securityContacts/default",
  "name": "default",
  "type": "Microsoft.Security/securityContact",
  "properties": {
    "notificationsByRole": {
      "state": "On",
      "roles": [
        "Owner"
      ]
    },
    "isEnabled": true,
    "emails": "john@microsoft.com;jane@microsoft.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 for Cloud пользователям с определенными ролями 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 for Cloud пользователям с определенными ролями RBAC в подписке.

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

NotificationsSourceAlert

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

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

NotificationsSourceAttackPath

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

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