Settings - Update

Referentie

Service:: Defender for Cloud

API-versie:: 2022-05-01

instellingen bijwerken over verschillende configuraties in Microsoft Defender voor Cloud

PUT https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Security/settings/{settingName}?api-version=2022-05-01

URI-parameters

Name In Vereist Type Description

settingName

path

True

De naam van de instelling

subscriptionId

path

True

string

Azure-abonnements-id

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

api-version

query

True

string

API-versie voor de bewerking

Aanvraagbody

De aanvraagtekst kan een van de volgende zijn:

Name	Description
AlertSyncSettings	Vertegenwoordigt een waarschuwingssynchronisatie-instelling
DataExportSettings	Vertegenwoordigt een instelling voor het exporteren van gegevens

AlertSyncSettings

Vertegenwoordigt een waarschuwingssynchronisatie-instelling

Name	Vereist	Type	Description
kind	True	string: AlertSyncSettings	het type instellingentekenreeks
properties.enabled	True	boolean	Is de instelling voor waarschuwingssynchronisatie ingeschakeld

DataExportSettings

Vertegenwoordigt een instelling voor het exporteren van gegevens

Name	Vereist	Type	Description
kind	True	string: DataExportSettings	het type instellingentekenreeks
properties.enabled	True	boolean	Is de instelling voor gegevensexport ingeschakeld

Antwoorden

Name	Type	Description
200 OK	Setting: DataExportSettings AlertSyncSettings	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

Update a setting for subscription

Voorbeeldaanvraag

PUT https://management.azure.com/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/settings/WDATP?api-version=2022-05-01

{
  "kind": "DataExportSettings",
  "properties": {
    "enabled": true
  }
}


import com.azure.resourcemanager.security.models.DataExportSettings;
import com.azure.resourcemanager.security.models.SettingName;

/**
 * Samples for Settings Update.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/security/resource-manager/Microsoft.Security/stable/2022-05-01/examples/Settings/
     * UpdateSetting_example.json
     */
    /**
     * Sample code: Update a setting for subscription.
     * 
     * @param manager Entry point to SecurityManager.
     */
    public static void updateASettingForSubscription(com.azure.resourcemanager.security.SecurityManager manager) {
        manager.settings().updateWithResponse(SettingName.WDATP, new DataExportSettings().withEnabled(true),
            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

from azure.identity import DefaultAzureCredential
from azure.mgmt.security import SecurityCenter

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-security
# USAGE
    python update_setting_example.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = SecurityCenter(
        credential=DefaultAzureCredential(),
        subscription_id="20ff7fc3-e762-44dd-bd96-b71116dcdc23",
    )

    response = client.settings.update(
        setting_name="MCAS",
        setting={"kind": "DataExportSettings", "properties": {"enabled": True}},
    )
    print(response)


# x-ms-original-file: specification/security/resource-manager/Microsoft.Security/stable/2022-05-01/examples/Settings/UpdateSetting_example.json
if __name__ == "__main__":
    main()

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/9ac34f238dd6b9071f486b57e9f9f1a0c43ec6f6/specification/security/resource-manager/Microsoft.Security/stable/2022-05-01/examples/Settings/UpdateSetting_example.json
func ExampleSettingsClient_Update() {
	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.NewSettingsClient().Update(ctx, armsecurity.SettingNameAutoGeneratedWDATP, &armsecurity.DataExportSettings{
		Kind: to.Ptr(armsecurity.SettingKindDataExportSettings),
		Properties: &armsecurity.DataExportSettingProperties{
			Enabled: to.Ptr(true),
		},
	}, 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 = armsecurity.SettingsClientUpdateResponse{
	// 	                            SettingClassification: &armsecurity.DataExportSettings{
	// 		Name: to.Ptr("WDATP"),
	// 		Type: to.Ptr("Microsoft.Security/settings"),
	// 		ID: to.Ptr("/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/settings/WDATP"),
	// 		Kind: to.Ptr(armsecurity.SettingKindDataExportSettings),
	// 		Properties: &armsecurity.DataExportSettingProperties{
	// 			Enabled: to.Ptr(true),
	// 		},
	// 	},
	// 	                        }
}

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 updating settings about different configurations in Microsoft Defender for Cloud
 *
 * @summary updating settings about different configurations in Microsoft Defender for Cloud
 * x-ms-original-file: specification/security/resource-manager/Microsoft.Security/stable/2022-05-01/examples/Settings/UpdateSetting_example.json
 */
async function updateASettingForSubscription() {
  const subscriptionId =
    process.env["SECURITY_SUBSCRIPTION_ID"] || "20ff7fc3-e762-44dd-bd96-b71116dcdc23";
  const settingName = "WDATP";
  const setting = {
    enabled: true,
    kind: "DataExportSettings",
  };
  const credential = new DefaultAzureCredential();
  const client = new SecurityCenter(credential, subscriptionId);
  const result = await client.settings.update(settingName, setting);
  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.SecurityCenter;
using Azure.ResourceManager.SecurityCenter.Models;

// Generated from example definition: specification/security/resource-manager/Microsoft.Security/stable/2022-05-01/examples/Settings/UpdateSetting_example.json
// this example is just showing the usage of "Settings_Update" 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 SecuritySettingResource created on azure
// for more information of creating SecuritySettingResource, please refer to the document of SecuritySettingResource
string subscriptionId = "20ff7fc3-e762-44dd-bd96-b71116dcdc23";
SecuritySettingName settingName = SecuritySettingName.Wdatp;
ResourceIdentifier securitySettingResourceId = SecuritySettingResource.CreateResourceIdentifier(subscriptionId, settingName);
SecuritySettingResource securitySetting = client.GetSecuritySettingResource(securitySettingResourceId);

// invoke the operation
SecuritySettingData data = new DataExportSettings()
{
    IsEnabled = true,
};
ArmOperation<SecuritySettingResource> lro = await securitySetting.UpdateAsync(WaitUntil.Completed, data);
SecuritySettingResource 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
SecuritySettingData 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

Voorbeeldrespons

Statuscode:: 200

{
  "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/settings/WDATP",
  "name": "WDATP",
  "kind": "DataExportSettings",
  "type": "Microsoft.Security/settings",
  "properties": {
    "enabled": true
  }
}

Definities

Name	Description
AlertSyncSettings	Vertegenwoordigt een waarschuwingssynchronisatie-instelling
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.
DataExportSettings	Vertegenwoordigt een instelling voor het exporteren van gegevens
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
SettingName	De naam van de instelling

AlertSyncSettings

Vertegenwoordigt een waarschuwingssynchronisatie-instelling

Name	Type	Description
id	string	Resource-id
kind	string: AlertSyncSettings	het type instellingentekenreeks
name	string	Resourcenaam
properties.enabled	boolean	Is de instelling voor waarschuwingssynchronisatie ingeschakeld
type	string	Resourcetype

CloudError

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

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.

DataExportSettings

Vertegenwoordigt een instelling voor het exporteren van gegevens

Name	Type	Description
id	string	Resource-id
kind	string: DataExportSettings	het type instellingentekenreeks
name	string	Resourcenaam
properties.enabled	boolean	Is de instelling voor gegevensexport ingeschakeld
type	string	Resourcetype

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

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

SettingName

De naam van de instelling

Name	Type	Description
MCAS	string
Sentinel	string
WDATP	string
WDATP_EXCLUDE_LINUX_PUBLIC_PREVIEW	string
WDATP_UNIFIED_SOLUTION	string