Virtual Machines - List By Lab

Referencia

Servicio:: Lab Services

Versión de la API:: 2023-06-07

Obtenga todas las máquinas virtuales de un laboratorio.
Devuelve una lista de todas las máquinas virtuales de un laboratorio.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labs/{labName}/virtualMachines?api-version=2023-06-07

Con parámetros opcionales:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labs/{labName}/virtualMachines?api-version=2023-06-07&$filter={$filter}

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
labName	path	True	string	Nombre del laboratorio que lo identifica de forma única dentro del plan de laboratorio que lo contiene. Se usa en los URI de recursos.
resourceGroupName	path	True	string	Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
subscriptionId	path	True	string	Identificador de la suscripción de destino.
api-version	query	True	string	Versión de API que se usará para la operación.
$filter	query		string	Filtro que se va a aplicar a la operación.

Respuestas

Nombre	Tipo	Description
200 OK	PagedVirtualMachines	La solicitud se realizó correctamente; la respuesta contiene todas las máquinas virtuales del laboratorio determinado.
Other Status Codes	ErrorResponse	Respuesta de error predeterminada.

Ejemplos

listVirtualMachine

Solicitud de ejemplo

HTTP

GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.LabServices/labs/testlab/virtualMachines?api-version=2023-06-07

Respuesta de muestra

status code:: 200

{
  "nextLink": null,
  "value": [
    {
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.LabServices/labs/testlab/virtualMachines/template",
      "name": "default",
      "type": "Microsoft.LabServices/VirtualMachine",
      "systemData": {
        "createdBy": "identity123",
        "createdByType": "User",
        "createdAt": "2020-05-01T10:00:00Z",
        "lastModifiedBy": "identity123",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2020-06-01T09:12:28Z"
      },
      "properties": {
        "provisioningState": "Succeeded",
        "state": "Running",
        "connectionProfile": {
          "privateIpAddress": "192.168.2.1",
          "sshAuthority": "vm-42.contoso.com:22",
          "sshInBrowserUrl": "vm-42.contoso.com",
          "rdpAuthority": "vm-42.contoso.com:3389",
          "rdpInBrowserUrl": "vm-42.contoso.com",
          "adminUsername": "user123"
        },
        "claimedByUserId": "testuser567",
        "vmType": "Template"
      }
    }
  ]
}

Definiciones

Nombre	Description
createdByType	Tipo de identidad que creó el recurso.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
PagedVirtualMachines	Lista paginada de máquinas virtuales de servicios de laboratorio.
ProvisioningState	Estado de aprovisionamiento actual de la máquina virtual.
ResourceOperationError	Detalles del error de la operación más reciente en este recurso
systemData	Metadatos relacionados con la creación y la última modificación del recurso.
VirtualMachine	Un recurso de máquina virtual de laboratorio.
VirtualMachineConnectionProfile	Información de conexión de la máquina virtual
VirtualMachineState	Estado de una máquina virtual.
VirtualMachineType	Tipo de la máquina virtual del laboratorio.

createdByType

Tipo de identidad que creó el recurso.

Nombre	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Los detalles del error.
message	string	El mensaje de error.
target	string	Destino del error.

ErrorResponse

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

PagedVirtualMachines

Lista paginada de máquinas virtuales de servicios de laboratorio.

Nombre	Tipo	Description
nextLink	string	Vínculo para obtener la página siguiente de los resultados de la máquina virtual.
value	VirtualMachine[]	Página de matriz de resultados de la máquina virtual.

ProvisioningState

Estado de aprovisionamiento actual de la máquina virtual.

Nombre	Tipo	Description
Creating	string	El recurso está en proceso de creación.
Deleting	string	El recurso está en proceso de eliminación.
Failed	string	La operación anterior en el recurso no ha podido dejar el recurso en estado incorrecto.
Locked	string	El recurso está bloqueado y los cambios están bloqueados actualmente. Esto puede deberse al mantenimiento o a una operación programada. El estado volverá a realizarse correctamente una vez finalizada la operación de bloqueo.
Succeeded	string	El recurso está en buen estado después de la creación o la operación de actualización.
Updating	string	Se aplican nuevos valores de propiedad al recurso.

ResourceOperationError

Detalles del error de la operación más reciente en este recurso

Nombre	Tipo	Description
action	string	La acción de operación que produjo un error
code	string	Código que corresponde al tipo de error de operación.
message	string	Mensaje de error de operación
timestamp	string	Fecha y hora de cuando se produjo el error

systemData

Metadatos relacionados con la creación y la última modificación del recurso.

Nombre	Tipo	Description
createdAt	string	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string	Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.

VirtualMachine

Un recurso de máquina virtual de laboratorio.

Nombre	Tipo	Description
id	string	Identificador de recurso completo del recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nombre del recurso.
properties.claimedByUserId	string	El identificador de usuario del laboratorio (no el PUID!) de quién afirmó la máquina virtual.
properties.connectionProfile	VirtualMachineConnectionProfile	Para obtener información sobre cómo conectarse a la máquina virtual.
properties.provisioningState	ProvisioningState	Estado de aprovisionamiento actual de la máquina virtual.
properties.resourceOperationError	ResourceOperationError	Detalles del error de la última operación realizada en el plan de laboratorio.
properties.state	VirtualMachineState	Estado actual de la máquina virtual
properties.vmType	VirtualMachineType	El tipo de este recurso de máquina virtual
systemData	systemData	Datos del sistema de la máquina virtual del laboratorio.
type	string	Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

VirtualMachineConnectionProfile

Información de conexión de la máquina virtual

Nombre	Tipo	Description
adminUsername	string	Nombre de usuario que se usa para iniciar sesión en la máquina virtual como administrador.
nonAdminUsername	string	Nombre de usuario que se usa para iniciar sesión en la máquina virtual como no administrador, si existe uno.
privateIpAddress	string	Dirección IP privada de la máquina virtual.
rdpAuthority	string	Puerto y nombre de host separados por punto y coma para conectarse a través del protocolo RDP a la máquina virtual.
rdpInBrowserUrl	string	Dirección URL para conectarse a través del protocolo RDP a la máquina virtual en el explorador.
sshAuthority	string	Puerto y nombre de host separados por punto y coma para conectarse a través del protocolo SSH a la máquina virtual.
sshInBrowserUrl	string	Dirección URL para conectarse a través del protocolo SSH a la máquina virtual en el explorador.

VirtualMachineState

Estado de una máquina virtual.

Nombre	Tipo	Description
Redeploying	string	La máquina virtual se está redempleando.
Reimaging	string	La máquina virtual se está reimagendo.
ResettingPassword	string	Se está restableciendo la contraseña de la máquina virtual.
Running	string	La máquina virtual se está ejecutando.
Starting	string	La máquina virtual se está iniciando.
Stopped	string	La máquina virtual está detenida actualmente.
Stopping	string	La máquina virtual se está deteniendo.

VirtualMachineType

Tipo de la máquina virtual del laboratorio.

Nombre	Tipo	Description
Template	string	Una máquina virtual de plantilla
User	string	Una máquina virtual de usuario

Compartir a través de