Virtual Machines - List By Lab

Référence

Service:: Lab Services

Version d'API:: 2023-06-07

Obtenez toutes les machines virtuelles d’un laboratoire.
Retourne la liste de toutes les machines virtuelles d’un laboratoire.

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

Avec des paramètres facultatifs:

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 minLength: 1 maxLength: 100	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 minLength: 1 maxLength: 90	Nom du groupe de ressources. Le nom ne respecte pas la casse.
subscriptionId	path	True	string minLength: 1	ID de l’abonnement cible.
api-version	query	True	string minLength: 1	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

Exemple de requête

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

Exemple de réponse

Code d’état:: 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 des services lab.
ProvisioningState	État d’approvisionnement actuel de la machine virtuelle.
ResourceOperationError	Détails de l’erreur de la dernière défaillance de l’opération sur cette ressource
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.
VirtualMachine	Ressource de machine virtuelle lab.
VirtualMachineConnectionProfile	Informations de connexion pour la machine virtuelle
VirtualMachineState	État d’une machine virtuelle.
VirtualMachineType	Type de la machine virtuelle lab.

createdByType

Énumération

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

Valeur	Description
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Object

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

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

ErrorDetail

Object

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

Object

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

PagedVirtualMachines

Object

Liste paginée des machines virtuelles des services lab.

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

Énumération

État d’approvisionnement actuel de la machine virtuelle.

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

ResourceOperationError

Object

Détails de l’erreur de la dernière défaillance de l’opération sur cette ressource

Nom	Type	Description
action	string	Action d’opération ayant é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 (date-time)	Date et heure de la survenue de l’erreur

systemData

Object

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

Nom	Type	Description
createdAt	string (date-time)	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 (date-time)	Horodatage de la dernière modification de ressource (UTC)
lastModifiedBy	string	Identité qui a modifié la ressource pour la dernière fois.
lastModifiedByType	createdByType	Type d’identité qui a modifié la ressource pour la dernière fois.

VirtualMachine

Object

Ressource de machine virtuelle lab.

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 l’ID PUID !) de qui a revendiqué la machine virtuelle.
properties.connectionProfile	VirtualMachineConnectionProfile	Profil pour obtenir des informations sur la connexion à la machine virtuelle.
properties.provisioningState	ProvisioningState	État d’approvisionnement actuel de la machine virtuelle.
properties.resourceOperationError	ResourceOperationError	Détails 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

Object

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, s’il en existe un.
privateIpAddress	string	Adresse IP privée de la machine virtuelle.
rdpAuthority	string	Port et nom d’hôte séparés par des points-virgules pour la connexion via le protocole RDP à la machine virtuelle.
rdpInBrowserUrl	string minLength: 3 maxLength: 2000	URL de connexion via le protocole RDP à la machine virtuelle dans le navigateur.
sshAuthority	string	Port et nom d’hôte séparés par des points-virgules pour la connexion via le protocole SSH à la machine virtuelle.
sshInBrowserUrl	string minLength: 3 maxLength: 2000	URL de connexion via le protocole SSH à la machine virtuelle dans le navigateur.

VirtualMachineState

Énumération

État d’une machine virtuelle.

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

VirtualMachineType

Énumération

Type de la machine virtuelle lab.

Valeur	Description
Template	Une machine virtuelle de modèle
User	Une machine virtuelle utilisateur

Partager via

Virtual Machines - List By Lab

Paramètres URI

Réponses

Exemples

listVirtualMachine

Exemple de requête

Exemple de réponse

Définitions

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

PagedVirtualMachines

ProvisioningState

ResourceOperationError

systemData

VirtualMachine

VirtualMachineConnectionProfile

VirtualMachineState

VirtualMachineType

Ressources supplémentaires