Report - Get

참조

서비스:: App Compliance Automation

API 버전:: 2022-11-16-preview

AppComplianceAutomation 보고서 및 해당 속성을 가져옵니다.

GET https://management.azure.com/providers/Microsoft.AppComplianceAutomation/reports/{reportName}?api-version=2022-11-16-preview

URI 매개 변수

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

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

reportName

path

True

string

보고서 이름입니다.

regex 패턴: ^[-a-zA-Z0-9_]+$

api-version

query

True

string

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

응답

Name	형식	Description
200 OK	ReportResource	성공.
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=2022-11-16-preview

import com.azure.core.util.Context;

/** Samples for ReportOperation Get. */
public final class Main {
    /*
     * x-ms-original-file: specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/preview/2022-11-16-preview/examples/Report_Get.json
     */
    /**
     * Sample code: Report_Get.
     *
     * @param manager Entry point to AppComplianceAutomationManager.
     */
    public static void reportGet(
        com.azure.resourcemanager.appcomplianceautomation.AppComplianceAutomationManager manager) {
        manager.reportOperations().getWithResponse("testReport", 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

from azure.identity import DefaultAzureCredential
from azure.mgmt.appcomplianceautomation import AppComplianceAutomationToolForMicrosoft365

"""
# 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 = AppComplianceAutomationToolForMicrosoft365(
        credential=DefaultAzureCredential(),
    )

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


# x-ms-original-file: specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/preview/2022-11-16-preview/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/82ea406b73d671269217053d7ef336450d860345/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/preview/2022-11-16-preview/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{
	// 		ComplianceStatus: &armappcomplianceautomation.ReportComplianceStatus{
	// 			M365: &armappcomplianceautomation.OverviewStatus{
	// 				FailedCount: to.Ptr[int32](0),
	// 				ManualCount: to.Ptr[int32](0),
	// 				PassedCount: to.Ptr[int32](0),
	// 			},
	// 		},
	// 		ID: to.Ptr("00000000-0000-0000-0000-000000000000"),
	// 		LastTriggerTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-03-02T05:17:23.922Z"); return t}()),
	// 		NextTriggerTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-03-02T05:17:23.922Z"); return t}()),
	// 		OfferGUID: to.Ptr("00000000-0000-0000-0000-000000000000"),
	// 		ProvisioningState: to.Ptr(armappcomplianceautomation.ProvisioningStateSucceeded),
	// 		ReportName: to.Ptr("testReportName"),
	// 		Resources: []*armappcomplianceautomation.ResourceMetadata{
	// 			{
	// 				ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService"),
	// 				Tags: map[string]*string{
	// 					"key1": to.Ptr("value1"),
	// 				},
	// 		}},
	// 		Status: to.Ptr(armappcomplianceautomation.ReportStatusActive),
	// 		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:17:23.922Z"); 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

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.AppComplianceAutomation;
using Azure.ResourceManager.AppComplianceAutomation.Models;

// Generated from example definition: specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/preview/2022-11-16-preview/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 ReportResource created on azure
// for more information of creating ReportResource, please refer to the document of ReportResource
string reportName = "testReport";
ResourceIdentifier reportResourceId = ReportResource.CreateResourceIdentifier(reportName);
ReportResource reportResource = client.GetReportResource(reportResourceId);

// invoke the operation
ReportResource result = await reportResource.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
ReportResourceData 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

{
  "id": "/provider/Microsfot.AppComplianceAutomation/reports/testReportName",
  "name": "testReportName",
  "type": "Microsfot.AppComplianceAutomation/reports",
  "properties": {
    "id": "00000000-0000-0000-0000-000000000000",
    "status": "Active",
    "tenantId": "00000000-0000-0000-0000-000000000000",
    "reportName": "testReportName",
    "offerGuid": "00000000-0000-0000-0000-000000000000",
    "timeZone": "GMT Standard Time",
    "triggerTime": "2022-03-02T05:17:23.922Z",
    "nextTriggerTime": "2022-03-02T05:17:23.922Z",
    "lastTriggerTime": "2022-03-02T05:17:23.922Z",
    "subscriptions": [
      "00000000-0000-0000-0000-000000000000"
    ],
    "resources": [
      {
        "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService",
        "tags": {
          "key1": "value1"
        }
      }
    ],
    "complianceStatus": {
      "m365": {
        "passedCount": 0,
        "failedCount": 0,
        "manualCount": 0
      }
    },
    "provisioningState": "Succeeded"
  },
  "systemData": {
    "createdBy": "00000000-0000-0000-0000-000000000000",
    "createdByType": "User",
    "createdAt": "2021-05-14T22:34:55.4499903Z",
    "lastModifiedBy": "00000000-0000-0000-0000-000000000000",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2021-05-14T22:34:55.4499903Z"
  }
}

정의

Name	Description
createdByType	리소스를 만든 ID의 형식입니다.
ErrorAdditionalInfo	리소스 관리 오류 추가 정보입니다.
ErrorDetail	오류 세부 정보입니다.
ErrorResponse	오류 응답
OverviewStatus	한 보고서에 대한 규정 준수 결과의 개요입니다.
provisioningState	Azure 수명 주기 관리
ReportComplianceStatus	하나의 보고서에 대한 모든 준수 결과를 포함하는 목록입니다.
ReportProperties	보고서의 속성입니다.
ReportResource	클래스는 AppComplianceAutomation 보고서 리소스를 나타냅니다.
ReportStatus	상태 보고.
ResourceMetadata	단일 리소스 ID의 메타데이터입니다.
systemData	리소스 만들기 및 마지막 수정과 관련된 메타데이터입니다.

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	Error 개체.

OverviewStatus

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

Name	형식	Description
failedCount	integer	실패한 모든 전체 자동화 제어의 수입니다.
manualCount	integer	모든 수동 컨트롤의 수입니다.
passedCount	integer	전달된 모든 전체 자동화 컨트롤의 수입니다.

provisioningState

Azure 수명 주기 관리

Name	형식	Description
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

ReportComplianceStatus

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

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

ReportProperties

보고서의 속성입니다.

Name	형식	Description
complianceStatus	ReportComplianceStatus	규정 준수 상태 보고합니다.
id	string	데이터베이스의 보고서 ID입니다.
lastTriggerTime	string	마지막 컬렉션 트리거 시간을 보고합니다.
nextTriggerTime	string	다음 컬렉션 트리거 시간을 보고합니다.
offerGuid	string	보고서 제품 Guid입니다.
provisioningState	provisioningState	Azure 수명 주기 관리
reportName	string	보고서 이름입니다.
resources	ResourceMetadata[]	리소스 데이터 목록입니다.
status	ReportStatus	상태 보고.
subscriptions	string[]	구독 ID 목록입니다.
tenantId	string	보고서의 테넌트 ID입니다.
timeZone	string	보고서 컬렉션 트리거 시간의 표준 시간대는 PowerShell에서 "Get-TimeZone -ListAvailable"을 실행하여 사용 가능한 목록을 가져올 수 있습니다. 유효한 표준 시간대 ID의 예는 "태평양 표준시"입니다.
triggerTime	string	보고서 컬렉션 트리거 시간입니다.

ReportResource

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

Name	형식	Description
id	string	리소스에 대한 정규화된 리소스 ID입니다. 예 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	리소스의 이름입니다.
properties	ReportProperties	보고서 속성입니다.
systemData	systemData	createdBy 및 modifiedBy 정보가 포함된 Azure Resource Manager 메타데이터입니다.
type	string	리소스 형식입니다. 예: "Microsoft.Compute/virtualMachines" 또는 "Microsoft.Storage/storageAccounts"

ReportStatus

상태 보고.

Name	형식	Description
Active	string
Disabled	string
Failed	string

ResourceMetadata

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

Name	형식	Description
resourceId	string	리소스 ID - 예: "/subscriptions/00000000-0000-0000-0000-00000000000/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/vm1".
resourceKind	string	리소스 종류입니다.
resourceName	string	리소스 이름입니다.
resourceType	string	리소스 종류.
tags	object	리소스의 태그 유형입니다.

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

샘플 요청

샘플 응답

정의

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

OverviewStatus

provisioningState

ReportComplianceStatus

ReportProperties

ReportResource

ReportStatus

ResourceMetadata

systemData

추가 리소스