Labs - Get

Servicio:

Dev Test Labs

Versión de la API:

2018-09-15

Obtener laboratorio.

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

Con parámetros opcionales:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{name}?$expand={$expand}&api-version=2018-09-15

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
name	path	True	string	Nombre del laboratorio.
resourceGroupName	path	True	string	Nombre del grupo de recursos.
subscriptionId	path	True	string	Identificador de suscripción.
api-version	query	True	string	Versión de la API de cliente.
$expand	query		string	Especifique la consulta $expand. Ejemplo: 'properties($select=defaultStorageAccount)'

Respuestas

Nombre	Tipo	Description
200 OK	Lab	De acuerdo
Other Status Codes	CloudError	Solicitud incorrecta

Seguridad

azure_auth

Concesión implícita de OAuth2

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	Acceso a Microsoft Azure

Ejemplos

Labs_Get

Solicitud de ejemplo

HTTP

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

Java

/**
 * Samples for Labs GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Labs_Get.json
     */
    /**
     * Sample code: Labs_Get.
     * 
     * @param manager Entry point to DevTestLabsManager.
     */
    public static void labsGet(com.azure.resourcemanager.devtestlabs.DevTestLabsManager manager) {
        manager.labs().getByResourceGroupWithResponse("resourceGroupName", "{labName}", 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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.devtestlabs import DevTestLabsClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-devtestlabs
# USAGE
    python labs_get.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.labs.get(
        resource_group_name="resourceGroupName",
        name="{labName}",
    )
    print(response)


# x-ms-original-file: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Labs_Get.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/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/Labs_Get.json
func ExampleLabsClient_Get() {
	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.NewLabsClient().Get(ctx, "resourceGroupName", "{labName}", &armdevtestlabs.LabsClientGetOptions{Expand: 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.Lab = armdevtestlabs.Lab{
	// 	Name: to.Ptr("{labName}"),
	// 	Type: to.Ptr("Microsoft.DevTestLab/labs"),
	// 	ID: to.Ptr("/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}"),
	// 	Location: to.Ptr("{location}"),
	// 	Tags: map[string]*string{
	// 		"tagName1": to.Ptr("tagValue1"),
	// 	},
	// 	Properties: &armdevtestlabs.LabProperties{
	// 		Announcement: &armdevtestlabs.LabAnnouncementProperties{
	// 			Enabled: to.Ptr(armdevtestlabs.EnableStatusDisabled),
	// 			Expired: to.Ptr(false),
	// 			Markdown: to.Ptr(""),
	// 			Title: to.Ptr(""),
	// 		},
	// 		ArtifactsStorageAccount: to.Ptr("/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.Storage/storageAccounts/{storageAccountName}"),
	// 		CreatedDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-10-02T01:40:48.173Z"); return t}()),
	// 		DefaultPremiumStorageAccount: to.Ptr("/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.Storage/storageAccounts/{storageAccountName}"),
	// 		DefaultStorageAccount: to.Ptr("/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.Storage/storageAccounts/{storageAccountName}"),
	// 		EnvironmentPermission: to.Ptr(armdevtestlabs.EnvironmentPermissionReader),
	// 		LabStorageType: to.Ptr(armdevtestlabs.StorageTypeStandard),
	// 		MandatoryArtifactsResourceIDsLinux: []*string{
	// 		},
	// 		MandatoryArtifactsResourceIDsWindows: []*string{
	// 		},
	// 		PremiumDataDiskStorageAccount: to.Ptr("/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.Storage/storageAccounts/{storageAccountName}"),
	// 		PremiumDataDisks: to.Ptr(armdevtestlabs.PremiumDataDiskDisabled),
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		Support: &armdevtestlabs.LabSupportProperties{
	// 			Enabled: to.Ptr(armdevtestlabs.EnableStatusDisabled),
	// 			Markdown: to.Ptr(""),
	// 		},
	// 		UniqueIdentifier: to.Ptr("{uniqueIdentifier}"),
	// 		VaultName: to.Ptr("/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/{keyVaultName}"),
	// 	},
	// }
}

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 Get lab.
 *
 * @summary Get lab.
 * x-ms-original-file: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Labs_Get.json
 */
async function labsGet() {
  const subscriptionId = "{subscriptionId}";
  const resourceGroupName = "resourceGroupName";
  const name = "{labName}";
  const credential = new DefaultAzureCredential();
  const client = new DevTestLabsClient(credential, subscriptionId);
  const result = await client.labs.get(resourceGroupName, name);
  console.log(result);
}

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

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

// invoke the operation
DevTestLabResource result = await devTestLab.GetAsync();

// 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
DevTestLabData 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

Respuesta de muestra

status code:

200

{
  "properties": {
    "defaultStorageAccount": "/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.Storage/storageAccounts/{storageAccountName}",
    "defaultPremiumStorageAccount": "/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.Storage/storageAccounts/{storageAccountName}",
    "artifactsStorageAccount": "/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.Storage/storageAccounts/{storageAccountName}",
    "premiumDataDiskStorageAccount": "/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.Storage/storageAccounts/{storageAccountName}",
    "vaultName": "/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/{keyVaultName}",
    "labStorageType": "Standard",
    "mandatoryArtifactsResourceIdsLinux": [],
    "mandatoryArtifactsResourceIdsWindows": [],
    "createdDate": "2018-10-01T18:40:48.1739018-07:00",
    "premiumDataDisks": "Disabled",
    "environmentPermission": "Reader",
    "announcement": {
      "title": "",
      "markdown": "",
      "enabled": "Disabled",
      "expired": false
    },
    "support": {
      "enabled": "Disabled",
      "markdown": ""
    },
    "provisioningState": "Succeeded",
    "uniqueIdentifier": "{uniqueIdentifier}"
  },
  "id": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}",
  "name": "{labName}",
  "type": "Microsoft.DevTestLab/labs",
  "location": "{location}",
  "tags": {
    "tagName1": "tagValue1"
  }
}

Definiciones

Nombre	Description
CloudError	Error de una solicitud REST.
CloudErrorBody	Cuerpo de un error de una solicitud REST.
EnableStatus	Estado de la programación (es decir, Habilitado, Deshabilitado)
EnvironmentPermission	Derechos de acceso que se van a conceder al usuario al aprovisionar un entorno
Lab	Un laboratorio.
LabAnnouncementProperties	Propiedades del banner de anuncio de un laboratorio
LabSupportProperties	Propiedades del banner de soporte técnico de un laboratorio
PremiumDataDisk	Configuración para habilitar el uso de discos de datos Premium. Cuando su valor es "Habilitado", se permite la creación de discos de datos estándar o Premium. Cuando su valor es "Disabled", solo se permite la creación de discos de datos estándar.
StorageType	Tipo de almacenamiento para el disco (es decir, Estándar, Premium).

CloudError

Object

Error de una solicitud REST.

Nombre	Tipo	Description
error	CloudErrorBody	Error en la nube que se produjo

CloudErrorBody

Object

Cuerpo de un error de una solicitud REST.

Nombre	Tipo	Description
code	string	Código de error.
details	CloudErrorBody[]	Errores internos.
message	string	Mensaje de error.
target	string	Destino del error.

EnableStatus

Enumeración

Estado de la programación (es decir, Habilitado, Deshabilitado)

Valor	Description
Disabled
Enabled

EnvironmentPermission

Enumeración

Derechos de acceso que se van a conceder al usuario al aprovisionar un entorno

Valor	Description
Contributor
Reader

Lab

Object

Un laboratorio.

Nombre	Tipo	Valor predeterminado	Description
id	string		Identificador del recurso.
location	string		La ubicación del recurso.
name	string		Nombre del recurso.
properties.announcement	LabAnnouncementProperties		Propiedades de cualquier anuncio de laboratorio asociado a este laboratorio
properties.artifactsStorageAccount	string		Cuenta de almacenamiento de artefactos del laboratorio.
properties.createdDate	string (date-time)		Fecha de creación del laboratorio.
properties.defaultPremiumStorageAccount	string		La cuenta de premium storage predeterminada del laboratorio.
properties.defaultStorageAccount	string		La cuenta de almacenamiento predeterminada del laboratorio.
properties.environmentPermission	EnvironmentPermission		Derechos de acceso que se van a conceder al usuario al aprovisionar un entorno
properties.extendedProperties	object		Propiedades extendidas del laboratorio usadas para características experimentales
properties.labStorageType	StorageType	Premium	Tipo de almacenamiento usado por el laboratorio. Puede ser Premium o Estándar. El valor predeterminado es Premium.
properties.loadBalancerId	string		Equilibrador de carga que se usa para las máquinas virtuales de laboratorio que usan la dirección IP compartida.
properties.mandatoryArtifactsResourceIdsLinux	string[]		Lista ordenada de identificadores de recursos de artefacto que se deben aplicar en todas las creaciones de máquinas virtuales Linux de forma predeterminada, antes de los artefactos especificados por el usuario.
properties.mandatoryArtifactsResourceIdsWindows	string[]		Lista ordenada de identificadores de recursos de artefacto que se deben aplicar en todas las creaciones de máquinas virtuales Windows de forma predeterminada, antes de los artefactos especificados por el usuario.
properties.networkSecurityGroupId	string		El grupo de seguridad de red conectado a las interfaces de red de las máquinas virtuales del laboratorio para restringir los puertos abiertos.
properties.premiumDataDiskStorageAccount	string		Cuenta de almacenamiento en disco de datos Premium del laboratorio.
properties.premiumDataDisks	PremiumDataDisk		Configuración para habilitar el uso de discos de datos Premium. Cuando su valor es "Habilitado", se permite la creación de discos de datos estándar o Premium. Cuando su valor es "Disabled", solo se permite la creación de discos de datos estándar.
properties.provisioningState	string		Estado de aprovisionamiento del recurso.
properties.publicIpId	string		Dirección IP pública del equilibrador de carga del laboratorio.
properties.support	LabSupportProperties		Propiedades de cualquier mensaje de soporte técnico de laboratorio asociado a este laboratorio
properties.uniqueIdentifier	string		Identificador inmutable único de un recurso (Guid).
properties.vaultName	string		Almacén de claves del laboratorio.
properties.vmCreationResourceGroup	string		Grupo de recursos en el que se crearán todas las máquinas virtuales de laboratorio nuevas. Para permitir que DevTest Labs administre la creación del grupo de recursos, establezca este valor en NULL.
tags	object		Etiquetas del recurso.
type	string		Tipo del recurso.

LabAnnouncementProperties

Object

Propiedades del banner de anuncio de un laboratorio

Nombre	Tipo	Description
enabled	EnableStatus	¿El anuncio del laboratorio está activo o habilitado en este momento?
expirationDate	string (date-time)	Hora a la que expira el anuncio (null para nunca)
expired	boolean	¿Ha expirado este anuncio?
markdown	string	Texto markdown (si existe) que este laboratorio muestra en la interfaz de usuario. Si se deja vacío o nulo, no se mostrará nada.
provisioningState	string	Estado de aprovisionamiento del recurso.
title	string	Título de texto sin formato del anuncio del laboratorio
uniqueIdentifier	string	Identificador inmutable único de un recurso (Guid).

LabSupportProperties

Object

Propiedades del banner de soporte técnico de un laboratorio

Nombre	Tipo	Description
enabled	EnableStatus	¿El banner de soporte técnico del laboratorio está activo o habilitado en este momento?
markdown	string	Texto markdown (si existe) que este laboratorio muestra en la interfaz de usuario. Si se deja vacío o nulo, no se mostrará nada.

PremiumDataDisk

Enumeración

Configuración para habilitar el uso de discos de datos Premium. Cuando su valor es "Habilitado", se permite la creación de discos de datos estándar o Premium. Cuando su valor es "Disabled", solo se permite la creación de discos de datos estándar.

Valor	Description
Disabled
Enabled

StorageType

Enumeración

Tipo de almacenamiento para el disco (es decir, Estándar, Premium).

Valor	Description
Premium
Standard
StandardSSD