Virtual Machines - List By Lab

Référence

Service:: Lab Services

API Version:: 2023-06-07

Obtenez toutes les machines virtuelles pour un labo.
Retourne une liste de toutes les machines virtuelles pour un labo.

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

With optional parameters:

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
labName	path	True	string	Nom du labo qui l’identifie de manière unique dans le plan de laboratoire contenant. Utilisé dans les URI de ressource.
resourceGroupName	path	True	string	Nom du groupe de ressources. Le nom ne respecte pas la casse.
subscriptionId	path	True	string	ID de l’abonnement cible.
api-version	query	True	string	Version de l’API à utiliser pour cette opération.
$filter	query		string	Filtre à appliquer à l’opération.

Réponses

Nom	Type	Description
200 OK	PagedVirtualMachines	La demande a réussi ; la réponse contient toutes les machines virtuelles pour le labo donné.
Other Status Codes	ErrorResponse	Réponse d’erreur par défaut.

Exemples

listVirtualMachine

Sample Request

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

Sample Response

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"
      }
    }
  ]
}

Définitions

Nom	Description
createdByType	Type d’identité qui a créé la ressource.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
PagedVirtualMachines	Liste paginée des machines virtuelles lab services.
ProvisioningState	État d’approvisionnement actuel de la machine virtuelle.
ResourceOperationError	Détails de l’erreur de l’échec de l’opération la plus récente sur cette ressource
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.
VirtualMachine	Une ressource de machine virtuelle de laboratoire.
VirtualMachineConnectionProfile	Informations de connexion pour la machine virtuelle
VirtualMachineState	État d’une machine virtuelle.
VirtualMachineType	Type de la machine virtuelle lab.

createdByType

Type d’identité qui a créé la ressource.

Nom	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires
type	string	Type d’informations supplémentaires.

ErrorDetail

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d'erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

PagedVirtualMachines

Liste paginée des machines virtuelles lab services.

Nom	Type	Description
nextLink	string	Lien permettant d’obtenir la page suivante des résultats de la machine virtuelle.
value	VirtualMachine[]	Page tableau des résultats de la machine virtuelle.

ProvisioningState

État d’approvisionnement actuel de la machine virtuelle.

Nom	Type	Description
Creating	string	La ressource est en cours de création.
Deleting	string	La ressource est en cours de suppression.
Failed	string	L’opération précédente sur la ressource a échoué, laissant la ressource dans un état défectueux.
Locked	string	La ressource est verrouillée et les modifications sont actuellement bloquées. Cela peut être dû à une maintenance ou à une opération planifiée. L’état revient à réussi une fois l’opération de verrouillage terminée.
Succeeded	string	La ressource est dans un état sain après l’opération de création ou de mise à jour.
Updating	string	De nouvelles valeurs de propriété sont appliquées à la ressource.

ResourceOperationError

Détails de l’erreur de l’échec de l’opération la plus récente sur cette ressource

Nom	Type	Description
action	string	Action d’opération qui a échoué
code	string	Code qui correspond au type d’échec de l’opération
message	string	Message d’échec de l’opération
timestamp	string	Dateheure du moment où l’erreur s’est produite

systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom	Type	Description
createdAt	string	Horodatage de la création de ressources (UTC).
createdBy	string	Identité qui a créé la ressource.
createdByType	createdByType	Type d’identité qui a créé la ressource.
lastModifiedAt	string	Horodatage de la dernière modification de la ressource (UTC)
lastModifiedBy	string	Identité qui a modifié la dernière ressource.
lastModifiedByType	createdByType	Type d’identité qui a modifié la dernière ressource.

VirtualMachine

Une ressource de machine virtuelle de laboratoire.

Nom	Type	Description
id	string	ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	nom de la ressource.
properties.claimedByUserId	string	L’ID utilisateur du labo (et non le PUID !) de qui a revendiqué la machine virtuelle.
properties.connectionProfile	VirtualMachineConnectionProfile	Profil pour plus d’informations sur la connexion à la machine virtuelle.
properties.provisioningState	ProvisioningState	État d’approvisionnement actuel de la machine virtuelle.
properties.resourceOperationError	ResourceOperationError	Détails de l’erreur de la dernière opération effectuée sur le plan lab.
properties.state	VirtualMachineState	État actuel de la machine virtuelle
properties.vmType	VirtualMachineType	Type de cette ressource de machine virtuelle
systemData	systemData	Données système de la machine virtuelle Lab.
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

VirtualMachineConnectionProfile

Informations de connexion pour la machine virtuelle

Nom	Type	Description
adminUsername	string	Nom d’utilisateur utilisé pour se connecter à la machine virtuelle en tant qu’administrateur.
nonAdminUsername	string	Nom d’utilisateur utilisé pour se connecter à la machine virtuelle en tant que non-administrateur, le cas échéant.
privateIpAddress	string	Adresse IP privée de la machine virtuelle.
rdpAuthority	string	Port et nom d’hôte séparés par un point-virgule pour la connexion via le protocole RDP à la machine virtuelle.
rdpInBrowserUrl	string	URL pour la connexion via le protocole RDP à la machine virtuelle dans le navigateur.
sshAuthority	string	Port et nom d’hôte séparés par un point-virgule pour la connexion via le protocole SSH à la machine virtuelle.
sshInBrowserUrl	string	URL pour la connexion via le protocole SSH à la machine virtuelle dans le navigateur.

VirtualMachineState

État d’une machine virtuelle.

Nom	Type	Description
Redeploying	string	La machine virtuelle est redéployée.
Reimaging	string	La machine virtuelle est en cours de réimage.
ResettingPassword	string	Le mot de passe de la machine virtuelle est en cours de réinitialisation.
Running	string	La machine virtuelle est en cours d’exécution.
Starting	string	La machine virtuelle démarre.
Stopped	string	La machine virtuelle est actuellement arrêtée.
Stopping	string	La machine virtuelle s’arrête.

VirtualMachineType

Type de la machine virtuelle lab.

Nom	Type	Description
Template	string	Un modèle de machine virtuelle
User	string	Machine virtuelle utilisateur