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

名稱位於必要類型 Description

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

回應

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

範圍

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

定義

名稱	Description
createdByType	建立資源的身分識別類型。
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應
OverviewStatus	一份報告的合規性結果概觀。
provisioningState	Azure 生命週期管理
ReportComplianceStatus	清單，其中包含一份報表的所有合規性結果。
ReportProperties	報表的屬性。
ReportResource	類別代表 AppComplianceAutomation 報表資源。
ReportStatus	報告狀態。
ResourceMetadata	單一資源識別碼的元數據。
systemData	與建立和上次修改資源相關的元數據。

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	錯誤物件。

OverviewStatus

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

名稱	類型	Description
failedCount	integer	所有失敗的完整自動化控制計數。
manualCount	integer	所有手動控件的計數。
passedCount	integer	所有傳遞的完整自動化控制項計數。

provisioningState

Azure 生命週期管理

名稱	類型	Description
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

ReportComplianceStatus

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

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

ReportProperties

報表的屬性。

名稱	類型	Description
complianceStatus	ReportComplianceStatus	報告合規性狀態。
id	string	資料庫中的報表標識碼。
lastTriggerTime	string	報告上次收集觸發程序時間。
nextTriggerTime	string	報告下一個集合觸發程序時間。
offerGuid	string	報表供應專案 Guid。
provisioningState	provisioningState	Azure 生命週期管理
reportName	string	報表名稱。
resources	ResourceMetadata[]	資源數據的清單。
status	ReportStatus	報告狀態。
subscriptions	string[]	訂用帳戶標識碼的清單。
tenantId	string	報表的租用戶標識碼。
timeZone	string	報表集合觸發時間的時區，可以在 PowerShell 中執行「Get-TimeZone -ListAvailable」來取得可用的清單。有效時區標識碼的範例是“Pacific Standard Time”。
triggerTime	string	報表集合觸發程序時間。

ReportResource

類別代表 AppComplianceAutomation 報表資源。

名稱	類型	Description
id	string	資源的完整資源識別碼。例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	資源的名稱
properties	ReportProperties	報表屬性。
systemData	systemData	Azure Resource Manager 包含 createdBy 和 modifiedBy 資訊的中繼資料。
type	string	資源類型。例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”

ReportStatus

報告狀態。

名稱	類型	Description
Active	string
Disabled	string
Failed	string

ResourceMetadata

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

名稱	類型	Description
resourceId	string	資源標識符 - 例如 “/subscriptions/00000000-0000-0000-0000-0000000000000000/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/vm1”。
resourceKind	string	資源種類。
resourceName	string	資源名稱。
resourceType	string	資源類型。
tags	object	資源的標籤。

systemData

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

名稱	類型	Description
createdAt	string	資源建立的時間戳 (UTC) 。
createdBy	string	建立資源的身分識別。
createdByType	createdByType	建立資源的身分識別類型。
lastModifiedAt	string	上次修改的資源時間戳 (UTC)
lastModifiedBy	string	上次修改資源的身分識別。
lastModifiedByType	createdByType	上次修改資源的身分識別類型。

共用方式為

Report - Get

URI 參數

回應

安全性

azure_auth

範圍

範例

Report_Get

範例要求

範例回覆

定義

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

OverviewStatus

provisioningState

ReportComplianceStatus

ReportProperties

ReportResource

ReportStatus

ResourceMetadata

systemData

其他資源