Report - Get

Referenz

Dienst:: App Compliance Automation

API-Version:: 2024-06-27

Rufen Sie den AppComplianceAutomation-Bericht und dessen Eigenschaften ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
reportName	path	True	string pattern: ^[-a-zA-Z0-9_]{1,50}$	Berichtsname.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	ReportResource	Der Azure-Vorgang wurde erfolgreich abgeschlossen.
Other Status Codes	ErrorResponse	Unerwartete Fehlerantwort.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

Report_Get

Beispielanforderung

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

Beispiel für eine Antwort

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

Definitionen

Name	Beschreibung
CertSyncRecord	Eine Klasse stellt den von der App-Compliance synchronisierten Zertifizierungseintrag dar.
ControlSyncRecord	Eine Klasse stellt den steuerelementdatensatz dar, der aus der App-Compliance synchronisiert wird.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
OverviewStatus	Die Übersicht über das Complianceergebnis für einen Bericht.
ProvisioningState	Ressourcenbereitstellungsstatus.
ReportComplianceStatus	Eine Liste, die das gesamte Complianceergebnis für einen Bericht enthält.
ReportResource	Eine Klasse stellt eine AppComplianceAutomation-Berichtsressource dar.
ReportStatus	Berichtsstatus.
ResourceMetadata	Metadaten der einzelnen Ressourcen-ID.
ResourceOrigin	Ressourcenursprung.
StorageInfo	Die Informationen zur Bindung ihres eigenen Speicherkontos an den Bericht
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.

CertSyncRecord

Objekt

Eine Klasse stellt den von der App-Compliance synchronisierten Zertifizierungseintrag dar.

Name	Typ	Beschreibung
certificationStatus	string	Gibt den Status des Zertifizierungsprozesses an.
controls	ControlSyncRecord[]	Die Zu synchronisierende Steuerelementdatensätzeliste.
ingestionStatus	string	Gibt den Status des Complianceprozesses an.
offerGuid	string minLength: 1	Das offerGuid, das den Berichten zugeordnet ist.

ControlSyncRecord

Objekt

Eine Klasse stellt den steuerelementdatensatz dar, der aus der App-Compliance synchronisiert wird.

Name	Typ	Beschreibung
controlId	string	Die ID des Steuerelements. z. B. "Operational_Security_10"
controlStatus	string	Steuern des Status, der aus der App-Compliance synchronisiert wird.

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

OverviewStatus

Objekt

Die Übersicht über das Complianceergebnis für einen Bericht.

Name	Typ	Beschreibung
failedCount	integer (int32)	Die Anzahl aller fehlgeschlagenen Steuerelemente.
manualCount	integer (int32)	Die Anzahl aller manuellen Steuerelemente.
notApplicableCount	integer (int32)	Die Anzahl aller nicht anwendbaren Steuerelemente.
passedCount	integer (int32)	Die Anzahl aller übergebenen Steuerelemente.
pendingCount	integer (int32)	Die Anzahl aller ausstehenden Genehmigungssteuerelemente.

ProvisioningState

Enumeration

Ressourcenbereitstellungsstatus.

Wert	Beschreibung
Canceled	Die Bereitstellung wird abgebrochen.
Creating	Die Erstellung wird ausgeführt.
Deleting	Der Löschvorgang wird ausgeführt.
Failed	Fehler bei der Bereitstellung.
Fixing	Der Fix der ausgeführten Ressource.
Succeeded	Die Bereitstellung ist erfolgreich.
Updating	Die Aktualisierung der ausgeführten Ressource.
Verifying	Die Überprüfung der ausgeführten Ressource.

ReportComplianceStatus

Objekt

Eine Liste, die das gesamte Complianceergebnis für einen Bericht enthält.

Name	Typ	Beschreibung
m365	OverviewStatus	Der Microsoft 365-Zertifizierungsname.

ReportResource

Objekt

Eine Klasse stellt eine AppComplianceAutomation-Berichtsressource dar.

Name	Typ	Beschreibung
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Der Name der Ressource
properties.certRecords	CertSyncRecord[]	Liste der synchronisierten Zertifizierungsdatensätze.
properties.complianceStatus	ReportComplianceStatus	Melden des Compliancestatus.
properties.errors	string[]	Liste der Fehlercodes des Berichts.
properties.lastTriggerTime	string (date-time)	Zeitpunkt des letzten Berichtssammlungsauslöser.
properties.nextTriggerTime	string (date-time)	Melden Sie die nächste Sammlungstriggerzeit.
properties.offerGuid	string	Eine Liste von durch Kommas getrennten offerGuids gibt eine Reihe von offerGuids an, die dem Bericht zugeordnet sind. Beispiel: "00000000-0000-0000-0000-000000000001.00000000-0000-000000-00000 -0000-00000000002" und "00000000-0000-0000-0000-00000000003".
properties.provisioningState	ProvisioningState	Azure-Lebenszyklusverwaltung
properties.resources	ResourceMetadata[]	Liste der Ressourcendaten.
properties.status	ReportStatus	Berichtsstatus.
properties.storageInfo	StorageInfo	Die Informationen zur Bindung von "Eigenem Speicher" an den Bericht
properties.subscriptions	string[]	Liste der Abonnement-IDs.
properties.tenantId	string	Mandanten-ID des Berichts.
properties.timeZone	string	Die Zeitzone der Berichtssammlung löst die Zeitzone aus, die verfügbare Liste kann durch Ausführen von "Get-TimeZone -ListAvailable" in PowerShell abgerufen werden. Ein Beispiel für gültige Zeitzonen-ID ist "Pacific Standard Time".
properties.triggerTime	string (date-time)	Berichtssammlungstriggerzeit.
systemData	systemData	Azure Resource Manager-Metadaten, die createdBy- und modifiedBy-Informationen enthalten.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

ReportStatus

Enumeration

Berichtsstatus.

Wert	Beschreibung
Active	Der Bericht ist aktiv.
Disabled	Der Bericht ist deaktiviert.
Failed	Der Bericht ist fehlgeschlagen.
Reviewing	Der Bericht wird überprüft.

ResourceMetadata

Objekt

Metadaten der einzelnen Ressourcen-ID.

Name	Typ	Beschreibung
accountId	string	Konto-ID. Beispiel: die AWS-Konto-ID.
resourceId	string	Ressourcen-ID – z. B. "/subscriptions/0000000-0000-0000-0000-00000000000/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/vm1".
resourceKind	string	Ressourcentyp.
resourceOrigin	ResourceOrigin	Ressourcenursprung.
resourceType	string	Ressourcentyp. z. B. "Microsoft.Compute/virtualMachines"

ResourceOrigin

Enumeration

Ressourcenursprung.

Wert	Beschreibung
AWS	Die Ressource stammt aus AWS.
Azure	Die Ressource stammt aus Azure.
GCP	Die Ressource stammt aus GCP.

StorageInfo

Objekt

Die Informationen zur Bindung ihres eigenen Speicherkontos an den Bericht

Name	Typ	Beschreibung
accountName	string	Kontoname "Eigenen Speicher mitbringen"
location	string	Die Region "Bring your own storage" account
resourceGroup	string	Die resourceGroup, zu der das Konto "Eigenen Speicher bringen" gehört
subscriptionId	string	Die Abonnement-ID, zu der ihr eigenes Speicherkonto gehört

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.

Freigeben über

Report - Get

URI-Parameter

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

Report_Get

Beispielanforderung

Beispiel für eine Antwort

Definitionen

CertSyncRecord

ControlSyncRecord

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

OverviewStatus

ProvisioningState

ReportComplianceStatus

ReportResource

ReportStatus

ResourceMetadata

ResourceOrigin

StorageInfo

systemData

Zusätzliche Ressourcen