Compliance Results - List

サービス:

Defender for Cloud

API バージョン:

2017-08-01

セキュリティ コンプライアンスの結果、サブスクリプション

GET https://management.azure.com/{scope}/providers/Microsoft.Security/complianceResults?api-version=2017-08-01

URI パラメーター

名前	/	必須	型	説明
scope	path	True	string	クエリのスコープは、サブスクリプション (/subscriptions/0b06d9ea-afe6-4779-bd59-30e5c2d9d13f) または管理グループ (/providers/Microsoft.Management/managementGroups/mgName) です。
api-version	query	True	string	操作の API バージョン

応答

名前	型	説明
200 OK	ComplianceResultList	わかりました
Other Status Codes	CloudError	操作が失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザー アカウントを偽装する

例

Get compliance results on subscription

要求のサンプル

HTTP

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

Java

/**
 * Samples for ComplianceResults List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/security/resource-manager/Microsoft.Security/stable/2017-08-01/examples/ComplianceResults/
     * ListComplianceResults_example.json
     */
    /**
     * Sample code: Get compliance results on subscription.
     * 
     * @param manager Entry point to SecurityManager.
     */
    public static void getComplianceResultsOnSubscription(com.azure.resourcemanager.security.SecurityManager manager) {
        manager.complianceResults().list("subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23",
            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

Go

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/2017-08-01/examples/ComplianceResults/ListComplianceResults_example.json
func ExampleComplianceResultsClient_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.NewComplianceResultsClient().NewListPager("subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23", 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.ComplianceResultList = armsecurity.ComplianceResultList{
		// 	Value: []*armsecurity.ComplianceResult{
		// 		{
		// 			Name: to.Ptr("DesignateMoreThanOneOwner"),
		// 			Type: to.Ptr("Microsoft.Security/complianceResults"),
		// 			ID: to.Ptr("/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/complianceResults/DesignateMoreThanOneOwner"),
		// 			Properties: &armsecurity.ComplianceResultProperties{
		// 				ResourceStatus: to.Ptr(armsecurity.ResourceStatusHealthy),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("RemoveExternalAccountsWithReadPermissions"),
		// 			Type: to.Ptr("Microsoft.Security/complianceResults"),
		// 			ID: to.Ptr("/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/complianceResults/RemoveExternalAccountsWithReadPermissions"),
		// 			Properties: &armsecurity.ComplianceResultProperties{
		// 				ResourceStatus: to.Ptr(armsecurity.ResourceStatusNotHealthy),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("RemoveDeprecatedAccounts"),
		// 			Type: to.Ptr("Microsoft.Security/complianceResults"),
		// 			ID: to.Ptr("/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/complianceResults/RemoveDeprecatedAccounts"),
		// 			Properties: &armsecurity.ComplianceResultProperties{
		// 				ResourceStatus: to.Ptr(armsecurity.ResourceStatusHealthy),
		// 			},
		// 	}},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { SecurityCenter } = require("@azure/arm-security");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Security compliance results in the subscription
 *
 * @summary Security compliance results in the subscription
 * x-ms-original-file: specification/security/resource-manager/Microsoft.Security/stable/2017-08-01/examples/ComplianceResults/ListComplianceResults_example.json
 */
async function getComplianceResultsOnSubscription() {
  const scope = "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23";
  const credential = new DefaultAzureCredential();
  const client = new SecurityCenter(credential);
  const resArray = new Array();
  for await (let item of client.complianceResults.list(scope)) {
    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

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.SecurityCenter;

// Generated from example definition: specification/security/resource-manager/Microsoft.Security/stable/2017-08-01/examples/ComplianceResults/ListComplianceResults_example.json
// this example is just showing the usage of "ComplianceResults_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 ArmResource created on azure
// for more information of creating ArmResource, please refer to the document of ArmResource

// get the collection of this ComplianceResultResource
string scope = "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23";
ResourceIdentifier scopeId = new ResourceIdentifier(string.Format("/{0}", scope));
ComplianceResultCollection collection = client.GetComplianceResults(scopeId);

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

応答のサンプル

状態コード:

200

{
  "value": [
    {
      "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/complianceResults/DesignateMoreThanOneOwner",
      "name": "DesignateMoreThanOneOwner",
      "type": "Microsoft.Security/complianceResults",
      "properties": {
        "resourceStatus": "Healthy"
      }
    },
    {
      "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/complianceResults/RemoveExternalAccountsWithReadPermissions",
      "name": "RemoveExternalAccountsWithReadPermissions",
      "type": "Microsoft.Security/complianceResults",
      "properties": {
        "resourceStatus": "NotHealthy"
      }
    },
    {
      "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/complianceResults/RemoveDeprecatedAccounts",
      "name": "RemoveDeprecatedAccounts",
      "type": "Microsoft.Security/complianceResults",
      "properties": {
        "resourceStatus": "Healthy"
      }
    }
  ]
}

定義

名前	説明
CloudError	失敗した操作のエラーの詳細を返す、すべての Azure Resource Manager API の一般的なエラー応答。 (これは、OData エラー応答形式にも従います)。
CloudErrorBody	エラーの詳細。
ComplianceResult	コンプライアンスの結果
ComplianceResultList	コンプライアンス結果の応答の一覧
ErrorAdditionalInfo	リソース管理エラーの追加情報。
resourceStatus	1 つの評価に関するリソースの状態

CloudError

失敗した操作のエラーの詳細を返す、すべての Azure Resource Manager API の一般的なエラー応答。 (これは、OData エラー応答形式にも従います)。

名前	型	説明
error.additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
error.code	string	エラー コード。
error.details	CloudErrorBody[]	エラーの詳細。
error.message	string	エラー メッセージ。
error.target	string	エラーターゲット。

CloudErrorBody

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラー コード。
details	CloudErrorBody[]	エラーの詳細。
message	string	エラー メッセージ。
target	string	エラーターゲット。

ComplianceResult

コンプライアンスの結果

名前	型	説明
id	string	リソース ID
name	string	リソース名
properties.resourceStatus	resourceStatus	1 つの評価に関するリソースの状態
type	string	リソースの種類

ComplianceResultList

コンプライアンス結果の応答の一覧

名前	型	説明
nextLink	string	次のページをフェッチする URI。
value	ComplianceResult[]	コンプライアンスの結果の一覧

ErrorAdditionalInfo

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

resourceStatus

1 つの評価に関するリソースの状態

名前	型	説明
Healthy	string	リソースに対するこの評価は正常です
NotApplicable	string	この評価は、このリソースには適用されません
NotHealthy	string	リソースに対するこの評価が正常ではありません
OffByPolicy	string	この評価は、このサブスクリプションのポリシーによって無効になります