Policy Sets - Evaluate Policies

Service:

Dev Test Labs

API Version:

2018-09-15

Avalia a política de laboratório.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/policysets/{name}/evaluatePolicies?api-version=2018-09-15

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
labName	path	True	string	O nome do laboratório.
name	path	True	string	O nome do conjunto de políticas.
resourceGroupName	path	True	string	O nome do grupo de recursos.
subscriptionId	path	True	string	O ID da subscrição.
api-version	query	True	string	Versão da API de Cliente.

Corpo do Pedido

Name	Tipo	Description
policies	EvaluatePoliciesProperties[]	Políticas a avaliar.

Respostas

Name	Tipo	Description
200 OK	EvaluatePoliciesResponse	OK
Other Status Codes	CloudError	BadRequest

Segurança

azure_auth

Concessão Implícita OAuth2

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	Aceder ao Microsoft Azure

Exemplos

PolicySets_EvaluatePolicies

Sample Request

HTTP

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}/policysets/{policySetName}/evaluatePolicies?api-version=2018-09-15

{
  "policies": [
    {
      "factName": "LabVmCount",
      "valueOffset": "1"
    }
  ]
}

Java

import com.azure.resourcemanager.devtestlabs.models.EvaluatePoliciesProperties;
import com.azure.resourcemanager.devtestlabs.models.EvaluatePoliciesRequest;
import java.util.Arrays;

/** Samples for PolicySets EvaluatePolicies. */
public final class Main {
    /*
     * x-ms-original-file: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/PolicySets_EvaluatePolicies.json
     */
    /**
     * Sample code: PolicySets_EvaluatePolicies.
     *
     * @param manager Entry point to DevTestLabsManager.
     */
    public static void policySetsEvaluatePolicies(com.azure.resourcemanager.devtestlabs.DevTestLabsManager manager) {
        manager
            .policySets()
            .evaluatePoliciesWithResponse(
                "resourceGroupName",
                "{labName}",
                "{policySetName}",
                new EvaluatePoliciesRequest()
                    .withPolicies(
                        Arrays
                            .asList(new EvaluatePoliciesProperties().withFactName("LabVmCount").withValueOffset("1"))),
                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

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.devtestlabs import DevTestLabsClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-devtestlabs
# USAGE
    python policy_sets_evaluate_policies.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 = DevTestLabsClient(
        credential=DefaultAzureCredential(),
        subscription_id="{subscriptionId}",
    )

    response = client.policy_sets.evaluate_policies(
        resource_group_name="resourceGroupName",
        lab_name="{labName}",
        name="{policySetName}",
    )
    print(response)


# x-ms-original-file: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/PolicySets_EvaluatePolicies.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 armdevtestlabs_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/devtestlabs/armdevtestlabs"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/PolicySets_EvaluatePolicies.json
func ExamplePolicySetsClient_EvaluatePolicies() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdevtestlabs.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewPolicySetsClient().EvaluatePolicies(ctx, "resourceGroupName", "{labName}", "{policySetName}", armdevtestlabs.EvaluatePoliciesRequest{
		Policies: []*armdevtestlabs.EvaluatePoliciesProperties{
			{
				FactName:    to.Ptr("LabVmCount"),
				ValueOffset: to.Ptr("1"),
			}},
	}, 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.EvaluatePoliciesResponse = armdevtestlabs.EvaluatePoliciesResponse{
	// 	Results: []*armdevtestlabs.PolicySetResult{
	// 		{
	// 			HasError: to.Ptr(true),
	// 			PolicyViolations: []*armdevtestlabs.PolicyViolation{
	// 				{
	// 					Code: to.Ptr("MaxValuePolicy"),
	// 					Message: to.Ptr("You cannot exceed the limit (1) of virtual machines that can be created in this lab."),
	// 			}},
	// 	}},
	// }
}

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 { DevTestLabsClient } = require("@azure/arm-devtestlabs");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Evaluates lab policy.
 *
 * @summary Evaluates lab policy.
 * x-ms-original-file: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/PolicySets_EvaluatePolicies.json
 */
async function policySetsEvaluatePolicies() {
  const subscriptionId = "{subscriptionId}";
  const resourceGroupName = "resourceGroupName";
  const labName = "{labName}";
  const name = "{policySetName}";
  const evaluatePoliciesRequest = {
    policies: [{ factName: "LabVmCount", valueOffset: "1" }],
  };
  const credential = new DefaultAzureCredential();
  const client = new DevTestLabsClient(credential, subscriptionId);
  const result = await client.policySets.evaluatePolicies(
    resourceGroupName,
    labName,
    name,
    evaluatePoliciesRequest
  );
  console.log(result);
}

policySetsEvaluatePolicies().catch(console.error);

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.DevTestLabs;
using Azure.ResourceManager.DevTestLabs.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Resources.Models;

// Generated from example definition: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/PolicySets_EvaluatePolicies.json
// this example is just showing the usage of "PolicySets_EvaluatePolicies" 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 DevTestLabResource created on azure
// for more information of creating DevTestLabResource, please refer to the document of DevTestLabResource
string subscriptionId = "{subscriptionId}";
string resourceGroupName = "resourceGroupName";
string labName = "{labName}";
ResourceIdentifier devTestLabResourceId = DevTestLabResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, labName);
DevTestLabResource devTestLab = client.GetDevTestLabResource(devTestLabResourceId);

// invoke the operation
string name = "{policySetName}";
DevTestLabEvaluatePoliciesContent content = new DevTestLabEvaluatePoliciesContent()
{
    Policies =
    {
    new DevTestLabEvaluatePolicy()
    {
    FactName = "LabVmCount",
    ValueOffset = "1",
    }
    },
};
DevTestLabEvaluatePoliciesResult result = await devTestLab.EvaluatePoliciesAsync(name, content);

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

Sample Response

Status code:

200

{
  "results": [
    {
      "hasError": true,
      "policyViolations": [
        {
          "code": "MaxValuePolicy",
          "message": "You cannot exceed the limit (1) of virtual machines that can be created in this lab."
        }
      ]
    }
  ]
}

Definições

Name	Description
CloudError	Erro de um pedido REST.
CloudErrorBody	Corpo de um erro de um pedido REST.
EvaluatePoliciesProperties	Propriedades para avaliar um conjunto de políticas.
EvaluatePoliciesRequest	Corpo do pedido para avaliar um conjunto de políticas.
EvaluatePoliciesResponse	Corpo da resposta para avaliar um conjunto de políticas.
PolicySetResult	Resultado de uma avaliação de conjunto de políticas.
PolicyViolation	Violação de política.

CloudError

Erro de um pedido REST.

Name	Tipo	Description
error	CloudErrorBody	O erro na cloud que ocorreu

CloudErrorBody

Corpo de um erro de um pedido REST.

Name	Tipo	Description
code	string	O código de erro.
details	CloudErrorBody[]	Erros internos.
message	string	A mensagem de erro.
target	string	O destino do erro.

EvaluatePoliciesProperties

Propriedades para avaliar um conjunto de políticas.

Name	Tipo	Description
factData	string	Os dados de factos.
factName	string	O nome do facto.
userObjectId	string	O utilizador para o qual as políticas serão avaliadas
valueOffset	string	O desvio de valor.

EvaluatePoliciesRequest

Corpo do pedido para avaliar um conjunto de políticas.

Name	Tipo	Description
policies	EvaluatePoliciesProperties[]	Políticas a avaliar.

EvaluatePoliciesResponse

Corpo da resposta para avaliar um conjunto de políticas.

Name	Tipo	Description
results	PolicySetResult[]	Resultados da avaliação de um conjunto de políticas.

PolicySetResult

Resultado de uma avaliação de conjunto de políticas.

Name	Tipo	Description
hasError	boolean	Um valor que indica se esta avaliação do conjunto de políticas detetou violações.
policyViolations	PolicyViolation[]	A lista de violações de políticas.

PolicyViolation

Violação de política.

Name	Tipo	Description
code	string	O código da violação da política.
message	string	A mensagem da violação da política.