Secure Score Control Definitions - List By Subscription

Reference

Service:: Defender for Cloud

API Version:: 2020-01-01

Pro zadané předplatné uveďte seznam dostupných bezpečnostních prvků, jejich hodnocení a maximálního skóre.

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description

Name	V	Vyžadováno	Typ	Description
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

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

Odpovědi

Name	Typ	Description
200 OK	secureScoreControlDefinitionList	OK
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

List security controls definition by subscription

Sample Request

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

/** Samples for SecureScoreControlDefinitions ListBySubscription. */
public final class Main {
    /*
     * x-ms-original-file: specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/secureScoreControlDefinitions/ListSecureScoreControlDefinitions_subscription_example.json
     */
    /**
     * Sample code: List security controls definition by subscription.
     *
     * @param manager Entry point to SecurityManager.
     */
    public static void listSecurityControlsDefinitionBySubscription(
        com.azure.resourcemanager.security.SecurityManager manager) {
        manager.secureScoreControlDefinitions().listBySubscription(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/stable/2020-01-01/examples/secureScoreControlDefinitions/ListSecureScoreControlDefinitions_subscription_example.json
func ExampleSecureScoreControlDefinitionsClient_NewListBySubscriptionPager() {
	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.NewSecureScoreControlDefinitionsClient().NewListBySubscriptionPager(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.SecureScoreControlDefinitionList = armsecurity.SecureScoreControlDefinitionList{
		// 	Value: []*armsecurity.SecureScoreControlDefinitionItem{
		// 		{
		// 			Name: to.Ptr("a9909064-42b4-4d34-8143-275477afe18b"),
		// 			Type: to.Ptr("Microsoft.Security/SecureScoreControlDefinitions"),
		// 			ID: to.Ptr("/providers/Microsoft.Security/SecureScoreControlDefinitions/a9909064-42b4-4d34-8143-275477afe18b"),
		// 			Properties: &armsecurity.SecureScoreControlDefinitionItemProperties{
		// 				Description: to.Ptr("This control contains recommendations regarding DDoS attack prevention"),
		// 				AssessmentDefinitions: []*armsecurity.AzureResourceLink{
		// 					{
		// 						ID: to.Ptr("/providers/Microsoft.Security/assessmentMetadata/e3de1cc0-f4dd-3b34-e496-8b5381ba2d70"),
		// 				}},
		// 				DisplayName: to.Ptr("Protect applications against DDoS attacks"),
		// 				MaxScore: to.Ptr[int32](2),
		// 				Source: &armsecurity.SecureScoreControlDefinitionSource{
		// 					SourceType: to.Ptr(armsecurity.ControlTypeBuiltIn),
		// 				},
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("34a42fb3-e6db-409c-b56b-7b1db6b8aee0"),
		// 			Type: to.Ptr("Microsoft.Security/SecureScoreControlDefinitions"),
		// 			ID: to.Ptr("/providers/Microsoft.Security/SecureScoreControlDefinitions/34a42fb3-e6db-409c-b56b-7b1db6b8aee0"),
		// 			Properties: &armsecurity.SecureScoreControlDefinitionItemProperties{
		// 				Description: to.Ptr("This control contains recommendations regarding MFA"),
		// 				AssessmentDefinitions: []*armsecurity.AzureResourceLink{
		// 					{
		// 						ID: to.Ptr("/providers/Microsoft.Security/assessmentMetadata/151e82c5-5341-a74b-1eb0-bc38d2c84bb5"),
		// 					},
		// 					{
		// 						ID: to.Ptr("/providers/Microsoft.Security/assessmentMetadata/57e98606-6b1e-6193-0e3d-fe621387c16b"),
		// 					},
		// 					{
		// 						ID: to.Ptr("/providers/Microsoft.Security/assessmentMetadata/94290b00-4d0c-d7b4-7cea-064a9554e681"),
		// 				}},
		// 				DisplayName: to.Ptr("Enable MFA"),
		// 				MaxScore: to.Ptr[int32](10),
		// 				Source: &armsecurity.SecureScoreControlDefinitionSource{
		// 					SourceType: to.Ptr(armsecurity.ControlTypeBuiltIn),
		// 				},
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("a000c66f-6da2-4f9d-826d-2364347d2588"),
		// 			Type: to.Ptr("Microsoft.Security/SecureScoreControlDefinitions"),
		// 			ID: to.Ptr("/providers/Microsoft.Security/SecureScoreControlDefinitions/a000c66f-6da2-4f9d-826d-2364347d2588"),
		// 			Properties: &armsecurity.SecureScoreControlDefinitionItemProperties{
		// 				Description: to.Ptr("This control contains recommendations regarding enabling adaptive application control"),
		// 				AssessmentDefinitions: []*armsecurity.AzureResourceLink{
		// 					{
		// 						ID: to.Ptr("/providers/Microsoft.Security/assessmentMetadata/35f45c95-27cf-4e52-891f-8390d1de5828"),
		// 					},
		// 					{
		// 						ID: to.Ptr("/providers/Microsoft.Security/assessmentMetadata/d1db3318-01ff-16de-29eb-28b344515626"),
		// 					},
		// 					{
		// 						ID: to.Ptr("/providers/Microsoft.Security/assessmentMetadata/e7ee30c4-bac9-2966-54bd-2023a4282872"),
		// 					},
		// 					{
		// 						ID: to.Ptr("/providers/Microsoft.Security/assessmentMetadata/8e2b96ff-3de2-289b-b5c1-3b9921a3441e"),
		// 				}},
		// 				DisplayName: to.Ptr("Apply adaptive application control"),
		// 				MaxScore: to.Ptr[int32](3),
		// 				Source: &armsecurity.SecureScoreControlDefinitionSource{
		// 					SourceType: to.Ptr(armsecurity.ControlTypeBuiltIn),
		// 				},
		// 			},
		// 	}},
		// }
	}
}

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 For a specified subscription, list the available security controls, their assessments, and the max score
 *
 * @summary For a specified subscription, list the available security controls, their assessments, and the max score
 * x-ms-original-file: specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/secureScoreControlDefinitions/ListSecureScoreControlDefinitions_subscription_example.json
 */
async function listSecurityControlsDefinitionBySubscription() {
  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.secureScoreControlDefinitions.listBySubscription()) {
    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.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/2020-01-01/examples/secureScoreControlDefinitions/ListSecureScoreControlDefinitions_subscription_example.json
// this example is just showing the usage of "SecureScoreControlDefinitions_ListBySubscription" 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);

// invoke the operation and iterate over the result
await foreach (SecureScoreControlDefinitionItem item in subscriptionResource.GetSecureScoreControlDefinitionsBySubscriptionAsync())
{
    Console.WriteLine($"Succeeded: {item}");
}

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

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "/providers/Microsoft.Security/SecureScoreControlDefinitions/a9909064-42b4-4d34-8143-275477afe18b",
      "name": "a9909064-42b4-4d34-8143-275477afe18b",
      "type": "Microsoft.Security/SecureScoreControlDefinitions",
      "properties": {
        "source": {
          "sourceType": "BuiltIn"
        },
        "displayName": "Protect applications against DDoS attacks",
        "description": "This control contains recommendations regarding DDoS attack prevention",
        "maxScore": 2,
        "assessmentDefinitions": [
          {
            "id": "/providers/Microsoft.Security/assessmentMetadata/e3de1cc0-f4dd-3b34-e496-8b5381ba2d70"
          }
        ]
      }
    },
    {
      "id": "/providers/Microsoft.Security/SecureScoreControlDefinitions/34a42fb3-e6db-409c-b56b-7b1db6b8aee0",
      "name": "34a42fb3-e6db-409c-b56b-7b1db6b8aee0",
      "type": "Microsoft.Security/SecureScoreControlDefinitions",
      "properties": {
        "source": {
          "sourceType": "BuiltIn"
        },
        "displayName": "Enable MFA",
        "description": "This control contains recommendations regarding MFA",
        "maxScore": 10,
        "assessmentDefinitions": [
          {
            "id": "/providers/Microsoft.Security/assessmentMetadata/151e82c5-5341-a74b-1eb0-bc38d2c84bb5"
          },
          {
            "id": "/providers/Microsoft.Security/assessmentMetadata/57e98606-6b1e-6193-0e3d-fe621387c16b"
          },
          {
            "id": "/providers/Microsoft.Security/assessmentMetadata/94290b00-4d0c-d7b4-7cea-064a9554e681"
          }
        ]
      }
    },
    {
      "id": "/providers/Microsoft.Security/SecureScoreControlDefinitions/a000c66f-6da2-4f9d-826d-2364347d2588",
      "name": "a000c66f-6da2-4f9d-826d-2364347d2588",
      "type": "Microsoft.Security/SecureScoreControlDefinitions",
      "properties": {
        "source": {
          "sourceType": "BuiltIn"
        },
        "displayName": "Apply adaptive application control",
        "description": "This control contains recommendations regarding enabling adaptive application control",
        "maxScore": 3,
        "assessmentDefinitions": [
          {
            "id": "/providers/Microsoft.Security/assessmentMetadata/35f45c95-27cf-4e52-891f-8390d1de5828"
          },
          {
            "id": "/providers/Microsoft.Security/assessmentMetadata/d1db3318-01ff-16de-29eb-28b344515626"
          },
          {
            "id": "/providers/Microsoft.Security/assessmentMetadata/e7ee30c4-bac9-2966-54bd-2023a4282872"
          },
          {
            "id": "/providers/Microsoft.Security/assessmentMetadata/8e2b96ff-3de2-289b-b5c1-3b9921a3441e"
          }
        ]
      }
    }
  ]
}

Definice

Name	Description
AzureResourceLink	Popisuje druh prostředku Azure.
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ě.
controlType	Typ ovládacího prvku zabezpečení (například BuiltIn)
ErrorAdditionalInfo	Další informace o chybě správy prostředků
SecureScoreControlDefinitionItem	Informace o ovládacím prvku zabezpečení
secureScoreControlDefinitionList	Seznam definic ovládacích prvků zabezpečení
SecureScoreControlDefinitionSource	Typ ovládacího prvku zabezpečení (například BuiltIn)

AzureResourceLink

Popisuje druh prostředku Azure.

Name	Typ	Description
id	string	ID prostředku Azure

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.

controlType

Typ ovládacího prvku zabezpečení (například BuiltIn)

Name	Typ	Description
BuiltIn	string	Microsoft Defender pro hodnocení spravovaná v cloudu
Custom	string	Ne Microsoft Defender pro hodnocení spravovaná v cloudu

ErrorAdditionalInfo

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

SecureScoreControlDefinitionItem

Informace o ovládacím prvku zabezpečení

Name	Typ	Description
id	string	ID prostředku
name	string	Název prostředku
properties.assessmentDefinitions	AzureResourceLink[]	Pole ID metadat posouzení, která jsou součástí tohoto ovládacího prvku zabezpečení
properties.description	string	Uživatelsky přívětivý popis ovládacího prvku
properties.displayName	string	Uživatelsky přívětivý zobrazovaný název ovládacího prvku
properties.maxScore	integer	Maximální kontrolní skóre (0..10)
properties.source	SecureScoreControlDefinitionSource	Zdrojový objekt, ze kterého byl ovládací prvek vytvořen
type	string	Typ prostředku

secureScoreControlDefinitionList

Seznam definic ovládacích prvků zabezpečení

Name	Typ	Description
nextLink	string	Identifikátor URI pro načtení další stránky
value	SecureScoreControlDefinitionItem[]	Kolekce definic ovládacích prvků zabezpečení na této stránce

SecureScoreControlDefinitionSource

Typ ovládacího prvku zabezpečení (například BuiltIn)

Name	Typ	Description
sourceType	controlType	Typ ovládacího prvku zabezpečení (například BuiltIn)

Sdílet prostřednictvím

Secure Score Control Definitions - List By Subscription

Parametry identifikátoru URI

Odpovědi

Zabezpečení

azure_auth

Scopes

Příklady

List security controls definition by subscription

Sample Request

Sample Response

Definice

AzureResourceLink

CloudError

CloudErrorBody

controlType

ErrorAdditionalInfo

SecureScoreControlDefinitionItem

secureScoreControlDefinitionList

SecureScoreControlDefinitionSource

Další materiály