Security Contacts - List

Referensi

Service:: Defender for Cloud

API Version:: 2020-01-01-preview

Mencantumkan semua konfigurasi kontak keamanan untuk langganan

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

Parameter URI

Nama Dalam Diperlukan Jenis Deskripsi

Nama	Dalam	Diperlukan	Jenis	Deskripsi
subscriptionId	path	True	string	ID langganan Azure Regex pattern: `^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$`
api-version	query	True	string	Versi API untuk operasi

subscriptionId

path

True

string

ID langganan Azure

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

api-version

query

True

string

Versi API untuk operasi

Respons

Nama	Jenis	Deskripsi
200 OK	SecurityContactList	OK
Other Status Codes	CloudError	Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory

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

Scopes

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

List security contact data

Sample Request

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

/** Samples for SecurityContacts List. */
public final class Main {
    /*
     * x-ms-original-file: specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/examples/SecurityContacts/GetSecurityContactsSubscription_example.json
     */
    /**
     * Sample code: List security contact data.
     *
     * @param manager Entry point to SecurityManager.
     */
    public static void listSecurityContactData(com.azure.resourcemanager.security.SecurityManager manager) {
        manager.securityContacts().list(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/GetSecurityContactsSubscription_example.json
func ExampleContactsClient_NewListPager() {
	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)
	}
	pager := clientFactory.NewContactsClient().NewListPager(nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ContactList = armsecurity.ContactList{
		// 	Value: []*armsecurity.Contact{
		// 		{
		// 			Name: to.Ptr("default"),
		// 			Type: to.Ptr("Microsoft.Security/securityContact"),
		// 			ID: to.Ptr("/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/securityContact/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),
		// 						to.Ptr(armsecurity.Roles("Admin"))},
		// 						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 List all security contact configurations for the subscription
 *
 * @summary List all security contact configurations for the subscription
 * x-ms-original-file: specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/examples/SecurityContacts/GetSecurityContactsSubscription_example.json
 */
async function listSecurityContactData() {
  const subscriptionId =
    process.env["SECURITY_SUBSCRIPTION_ID"] || "20ff7fc3-e762-44dd-bd96-b71116dcdc23";
  const credential = new DefaultAzureCredential();
  const client = new SecurityCenter(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.securityContacts.list()) {
    resArray.push(item);
  }
  console.log(resArray);
}

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/GetSecurityContactsSubscription_example.json
// this example is just showing the usage of "SecurityContacts_List" 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 and iterate over the result
await foreach (SecurityContactResource item in collection.GetAllAsync())
{
    // the variable item 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 = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine($"Succeeded");

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

{
  "value": [
    {
      "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/securityContact/default",
      "name": "default",
      "type": "Microsoft.Security/securityContact",
      "properties": {
        "notificationsByRole": {
          "state": "On",
          "roles": [
            "Owner",
            "Admin"
          ]
        },
        "emails": "john@contoso.com;Jane@contoso.com",
        "phone": "(214)275-4038",
        "alertNotifications": {
          "state": "On",
          "minimalSeverity": "Low"
        }
      }
    }
  ]
}

Definisi

Nama	Deskripsi
AlertNotifications	Menentukan apakah akan mengirim pemberitahuan email tentang pemberitahuan keamanan baru
CloudError	Respons kesalahan umum untuk semua API Azure Resource Manager untuk mengembalikan detail kesalahan untuk operasi yang gagal. (Ini juga mengikuti format respons kesalahan OData.).
CloudErrorBody	Detail kesalahan.
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
minimalSeverity	Menentukan tingkat keparahan pemberitahuan minimal yang akan dikirim sebagai pemberitahuan email
NotificationsByRole	Menentukan apakah akan mengirim pemberitahuan email dari Microsoft Defender untuk Cloud ke orang dengan peran RBAC tertentu pada langganan.
roles	Menentukan peran RBAC mana yang akan mendapatkan pemberitahuan email dari Microsoft Defender untuk Cloud. Daftar peran RBAC yang diizinkan:
SecurityContact	Detail dan konfigurasi kontak untuk pemberitahuan yang berasal dari Microsoft Defender untuk Cloud.
SecurityContactList	Daftar respons kontak keamanan
state	Menentukan apakah pemberitahuan email akan dikirim tentang pemberitahuan keamanan baru

AlertNotifications

Menentukan apakah akan mengirim pemberitahuan email tentang pemberitahuan keamanan baru

Nama	Jenis	Deskripsi
minimalSeverity	minimalSeverity	Menentukan tingkat keparahan pemberitahuan minimal yang akan dikirim sebagai pemberitahuan email
state	state	Menentukan apakah pemberitahuan email akan dikirim tentang pemberitahuan keamanan baru

CloudError

Respons kesalahan umum untuk semua API Azure Resource Manager untuk mengembalikan detail kesalahan untuk operasi yang gagal. (Ini juga mengikuti format respons kesalahan OData.).

Nama	Jenis	Deskripsi
error.additionalInfo	ErrorAdditionalInfo[]	Info tambahan kesalahan.
error.code	string	Kode kesalahan.
error.details	CloudErrorBody[]	Detail kesalahan.
error.message	string	Pesan kesalahan.
error.target	string	Target kesalahan.

CloudErrorBody

Detail kesalahan.

Nama	Jenis	Deskripsi
additionalInfo	ErrorAdditionalInfo[]	Info tambahan kesalahan.
code	string	Kode kesalahan.
details	CloudErrorBody[]	Detail kesalahan.
message	string	Pesan kesalahan.
target	string	Target kesalahan.

ErrorAdditionalInfo

Info tambahan kesalahan manajemen sumber daya.

Nama	Jenis	Deskripsi
info	object	Info tambahan.
type	string	Jenis info tambahan.

minimalSeverity

Menentukan tingkat keparahan pemberitahuan minimal yang akan dikirim sebagai pemberitahuan email

Nama	Jenis	Deskripsi
High	string	Mendapatkan pemberitahuan tentang pemberitahuan baru dengan tingkat keparahan tinggi
Low	string	Jangan mendapatkan pemberitahuan tentang pemberitahuan baru dengan tingkat keparahan rendah, sedang, atau tinggi
Medium	string	Mendapatkan pemberitahuan tentang pemberitahuan baru dengan tingkat keparahan sedang atau tinggi

NotificationsByRole

Menentukan apakah akan mengirim pemberitahuan email dari Microsoft Defender untuk Cloud ke orang dengan peran RBAC tertentu pada langganan.

Nama	Jenis	Deskripsi
roles	roles[]	Menentukan peran RBAC mana yang akan mendapatkan pemberitahuan email dari Microsoft Defender untuk Cloud. Daftar peran RBAC yang diizinkan:
state	state	Menentukan apakah akan mengirim pemberitahuan email dari AMicrosoft Defender for Cloud kepada orang dengan peran RBAC tertentu pada langganan.

roles

Menentukan peran RBAC mana yang akan mendapatkan pemberitahuan email dari Microsoft Defender untuk Cloud. Daftar peran RBAC yang diizinkan:

Nama	Jenis	Deskripsi
AccountAdmin	string	Jika diaktifkan, kirim pemberitahuan pada pemberitahuan baru ke admin akun
Contributor	string	Jika diaktifkan, kirim pemberitahuan pada pemberitahuan baru ke kontributor langganan
Owner	string	Jika diaktifkan, kirim pemberitahuan pada pemberitahuan baru ke pemilik langganan
ServiceAdmin	string	Jika diaktifkan, kirim pemberitahuan pada pemberitahuan baru ke admin layanan