Snapshot - List

Serviço:

App Compliance Automation

Versão da API:

2024-06-27

Obtenha a lista de instantâneos AppComplianceAutomation.

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

Com parâmetros opcionais:

GET https://management.azure.com/providers/Microsoft.AppComplianceAutomation/reports/{reportName}/snapshots?api-version=2024-06-27&$skipToken={$skipToken}&$top={$top}&$select={$select}&$filter={$filter}&$orderby={$orderby}&offerGuid={offerGuid}&reportCreatorTenantId={reportCreatorTenantId}

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
reportName	path	True	string pattern: ^[-a-zA-Z0-9_]{1,50}$	Nome do relatório.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.
$filter	query		string minLength: 1	O filtro a ser aplicado na operação.
$orderby	query		string minLength: 1	Opção OData order by query.
$select	query		string minLength: 1	Instrução OData Select. Limita as propriedades em cada entrada apenas às solicitadas, por exemplo? ?$select=reportName,id.
$skipToken	query		string	Ignore ao recuperar resultados.
$top	query		integer (int32) minimum: 1 maximum: 100	Número de elementos a serem retornados ao recuperar resultados.
offerGuid	query		string minLength: 1	O offerGuid que mapeia para os relatórios.
reportCreatorTenantId	query		string minLength: 1	A ID do locatário do criador do relatório.

Respostas

Nome	Tipo	Description
200 OK	SnapshotResourceListResult	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

Snapshot_List

Solicitação de exemplo

HTTP

GET https://management.azure.com/providers/Microsoft.AppComplianceAutomation/reports/testReportName/snapshots?api-version=2024-06-27&$skipToken=1&$top=100&offerGuid=00000000-0000-0000-0000-000000000001&reportCreatorTenantId=00000000-0000-0000-0000-000000000000

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.appcomplianceautomation import AppComplianceAutomationMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-appcomplianceautomation
# USAGE
    python snapshot_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 = AppComplianceAutomationMgmtClient(
        credential=DefaultAzureCredential(),
    )

    response = client.snapshot.list(
        report_name="testReportName",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Snapshot_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

Go

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/d88c94b22a8efdd47c0cadfe6d8d489107db2b23/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Snapshot_List.json
func ExampleSnapshotClient_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.NewSnapshotClient().NewListPager("testReportName", &armappcomplianceautomation.SnapshotClientListOptions{SkipToken: to.Ptr("1"),
		Top:                   to.Ptr[int32](100),
		Select:                nil,
		Filter:                nil,
		Orderby:               nil,
		OfferGUID:             to.Ptr("00000000-0000-0000-0000-000000000001"),
		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.SnapshotResourceListResult = armappcomplianceautomation.SnapshotResourceListResult{
		// 	Value: []*armappcomplianceautomation.SnapshotResource{
		// 		{
		// 			Name: to.Ptr("testSnapshot"),
		// 			Type: to.Ptr("Microsfot.AppComplianceAutomation/reports/snapshots"),
		// 			ID: to.Ptr("/provider/Microsfot.AppComplianceAutomation/reports/testReportName/snapshots/testSnapshot"),
		// 			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.SnapshotProperties{
		// 				ComplianceResults: []*armappcomplianceautomation.ComplianceResult{
		// 					{
		// 						Categories: []*armappcomplianceautomation.Category{
		// 							{
		// 								CategoryName: to.Ptr("Operational Security"),
		// 								CategoryStatus: to.Ptr(armappcomplianceautomation.CategoryStatusPassed),
		// 								ControlFamilies: []*armappcomplianceautomation.ControlFamily{
		// 									{
		// 										ControlFamilyName: to.Ptr("Incident Response"),
		// 										ControlFamilyStatus: to.Ptr(armappcomplianceautomation.ControlFamilyStatusPassed),
		// 										Controls: []*armappcomplianceautomation.Control{
		// 											{
		// 												ControlDescription: to.Ptr("Provide demonstrable evidence that all member of the incident response team have completed annual training or a table top exercise"),
		// 												ControlDescriptionHyperLink: to.Ptr("https://aka.ms/acat/m365cert/operational/control73"),
		// 												ControlFullName: to.Ptr("Provide demonstrable evidence that all member of the incident response team have completed annual training or a table top exercise"),
		// 												ControlID: to.Ptr("Operational_Security_75"),
		// 												ControlName: to.Ptr("Provide demonstrable evidence that all member of the incident response team have completed annual training or a table top exercise"),
		// 												ControlStatus: to.Ptr(armappcomplianceautomation.ControlStatusPassed),
		// 												Responsibilities: []*armappcomplianceautomation.Responsibility{
		// 													{
		// 														EvidenceFiles: []*string{
		// 															to.Ptr("https://management.azure.com/providers/Microsoft.AppComplianceAutomation/reports/reportABC/fileName?api-version=2024-06-27")},
		// 															FailedResourceCount: to.Ptr[int32](0),
		// 															Guidance: to.Ptr("Please upload the screen capture file to ACAT service."),
		// 															Justification: to.Ptr("Here is my evidence files"),
		// 															RecommendationList: []*armappcomplianceautomation.Recommendation{
		// 																{
		// 																	RecommendationID: to.Ptr("failed_reason_1"),
		// 																	RecommendationShortName: to.Ptr("Invalid TLS Config"),
		// 																	RecommendationSolutions: []*armappcomplianceautomation.RecommendationSolution{
		// 																		{
		// 																			IsRecommendSolution: to.Ptr(armappcomplianceautomation.IsRecommendSolutionTrue),
		// 																			RecommendationSolutionContent: to.Ptr("Setting minimal TLS version to 1.2 improves security by ensuring your SQL Managed Instance can only be accessed from clients using TLS 1.2. Using versions of TLS less than 1.2 is not recommended since they have well documented security vulnerabilities"),
		// 																			RecommendationSolutionIndex: to.Ptr("1"),
		// 																	}},
		// 																},
		// 																{
		// 																	RecommendationID: to.Ptr("failed_reason_2"),
		// 																	RecommendationShortName: to.Ptr("Invalid AWS TLS Config"),
		// 																	RecommendationSolutions: []*armappcomplianceautomation.RecommendationSolution{
		// 																		{
		// 																			IsRecommendSolution: to.Ptr(armappcomplianceautomation.IsRecommendSolutionTrue),
		// 																			RecommendationSolutionContent: to.Ptr("Open the AWS related service, and set its TLS version to 1.2 or higher version."),
		// 																			RecommendationSolutionIndex: to.Ptr("1"),
		// 																	}},
		// 															}},
		// 															ResourceList: []*armappcomplianceautomation.ResponsibilityResource{
		// 																{
		// 																	RecommendationIDs: []*string{
		// 																		to.Ptr("failed_reason_1")},
		// 																		ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService"),
		// 																		ResourceOrigin: to.Ptr(armappcomplianceautomation.ResourceOriginAzure),
		// 																		ResourceStatus: to.Ptr(armappcomplianceautomation.ResourceStatusUnhealthy),
		// 																		ResourceStatusChangeDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-01-12T16:17:20.150Z"); return t}()),
		// 																		ResourceType: to.Ptr("Microsoft.SignalRService/SignalR"),
		// 																	},
		// 																	{
		// 																		AccountID: to.Ptr("000000000000"),
		// 																		RecommendationIDs: []*string{
		// 																			to.Ptr("failed_reason_2")},
		// 																			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),
		// 																			ResourceStatus: to.Ptr(armappcomplianceautomation.ResourceStatusUnhealthy),
		// 																			ResourceStatusChangeDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-01-12T16:17:20.150Z"); return t}()),
		// 																			ResourceType: to.Ptr("iam.user"),
		// 																	}},
		// 																	ResponsibilityDescription: to.Ptr("Restrict access to the Kubernetes Service Management API by granting API access only to IP addresses in specific ranges. It is recommended to limit access to authorized IP ranges to ensure that only applications from allowed networks can access the cluster."),
		// 																	ResponsibilityEnvironment: to.Ptr(armappcomplianceautomation.ResponsibilityEnvironmentAzure),
		// 																	ResponsibilityID: to.Ptr("authorized_ip_ranges_should_be_defined_on_kubernetes_services"),
		// 																	ResponsibilitySeverity: to.Ptr(armappcomplianceautomation.ResponsibilitySeverityHigh),
		// 																	ResponsibilityStatus: to.Ptr(armappcomplianceautomation.ResponsibilityStatusPassed),
		// 																	ResponsibilityTitle: to.Ptr("Authorized IP ranges should be defined on Kubernetes Services"),
		// 																	ResponsibilityType: to.Ptr(armappcomplianceautomation.ResponsibilityTypeAutomated),
		// 																	TotalResourceCount: to.Ptr[int32](1),
		// 															}},
		// 													}},
		// 											}},
		// 									}},
		// 									ComplianceName: to.Ptr("M365"),
		// 							}},
		// 							CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-03-04T15:33:59.160Z"); return t}()),
		// 							ProvisioningState: to.Ptr(armappcomplianceautomation.ProvisioningStateSucceeded),
		// 							ReportProperties: &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),
		// 										NotApplicableCount: to.Ptr[int32](0),
		// 										PassedCount: to.Ptr[int32](0),
		// 										PendingCount: to.Ptr[int32](0),
		// 									},
		// 								},
		// 								Errors: []*string{
		// 								},
		// 								LastTriggerTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-03-04T15:00:00.000Z"); return t}()),
		// 								NextTriggerTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-03-04T15: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.ReportStatusActive),
		// 								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-04T15:00:00.000Z"); return t}()),
		// 								},
		// 								ReportSystemData: &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),
		// 								},
		// 								SnapshotName: to.Ptr("testSnapshot"),
		// 							},
		// 					}},
		// 				}
	}
}

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 snapshot list.
 *
 * @summary Get the AppComplianceAutomation snapshot list.
 * x-ms-original-file: specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Snapshot_List.json
 */
async function snapshotList() {
  const skipToken = "1";
  const top = 100;
  const offerGuid = "00000000-0000-0000-0000-000000000001";
  const reportCreatorTenantId = "00000000-0000-0000-0000-000000000000";
  const reportName = "testReportName";
  const options = {
    skipToken,
    top,
    offerGuid,
    reportCreatorTenantId,
  };
  const credential = new DefaultAzureCredential();
  const client = new AppComplianceAutomationToolForMicrosoft365(credential);
  const resArray = new Array();
  for await (let item of client.snapshot.list(reportName, options)) {
    resArray.push(item);
  }
  console.log(resArray);
}

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/Snapshot_List.json
// this example is just showing the usage of "Snapshot_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 AppComplianceReportResource created on azure
// for more information of creating AppComplianceReportResource, please refer to the document of AppComplianceReportResource
string reportName = "testReportName";
ResourceIdentifier appComplianceReportResourceId = AppComplianceReportResource.CreateResourceIdentifier(reportName);
AppComplianceReportResource appComplianceReport = client.GetAppComplianceReportResource(appComplianceReportResourceId);

// get the collection of this AppComplianceReportSnapshotResource
AppComplianceReportSnapshotCollection collection = appComplianceReport.GetAppComplianceReportSnapshots();

// invoke the operation and iterate over the result
AppComplianceReportSnapshotCollectionGetAllOptions options = new AppComplianceReportSnapshotCollectionGetAllOptions { SkipToken = "1", Top = 100, OfferGuid = "00000000-0000-0000-0000-000000000001", ReportCreatorTenantId = "00000000-0000-0000-0000-000000000000" };
await foreach (AppComplianceReportSnapshotResource item in collection.GetAllAsync(options))
{
    // 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
    AppComplianceReportSnapshotData 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

Resposta de exemplo

Código de status:

200

{
  "nextLink": "https://management.azure.com/providers/Microsoft.AppComplianceAutomation/reports/testReportName/snapshots?api-version=2024-06-27&skipToken=1&top=100",
  "value": [
    {
      "name": "testSnapshot",
      "type": "Microsfot.AppComplianceAutomation/reports/snapshots",
      "id": "/provider/Microsfot.AppComplianceAutomation/reports/testReportName/snapshots/testSnapshot",
      "properties": {
        "complianceResults": [
          {
            "categories": [
              {
                "categoryName": "Operational Security",
                "categoryStatus": "Passed",
                "controlFamilies": [
                  {
                    "controlFamilyName": "Incident Response",
                    "controlFamilyStatus": "Passed",
                    "controls": [
                      {
                        "controlDescription": "Provide demonstrable evidence that all member of the incident response team have completed annual training or a table top exercise",
                        "controlDescriptionHyperLink": "https://aka.ms/acat/m365cert/operational/control73",
                        "controlFullName": "Provide demonstrable evidence that all member of the incident response team have completed annual training or a table top exercise",
                        "controlId": "Operational_Security_75",
                        "controlName": "Provide demonstrable evidence that all member of the incident response team have completed annual training or a table top exercise",
                        "controlStatus": "Passed",
                        "responsibilities": [
                          {
                            "evidenceFiles": [
                              "https://management.azure.com/providers/Microsoft.AppComplianceAutomation/reports/reportABC/fileName?api-version=2024-06-27"
                            ],
                            "failedResourceCount": 0,
                            "guidance": "Please upload the screen capture file to ACAT service.",
                            "justification": "Here is my evidence files",
                            "recommendationList": [
                              {
                                "recommendationId": "failed_reason_1",
                                "recommendationShortName": "Invalid TLS Config",
                                "recommendationSolutions": [
                                  {
                                    "isRecommendSolution": "true",
                                    "recommendationSolutionContent": "Setting minimal TLS version to 1.2 improves security by ensuring your SQL Managed Instance can only be accessed from clients using TLS 1.2. Using versions of TLS less than 1.2 is not recommended since they have well documented security vulnerabilities",
                                    "recommendationSolutionIndex": "1"
                                  }
                                ]
                              },
                              {
                                "recommendationId": "failed_reason_2",
                                "recommendationShortName": "Invalid AWS TLS Config",
                                "recommendationSolutions": [
                                  {
                                    "isRecommendSolution": "true",
                                    "recommendationSolutionContent": "Open the AWS related service, and set its TLS version to 1.2 or higher version.",
                                    "recommendationSolutionIndex": "1"
                                  }
                                ]
                              }
                            ],
                            "resourceList": [
                              {
                                "recommendationIds": [
                                  "failed_reason_1"
                                ],
                                "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService",
                                "resourceOrigin": "Azure",
                                "resourceStatus": "Unhealthy",
                                "resourceStatusChangeDate": "2023-01-12T16:17:20.150Z",
                                "resourceType": "Microsoft.SignalRService/SignalR"
                              },
                              {
                                "accountId": "000000000000",
                                "recommendationIds": [
                                  "failed_reason_2"
                                ],
                                "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/acat-aws/providers/microsoft.security/securityconnectors/acatawsconnector/securityentitydata/aws-iam-user-testuser",
                                "resourceOrigin": "AWS",
                                "resourceStatus": "Unhealthy",
                                "resourceStatusChangeDate": "2023-01-12T16:17:20.150Z",
                                "resourceType": "iam.user"
                              }
                            ],
                            "responsibilityDescription": "Restrict access to the Kubernetes Service Management API by granting API access only to IP addresses in specific ranges. It is recommended to limit access to authorized IP ranges to ensure that only applications from allowed networks can access the cluster.",
                            "responsibilityEnvironment": "Azure",
                            "responsibilityId": "authorized_ip_ranges_should_be_defined_on_kubernetes_services",
                            "responsibilitySeverity": "High",
                            "responsibilityStatus": "Passed",
                            "responsibilityTitle": "Authorized IP ranges should be defined on Kubernetes Services",
                            "responsibilityType": "Automated",
                            "totalResourceCount": 1
                          }
                        ]
                      }
                    ]
                  }
                ]
              }
            ],
            "complianceName": "M365"
          }
        ],
        "createdAt": "2022-03-04T15:33:59.160Z",
        "provisioningState": "Succeeded",
        "reportProperties": {
          "certRecords": [
            {
              "certificationStatus": "CertIngestion",
              "controls": [
                {
                  "controlId": "Operational_Security_10",
                  "controlStatus": "Approved"
                }
              ],
              "ingestionStatus": "EvidenceResubmitted",
              "offerGuid": "00000000-0000-0000-0000-000000000001"
            }
          ],
          "complianceStatus": {
            "m365": {
              "failedCount": 0,
              "manualCount": 0,
              "notApplicableCount": 0,
              "passedCount": 0,
              "pendingCount": 0
            }
          },
          "errors": [],
          "lastTriggerTime": "2022-03-04T15:00:00.000Z",
          "nextTriggerTime": "2022-03-04T15: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": "Active",
          "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-04T15:00:00.000Z"
        },
        "reportSystemData": {
          "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"
        },
        "snapshotName": "testSnapshot"
      },
      "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
Category	Uma classe representa a categoria de conformidade.
CategoryStatus	Indica o status da categoria.
CertSyncRecord	Uma classe representa o registro de certificação sincronizado com a conformidade do aplicativo.
ComplianceResult	Uma classe representa o resultado da conformidade.
Control	Uma classe representa o controle.
ControlFamily	Uma classe representa a família de controle.
ControlFamilyStatus	Indica o status da família de controle.
ControlStatus	Indica o status do controle.
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
IsRecommendSolution	Indica se essa solução é a recomendada.
OverviewStatus	A visão geral do resultado da conformidade de um relatório.
ProvisioningState	Estados de provisionamento de recursos.
Recommendation	Uma classe representa a recomendação.
RecommendationSolution	Uma classe representa a solução de recomendação.
ReportComplianceStatus	Uma lista que inclui todo o resultado de conformidade de um relatório.
ReportProperties	Crie as propriedades do Relatório.
ReportStatus	Status do relatório.
ResourceMetadata	Metadados da ID de recurso único.
ResourceOrigin	Origem do recurso.
ResourceStatus	Indica o status do recurso.
Responsibility	Uma classe representa a responsabilidade do cliente.
ResponsibilityEnvironment	Indica o ambiente de nuvem com suporte à responsabilidade do cliente.
ResponsibilityResource	Uma classe representa o recurso.
ResponsibilitySeverity	Indica a gravidade da responsabilidade do cliente.
ResponsibilityStatus	Indica o status de responsabilidade do cliente.
ResponsibilityType	Indica o tipo de responsabilidade do cliente.
SnapshotResource	Uma classe representa um recurso de instantâneo AppComplianceAutomation.
SnapshotResourceListResult	A resposta de uma operação de lista SnapshotResource.
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.

Category

Objeto

Uma classe representa a categoria de conformidade.

Nome	Tipo	Description
categoryName	string	O nome da categoria de conformidade. por exemplo, "Segurança Operacional"
categoryStatus	CategoryStatus	Status da categoria.
controlFamilies	ControlFamily[]	Lista de famílias de controle.

CategoryStatus

Enumeração

Indica o status da categoria.

Valor	Description
Failed	Falha na categoria.
NotApplicable	A categoria não é aplicável.
Passed	A categoria é passada.
PendingApproval	A categoria está pendente para aprovação.

CertSyncRecord

Objeto

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 minLength: 1	O offerGuid que mapeia para os relatórios.

ComplianceResult

Objeto

Uma classe representa o resultado da conformidade.

Nome	Tipo	Description
categories	Category[]	Lista de categorias.
complianceName	string	O nome da conformidade. por exemplo, "M365"

Control

Objeto

Uma classe representa o controle.

Nome	Tipo	Description
controlDescription	string	Descrição do controle
controlDescriptionHyperLink	string	O hiper link para a descrição do controle.
controlFullName	string	O nome completo do controle. por exemplo, "Valide se sistemas operacionais sem suporte e componentes de software não estão em uso."
controlId	string	A ID do controle. por exemplo, "Operational_Security_10"
controlName	string	O nome do controle. por exemplo, "Software e sistema operacional sem suporte".
controlStatus	ControlStatus	Status do controle.
responsibilities	Responsibility[]	Lista de responsabilidade do cliente.

ControlFamily

Objeto

Uma classe representa a família de controle.

Nome	Tipo	Description
controlFamilyName	string	O nome da família de controle. por exemplo, "Proteção contra Malware – Antivírus"
controlFamilyStatus	ControlFamilyStatus	O status da família de controle
controls	Control[]	Lista de controles.

ControlFamilyStatus

Enumeração

Indica o status da família de controle.

Valor	Description
Failed	Falha na família de controle.
NotApplicable	A família de controle não é aplicável.
Passed	A família de controle é passada.
PendingApproval	A família de controle está pendente para aprovação.

ControlStatus

Enumeração

Indica o status do controle.

Valor	Description
Failed	O controle falhou.
NotApplicable	O controle não é aplicável.
Passed	O controle é passado.
PendingApproval	O controle está pendente para aprovação.

ControlSyncRecord

Objeto

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

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Objeto

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

Objeto

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

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

IsRecommendSolution

Enumeração

Indica se essa solução é a recomendada.

Valor	Description
false	Essa solução não é a recomendada.
true	Essa solução é a recomendada.

OverviewStatus

Objeto

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

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

ProvisioningState

Enumeração

Estados de provisionamento de recursos.

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

Recommendation

Objeto

Uma classe representa a recomendação.

Nome	Tipo	Description
recommendationId	string	A ID da recomendação.
recommendationShortName	string	O nome curto da recomendação. por exemplo, "Configuração de TLS inválida"
recommendationSolutions	RecommendationSolution[]	Lista de soluções de recomendação.

RecommendationSolution

Objeto

Uma classe representa a solução de recomendação.

Nome	Tipo	Description
isRecommendSolution	IsRecommendSolution	Indica se essa solução é a recomendada.
recommendationSolutionContent	string	As etapas detalhadas da solução de recomendação.
recommendationSolutionIndex	string	O índice da solução de recomendação.

ReportComplianceStatus

Objeto

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.

ReportProperties

Objeto

Crie as propriedades do Relatório.

Nome	Tipo	Description
certRecords	CertSyncRecord[]	Lista de registros de certificação sincronizados.
complianceStatus	ReportComplianceStatus	Relatar o status de conformidade.
errors	string[]	Lista de códigos de erro de relatório.
lastTriggerTime	string (date-time)	Relatar a hora do gatilho da última coleção.
nextTriggerTime	string (date-time)	Relatar a hora do gatilho da próxima coleção.
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".
provisioningState	ProvisioningState	Gerenciamento do ciclo de vida do Azure
resources	ResourceMetadata[]	Lista de dados de recursos.
status	ReportStatus	Status do relatório.
storageInfo	StorageInfo	As informações da associação 'traga seu próprio armazenamento' para o relatório
subscriptions	string[]	Lista de IDs de assinatura.
tenantId	string	ID do locatário do relatório.
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".
triggerTime	string (date-time)	Hora do gatilho da coleção de relatórios.

ReportStatus

Enumeração

Status do relatório.

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

ResourceMetadata

Objeto

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

Enumeração

Origem do recurso.

Valor	Description
AWS	O recurso é da AWS.
Azure	O recurso é do Azure.
GCP	O recurso é do GCP.

ResourceStatus

Enumeração

Indica o status do recurso.

Valor	Description
Healthy	O recurso está íntegro.
Unhealthy	O recurso não está íntegro.

Responsibility

Objeto

Uma classe representa a responsabilidade do cliente.

Nome	Tipo	Description
evidenceFiles	string[]	Lista de url do arquivo de evidência.
failedResourceCount	integer (int32)	A contagem de todos os recursos com falha.
guidance	string	A descrição das diretrizes de carregamento de evidência.
justification	string	A justificativa fornecida pelo usuário para esclarecer o motivo.
recommendationList	Recommendation[]	Lista de recomendações.
resourceList	ResponsibilityResource[]	Lista de recursos.
responsibilityDescription	string	A descrição da responsabilidade do cliente.
responsibilityEnvironment	ResponsibilityEnvironment	O ambiente de nuvem com suporte dessa responsabilidade do cliente.
responsibilityId	string	A ID da responsabilidade do cliente.
responsibilitySeverity	ResponsibilitySeverity	O nível de gravidade dessa responsabilidade do cliente.
responsibilityStatus	ResponsibilityStatus	O status dessa responsabilidade do cliente.
responsibilityTitle	string	O título da responsabilidade do cliente.
responsibilityType	ResponsibilityType	O tipo de responsabilidade do cliente.
totalResourceCount	integer (int32)	A contagem de todos os recursos.

ResponsibilityEnvironment

Enumeração

Indica o ambiente de nuvem com suporte à responsabilidade do cliente.

Valor	Description
AWS	A responsabilidade é suportada na AWS.
Azure	Há suporte para a responsabilidade no Azure.
GCP	Há suporte para a responsabilidade no GCP.
General	A responsabilidade é um requisito geral de todo o ambiente.

ResponsibilityResource

Objeto

Uma classe representa o recurso.

Nome	Tipo	Description
accountId	string	ID da conta. Por exemplo: ID da conta do AWS.
recommendationIds	string[]	Lista de ID de recomendação.
resourceId	string	A ID do recurso.
resourceOrigin	ResourceOrigin	Origem do recurso.
resourceStatus	ResourceStatus	Status do recurso.
resourceStatusChangeDate	string (date-time)	A data de alteração de status do recurso.
resourceType	string	O tipo do recurso. por exemplo, "Microsoft.SignalRService/SignalR"

ResponsibilitySeverity

Enumeração

Indica a gravidade da responsabilidade do cliente.

Valor	Description
High	A responsabilidade é de alta gravidade.
Low	A responsabilidade é de baixa gravidade.
Medium	A responsabilidade é de gravidade média.

ResponsibilityStatus

Enumeração

Indica o status de responsabilidade do cliente.

Valor	Description
Failed	Falha na responsabilidade.
NotApplicable	A responsabilidade não é aplicável.
Passed	A responsabilidade é passada.
PendingApproval	A responsabilidade está pendente para aprovação.

ResponsibilityType

Enumeração

Indica o tipo de responsabilidade do cliente.

Valor	Description
Automated	A responsabilidade é automatizada.
Manual	A responsabilidade é manual.
ScopedManual	A responsabilidade é manual de escopo.

SnapshotResource

Objeto

Uma classe representa um recurso de instantâneo 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.complianceResults	ComplianceResult[]	Lista de resultados de conformidade.
properties.createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
properties.provisioningState	ProvisioningState	Gerenciamento do ciclo de vida do Azure
properties.reportProperties	ReportProperties	As informações essenciais do relatório.
properties.reportSystemData	systemData	Metadados relativos à criação e última modificação do recurso.
properties.snapshotName	string	Nome do instantâneo.
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"

SnapshotResourceListResult

Objeto

A resposta de uma operação de lista SnapshotResource.

Nome	Tipo	Description
nextLink	string (uri)	O link para a próxima página de itens
value	SnapshotResource[]	Os itens SnapshotResource nesta página

StorageInfo

Objeto

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

Objeto

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

Nome	Tipo	Description
createdAt	string (date-time)	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 (date-time)	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.