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	レポート名。正規表現パターン: `^[-a-zA-Z0-9_]{1,50}$`
api-version	query	True	string	この操作に使用する API バージョン。

reportName

path

True

string

レポート名。

正規表現パターン: ^[-a-zA-Z0-9_]{1,50}$

api-version

query

True

string

この操作に使用する API バージョン。

応答

名前	型	説明
200 OK	ReportResource	Azure 操作は正常に完了しました。
Other Status Codes	ErrorResponse	予期しないエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 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	リソースを作成した ID の種類。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
OverviewStatus	1 つのレポートのコンプライアンス結果の概要。
ProvisioningState	リソースプロビジョニングの状態。
ReportComplianceStatus	1 つのレポートのすべてのコンプライアンス結果を含むリスト。
ReportResource	クラスは AppComplianceAutomation レポートリソースを表します。
ReportStatus	レポートの状態。
ResourceMetadata	単一リソース ID のメタデータ。
ResourceOrigin	リソースの配信元。
StorageInfo	レポートへの "Bring Your Own Storage" アカウントバインドの情報
systemData	リソースの作成と最後の変更に関連するメタデータ。

CertSyncRecord

クラスは、アプリのコンプライアンスから同期された認定レコードを表します。

名前	型	説明
certificationStatus	string	認定プロセスの状態を示します。
controls	ControlSyncRecord[]	同期するコントロールレコードの一覧。
ingestionStatus	string	コンプライアンスプロセスの状態を示します。
offerGuid	string	レポートにマッピングする offerGuid。

ControlSyncRecord

クラスは、アプリのコンプライアンスから同期されたコントロールレコードを表します。

名前	型	説明
controlId	string	コントロールの ID。例: "Operational_Security_10"
controlStatus	string	アプリのコンプライアンスから同期された状態を制御します。

createdByType

リソースを作成した ID の種類。

名前	型	説明
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーコード。
details	ErrorDetail[]	エラーの詳細。
message	string	エラーメッセージ。
target	string	エラーターゲット。

ErrorResponse

エラー応答

名前	型	説明
error	ErrorDetail	エラーオブジェクト。

OverviewStatus

1 つのレポートのコンプライアンス結果の概要。

名前	型	説明
failedCount	integer	失敗したすべてのコントロールの数。
manualCount	integer	すべての手動コントロールの数。
notApplicableCount	integer	適用できないすべてのコントロールの数。
passedCount	integer	渡されたすべてのコントロールの数。
pendingCount	integer	承認コントロールのすべての保留中の数。

ProvisioningState

リソースプロビジョニングの状態。

名前	型	説明
Canceled	string	プロビジョニングは取り消されます。
Creating	string	作成が進行中です。
Deleting	string	削除が進行中です。
Failed	string	プロビジョニングに失敗しました。
Fixing	string	進行中のリソースの修正。
Succeeded	string	プロビジョニングは成功しました。
Updating	string	進行中のリソースの更新。
Verifying	string	進行中のリソースの検証。

ReportComplianceStatus

1 つのレポートのすべてのコンプライアンス結果を含むリスト。

名前	型	説明
m365	OverviewStatus	Microsoft 365 認定名。

ReportResource

クラスは AppComplianceAutomation レポートリソースを表します。

名前	型	説明
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-0000-00000000001,00000000-00000-0000-0000 0000-0000000000002" と "000000000-0000-0000-0000-0000000000003"
properties.provisioningState	ProvisioningState	Azure ライフサイクル管理
properties.resources	ResourceMetadata[]	リソースデータの一覧。
properties.status	ReportStatus	レポートの状態。
properties.storageInfo	StorageInfo	レポートへの "Bring Your Own Storage" バインドの情報
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

レポートの状態。

名前	型	説明
Active	string	レポートがアクティブです。
Disabled	string	レポートは無効になっています。
Failed	string	レポートが失敗しました。
Reviewing	string	レポートはレビュー中です。

ResourceMetadata

単一リソース ID のメタデータ。

名前	型	説明
accountId	string	アカウント ID。たとえば、AWS アカウント ID です。
resourceId	string	リソース ID - "/subscriptions/00000000-0000-0000-0000-00000000000/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/vm1" などです。
resourceKind	string	リソースの種類。
resourceOrigin	ResourceOrigin	リソースの配信元。
resourceType	string	リソースの種類。例: "Microsoft.Compute/virtualMachines"

ResourceOrigin

リソースの配信元。

名前	型	説明
AWS	string	リソースは AWS からのリソースです。
Azure	string	リソースは Azure からのリソースです。
GCP	string	リソースは GCP からのリソースです。

StorageInfo

レポートへの "Bring Your Own Storage" アカウントバインドの情報

名前	型	説明
accountName	string	"Bring Your Own Storage" アカウント名
location	string	"Bring Your Own Storage" アカウントのリージョン
resourceGroup	string	"独自のストレージを持ち込む" アカウントが属する resourceGroup
subscriptionId	string	"Bring Your Own Storage" アカウントが属するサブスクリプション ID

systemData

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
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

その他のリソース