Compliance Results - Get

Referência

Serviço:: Defender for Cloud

Versão da API:: 2017-08-01

Resultado da conformidade de segurança

GET https://management.azure.com/{resourceId}/providers/Microsoft.Security/complianceResults/{complianceResultName}?api-version=2017-08-01

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
complianceResultName	path	True	string	Nome do resultado desejado da avaliação de conformidade
resourceId	path	True	string	O identificador do recurso.
api-version	query	True	string	Versão da API para a operação

Respostas

Name	Tipo	Description
200 OK	ComplianceResult	OK
Other Status Codes	CloudError	Resposta de erro descrevendo por que a operação falhou.

Segurança

azure_auth

Azure Ative Directory OAuth2 Flow

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

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

Get compliance results on subscription

Pedido de amostra

GET https://management.azure.com/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/complianceResults/DesignateMoreThanOneOwner?api-version=2017-08-01


/**
 * Samples for ComplianceResults Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/security/resource-manager/Microsoft.Security/stable/2017-08-01/examples/ComplianceResults/
     * GetComplianceResults_example.json
     */
    /**
     * Sample code: Get compliance results on subscription.
     * 
     * @param manager Entry point to SecurityManager.
     */
    public static void getComplianceResultsOnSubscription(com.azure.resourcemanager.security.SecurityManager manager) {
        manager.complianceResults().getWithResponse("subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23",
            "DesignateMoreThanOneOwner", com.azure.core.util.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

package armsecurity_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/security/armsecurity"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ac34f238dd6b9071f486b57e9f9f1a0c43ec6f6/specification/security/resource-manager/Microsoft.Security/stable/2017-08-01/examples/ComplianceResults/GetComplianceResults_example.json
func ExampleComplianceResultsClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsecurity.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewComplianceResultsClient().Get(ctx, "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23", "DesignateMoreThanOneOwner", 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.ComplianceResult = armsecurity.ComplianceResult{
	// 	Name: to.Ptr("DesignateMoreThanOneOwner"),
	// 	Type: to.Ptr("Microsoft.Security/complianceResults"),
	// 	ID: to.Ptr("/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/complianceResults/DesignateMoreThanOneOwner"),
	// 	Properties: &armsecurity.ComplianceResultProperties{
	// 		ResourceStatus: to.Ptr(armsecurity.ResourceStatusHealthy),
	// 	},
	// }
}

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

const { SecurityCenter } = require("@azure/arm-security");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Security Compliance Result
 *
 * @summary Security Compliance Result
 * x-ms-original-file: specification/security/resource-manager/Microsoft.Security/stable/2017-08-01/examples/ComplianceResults/GetComplianceResults_example.json
 */
async function getComplianceResultsOnSubscription() {
  const resourceId = "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23";
  const complianceResultName = "DesignateMoreThanOneOwner";
  const credential = new DefaultAzureCredential();
  const client = new SecurityCenter(credential);
  const result = await client.complianceResults.get(resourceId, complianceResultName);
  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 System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.SecurityCenter;

// Generated from example definition: specification/security/resource-manager/Microsoft.Security/stable/2017-08-01/examples/ComplianceResults/GetComplianceResults_example.json
// this example is just showing the usage of "ComplianceResults_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 ArmResource created on azure
// for more information of creating ArmResource, please refer to the document of ArmResource

// get the collection of this ComplianceResultResource
string resourceId = "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23";
ResourceIdentifier scopeId = new ResourceIdentifier(string.Format("/{0}", resourceId));
ComplianceResultCollection collection = client.GetComplianceResults(scopeId);

// invoke the operation
string complianceResultName = "DesignateMoreThanOneOwner";
NullableResponse<ComplianceResultResource> response = await collection.GetIfExistsAsync(complianceResultName);
ComplianceResultResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine($"Succeeded with null as result");
}
else
{
    // 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
    ComplianceResultData 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 da amostra

Código de estado:: 200

{
  "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/complianceResults/DesignateMoreThanOneOwner",
  "name": "DesignateMoreThanOneOwner",
  "type": "Microsoft.Security/complianceResults",
  "properties": {
    "resourceStatus": "Healthy"
  }
}

Definições

Name	Description
CloudError	Resposta de erro comum para todas as APIs do Azure Resource Manager para retornar detalhes de erro para operações com falha. (Isso também segue o formato de resposta de erro OData.)
CloudErrorBody	O detalhe do erro.
ComplianceResult	um resultado de conformidade
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
resourceStatus	O status do recurso em relação a uma única avaliação

CloudError

Resposta de erro comum para todas as APIs do Azure Resource Manager para retornar detalhes de erro para operações com falha. (Isso também segue o formato de resposta de erro OData.)

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

CloudErrorBody

O detalhe do erro.

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