Condividi tramite


Virtual Machines - List

Elencare le macchine virtuali in un determinato lab.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
labName
path True

string

Il nome del lab.

resourceGroupName
path True

string

Nome del gruppo di risorse.

subscriptionId
path True

string

ID della sottoscrizione.

api-version
query True

string

Versione API client.

$expand
query

string

Specificare la query $expand. Esempio: 'properties($expand=artifacts,computeVm,networkInterface,applicableSchedule)'

$filter
query

string

Filtro da applicare all'operazione. Esempio: '$filter=contains(name,'myName')

$orderby
query

string

Espressione di ordinamento per i risultati, utilizzando la notazione OData. Esempio: '$orderby=name desc'

$top
query

integer

int32

Numero massimo di risorse da restituire dall'operazione. Esempio: '$top=10'

Risposte

Nome Tipo Descrizione
200 OK

LabVirtualMachineList

OK

Other Status Codes

CloudError

BadRequest

Sicurezza

azure_auth

Concessione implicita OAuth2

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome Descrizione
user_impersonation Accedere a Microsoft Azure

Esempio

VirtualMachines_List

Esempio di richiesta

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

Risposta di esempio

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

Definizioni

Nome Descrizione
ApplicableSchedule

Pianificazioni applicabili a una macchina virtuale. Le pianificazioni potrebbero essere state definite in una macchina virtuale o a livello di lab.

ArtifactDeploymentStatusProperties

Proprietà di una distribuzione di artefatti.

ArtifactInstallProperties

Proprietà di un artefatto.

ArtifactParameterProperties

Proprietà di un parametro di artefatto.

AttachNewDataDiskOptions

Proprietà per collegare un nuovo disco alla macchina virtuale.

CloudError

Errore da una richiesta REST.

CloudErrorBody

Corpo di un errore da una richiesta REST.

ComputeDataDisk

Dischi dati collegati a una macchina virtuale.

ComputeVmInstanceViewStatus

Informazioni sullo stato di una macchina virtuale.

ComputeVmProperties

Proprietà di una macchina virtuale restituita dall'API Microsoft.Compute.

DataDiskProperties

Corpo della richiesta per l'aggiunta di un disco dati nuovo o esistente a una macchina virtuale.

DayDetails

Proprietà di una pianificazione giornaliera.

EnableStatus

Stato della pianificazione (ad esempio Abilitato, Disabilitato)

GalleryImageReference

Informazioni di riferimento per un'immagine Azure Marketplace.

HostCachingOptions

Opzione di memorizzazione nella cache per un disco dati ,ad esempio Nessuno, ReadOnly, ReadWrite.

HourDetails

Proprietà di una pianificazione oraria.

InboundNatRule

Regola per NAT: esposizione della porta di una macchina virtuale (backendPort) nell'indirizzo IP pubblico tramite un servizio di bilanciamento del carico.

LabVirtualMachine

Una macchina virtuale.

LabVirtualMachineList

Risposta di un'operazione di elenco.

NetworkInterfaceProperties

Proprietà di un'interfaccia di rete.

NotificationSettings

Impostazioni di notifica per una pianificazione.

Schedule

Una pianificazione.

ScheduleCreationParameter

Proprietà per la creazione di una pianificazione.

SharedPublicIpAddressConfiguration

Proprietà di una macchina virtuale che determinano come è connessa a un servizio di bilanciamento del carico.

StorageType

Tipo di archiviazione per il disco (ad esempio Standard, Premium).

TransportProtocol

Protocollo di trasporto per l'endpoint.

VirtualMachineCreationSource

Indica l'origine della creazione di macchina virtuale lab. Solo la proprietà output.

WeekDetails

Proprietà di una pianificazione settimanale.

ApplicableSchedule

Pianificazioni applicabili a una macchina virtuale. Le pianificazioni potrebbero essere state definite in una macchina virtuale o a livello di lab.

Nome Tipo Descrizione
id

string

Identificatore della risorsa.

location

string

Il percorso della risorsa.

name

string

Nome della risorsa.

properties.labVmsShutdown

Schedule

Pianificazione di arresto automatico, se è stata impostata a livello di lab o risorse lab.

properties.labVmsStartup

Schedule

Pianificazione di avvio automatico, se è stata impostata a livello di lab o risorse lab.

tags

object

Tag della risorsa.

type

string

Tipo di risorsa.

ArtifactDeploymentStatusProperties

Proprietà di una distribuzione di artefatti.

Nome Tipo Descrizione
artifactsApplied

integer

Numero totale degli artefatti applicati correttamente.

deploymentStatus

string

Stato della distribuzione dell'artefatto.

totalArtifacts

integer

Numero totale degli artefatti applicati in modo provvisorio.

ArtifactInstallProperties

Proprietà di un artefatto.

Nome Tipo Descrizione
artifactId

string

Identificatore dell'artefatto.

artifactTitle

string

Titolo dell'artefatto.

deploymentStatusMessage

string

Messaggio di stato dalla distribuzione.

installTime

string

Ora in cui l'artefatto inizia a essere installato nella macchina virtuale.

parameters

ArtifactParameterProperties[]

Parametri dell'artefatto.

status

string

Stato dell'artefatto.

vmExtensionStatusMessage

string

Messaggio di stato dall'estensione della macchina virtuale.

ArtifactParameterProperties

Proprietà di un parametro di artefatto.

Nome Tipo Descrizione
name

string

Nome del parametro dell'artefatto.

value

string

Valore del parametro dell'artefatto.

AttachNewDataDiskOptions

Proprietà per collegare un nuovo disco alla macchina virtuale.

Nome Tipo Descrizione
diskName

string

Nome del disco da collegare.

diskSizeGiB

integer

Dimensioni del disco da collegare in Gibibytes.

diskType

StorageType

Tipo di archiviazione per il disco (ad esempio Standard, Premium).

CloudError

Errore da una richiesta REST.

Nome Tipo Descrizione
error

CloudErrorBody

Errore cloud che si è verificato

CloudErrorBody

Corpo di un errore da una richiesta REST.

Nome Tipo Descrizione
code

string

Codice di errore.

details

CloudErrorBody[]

Errori interni.

message

string

Messaggio di errore.

target

string

Destinazione dell'errore.

ComputeDataDisk

Dischi dati collegati a una macchina virtuale.

Nome Tipo Descrizione
diskSizeGiB

integer

Ottiene le dimensioni del disco dati in GiB.

diskUri

string

Se supportato da un BLOB, l'URI del BLOB sottostante.

managedDiskId

string

Se supportato da disco gestito, si tratta dell'ID della risorsa disco di calcolo.

name

string

Ottiene il nome del disco dati.

ComputeVmInstanceViewStatus

Informazioni sullo stato di una macchina virtuale.

Nome Tipo Descrizione
code

string

Ottiene il codice di stato.

displayStatus

string

Ottiene l'etichetta localizzabile breve per lo stato.

message

string

Ottiene il messaggio associato allo stato.

ComputeVmProperties

Proprietà di una macchina virtuale restituita dall'API Microsoft.Compute.

Nome Tipo Descrizione
dataDiskIds

string[]

Ottiene l'URI BLOB dei dischi dati per la macchina virtuale.

dataDisks

ComputeDataDisk[]

Ottiene tutti i dischi dati collegati alla macchina virtuale.

networkInterfaceId

string

Ottiene l'ID dell'interfaccia di rete della macchina virtuale.

osDiskId

string

Ottiene l'URI BLOB del disco del sistema operativo per la macchina virtuale.

osType

string

Ottiene il tipo di sistema operativo della macchina virtuale.

statuses

ComputeVmInstanceViewStatus[]

Ottiene gli stati della macchina virtuale.

vmSize

string

Ottiene le dimensioni della macchina virtuale.

DataDiskProperties

Corpo della richiesta per l'aggiunta di un disco dati nuovo o esistente a una macchina virtuale.

Nome Tipo Descrizione
attachNewDataDiskOptions

AttachNewDataDiskOptions

Specifica le opzioni per collegare un nuovo disco alla macchina virtuale.

existingLabDiskId

string

Specifica l'ID del disco lab esistente da collegare alla macchina virtuale.

hostCaching

HostCachingOptions

Opzione di memorizzazione nella cache per un disco dati ,ad esempio Nessuno, ReadOnly, ReadWrite.

DayDetails

Proprietà di una pianificazione giornaliera.

Nome Tipo Descrizione
time

string

Ora del giorno in cui verrà eseguita la pianificazione.

EnableStatus

Stato della pianificazione (ad esempio Abilitato, Disabilitato)

Nome Tipo Descrizione
Disabled

string

Enabled

string

GalleryImageReference

Informazioni di riferimento per un'immagine Azure Marketplace.

Nome Tipo Descrizione
offer

string

Offerta dell'immagine della raccolta.

osType

string

Tipo di sistema operativo dell'immagine della raccolta.

publisher

string

Autore dell'immagine della raccolta.

sku

string

SKU dell'immagine della raccolta.

version

string

Versione dell'immagine della raccolta.

HostCachingOptions

Opzione di memorizzazione nella cache per un disco dati ,ad esempio Nessuno, ReadOnly, ReadWrite.

Nome Tipo Descrizione
None

string

ReadOnly

string

ReadWrite

string

HourDetails

Proprietà di una pianificazione oraria.

Nome Tipo Descrizione
minute

integer

Minuti dell'ora in cui verrà eseguita la pianificazione.

InboundNatRule

Regola per NAT: esposizione della porta di una macchina virtuale (backendPort) nell'indirizzo IP pubblico tramite un servizio di bilanciamento del carico.

Nome Tipo Descrizione
backendPort

integer

Porta a cui verrà reindirizzato il traffico esterno.

frontendPort

integer

Porta endpoint esterna della connessione in ingresso. I possibili valori sono compresi tra 1 e 65535 inclusi. Se non specificato, verrà allocato automaticamente un valore.

transportProtocol

TransportProtocol

Protocollo di trasporto per l'endpoint.

LabVirtualMachine

Una macchina virtuale.

Nome Tipo Valore predefinito Descrizione
id

string

Identificatore della risorsa.

location

string

Il percorso della risorsa.

name

string

Nome della risorsa.

properties.allowClaim

boolean

False

Indica se un altro utente può assumere la proprietà della macchina virtuale

properties.applicableSchedule

ApplicableSchedule

Pianificazione applicabile per la macchina virtuale.

properties.artifactDeploymentStatus

ArtifactDeploymentStatusProperties

Stato della distribuzione dell'artefatto per la macchina virtuale.

properties.artifacts

ArtifactInstallProperties[]

Elementi da installare nella macchina virtuale.

properties.computeId

string

Identificatore di risorsa (Microsoft.Compute) della macchina virtuale.

properties.computeVm

ComputeVmProperties

Proprietà della macchina virtuale di calcolo.

properties.createdByUser

string

Indirizzo di posta elettronica dell'autore della macchina virtuale.

properties.createdByUserId

string

Identificatore dell'oggetto dell'autore della macchina virtuale.

properties.createdDate

string

Data di creazione della macchina virtuale.

properties.customImageId

string

Identificatore di immagine personalizzato della macchina virtuale.

properties.dataDiskParameters

DataDiskProperties[]

Dischi dati nuovi o esistenti da collegare alla macchina virtuale dopo la creazione

properties.disallowPublicIpAddress

boolean

False

Indica se la macchina virtuale deve essere creata senza un indirizzo IP pubblico.

properties.environmentId

string

ID risorsa dell'ambiente contenente questa macchina virtuale, se presente.

properties.expirationDate

string

Data di scadenza per la macchina virtuale.

properties.fqdn

string

Nome di dominio completo della macchina virtuale.

properties.galleryImageReference

GalleryImageReference

Riferimento all'immagine di Microsoft Azure Marketplace della macchina virtuale.

properties.isAuthenticationWithSshKey

boolean

Indica se questa macchina virtuale usa una chiave SSH per l'autenticazione.

properties.labSubnetName

string

Nome della subnet lab della macchina virtuale.

properties.labVirtualNetworkId

string

Identificatore di rete virtuale lab della macchina virtuale.

properties.lastKnownPowerState

string

Ultimo stato di potenza di calcolo noto acquisito in DTL

properties.networkInterface

NetworkInterfaceProperties

Proprietà dell'interfaccia di rete.

properties.notes

string

Note della macchina virtuale.

properties.osType

string

Tipo di sistema operativo della macchina virtuale.

properties.ownerObjectId

string

dynamicValue

Identificatore dell'oggetto del proprietario della macchina virtuale.

properties.ownerUserPrincipalName

string

Nome dell'entità utente del proprietario della macchina virtuale.

properties.password

string

Password dell'amministratore della macchina virtuale.

properties.planId

string

ID del piano associato all'immagine della macchina virtuale

properties.provisioningState

string

Stato del provisioning della risorsa.

properties.scheduleParameters

ScheduleCreationParameter[]

Pianificazioni di macchine virtuali da creare

properties.size

string

Dimensioni della macchina virtuale.

properties.sshKey

string

Chiave SSH dell'amministratore della macchina virtuale.

properties.storageType

string

labStorageType

Tipo di archiviazione da usare per la macchina virtuale (ad esempio Standard, Premium).

properties.uniqueIdentifier

string

Identificatore univoco non modificabile di una risorsa (Guid).

properties.userName

string

Nome utente della macchina virtuale.

properties.virtualMachineCreationSource

VirtualMachineCreationSource

Indica l'origine della creazione di macchina virtuale lab. Solo la proprietà output.

tags

object

Tag della risorsa.

type

string

Tipo di risorsa.

LabVirtualMachineList

Risposta di un'operazione di elenco.

Nome Tipo Descrizione
nextLink

string

Collegamento per il set successivo di risultati.

value

LabVirtualMachine[]

Risultati dell'operazione di elenco.

NetworkInterfaceProperties

Proprietà di un'interfaccia di rete.

Nome Tipo Descrizione
dnsName

string

Nome DNS.

privateIpAddress

string

Indirizzo IP privato.

publicIpAddress

string

Indirizzo IP pubblico.

publicIpAddressId

string

ID risorsa dell'indirizzo IP pubblico.

rdpAuthority

string

La proprietà RdpAuthority è un nome host DNS del server o un indirizzo IP seguito dal numero di porta del servizio per RDP (Remote Desktop Protocol).

sharedPublicIpAddressConfiguration

SharedPublicIpAddressConfiguration

Configurazione per la condivisione di un indirizzo IP pubblico in più macchine virtuali.

sshAuthority

string

La proprietà SshAuthority è un nome host DNS del server o un indirizzo IP seguito dal numero di porta del servizio per SSH.

subnetId

string

ID risorsa della rete secondaria.

virtualNetworkId

string

ID risorsa della rete virtuale.

NotificationSettings

Impostazioni di notifica per una pianificazione.

Nome Tipo Valore predefinito Descrizione
emailRecipient

string

Il destinatario del messaggio di posta elettronica a cui inviare notifiche (può essere un elenco di indirizzi di posta elettronica separati da punto e virgola).

notificationLocale

string

Impostazioni locali da usare per l'invio di una notifica (fallback per le lingue non supportate è EN).

status

EnableStatus

Disabled

Se le notifiche sono abilitate per questa pianificazione ,ad esempio Abilitato, Disabilitato.

timeInMinutes

integer

Tempo in minuti prima dell'evento in cui verrà inviata la notifica.

webhookUrl

string

URL del webhook a cui verrà inviata la notifica.

Schedule

Una pianificazione.

Nome Tipo Valore predefinito Descrizione
id

string

Identificatore della risorsa.

location

string

Il percorso della risorsa.

name

string

Nome della risorsa.

properties.createdDate

string

Data di creazione della pianificazione.

properties.dailyRecurrence

DayDetails

Se la pianificazione verrà eseguita una volta ogni giorno della settimana, specificare la ricorrenza giornaliera.

properties.hourlyRecurrence

HourDetails

Se la pianificazione verrà eseguita più volte al giorno, specificare la ricorrenza oraria.

properties.notificationSettings

NotificationSettings

Impostazioni di notifica.

properties.provisioningState

string

Stato del provisioning della risorsa.

properties.status

EnableStatus

Disabled

Stato della pianificazione (ad esempio Abilitato, Disabilitato)

properties.targetResourceId

string

ID risorsa a cui appartiene la pianificazione

properties.taskType

string

Tipo di attività della pianificazione, ad esempio LabVmsShutdownTask, LabVmAutoStart.

properties.timeZoneId

string

ID del fuso orario (ad esempio, ora solare cina, ora solare della Groenlandia, ora solare pacifico e così via). I valori possibili per questa proprietà sono disponibili in IReadOnlyCollection<string> TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md)

properties.uniqueIdentifier

string

Identificatore univoco non modificabile di una risorsa (GUID).

properties.weeklyRecurrence

WeekDetails

Se la pianificazione verrà eseguita solo alcuni giorni della settimana, specificare la ricorrenza settimanale.

tags

object

Tag della risorsa.

type

string

Tipo di risorsa.

ScheduleCreationParameter

Proprietà per la creazione di una pianificazione.

Nome Tipo Valore predefinito Descrizione
location

string

Posizione della nuova macchina virtuale o dell'ambiente

name

string

Nome della macchina virtuale o dell'ambiente

properties.dailyRecurrence

DayDetails

Se la pianificazione verrà eseguita una volta ogni giorno della settimana, specificare la ricorrenza giornaliera.

properties.hourlyRecurrence

HourDetails

Se la pianificazione verrà eseguita più volte al giorno, specificare la ricorrenza oraria.

properties.notificationSettings

NotificationSettings

Impostazioni di notifica.

properties.status

EnableStatus

Disabled

Stato della pianificazione (ad esempio Abilitato, Disabilitato)

properties.targetResourceId

string

ID risorsa a cui appartiene la pianificazione

properties.taskType

string

Tipo di attività della pianificazione, ad esempio LabVmsShutdownTask, LabVmAutoStart.

properties.timeZoneId

string

ID del fuso orario (ad esempio, ora solare cina, ora solare della Groenlandia, ora solare pacifico e così via). I valori possibili per questa proprietà sono disponibili in IReadOnlyCollection<string> TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md)

properties.weeklyRecurrence

WeekDetails

Se la pianificazione verrà eseguita solo alcuni giorni della settimana, specificare la ricorrenza settimanale.

tags

object

Tag della risorsa.

SharedPublicIpAddressConfiguration

Proprietà di una macchina virtuale che determinano come è connessa a un servizio di bilanciamento del carico.

Nome Tipo Descrizione
inboundNatRules

InboundNatRule[]

Regole NAT in ingresso

StorageType

Tipo di archiviazione per il disco (ad esempio Standard, Premium).

Nome Tipo Descrizione
Premium

string

Standard

string

StandardSSD

string

TransportProtocol

Protocollo di trasporto per l'endpoint.

Nome Tipo Descrizione
Tcp

string

Udp

string

VirtualMachineCreationSource

Indica l'origine della creazione di macchina virtuale lab. Solo la proprietà output.

Nome Tipo Descrizione
FromCustomImage

string

FromGalleryImage

string

FromSharedGalleryImage

string

WeekDetails

Proprietà di una pianificazione settimanale.

Nome Tipo Descrizione
time

string

Ora del giorno in cui verrà eseguita la pianificazione.

weekdays

string[]

Giorni della settimana per cui è impostata la pianificazione (ad esempio domenica, lunedì, martedì e così via).