Security Contacts - Create

Reference

Service:: Defender for Cloud

API Version:: 2020-01-01-preview

Vytvoření konfigurace kontaktů zabezpečení pro předplatné

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description

Name	V	Vyžadováno	Typ	Description
securityContactName	path	True	string	Název objektu kontaktu zabezpečení
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

string

Název objektu kontaktu zabezpečení

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

Text požadavku

Name	Typ	Description
properties.alertNotifications	AlertNotifications	Definuje, jestli se mají odesílat e-mailová oznámení o nových výstrahách zabezpečení.
properties.emails	string	Seznam e-mailových adres, které budou dostávat oznámení z Microsoft Defender pro cloud podle konfigurací definovaných v tomto kontaktu zabezpečení.
properties.notificationsByRole	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.
properties.phone	string	Telefonní číslo bezpečnostního kontaktu

Odpovědi

Name	Typ	Description
200 OK	SecurityContact	OK
201 Created	SecurityContact	Vytvořeno
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

Create security contact data

Sample Request

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

{
  "properties": {
    "notificationsByRole": {
      "state": "On",
      "roles": [
        "Owner"
      ]
    },
    "emails": "john@contoso.com;jane@contoso.com",
    "phone": "(214)275-4038",
    "alertNotifications": {
      "state": "On",
      "minimalSeverity": "Low"
    }
  }
}

import com.azure.resourcemanager.security.models.MinimalSeverity;
import com.azure.resourcemanager.security.models.Roles;
import com.azure.resourcemanager.security.models.SecurityContactPropertiesAlertNotifications;
import com.azure.resourcemanager.security.models.SecurityContactPropertiesNotificationsByRole;
import com.azure.resourcemanager.security.models.State;
import java.util.Arrays;

/** Samples for SecurityContacts Create. */
public final class Main {
    /*
     * x-ms-original-file: specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/examples/SecurityContacts/CreateSecurityContact_example.json
     */
    /**
     * Sample code: Create security contact data.
     *
     * @param manager Entry point to SecurityManager.
     */
    public static void createSecurityContactData(com.azure.resourcemanager.security.SecurityManager manager) {
        manager
            .securityContacts()
            .define("default")
            .withEmails("john@contoso.com;jane@contoso.com")
            .withPhone("(214)275-4038")
            .withAlertNotifications(
                new SecurityContactPropertiesAlertNotifications()
                    .withState(State.fromString("On"))
                    .withMinimalSeverity(MinimalSeverity.LOW))
            .withNotificationsByRole(
                new SecurityContactPropertiesNotificationsByRole()
                    .withState(State.fromString("On"))
                    .withRoles(Arrays.asList(Roles.OWNER)))
            .create();
    }
}

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/azcore/to"
	"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/CreateSecurityContact_example.json
func ExampleContactsClient_Create() {
	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().Create(ctx, "default", armsecurity.Contact{
		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"),
		},
	}, 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/securityContact"),
	// 	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@microsoft.com;jane@microsoft.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 Create security contact configurations for the subscription
 *
 * @summary Create security contact configurations for the subscription
 * x-ms-original-file: specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/examples/SecurityContacts/CreateSecurityContact_example.json
 */
async function createSecurityContactData() {
  const subscriptionId =
    process.env["SECURITY_SUBSCRIPTION_ID"] || "20ff7fc3-e762-44dd-bd96-b71116dcdc23";
  const securityContactName = "default";
  const securityContact = {
    alertNotifications: { minimalSeverity: "Low", state: "On" },
    emails: "john@contoso.com;jane@contoso.com",
    notificationsByRole: { roles: ["Owner"], state: "On" },
    phone: "(214)275-4038",
  };
  const credential = new DefaultAzureCredential();
  const client = new SecurityCenter(credential, subscriptionId);
  const result = await client.securityContacts.create(securityContactName, securityContact);
  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/CreateSecurityContact_example.json
// this example is just showing the usage of "SecurityContacts_Create" 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";
SecurityContactData data = new SecurityContactData()
{
    Emails = "john@contoso.com;jane@contoso.com",
    Phone = "(214)275-4038",
    AlertNotifications = new SecurityContactPropertiesAlertNotifications()
    {
        State = SecurityAlertNotificationState.On,
        MinimalSeverity = SecurityAlertMinimalSeverity.Low,
    },
    NotificationsByRole = new SecurityContactPropertiesNotificationsByRole()
    {
        State = SecurityAlertNotificationByRoleState.On,
        Roles =
        {
        SecurityAlertReceivingRole.Owner
        },
    },
};
ArmOperation<SecurityContactResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, securityContactName, data);
SecurityContactResource result = lro.Value;

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

{
  "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/securityContacts/default",
  "name": "default",
  "type": "Microsoft.Security/securityContact",
  "properties": {
    "notificationsByRole": {
      "state": "On",
      "roles": [
        "Owner"
      ]
    },
    "emails": "john@microsoft.com;jane@microsoft.com",
    "phone": "(214)275-4038",
    "alertNotifications": {
      "state": "On",
      "minimalSeverity": "Low"
    }
  }
}

Status code:: 200

{
  "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/securityContacts/default",
  "name": "default",
  "type": "Microsoft.Security/securityContact",
  "properties": {
    "notificationsByRole": {
      "state": "On",
      "roles": [
        "Owner"
      ]
    },
    "emails": "john@microsoft.com;jane@microsoft.com",
    "phone": "(214)275-4038",
    "alertNotifications": {
      "state": "On",
      "minimalSeverity": "Low"
    }
  }
}

Definice

Name	Description
AlertNotifications	Definuje, jestli se mají odesílat e-mailová oznámení o nových výstrahách zabezpečení.
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ů
minimalSeverity	Definuje minimální závažnost upozornění, která se bude odesílat jako e-mailová oznámení.
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.
roles	Definuje, které role RBAC budou dostávat e-mailová oznámení z Microsoft Defender pro cloud. Seznam povolených rolí RBAC:
SecurityContact	Kontaktní údaje a konfigurace pro oznámení přicházející z Microsoft Defender pro cloud
state	Definuje, jestli se budou odesílat e-mailová oznámení o nových výstrahách zabezpečení.

AlertNotifications

Definuje, jestli se mají odesílat e-mailová oznámení o nových výstrahách zabezpečení.

Name	Typ	Description
minimalSeverity	minimalSeverity	Definuje minimální závažnost upozornění, která se bude odesílat jako e-mailová oznámení.
state	state	Definuje, jestli se budou odesílat e-mailová oznámení o nových výstrahách zabezpečení.

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í.

minimalSeverity

Definuje minimální závažnost upozornění, která se bude odesílat jako e-mailová oznámení.

Name	Typ	Description
High	string	Získání oznámení o nových upozorněních s vysokou závažností
Low	string	Nedostanou oznámení o nových výstrahá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	roles[]	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.

roles

Definuje, které role RBAC budou dostávat e-mailová oznámení z Microsoft Defender pro cloud. Seznam povolených rolí RBAC:

Name	Typ	Description
AccountAdmin	string	Pokud je tato možnost povolená, odešlete oznámení o nových upozorněních správcům účtu.
Contributor	string	Pokud je tato možnost povolená, odešlete oznámení o nových upozorněních přispěvatelům předplatného.
Owner	string	Pokud je tato možnost povolená, odešlete oznámení o nových upozorněních vlastníkům předplatného.
ServiceAdmin	string	Pokud je tato možnost povolená, odešlete oznámení o nových upozorněních správcům služby.