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

Поток OAuth2 в Azure Active Directory

Тип: oauth2
Flow: implicit
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	Тип удостоверения, создавшего ресурс.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Сообщение об ошибке
OverviewStatus	Обзор результата соответствия для одного отчета.
provisioningState	Управление жизненным циклом Azure
ReportComplianceStatus	Список, включающий все результаты соответствия для одного отчета.
ReportProperties	Свойства отчета.
ReportResource	Класс представляет ресурс отчета AppComplianceAutomation.
ReportStatus	создание отчетов о состоянии;
ResourceMetadata	Метаданные идентификатора одного ресурса.
systemData	Метаданные, относящиеся к созданию и последнему изменению ресурса.

createdByType

Тип удостоверения, создавшего ресурс.

Имя	Тип	Описание
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	Объект ошибки.

OverviewStatus

Обзор результата соответствия для одного отчета.

Имя	Тип	Описание
failedCount	integer	Число всех неудачных полных элементов управления автоматизацией.
manualCount	integer	Количество всех элементов управления вручную.
passedCount	integer	Количество всех пройденных полный контроль автоматизации.

provisioningState

Управление жизненным циклом Azure

Имя	Тип	Описание
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

ReportComplianceStatus

Список, включающий все результаты соответствия для одного отчета.

Имя	Тип	Описание
m365	OverviewStatus	Имя сертификации Microsoft 365.

ReportProperties

Свойства отчета.

Имя	Тип	Описание
complianceStatus	ReportComplianceStatus	Сообщить о состоянии соответствия.
id	string	Идентификатор отчета в базе данных.
lastTriggerTime	string	Отчет о времени последнего триггера сбора.
nextTriggerTime	string	Сообщите о времени следующего триггера сбора.
offerGuid	string	Идентификатор GUID предложения отчета.
provisioningState	provisioningState	Управление жизненным циклом Azure
reportName	string	Имя отчета.
resources	ResourceMetadata[]	Список данных ресурсов.
status	ReportStatus	создание отчетов о состоянии;
subscriptions	string[]	Список идентификаторов подписки.
tenantId	string	Идентификатор клиента отчета.
timeZone	string	Часовой пояс триггера сбора отчетов. Доступный список можно получить, выполнив команду Get-TimeZone -ListAvailable в PowerShell. Примером допустимого идентификатора часового пояса является "Тихоокеанское стандартное время".
triggerTime	string	Время триггера сбора отчетов.

ReportResource

Класс представляет ресурс отчета AppComplianceAutomation.

Имя	Тип	Описание
id	string	Полный идентификатор ресурса. Пример : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Имя ресурса.
properties	ReportProperties	Свойство отчета.
systemData	systemData	Azure Resource Manager метаданные, содержащие сведения о createdBy и modifiedBy.
type	string	Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

ReportStatus

создание отчетов о состоянии;

Имя	Тип	Описание
Active	string
Disabled	string
Failed	string

ResourceMetadata

Метаданные идентификатора одного ресурса.

Имя	Тип	Описание
resourceId	string	Идентификатор ресурса, например "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/vm1".
resourceKind	string	Тип ресурса.
resourceName	string	Имя ресурса.
resourceType	string	Тип ресурса.
tags	object	Тип тега ресурса.

systemData

Метаданные, относящиеся к созданию и последнему изменению ресурса.

Имя	Тип	Описание
createdAt	string	Метка времени создания ресурса (UTC).
createdBy	string	Удостоверение, создающее ресурс.
createdByType	createdByType	Тип удостоверения, создавшего ресурс.
lastModifiedAt	string	Метка времени последнего изменения ресурса (UTC)
lastModifiedBy	string	Удостоверение, которое в последний раз изменял ресурс.
lastModifiedByType	createdByType	Тип удостоверения, изменяющего ресурс в последний раз.