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 매개 변수

Name In(다음 안에) 필수 형식 Description

Name	In(다음 안에)	필수	형식	Description
reportName	path	True	string	보고서 이름입니다. regex 패턴: `^[-a-zA-Z0-9_]{1,50}$`
api-version	query	True	string	이 작업에 사용할 API 버전입니다.

reportName

path

True

string

보고서 이름입니다.

regex 패턴: ^[-a-zA-Z0-9_]{1,50}$

api-version

query

True

string

이 작업에 사용할 API 버전입니다.

응답

Name	형식	Description
200 OK	ReportResource	Azure 작업이 성공적으로 완료되었습니다.
Other Status Codes	ErrorResponse	예기치 않은 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 Flow.

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name	Description
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"
  }
}

정의

Name	Description
CertSyncRecord	클래스는 앱 준수에서 동기화된 인증 레코드를 나타냅니다.
ControlSyncRecord	클래스는 앱 준수에서 동기화된 컨트롤 레코드를 나타냅니다.
createdByType	리소스를 만든 ID의 형식입니다.
ErrorAdditionalInfo	리소스 관리 오류 추가 정보입니다.
ErrorDetail	오류 세부 정보입니다.
ErrorResponse	오류 응답
OverviewStatus	한 보고서에 대한 규정 준수 결과의 개요입니다.
ProvisioningState	리소스 프로비저닝 상태입니다.
ReportComplianceStatus	하나의 보고서에 대한 모든 준수 결과를 포함하는 목록입니다.
ReportResource	클래스는 AppComplianceAutomation 보고서 리소스를 나타냅니다.
ReportStatus	보고서 상태.
ResourceMetadata	단일 리소스 ID의 메타데이터입니다.
ResourceOrigin	리소스 원본.
StorageInfo	보고서에 '사용자 고유의 스토리지 가져오기' 계정 바인딩 정보
systemData	리소스의 생성 및 마지막 수정과 관련된 메타데이터입니다.

CertSyncRecord

클래스는 앱 준수에서 동기화된 인증 레코드를 나타냅니다.

Name	형식	Description
certificationStatus	string	인증 프로세스의 상태를 나타냅니다.
controls	ControlSyncRecord[]	동기화할 컨트롤 레코드 목록입니다.
ingestionStatus	string	준수 프로세스의 상태를 나타냅니다.
offerGuid	string	보고서에 매핑하는 offerGuid입니다.

ControlSyncRecord

클래스는 앱 준수에서 동기화된 컨트롤 레코드를 나타냅니다.

Name	형식	Description
controlId	string	컨트롤의 ID입니다. 예: "Operational_Security_10"
controlStatus	string	앱 규정 준수에서 동기화된 제어 상태입니다.

createdByType

리소스를 만든 ID의 형식입니다.

Name	형식	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

리소스 관리 오류 추가 정보입니다.

Name	형식	Description
info	object	추가 정보입니다.
type	string	추가 정보 유형입니다.

ErrorDetail

오류 세부 정보입니다.

Name	형식	Description
additionalInfo	ErrorAdditionalInfo[]	오류 추가 정보입니다.
code	string	오류 코드입니다.
details	ErrorDetail[]	오류 세부 정보입니다.
message	string	오류 메시지입니다.
target	string	오류 대상입니다.

ErrorResponse

오류 응답

Name	형식	Description
error	ErrorDetail	오류 개체입니다.

OverviewStatus

한 보고서에 대한 규정 준수 결과의 개요입니다.

Name	형식	Description
failedCount	integer	실패한 모든 컨트롤의 수입니다.
manualCount	integer	모든 수동 컨트롤의 수입니다.
notApplicableCount	integer	적용할 수 없는 모든 컨트롤의 수입니다.
passedCount	integer	전달된 모든 컨트롤의 수입니다.
pendingCount	integer	승인 제어를 위해 보류 중인 모든 수입니다.

ProvisioningState

리소스 프로비저닝 상태입니다.

Name	형식	Description
Canceled	string	프로비저닝이 취소되었습니다.
Creating	string	만들기가 진행 중입니다.
Deleting	string	삭제가 진행 중입니다.
Failed	string	프로비저닝이 실패했습니다.
Fixing	string	진행 중인 리소스의 수정입니다.
Succeeded	string	프로비전에 성공했습니다.
Updating	string	진행 중인 리소스의 업데이트입니다.
Verifying	string	진행 중인 리소스의 확인입니다.

ReportComplianceStatus

하나의 보고서에 대한 모든 준수 결과를 포함하는 목록입니다.

Name	형식	Description
m365	OverviewStatus	Microsoft 365 인증 이름입니다.

ReportResource

클래스는 AppComplianceAutomation 보고서 리소스를 나타냅니다.

Name	형식	Description
id	string	리소스에 대한 정규화된 리소스 ID입니다. 예 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	리소스의 이름
properties.certRecords	CertSyncRecord[]	동기화된 인증 레코드 목록입니다.
properties.complianceStatus	ReportComplianceStatus	준수 상태를 보고합니다.
properties.errors	string[]	보고서 오류 코드 목록입니다.
properties.lastTriggerTime	string	마지막 컬렉션 트리거 시간을 보고합니다.
properties.nextTriggerTime	string	다음 컬렉션 트리거 시간을 보고합니다.
properties.offerGuid	string	쉼표로 구분된 offerGuids 목록은 보고서에 매핑되는 일련의 offerGuids를 나타냅니다. 예를 들어 "000000000-0000-0000-0000000000001,000000000-0000-0000000 -0000-00000000000002" 및 "00000000-00000-0000-0000-0000000000003".
properties.provisioningState	ProvisioningState	Azure 수명 주기 관리
properties.resources	ResourceMetadata[]	리소스 데이터 목록입니다.
properties.status	ReportStatus	보고서 상태.
properties.storageInfo	StorageInfo	보고서에 '사용자 고유의 스토리지 가져오기' 바인딩 정보
properties.subscriptions	string[]	구독 ID 목록입니다.
properties.tenantId	string	보고서의 테넌트 ID입니다.
properties.timeZone	string	보고서 컬렉션 트리거 시간의 표준 시간대는 PowerShell에서 "Get-TimeZone -ListAvailable"을 실행하여 사용 가능한 목록을 가져올 수 있습니다. 유효한 표준 시간대 ID의 예는 "Pacific Standard Time"입니다.
properties.triggerTime	string	보고서 컬렉션 트리거 시간입니다.
systemData	systemData	createdBy 및 modifiedBy 정보가 포함된 Azure Resource Manager 메타데이터입니다.
type	string	리소스의 형식입니다. 예: "Microsoft.Compute/virtualMachines" 또는 "Microsoft.Storage/storageAccounts"

ReportStatus

보고서 상태.

Name	형식	Description
Active	string	보고서가 활성화되어 있습니다.
Disabled	string	보고서를 사용할 수 없습니다.
Failed	string	보고서가 실패했습니다.
Reviewing	string	보고서가 검토 중입니다.

ResourceMetadata

단일 리소스 ID의 메타데이터입니다.

Name	형식	Description
accountId	string	계정 ID입니다. 예를 들어 AWS 계정 ID입니다.
resourceId	string	리소스 ID - 예: "/subscriptions/00000000-0000-0000-0000-0000000000000/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/vm1".
resourceKind	string	리소스 종류입니다.
resourceOrigin	ResourceOrigin	리소스 원본.
resourceType	string	리소스 종류입니다. 예: "Microsoft.Compute/virtualMachines"

ResourceOrigin

리소스 원본.

Name	형식	Description
AWS	string	리소스는 AWS에서 온 것입니다.
Azure	string	리소스는 Azure에서 온 것입니다.
GCP	string	리소스는 GCP에서 가져옵니다.

StorageInfo

보고서에 '사용자 고유의 스토리지 가져오기' 계정 바인딩 정보

Name	형식	Description
accountName	string	'사용자 고유의 스토리지 가져오기' 계정 이름
location	string	'Bring Your Own Storage' 계정의 지역
resourceGroup	string	'사용자 고유의 스토리지를 가져오는' 계정이 속한 resourceGroup
subscriptionId	string	'사용자 고유의 스토리지 가져오기' 계정이 속한 구독 ID

systemData

리소스의 생성 및 마지막 수정과 관련된 메타데이터입니다.

Name	형식	Description
createdAt	string	리소스 만들기의 타임스탬프(UTC)입니다.
createdBy	string	리소스를 만든 ID입니다.
createdByType	createdByType	리소스를 만든 ID의 형식입니다.
lastModifiedAt	string	리소스 마지막 수정의 타임스탬프(UTC)
lastModifiedBy	string	리소스를 마지막으로 수정한 ID입니다.
lastModifiedByType	createdByType	리소스를 마지막으로 수정한 ID의 형식입니다.

다음을 통해 공유

Report - Get

URI 매개 변수

응답

보안

azure_auth

범위

예제

Report_Get

샘플 요청

샘플 응답

정의

CertSyncRecord

ControlSyncRecord

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

OverviewStatus

ProvisioningState

ReportComplianceStatus

ReportResource

ReportStatus

ResourceMetadata

ResourceOrigin

StorageInfo

systemData

추가 리소스