Security Contacts - Get

Reference

Service:: Defender for Cloud

API Version:: 2023-12-01-preview

Získání výchozích konfigurací kontaktů zabezpečení pro předplatné

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description

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

securityContactName

path

True

securityContactName

Název objektu kontaktu zabezpečení

Regex pattern: ^(default)$

subscriptionId

path

True

string

ID předplatného Azure

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

api-version

query

True

string

Verze rozhraní API pro operaci

Odpovědi

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

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

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

Scopes

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

Příklady

Get a security contact

Sample Request

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


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

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

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

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"
      ]
    },
    "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á odpověď na chybu pro všechna rozhraní API azure Resource Manager, která vrací podrobnosti o chybě pro neúspěšné operace. (To také odpovídá formátu odpovědi na chybu OData.)
CloudErrorBody	Podrobnosti o chybě.
ErrorAdditionalInfo	Další informace o chybě správy prostředků
minimalRiskLevel	Definuje minimální úroveň rizika cesty připojení, která se bude odesílat jako e-mailová oznámení.
minimalSeverity
NotificationsByRole	Definuje, jestli se mají odesílat e-mailová oznámení z Microsoft Defender pro cloud osobám s konkrétními rolemi RBAC v předplatném.
NotificationsSourceAlert	Zdroj upozornění
NotificationsSourceAttackPath	Zdroj oznámení o cestě útoku
SecurityContact	Kontaktní údaje a konfigurace pro oznámení přicházející z Microsoft Defender pro cloud
securityContactName	Název objektu kontaktu zabezpečení
securityContactRole	Definuje, které role RBAC budou dostávat e-mailová oznámení z Microsoft Defender pro cloud. Seznam povolených rolí RBAC:
state	Definuje, jestli se mají odesílat e-mailová oznámení z AMicrosoft Defenderu for Cloud osobám s konkrétními rolemi RBAC v předplatném.

CloudError

Běžná odpověď na chybu pro všechna rozhraní API azure Resource Manager, která vrací podrobnosti o chybě pro neúspěšné operace. (To také odpovídá formátu 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

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

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

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

minimalRiskLevel

Definuje minimální úroveň rizika cesty připojení, která se bude odesílat jako e-mailová oznámení.

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

minimalSeverity

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

NotificationsByRole

Definuje, jestli se mají odesílat e-mailová oznámení z 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 Defender pro cloud. Seznam povolených rolí RBAC:
state	state	Definuje, jestli se mají odesílat e-mailová oznámení z AMicrosoft Defenderu for Cloud osobám s konkrétními rolemi RBAC v předplatném.

NotificationsSourceAlert

Zdroj upozornění

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

NotificationsSourceAttackPath

Zdroj oznámení o cestě útoku

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