Secure Scores - List

Referência

Service:: Defender for Cloud

API Version:: 2020-01-01

Liste classificações seguras para todas as suas Microsoft Defender para iniciativas da Cloud no âmbito atual.

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

Parâmetros do URI

Name Em Necessário Tipo Description

Name	Em	Necessário	Tipo	Description
subscriptionId	path	True	string	ID da subscrição do Azure Regex pattern: `^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$`
api-version	query	True	string	Versão da API para a operação

subscriptionId

path

True

string

ID da subscrição do Azure

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

api-version

query

True

string

Versão da API para a operação

Respostas

Name	Tipo	Description
200 OK	SecureScoresList	OK
Other Status Codes	CloudError	Resposta de erro que descreve o motivo pela qual a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

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

Scopes

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

List secure scores

Sample Request

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


/**
 * Samples for SecureScores List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/secureScores/
     * ListSecureScores_example.json
     */
    /**
     * Sample code: List secure scores.
     * 
     * @param manager Entry point to SecurityManager.
     */
    public static void listSecureScores(com.azure.resourcemanager.security.SecurityManager manager) {
        manager.secureScores().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/secureScores/ListSecureScores_example.json
func ExampleSecureScoresClient_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.NewSecureScoresClient().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.SecureScoresList = armsecurity.SecureScoresList{
		// 	Value: []*armsecurity.SecureScoreItem{
		// 		{
		// 			Name: to.Ptr("ascScore"),
		// 			Type: to.Ptr("Microsoft.Security/secureScores"),
		// 			ID: to.Ptr("/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/secureScores/ascScore"),
		// 			Properties: &armsecurity.SecureScoreItemProperties{
		// 				DisplayName: to.Ptr("ASC score"),
		// 				Score: &armsecurity.ScoreDetails{
		// 					Current: to.Ptr[float64](23.53),
		// 					Max: to.Ptr[int32](39),
		// 					Percentage: to.Ptr[float64](0.6033),
		// 				},
		// 				Weight: to.Ptr[int64](67),
		// 			},
		// 	}},
		// }
	}
}

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 secure scores for all your Microsoft Defender for Cloud initiatives within your current scope.
 *
 * @summary List secure scores for all your Microsoft Defender for Cloud initiatives within your current scope.
 * x-ms-original-file: specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/secureScores/ListSecureScores_example.json
 */
async function listSecureScores() {
  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.secureScores.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;

// Generated from example definition: specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/secureScores/ListSecureScores_example.json
// this example is just showing the usage of "SecureScores_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 SecureScoreResource
SecureScoreCollection collection = subscriptionResource.GetSecureScores();

// invoke the operation and iterate over the result
await foreach (SecureScoreResource 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
    SecureScoreData 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

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/secureScores/ascScore",
      "name": "ascScore",
      "type": "Microsoft.Security/secureScores",
      "properties": {
        "displayName": "ASC score",
        "score": {
          "max": 39,
          "current": 23.53,
          "percentage": 0.6033
        },
        "weight": 67
      }
    }
  ]
}

Definições

Name	Description
CloudError	Resposta de erro comum para todas as APIs do Azure Resource Manager para devolver detalhes do erro para operações com falhas. (Isto também segue o formato de resposta de erro OData.).
CloudErrorBody	O detalhe do erro.
ErrorAdditionalInfo	Informações adicionais sobre o erro de gestão de recursos.
SecureScoreItem	Modelo de dados de item de classificação segura
SecureScoresList	Lista de classificações seguras

CloudError

Resposta de erro comum para todas as APIs do Azure Resource Manager para devolver detalhes do erro para operações com falhas. (Isto também segue o formato de resposta de erro OData.).

Name	Tipo	Description
error.additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
error.code	string	O código de erro.
error.details	CloudErrorBody[]	Os detalhes do erro.
error.message	string	A mensagem de erro.
error.target	string	O destino do erro.

CloudErrorBody

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	CloudErrorBody[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informações adicionais.

SecureScoreItem

Modelo de dados de item de classificação segura

Name	Tipo	Description
id	string	ID do Recurso
name	string	Nome do recurso
properties.displayName	string	O nome da iniciativa
properties.score.current	number	Pontuação atual
properties.score.max	integer	Classificação máxima disponível
properties.score.percentage	number	Proporção da classificação atual dividida pelo máximo. Arredondado para 4 dígitos após a vírgula decimal
properties.weight	integer	O peso relativo de cada subscrição. Utilizado ao calcular uma classificação de segurança agregada para várias subscrições.
type	string	Tipo de recurso