Security Contacts - Get

Referencia

Service:: Defender for Cloud

API Version:: 2020-01-01-preview

Alapértelmezett biztonsági kapcsolatfelvételi konfigurációk lekérése az előfizetéshez

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

URI-paraméterek

Name In Kötelező Típus Description

Name	In	Kötelező	Típus	Description
securityContactName	path	True	string	A biztonsági kapcsolattartó objektum neve
subscriptionId	path	True	string	Azure-előfizetés azonosítója Regex pattern: `^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$`
api-version	query	True	string	A művelet API-verziója

securityContactName

path

True

string

A biztonsági kapcsolattartó objektum neve

subscriptionId

path

True

string

Azure-előfizetés azonosítója

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

api-version

query

True

string

A művelet API-verziója

Válaszok

Name	Típus	Description
200 OK	SecurityContact	OK
Other Status Codes	CloudError	Hibaválasz, amely leírja, hogy a művelet miért hiúsult meg.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name	Description
user_impersonation	felhasználói fiók megszemélyesítése

Példák

Get a security contact

Sample Request

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

/** Samples for SecurityContacts Get. */
public final class Main {
    /*
     * x-ms-original-file: specification/security/resource-manager/Microsoft.Security/preview/2020-01-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("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/e716082ac474f182e2220e4f38f1d6191e7636cf/specification/security/resource-manager/Microsoft.Security/preview/2020-01-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, "default", 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{
	// 		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)},
	// 				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 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/2020-01-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

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/GetSecurityContact_example.json
// this example is just showing the usage of "SecurityContacts_Get" 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
string securityContactName = "default";
NullableResponse<SecurityContactResource> response = await collection.GetIfExistsAsync(securityContactName);
SecurityContactResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine($"Succeeded with null as result");
}
else
{
    // the variable result 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 = result.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

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"
      ]
    },
    "emails": "john@contoso.com;jane@contoso.com",
    "phone": "(214)275-4038",
    "alertNotifications": {
      "state": "On",
      "minimalSeverity": "Low"
    }
  }
}

Definíciók

Name	Description
AlertNotifications	Meghatározza, hogy küldjön-e e e-mail-értesítéseket az új biztonsági riasztásokról
CloudError	Az azure Resource Manager API-k gyakori hibaválasza a meghiúsult műveletek hibaadatainak visszaadásához. (Ez az OData hibaválasz formátumát is követi.)
CloudErrorBody	A hiba részletei.
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
minimalSeverity	Meghatározza az e-mail-értesítésekként küldendő minimális riasztási súlyosságot
NotificationsByRole	Meghatározza, hogy küldjön-e e e-mail-értesítéseket Microsoft Defender felhőhöz az előfizetésben meghatározott RBAC-szerepkörökkel rendelkező személyeknek.
roles	Meghatározza, hogy mely RBAC-szerepkörök kapnak e-mail-értesítéseket Microsoft Defender a Felhőhöz. Az engedélyezett RBAC-szerepkörök listája:
SecurityContact	A felhőhöz készült Microsoft Defender érkező értesítések kapcsolattartási adatai és konfigurációi.
state	Meghatározza, hogy a rendszer e-mail-értesítéseket küldjön-e az új biztonsági riasztásokról

AlertNotifications

Meghatározza, hogy küldjön-e e e-mail-értesítéseket az új biztonsági riasztásokról

Name	Típus	Description
minimalSeverity	minimalSeverity	Meghatározza az e-mail-értesítésekként küldendő minimális riasztási súlyosságot
state	state	Meghatározza, hogy a rendszer e-mail-értesítéseket küldjön-e az új biztonsági riasztásokról

CloudError

Az azure Resource Manager API-k gyakori hibaválasza a meghiúsult műveletek hibaadatainak visszaadásához. (Ez az OData hibaválasz formátumát is követi.)

Name	Típus	Description
error.additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
error.code	string	A hibakód.
error.details	CloudErrorBody[]	A hiba részletei.
error.message	string	A hibaüzenet.
error.target	string	A hiba célja.

CloudErrorBody

A hiba részletei.

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	CloudErrorBody[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hiba célja.

ErrorAdditionalInfo

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további adattípus.

minimalSeverity

Meghatározza az e-mail-értesítésekként küldendő minimális riasztási súlyosságot

Name	Típus	Description
High	string	Értesítések lekérése nagy súlyosságú új riasztásokról
Low	string	Ne kapjon értesítéseket alacsony, közepes vagy nagy súlyosságú új riasztásokról
Medium	string	Értesítések lekérése közepes vagy nagy súlyosságú új riasztásokról

NotificationsByRole

Meghatározza, hogy küldjön-e e e-mail-értesítéseket Microsoft Defender felhőhöz az előfizetésben meghatározott RBAC-szerepkörökkel rendelkező személyeknek.

Name	Típus	Description
roles	roles[]	Meghatározza, hogy mely RBAC-szerepkörök kapnak e-mail-értesítéseket Microsoft Defender a Felhőhöz. Az engedélyezett RBAC-szerepkörök listája:
state	state	Meghatározza, hogy küldjön-e e e-mail-értesítéseket az AMicrosoft Defender for Cloudból az előfizetésben meghatározott RBAC-szerepkörökkel rendelkező személyeknek.

roles

Meghatározza, hogy mely RBAC-szerepkörök kapnak e-mail-értesítéseket Microsoft Defender a Felhőhöz. Az engedélyezett RBAC-szerepkörök listája:

Name	Típus	Description
AccountAdmin	string	Ha engedélyezve van, küldjön értesítést az új riasztásokról a fiókadminisztrátornak
Contributor	string	Ha engedélyezve van, küldjön értesítést az új riasztásokról az előfizetés közreműködőinek
Owner	string	Ha engedélyezve van, küldjön értesítést az új riasztásokról az előfizetés tulajdonosainak
ServiceAdmin	string	Ha engedélyezve van, küldjön értesítést az új riasztásokról a szolgáltatás rendszergazdáinak