Environments - List

Ссылка

Service:: Dev Test Labs

API Version:: 2018-09-15

Вывод списка сред в заданном профиле пользователя.

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

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/environments?$expand={$expand}&$filter={$filter}&$top={$top}&$orderby={$orderby}&api-version=2018-09-15

Параметры URI

Имя	В	Обязательно	Тип	Описание
labName	path	True	string	Имя лаборатории.
resourceGroupName	path	True	string	Имя группы ресурсов.
subscriptionId	path	True	string	Идентификатор подписки.
userName	path	True	string	Имя профиля пользователя.
api-version	query	True	string	Версия API клиента.
$expand	query		string	Укажите запрос $expand. Пример: 'properties($select=deploymentProperties)'
$filter	query		string	Фильтр, применяемый к операции. Пример: '$filter=contains(name;'myName')
$orderby	query		string	Упорядоченное выражение для результатов с использованием нотации OData. Пример: "$orderby=name desc"
$top	query		integer int32	Максимальное количество ресурсов, возвращаемых операцией. Пример: "$top=10"

Ответы

Имя	Тип	Описание
200 OK	DtlEnvironmentList	ОК
Other Status Codes	CloudError	BadRequest

Безопасность

azure_auth

Неявное предоставление OAuth2

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

Scopes

Имя	Описание
user_impersonation	Доступ к Microsoft Azure

Примеры

Environments_List

Sample Request

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

/** Samples for Environments List. */
public final class Main {
    /*
     * x-ms-original-file: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Environments_List.json
     */
    /**
     * Sample code: Environments_List.
     *
     * @param manager Entry point to DevTestLabsManager.
     */
    public static void environmentsList(com.azure.resourcemanager.devtestlabs.DevTestLabsManager manager) {
        manager
            .environments()
            .list("resourceGroupName", "{labName}", "@me", null, null, null, null, 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

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

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-devtestlabs
# USAGE
    python environments_list.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.list(
        resource_group_name="resourceGroupName",
        lab_name="{labName}",
        user_name="@me",
    )
    for item in response:
        print(item)


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

package armdevtestlabs_test

import (
	"context"
	"log"

	"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_List.json
func ExampleEnvironmentsClient_NewListPager() {
	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)
	}
	pager := clientFactory.NewEnvironmentsClient().NewListPager("resourceGroupName", "{labName}", "@me", &armdevtestlabs.EnvironmentsClientListOptions{Expand: nil,
		Filter:  nil,
		Top:     nil,
		Orderby: nil,
	})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.DtlEnvironmentList = armdevtestlabs.DtlEnvironmentList{
		// 	Value: []*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

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

/**
 * This sample demonstrates how to List environments in a given user profile.
 *
 * @summary List environments in a given user profile.
 * x-ms-original-file: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Environments_List.json
 */
async function environmentsList() {
  const subscriptionId = "{subscriptionId}";
  const resourceGroupName = "resourceGroupName";
  const labName = "{labName}";
  const userName = "@me";
  const credential = new DefaultAzureCredential();
  const client = new DevTestLabsClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.environments.list(resourceGroupName, labName, userName)) {
    resArray.push(item);
  }
  console.log(resArray);
}

environmentsList().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

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_List.json
// this example is just showing the usage of "Environments_List" 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 and iterate over the result
await foreach (DevTestLabEnvironmentResource item in collection.GetAllAsync())
{
    // the variable item 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 = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine($"Succeeded");

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

{
  "value": [
    {
      "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"
      }
    }
  ]
}

Определения

Имя	Описание
ArmTemplateParameterProperties	Свойства параметра шаблона azure Resource Manager.
CloudError	Ошибка из запроса REST.
CloudErrorBody	Текст ошибки из запроса REST.
DtlEnvironment	Среда, которая по сути является развертыванием шаблона ARM.
DtlEnvironmentList	Ответ операции со списком.
EnvironmentDeploymentProperties	Свойства развертывания среды.

ArmTemplateParameterProperties

Свойства параметра шаблона azure Resource Manager.

Имя	Тип	Описание
name	string	Имя параметра шаблона.
value	string	Значение параметра шаблона.

CloudError

Ошибка из запроса REST.

Имя	Тип	Описание
error	CloudErrorBody	Произошла облачная ошибка

CloudErrorBody

Текст ошибки из запроса REST.

Имя	Тип	Описание
code	string	Код ошибки.
details	CloudErrorBody[]	Внутренние ошибки.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

DtlEnvironment

Среда, которая по сути является развертыванием шаблона ARM.

Имя	Тип	Описание
id	string	Идентификатор ресурса.
location	string	Расположение ресурса.
name	string	Имя ресурса.
properties.armTemplateDisplayName	string	Отображаемое имя шаблона azure Resource Manager, создающего среду.
properties.createdByUser	string	Создатель среды.
properties.deploymentProperties	EnvironmentDeploymentProperties	Свойства развертывания среды.
properties.provisioningState	string	Состояние подготовки ресурса.
properties.resourceGroupId	string	Идентификатор группы ресурсов, содержащей ресурсы среды.
properties.uniqueIdentifier	string	Уникальный неизменяемый идентификатор ресурса (Guid).
tags	object	Теги ресурса.
type	string	Тип ресурса.

DtlEnvironmentList

Ответ операции со списком.

Имя	Тип	Описание
nextLink	string	Ссылка для следующего набора результатов.
value	DtlEnvironment[]	Результаты операции со списком.

EnvironmentDeploymentProperties

Свойства развертывания среды.

Имя	Тип	Описание
armTemplateId	string	Идентификатор шаблона azure Resource Manager.
parameters	ArmTemplateParameterProperties[]	Параметры шаблона Azure Resource Manager.