Security Contacts - Get

Referens

Tjänst:: Defender for Cloud

API-version:: 2023-12-01-preview

Hämta standardkonfigurationer för säkerhetskontakter för prenumerationen

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

URI-parametrar

Name I Obligatorisk Typ Description

Name	I	Obligatorisk	Typ	Description
securityContactName	path	True	securityContactName	Namnet på säkerhetskontaktobjektet Reguljärt uttrycksmönster: `^(default)$`
subscriptionId	path	True	string	Azure-prenumerations-ID Reguljärt uttrycksmönster: `^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$`
api-version	query	True	string	API-version för åtgärden

securityContactName

path

True

securityContactName

Namnet på säkerhetskontaktobjektet

Reguljärt uttrycksmönster: ^(default)$

subscriptionId

path

True

string

Azure-prenumerations-ID

Reguljärt uttrycksmönster: ^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$

api-version

query

True

string

API-version för åtgärden

Svar

Name	Typ	Description
200 OK	SecurityContact	OKEJ
Other Status Codes	CloudError	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

Get a security contact

Exempelbegäran

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

Exempelsvar

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

Definitioner

Name	Description
CloudError	Vanligt felsvar för alla Azure Resource Manager-API:er för att returnera felinformation för misslyckade åtgärder. (Detta följer även formatet för OData-felsvar.).
CloudErrorBody	Felinformationen.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
minimalRiskLevel	Definierar den minimala risknivån för bifogad sökväg som skickas som e-postaviseringar
minimalSeverity
NotificationsByRole	Definierar om du vill skicka e-postaviseringar från Microsoft Defender för molnet till personer med specifika RBAC-roller i prenumerationen.
NotificationsSourceAlert	Aviseringsmeddelandekälla
NotificationsSourceAttackPath	Meddelandekälla för attackväg
SecurityContact	Kontaktuppgifter och konfigurationer för meddelanden som kommer från Microsoft Defender för molnet.
securityContactName	Namnet på säkerhetskontaktobjektet
securityContactRole	Definierar vilka RBAC-roller som ska få e-postaviseringar från Microsoft Defender för molnet. Lista över tillåtna RBAC-roller:
state	Definierar om du vill skicka e-postaviseringar från AMicrosoft Defender för molnet till personer med specifika RBAC-roller i prenumerationen.

CloudError

Vanligt felsvar för alla Azure Resource Manager-API:er för att returnera felinformation för misslyckade åtgärder. (Detta följer även formatet för OData-felsvar.).

Name	Typ	Description
error.additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
error.code	string	Felkoden.
error.details	CloudErrorBody[]	Felinformationen.
error.message	string	Felmeddelandet.
error.target	string	Felmålet.

CloudErrorBody

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	CloudErrorBody[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Ytterligare informationstyp.

minimalRiskLevel

Definierar den minimala risknivån för bifogad sökväg som skickas som e-postaviseringar

Name	Typ	Description
Critical	string	Få meddelanden om nya attackvägar med kritisk risknivå
High	string	Få meddelanden om nya attackvägar med hög eller kritisk risknivå
Low	string	Få meddelanden om nya bifoga sökvägar med risknivån Låg, Medel, Hög eller Kritisk
Medium	string	Få meddelanden om nya bifoga sökvägar med risknivån Medel, Hög eller Kritisk

minimalSeverity

Name	Typ	Description
High	string	Få meddelanden om nya aviseringar med hög allvarlighetsgrad
Low	string	Få meddelanden om nya aviseringar med låg, medelhög eller hög allvarlighetsgrad
Medium	string	Få meddelanden om nya aviseringar med medelhög eller hög allvarlighetsgrad

NotificationsByRole

Definierar om du vill skicka e-postaviseringar från Microsoft Defender för molnet till personer med specifika RBAC-roller i prenumerationen.

Name	Typ	Description
roles	securityContactRole[]	Definierar vilka RBAC-roller som ska få e-postaviseringar från Microsoft Defender för molnet. Lista över tillåtna RBAC-roller:
state	state	Definierar om du vill skicka e-postaviseringar från AMicrosoft Defender för molnet till personer med specifika RBAC-roller i prenumerationen.

NotificationsSourceAlert

Aviseringsmeddelandekälla

Name	Typ	Description
minimalSeverity	minimalSeverity
sourceType	string: Alert	Den källtyp som utlöser meddelandet

NotificationsSourceAttackPath

Meddelandekälla för attackväg

Name	Typ	Description
minimalRiskLevel	minimalRiskLevel	Definierar den minimala risknivån för bifogad sökväg som skickas som e-postaviseringar
sourceType	string: AttackPath	Den källtyp som utlöser meddelandet