获取当前范围内特定云Microsoft Defender计划的安全分数。 对于 ASC Default 计划,请使用“ascScore”。
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Security/secureScores/{secureScoreName}?api-version=2020-01-01
URI 参数
名称 |
在 |
必需 |
类型 |
说明 |
secureScoreName
|
path |
True
|
string
|
计划名称。 对于 ASC Default 计划,请使用“ascScore”,如以下示例请求中所示。
|
subscriptionId
|
path |
True
|
string
|
Azure 订阅 ID
Regex pattern: ^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$
|
api-version
|
query |
True
|
string
|
操作的 API 版本
|
响应
安全性
azure_auth
Azure Active Directory OAuth2 流
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
名称 |
说明 |
user_impersonation
|
模拟用户帐户
|
示例
Get single secure score
Sample Request
GET https://management.azure.com/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/secureScores/ascScore?api-version=2020-01-01
/**
* Samples for SecureScores Get.
*/
public final class Main {
/*
* x-ms-original-file:
* specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/secureScores/
* GetSecureScoresSingle_example.json
*/
/**
* Sample code: Get single secure score.
*
* @param manager Entry point to SecurityManager.
*/
public static void getSingleSecureScore(com.azure.resourcemanager.security.SecurityManager manager) {
manager.secureScores().getWithResponse("ascScore", 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/GetSecureScoresSingle_example.json
func ExampleSecureScoresClient_Get() {
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)
}
res, err := clientFactory.NewSecureScoresClient().Get(ctx, "ascScore", nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.SecureScoreItem = 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 Get secure score for a specific Microsoft Defender for Cloud initiative within your current scope. For the ASC Default initiative, use 'ascScore'.
*
* @summary Get secure score for a specific Microsoft Defender for Cloud initiative within your current scope. For the ASC Default initiative, use 'ascScore'.
* x-ms-original-file: specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/secureScores/GetSecureScoresSingle_example.json
*/
async function getSingleSecureScore() {
const subscriptionId =
process.env["SECURITY_SUBSCRIPTION_ID"] || "20ff7fc3-e762-44dd-bd96-b71116dcdc23";
const secureScoreName = "ascScore";
const credential = new DefaultAzureCredential();
const client = new SecurityCenter(credential, subscriptionId);
const result = await client.secureScores.get(secureScoreName);
console.log(result);
}
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/GetSecureScoresSingle_example.json
// this example is just showing the usage of "SecureScores_Get" 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
string secureScoreName = "ascScore";
NullableResponse<SecureScoreResource> response = await collection.GetIfExistsAsync(secureScoreName);
SecureScoreResource result = response.HasValue ? response.Value : null;
if (result == null)
{
Console.WriteLine($"Succeeded with null as result");
}
else
{
// the variable result 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 = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}
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
{
"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
}
}
定义
CloudError
对所有 Azure 资源管理器 API 的常见错误响应,可返回失败操作的错误详细信息。 (这也遵循 OData 错误响应格式.) 。
名称 |
类型 |
说明 |
error.additionalInfo
|
ErrorAdditionalInfo[]
|
错误附加信息。
|
error.code
|
string
|
错误代码。
|
error.details
|
CloudErrorBody[]
|
错误详细信息。
|
error.message
|
string
|
错误消息。
|
error.target
|
string
|
错误目标。
|
CloudErrorBody
错误详细信息。
ErrorAdditionalInfo
资源管理错误附加信息。
名称 |
类型 |
说明 |
info
|
object
|
其他信息。
|
type
|
string
|
其他信息类型。
|
SecureScoreItem
安全评分项数据模型
名称 |
类型 |
说明 |
id
|
string
|
资源 ID
|
name
|
string
|
资源名称
|
properties.displayName
|
string
|
计划的名称
|
properties.score.current
|
number
|
当前分数
|
properties.score.max
|
integer
|
可用最高分数
|
properties.score.percentage
|
number
|
当前分数的比率除以最大值。 小数点后舍入到 4 位
|
properties.weight
|
integer
|
每个订阅的相对权重。 在计算多个订阅的聚合安全分数时使用。
|
type
|
string
|
资源类型
|