Security Contacts - Create

Başvuru

Service:: Defender for Cloud

API Version:: 2023-12-01-preview

Abonelik için güvenlik kişisi yapılandırmalarını İçerik Oluşturucu

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

URI Parametreleri

Name İçinde Gerekli Tür Description

Name	İçinde	Gerekli	Tür	Description
securityContactName	path	True	securityContactName	Güvenlik kişisi nesnesinin adı Regex pattern: `^(default)$`
subscriptionId	path	True	string	Azure abonelik kimliği Regex pattern: `^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$`
api-version	query	True	string	İşlem için API sürümü

securityContactName

path

True

securityContactName

Güvenlik kişisi nesnesinin adı

Regex pattern: ^(default)$

subscriptionId

path

True

string

Azure abonelik kimliği

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

api-version

query

True

string

İşlem için API sürümü

İstek Gövdesi

Name	Tür	Description
properties.emails	string	Bu güvenlik kişisinde tanımlanan yapılandırmalar tarafından Bulut için Microsoft Defender bildirim alacak e-posta adreslerinin listesi.
properties.isEnabled	boolean	Güvenlik kişisinin etkin olup olmadığını gösterir.
properties.notificationsByRole	NotificationsByRole	Bulut için Microsoft Defender'dan abonelikte belirli RBAC rollerine sahip kişilere e-posta bildirimleri gönderip göndermeyeceğini tanımlar.
properties.notificationsSources	NotificationsSource[]: NotificationsSourceAlert[] NotificationsSourceAttackPath[]	E-posta bildirimini değerlendiren kaynak türleri koleksiyonu.
properties.phone	string	Güvenlik kişisinin telefon numarası

Yanıtlar

Name	Tür	Description
200 OK	SecurityContact	Tamam
201 Created	SecurityContact	Oluşturulan
Other Status Codes	CloudError	İşlemin neden başarısız olduğunu açıklayan hata yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name	Description
user_impersonation	kullanıcı hesabınızın kimliğine bürünme

Örnekler

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

Tanımlar

Name	Description
CloudError	Başarısız işlemlerin hata ayrıntılarını döndürmek için tüm Azure Resource Manager API'leri için genel hata yanıtı. (Bu, OData hata yanıtı biçimini de izler.).
CloudErrorBody	Hata ayrıntısı.
ErrorAdditionalInfo	Kaynak yönetimi hatası ek bilgileri.
minimalRiskLevel	E-posta bildirimleri olarak gönderilecek en düşük ekleme yolu risk düzeyini tanımlar
minimalSeverity
NotificationsByRole	Bulut için Microsoft Defender'dan abonelikte belirli RBAC rollerine sahip kişilere e-posta bildirimleri gönderip göndermeyeceğini tanımlar.
NotificationsSourceAlert	Uyarı bildirim kaynağı
NotificationsSourceAttackPath	Saldırı yolu bildirim kaynağı
SecurityContact	Bulut için Microsoft Defender gelen bildirimler için iletişim ayrıntıları ve yapılandırmaları.
securityContactName	Güvenlik kişisi nesnesinin adı
securityContactRole	Bulut için Microsoft Defender hangi RBAC rollerinin e-posta bildirimleri alacağını tanımlar. İzin verilen RBAC rollerinin listesi:
state	Abonelikte belirli RBAC rollerine sahip kişilere Bulut için AMicrosoft Defender'dan e-posta bildirimleri gönderip göndermeyeceğini tanımlar.

CloudError

Başarısız işlemlerin hata ayrıntılarını döndürmek için tüm Azure Resource Manager API'leri için genel hata yanıtı. (Bu, OData hata yanıtı biçimini de izler.).

Name	Tür	Description
error.additionalInfo	ErrorAdditionalInfo[]	Hata ek bilgileri.
error.code	string	Hata kodu.
error.details	CloudErrorBody[]	Hata ayrıntıları.
error.message	string	Hata iletisi.
error.target	string	Hata hedefi.

CloudErrorBody

Hata ayrıntısı.

Name	Tür	Description
additionalInfo	ErrorAdditionalInfo[]	Hata ek bilgileri.
code	string	Hata kodu.
details	CloudErrorBody[]	Hata ayrıntıları.
message	string	Hata iletisi.
target	string	Hata hedefi.

ErrorAdditionalInfo

Kaynak yönetimi hatası ek bilgileri.

Name	Tür	Description
info	object	Ek bilgiler.
type	string	Ek bilgi türü.

minimalRiskLevel

E-posta bildirimleri olarak gönderilecek en düşük ekleme yolu risk düzeyini tanımlar

Name	Tür	Description
Critical	string	Kritik risk düzeyine sahip yeni saldırı yollarıyla ilgili bildirimler alma
High	string	Yüksek veya Kritik risk düzeyine sahip yeni saldırı yollarıyla ilgili bildirimler alma
Low	string	Düşük, Orta, Yüksek veya Kritik risk düzeyine sahip yeni ekleme yollarında bildirim alma
Medium	string	Orta, Yüksek veya Kritik risk düzeyine sahip yeni ekleme yollarında bildirim alma

minimalSeverity

Name	Tür	Description
High	string	Yüksek önem derecesinde yeni uyarılarda bildirim alma
Low	string	Düşük, Orta veya Yüksek önem derecelerine sahip yeni uyarılarda bildirim alma
Medium	string	Orta veya Yüksek önem derecesiyle yeni uyarılarda bildirim alma

NotificationsByRole

Bulut için Microsoft Defender'dan abonelikte belirli RBAC rollerine sahip kişilere e-posta bildirimleri gönderip göndermeyeceğini tanımlar.

Name	Tür	Description
roles	securityContactRole[]	Bulut için Microsoft Defender hangi RBAC rollerinin e-posta bildirimleri alacağını tanımlar. İzin verilen RBAC rollerinin listesi:
state	state	Abonelikte belirli RBAC rollerine sahip kişilere Bulut için AMicrosoft Defender'dan e-posta bildirimleri gönderip göndermeyeceğini tanımlar.

NotificationsSourceAlert

Uyarı bildirim kaynağı

Name	Tür	Description
minimalSeverity	minimalSeverity
sourceType	string: Alert	Bildirimi tetikleyecek kaynak türü

NotificationsSourceAttackPath

Saldırı yolu bildirim kaynağı

Name	Tür	Description
minimalRiskLevel	minimalRiskLevel	E-posta bildirimleri olarak gönderilecek en düşük ekleme yolu risk düzeyini tanımlar
sourceType	string: AttackPath	Bildirimi tetikleyecek kaynak türü