Report - Verify

Služba:

App Compliance Automation

Verze rozhraní API:

2024-06-27

Ověřte stav aplikaceComplianceAutomation.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
reportName	path	True	string pattern: ^[-a-zA-Z0-9_]{1,50}$	Název sestavy
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Odpovědi

Name	Typ	Description
200 OK	ReportVerificationResult	Operace Azure byla úspěšně dokončena.
202 Accepted		Akceptovala se operace prostředku. Hlavičky Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Neočekávaná chybová odpověď

Zabezpečení

azure_auth

Tok OAuth2 v Azure Active Directory

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

Report_Verify

Ukázkový požadavek

HTTP

POST https://management.azure.com/providers/Microsoft.AppComplianceAutomation/reports/testReport/verify?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_verify.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.begin_verify(
        report_name="testReport",
    ).result()
    print(response)


# x-ms-original-file: specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Report_Verify.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_Verify.json
func ExampleReportClient_BeginVerify() {
	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)
	}
	poller, err := clientFactory.NewReportClient().BeginVerify(ctx, "testReport", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %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.ReportVerificationResult = armappcomplianceautomation.ReportVerificationResult{
	// 	Reason: to.Ptr(""),
	// 	Result: to.Ptr(armappcomplianceautomation.ResultSucceeded),
	// }
}

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 Verify the AppComplianceAutomation report health status.
 *
 * @summary Verify the AppComplianceAutomation report health status.
 * x-ms-original-file: specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Report_Verify.json
 */
async function reportVerify() {
  const reportName = "testReport";
  const credential = new DefaultAzureCredential();
  const client = new AppComplianceAutomationToolForMicrosoft365(credential);
  const result = await client.report.beginVerifyAndWait(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_Verify.json
// this example is just showing the usage of "Report_Verify" 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
ArmOperation<ReportVerificationResult> lro = await appComplianceReport.VerifyAsync(WaitUntil.Completed);
ReportVerificationResult result = lro.Value;

Console.WriteLine($"Succeeded: {result}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Ukázková odpověď

Stavový kód:

200

{
  "reason": "",
  "result": "Succeeded"
}

Stavový kód:

202

Azure-AsyncOperation: https://management.azure.com/providers/Microsoft.AppComplianceAutomation/operationStatuses/{operationId}
Location: https://management.azure.com/providers/Microsoft.AppComplianceAutomation/operationResults/{operationId}

Definice

Name	Description
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď
ReportVerificationResult	Nahlásit výsledek ověření stavu
Result	Určuje, jestli je akce opravy úspěšná nebo neúspěšná.

ErrorAdditionalInfo

Objekt

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorDetail

Objekt

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorResponse

Objekt

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

ReportVerificationResult

Objekt

Nahlásit výsledek ověření stavu

Name	Typ	Description
reason	string	Pokud se akce ověření sestavy nezdařila, uveďte podrobný důvod selhání.
result	Result	Určuje, jestli je akce ověření sestavy úspěšná nebo neúspěšná.

Result

Výčet

Určuje, jestli je akce opravy úspěšná nebo neúspěšná.

Hodnota	Description
Succeeded	Výsledek je úspěšný.
Failed	Výsledek se nezdařil.