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 參數

名稱位於必要類型 Description

名稱	位於	必要	類型	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 版本。

回應

名稱	類型	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

範圍

名稱	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"
  }
}

定義

名稱	Description
CertSyncRecord	類別代表從應用程式合規性同步處理的認證記錄。
ControlSyncRecord	類別代表從應用程式合規性同步處理的控件記錄。
createdByType	建立資源的身分識別類型。
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應
OverviewStatus	一份報告的合規性結果概觀。
ProvisioningState	資源布建狀態。
ReportComplianceStatus	清單，其中包含一份報表的所有合規性結果。
ReportResource	類別代表 AppComplianceAutomation 報表資源。
ReportStatus	報告狀態。
ResourceMetadata	單一資源識別碼的元數據。
ResourceOrigin	資源來源。
StorageInfo	「攜帶您自己的記憶體」帳戶系結至報表的資訊
systemData	與建立和上次修改資源相關的元數據。

CertSyncRecord

類別代表從應用程式合規性同步處理的認證記錄。

名稱	類型	Description
certificationStatus	string	指出認證程序的狀態。
controls	ControlSyncRecord[]	要同步處理的控件記錄清單。
ingestionStatus	string	表示合規性程序的狀態。
offerGuid	string	會對應至報表的 offerGuid。

ControlSyncRecord

類別代表從應用程式合規性同步處理的控件記錄。

名稱	類型	Description
controlId	string	控件的標識碼。例如“Operational_Security_10”
controlStatus	string	從應用程式合規性同步控制狀態。

createdByType

建立資源的身分識別類型。

名稱	類型	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

ErrorDetail

錯誤詳細數據。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳細數據。
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponse

錯誤回應

名稱	類型	Description
error	ErrorDetail	error 物件。

OverviewStatus

一份報告的合規性結果概觀。

名稱	類型	Description
failedCount	integer	所有失敗控制件的計數。
manualCount	integer	所有手動控件的計數。
notApplicableCount	integer	所有不適用控件的計數。
passedCount	integer	所有傳遞控件的計數。
pendingCount	integer	所有擱置的核准控制計數。

ProvisioningState

資源布建狀態。

名稱	類型	Description
Canceled	string	已取消布建。
Creating	string	建立正在進行中。
Deleting	string	刪除正在進行中。
Failed	string	布建失敗。
Fixing	string	資源進行中的修正。
Succeeded	string	布建成功。
Updating	string	進行中的資源更新。
Verifying	string	進行中資源的驗證。

ReportComplianceStatus

清單，其中包含一份報表的所有合規性結果。

名稱	類型	Description
m365	OverviewStatus	Microsoft 365 認證名稱。

ReportResource

類別代表 AppComplianceAutomation 報表資源。

名稱	類型	Description
id	string	資源的完整資源標識碼。例如 - /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。例如，“0000000-0000-0000-0000-0000000000001,00000000-00000-00000-0000-0000000000002” 和 “00000000-0000-0000-00000-000000000003”。
properties.provisioningState	ProvisioningState	Azure 生命週期管理
properties.resources	ResourceMetadata[]	資源數據的清單。
properties.status	ReportStatus	報告狀態。
properties.storageInfo	StorageInfo	「攜帶您自己的記憶體」系結至報表的資訊
properties.subscriptions	string[]	訂用帳戶標識碼清單。
properties.tenantId	string	報表的租用戶標識碼。
properties.timeZone	string	報表集合觸發時間的時區，可以在 PowerShell 中執行「Get-TimeZone -ListAvailable」來取得可用的清單。有效的時區標識符範例是「Pacific Standard Time」。。
properties.triggerTime	string	報表集合觸發時間。
systemData	systemData	包含 createdBy 和 modifiedBy 資訊的 Azure Resource Manager 元數據。
type	string	資源的型別。例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”

ReportStatus

報告狀態。

名稱	類型	Description
Active	string	報表為使用中。
Disabled	string	報表已停用。
Failed	string	報表失敗。
Reviewing	string	報告正在審查中。

ResourceMetadata

單一資源識別碼的元數據。

名稱	類型	Description
accountId	string	帳戶標識碼。例如 - AWS 帳戶識別碼。
resourceId	string	資源標識符 - 例如 “/subscriptions/00000000-0000-0000-0000-00000000000000/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/vm1”。
resourceKind	string	資源種類。
resourceOrigin	ResourceOrigin	資源來源。
resourceType	string	資源類型。例如“Microsoft.Compute/virtualMachines”

ResourceOrigin

資源來源。

名稱	類型	Description
AWS	string	資源來自 AWS。
Azure	string	資源來自 Azure。
GCP	string	資源來自 GCP。

StorageInfo

「攜帶您自己的記憶體」帳戶系結至報表的資訊

名稱	類型	Description
accountName	string	「攜帶您自己的記憶體」帳戶名稱
location	string	「攜帶您自己的記憶體」帳戶的區域
resourceGroup	string	「攜帶您自己的記憶體」帳戶所屬的 resourceGroup
subscriptionId	string	「攜帶您自己的記憶體」帳戶所屬的訂用帳戶標識碼

systemData

與建立和上次修改資源相關的元數據。

名稱	類型	Description
createdAt	string	資源建立的時間戳（UTC）。
createdBy	string	建立資源的身分識別。
createdByType	createdByType	建立資源的身分識別類型。
lastModifiedAt	string	上次修改的資源時間戳（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

其他資源