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 パラメーター

名前	/	必須	型	説明
reportName	path	True	string	レポート名。 正規表現パターン: ^[-a-zA-Z0-9_]+$
api-version	query	True	string	この操作に使用する API バージョン。

応答

名前	型	説明
200 OK	ReportResource	正常終了しました。
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

要求のサンプル

HTTP

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

Java

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

Python

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

Go

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

dotnet

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

定義

名前	説明
createdByType	リソースを作成した ID の種類。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
OverviewStatus	1 つのレポートのコンプライアンス結果の概要。
provisioningState	Azure ライフサイクル管理
ReportComplianceStatus	1 つのレポートのすべてのコンプライアンス結果を含むリスト。
ReportProperties	レポートのプロパティ。
ReportResource	クラスは AppComplianceAutomation レポート リソースを表します。
ReportStatus	ステータスを報告する。
ResourceMetadata	単一リソース ID のメタデータ。
systemData	リソースの作成と最後の変更に関連するメタデータ。

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	error オブジェクト。

OverviewStatus

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

名前	型	説明
failedCount	integer	失敗したすべての完全自動化コントロールの数。
manualCount	integer	すべての手動コントロールの数。
passedCount	integer	渡されたすべての完全オートメーション コントロールの数。

provisioningState

Azure ライフサイクル管理

名前	型	説明
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

ReportComplianceStatus

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

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

ReportProperties

レポートのプロパティ。

名前	型	説明
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 レポート リソースを表します。

名前	型	説明
id	string	リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	リソースの名前
properties	ReportProperties	Report プロパティ。
systemData	systemData	createdBy および modifiedBy 情報を含む Azure Resource Manager メタデータ。
type	string	リソースの型。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

ReportStatus

ステータスを報告する。

名前	型	説明
Active	string
Disabled	string
Failed	string

ResourceMetadata

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

名前	型	説明
resourceId	string	リソース ID - "/subscriptions/0000000-0000-0000-0000-0000000000000/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/vm1" などです。
resourceKind	string	リソースの種類。
resourceName	string	リソース名。
resourceType	string	リソースの種類。
tags	object	リソースのタグの種類。

systemData

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

名前	型	説明
createdAt	string	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。