Policies - Create Or Update

Serviço:

Dev Test Labs

Versão da API:

2018-09-15

Crie ou substitua uma política existente.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
labName	path	True	string	O nome do laboratório.
name	path	True	string	O nome da política.
policySetName	path	True	string	O nome do conjunto de políticas.
resourceGroupName	path	True	string	O nome do grupo de recursos.
subscriptionId	path	True	string	A ID da assinatura.
api-version	query	True	string	Versão da API do cliente.

Corpo da solicitação

Nome	Tipo	Description
location	string	A localização do recurso.
properties.description	string	A descrição da política.
properties.evaluatorType	PolicyEvaluatorType	O tipo de avaliador da política (ou seja, AllowedValuesPolicy, MaxValuePolicy).
properties.factData	string	Os dados de fato da política.
properties.factName	PolicyFactName	O nome do fato da política (por exemplo, LabVmCount, LabVmSize, MaxVmsAllowedPerLab etc.
properties.status	PolicyStatus	O status da política.
properties.threshold	string	O limite da política (ou seja, um número para MaxValuePolicy e uma matriz JSON de valores para AllowedValuesPolicy).
tags	object	As marcas do recurso.

Respostas

Nome	Tipo	Description
200 OK	Policy	OKEY
201 Created	Policy	Criado
Other Status Codes	CloudError	Solicitação Inválida

Segurança

azure_auth

Concessão Implícita OAuth2

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

Escopos

Nome	Description
user_impersonation	Acessar o Microsoft Azure

Exemplos

Policies_CreateOrUpdate

Solicitação de exemplo

HTTP

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

{
  "location": "{location}",
  "tags": {
    "tagName1": "tagValue1"
  },
  "properties": {
    "description": "{policyDescription}",
    "status": "{policyStatus}",
    "factName": "{policyFactName}",
    "factData": "{policyFactData}",
    "threshold": "{policyThreshold}",
    "evaluatorType": "{policyEvaluatorType}"
  }
}

Java

import com.azure.resourcemanager.devtestlabs.models.PolicyEvaluatorType;
import com.azure.resourcemanager.devtestlabs.models.PolicyFactName;
import com.azure.resourcemanager.devtestlabs.models.PolicyStatus;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for Policies CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/
     * Policies_CreateOrUpdate.json
     */
    /**
     * Sample code: Policies_CreateOrUpdate.
     * 
     * @param manager Entry point to DevTestLabsManager.
     */
    public static void policiesCreateOrUpdate(com.azure.resourcemanager.devtestlabs.DevTestLabsManager manager) {
        manager.policies().define("{policyName}").withRegion("{location}")
            .withExistingPolicyset("resourceGroupName", "{labName}", "{policySetName}")
            .withTags(mapOf("tagName1", "tagValue1")).withDescription("{policyDescription}")
            .withStatus(PolicyStatus.fromString("{policyStatus}"))
            .withFactName(PolicyFactName.fromString("{policyFactName}")).withFactData("{policyFactData}")
            .withThreshold("{policyThreshold}")
            .withEvaluatorType(PolicyEvaluatorType.fromString("{policyEvaluatorType}")).create();
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

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 policies_create_or_update.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.policies.create_or_update(
        resource_group_name="resourceGroupName",
        lab_name="{labName}",
        policy_set_name="{policySetName}",
        name="{policyName}",
        policy={
            "location": "{location}",
            "properties": {
                "description": "{policyDescription}",
                "evaluatorType": "{policyEvaluatorType}",
                "factData": "{policyFactData}",
                "factName": "{policyFactName}",
                "status": "{policyStatus}",
                "threshold": "{policyThreshold}",
            },
            "tags": {"tagName1": "tagValue1"},
        },
    )
    print(response)


# x-ms-original-file: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Policies_CreateOrUpdate.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/Policies_CreateOrUpdate.json
func ExamplePoliciesClient_CreateOrUpdate() {
	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.NewPoliciesClient().CreateOrUpdate(ctx, "resourceGroupName", "{labName}", "{policySetName}", "{policyName}", armdevtestlabs.Policy{
		Location: to.Ptr("{location}"),
		Tags: map[string]*string{
			"tagName1": to.Ptr("tagValue1"),
		},
		Properties: &armdevtestlabs.PolicyProperties{
			Description:   to.Ptr("{policyDescription}"),
			EvaluatorType: to.Ptr(armdevtestlabs.PolicyEvaluatorType("{policyEvaluatorType}")),
			FactData:      to.Ptr("{policyFactData}"),
			FactName:      to.Ptr(armdevtestlabs.PolicyFactName("{policyFactName}")),
			Status:        to.Ptr(armdevtestlabs.PolicyStatus("{policyStatus}")),
			Threshold:     to.Ptr("{policyThreshold}"),
		},
	}, 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.Policy = armdevtestlabs.Policy{
	// 	Name: to.Ptr("{labName}"),
	// 	Type: to.Ptr("Microsoft.DevTestLab/labs/policies"),
	// 	ID: to.Ptr("/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}/policysets/{policySetName}/policies/{policyName}"),
	// 	Location: to.Ptr("{location}"),
	// 	Properties: &armdevtestlabs.PolicyProperties{
	// 		Description: to.Ptr("{policyDescription}"),
	// 		CreatedDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-10-02T01:40:48.173Z"); return t}()),
	// 		EvaluatorType: to.Ptr(armdevtestlabs.PolicyEvaluatorType("{policyEvaluatorType}")),
	// 		FactData: to.Ptr("{policyFactData}"),
	// 		FactName: to.Ptr(armdevtestlabs.PolicyFactName("{policyFactName}")),
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		Status: to.Ptr(armdevtestlabs.PolicyStatus("{policyStatus}")),
	// 		Threshold: to.Ptr("{policyThreshold}"),
	// 		UniqueIdentifier: to.Ptr("{uniqueIdentifier}"),
	// 	},
	// }
}

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 Create or replace an existing policy.
 *
 * @summary Create or replace an existing policy.
 * x-ms-original-file: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Policies_CreateOrUpdate.json
 */
async function policiesCreateOrUpdate() {
  const subscriptionId = "{subscriptionId}";
  const resourceGroupName = "resourceGroupName";
  const labName = "{labName}";
  const policySetName = "{policySetName}";
  const name = "{policyName}";
  const policy = {
    description: "{policyDescription}",
    evaluatorType: "{policyEvaluatorType}",
    factData: "{policyFactData}",
    factName: "{policyFactName}",
    location: "{location}",
    status: "{policyStatus}",
    tags: { tagName1: "tagValue1" },
    threshold: "{policyThreshold}",
  };
  const credential = new DefaultAzureCredential();
  const client = new DevTestLabsClient(credential, subscriptionId);
  const result = await client.policies.createOrUpdate(
    resourceGroupName,
    labName,
    policySetName,
    name,
    policy
  );
  console.log(result);
}

policiesCreateOrUpdate().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 Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.DevTestLabs.Models;
using Azure.ResourceManager.DevTestLabs;

// Generated from example definition: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Policies_CreateOrUpdate.json
// this example is just showing the usage of "Policies_CreateOrUpdate" 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);

// get the collection of this DevTestLabPolicyResource
string policySetName = "{policySetName}";
DevTestLabPolicyCollection collection = devTestLab.GetDevTestLabPolicies(policySetName);

// invoke the operation
string name = "{policyName}";
DevTestLabPolicyData data = new DevTestLabPolicyData(new AzureLocation("{location}"))
{
    Description = "{policyDescription}",
    Status = new DevTestLabPolicyStatus("{policyStatus}"),
    FactName = new DevTestLabPolicyFactName("{policyFactName}"),
    FactData = "{policyFactData}",
    Threshold = "{policyThreshold}",
    EvaluatorType = new DevTestLabPolicyEvaluatorType("{policyEvaluatorType}"),
    Tags =
    {
    ["tagName1"] = "tagValue1"
    },
};
ArmOperation<DevTestLabPolicyResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, name, data);
DevTestLabPolicyResource result = lro.Value;

// 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
DevTestLabPolicyData 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 de exemplo

Código de status:

200

{
  "id": "/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}/policysets/{policySetName}/policies/{policyName}",
  "name": "{labName}",
  "type": "Microsoft.DevTestLab/labs/policies",
  "location": "{location}",
  "properties": {
    "description": "{policyDescription}",
    "status": "{policyStatus}",
    "factName": "{policyFactName}",
    "factData": "{policyFactData}",
    "threshold": "{policyThreshold}",
    "evaluatorType": "{policyEvaluatorType}",
    "createdDate": "2018-10-01T18:40:48.1739018-07:00",
    "provisioningState": "Succeeded",
    "uniqueIdentifier": "{uniqueIdentifier}"
  }
}

Código de status:

201

{
  "id": "/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}/policysets/{policySetName}/policies/{policyName}",
  "name": "{labName}",
  "type": "Microsoft.DevTestLab/labs/policySets/policies",
  "location": "{location}",
  "properties": {
    "description": "{policyDescription}",
    "status": "{policyStatus}",
    "factName": "{policyFactName}",
    "factData": "{policyFactData}",
    "threshold": "{policyThreshold}",
    "evaluatorType": "{policyEvaluatorType}",
    "createdDate": "2018-10-01T18:40:48.1739018-07:00",
    "provisioningState": "Succeeded",
    "uniqueIdentifier": "{uniqueIdentifier}"
  }
}

Definições

Nome	Description
CloudError	Erro de uma solicitação REST.
CloudErrorBody	Corpo de um erro de uma solicitação REST.
Policy	Uma política.
PolicyEvaluatorType	O tipo de avaliador da política (ou seja, AllowedValuesPolicy, MaxValuePolicy).
PolicyFactName	O nome do fato da política (por exemplo, LabVmCount, LabVmSize, MaxVmsAllowedPerLab etc.
PolicyStatus	O status da política.

CloudError

Objeto

Erro de uma solicitação REST.

Nome	Tipo	Description
error	CloudErrorBody	O erro de nuvem que ocorreu

CloudErrorBody

Objeto

Corpo de um erro de uma solicitação REST.

Nome	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.

Policy

Objeto

Uma política.

Nome	Tipo	Description
id	string	O identificador do recurso.
location	string	A localização do recurso.
name	string	O nome do recurso.
properties.createdDate	string (date-time)	A data de criação da política.
properties.description	string	A descrição da política.
properties.evaluatorType	PolicyEvaluatorType	O tipo de avaliador da política (ou seja, AllowedValuesPolicy, MaxValuePolicy).
properties.factData	string	Os dados de fato da política.
properties.factName	PolicyFactName	O nome do fato da política (por exemplo, LabVmCount, LabVmSize, MaxVmsAllowedPerLab etc.
properties.provisioningState	string	O status de provisionamento do recurso.
properties.status	PolicyStatus	O status da política.
properties.threshold	string	O limite da política (ou seja, um número para MaxValuePolicy e uma matriz JSON de valores para AllowedValuesPolicy).
properties.uniqueIdentifier	string	O identificador imutável exclusivo de um recurso (Guid).
tags	object	As marcas do recurso.
type	string	O tipo do recurso.

PolicyEvaluatorType

Enumeração

O tipo de avaliador da política (ou seja, AllowedValuesPolicy, MaxValuePolicy).

Valor	Description
AllowedValuesPolicy
MaxValuePolicy

PolicyFactName

Enumeração

O nome do fato da política (por exemplo, LabVmCount, LabVmSize, MaxVmsAllowedPerLab etc.

Valor	Description
EnvironmentTemplate
GalleryImage
LabPremiumVmCount
LabTargetCost
LabVmCount
LabVmSize
ScheduleEditPermission
UserOwnedLabPremiumVmCount
UserOwnedLabVmCount
UserOwnedLabVmCountInSubnet

PolicyStatus

Enumeração

O status da política.

Valor	Description
Disabled
Enabled