Secure Score Control Definitions - List

Référence

Service:: Defender for Cloud

API Version:: 2020-01-01

Répertorier les contrôles de sécurité disponibles, leurs évaluations et le score maximal

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
api-version	query	True	string	Version de l’API pour l’opération

Réponses

Nom	Type	Description
200 OK	secureScoreControlDefinitionList	Ok
Other Status Codes	CloudError	Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

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

Scopes

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

List security controls definition

Sample Request

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


/**
 * Samples for SecureScoreControlDefinitions List.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/
     * secureScoreControlDefinitions/ListSecureScoreControlDefinitions_example.json
     */
    /**
     * Sample code: List security controls definition.
     * 
     * @param manager Entry point to SecurityManager.
     */
    public static void listSecurityControlsDefinition(com.azure.resourcemanager.security.SecurityManager manager) {
        manager.secureScoreControlDefinitions().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

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_example.json
func ExampleSecureScoreControlDefinitionsClient_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.NewSecureScoreControlDefinitionsClient().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.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("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 List the available security controls, their assessments, and the max score
 *
 * @summary 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_example.json
 */
async function listSecurityControlsDefinition() {
  const credential = new DefaultAzureCredential();
  const client = new SecurityCenter(credential);
  const resArray = new Array();
  for await (let item of client.secureScoreControlDefinitions.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.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/2020-01-01/examples/secureScoreControlDefinitions/ListSecureScoreControlDefinitions_example.json
// this example is just showing the usage of "SecureScoreControlDefinitions_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 TenantResource created on azure
// for more information of creating TenantResource, please refer to the document of TenantResource
var tenantResource = client.GetTenants().GetAllAsync().GetAsyncEnumerator().Current;

// invoke the operation and iterate over the result
await foreach (SecureScoreControlDefinitionItem item in tenantResource.GetSecureScoreControlDefinitionsAsync())
{
    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/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"
          }
        ]
      }
    }
  ]
}

Définitions

Nom	Description
AzureResourceLink	Décrit une ressource Azure avec type
CloudError	Réponse d’erreur courante pour toutes les API Azure Resource Manager pour retourner les détails de l’erreur concernant les opérations ayant échoué. (Cela suit également le format de réponse d’erreur OData.).
CloudErrorBody	Détail de l’erreur.
controlType	Type de contrôle de sécurité (par exemple, BuiltIn)
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
SecureScoreControlDefinitionItem	Informations sur le contrôle de sécurité.
secureScoreControlDefinitionList	Liste de la définition des contrôles de sécurité
SecureScoreControlDefinitionSource	Type du contrôle de sécurité (par exemple, BuiltIn)

AzureResourceLink

Décrit une ressource Azure avec type

Nom	Type	Description
id	string	ID de ressource Azure

CloudError

Réponse d’erreur courante pour toutes les API Azure Resource Manager pour retourner les détails de l’erreur concernant les opérations ayant échoué. (Cela suit également le format de réponse d’erreur OData.).

Nom	Type	Description
error.additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
error.code	string	Code d'erreur.
error.details	CloudErrorBody[]	Détails de l’erreur.
error.message	string	Message d’erreur.
error.target	string	Cible d’erreur.

CloudErrorBody

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d'erreur.
details	CloudErrorBody[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

controlType

Type de contrôle de sécurité (par exemple, BuiltIn)

Nom	Type	Description
BuiltIn	string	Microsoft Defender pour les évaluations gérées par le cloud
Custom	string	Non Microsoft Defender pour les évaluations gérées par le cloud

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires
type	string	Type d’informations supplémentaires.

SecureScoreControlDefinitionItem

Informations sur le contrôle de sécurité.

Nom	Type	Description
id	string	ID de ressource
name	string	Nom de la ressource
properties.assessmentDefinitions	AzureResourceLink[]	Tableau d’ID de métadonnées d’évaluation inclus dans ce contrôle de sécurité
properties.description	string	Description conviviale du contrôle
properties.displayName	string	Nom d’affichage convivial du contrôle
properties.maxScore	integer	Score de contrôle maximal (0,10)
properties.source	SecureScoreControlDefinitionSource	Objet source à partir duquel le contrôle a été créé
type	string	Type de ressource

secureScoreControlDefinitionList

Liste de la définition des contrôles de sécurité

Nom	Type	Description
nextLink	string	URI pour extraire la page suivante.
value	SecureScoreControlDefinitionItem[]	Collection de définitions de contrôles de sécurité dans cette page

SecureScoreControlDefinitionSource

Type du contrôle de sécurité (par exemple, BuiltIn)

Nom	Type	Description
sourceType	controlType	Type de contrôle de sécurité (par exemple, BuiltIn)

Partager via

Secure Score Control Definitions - List

Paramètres URI

Réponses

Sécurité

azure_auth

Scopes

Exemples

List security controls definition

Sample Request

Sample Response

Définitions

AzureResourceLink

CloudError

CloudErrorBody

controlType

ErrorAdditionalInfo

SecureScoreControlDefinitionItem

secureScoreControlDefinitionList

SecureScoreControlDefinitionSource

Ressources supplémentaires