Security Contacts - List

Service:

Defender for Cloud

API-versie:

2023-12-01-preview

Alle configuraties van beveiligingscontactpersoon voor het abonnement weergeven

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

URI-parameters

Name	In	Vereist	Type	Description
subscriptionId	path	True	string pattern: ^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$	Azure-abonnements-id
api-version	query	True	string	API-versie voor de bewerking

Antwoorden

Name	Type	Description
200 OK	SecurityContactList	OK
Other Status Codes	CloudError	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

List security contact data

Voorbeeldaanvraag

HTTP

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

Java

/**
 * 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

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/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

JavaScript

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

Voorbeeldrespons

Statuscode:

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

Definities

Name	Description
CloudError	Veelvoorkomende foutreactie voor alle Azure Resource Manager-API's om foutdetails te retourneren voor mislukte bewerkingen. (Dit volgt ook de OData-foutreactieindeling.)
CloudErrorBody	De foutdetails.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
minimalRiskLevel	Definieert het minimale risiconiveau voor het koppelen van pad dat als e-mailmeldingen wordt verzonden
minimalSeverity
NotificationsByRole	Hiermee definieert u of e-mailmeldingen van Microsoft Defender voor Cloud moeten worden verzonden naar personen met specifieke RBAC-rollen in het abonnement.
NotificationsSourceAlert	Meldingsbron voor waarschuwingen
NotificationsSourceAttackPath	Meldingsbron voor aanvalspad
SecurityContact	Contactgegevens en configuraties voor meldingen die afkomstig zijn van Microsoft Defender voor Cloud.
SecurityContactList	Lijst met antwoord van beveiligingscontactpersonen
securityContactRole	Hiermee definieert u welke RBAC-rollen e-mailmeldingen ontvangen van Microsoft Defender voor Cloud. Lijst met toegestane RBAC-rollen:
state	Hiermee definieert u of e-mailmeldingen van AMicrosoft Defender for Cloud moeten worden verzonden naar personen met specifieke RBAC-rollen in het abonnement.

CloudError

Object

Veelvoorkomende foutreactie voor alle Azure Resource Manager-API's om foutdetails te retourneren voor mislukte bewerkingen. (Dit volgt ook de OData-foutreactieindeling.)

Name	Type	Description
error.additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
error.code	string	De foutcode.
error.details	CloudErrorBody[]	De foutdetails.
error.message	string	Het foutbericht.
error.target	string	Het foutdoel.

CloudErrorBody

Object

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	CloudErrorBody[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

minimalRiskLevel

Inventarisatie

Definieert het minimale risiconiveau voor het koppelen van pad dat als e-mailmeldingen wordt verzonden

Waarde	Description
Critical	Meldingen ontvangen over nieuwe aanvalspaden met kritiek risiconiveau
High	Meldingen ontvangen over nieuwe aanvalspaden met hoog of kritiek risiconiveau
Low	Meldingen ontvangen over nieuwe bijlagepaden met het risiconiveau Laag, Gemiddeld, Hoog of Kritiek
Medium	Meldingen ontvangen over nieuwe koppelpaden met een gemiddeld, hoog of kritiek risiconiveau

minimalSeverity

Inventarisatie

Waarde	Description
High	Meldingen ontvangen over nieuwe waarschuwingen met hoge urgentie
Low	Meldingen ontvangen over nieuwe waarschuwingen met een lage, gemiddelde of hoge ernst
Medium	Meldingen ontvangen over nieuwe waarschuwingen met een gemiddelde of hoge ernst

NotificationsByRole

Object

Hiermee definieert u of e-mailmeldingen van Microsoft Defender voor Cloud moeten worden verzonden naar personen met specifieke RBAC-rollen in het abonnement.

Name	Type	Description
roles	securityContactRole[]	Hiermee definieert u welke RBAC-rollen e-mailmeldingen ontvangen van Microsoft Defender voor Cloud. Lijst met toegestane RBAC-rollen:
state	state	Hiermee definieert u of e-mailmeldingen van AMicrosoft Defender for Cloud moeten worden verzonden naar personen met specifieke RBAC-rollen in het abonnement.

NotificationsSourceAlert

Object

Meldingsbron voor waarschuwingen

Name	Type	Description
minimalSeverity	minimalSeverity
sourceType	string: Alert	Het brontype waarmee de melding wordt geactiveerd

NotificationsSourceAttackPath

Object

Meldingsbron voor aanvalspad

Name	Type	Description
minimalRiskLevel	minimalRiskLevel	Definieert het minimale risiconiveau voor het koppelen van pad dat als e-mailmeldingen wordt verzonden
sourceType	string: AttackPath	Het brontype waarmee de melding wordt geactiveerd

SecurityContact

Object

Contactgegevens en configuraties voor meldingen die afkomstig zijn van Microsoft Defender voor Cloud.

Name	Type	Description
id	string	Resource-id
name	string	Resourcenaam
properties.emails	string	Lijst met e-mailadressen die meldingen ontvangen van Microsoft Defender voor Cloud door de configuraties die in deze beveiligingscontactpersoon zijn gedefinieerd.
properties.isEnabled	boolean	Geeft aan of de beveiligingscontactpersoon is ingeschakeld.
properties.notificationsByRole	NotificationsByRole	Hiermee definieert u of e-mailmeldingen van Microsoft Defender voor Cloud moeten worden verzonden naar personen met specifieke RBAC-rollen in het abonnement.
properties.notificationsSources	NotificationsSource[]: NotificationsSourceAlert[] NotificationsSourceAttackPath[]	Een verzameling bronnentypen die de e-mailmelding evalueren.
properties.phone	string	Het telefoonnummer van de beveiligingscontactpersoon
type	string	Resourcetype

SecurityContactList

Object

Lijst met antwoord van beveiligingscontactpersonen

Name	Type	Description
nextLink	string	De URI voor het ophalen van de volgende pagina.
value	SecurityContact[]	Lijst met beveiligingscontactpersonen

securityContactRole

Inventarisatie

Hiermee definieert u welke RBAC-rollen e-mailmeldingen ontvangen van Microsoft Defender voor Cloud. Lijst met toegestane RBAC-rollen:

Waarde	Description
AccountAdmin	Als deze optie is ingeschakeld, verzendt u een melding over nieuwe waarschuwingen naar de accountbeheerders
Contributor	Als deze optie is ingeschakeld, verzendt u een melding over nieuwe waarschuwingen naar de inzenders van het abonnement
Owner	Als deze optie is ingeschakeld, verzendt u een melding over nieuwe waarschuwingen naar de eigenaren van het abonnement
ServiceAdmin	Als deze optie is ingeschakeld, verzendt u een melding over nieuwe waarschuwingen naar de servicebeheerders

state

Inventarisatie

Hiermee definieert u of e-mailmeldingen van AMicrosoft Defender for Cloud moeten worden verzonden naar personen met specifieke RBAC-rollen in het abonnement.

Waarde	Description
Off	Geen melding verzenden voor nieuwe waarschuwingen naar de beheerders van het abonnement
On	Melding verzenden over nieuwe waarschuwingen naar de beheerders van het abonnement