Secure Scores - List

Referencia

Service:: Defender for Cloud

API Version:: 2020-01-01

Az aktuális hatókörön belüli felhőbeli kezdeményezések Microsoft Defender biztonsági pontszámainak listázása.

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

URI-paraméterek

Name In Kötelező Típus Description

Name	In	Kötelező	Típus	Description
subscriptionId	path	True	string	Azure-előfizetés azonosítója Regex pattern: `^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$`
api-version	query	True	string	A művelet API-verziója

subscriptionId

path

True

string

Azure-előfizetés azonosítója

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

api-version

query

True

string

A művelet API-verziója

Válaszok

Name	Típus	Description
200 OK	SecureScoresList	OK
Other Status Codes	CloudError	Hibaválasz, amely leírja, hogy a művelet miért hiúsult meg.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name	Description
user_impersonation	felhasználói fiók megszemélyesítése

Példák

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/b43974e07d3204c4b6f8396627f5430994a7f7c9/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
      }
    }
  ]
}

Definíciók

Name	Description
CloudError	Az azure Resource Manager API-k gyakori hibaválasza a meghiúsult műveletek hibaadatainak visszaadásához. (Ez az OData hibaválasz formátumát is követi.)
CloudErrorBody	A hiba részletei.
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
SecureScoreItem	Biztonsági pontszám elem adatmodellje
SecureScoresList	Biztonsági pontszámok listája

CloudError

Az azure Resource Manager API-k gyakori hibaválasza a meghiúsult műveletek hibaadatainak visszaadásához. (Ez az OData hibaválasz formátumát is követi.)

Name	Típus	Description
error.additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
error.code	string	A hibakód.
error.details	CloudErrorBody[]	A hiba részletei.
error.message	string	A hibaüzenet.
error.target	string	A hiba célja.

CloudErrorBody

A hiba részletei.

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	CloudErrorBody[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hiba célja.

ErrorAdditionalInfo

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további adattípus.

SecureScoreItem

Biztonsági pontszám elem adatmodellje

Name	Típus	Description
id	string	Erőforrás-azonosító
name	string	Erőforrás neve
properties.displayName	string	A kezdeményezés neve
properties.score.current	number	Aktuális pontszám
properties.score.max	integer	Elérhető maximális pontszám
properties.score.percentage	number	Az aktuális pontszám és a maximum hányadosa. Kerekítve 4 számjegyre a tizedesvessző után
properties.weight	integer	Az egyes előfizetések relatív súlya. Több előfizetés összesített biztonsági pontszámának kiszámításakor használatos.
type	string	Erőforrás típusa