Sdílet prostřednictvím


Virtual Machines - List

Výpis virtuálních počítačů v daném testovacím prostředí

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
labName
path True

string

Název testovacího prostředí.

resourceGroupName
path True

string

Název skupiny prostředků.

subscriptionId
path True

string

ID předplatného.

api-version
query True

string

Verze klientského rozhraní API

$expand
query

string

Zadejte dotaz $expand. Příklad: properties($expand=artifacts,computeVm,networkInterface,applicableSchedule)

$filter
query

string

Filtr, který se má použít pro operaci. Příklad: '$filter=contains(name;'myName')

$orderby
query

string

Výraz řazení výsledků pomocí notace OData Příklad: '$orderby=name desc'

$top
query

integer

int32

Maximální počet prostředků, které se mají z operace vrátit. Příklad: $top=10

Odpovědi

Name Typ Description
200 OK

LabVirtualMachineList

OK

Other Status Codes

CloudError

BadRequest

Zabezpečení

azure_auth

Implicitní udělení OAuth2

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name Description
user_impersonation Přístup k Microsoft Azure

Příklady

VirtualMachines_List

Ukázkový požadavek

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

Ukázková odpověď

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

Definice

Name Description
ApplicableSchedule

Plány použitelné pro virtuální počítač. Plány mohly být definované na virtuálním počítači nebo na úrovni testovacího prostředí.

ArtifactDeploymentStatusProperties

Vlastnosti nasazení artefaktu.

ArtifactInstallProperties

Vlastnosti artefaktu.

ArtifactParameterProperties

Vlastnosti parametru artefaktu.

AttachNewDataDiskOptions

Vlastnosti pro připojení nového disku k virtuálnímu počítači

CloudError

Chyba požadavku REST.

CloudErrorBody

Text chyby z požadavku REST

ComputeDataDisk

Datové disky připojené k virtuálnímu počítači.

ComputeVmInstanceViewStatus

Informace o stavu virtuálního počítače.

ComputeVmProperties

Vlastnosti virtuálního počítače vrácené rozhraním API Microsoft.Compute

DataDiskProperties

Text žádosti o přidání nového nebo existujícího datového disku do virtuálního počítače

DayDetails

Vlastnosti denního plánu.

EnableStatus

Stav plánu (tj. Povoleno, Zakázáno)

GalleryImageReference

Referenční informace pro Azure Marketplace image.

HostCachingOptions

Možnost ukládání do mezipaměti pro datový disk (tj. Žádný, Jen pro čtení, ReadWrite).

HourDetails

Vlastnosti hodinového plánu.

InboundNatRule

Pravidlo pro překlad adres (NAT) – vystavení portu virtuálního počítače (backendPort) na veřejné IP adrese pomocí nástroje pro vyrovnávání zatížení

LabVirtualMachine

Virtuální počítač.

LabVirtualMachineList

Odpověď operace seznamu.

NetworkInterfaceProperties

Vlastnosti síťového rozhraní.

NotificationSettings

Nastavení oznámení pro plán.

Schedule

Plán.

ScheduleCreationParameter

Vlastnosti pro vytvoření plánu

SharedPublicIpAddressConfiguration

Vlastnosti virtuálního počítače, které určují, jak se připojí k nástroji pro vyrovnávání zatížení.

StorageType

Typ úložiště pro disk (tj. Standard, Premium).

TransportProtocol

Přenosový protokol pro koncový bod.

VirtualMachineCreationSource

Informuje zdroj o vytvoření virtuálního počítače testovacího prostředí. Pouze výstupní vlastnost.

WeekDetails

Vlastnosti týdenního plánu.

ApplicableSchedule

Plány použitelné pro virtuální počítač. Plány mohly být definované na virtuálním počítači nebo na úrovni testovacího prostředí.

Name Typ Description
id

string

Identifikátor prostředku.

location

string

Umístění prostředku.

name

string

Název prostředku.

properties.labVmsShutdown

Schedule

Plán automatického vypínání, pokud je nastavený na úrovni testovacího prostředí nebo prostředků testovacího prostředí.

properties.labVmsStartup

Schedule

Plán automatického spouštění, pokud je nastavený na úrovni prostředků testovacího prostředí nebo testovacího prostředí.

tags

object

Značky prostředku.

type

string

Typ prostředku.

ArtifactDeploymentStatusProperties

Vlastnosti nasazení artefaktu.

Name Typ Description
artifactsApplied

integer

Celkový počet artefaktů, které byly úspěšně použity.

deploymentStatus

string

Stav nasazení artefaktu.

totalArtifacts

integer

Celkový počet artefaktů, které byly nezávazně použity.

ArtifactInstallProperties

Vlastnosti artefaktu.

Name Typ Description
artifactId

string

Identifikátor artefaktu.

artifactTitle

string

Název artefaktu.

deploymentStatusMessage

string

Stavová zpráva z nasazení.

installTime

string

Čas, kdy se artefakt začne instalovat na virtuální počítač.

parameters

ArtifactParameterProperties[]

Parametry artefaktu.

status

string

Stav artefaktu.

vmExtensionStatusMessage

string

Stavová zpráva z rozšíření virtuálního počítače

ArtifactParameterProperties

Vlastnosti parametru artefaktu.

Name Typ Description
name

string

Název parametru artefaktu.

value

string

Hodnota parametru artefaktu.

AttachNewDataDiskOptions

Vlastnosti pro připojení nového disku k virtuálnímu počítači

Name Typ Description
diskName

string

Název disku, který se má připojit.

diskSizeGiB

integer

Velikost disku, který se má připojit v gibibajtech.

diskType

StorageType

Typ úložiště pro disk (tj. Standard, Premium).

CloudError

Chyba požadavku REST.

Name Typ Description
error

CloudErrorBody

Chyba cloudu, ke které došlo

CloudErrorBody

Text chyby z požadavku REST

Name Typ Description
code

string

Kód chyby

details

CloudErrorBody[]

Vnitřní chyby.

message

string

Chybová zpráva

target

string

Cíl chyby.

ComputeDataDisk

Datové disky připojené k virtuálnímu počítači.

Name Typ Description
diskSizeGiB

integer

Získá velikost datového disku v GiB.

diskUri

string

Pokud je zajištěn objekt blob, identifikátor URI podkladového objektu blob.

managedDiskId

string

Při zálohování spravovaným diskem se jedná o ID prostředku výpočetního disku.

name

string

Získá název datového disku.

ComputeVmInstanceViewStatus

Informace o stavu virtuálního počítače.

Name Typ Description
code

string

Získá stavový kód.

displayStatus

string

Získá krátký lokalizovatelný popisek stavu.

message

string

Získá zprávu přidruženou ke stavu.

ComputeVmProperties

Vlastnosti virtuálního počítače vrácené rozhraním API Microsoft.Compute

Name Typ Description
dataDiskIds

string[]

Získá identifikátor URI objektu blob datových disků pro virtuální počítač.

dataDisks

ComputeDataDisk[]

Získá všechny datové disky připojené k virtuálnímu počítači.

networkInterfaceId

string

Získá ID síťového rozhraní virtuálního počítače.

osDiskId

string

Získá identifikátor URI objektu blob disku s operačním systémem pro virtuální počítač.

osType

string

Získá typ operačního systému virtuálního počítače.

statuses

ComputeVmInstanceViewStatus[]

Získá stavy virtuálního počítače.

vmSize

string

Získá velikost virtuálního počítače.

DataDiskProperties

Text žádosti o přidání nového nebo existujícího datového disku do virtuálního počítače

Name Typ Description
attachNewDataDiskOptions

AttachNewDataDiskOptions

Určuje možnosti připojení nového disku k virtuálnímu počítači.

existingLabDiskId

string

Určuje ID existujícího disku testovacího prostředí pro připojení k virtuálnímu počítači.

hostCaching

HostCachingOptions

Možnost ukládání do mezipaměti pro datový disk (tj. Žádný, Jen pro čtení, ReadWrite).

DayDetails

Vlastnosti denního plánu.

Name Typ Description
time

string

Čas, kdy bude plán probíhat.

EnableStatus

Stav plánu (tj. Povoleno, Zakázáno)

Name Typ Description
Disabled

string

Enabled

string

GalleryImageReference

Referenční informace pro Azure Marketplace image.

Name Typ Description
offer

string

Nabídka obrázku galerie.

osType

string

Typ operačního systému image galerie.

publisher

string

Vydavatel image galerie.

sku

string

Skladová položka image galerie.

version

string

Verze image galerie.

HostCachingOptions

Možnost ukládání do mezipaměti pro datový disk (tj. Žádný, Jen pro čtení, ReadWrite).

Name Typ Description
None

string

ReadOnly

string

ReadWrite

string

HourDetails

Vlastnosti hodinového plánu.

Name Typ Description
minute

integer

Počet minut v hodině, ve které bude plán běžet.

InboundNatRule

Pravidlo pro překlad adres (NAT) – vystavení portu virtuálního počítače (backendPort) na veřejné IP adrese pomocí nástroje pro vyrovnávání zatížení

Name Typ Description
backendPort

integer

Port, na který bude externí provoz přesměrován.

frontendPort

integer

Port externího koncového bodu příchozího připojení. Možné hodnoty jsou v rozsahu od 1 do 65535 včetně. Pokud není zadáno, bude hodnota přidělena automaticky.

transportProtocol

TransportProtocol

Přenosový protokol pro koncový bod.

LabVirtualMachine

Virtuální počítač.

Name Typ Default value Description
id

string

Identifikátor prostředku.

location

string

Umístění prostředku.

name

string

Název prostředku.

properties.allowClaim

boolean

False

Určuje, jestli jiný uživatel může převzít vlastnictví virtuálního počítače.

properties.applicableSchedule

ApplicableSchedule

Příslušný plán pro virtuální počítač.

properties.artifactDeploymentStatus

ArtifactDeploymentStatusProperties

Stav nasazení artefaktu pro virtuální počítač.

properties.artifacts

ArtifactInstallProperties[]

Artefakty, které se mají nainstalovat na virtuální počítač.

properties.computeId

string

Identifikátor prostředku (Microsoft.Compute) virtuálního počítače.

properties.computeVm

ComputeVmProperties

Vlastnosti výpočetního virtuálního počítače.

properties.createdByUser

string

E-mailová adresa tvůrce virtuálního počítače.

properties.createdByUserId

string

Identifikátor objektu tvůrce virtuálního počítače.

properties.createdDate

string

Datum vytvoření virtuálního počítače.

properties.customImageId

string

Identifikátor vlastní image virtuálního počítače.

properties.dataDiskParameters

DataDiskProperties[]

Nové nebo existující datové disky pro připojení k virtuálnímu počítači po vytvoření

properties.disallowPublicIpAddress

boolean

False

Určuje, jestli se má virtuální počítač vytvořit bez veřejné IP adresy.

properties.environmentId

string

ID prostředku prostředí, které obsahuje tento virtuální počítač, pokud existuje.

properties.expirationDate

string

Datum vypršení platnosti virtuálního počítače.

properties.fqdn

string

Plně kvalifikovaný název domény virtuálního počítače.

properties.galleryImageReference

GalleryImageReference

Odkaz na image virtuálního počítače Azure Marketplace Microsoft.

properties.isAuthenticationWithSshKey

boolean

Určuje, jestli tento virtuální počítač používá k ověřování klíč SSH.

properties.labSubnetName

string

Název podsítě testovacího prostředí virtuálního počítače.

properties.labVirtualNetworkId

string

Identifikátor virtuální sítě testovacího prostředí virtuálního počítače.

properties.lastKnownPowerState

string

Poslední známý stav výpočetního výkonu zachycený v hodnotě DTL

properties.networkInterface

NetworkInterfaceProperties

Vlastnosti síťového rozhraní.

properties.notes

string

Poznámky k virtuálnímu počítači.

properties.osType

string

Typ operačního systému virtuálního počítače.

properties.ownerObjectId

string

dynamicValue

Identifikátor objektu vlastníka virtuálního počítače.

properties.ownerUserPrincipalName

string

Hlavní název uživatele vlastníka virtuálního počítače.

properties.password

string

Heslo správce virtuálního počítače.

properties.planId

string

ID plánu přidruženého k imagi virtuálního počítače

properties.provisioningState

string

Stav zřizování prostředku.

properties.scheduleParameters

ScheduleCreationParameter[]

Plány virtuálních počítačů, které se mají vytvořit

properties.size

string

Velikost virtuálního počítače.

properties.sshKey

string

Klíč SSH správce virtuálního počítače.

properties.storageType

string

labStorageType

Typ úložiště, který se má použít pro virtuální počítač (tj. Standard, Premium).

properties.uniqueIdentifier

string

Jedinečný neměnný identifikátor prostředku (GUID).

properties.userName

string

Uživatelské jméno virtuálního počítače.

properties.virtualMachineCreationSource

VirtualMachineCreationSource

Informuje zdroj o vytvoření virtuálního počítače testovacího prostředí. Pouze výstupní vlastnost.

tags

object

Značky prostředku.

type

string

Typ prostředku.

LabVirtualMachineList

Odpověď operace seznamu.

Name Typ Description
nextLink

string

Odkaz na další sadu výsledků

value

LabVirtualMachine[]

Výsledky operace seznamu

NetworkInterfaceProperties

Vlastnosti síťového rozhraní.

Name Typ Description
dnsName

string

Název DNS.

privateIpAddress

string

Privátní IP adresa.

publicIpAddress

string

Veřejná IP adresa.

publicIpAddressId

string

ID prostředku veřejné IP adresy.

rdpAuthority

string

Vlastnost RdpAuthority je název nebo IP adresa hostitele DNS serveru následovaná číslem portu služby pro protokol RDP (Remote Desktop Protocol).

sharedPublicIpAddressConfiguration

SharedPublicIpAddressConfiguration

Konfigurace pro sdílení veřejné IP adresy mezi několika virtuálními počítači.

sshAuthority

string

Vlastnost SshAuthority je název hostitele DNS serveru nebo IP adresa následovaná číslem portu služby pro SSH.

subnetId

string

ID prostředku dílčí sítě.

virtualNetworkId

string

ID prostředku virtuální sítě.

NotificationSettings

Nastavení oznámení pro plán.

Name Typ Default value Description
emailRecipient

string

Příjemce e-mailu, na který se mají odesílat oznámení (může to být seznam e-mailových adres oddělených středníkem).

notificationLocale

string

Národní prostředí, které se má použít při odesílání oznámení (náhradní pro nepodporované jazyky je EN).

status

EnableStatus

Disabled

Pokud jsou pro tento plán povolená oznámení (tj. Povoleno, Zakázáno).

timeInMinutes

integer

Čas v minutách před událostí, při které se odešle oznámení.

webhookUrl

string

Adresa URL webhooku, na kterou se oznámení odešle.

Schedule

Plán.

Name Typ Default value Description
id

string

Identifikátor prostředku.

location

string

Umístění prostředku.

name

string

Název prostředku.

properties.createdDate

string

Datum vytvoření plánu.

properties.dailyRecurrence

DayDetails

Pokud bude plán probíhat každý den v týdnu, zadejte denní opakování.

properties.hourlyRecurrence

HourDetails

Pokud bude plán probíhat několikrát denně, zadejte hodinové opakování.

properties.notificationSettings

NotificationSettings

Nastavení oznámení.

properties.provisioningState

string

Stav zřizování prostředku.

properties.status

EnableStatus

Disabled

Stav plánu (tj. Povoleno, Zakázáno)

properties.targetResourceId

string

ID prostředku, ke kterému patří plán

properties.taskType

string

Typ úkolu plánu (např. LabVmsShutdownTask, LabVmAutoStart).

properties.timeZoneId

string

ID časového pásma (např. Čína (běžný čas), Grónsko (běžný čas), Tichomoří (běžný čas) atd.). Možné hodnoty pro tuto vlastnost najdete v IReadOnlyCollection<string> TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIdshttps://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md()

properties.uniqueIdentifier

string

Jedinečný neměnný identifikátor prostředku (GUID).

properties.weeklyRecurrence

WeekDetails

Pokud plán nastane pouze v některých dnech v týdnu, zadejte týdenní opakování.

tags

object

Značky prostředku.

type

string

Typ prostředku.

ScheduleCreationParameter

Vlastnosti pro vytvoření plánu

Name Typ Default value Description
location

string

Umístění nového virtuálního počítače nebo prostředí

name

string

Název virtuálního počítače nebo prostředí

properties.dailyRecurrence

DayDetails

Pokud bude plán probíhat každý den v týdnu, zadejte denní opakování.

properties.hourlyRecurrence

HourDetails

Pokud bude plán probíhat několikrát denně, zadejte hodinové opakování.

properties.notificationSettings

NotificationSettings

Nastavení oznámení.

properties.status

EnableStatus

Disabled

Stav plánu (tj. Povoleno, Zakázáno)

properties.targetResourceId

string

ID prostředku, ke kterému patří plán

properties.taskType

string

Typ úkolu plánu (např. LabVmsShutdownTask, LabVmAutoStart).

properties.timeZoneId

string

ID časového pásma (např. Čína (běžný čas), Grónsko (běžný čas), Tichomoří (běžný čas) atd.). Možné hodnoty pro tuto vlastnost najdete v IReadOnlyCollection<string> TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIdshttps://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md()

properties.weeklyRecurrence

WeekDetails

Pokud plán nastane pouze v některých dnech v týdnu, zadejte týdenní opakování.

tags

object

Značky prostředku.

SharedPublicIpAddressConfiguration

Vlastnosti virtuálního počítače, které určují, jak se připojí k nástroji pro vyrovnávání zatížení.

Name Typ Description
inboundNatRules

InboundNatRule[]

Příchozí pravidla překladu adres (NAT)

StorageType

Typ úložiště pro disk (tj. Standard, Premium).

Name Typ Description
Premium

string

Standard

string

StandardSSD

string

TransportProtocol

Přenosový protokol pro koncový bod.

Name Typ Description
Tcp

string

Udp

string

VirtualMachineCreationSource

Informuje zdroj o vytvoření virtuálního počítače testovacího prostředí. Pouze výstupní vlastnost.

Name Typ Description
FromCustomImage

string

FromGalleryImage

string

FromSharedGalleryImage

string

WeekDetails

Vlastnosti týdenního plánu.

Name Typ Description
time

string

Čas dne, kdy bude plán probíhat.

weekdays

string[]

Dny v týdnu, pro které je plán nastavený (např. neděle, pondělí, úterý atd.).