Security Contacts - Get

참조

Service:: Defender for Cloud

API Version:: 2020-01-01-preview

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

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

URI 매개 변수

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

Name	In(다음 안에)	필수	형식	Description
securityContactName	path	True	string	보안 연락처 개체의 이름
subscriptionId	path	True	string	Azure 구독 ID입니다. 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

string

보안 연락처 개체의 이름

subscriptionId

path

True

string

Azure 구독 ID입니다.

Regex pattern: ^[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

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

Scopes

Name	Description
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=2020-01-01-preview

/** Samples for SecurityContacts Get. */
public final class Main {
    /*
     * x-ms-original-file: specification/security/resource-manager/Microsoft.Security/preview/2020-01-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("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/e716082ac474f182e2220e4f38f1d6191e7636cf/specification/security/resource-manager/Microsoft.Security/preview/2020-01-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, "default", 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{
	// 		AlertNotifications: &armsecurity.ContactPropertiesAlertNotifications{
	// 			MinimalSeverity: to.Ptr(armsecurity.MinimalSeverityLow),
	// 			State: to.Ptr(armsecurity.State("On")),
	// 		},
	// 		Emails: to.Ptr("john@contoso.com;jane@contoso.com"),
	// 		NotificationsByRole: &armsecurity.ContactPropertiesNotificationsByRole{
	// 			Roles: []*armsecurity.Roles{
	// 				to.Ptr(armsecurity.RolesOwner)},
	// 				State: to.Ptr(armsecurity.State("On")),
	// 			},
	// 			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/2020-01-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

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.SecurityCenter;
using Azure.ResourceManager.SecurityCenter.Models;

// Generated from example definition: specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/examples/SecurityContacts/GetSecurityContact_example.json
// this example is just showing the usage of "SecurityContacts_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "20ff7fc3-e762-44dd-bd96-b71116dcdc23";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// get the collection of this SecurityContactResource
SecurityContactCollection collection = subscriptionResource.GetSecurityContacts();

// invoke the operation
string securityContactName = "default";
NullableResponse<SecurityContactResource> response = await collection.GetIfExistsAsync(securityContactName);
SecurityContactResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine($"Succeeded with null as result");
}
else
{
    // the variable result is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    SecurityContactData resourceData = result.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

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"
      ]
    },
    "emails": "john@contoso.com;jane@contoso.com",
    "phone": "(214)275-4038",
    "alertNotifications": {
      "state": "On",
      "minimalSeverity": "Low"
    }
  }
}

정의

Name	Description
AlertNotifications	새 보안 경고에 대한 메일 알림 보낼지 여부를 정의합니다.
CloudError	실패한 작업에 대한 오류 세부 정보를 반환하는 모든 Azure Resource Manager API에 대한 일반적인 오류 응답입니다. OData 오류 응답 형식도 따릅니다.
CloudErrorBody	오류 세부 정보입니다.
ErrorAdditionalInfo	리소스 관리 오류 추가 정보입니다.
minimalSeverity	메일 알림 전송될 최소 경고 심각도를 정의합니다.
NotificationsByRole	클라우드용 Microsoft Defender 구독에 특정 RBAC 역할이 있는 사용자에게 메일 알림 보낼지 여부를 정의합니다.
roles	클라우드용 Microsoft Defender 메일 알림 가져올 RBAC 역할을 정의합니다. 허용되는 RBAC 역할 목록:
SecurityContact	클라우드용 Microsoft Defender 제공되는 알림에 대한 연락처 세부 정보 및 구성입니다.
state	새 보안 경고에 대해 메일 알림 전송되는지를 정의합니다.

AlertNotifications

새 보안 경고에 대한 메일 알림 보낼지 여부를 정의합니다.

Name	형식	Description
minimalSeverity	minimalSeverity	메일 알림 전송될 최소 경고 심각도를 정의합니다.
state	state	새 보안 경고에 대해 메일 알림 전송되는지를 정의합니다.

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	추가 정보 유형입니다.

minimalSeverity

메일 알림 전송될 최소 경고 심각도를 정의합니다.

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

NotificationsByRole

클라우드용 Microsoft Defender 구독에 특정 RBAC 역할이 있는 사용자에게 메일 알림 보낼지 여부를 정의합니다.

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

roles

클라우드용 Microsoft Defender 메일 알림 가져올 RBAC 역할을 정의합니다. 허용되는 RBAC 역할 목록:

Name	형식	Description
AccountAdmin	string	사용하도록 설정된 경우 계정 관리자에게 새 경고에 대한 알림을 보냅니다.
Contributor	string	사용하도록 설정된 경우 구독 기여자에게 새 경고에 대한 알림을 보냅니다.
Owner	string	사용하도록 설정된 경우 구독 소유자에게 새 경고에 대한 알림을 보냅니다.
ServiceAdmin	string	사용하도록 설정된 경우 서비스 관리자에게 새 경고에 대한 알림을 보냅니다.