Report - Get

Service:

App Compliance Automation

API Version:

2024-06-27

Get the AppComplianceAutomation report and its properties.

GET https://management.azure.com/providers/Microsoft.AppComplianceAutomation/reports/{reportName}?api-version=2024-06-27

URI Parameters

Name	In	Required	Type	Description
reportName	path	True	string	Report Name. Regex pattern: ^[-a-zA-Z0-9_]{1,50}$
api-version	query	True	string	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	ReportResource	Azure operation completed successfully.
Other Status Codes	ErrorResponse	An unexpected error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Report_Get

Sample request

HTTP

GET https://management.azure.com/providers/Microsoft.AppComplianceAutomation/reports/testReport?api-version=2024-06-27

Python

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

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/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

JavaScript

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

dotnet

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

Sample response

Status code:

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

Definitions

Name	Description
CertSyncRecord	A class represent the certification record synchronized from app compliance.
ControlSyncRecord	A class represent the control record synchronized from app compliance.
createdByType	The type of identity that created the resource.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
OverviewStatus	The overview of the compliance result for one report.
ProvisioningState	Resource provisioning states.
ReportComplianceStatus	A list which includes all the compliance result for one report.
ReportResource	A class represent an AppComplianceAutomation report resource.
ReportStatus	Report status.
ResourceMetadata	Single resource Id's metadata.
ResourceOrigin	Resource Origin.
StorageInfo	The information of 'bring your own storage' account binding to the report
systemData	Metadata pertaining to creation and last modification of the resource.

CertSyncRecord

A class represent the certification record synchronized from app compliance.

Name	Type	Description
certificationStatus	string	Indicates the status of certification process.
controls	ControlSyncRecord[]	The control records list to be synchronized.
ingestionStatus	string	Indicates the status of compliance process.
offerGuid	string	The offerGuid which mapping to the reports.

ControlSyncRecord

A class represent the control record synchronized from app compliance.

Name	Type	Description
controlId	string	The Id of the control. e.g. "Operational_Security_10"
controlStatus	string	Control status synchronized from app compliance.

createdByType

The type of identity that created the resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.

OverviewStatus

The overview of the compliance result for one report.

Name	Type	Description
failedCount	integer	The count of all failed control.
manualCount	integer	The count of all manual control.
notApplicableCount	integer	The count of all not applicable control.
passedCount	integer	The count of all passed control.
pendingCount	integer	The count of all pending for approval control.

ProvisioningState

Resource provisioning states.

Name	Type	Description
Canceled	string	The provision is canceled.
Creating	string	The creation is in progress.
Deleting	string	The deletion is in progress.
Failed	string	The provision is failed.
Fixing	string	The fix of the resource in progress.
Succeeded	string	The provision is succeeded.
Updating	string	The update of the resource in progress.
Verifying	string	The verification of the resource in progress.

ReportComplianceStatus

A list which includes all the compliance result for one report.

Name	Type	Description
m365	OverviewStatus	The Microsoft 365 certification name.

ReportResource

A class represent an AppComplianceAutomation report resource.

Name	Type	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	The name of the resource
properties.certRecords	CertSyncRecord[]	List of synchronized certification records.
properties.complianceStatus	ReportComplianceStatus	Report compliance status.
properties.errors	string[]	List of report error codes.
properties.lastTriggerTime	string	Report last collection trigger time.
properties.nextTriggerTime	string	Report next collection trigger time.
properties.offerGuid	string	A list of comma-separated offerGuids indicates a series of offerGuids that map to the report. For example, "00000000-0000-0000-0000-000000000001,00000000-0000-0000-0000-000000000002" and "00000000-0000-0000-0000-000000000003".
properties.provisioningState	ProvisioningState	Azure lifecycle management
properties.resources	ResourceMetadata[]	List of resource data.
properties.status	ReportStatus	Report status.
properties.storageInfo	StorageInfo	The information of 'bring your own storage' binding to the report
properties.subscriptions	string[]	List of subscription Ids.
properties.tenantId	string	Report's tenant id.
properties.timeZone	string	Report collection trigger time's time zone, the available list can be obtained by executing "Get-TimeZone -ListAvailable" in PowerShell. An example of valid timezone id is "Pacific Standard Time".
properties.triggerTime	string	Report collection trigger time.
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

ReportStatus

Report status.

Name	Type	Description
Active	string	The report is active.
Disabled	string	The report is disabled.
Failed	string	The report is failed.
Reviewing	string	The report is under reviewing.

ResourceMetadata

Single resource Id's metadata.

Name	Type	Description
accountId	string	Account Id. For example - the AWS account id.
resourceId	string	Resource Id - e.g. "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/vm1".
resourceKind	string	Resource kind.
resourceOrigin	ResourceOrigin	Resource Origin.
resourceType	string	Resource type. e.g. "Microsoft.Compute/virtualMachines"

ResourceOrigin

Resource Origin.

Name	Type	Description
AWS	string	The resource is from AWS.
Azure	string	The resource is from Azure.
GCP	string	The resource is from GCP.

StorageInfo

The information of 'bring your own storage' account binding to the report

Name	Type	Description
accountName	string	'bring your own storage' account name
location	string	The region of 'bring your own storage' account
resourceGroup	string	The resourceGroup which 'bring your own storage' account belongs to
subscriptionId	string	The subscription id which 'bring your own storage' account belongs to

systemData

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.