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 パラメーター

名前	/	必須	型	説明
securityContactName	path	True	securityContactName	セキュリティ連絡先オブジェクトの名前 正規表現パターン: ^(default)$
subscriptionId	path	True	string	Azure サブスクリプション ID 正規表現パターン: ^[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

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザー アカウントを偽装する

例

Get a security contact

要求のサンプル

HTTP

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

Java

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

Go

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

JavaScript

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

定義

名前	説明
CloudError	失敗した操作のエラーの詳細を返す、すべての Azure Resource Manager API の一般的なエラー応答。 (これは、OData エラー応答形式にも従います)。
CloudErrorBody	エラーの詳細。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
minimalRiskLevel	電子メール通知として送信される最小添付パス リスク レベルを定義します
minimalSeverity
NotificationsByRole	サブスクリプション上の特定の RBAC ロールを持つユーザーに Microsoft Defender for Cloud から電子メール通知を送信するかどうかを定義します。
NotificationsSourceAlert	アラート通知ソース
NotificationsSourceAttackPath	攻撃パス通知ソース
SecurityContact	Microsoft Defender for Cloud からの通知の連絡先の詳細と構成。
securityContactName	セキュリティ連絡先オブジェクトの名前
securityContactRole	Microsoft Defender for Cloud から電子メール通知を受け取る RBAC ロールを定義します。 許可されている RBAC ロールの一覧:
state	AMicrosoft Defender for Cloud から、サブスクリプション上の特定の RBAC ロールを持つユーザーに電子メール通知を送信するかどうかを定義します。

CloudError

失敗した操作のエラーの詳細を返す、すべての Azure Resource Manager API の一般的なエラー応答。 (これは、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

サブスクリプション上の特定の RBAC ロールを持つユーザーに Microsoft Defender for Cloud から電子メール通知を送信するかどうかを定義します。

名前	型	説明
roles	securityContactRole[]	Microsoft Defender for Cloud から電子メール通知を受け取る RBAC ロールを定義します。 許可されている RBAC ロールの一覧:
state	state	AMicrosoft Defender for Cloud から、サブスクリプション上の特定の RBAC ロールを持つユーザーに電子メール通知を送信するかどうかを定義します。

NotificationsSourceAlert

アラート通知ソース

名前	型	説明
minimalSeverity	minimalSeverity
sourceType	string: Alert	通知をトリガーするソースの種類

NotificationsSourceAttackPath

攻撃パス通知ソース

名前	型	説明
minimalRiskLevel	minimalRiskLevel	電子メール通知として送信される最小添付パス リスク レベルを定義します
sourceType	string: AttackPath	通知をトリガーするソースの種類

SecurityContact

Microsoft Defender for Cloud からの通知の連絡先の詳細と構成。

名前	型	説明
id	string	リソース ID
name	string	リソース名
properties.emails	string	このセキュリティ連絡先で定義されている構成によって Microsoft Defender for Cloud から通知を受け取る電子メール アドレスの一覧。
properties.isEnabled	boolean	セキュリティ連絡先が有効かどうかを示します。
properties.notificationsByRole	NotificationsByRole	サブスクリプション上の特定の RBAC ロールを持つユーザーに Microsoft Defender for Cloud から電子メール通知を送信するかどうかを定義します。
properties.notificationsSources	NotificationsSource[]: NotificationsSourceAlert[] NotificationsSourceAttackPath[]	電子メール通知を評価するソースの種類のコレクション。
properties.phone	string	セキュリティ連絡先の電話番号
type	string	リソースの種類

securityContactName

セキュリティ連絡先オブジェクトの名前

名前	型	説明
default	string	セキュリティ連絡先オブジェクトの該当する 1 つの名前

securityContactRole

Microsoft Defender for Cloud から電子メール通知を受け取る RBAC ロールを定義します。 許可されている RBAC ロールの一覧:

名前	型	説明
AccountAdmin	string	有効になっている場合は、新しいアラートに関する通知をアカウント管理者に送信します
Contributor	string	有効になっている場合は、サブスクリプションの共同作成者に新しいアラートに関する通知を送信します
Owner	string	有効になっている場合は、サブスクリプション所有者に新しいアラートに関する通知を送信します
ServiceAdmin	string	有効になっている場合は、新しいアラートに関する通知をサービス管理者に送信します

state

AMicrosoft Defender for Cloud から、サブスクリプション上の特定の RBAC ロールを持つユーザーに電子メール通知を送信するかどうかを定義します。

名前	型	説明
Off	string	サブスクリプションの管理者に新しいアラートに関する通知を送信しない
On	string	サブスクリプションの管理者に新しいアラートに関する通知を送信する