Reports - List

Reference

Service:: App Compliance Automation

API Version:: 2022-11-16-preview

Get the AppComplianceAutomation report list for the tenant.

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

With optional parameters:

GET https://management.azure.com/providers/Microsoft.AppComplianceAutomation/reports?api-version=2022-11-16-preview&$skipToken={$skipToken}&$top={$top}&$select={$select}&offerGuid={offerGuid}&reportCreatorTenantId={reportCreatorTenantId}

URI Parameters

Name	In	Required	Type	Description
api-version	query	True	string	The API version to use for this operation.
$select	query		string	OData Select statement. Limits the properties on each entry to just those requested, e.g. ?$select=reportName,id.
$skipToken	query		string	Skip over when retrieving results.
$top	query		integer int32	Number of elements to return when retrieving results.
offerGuid	query		string	The offerGuid which mapping to the reports.
reportCreatorTenantId	query		string	The tenant id of the report creator.

Responses

Name	Type	Description
200 OK	ReportResourceList	Success.
Other Status Codes	ErrorResponse	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

Reports_List

Sample Request

GET https://management.azure.com/providers/Microsoft.AppComplianceAutomation/reports?api-version=2022-11-16-preview&$skipToken=1&$top=100&offerGuid=00000000-0000-0000-0000-000000000000&reportCreatorTenantId=00000000-0000-0000-0000-000000000000

import com.azure.core.util.Context;

/** Samples for Reports List. */
public final class Main {
    /*
     * x-ms-original-file: specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/preview/2022-11-16-preview/examples/Reports_List.json
     */
    /**
     * Sample code: Reports_List.
     *
     * @param manager Entry point to AppComplianceAutomationManager.
     */
    public static void reportsList(
        com.azure.resourcemanager.appcomplianceautomation.AppComplianceAutomationManager manager) {
        manager
            .reports()
            .list(
                "1",
                100,
                null,
                "00000000-0000-0000-0000-000000000000",
                "00000000-0000-0000-0000-000000000000",
                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 reports_list.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.reports.list()
    for item in response:
        print(item)


# x-ms-original-file: specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/preview/2022-11-16-preview/examples/Reports_List.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/azcore/to"
	"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/Reports_List.json
func ExampleReportsClient_NewListPager() {
	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)
	}
	pager := clientFactory.NewReportsClient().NewListPager(&armappcomplianceautomation.ReportsClientListOptions{SkipToken: to.Ptr("1"),
		Top:                   to.Ptr[int32](100),
		Select:                nil,
		OfferGUID:             to.Ptr("00000000-0000-0000-0000-000000000000"),
		ReportCreatorTenantID: to.Ptr("00000000-0000-0000-0000-000000000000"),
	})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ReportResourceList = armappcomplianceautomation.ReportResourceList{
		// 	Value: []*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/Reports_List.json
// this example is just showing the usage of "Reports_List" 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 TenantResource created on azure
// for more information of creating TenantResource, please refer to the document of TenantResource
var tenantResource = client.GetTenants().GetAllAsync().GetAsyncEnumerator().Current;

// get the collection of this ReportResource
ReportResourceCollection collection = tenantResource.GetReportResources();

// invoke the operation and iterate over the result
string skipToken = "1";
int? top = 100;
string offerGuid = "00000000-0000-0000-0000-000000000000";
string reportCreatorTenantId = "00000000-0000-0000-0000-000000000000";
await foreach (ReportResource item in collection.GetAllAsync(skipToken: skipToken, top: top, offerGuid: offerGuid, reportCreatorTenantId: reportCreatorTenantId))
{
    // the variable item 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 = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine($"Succeeded");

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

{
  "value": [
    {
      "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"
      }
    }
  ],
  "nextLink": "https://management.azure.com/providers/Microsoft.AppComplianceAutomation/reports?api-version=2022-11-16-preview&skipToken=1&top=100"
}

Definitions

Name	Description
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	Azure lifecycle management
ReportComplianceStatus	A list which includes all the compliance result for one report.
ReportProperties	Report's properties.
ReportResource	A class represent an AppComplianceAutomation report resource.
ReportResourceList	Object that includes an array of resources and a possible link for next set.
ReportStatus	Report status.
ResourceMetadata	Single resource Id's metadata.
systemData	Metadata pertaining to creation and last modification of the resource.

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 full automation control.
manualCount	integer	The count of all manual control.
passedCount	integer	The count of all passed full automation control.

provisioningState

Azure lifecycle management

Name	Type	Description
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

ReportComplianceStatus

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

Name	Type	Description
m365	OverviewStatus	The Microsoft 365 certification name.

ReportProperties

Report's properties.

Name	Type	Description
complianceStatus	ReportComplianceStatus	Report compliance status.
id	string	Report id in database.
lastTriggerTime	string	Report last collection trigger time.
nextTriggerTime	string	Report next collection trigger time.
offerGuid	string	Report offer Guid.
provisioningState	provisioningState	Azure lifecycle management
reportName	string	Report name.
resources	ResourceMetadata[]	List of resource data.
status	ReportStatus	Report status.
subscriptions	string[]	List of subscription Ids.
tenantId	string	Report's tenant id.
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".
triggerTime	string	Report collection trigger time.

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	ReportProperties	Report property.
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"

ReportResourceList

Object that includes an array of resources and a possible link for next set.

Name	Type	Description
nextLink	string	The URL the client should use to fetch the next page (per server side paging). It's null for now, added for future use.
value	ReportResource[]	List of the reports

ReportStatus

Report status.

Name	Type	Description
Active	string
Disabled	string
Failed	string

ResourceMetadata

Single resource Id's metadata.

Name	Type	Description
resourceId	string	Resource Id - e.g. "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/vm1".
resourceKind	string	Resource kind.
resourceName	string	Resource name.
resourceType	string	Resource type.
tags	object	Resource's tag type.

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.

Reports - List

URI Parameters

Responses

Security

azure_auth

Scopes

Examples

Reports_List

Sample Request

Sample Response

Definitions

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

OverviewStatus

provisioningState

ReportComplianceStatus

ReportProperties

ReportResource

ReportResourceList

ReportStatus

ResourceMetadata

systemData

Additional resources