Partager via


Virtual Machines - List

Répertorier les machines virtuelles dans un labo donné.

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

Paramètres URI

Nom Dans Obligatoire Type Description
labName
path True

string

Nom du lab.

resourceGroupName
path True

string

Nom du groupe de ressources.

subscriptionId
path True

string

L'ID de l'abonnement.

api-version
query True

string

Version d’API client.

$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 des 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

Ok

Other Status Codes

CloudError

BadRequest

Sécurité

azure_auth

Octroi implicite OAuth2

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

Étendues

Nom Description
user_impersonation Accéder à Microsoft Azure

Exemples

VirtualMachines_List

Exemple de requête

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

Exemple de réponse

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

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 labo.

ArtifactDeploymentStatusProperties

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

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.

CloudError

Erreur d’une requête REST.

CloudErrorBody

Corps d’une erreur à partir d’une requête REST.

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ées 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

Status de la planification (par exemple, Activé, Désactivé)

GalleryImageReference

Informations de référence pour une image 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 pour 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 la façon dont elle est connectée à un équilibreur de charge.

StorageType

Type de stockage du disque (Par exemple, Standard, Premium).

TransportProtocol

Protocole de transport du 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

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

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 elle a été définie au niveau de la ressource lab ou lab.

properties.labVmsStartup

Schedule

Planification de démarrage automatique, si elle a été définie au niveau de la ressource lab ou lab.

tags

object

Balises de la ressource.

type

string

Type de la ressource.

ArtifactDeploymentStatusProperties

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

Nom Type Description
artifactsApplied

integer

Nombre total d’artefacts qui ont été appliqués avec succès.

deploymentStatus

string

Déploiement status de l’artefact.

totalArtifacts

integer

Nombre total d’artefacts qui ont été appliqués provisoirement.

ArtifactInstallProperties

Propriétés d’un artefact.

Nom Type Description
artifactId

string

Identificateur de l’artefact.

artifactTitle

string

Titre de l’artefact.

deploymentStatusMessage

string

Message status du déploiement.

installTime

string

Heure à laquelle l’artefact commence à installer sur la machine virtuelle.

parameters

ArtifactParameterProperties[]

Paramètres de l’artefact.

status

string

Status de l’artefact.

vmExtensionStatusMessage

string

Message status de l’extension de machine virtuelle.

ArtifactParameterProperties

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

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

Nom Type Description
diskName

string

Nom du disque à attacher.

diskSizeGiB

integer

Taille du disque à attacher en Gibibytes.

diskType

StorageType

Type de stockage du disque (Par exemple, Standard, Premium).

CloudError

Erreur d’une requête REST.

Nom Type Description
error

CloudErrorBody

Erreur cloud qui s’est produite

CloudErrorBody

Corps d’une erreur à partir d’une requête REST.

Nom Type Description
code

string

Code d'erreur.

details

CloudErrorBody[]

Erreurs internes.

message

string

Message d’erreur.

target

string

Cible d’erreur.

ComputeDataDisk

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

Nom Type Description
diskSizeGiB

integer

Obtient la taille du disque de données en Gio.

diskUri

string

Lorsqu’il est soutenu par un objet blob, l’URI de l’objet blob sous-jacent.

managedDiskId

string

Lorsqu’il est sauvegardé par un 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

Informations d’état sur une machine virtuelle.

Nom Type Description
code

string

Obtient le code status.

displayStatus

string

Obtient l’étiquette courte localisable pour le status.

message

string

Obtient le message associé au status.

ComputeVmProperties

Propriétés d’une machine virtuelle retournées 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 d’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

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 de 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

Propriétés d’une planification quotidienne.

Nom Type Description
time

string

Heure de la journée où la planification se produira.

EnableStatus

Status de la planification (par exemple, Activé, Désactivé)

Nom Type Description
Disabled

string

Enabled

string

GalleryImageReference

Informations de référence pour une image 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

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

Nom Type Description
None

string

ReadOnly

string

ReadWrite

string

HourDetails

Propriétés d’une planification horaire.

Nom Type Description
minute

integer

Minutes de l’heure d’exécution de la planification.

InboundNatRule

Règle pour 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

Port vers lequel le trafic externe sera redirigé.

frontendPort

integer

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 du point de terminaison.

LabVirtualMachine

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

Le déploiement de l’artefact status 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 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 d’expiration de la machine virtuelle.

properties.fqdn

string

Nom de domaine complet de la machine virtuelle.

properties.galleryImageReference

GalleryImageReference

Référence d’image Microsoft Place de marché 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 lab 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

Status d’approvisionnement de la ressource.

properties.scheduleParameters

ScheduleCreationParameter[]

Planifications de machine virtuelle à 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

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

Nom Type Description
nextLink

string

Lien pour l’ensemble de résultats suivant.

value

LabVirtualMachine[]

Résultats de l’opération de liste.

NetworkInterfaceProperties

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 suivi du numéro de port de service pour RDP (Remote Desktop Protocol).

sharedPublicIpAddressConfiguration

SharedPublicIpAddressConfiguration

Configuration du 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 suivi 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

Paramètres de notification pour une planification.

Nom Type Valeur par défaut Description
emailRecipient

string

Destinataire de l’e-mail auquel envoyer des notifications (peut être une liste d’adresses e-mail séparées par deux-points).

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 (par exemple, Activé, Désactivé).

timeInMinutes

integer

Heure, en minutes avant l’événement, à laquelle la notification sera envoyée.

webhookUrl

string

URL du webhook à laquelle la notification sera envoyée.

Schedule

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 de création de la planification.

properties.dailyRecurrence

DayDetails

Si la planification se produit une fois chaque 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

Le provisionnement status de la ressource.

properties.status

EnableStatus

Disabled

Status de la planification (par exemple, Activé, Désactivé)

properties.targetResourceId

string

ID de ressource auquel la planification appartient

properties.taskType

string

Type de tâche de la planification (par exemple, LabVmsShutdownTask, LabVmAutoStart).

properties.timeZoneId

string

ID de fuseau horaire (par exemple, l’heure standard de la Chine, l’heure normale du Groenland, l’heure standard du Pacifique, etc.). Les valeurs possibles de cette propriété se trouvent 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 certains jours de la semaine, spécifiez la périodicité hebdomadaire.

tags

object

Balises de la ressource.

type

string

Type de la ressource.

ScheduleCreationParameter

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

Nom Type Valeur par défaut Description
location

string

Emplacement du nouvel environnement ou machine virtuelle

name

string

Nom de la machine virtuelle ou de l’environnement

properties.dailyRecurrence

DayDetails

Si la planification se produit une fois chaque 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

Status de la planification (par exemple, Activé, Désactivé)

properties.targetResourceId

string

ID de ressource auquel la planification appartient

properties.taskType

string

Type de tâche de la planification (par exemple, LabVmsShutdownTask, LabVmAutoStart).

properties.timeZoneId

string

ID de fuseau horaire (par exemple, l’heure standard de la Chine, l’heure normale du Groenland, l’heure standard du Pacifique, etc.). Les valeurs possibles de cette propriété se trouvent 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 certains jours de la semaine, spécifiez la périodicité hebdomadaire.

tags

object

Balises de la ressource.

SharedPublicIpAddressConfiguration

Propriétés d’une machine virtuelle qui déterminent la façon dont elle est connectée à un équilibreur de charge.

Nom Type Description
inboundNatRules

InboundNatRule[]

Règles NAT entrantes

StorageType

Type de stockage du disque (Par exemple, Standard, Premium).

Nom Type Description
Premium

string

Standard

string

StandardSSD

string

TransportProtocol

Protocole de transport du point de terminaison.

Nom Type Description
Tcp

string

Udp

string

VirtualMachineCreationSource

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

Nom Type Description
FromCustomImage

string

FromGalleryImage

string

FromSharedGalleryImage

string

WeekDetails

Propriétés d’une planification hebdomadaire.

Nom Type Description
time

string

Heure du jour où la planification se produira.

weekdays

string[]

Jours de la semaine pour lesquels l’horaire est défini (par exemple, dimanche, lundi, mardi, etc.).