Settings - List

Odwołanie

Usługa:: Defender for Cloud

Wersja interfejsu API:: 2022-05-01

Ustawienia dotyczące różnych konfiguracji w usłudze Microsoft Defender for Cloud

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis

subscriptionId

path

True

string

Identyfikator subskrypcji platformy Azure

Wzorzec wyrażenia regularnego: ^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$

api-version

query

True

string

Wersja interfejsu API dla operacji

Odpowiedzi

Nazwa	Typ	Opis
200 OK	SettingsList	OK
Other Status Codes	CloudError	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

Get settings of subscription

Przykładowe żądanie

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


/**
 * Samples for Settings List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/security/resource-manager/Microsoft.Security/stable/2022-05-01/examples/Settings/
     * GetSettings_example.json
     */
    /**
     * Sample code: Get settings of subscription.
     * 
     * @param manager Entry point to SecurityManager.
     */
    public static void getSettingsOfSubscription(com.azure.resourcemanager.security.SecurityManager manager) {
        manager.settings().list(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 get_settings_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.list()
    for item in response:
        print(item)


# x-ms-original-file: specification/security/resource-manager/Microsoft.Security/stable/2022-05-01/examples/Settings/GetSettings_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/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/GetSettings_example.json
func ExampleSettingsClient_NewListPager() {
	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)
	}
	pager := clientFactory.NewSettingsClient().NewListPager(nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.SettingsList = armsecurity.SettingsList{
		// 	Value: []armsecurity.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(false),
		// 			},
		// 		},
		// 		&armsecurity.DataExportSettings{
		// 			Name: to.Ptr("WDATP_EXCLUDE_LINUX_PUBLIC_PREVIEW"),
		// 			Type: to.Ptr("Microsoft.Security/settings"),
		// 			ID: to.Ptr("/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/settings/WDATP_EXCLUDE_LINUX_PUBLIC_PREVIEW"),
		// 			Kind: to.Ptr(armsecurity.SettingKindDataExportSettings),
		// 			Properties: &armsecurity.DataExportSettingProperties{
		// 				Enabled: to.Ptr(false),
		// 			},
		// 		},
		// 		&armsecurity.DataExportSettings{
		// 			Name: to.Ptr("WDATP_UNIFIED_SOLUTION"),
		// 			Type: to.Ptr("Microsoft.Security/settings"),
		// 			ID: to.Ptr("/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/settings/WDATP_UNIFIED_SOLUTION"),
		// 			Kind: to.Ptr(armsecurity.SettingKindDataExportSettings),
		// 			Properties: &armsecurity.DataExportSettingProperties{
		// 				Enabled: to.Ptr(false),
		// 			},
		// 		},
		// 		&armsecurity.AlertSyncSettings{
		// 			Name: to.Ptr("Sentinel"),
		// 			Type: to.Ptr("Microsoft.Security/settings"),
		// 			ID: to.Ptr("/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/settings/Sentinel"),
		// 			Kind: to.Ptr(armsecurity.SettingKindAlertSyncSettings),
		// 			Properties: &armsecurity.AlertSyncSettingProperties{
		// 				Enabled: to.Ptr(false),
		// 			},
		// 	}},
		// }
	}
}

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 Settings about different configurations in Microsoft Defender for Cloud
 *
 * @summary 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/GetSettings_example.json
 */
async function getSettingsOfSubscription() {
  const subscriptionId =
    process.env["SECURITY_SUBSCRIPTION_ID"] || "20ff7fc3-e762-44dd-bd96-b71116dcdc23";
  const credential = new DefaultAzureCredential();
  const client = new SecurityCenter(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.settings.list()) {
    resArray.push(item);
  }
  console.log(resArray);
}

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/stable/2022-05-01/examples/Settings/GetSettings_example.json
// this example is just showing the usage of "Settings_List" 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 SecuritySettingResource
SecuritySettingCollection collection = subscriptionResource.GetSecuritySettings();

// invoke the operation and iterate over the result
await foreach (SecuritySettingResource item in collection.GetAllAsync())
{
    // the variable item 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 = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine($"Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Przykładowa odpowiedź

Kod stanu:: 200

{
  "value": [
    {
      "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/settings/WDATP",
      "name": "WDATP",
      "kind": "DataExportSettings",
      "type": "Microsoft.Security/settings",
      "properties": {
        "enabled": false
      }
    },
    {
      "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/settings/WDATP_EXCLUDE_LINUX_PUBLIC_PREVIEW",
      "name": "WDATP_EXCLUDE_LINUX_PUBLIC_PREVIEW",
      "kind": "DataExportSettings",
      "type": "Microsoft.Security/settings",
      "properties": {
        "enabled": false
      }
    },
    {
      "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/settings/WDATP_UNIFIED_SOLUTION",
      "name": "WDATP_UNIFIED_SOLUTION",
      "kind": "DataExportSettings",
      "type": "Microsoft.Security/settings",
      "properties": {
        "enabled": false
      }
    },
    {
      "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/settings/Sentinel",
      "name": "Sentinel",
      "kind": "AlertSyncSettings",
      "type": "Microsoft.Security/settings",
      "properties": {
        "enabled": false
      }
    }
  ]
}

Definicje

Nazwa	Opis
AlertSyncSettings	Reprezentuje ustawienie synchronizacji alertów
CloudError	Typowa odpowiedź na błędy dla wszystkich interfejsów API usługi Azure Resource Manager w celu zwrócenia szczegółów błędu dla operacji, które zakończyły się niepowodzeniem. (Jest to również zgodne z formatem odpowiedzi na błąd OData).
CloudErrorBody	Szczegóły błędu.
DataExportSettings	Reprezentuje ustawienie eksportu danych
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
SettingsList	Lista ustawień subskrypcji.

AlertSyncSettings

Reprezentuje ustawienie synchronizacji alertów

Nazwa	Typ	Opis
id	string	Identyfikator zasobu
kind	string: AlertSyncSettings	rodzaj ciągu ustawień
name	string	Nazwa zasobu
properties.enabled	boolean	Czy włączono ustawienie synchronizacji alertów
type	string	Typ zasobu

CloudError

Typowa odpowiedź na błędy dla wszystkich interfejsów API usługi Azure Resource Manager w celu zwrócenia szczegółów błędu dla operacji, które zakończyły się niepowodzeniem. (Jest to również zgodne z formatem odpowiedzi na błąd OData).

Nazwa	Typ	Opis
error.additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
error.code	string	Kod błędu.
error.details	CloudErrorBody[]	Szczegóły błędu.
error.message	string	Komunikat o błędzie.
error.target	string	Element docelowy błędu.

CloudErrorBody

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	CloudErrorBody[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

DataExportSettings

Reprezentuje ustawienie eksportu danych

Nazwa	Typ	Opis
id	string	Identyfikator zasobu
kind	string: DataExportSettings	rodzaj ciągu ustawień
name	string	Nazwa zasobu
properties.enabled	boolean	Czy ustawienie eksportu danych jest włączone
type	string	Typ zasobu

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

SettingsList

Lista ustawień subskrypcji.

Nazwa	Typ	Opis
nextLink	string	Identyfikator URI do pobrania następnej strony.
value	Setting[]: AlertSyncSettings[] DataExportSettings[]	Lista ustawień.