Compartir a través de


Virtual Machines - List

Enumere las máquinas virtuales de un laboratorio determinado.

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
labName
path True

string

El nombre del laboratorio.

resourceGroupName
path True

string

Nombre del grupo de recursos.

subscriptionId
path True

string

Identificador de la suscripción.

api-version
query True

string

Versión de API del cliente.

$expand
query

string

Especifique la consulta de $expand. Ejemplo: 'properties($expand=artifacts,computeVm,networkInterface,applicableSchedule)'

$filter
query

string

Filtro que se va a aplicar a la operación. Ejemplo: '$filter=contains(name,'myName')

$orderby
query

string

Expresión de ordenación de los resultados, mediante notación OData. Ejemplo: '$orderby=name desc'

$top
query

integer

int32

Número máximo de recursos que se van a devolver de la operación. Ejemplo: "$top=10"

Respuestas

Nombre Tipo Description
200 OK

LabVirtualMachineList

Aceptar

Other Status Codes

CloudError

BadRequest

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

VirtualMachines_List

Solicitud de ejemplo

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

Respuesta de muestra

{
  "value": [
    {
      "properties": {
        "ownerObjectId": "",
        "ownerUserPrincipalName": "",
        "createdByUserId": "",
        "createdByUser": "",
        "createdDate": "2018-10-01T16:53:02.4830866-07:00",
        "computeId": "/subscriptions/{subscriptionId}/resourceGroups/{labName}-{vmName}-{randomSuffix}/providers/Microsoft.Compute/virtualMachines/{vmName}",
        "osType": "Linux",
        "size": "Standard_A2_v2",
        "userName": "{userName}",
        "labSubnetName": "{virtualNetworkName}Subnet",
        "labVirtualNetworkId": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}/virtualnetworks/{virtualNetworkName}",
        "disallowPublicIpAddress": true,
        "artifactDeploymentStatus": {
          "artifactsApplied": 0,
          "totalArtifacts": 0
        },
        "galleryImageReference": {
          "offer": "UbuntuServer",
          "publisher": "Canonical",
          "sku": "16.04-LTS",
          "osType": "Linux",
          "version": "Latest"
        },
        "networkInterface": {},
        "allowClaim": true,
        "storageType": "Standard",
        "virtualMachineCreationSource": "FromGalleryImage",
        "dataDiskParameters": [],
        "provisioningState": "Succeeded",
        "uniqueIdentifier": "{uniqueIdentifier}"
      },
      "id": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}/virtualmachines/{vmName}",
      "name": "{vmName}",
      "type": "Microsoft.DevTestLab/labs/virtualMachines",
      "location": "{location}",
      "tags": {
        "tagName1": "tagValue1"
      }
    }
  ]
}

Definiciones

Nombre Description
ApplicableSchedule

Programaciones aplicables a una máquina virtual. Es posible que las programaciones se hayan definido en una máquina virtual o en el nivel de laboratorio.

ArtifactDeploymentStatusProperties

Propiedades de una implementación de artefactos.

ArtifactInstallProperties

Propiedades de un artefacto.

ArtifactParameterProperties

Propiedades de un parámetro de artefacto.

AttachNewDataDiskOptions

Propiedades para conectar un nuevo disco a la máquina virtual.

CloudError

Error de una solicitud REST.

CloudErrorBody

Cuerpo de un error de una solicitud REST.

ComputeDataDisk

Discos de datos conectados a una máquina virtual.

ComputeVmInstanceViewStatus

Información de estado sobre una máquina virtual.

ComputeVmProperties

Propiedades de una máquina virtual devuelta por microsoft.Compute API.

DataDiskProperties

Cuerpo de la solicitud para agregar un disco de datos nuevo o existente a una máquina virtual.

DayDetails

Propiedades de una programación diaria.

EnableStatus

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

GalleryImageReference

Información de referencia de una imagen de Azure Marketplace.

HostCachingOptions

Opción de almacenamiento en caché para un disco de datos (es decir, None, ReadOnly, ReadWrite).

HourDetails

Propiedades de una programación por hora.

InboundNatRule

Una regla para NAT: exponer el puerto de una máquina virtual (backendPort) en la dirección IP pública mediante un equilibrador de carga.

LabVirtualMachine

Una máquina virtual.

LabVirtualMachineList

Respuesta de una operación de lista.

NetworkInterfaceProperties

Propiedades de una interfaz de red.

NotificationSettings

Configuración de notificación para una programación.

Schedule

Una programación.

ScheduleCreationParameter

Propiedades para crear una programación.

SharedPublicIpAddressConfiguration

Propiedades de una máquina virtual que determinan cómo se conecta a un equilibrador de carga.

StorageType

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

TransportProtocol

Protocolo de transporte para el extremo.

VirtualMachineCreationSource

Indica el origen de la creación de una máquina virtual de laboratorio. Solo propiedad de salida.

WeekDetails

Propiedades de una programación semanal.

ApplicableSchedule

Programaciones aplicables a una máquina virtual. Es posible que las programaciones se hayan definido en una máquina virtual o en el nivel de laboratorio.

Nombre Tipo Description
id

string

Identificador del recurso.

location

string

Ubicación del recurso.

name

string

Nombre del recurso.

properties.labVmsShutdown

Schedule

La programación de apagado automático, si se ha establecido uno en el nivel de recurso de laboratorio o laboratorio.

properties.labVmsStartup

Schedule

La programación de inicio automático, si se ha establecido una en el nivel de recurso de laboratorio o laboratorio.

tags

object

Etiquetas del recurso.

type

string

Tipo de recurso.

ArtifactDeploymentStatusProperties

Propiedades de una implementación de artefactos.

Nombre Tipo Description
artifactsApplied

integer

Recuento total de los artefactos que se aplicaron correctamente.

deploymentStatus

string

Estado de implementación del artefacto.

totalArtifacts

integer

Recuento total de los artefactos que se aplicaron provisionalmente.

ArtifactInstallProperties

Propiedades de un artefacto.

Nombre Tipo Description
artifactId

string

Identificador del artefacto.

artifactTitle

string

Título del artefacto.

deploymentStatusMessage

string

Mensaje de estado de la implementación.

installTime

string

Hora a la que el artefacto comienza a instalarse en la máquina virtual.

parameters

ArtifactParameterProperties[]

Parámetros del artefacto.

status

string

Estado del artefacto.

vmExtensionStatusMessage

string

Mensaje de estado de la extensión de máquina virtual.

ArtifactParameterProperties

Propiedades de un parámetro de artefacto.

Nombre Tipo Description
name

string

Nombre del parámetro artifact.

value

string

Valor del parámetro artifact.

AttachNewDataDiskOptions

Propiedades para conectar un nuevo disco a la máquina virtual.

Nombre Tipo Description
diskName

string

Nombre del disco que se va a conectar.

diskSizeGiB

integer

Tamaño del disco que se va a conectar en Gibibytes.

diskType

StorageType

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

CloudError

Error de una solicitud REST.

Nombre Tipo Description
error

CloudErrorBody

Error en la nube que se produjo

CloudErrorBody

Cuerpo de un error de una solicitud REST.

Nombre Tipo Description
code

string

Código de error.

details

CloudErrorBody[]

Errores internos.

message

string

El mensaje de error.

target

string

Destino del error.

ComputeDataDisk

Discos de datos conectados a una máquina virtual.

Nombre Tipo Description
diskSizeGiB

integer

Obtiene el tamaño del disco de datos en GiB.

diskUri

string

Cuando un blob está respaldado por un blob, el URI del blob subyacente.

managedDiskId

string

Cuando está respaldado por un disco administrado, este es el identificador del recurso de disco de proceso.

name

string

Obtiene el nombre del disco de datos.

ComputeVmInstanceViewStatus

Información de estado sobre una máquina virtual.

Nombre Tipo Description
code

string

Obtiene el código de estado.

displayStatus

string

Obtiene la etiqueta localizable corta para el estado.

message

string

Obtiene el mensaje asociado al estado.

ComputeVmProperties

Propiedades de una máquina virtual devuelta por microsoft.Compute API.

Nombre Tipo Description
dataDiskIds

string[]

Obtiene el URI de blob de discos de datos para la máquina virtual.

dataDisks

ComputeDataDisk[]

Obtiene todos los discos de datos conectados a la máquina virtual.

networkInterfaceId

string

Obtiene el identificador de interfaz de red de la máquina virtual.

osDiskId

string

Obtiene el URI del blob de disco del sistema operativo para la máquina virtual.

osType

string

Obtiene el tipo de sistema operativo de la máquina virtual.

statuses

ComputeVmInstanceViewStatus[]

Obtiene los estados de la máquina virtual.

vmSize

string

Obtiene el tamaño de la máquina virtual.

DataDiskProperties

Cuerpo de la solicitud para agregar un disco de datos nuevo o existente a una máquina virtual.

Nombre Tipo Description
attachNewDataDiskOptions

AttachNewDataDiskOptions

Especifica opciones para conectar un nuevo disco a la máquina virtual.

existingLabDiskId

string

Especifica el identificador de disco de laboratorio existente que se va a conectar a la máquina virtual.

hostCaching

HostCachingOptions

Opción de almacenamiento en caché para un disco de datos (es decir, None, ReadOnly, ReadWrite).

DayDetails

Propiedades de una programación diaria.

Nombre Tipo Description
time

string

Hora del día en que se producirá la programación.

EnableStatus

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

Nombre Tipo Description
Disabled

string

Enabled

string

GalleryImageReference

Información de referencia de una imagen de Azure Marketplace.

Nombre Tipo Description
offer

string

Oferta de la imagen de la galería.

osType

string

Tipo de sistema operativo de la imagen de la galería.

publisher

string

Publicador de la imagen de la galería.

sku

string

SKU de la imagen de la galería.

version

string

Versión de la imagen de la galería.

HostCachingOptions

Opción de almacenamiento en caché para un disco de datos (es decir, None, ReadOnly, ReadWrite).

Nombre Tipo Description
None

string

ReadOnly

string

ReadWrite

string

HourDetails

Propiedades de una programación por hora.

Nombre Tipo Description
minute

integer

Minutos de la hora en que se ejecutará la programación.

InboundNatRule

Una regla para NAT: exponer el puerto de una máquina virtual (backendPort) en la dirección IP pública mediante un equilibrador de carga.

Nombre Tipo Description
backendPort

integer

Puerto al que se redirigirá el tráfico externo.

frontendPort

integer

Puerto de punto de conexión externo de la conexión entrante. El intervalo de valores posibles oscila entre 1 y 65535, ambos inclusive. Si no se especifica, se asignará automáticamente un valor.

transportProtocol

TransportProtocol

Protocolo de transporte para el extremo.

LabVirtualMachine

Una máquina virtual.

Nombre Tipo Valor predeterminado Description
id

string

Identificador del recurso.

location

string

Ubicación del recurso.

name

string

Nombre del recurso.

properties.allowClaim

boolean

False

Indica si otro usuario puede tomar posesión de la máquina virtual.

properties.applicableSchedule

ApplicableSchedule

Programación aplicable para la máquina virtual.

properties.artifactDeploymentStatus

ArtifactDeploymentStatusProperties

Estado de implementación del artefacto para la máquina virtual.

properties.artifacts

ArtifactInstallProperties[]

Artefactos que se van a instalar en la máquina virtual.

properties.computeId

string

Identificador de recurso (Microsoft.Compute) de la máquina virtual.

properties.computeVm

ComputeVmProperties

Propiedades de la máquina virtual de proceso.

properties.createdByUser

string

Dirección de correo electrónico del creador de la máquina virtual.

properties.createdByUserId

string

Identificador de objeto del creador de la máquina virtual.

properties.createdDate

string

Fecha de creación de la máquina virtual.

properties.customImageId

string

Identificador de imagen personalizado de la máquina virtual.

properties.dataDiskParameters

DataDiskProperties[]

Discos de datos nuevos o existentes que se van a conectar a la máquina virtual después de la creación

properties.disallowPublicIpAddress

boolean

False

Indica si la máquina virtual se va a crear sin una dirección IP pública.

properties.environmentId

string

Identificador de recurso del entorno que contiene esta máquina virtual, si existe.

properties.expirationDate

string

Fecha de expiración de la máquina virtual.

properties.fqdn

string

Nombre de dominio completo de la máquina virtual.

properties.galleryImageReference

GalleryImageReference

Referencia de imagen de Microsoft Azure Marketplace de la máquina virtual.

properties.isAuthenticationWithSshKey

boolean

Indica si esta máquina virtual usa una clave SSH para la autenticación.

properties.labSubnetName

string

Nombre de subred del laboratorio de la máquina virtual.

properties.labVirtualNetworkId

string

Identificador de red virtual del laboratorio de la máquina virtual.

properties.lastKnownPowerState

string

Último estado de energía de proceso conocido capturado en DTL

properties.networkInterface

NetworkInterfaceProperties

Propiedades de la interfaz de red.

properties.notes

string

Notas de la máquina virtual.

properties.osType

string

Tipo de sistema operativo de la máquina virtual.

properties.ownerObjectId

string

dynamicValue

Identificador de objeto del propietario de la máquina virtual.

properties.ownerUserPrincipalName

string

Nombre principal de usuario del propietario de la máquina virtual.

properties.password

string

Contraseña del administrador de la máquina virtual.

properties.planId

string

Identificador del plan asociado a la imagen de máquina virtual

properties.provisioningState

string

Estado de aprovisionamiento del recurso.

properties.scheduleParameters

ScheduleCreationParameter[]

Programaciones de máquina virtual que se van a crear

properties.size

string

Tamaño de la máquina virtual.

properties.sshKey

string

Clave SSH del administrador de la máquina virtual.

properties.storageType

string

labStorageType

Tipo de almacenamiento que se va a usar para la máquina virtual (es decir, Estándar, Premium).

properties.uniqueIdentifier

string

Identificador inmutable único de un recurso (Guid).

properties.userName

string

Nombre de usuario de la máquina virtual.

properties.virtualMachineCreationSource

VirtualMachineCreationSource

Indica el origen de la creación de una máquina virtual de laboratorio. Solo propiedad de salida.

tags

object

Etiquetas del recurso.

type

string

Tipo de recurso.

LabVirtualMachineList

Respuesta de una operación de lista.

Nombre Tipo Description
nextLink

string

Vínculo para el siguiente conjunto de resultados.

value

LabVirtualMachine[]

Resultados de la operación de lista.

NetworkInterfaceProperties

Propiedades de una interfaz de red.

Nombre Tipo Description
dnsName

string

Nombre de DNS.

privateIpAddress

string

Dirección IP privada.

publicIpAddress

string

La dirección IP pública.

publicIpAddressId

string

Identificador de recurso de la dirección IP pública.

rdpAuthority

string

La propiedad RdpAuthority es un nombre de host DNS del servidor o una dirección IP seguido del número de puerto de servicio para RDP (Protocolo de escritorio remoto).

sharedPublicIpAddressConfiguration

SharedPublicIpAddressConfiguration

Configuración para compartir una dirección IP pública en varias máquinas virtuales.

sshAuthority

string

La propiedad SshAuthority es un nombre de host DNS del servidor o una dirección IP seguido del número de puerto de servicio para SSH.

subnetId

string

Identificador de recurso de la subred.

virtualNetworkId

string

Identificador de recurso de la red virtual.

NotificationSettings

Configuración de notificación para una programación.

Nombre Tipo Valor predeterminado Description
emailRecipient

string

El destinatario del correo electrónico al que enviar notificaciones (puede ser una lista de direcciones de correo electrónico separadas por punto y coma).

notificationLocale

string

La configuración regional que se va a usar al enviar una notificación (la reserva de idiomas no admitidos es EN).

status

EnableStatus

Disabled

Si las notificaciones están habilitadas para esta programación (es decir, Habilitada, Deshabilitada).

timeInMinutes

integer

Tiempo en minutos antes del evento en el que se enviará la notificación.

webhookUrl

string

Dirección URL del webhook a la que se enviará la notificación.

Schedule

Una programación.

Nombre Tipo Valor predeterminado Description
id

string

Identificador del recurso.

location

string

Ubicación del recurso.

name

string

Nombre del recurso.

properties.createdDate

string

Fecha de creación de la programación.

properties.dailyRecurrence

DayDetails

Si la programación se producirá una vez cada día de la semana, especifique la periodicidad diaria.

properties.hourlyRecurrence

HourDetails

Si la programación se producirá varias veces al día, especifique la periodicidad por hora.

properties.notificationSettings

NotificationSettings

Configuración de notificación.

properties.provisioningState

string

Estado de aprovisionamiento del recurso.

properties.status

EnableStatus

Disabled

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

properties.targetResourceId

string

Identificador de recurso al que pertenece la programación

properties.taskType

string

Tipo de tarea de la programación (por ejemplo, LabVmsShutdownTask, LabVmAutoStart).

properties.timeZoneId

string

El identificador de zona horaria (por ejemplo, hora estándar de China, hora estándar de Groenlandia, hora estándar del Pacífico, etc.). Los valores posibles de esta propiedad se pueden encontrar en IReadOnlyCollection<string> TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md)

properties.uniqueIdentifier

string

Identificador inmutable único de un recurso (Guid).

properties.weeklyRecurrence

WeekDetails

Si la programación se producirá solo algunos días de la semana, especifique la periodicidad semanal.

tags

object

Etiquetas del recurso.

type

string

Tipo de recurso.

ScheduleCreationParameter

Propiedades para crear una programación.

Nombre Tipo Valor predeterminado Description
location

string

Ubicación de la nueva máquina virtual o entorno

name

string

Nombre de la máquina virtual o el entorno

properties.dailyRecurrence

DayDetails

Si la programación se producirá una vez cada día de la semana, especifique la periodicidad diaria.

properties.hourlyRecurrence

HourDetails

Si la programación se producirá varias veces al día, especifique la periodicidad por hora.

properties.notificationSettings

NotificationSettings

Configuración de notificación.

properties.status

EnableStatus

Disabled

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

properties.targetResourceId

string

Identificador de recurso al que pertenece la programación

properties.taskType

string

Tipo de tarea de la programación (por ejemplo, LabVmsShutdownTask, LabVmAutoStart).

properties.timeZoneId

string

El identificador de zona horaria (por ejemplo, hora estándar de China, hora estándar de Groenlandia, hora estándar del Pacífico, etc.). Los valores posibles de esta propiedad se pueden encontrar en IReadOnlyCollection<string> TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md)

properties.weeklyRecurrence

WeekDetails

Si la programación se producirá solo algunos días de la semana, especifique la periodicidad semanal.

tags

object

Etiquetas del recurso.

SharedPublicIpAddressConfiguration

Propiedades de una máquina virtual que determinan cómo se conecta a un equilibrador de carga.

Nombre Tipo Description
inboundNatRules

InboundNatRule[]

Reglas NAT entrantes

StorageType

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

Nombre Tipo Description
Premium

string

Standard

string

StandardSSD

string

TransportProtocol

Protocolo de transporte para el extremo.

Nombre Tipo Description
Tcp

string

Udp

string

VirtualMachineCreationSource

Indica el origen de la creación de una máquina virtual de laboratorio. Solo propiedad de salida.

Nombre Tipo Description
FromCustomImage

string

FromGalleryImage

string

FromSharedGalleryImage

string

WeekDetails

Propiedades de una programación semanal.

Nombre Tipo Description
time

string

Hora del día en que se producirá la programación.

weekdays

string[]

Los días de la semana para los que se establece la programación (por ejemplo, domingo, lunes, martes, etc.).