Report - Get

Serviço:

App Compliance Automation

Versão da API:

2024-06-27

Obtenha o relatório AppComplianceAutomation e suas propriedades.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
reportName	path	True	string	Nome do relatório. Padrão Regex: ^[-a-zA-Z0-9_]{1,50}$
api-version	query	True	string	A versão da API a ser usada para esta operação.

Respostas

Nome	Tipo	Description
200 OK	ReportResource	A operação do Azure foi concluída com êxito.
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

Report_Get

Solicitação de exemplo

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

Resposta de exemplo

Código de status:

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

Definições

Nome	Description
CertSyncRecord	Uma classe representa o registro de certificação sincronizado com a conformidade do aplicativo.
ControlSyncRecord	Uma classe representa o registro de controle sincronizado com a conformidade do aplicativo.
createdByType	O tipo de identidade que criou o recurso.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
OverviewStatus	A visão geral do resultado da conformidade de um relatório.
ProvisioningState	Estados de provisionamento de recursos.
ReportComplianceStatus	Uma lista que inclui todo o resultado de conformidade de um relatório.
ReportResource	Uma classe representa um recurso de relatório AppComplianceAutomation.
ReportStatus	Status do relatório.
ResourceMetadata	Metadados da ID de recurso único.
ResourceOrigin	Origem do recurso.
StorageInfo	As informações da associação de conta 'traga seu próprio armazenamento' para o relatório
systemData	Metadados relativos à criação e última modificação do recurso.

CertSyncRecord

Uma classe representa o registro de certificação sincronizado com a conformidade do aplicativo.

Nome	Tipo	Description
certificationStatus	string	Indica o status do processo de certificação.
controls	ControlSyncRecord[]	A lista de registros de controle a ser sincronizada.
ingestionStatus	string	Indica o status do processo de conformidade.
offerGuid	string	O offerGuid que mapeia para os relatórios.

ControlSyncRecord

Uma classe representa o registro de controle sincronizado com a conformidade do aplicativo.

Nome	Tipo	Description
controlId	string	A ID do controle. por exemplo, "Operational_Security_10"
controlStatus	string	Controlar o status sincronizado com a conformidade do aplicativo.

createdByType

O tipo de identidade que criou o recurso.

Nome	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

OverviewStatus

A visão geral do resultado da conformidade de um relatório.

Nome	Tipo	Description
failedCount	integer	A contagem de todo o controle com falha.
manualCount	integer	A contagem de todo o controle manual.
notApplicableCount	integer	A contagem de todos os controles não aplicáveis.
passedCount	integer	A contagem de todo o controle passado.
pendingCount	integer	A contagem de todos os pendentes para controle de aprovação.

ProvisioningState

Estados de provisionamento de recursos.

Nome	Tipo	Description
Canceled	string	O provisionamento é cancelado.
Creating	string	A criação está em andamento.
Deleting	string	A exclusão está em andamento.
Failed	string	Falha na provisionamento.
Fixing	string	A correção do recurso em andamento.
Succeeded	string	A provisionamento foi bem-sucedida.
Updating	string	A atualização do recurso em andamento.
Verifying	string	A verificação do recurso em andamento.

ReportComplianceStatus

Uma lista que inclui todo o resultado de conformidade de um relatório.

Nome	Tipo	Description
m365	OverviewStatus	O nome da certificação do Microsoft 365.

ReportResource

Uma classe representa um recurso de relatório AppComplianceAutomation.

Nome	Tipo	Description
id	string	ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	O nome do recurso
properties.certRecords	CertSyncRecord[]	Lista de registros de certificação sincronizados.
properties.complianceStatus	ReportComplianceStatus	Relatar o status de conformidade.
properties.errors	string[]	Lista de códigos de erro de relatório.
properties.lastTriggerTime	string	Relatar a hora do gatilho da última coleção.
properties.nextTriggerTime	string	Relatar a hora do gatilho da próxima coleção.
properties.offerGuid	string	Uma lista de offerGuids separados por vírgulas indica uma série de offerGuids mapeados para o relatório. Por exemplo, "00000000-0000-0000-0000-000000000001,000000000-0000-0000-0000-0000-000000000002" e "000000000-0000-0000-0000-00000000003".
properties.provisioningState	ProvisioningState	Gerenciamento do ciclo de vida do Azure
properties.resources	ResourceMetadata[]	Lista de dados de recursos.
properties.status	ReportStatus	Status do relatório.
properties.storageInfo	StorageInfo	As informações da associação 'traga seu próprio armazenamento' para o relatório
properties.subscriptions	string[]	Lista de IDs de assinatura.
properties.tenantId	string	ID do locatário do relatório.
properties.timeZone	string	O fuso horário do gatilho de coleta de relatórios, a lista disponível pode ser obtida executando "Get-TimeZone -ListAvailable" no PowerShell. Um exemplo de ID de fuso horário válida é "Horário Padrão do Pacífico".
properties.triggerTime	string	Hora do gatilho da coleção de relatórios.
systemData	systemData	Metadados do Azure Resource Manager que contêm informações createdBy e modifiedBy.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

ReportStatus

Status do relatório.

Nome	Tipo	Description
Active	string	O relatório está ativo.
Disabled	string	O relatório está desabilitado.
Failed	string	O relatório falhou.
Reviewing	string	O relatório está em análise.

ResourceMetadata

Metadados da ID de recurso único.

Nome	Tipo	Description
accountId	string	ID da conta. Por exemplo, a ID da conta do AWS.
resourceId	string	ID do recurso - por exemplo, "/subscriptions/000000000-0000-0000-00000-00000000000/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/vm1".
resourceKind	string	Tipo de recurso.
resourceOrigin	ResourceOrigin	Origem do recurso.
resourceType	string	Tipo de recurso. por exemplo, "Microsoft.Compute/virtualMachines"

ResourceOrigin

Origem do recurso.

Nome	Tipo	Description
AWS	string	O recurso é da AWS.
Azure	string	O recurso é do Azure.
GCP	string	O recurso é do GCP.

StorageInfo

As informações da associação de conta 'traga seu próprio armazenamento' para o relatório

Nome	Tipo	Description
accountName	string	Nome da conta 'traga seu próprio armazenamento'
location	string	A região da conta 'traga seu próprio armazenamento'
resourceGroup	string	O resourceGroup ao qual a conta 'traga seu próprio armazenamento' pertence
subscriptionId	string	A ID da assinatura à qual a conta 'traga seu próprio armazenamento' pertence

systemData

Metadados relativos à criação e última modificação do recurso.

Nome	Tipo	Description
createdAt	string	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.