Report - Get

Ссылка

Служба:: App Compliance Automation

Версия API:: 2024-06-27

Получите отчет AppComplianceAutomation и его свойства.

GET https://management.azure.com/providers/Microsoft.AppComplianceAutomation/reports/{reportName}?api-version=2024-06-27

Параметры URI

Имя	В	Обязательно	Тип	Описание
reportName	path	True	string pattern: ^[-a-zA-Z0-9_]{1,50}$	Имя отчета.
api-version	query	True	string minLength: 1	Версия API, используемая для этой операции.

Ответы

Имя	Тип	Описание
200 OK	ReportResource	Операция Azure успешно завершена.
Other Status Codes	ErrorResponse	Непредвиденное сообщение об ошибке.

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

azure_auth

Поток OAuth2 Azure Active Directory.

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

Области

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

Примеры

Report_Get

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

GET https://management.azure.com/providers/Microsoft.AppComplianceAutomation/reports/testReport?api-version=2024-06-27

from azure.identity import DefaultAzureCredential

from azure.mgmt.appcomplianceautomation import AppComplianceAutomationMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-appcomplianceautomation
# USAGE
    python report_get.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = AppComplianceAutomationMgmtClient(
        credential=DefaultAzureCredential(),
    )

    response = client.report.get(
        report_name="testReport",
    )
    print(response)


# x-ms-original-file: specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Report_Get.json
if __name__ == "__main__":
    main()

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

package armappcomplianceautomation_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appcomplianceautomation/armappcomplianceautomation"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d88c94b22a8efdd47c0cadfe6d8d489107db2b23/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Report_Get.json
func ExampleReportClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappcomplianceautomation.NewClientFactory(cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewReportClient().Get(ctx, "testReport", 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.ReportResource = armappcomplianceautomation.ReportResource{
	// 	Name: to.Ptr("testReportName"),
	// 	Type: to.Ptr("Microsfot.AppComplianceAutomation/reports"),
	// 	ID: to.Ptr("/provider/Microsfot.AppComplianceAutomation/reports/testReportName"),
	// 	SystemData: &armappcomplianceautomation.SystemData{
	// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-05-14T22:34:55.449Z"); return t}()),
	// 		CreatedBy: to.Ptr("00000000-0000-0000-0000-000000000000"),
	// 		CreatedByType: to.Ptr(armappcomplianceautomation.CreatedByTypeUser),
	// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-05-14T22:34:55.449Z"); return t}()),
	// 		LastModifiedBy: to.Ptr("00000000-0000-0000-0000-000000000000"),
	// 		LastModifiedByType: to.Ptr(armappcomplianceautomation.CreatedByTypeUser),
	// 	},
	// 	Properties: &armappcomplianceautomation.ReportProperties{
	// 		CertRecords: []*armappcomplianceautomation.CertSyncRecord{
	// 			{
	// 				CertificationStatus: to.Ptr("CertIngestion"),
	// 				Controls: []*armappcomplianceautomation.ControlSyncRecord{
	// 					{
	// 						ControlID: to.Ptr("Operational_Security_10"),
	// 						ControlStatus: to.Ptr("Approved"),
	// 				}},
	// 				IngestionStatus: to.Ptr("EvidenceResubmitted"),
	// 				OfferGUID: to.Ptr("00000000-0000-0000-0000-000000000001"),
	// 		}},
	// 		ComplianceStatus: &armappcomplianceautomation.ReportComplianceStatus{
	// 			M365: &armappcomplianceautomation.OverviewStatus{
	// 				FailedCount: to.Ptr[int32](0),
	// 				ManualCount: to.Ptr[int32](0),
	// 				PassedCount: to.Ptr[int32](0),
	// 			},
	// 		},
	// 		Errors: []*string{
	// 			to.Ptr("resource-inaccessible")},
	// 			LastTriggerTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-03-02T05:00:00.000Z"); return t}()),
	// 			NextTriggerTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-03-02T05:00:00.000Z"); return t}()),
	// 			OfferGUID: to.Ptr("00000000-0000-0000-0000-000000000001,00000000-0000-0000-0000-000000000002"),
	// 			ProvisioningState: to.Ptr(armappcomplianceautomation.ProvisioningStateSucceeded),
	// 			Resources: []*armappcomplianceautomation.ResourceMetadata{
	// 				{
	// 					ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService"),
	// 					ResourceOrigin: to.Ptr(armappcomplianceautomation.ResourceOriginAzure),
	// 					ResourceType: to.Ptr("Microsoft.SignalRService/SignalR"),
	// 				},
	// 				{
	// 					AccountID: to.Ptr("000000000000"),
	// 					ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/acat-aws/providers/microsoft.security/securityconnectors/acatawsconnector/securityentitydata/aws-iam-user-testuser"),
	// 					ResourceOrigin: to.Ptr(armappcomplianceautomation.ResourceOriginAWS),
	// 					ResourceType: to.Ptr("iam.user"),
	// 			}},
	// 			Status: to.Ptr(armappcomplianceautomation.ReportStatusFailed),
	// 			StorageInfo: &armappcomplianceautomation.StorageInfo{
	// 				AccountName: to.Ptr("testStorageAccount"),
	// 				Location: to.Ptr("East US"),
	// 				ResourceGroup: to.Ptr("testResourceGroup"),
	// 				SubscriptionID: to.Ptr("00000000-0000-0000-0000-000000000000"),
	// 			},
	// 			Subscriptions: []*string{
	// 				to.Ptr("00000000-0000-0000-0000-000000000000")},
	// 				TenantID: to.Ptr("00000000-0000-0000-0000-000000000000"),
	// 				TimeZone: to.Ptr("GMT Standard Time"),
	// 				TriggerTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-03-02T05:00:00.000Z"); return t}()),
	// 			},
	// 		}
}

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

const {
  AppComplianceAutomationToolForMicrosoft365,
} = require("@azure/arm-appcomplianceautomation");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Get the AppComplianceAutomation report and its properties.
 *
 * @summary Get the AppComplianceAutomation report and its properties.
 * x-ms-original-file: specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Report_Get.json
 */
async function reportGet() {
  const reportName = "testReport";
  const credential = new DefaultAzureCredential();
  const client = new AppComplianceAutomationToolForMicrosoft365(credential);
  const result = await client.report.get(reportName);
  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 Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.AppComplianceAutomation.Models;
using Azure.ResourceManager.AppComplianceAutomation;

// Generated from example definition: specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Report_Get.json
// this example is just showing the usage of "Report_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 AppComplianceReportResource created on azure
// for more information of creating AppComplianceReportResource, please refer to the document of AppComplianceReportResource
string reportName = "testReport";
ResourceIdentifier appComplianceReportResourceId = AppComplianceReportResource.CreateResourceIdentifier(reportName);
AppComplianceReportResource appComplianceReport = client.GetAppComplianceReportResource(appComplianceReportResourceId);

// invoke the operation
AppComplianceReportResource result = await appComplianceReport.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
AppComplianceReportData 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

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

Код состояния:: 200

{
  "name": "testReportName",
  "type": "Microsfot.AppComplianceAutomation/reports",
  "id": "/provider/Microsfot.AppComplianceAutomation/reports/testReportName",
  "properties": {
    "certRecords": [
      {
        "certificationStatus": "CertIngestion",
        "controls": [
          {
            "controlId": "Operational_Security_10",
            "controlStatus": "Approved"
          }
        ],
        "ingestionStatus": "EvidenceResubmitted",
        "offerGuid": "00000000-0000-0000-0000-000000000001"
      }
    ],
    "complianceStatus": {
      "m365": {
        "failedCount": 0,
        "manualCount": 0,
        "passedCount": 0
      }
    },
    "errors": [
      "resource-inaccessible"
    ],
    "lastTriggerTime": "2022-03-02T05:00:00.000Z",
    "nextTriggerTime": "2022-03-02T05:00:00.000Z",
    "offerGuid": "00000000-0000-0000-0000-000000000001,00000000-0000-0000-0000-000000000002",
    "provisioningState": "Succeeded",
    "resources": [
      {
        "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService",
        "resourceOrigin": "Azure",
        "resourceType": "Microsoft.SignalRService/SignalR"
      },
      {
        "accountId": "000000000000",
        "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/acat-aws/providers/microsoft.security/securityconnectors/acatawsconnector/securityentitydata/aws-iam-user-testuser",
        "resourceOrigin": "AWS",
        "resourceType": "iam.user"
      }
    ],
    "status": "Failed",
    "storageInfo": {
      "accountName": "testStorageAccount",
      "location": "East US",
      "resourceGroup": "testResourceGroup",
      "subscriptionId": "00000000-0000-0000-0000-000000000000"
    },
    "subscriptions": [
      "00000000-0000-0000-0000-000000000000"
    ],
    "tenantId": "00000000-0000-0000-0000-000000000000",
    "timeZone": "GMT Standard Time",
    "triggerTime": "2022-03-02T05:00:00.000Z"
  },
  "systemData": {
    "createdAt": "2021-05-14T22:34:55.4499903Z",
    "createdBy": "00000000-0000-0000-0000-000000000000",
    "createdByType": "User",
    "lastModifiedAt": "2021-05-14T22:34:55.4499903Z",
    "lastModifiedBy": "00000000-0000-0000-0000-000000000000",
    "lastModifiedByType": "User"
  }
}

Определения

Имя	Описание
CertSyncRecord	Класс представляет запись сертификации, синхронизированную из соответствия приложения.
ControlSyncRecord	Класс представляет запись элемента управления, синхронизированную из соответствия приложения.
createdByType	Тип удостоверения, создавшего ресурс.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ на ошибку
OverviewStatus	Общие сведения о результатах соответствия для одного отчета.
ProvisioningState	Состояния подготовки ресурсов.
ReportComplianceStatus	Список, содержащий все результаты соответствия для одного отчета.
ReportResource	Класс представляет ресурс отчета AppComplianceAutomation.
ReportStatus	Состояние отчета.
ResourceMetadata	Метаданные одного идентификатора ресурса.
ResourceOrigin	Источник ресурсов.
StorageInfo	Сведения о привязке учетной записи хранения к отчету
systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.

CertSyncRecord

Object

Класс представляет запись сертификации, синхронизированную из соответствия приложения.

Имя	Тип	Описание
certificationStatus	string	Указывает состояние процесса сертификации.
controls	ControlSyncRecord[]	Список записей элементов управления для синхронизации.
ingestionStatus	string	Указывает состояние процесса соответствия требованиям.
offerGuid	string minLength: 1	ПредложениеGuid, которое сопоставляет отчеты.

ControlSyncRecord

Object

Класс представляет запись элемента управления, синхронизированную из соответствия приложения.

Имя	Тип	Описание
controlId	string	Идентификатор элемента управления. Например, "Operational_Security_10"
controlStatus	string	Управление состоянием, синхронизированным из соответствия приложений.

createdByType

Перечисление

Тип удостоверения, создавшего ресурс.

Значение	Описание
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Object

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

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

ErrorDetail

Object

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

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

ErrorResponse

Object

Ответ на ошибку

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.

OverviewStatus

Object

Общие сведения о результатах соответствия для одного отчета.

Имя	Тип	Описание
failedCount	integer (int32)	Количество всех неудачных элементов управления.
manualCount	integer (int32)	Количество всех элементов управления вручную.
notApplicableCount	integer (int32)	Количество всех не применимых элементов управления.
passedCount	integer (int32)	Количество всех переданных элементов управления.
pendingCount	integer (int32)	Количество всех ожиданий для элемента управления утверждением.

ProvisioningState

Перечисление

Состояния подготовки ресурсов.

Значение	Описание
Canceled	Подготовка отменена.
Creating	Создание выполняется.
Deleting	Выполняется удаление.
Failed	Сбой подготовки.
Fixing	Исправление выполняющегося ресурса.
Succeeded	Подготовка выполнена успешно.
Updating	Обновление ресурса выполняется.
Verifying	Проверка выполняющегося ресурса.

ReportComplianceStatus

Object

Список, содержащий все результаты соответствия для одного отчета.

Имя	Тип	Описание
m365	OverviewStatus	Имя сертификации Microsoft 365.

ReportResource

Object

Класс представляет ресурс отчета AppComplianceAutomation.

Имя	Тип	Описание
id	string	Полный идентификатор ресурса для ресурса. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Имя ресурса
properties.certRecords	CertSyncRecord[]	Список синхронизированных записей сертификации.
properties.complianceStatus	ReportComplianceStatus	Состояние соответствия отчета.
properties.errors	string[]	Список кодов ошибок отчета.
properties.lastTriggerTime	string (date-time)	Отчет о времени последнего триггера коллекции.
properties.nextTriggerTime	string (date-time)	Сообщите о времени триггера следующей коллекции.
properties.offerGuid	string	Список предложений, разделенных запятыми, указывает ряд предложенийGuids, которые сопоставляются с отчетом. Например, "00000000-0000-0000-0000-0000000001000000000000000000-0000-0000-0000-0000-000000000002" и "000000000000-0000-00000-0000000000000003".
properties.provisioningState	ProvisioningState	Управление жизненным циклом Azure
properties.resources	ResourceMetadata[]	Список данных ресурсов.
properties.status	ReportStatus	Состояние отчета.
properties.storageInfo	StorageInfo	Сведения о привязке собственного хранилища к отчету
properties.subscriptions	string[]	Список идентификаторов подписки.
properties.tenantId	string	Идентификатор клиента отчета.
properties.timeZone	string	Часовой пояс времени триггера сбора отчетов доступный список можно получить, выполнив команду "Get-TimeZone -ListAvailable" в PowerShell. Пример допустимого идентификатора часового пояса — "Тихоокеанское стандартное время".
properties.triggerTime	string (date-time)	Время триггера сбора отчетов.
systemData	systemData	Метаданные Azure Resource Manager, содержащие данные createdBy и modifiedBy.
type	string	Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

ReportStatus

Перечисление

Состояние отчета.

Значение	Описание
Active	Отчет активен.
Disabled	Отчет отключен.
Failed	Отчет завершается ошибкой.
Reviewing	В отчете выполняется обзор.

ResourceMetadata

Object

Метаданные одного идентификатора ресурса.

Имя	Тип	Описание
accountId	string	Идентификатор учетной записи. Например, идентификатор учетной записи AWS.
resourceId	string	Идентификатор ресурса: например, "/subscriptions/000000000-0000-0000-0000-000000000000000/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/vm1".
resourceKind	string	Тип ресурса.
resourceOrigin	ResourceOrigin	Источник ресурсов.
resourceType	string	Тип ресурса. Например, "Microsoft.Compute/virtualMachines"

ResourceOrigin

Перечисление

Источник ресурсов.

Значение	Описание
AWS	Ресурс выполняется из AWS.
Azure	Ресурс выполняется из Azure.
GCP	Ресурс выполняется из GCP.

StorageInfo

Object

Сведения о привязке учетной записи хранения к отчету

Имя	Тип	Описание
accountName	string	Имя учетной записи хранения
location	string	Регион учетной записи "Принести собственную учетную запись хранения"
resourceGroup	string	Группа ресурсов, к которой относится учетная запись хранения
subscriptionId	string	Идентификатор подписки, к которой принадлежит собственная учетная запись хранения.

systemData

Object

Метаданные, относящиеся к созданию и последнему изменении ресурса.

Имя	Тип	Описание
createdAt	string (date-time)	Метка времени создания ресурса (UTC).
createdBy	string	Удостоверение, создающее ресурс.
createdByType	createdByType	Тип удостоверения, создавшего ресурс.
lastModifiedAt	string (date-time)	Метка времени последнего изменения ресурса (UTC)
lastModifiedBy	string	Идентификатор, который последний раз изменил ресурс.
lastModifiedByType	createdByType	Тип удостоверения, который последний раз изменил ресурс.

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

Report - Get

Параметры URI

Ответы

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

azure_auth

Области

Примеры

Report_Get

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

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

Определения

CertSyncRecord

ControlSyncRecord

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

OverviewStatus

ProvisioningState

ReportComplianceStatus

ReportResource

ReportStatus

ResourceMetadata

ResourceOrigin

StorageInfo

systemData

Дополнительные ресурсы