Security Contacts - Get

참조

서비스:: Defender for Cloud

API 버전:: 2023-12-01-preview

구독에 대한 기본 보안 연락처 구성 가져오기

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

URI 매개 변수

Name In(다음 안에) 필수 형식 Description

Name	In(다음 안에)	필수	형식	Description
securityContactName	path	True	securityContactName	보안 연락처 개체의 이름 regex 패턴: `^(default)$`
subscriptionId	path	True	string	Azure 구독 ID regex 패턴: `^[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 패턴: ^(default)$

subscriptionId

path

True

string

Azure 구독 ID

regex 패턴: ^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$

api-version

query

True

string

작업에 대한 API 버전

응답

Name	형식	Description
200 OK	SecurityContact	그래
Other Status Codes	CloudError	작업이 실패한 이유를 설명하는 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 Flow

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name	Description
user_impersonation	사용자 계정 가장

예제

Get a security contact

샘플 요청

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

샘플 응답

상태 코드:: 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"
      }
    ]
  }
}

정의

Name	Description
CloudError	실패한 작업에 대한 오류 세부 정보를 반환하는 모든 Azure Resource Manager API에 대한 일반적인 오류 응답입니다. 또한 OData 오류 응답 형식을 따릅니다.
CloudErrorBody	오류 세부 정보입니다.
ErrorAdditionalInfo	리소스 관리 오류 추가 정보입니다.
minimalRiskLevel	이메일 알림으로 전송될 최소 연결 경로 위험 수준을 정의합니다.
minimalSeverity
NotificationsByRole	Microsoft Defender for Cloud에서 구독의 특정 RBAC 역할을 가진 사람에게 전자 메일 알림을 보낼지 여부를 정의합니다.
NotificationsSourceAlert	경고 알림 원본
NotificationsSourceAttackPath	공격 경로 알림 원본
SecurityContact	클라우드용 Microsoft Defender에서 제공되는 알림에 대한 연락처 세부 정보 및 구성입니다.
securityContactName	보안 연락처 개체의 이름
securityContactRole	클라우드용 Microsoft Defender에서 전자 메일 알림을 받을 RBAC 역할을 정의합니다. 허용되는 RBAC 역할 목록:
state	AMicrosoft Defender for Cloud에서 구독의 특정 RBAC 역할을 가진 사람에게 전자 메일 알림을 보낼지 여부를 정의합니다.

CloudError

실패한 작업에 대한 오류 세부 정보를 반환하는 모든 Azure Resource Manager API에 대한 일반적인 오류 응답입니다. 또한 OData 오류 응답 형식을 따릅니다.

Name	형식	Description
error.additionalInfo	ErrorAdditionalInfo[]	오류 추가 정보입니다.
error.code	string	오류 코드입니다.
error.details	CloudErrorBody[]	오류 세부 정보입니다.
error.message	string	오류 메시지입니다.
error.target	string	오류 대상입니다.

CloudErrorBody

오류 세부 정보입니다.

Name	형식	Description
additionalInfo	ErrorAdditionalInfo[]	오류 추가 정보입니다.
code	string	오류 코드입니다.
details	CloudErrorBody[]	오류 세부 정보입니다.
message	string	오류 메시지입니다.
target	string	오류 대상입니다.

ErrorAdditionalInfo

리소스 관리 오류 추가 정보입니다.

Name	형식	Description
info	object	추가 정보입니다.
type	string	추가 정보 유형입니다.

minimalRiskLevel

이메일 알림으로 전송될 최소 연결 경로 위험 수준을 정의합니다.

Name	형식	Description
Critical	string	위험 수준이 중요한 새 공격 경로에 대한 알림 받기
High	string	위험 수준이 높거나 위험 수준이 높은 새 공격 경로에 대한 알림 받기
Low	string	낮음, 중간, 높음 또는 위험 수준이 있는 새 연결 경로에 대한 알림 받기
Medium	string	중간, 높음 또는 위험 수준이 있는 새 연결 경로에 대한 알림 받기

minimalSeverity

Name	형식	Description
High	string	심각도가 높은 새 경고에 대한 알림 받기
Low	string	심각도가 낮음, 중간 또는 높음인 새 경고에 대한 알림 받기
Medium	string	심각도가 중간 또는 높음인 새 경고에 대한 알림 받기

NotificationsByRole

Microsoft Defender for Cloud에서 구독의 특정 RBAC 역할을 가진 사람에게 전자 메일 알림을 보낼지 여부를 정의합니다.

Name	형식	Description
roles	securityContactRole[]	클라우드용 Microsoft Defender에서 전자 메일 알림을 받을 RBAC 역할을 정의합니다. 허용되는 RBAC 역할 목록:
state	state	AMicrosoft Defender for Cloud에서 구독의 특정 RBAC 역할을 가진 사람에게 전자 메일 알림을 보낼지 여부를 정의합니다.

NotificationsSourceAlert

경고 알림 원본

Name	형식	Description
minimalSeverity	minimalSeverity
sourceType	string: Alert	알림을 트리거할 원본 유형입니다.

NotificationsSourceAttackPath

공격 경로 알림 원본

Name	형식	Description
minimalRiskLevel	minimalRiskLevel	이메일 알림으로 전송될 최소 연결 경로 위험 수준을 정의합니다.
sourceType	string: AttackPath	알림을 트리거할 원본 유형입니다.