Security Contacts - List

Reference

Služba:: Defender for Cloud

Verze rozhraní API:: 2023-12-01-preview

Výpis všech konfigurací kontaktů zabezpečení pro předplatné

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
subscriptionId	path	True	string pattern: ^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$	ID předplatného Azure
api-version	query	True	string	Verze rozhraní API pro operaci

Odpovědi

Name	Typ	Description
200 OK	SecurityContactList	OK
Other Status Codes	CloudError	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

List security contact data

Ukázkový požadavek

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


/**
 * Samples for SecurityContacts List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/security/resource-manager/Microsoft.Security/preview/2023-12-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/9ac34f238dd6b9071f486b57e9f9f1a0c43ec6f6/specification/security/resource-manager/Microsoft.Security/preview/2023-12-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{
		// 				Emails: to.Ptr("john@contoso.com;Jane@contoso.com"),
		// 				IsEnabled: to.Ptr(true),
		// 				NotificationsByRole: &armsecurity.ContactPropertiesNotificationsByRole{
		// 					Roles: []*armsecurity.SecurityContactRole{
		// 						to.Ptr(armsecurity.SecurityContactRoleOwner),
		// 						to.Ptr(armsecurity.SecurityContactRole("Admin"))},
		// 						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 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/2023-12-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

Ukázková odpověď

Stavový kód:: 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"
          ]
        },
        "isEnabled": true,
        "emails": "john@contoso.com;Jane@contoso.com",
        "phone": "(214)275-4038",
        "notificationsSources": [
          {
            "sourceType": "AttackPath",
            "minimalRiskLevel": "Critical"
          },
          {
            "sourceType": "Alert",
            "minimalSeverity": "Medium"
          }
        ]
      }
    }
  ]
}

Definice

Name	Description
CloudError	Běžná chybová odpověď pro všechna rozhraní API Azure Resource Manageru pro vrácení podrobností o chybě pro neúspěšné operace (To se také řídí formátem odpovědi na chybu OData.)
CloudErrorBody	Podrobnosti o chybě.
ErrorAdditionalInfo	Další informace o chybě správy prostředků
minimalRiskLevel	Definuje minimální úroveň rizika připojení cesty, která se odešle jako e-mailová oznámení.
minimalSeverity
NotificationsByRole	Definuje, jestli se mají odesílat e-mailová oznámení z Programu Microsoft Defender pro cloud osobám s konkrétními rolemi RBAC v předplatném.
NotificationsSourceAlert	Zdroj oznámení upozornění
NotificationsSourceAttackPath	Zdroj oznámení o cestě útoku
SecurityContact	Kontaktní údaje a konfigurace pro oznámení přicházející z Microsoft Defenderu pro cloud
SecurityContactList	Seznamodpovědích
securityContactRole	Definuje, které role RBAC budou dostávat e-mailová oznámení z Microsoft Defenderu pro cloud. Seznam povolených rolí RBAC:
state	Definuje, jestli se mají odesílat e-mailová oznámení z AMicrosoft Defenderu pro cloud osobám s konkrétními rolemi RBAC v předplatném.

CloudError

Objekt

Běžná chybová odpověď pro všechna rozhraní API Azure Resource Manageru pro vrácení podrobností o chybě pro neúspěšné operace (To se také řídí formátem odpovědi na chybu OData.)

Name	Typ	Description
error.additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
error.code	string	Kód chyby.
error.details	CloudErrorBody[]	Podrobnosti o chybě.
error.message	string	Chybová zpráva.
error.target	string	Cíl chyby.

CloudErrorBody

Objekt

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	CloudErrorBody[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorAdditionalInfo

Objekt

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

minimalRiskLevel

Výčet

Definuje minimální úroveň rizika připojení cesty, která se odešle jako e-mailová oznámení.

Hodnota	Description
Critical	Získání oznámení o nových cestách útoku s kritickou úrovní rizika
High	Získání oznámení o nových cestách útoku s vysokou nebo kritickou úrovní rizika
Low	Dostávat oznámení o nových cestách připojení s nízkou, střední, vysokou nebo kritickou úrovní rizika
Medium	Získání oznámení o nových cestách připojení se střední, vysokou nebo kritickou úrovní rizika

minimalSeverity

Výčet

Hodnota	Description
High	Získání oznámení o nových upozorněních s vysokou závažností
Low	Získání oznámení o nových upozorněních s nízkou, střední nebo vysokou závažností
Medium	Získání oznámení o nových upozorněních se střední nebo vysokou závažností

NotificationsByRole

Objekt

Definuje, jestli se mají odesílat e-mailová oznámení z Programu Microsoft Defender pro cloud osobám s konkrétními rolemi RBAC v předplatném.

Name	Typ	Description
roles	securityContactRole[]	Definuje, které role RBAC budou dostávat e-mailová oznámení z Microsoft Defenderu pro cloud. Seznam povolených rolí RBAC:
state	state	Definuje, jestli se mají odesílat e-mailová oznámení z AMicrosoft Defenderu pro cloud osobám s konkrétními rolemi RBAC v předplatném.

NotificationsSourceAlert

Objekt

Zdroj oznámení upozornění

Name	Typ	Description
minimalSeverity	minimalSeverity
sourceType	string: Alert	Typ zdroje, který aktivuje oznámení

NotificationsSourceAttackPath

Objekt

Zdroj oznámení o cestě útoku

Name	Typ	Description
minimalRiskLevel	minimalRiskLevel	Definuje minimální úroveň rizika připojení cesty, která se odešle jako e-mailová oznámení.
sourceType	string: AttackPath	Typ zdroje, který aktivuje oznámení