Compliances - Get

Service:

Defender for Cloud

API Version:

2017-08-01-preview

特定のコンプライアンスの詳細。

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

URI パラメーター

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

応答

名前	型	説明
200 OK	Compliance	OK
Other Status Codes	CloudError	操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

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

Scopes

名前	説明
user_impersonation	ユーザー アカウントの借用

例

Get security compliance data for a day

Sample Request

HTTP

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

Java

/**
 * Samples for Compliances Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/Compliances/
     * GetCompliance_example.json
     */
    /**
     * Sample code: Get security compliance data for a day.
     * 
     * @param manager Entry point to SecurityManager.
     */
    public static void getSecurityComplianceDataForADay(com.azure.resourcemanager.security.SecurityManager manager) {
        manager.compliances().getWithResponse("subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23", "2018-01-01Z",
            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/preview/2017-08-01-preview/examples/Compliances/GetCompliance_example.json
func ExampleCompliancesClient_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.NewCompliancesClient().Get(ctx, "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23", "2018-01-01Z", 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.Compliance = armsecurity.Compliance{
	// 	Name: to.Ptr("2018-01-01Z"),
	// 	Type: to.Ptr("Microsoft.Security/compliances"),
	// 	ID: to.Ptr("/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/compliances/2018-01-01Z"),
	// 	Properties: &armsecurity.ComplianceProperties{
	// 		AssessmentResult: []*armsecurity.ComplianceSegment{
	// 			{
	// 				Percentage: to.Ptr[float64](77.77777777777779),
	// 				SegmentType: to.Ptr("Compliant"),
	// 		}},
	// 		AssessmentTimestampUTCDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-01-01T00:00:00.000Z"); return t}()),
	// 		ResourceCount: to.Ptr[int32](18),
	// 	},
	// }
}

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 Details of a specific Compliance.
 *
 * @summary Details of a specific Compliance.
 * x-ms-original-file: specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/Compliances/GetCompliance_example.json
 */
async function getSecurityComplianceDataForADay() {
  const scope = "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23";
  const complianceName = "2018-01-01Z";
  const credential = new DefaultAzureCredential();
  const client = new SecurityCenter(credential);
  const result = await client.compliances.get(scope, complianceName);
  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

dotnet

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

// Generated from example definition: specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/Compliances/GetCompliance_example.json
// this example is just showing the usage of "Compliances_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 SecurityComplianceResource created on azure
// for more information of creating SecurityComplianceResource, please refer to the document of SecurityComplianceResource
string scope = "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23";
string complianceName = "2018-01-01Z";
ResourceIdentifier securityComplianceResourceId = SecurityComplianceResource.CreateResourceIdentifier(scope, complianceName);
SecurityComplianceResource securityCompliance = client.GetSecurityComplianceResource(securityComplianceResourceId);

// invoke the operation
SecurityComplianceResource result = await securityCompliance.GetAsync();

// 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
SecurityComplianceData 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

Status code:

200

{
  "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/compliances/2018-01-01Z",
  "name": "2018-01-01Z",
  "type": "Microsoft.Security/compliances",
  "properties": {
    "assessmentResult": [
      {
        "segmentType": "Compliant",
        "percentage": 77.77777777777779
      }
    ],
    "resourceCount": 18,
    "assessmentTimestampUtcDate": "2018-01-01T00:00:00Z"
  }
}

定義

名前	説明
CloudError	失敗した操作のエラーの詳細を返す、すべての Azure Resource Manager API に対する一般的なエラー応答 (これは OData エラー応答形式にも従います)。
CloudErrorBody	エラーの詳細。
Compliance	スコープのコンプライアンス
ComplianceSegment	コンプライアンス評価のセグメント。
ErrorAdditionalInfo	リソース管理エラーの追加情報。

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	エラーのターゲット。

Compliance

スコープのコンプライアンス

名前	型	説明
id	string	リソース ID
name	string	リソース名
properties.assessmentResult	ComplianceSegment[]	セグメントの配列。これは実際にはコンプライアンス評価です。
properties.assessmentTimestampUtcDate	string	コンプライアンス計算が実行されたときのタイムスタンプ。
properties.resourceCount	integer	コンプライアンス計算が実行された特定のサブスクリプションのリソース数 (管理グループ コンプライアンス計算に必要)。
type	string	リソースの種類

ComplianceSegment

コンプライアンス評価のセグメント。

名前	型	説明
percentage	number	セグメントのサイズ (%) です。
segmentType	string	セグメントの種類 (準拠、非準拠、カバレッジの不十分、N/A など)。

ErrorAdditionalInfo

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

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