Virtual Machines - List

Service:: Dev Test Labs

Version d'API:: 2018-09-15

Répertoriez les machines virtuelles dans un laboratoire donné.

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

Avec des paramètres facultatifs:

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
labName	path	True	string	Nom du labo.
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.
$expand	query		string	Spécifiez la requête $expand. Exemple : 'properties($expand=artifacts,computeVm,networkInterface,applicableSchedule)'
$filter	query		string	Filtre à appliquer à l’opération. Exemple : '$filter=contains(name,'myName')
$orderby	query		string	Expression de classement pour les résultats, à l’aide de la notation OData. Exemple : '$orderby=name desc'
$top	query		integer (int32)	Nombre maximal de ressources à retourner à partir de l’opération. Exemple : '$top=10'

Réponses

Nom	Type	Description
200 OK	LabVirtualMachineList	L’opération Azure s’est terminée avec succès.
Other Status Codes	ErrorResponse	Réponse d’erreur inattendue.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

VirtualMachines_List

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:: 200

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

Définitions

Nom	Description
ApplicableSchedule	Planifications applicables à une machine virtuelle. Les planifications peuvent avoir été définies sur une machine virtuelle ou au niveau du laboratoire.
ArtifactDeploymentStatusProperties	Propriétés d’un déploiement d’artefacts.
ArtifactInstallProperties	Propriétés d’un artefact.
ArtifactParameterProperties	Propriétés d’un paramètre d’artefact.
AttachNewDataDiskOptions	Propriétés permettant d’attacher un nouveau disque à la machine virtuelle.
ComputeDataDisk	Disques de données attachés à une machine virtuelle.
ComputeVmInstanceViewStatus	Informations d’état sur une machine virtuelle.
ComputeVmProperties	Propriétés d’une machine virtuelle retournée par l’API Microsoft.Compute.
DataDiskProperties	Corps de la demande pour l’ajout d’un disque de données nouveau ou existant à une machine virtuelle.
DayDetails	Propriétés d’une planification quotidienne.
EnableStatus	Indique si la source de l’artefact est activée (valeurs : Activé, Désactivé).
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
GalleryImageReference	Informations de référence pour une image de la Place de marché Azure.
HostCachingOptions	Option de mise en cache pour un disque de données (par exemple, None, ReadOnly, ReadWrite).
HourDetails	Propriétés d’une planification horaire.
InboundNatRule	Règle de nat : exposition du port d’une machine virtuelle (backendPort) sur l’adresse IP publique à l’aide d’un équilibreur de charge.
LabVirtualMachine	Une machine virtuelle.
LabVirtualMachineList	Réponse d’une opération de liste.
NetworkInterfaceProperties	Propriétés d’une interface réseau.
NotificationSettings	Paramètres de notification pour une planification.
Schedule	Une planification.
ScheduleCreationParameter	Propriétés pour la création d’une planification.
SharedPublicIpAddressConfiguration	Propriétés d’une machine virtuelle qui déterminent comment elle est connectée à un équilibreur de charge.
StorageType	Type de stockage pour le disque (par exemple, Standard, Premium).
TransportProtocol	Protocole de transport pour le point de terminaison.
VirtualMachineCreationSource	Indique la source de création d’une machine virtuelle lab. Propriété de sortie uniquement.
WeekDetails	Propriétés d’une planification hebdomadaire.

ApplicableSchedule

Object

Planifications applicables à une machine virtuelle. Les planifications peuvent avoir été définies sur une machine virtuelle ou au niveau du laboratoire.

Nom	Type	Description
id	string	Identificateur de la ressource.
location	string	Emplacement de la ressource.
name	string	Nom de la ressource.
properties.labVmsShutdown	Schedule	Planification de l’arrêt automatique, si l’une d’elles a été définie au niveau du labo ou de la ressource lab.
properties.labVmsStartup	Schedule	Planification de démarrage automatique, si l’une d’elles a été définie au niveau du labo ou de la ressource lab.
tags	object	Balises de la ressource.
type	string	Type de la ressource.

ArtifactDeploymentStatusProperties

Object

Propriétés d’un déploiement d’artefacts.

Nom	Type	Description
artifactsApplied	integer (int32)	Nombre total d’artefacts appliqués avec succès.
deploymentStatus	string	État du déploiement de l’artefact.
totalArtifacts	integer (int32)	Nombre total d’artefacts appliqués provisoirement.

ArtifactInstallProperties

Object

Propriétés d’un artefact.

Nom	Type	Description
artifactId	string	Identificateur de l’artefact.
artifactTitle	string	Titre de l’artefact.
deploymentStatusMessage	string	Message d’état du déploiement.
installTime	string (date-time)	Heure à laquelle l’artefact commence à s’installer sur la machine virtuelle.
parameters	ArtifactParameterProperties[]	Paramètres de l’artefact.
status	string	État de l’artefact.
vmExtensionStatusMessage	string	Message d’état de l’extension de machine virtuelle.

ArtifactParameterProperties

Object

Propriétés d’un paramètre d’artefact.

Nom	Type	Description
name	string	Nom du paramètre d’artefact.
value	string	Valeur du paramètre d’artefact.

AttachNewDataDiskOptions

Object

Propriétés permettant d’attacher un nouveau disque à la machine virtuelle.

Nom	Type	Description
diskName	string	Nom du disque à attacher.
diskSizeGiB	integer (int32)	Taille du disque à attacher en Gibibytes.
diskType	StorageType	Type de stockage pour le disque (par exemple, Standard, Premium).

ComputeDataDisk

Object

Disques de données attachés à une machine virtuelle.

Nom	Type	Description
diskSizeGiB	integer (int32)	Obtient la taille du disque de données en Gio.
diskUri	string	Lorsqu’il est sauvegardé par un objet blob, l’URI de l’objet blob sous-jacent.
managedDiskId	string	Lorsqu’il est sauvegardé par disque managé, il s’agit de l’ID de la ressource de disque de calcul.
name	string	Obtient le nom du disque de données.

ComputeVmInstanceViewStatus

Object

Informations d’état sur une machine virtuelle.

Nom	Type	Description
code	string	Obtient le code d’état.
displayStatus	string	Obtient l’étiquette localisable courte pour l’état.
message	string	Obtient le message associé à l’état.

ComputeVmProperties

Object

Propriétés d’une machine virtuelle retournée par l’API Microsoft.Compute.

Nom	Type	Description
dataDiskIds	string[]	Obtient l’URI d’objet blob des disques de données pour la machine virtuelle.
dataDisks	ComputeDataDisk[]	Obtient tous les disques de données attachés à la machine virtuelle.
networkInterfaceId	string	Obtient l’ID d’interface réseau de la machine virtuelle.
osDiskId	string	Obtient l’URI de l’objet blob de disque du système d’exploitation pour la machine virtuelle.
osType	string	Obtient le type de système d’exploitation de la machine virtuelle.
statuses	ComputeVmInstanceViewStatus[]	Obtient les états de la machine virtuelle.
vmSize	string	Obtient la taille de la machine virtuelle.

DataDiskProperties

Object

Corps de la demande pour l’ajout d’un disque de données nouveau ou existant à une machine virtuelle.

Nom	Type	Description
attachNewDataDiskOptions	AttachNewDataDiskOptions	Spécifie les options permettant d’attacher un nouveau disque à la machine virtuelle.
existingLabDiskId	string	Spécifie l’ID de disque du labo existant à attacher à la machine virtuelle.
hostCaching	HostCachingOptions	Option de mise en cache pour un disque de données (par exemple, None, ReadOnly, ReadWrite).

DayDetails

Object

Propriétés d’une planification quotidienne.

Nom	Type	Description
time	string	L’heure de la planification se produit.

EnableStatus

Énumération

Indique si la source de l’artefact est activée (valeurs : Activé, Désactivé).

Valeur	Description
Enabled
Disabled

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.

GalleryImageReference

Object

Informations de référence pour une image de la Place de marché Azure.

Nom	Type	Description
offer	string	Offre de l’image de la galerie.
osType	string	Type de système d’exploitation de l’image de la galerie.
publisher	string	Éditeur de l’image de la galerie.
sku	string	Référence SKU de l’image de la galerie.
version	string	Version de l’image de la galerie.

HostCachingOptions

Énumération

Option de mise en cache pour un disque de données (par exemple, None, ReadOnly, ReadWrite).

Valeur	Description
None
ReadOnly
ReadWrite

HourDetails

Object

Propriétés d’une planification horaire.

Nom	Type	Description
minute	integer (int32)	Minutes de l’heure pendant laquelle la planification s’exécutera.

InboundNatRule

Object

Règle de nat : exposition du port d’une machine virtuelle (backendPort) sur l’adresse IP publique à l’aide d’un équilibreur de charge.

Nom	Type	Description
backendPort	integer (int32)	Port vers lequel le trafic externe sera redirigé.
frontendPort	integer (int32)	Port de point de terminaison externe de la connexion entrante. Les valeurs possibles sont comprises entre 1 et 65535, inclus. Si elle n’est pas spécifiée, une valeur est allouée automatiquement.
transportProtocol	TransportProtocol	Protocole de transport pour le point de terminaison.

LabVirtualMachine

Object

Une machine virtuelle.

Nom	Type	Valeur par défaut	Description
id	string		Identificateur de la ressource.
location	string		Emplacement de la ressource.
name	string		Nom de la ressource.
properties.allowClaim	boolean	False	Indique si un autre utilisateur peut prendre possession de la machine virtuelle
properties.applicableSchedule	ApplicableSchedule		Planification applicable pour la machine virtuelle.
properties.artifactDeploymentStatus	ArtifactDeploymentStatusProperties		État du déploiement d’artefacts pour la machine virtuelle.
properties.artifacts	ArtifactInstallProperties[]		Artefacts à installer sur la machine virtuelle.
properties.computeId	string		Identificateur de ressource (Microsoft.Compute) de la machine virtuelle.
properties.computeVm	ComputeVmProperties		Propriétés de la machine virtuelle de calcul.
properties.createdByUser	string		Adresse e-mail du créateur de la machine virtuelle.
properties.createdByUserId	string		Identificateur d’objet du créateur de la machine virtuelle.
properties.createdDate	string (date-time)		Date de création de la machine virtuelle.
properties.customImageId	string		Identificateur d’image personnalisé de la machine virtuelle.
properties.dataDiskParameters	DataDiskProperties[]		Disques de données nouveaux ou existants à attacher à la machine virtuelle après la création
properties.disallowPublicIpAddress	boolean	False	Indique si la machine virtuelle doit être créée sans adresse IP publique.
properties.environmentId	string		ID de ressource de l’environnement qui contient cette machine virtuelle, le cas échéant.
properties.expirationDate	string (date-time)		Date d’expiration de la machine virtuelle.
properties.fqdn	string		Nom de domaine complet de la machine virtuelle.
properties.galleryImageReference	GalleryImageReference		Référence de l’image de la Place de marché Microsoft Azure de la machine virtuelle.
properties.isAuthenticationWithSshKey	boolean		Indique si cette machine virtuelle utilise une clé SSH pour l’authentification.
properties.labSubnetName	string		Nom du sous-réseau du labo de la machine virtuelle.
properties.labVirtualNetworkId	string		Identificateur de réseau virtuel lab de la machine virtuelle.
properties.lastKnownPowerState	string		Dernier état de puissance de calcul connu capturé dans DTL
properties.networkInterface	NetworkInterfaceProperties		Propriétés de l’interface réseau.
properties.notes	string		Notes de la machine virtuelle.
properties.osType	string		Type de système d’exploitation de la machine virtuelle.
properties.ownerObjectId	string	dynamicValue	Identificateur d’objet du propriétaire de la machine virtuelle.
properties.ownerUserPrincipalName	string		Nom d’utilisateur principal du propriétaire de la machine virtuelle.
properties.password	string		Mot de passe de l’administrateur de la machine virtuelle.
properties.planId	string		ID du plan associé à l’image de machine virtuelle
properties.provisioningState	string		État d’approvisionnement de la ressource.
properties.scheduleParameters	ScheduleCreationParameter[]		Planifications de machines virtuelles à créer
properties.size	string		Taille de la machine virtuelle.
properties.sshKey	string		Clé SSH de l’administrateur de la machine virtuelle.
properties.storageType	string	labStorageType	Type de stockage à utiliser pour la machine virtuelle (par exemple, Standard, Premium).
properties.uniqueIdentifier	string		Identificateur immuable unique d’une ressource (GUID).
properties.userName	string		Nom d’utilisateur de la machine virtuelle.
properties.virtualMachineCreationSource	VirtualMachineCreationSource		Indique la source de création d’une machine virtuelle lab. Propriété de sortie uniquement.
tags	object		Balises de la ressource.
type	string		Type de la ressource.

LabVirtualMachineList

Object

Réponse d’une opération de liste.

Nom	Type	Description
nextLink	string (uri)	Lien vers la page suivante des éléments
value	LabVirtualMachine[]	Les éléments LabVirtualMachine sur cette page

NetworkInterfaceProperties

Object

Propriétés d’une interface réseau.

Nom	Type	Description
dnsName	string	Nom DNS.
privateIpAddress	string	Adresse IP privée.
publicIpAddress	string	Adresse IP publique.
publicIpAddressId	string	ID de ressource de l’adresse IP publique.
rdpAuthority	string	La propriété RdpAuthority est un nom d’hôte DNS de serveur ou une adresse IP suivie du numéro de port de service pour RDP (Remote Desktop Protocol).
sharedPublicIpAddressConfiguration	SharedPublicIpAddressConfiguration	Configuration pour le partage d’une adresse IP publique sur plusieurs machines virtuelles.
sshAuthority	string	La propriété SshAuthority est un nom d’hôte DNS de serveur ou une adresse IP suivie du numéro de port de service pour SSH.
subnetId	string	ID de ressource du sous-réseau.
virtualNetworkId	string	ID de ressource du réseau virtuel.

NotificationSettings

Object

Paramètres de notification pour une planification.

Nom	Type	Valeur par défaut	Description
emailRecipient	string		Le destinataire de l’e-mail auquel envoyer des notifications (il peut s’agir d’une liste d’adresses e-mail séparées par des points-virgules).
notificationLocale	string		Paramètres régionaux à utiliser lors de l’envoi d’une notification (secours pour les langues non prises en charge est EN).
status	EnableStatus	Disabled	Si les notifications sont activées pour cette planification (c’est-à-dire activée, désactivée).
timeInMinutes	integer (int32)		Heure en minutes avant l’événement auquel la notification sera envoyée.
webhookUrl	string		URL du webhook à laquelle la notification sera envoyée.

Schedule

Object

Une planification.

Nom	Type	Valeur par défaut	Description
id	string		Identificateur de la ressource.
location	string		Emplacement de la ressource.
name	string		Nom de la ressource.
properties.createdDate	string (date-time)		Date de création de la planification.
properties.dailyRecurrence	DayDetails		Si la planification se produit une fois par jour de la semaine, spécifiez la périodicité quotidienne.
properties.hourlyRecurrence	HourDetails		Si la planification se produit plusieurs fois par jour, spécifiez la périodicité horaire.
properties.notificationSettings	NotificationSettings		Paramètres de notification.
properties.provisioningState	string		État d’approvisionnement de la ressource.
properties.status	EnableStatus	Disabled	État de la planification (c’est-à-dire Activé, Désactivé)
properties.targetResourceId	string		ID de ressource auquel appartient la planification
properties.taskType	string		Type de tâche de la planification (par exemple, LabVmsShutdownTask, LabVmAutoStart).
properties.timeZoneId	string		ID de fuseau horaire (par exemple, Heure standard de chine, heure standard du Groenland, heure standard du Pacifique, etc.). Les valeurs possibles pour cette propriété sont disponibles dans `IReadOnlyCollection<string> TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md)
properties.uniqueIdentifier	string		Identificateur immuable unique d’une ressource (GUID).
properties.weeklyRecurrence	WeekDetails		Si la planification ne se produit que quelques jours de la semaine, spécifiez la périodicité hebdomadaire.
tags	object		Balises de la ressource.
type	string		Type de la ressource.

ScheduleCreationParameter

Object

Propriétés pour la création d’une planification.

Nom	Type	Valeur par défaut	Description
location	string		Emplacement de la nouvelle machine virtuelle ou de l’environnement
name	string		Nom de la machine virtuelle ou de l’environnement
properties.dailyRecurrence	DayDetails		Si la planification se produit une fois par jour de la semaine, spécifiez la périodicité quotidienne.
properties.hourlyRecurrence	HourDetails		Si la planification se produit plusieurs fois par jour, spécifiez la périodicité horaire.
properties.notificationSettings	NotificationSettings		Paramètres de notification.
properties.status	EnableStatus	Disabled	État de la planification (c’est-à-dire Activé, Désactivé)
properties.targetResourceId	string		ID de ressource auquel appartient la planification
properties.taskType	string		Type de tâche de la planification (par exemple, LabVmsShutdownTask, LabVmAutoStart).
properties.timeZoneId	string		ID de fuseau horaire (par exemple, Heure standard de chine, heure standard du Groenland, heure standard du Pacifique, etc.). Les valeurs possibles pour cette propriété sont disponibles dans `IReadOnlyCollection<string> TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md)
properties.weeklyRecurrence	WeekDetails		Si la planification ne se produit que quelques jours de la semaine, spécifiez la périodicité hebdomadaire.
tags	object		Balises de la ressource.

SharedPublicIpAddressConfiguration

Object

Propriétés d’une machine virtuelle qui déterminent comment elle est connectée à un équilibreur de charge.

Nom	Type	Description
inboundNatRules	InboundNatRule[]	Règles NAT entrantes

StorageType

Énumération

Type de stockage pour le disque (par exemple, Standard, Premium).

Valeur	Description
Standard
Premium
StandardSSD

TransportProtocol

Énumération

Protocole de transport pour le point de terminaison.

Valeur	Description
Tcp
Udp

VirtualMachineCreationSource

Énumération

Indique la source de création d’une machine virtuelle lab. Propriété de sortie uniquement.

Valeur	Description
FromCustomImage
FromGalleryImage
FromSharedGalleryImage

WeekDetails

Object

Propriétés d’une planification hebdomadaire.

Nom	Type	Description
time	string	Heure de la planification.
weekdays	string[]	Jours de la semaine pour lesquels la planification est définie (par exemple, dimanche, lundi, mardi, etc.).

Partager via

Virtual Machines - List

Paramètres URI

Réponses

Sécurité

azure_auth

Étendues

Exemples

VirtualMachines_List

Exemple de requête

Exemple de réponse

Définitions

ApplicableSchedule

ArtifactDeploymentStatusProperties

ArtifactInstallProperties

ArtifactParameterProperties

AttachNewDataDiskOptions

ComputeDataDisk

ComputeVmInstanceViewStatus

ComputeVmProperties

DataDiskProperties

DayDetails

EnableStatus

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GalleryImageReference

HostCachingOptions

HourDetails

InboundNatRule

LabVirtualMachine

LabVirtualMachineList

NetworkInterfaceProperties

NotificationSettings

Schedule

ScheduleCreationParameter

SharedPublicIpAddressConfiguration

StorageType

TransportProtocol

VirtualMachineCreationSource

WeekDetails