Environments - Create Or Update

Service:

Dev Test Labs

API Version:

2018-09-15

Skapa eller ersätta en befintlig miljö. Den här åtgärden tar ett tag att slutföra.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
labName	path	True	string	Namnet på labbet.
name	path	True	string	Namnet på miljön.
resourceGroupName	path	True	string	Namnet på resursgruppen.
subscriptionId	path	True	string	Prenumerations-ID: t.
userName	path	True	string	Namnet på användarprofilen.
api-version	query	True	string	Klient-API-version.

Begärandetext

Name	Typ	Description
location	string	Platsen för resursen.
properties.armTemplateDisplayName	string	Visningsnamnet för den Azure Resource Manager-mall som skapade miljön.
properties.deploymentProperties	EnvironmentDeploymentProperties	Distributionsegenskaperna för miljön.
tags	object	Taggarna för resursen.

Svar

Name	Typ	Description
200 OK	DtlEnvironment	OK
201 Created	DtlEnvironment	Skapad
Other Status Codes	CloudError	BadRequest

Säkerhet

azure_auth

Implicit beviljande av OAuth2

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

Scopes

Name	Description
user_impersonation	Få åtkomst till Microsoft Azure

Exempel

Environments_CreateOrUpdate

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}/users/@me/environments/{environmentName}?api-version=2018-09-15

{
  "properties": {
    "deploymentProperties": {
      "parameters": [],
      "armTemplateId": "/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}/artifactSources/{artifactSourceName}/armTemplates/{armTemplateName}"
    }
  }
}

Java

import com.azure.resourcemanager.devtestlabs.models.EnvironmentDeploymentProperties;
import java.util.Arrays;

/** Samples for Environments CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Environments_CreateOrUpdate.json
     */
    /**
     * Sample code: Environments_CreateOrUpdate.
     *
     * @param manager Entry point to DevTestLabsManager.
     */
    public static void environmentsCreateOrUpdate(com.azure.resourcemanager.devtestlabs.DevTestLabsManager manager) {
        manager
            .environments()
            .define("{environmentName}")
            .withRegion((String) null)
            .withExistingUser("resourceGroupName", "{labName}", "@me")
            .withDeploymentProperties(
                new EnvironmentDeploymentProperties()
                    .withArmTemplateId(
                        "/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}/artifactSources/{artifactSourceName}/armTemplates/{armTemplateName}")
                    .withParameters(Arrays.asList()))
            .create();
    }
}

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 environments_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.environments.begin_create_or_update(
        resource_group_name="resourceGroupName",
        lab_name="{labName}",
        user_name="@me",
        name="{environmentName}",
        dtl_environment={
            "properties": {
                "deploymentProperties": {
                    "armTemplateId": "/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}/artifactSources/{artifactSourceName}/armTemplates/{armTemplateName}",
                    "parameters": [],
                }
            }
        },
    ).result()
    print(response)


# x-ms-original-file: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Environments_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/Environments_CreateOrUpdate.json
func ExampleEnvironmentsClient_BeginCreateOrUpdate() {
	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)
	}
	poller, err := clientFactory.NewEnvironmentsClient().BeginCreateOrUpdate(ctx, "resourceGroupName", "{labName}", "@me", "{environmentName}", armdevtestlabs.DtlEnvironment{
		Properties: &armdevtestlabs.EnvironmentProperties{
			DeploymentProperties: &armdevtestlabs.EnvironmentDeploymentProperties{
				ArmTemplateID: to.Ptr("/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}/artifactSources/{artifactSourceName}/armTemplates/{armTemplateName}"),
				Parameters:    []*armdevtestlabs.ArmTemplateParameterProperties{},
			},
		},
	}, 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.DtlEnvironment = armdevtestlabs.DtlEnvironment{
	// 	Name: to.Ptr("{environmentName}"),
	// 	Type: to.Ptr("Microsoft.DevTestLab/labs/users/environments"),
	// 	ID: to.Ptr("/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}/users/{uniqueIdentifier}/environments/{environmentName}"),
	// 	Location: to.Ptr("{location}"),
	// 	Tags: map[string]*string{
	// 		"tagName1": to.Ptr("tagValue1"),
	// 	},
	// 	Properties: &armdevtestlabs.EnvironmentProperties{
	// 		CreatedByUser: to.Ptr("user@contoso.com"),
	// 		DeploymentProperties: &armdevtestlabs.EnvironmentDeploymentProperties{
	// 			ArmTemplateID: to.Ptr("/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}/artifactSources/{artifactSourceName}/armTemplates/{armTemplateName}"),
	// 		},
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		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 environment. This operation can take a while to complete.
 *
 * @summary Create or replace an existing environment. This operation can take a while to complete.
 * x-ms-original-file: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Environments_CreateOrUpdate.json
 */
async function environmentsCreateOrUpdate() {
  const subscriptionId = "{subscriptionId}";
  const resourceGroupName = "resourceGroupName";
  const labName = "{labName}";
  const userName = "@me";
  const name = "{environmentName}";
  const dtlEnvironment = {
    deploymentProperties: {
      armTemplateId:
        "/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}/artifactSources/{artifactSourceName}/armTemplates/{armTemplateName}",
      parameters: [],
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new DevTestLabsClient(credential, subscriptionId);
  const result = await client.environments.beginCreateOrUpdateAndWait(
    resourceGroupName,
    labName,
    userName,
    name,
    dtlEnvironment
  );
  console.log(result);
}

environmentsCreateOrUpdate().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;

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

// get the collection of this DevTestLabEnvironmentResource
DevTestLabEnvironmentCollection collection = devTestLabUser.GetDevTestLabEnvironments();

// invoke the operation
string name = "{environmentName}";
DevTestLabEnvironmentData data = new DevTestLabEnvironmentData(new AzureLocation("placeholder"))
{
    DeploymentProperties = new DevTestLabEnvironmentDeployment()
    {
        ArmTemplateId = new ResourceIdentifier("/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}/artifactSources/{artifactSourceName}/armTemplates/{armTemplateName}"),
        Parameters =
        {
        },
    },
};
ArmOperation<DevTestLabEnvironmentResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, name, data);
DevTestLabEnvironmentResource 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
DevTestLabEnvironmentData 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

Sample Response

Status code:

200

{
  "id": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}/users/{uniqueIdentifier}/environments/{environmentName}",
  "name": "{environmentName}",
  "type": "Microsoft.DevTestLab/labs/users/environments",
  "location": "{location}",
  "properties": {
    "deploymentProperties": {
      "armTemplateId": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}/artifactSources/{artifactSourceName}/armTemplates/{armTemplateName}"
    },
    "createdByUser": "user@contoso.com",
    "provisioningState": "Succeeded",
    "uniqueIdentifier": "{uniqueIdentifier}"
  },
  "tags": {
    "tagName1": "tagValue1"
  }
}

Status code:

201

{
  "id": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}/users/{uniqueIdentifier}/environments/{environmentName}",
  "name": "{environmentName}",
  "type": "Microsoft.DevTestLab/labs/users/environments",
  "location": "{location}",
  "properties": {
    "deploymentProperties": {
      "armTemplateId": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}/artifactSources/{artifactSourceName}/armTemplates/{armTemplateName}"
    },
    "createdByUser": "user@contoso.com",
    "provisioningState": "Creating",
    "uniqueIdentifier": "{uniqueIdentifier}"
  },
  "tags": {
    "tagName1": "tagValue1"
  }
}

Definitioner

Name	Description
ArmTemplateParameterProperties	Egenskaper för en Azure Resource Manager-mallparameter.
CloudError	Fel från en REST-begäran.
CloudErrorBody	Brödtext för ett fel från en REST-begäran.
DtlEnvironment	En miljö, som i princip är en DISTRIBUTION av ARM-mallar.
EnvironmentDeploymentProperties	Egenskaper för en miljödistribution.

ArmTemplateParameterProperties

Egenskaper för en Azure Resource Manager-mallparameter.

Name	Typ	Description
name	string	Namnet på mallparametern.
value	string	Värdet för mallparametern.

CloudError

Fel från en REST-begäran.

Name	Typ	Description
error	CloudErrorBody	Molnfelet som inträffade

CloudErrorBody

Brödtext för ett fel från en REST-begäran.

Name	Typ	Description
code	string	Felkoden.
details	CloudErrorBody[]	Inre fel.
message	string	Felmeddelandet.
target	string	Felmålet.

DtlEnvironment

En miljö, som i princip är en DISTRIBUTION av ARM-mallar.

Name	Typ	Description
id	string	Resursens identifierare.
location	string	Platsen för resursen.
name	string	Namnet på resursen.
properties.armTemplateDisplayName	string	Visningsnamnet för den Azure Resource Manager-mall som skapade miljön.
properties.createdByUser	string	Skaparen av miljön.
properties.deploymentProperties	EnvironmentDeploymentProperties	Distributionsegenskaperna för miljön.
properties.provisioningState	string	Resursens etableringsstatus.
properties.resourceGroupId	string	Identifieraren för resursgruppen som innehåller miljöns resurser.
properties.uniqueIdentifier	string	Den unika oföränderliga identifieraren för en resurs (GUID).
tags	object	Taggarna för resursen.
type	string	Resurstypen.

EnvironmentDeploymentProperties

Egenskaper för en miljödistribution.

Name	Typ	Description
armTemplateId	string	Azure Resource Manager-mallens identifierare.
parameters	ArmTemplateParameterProperties[]	Parametrarna för Azure Resource Manager-mallen.