Compliances - List

Ссылка

Служба:: Defender for Cloud

Версия API:: 2017-08-01-preview

Оценки соответствия определенной группы управления.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
scope	path	True	string	Область запроса может быть подпиской (/subscriptions/0b06d9ea-afe6-4779-bd59-30e5c2d9d13f) или группой управления (/providers/Microsoft.Management/managementGroups/mgName).
api-version	query	True	string	Версия API для операции

Ответы

Имя	Тип	Описание
200 OK	ComplianceList	ХОРОШО
Other Status Codes	CloudError	Ответ на ошибку, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

Get security compliance data over time

Образец запроса

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


/**
 * Samples for Compliances List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/Compliances/
     * GetCompliances_example.json
     */
    /**
     * Sample code: Get security compliance data over time.
     * 
     * @param manager Entry point to SecurityManager.
     */
    public static void getSecurityComplianceDataOverTime(com.azure.resourcemanager.security.SecurityManager manager) {
        manager.compliances().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

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/GetCompliances_example.json
func ExampleCompliancesClient_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.NewCompliancesClient().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.ComplianceList = armsecurity.ComplianceList{
		// 	Value: []*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),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("2018-01-02Z"),
		// 			Type: to.Ptr("Microsoft.Security/compliances"),
		// 			ID: to.Ptr("/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/compliances/2018-01-02Z"),
		// 			Properties: &armsecurity.ComplianceProperties{
		// 				AssessmentResult: []*armsecurity.ComplianceSegment{
		// 					{
		// 						Percentage: to.Ptr[float64](94.44444444444444),
		// 						SegmentType: to.Ptr("Compliant"),
		// 				}},
		// 				AssessmentTimestampUTCDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-01-02T00:00:00.000Z"); return t}()),
		// 				ResourceCount: to.Ptr[int32](18),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("2018-01-03Z"),
		// 			Type: to.Ptr("Microsoft.Security/compliances"),
		// 			ID: to.Ptr("/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/compliances/2018-01-03Z"),
		// 			Properties: &armsecurity.ComplianceProperties{
		// 				AssessmentResult: []*armsecurity.ComplianceSegment{
		// 					{
		// 						Percentage: to.Ptr[float64](100),
		// 						SegmentType: to.Ptr("Compliant"),
		// 				}},
		// 				AssessmentTimestampUTCDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-01-03T00: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

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

/**
 * This sample demonstrates how to The Compliance scores of the specific management group.
 *
 * @summary The Compliance scores of the specific management group.
 * x-ms-original-file: specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/Compliances/GetCompliances_example.json
 */
async function getSecurityComplianceDataOverTime() {
  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.compliances.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

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

// Generated from example definition: specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/Compliances/GetCompliances_example.json
// this example is just showing the usage of "Compliances_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);

// get the collection of this SecurityComplianceResource
string scope = "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23";
SecurityComplianceCollection collection = client.GetSecurityCompliances(new ResourceIdentifier(scope));

// invoke the operation and iterate over the result
await foreach (SecurityComplianceResource 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
    SecurityComplianceData 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/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"
      }
    },
    {
      "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/compliances/2018-01-02Z",
      "name": "2018-01-02Z",
      "type": "Microsoft.Security/compliances",
      "properties": {
        "assessmentResult": [
          {
            "segmentType": "Compliant",
            "percentage": 94.44444444444444
          }
        ],
        "resourceCount": 18,
        "assessmentTimestampUtcDate": "2018-01-02T00:00:00Z"
      }
    },
    {
      "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/compliances/2018-01-03Z",
      "name": "2018-01-03Z",
      "type": "Microsoft.Security/compliances",
      "properties": {
        "assessmentResult": [
          {
            "segmentType": "Compliant",
            "percentage": 100
          }
        ],
        "resourceCount": 18,
        "assessmentTimestampUtcDate": "2018-01-03T00:00:00Z"
      }
    }
  ]
}

Определения

Имя	Описание
CloudError	Распространенный ответ об ошибке для всех API Azure Resource Manager для возврата сведений об ошибке для неудачных операций. (Это также следует формату ответа об ошибках OData.).
CloudErrorBody	Сведения об ошибке.
Compliance	Соответствие области
ComplianceList	Список ответов объектов соответствия
ComplianceSegment	Сегмент оценки соответствия требованиям.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.

CloudError

Object

Распространенный ответ об ошибке для всех API Azure Resource Manager для возврата сведений об ошибке для неудачных операций. (Это также следует формату ответа об ошибках OData.).

Имя	Тип	Описание
error.additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
error.code	string	Код ошибки.
error.details	CloudErrorBody[]	Сведения об ошибке.
error.message	string	Сообщение об ошибке.
error.target	string	Целевой объект ошибки.

CloudErrorBody

Object

Сведения об ошибке.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	CloudErrorBody[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

Compliance

Object

Соответствие области

Имя	Тип	Описание
id	string	Идентификатор ресурса
name	string	Имя ресурса
properties.assessmentResult	ComplianceSegment[]	Массив сегмента, который является фактически оценкой соответствия.
properties.assessmentTimestampUtcDate	string (date-time)	Метка времени проведения вычисления соответствия требованиям.
properties.resourceCount	integer	Количество ресурсов указанной подписки, для которой было проведено вычисление соответствия требованиям (необходимо для вычисления соответствия группе управления).
type	string	Тип ресурса

ComplianceList

Object

Список ответов объектов соответствия

Имя	Тип	Описание
nextLink	string	URI для получения следующей страницы.
value	Compliance[]	Список объектов соответствия требованиям

ComplianceSegment

Object

Сегмент оценки соответствия требованиям.

Имя	Тип	Описание
percentage	number (double)	Размер сегмента (%).
segmentType	string	Тип сегмента, например соответствие требованиям, несоответствие требованиям, недостаточное покрытие, N/A и т. д.

ErrorAdditionalInfo

Object

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Дополнительный тип сведений.

Поделиться через

Compliances - List

Параметры URI

Ответы

Безопасность

azure_auth

Области

Примеры

Get security compliance data over time

Образец запроса

Пример ответа

Определения

CloudError

CloudErrorBody

Compliance

ComplianceList

ComplianceSegment

ErrorAdditionalInfo