Virtual Machines - List
Virtuele machines in een bepaald lab weergeven.
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
URI-parameters
Name | In | Vereist | Type | Description |
---|---|---|---|---|
lab
|
path | True |
string |
De naam van het lab. |
resource
|
path | True |
string |
De naam van de resourcegroep. |
subscription
|
path | True |
string |
De abonnements-id. |
api-version
|
query | True |
string |
Client-API-versie. |
$expand
|
query |
string |
Geef de $expand query op. Voorbeeld: 'properties($expand=artifacts,computeVm,networkInterface,applicableSchedule)' |
|
$filter
|
query |
string |
Het filter dat moet worden toegepast op de bewerking. Voorbeeld: '$filter=contains(name,'myName') |
|
$orderby
|
query |
string |
De volgorde-expressie voor de resultaten, met behulp van OData-notatie. Voorbeeld: '$orderby=name desc' |
|
$top
|
query |
integer int32 |
Het maximum aantal resources dat door de bewerking moet worden geretourneerd. Voorbeeld: '$top=10' |
Antwoorden
Name | Type | Description |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
BadRequest |
Beveiliging
azure_auth
Impliciete OAuth2-toekenning
Type:
oauth2
Stroom:
implicit
Autorisatie-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Bereiken
Name | Description |
---|---|
user_impersonation | Toegang tot Microsoft Azure |
Voorbeelden
VirtualMachines_List
Voorbeeldaanvraag
Voorbeeldrespons
{
"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"
}
}
]
}
Definities
Name | Description |
---|---|
Applicable |
Schema's die van toepassing zijn op een virtuele machine. De planningen kunnen zijn gedefinieerd op een VM of op labniveau. |
Artifact |
Eigenschappen van een artefactimplementatie. |
Artifact |
Eigenschappen van een artefact. |
Artifact |
Eigenschappen van een artefactparameter. |
Attach |
Eigenschappen voor het koppelen van een nieuwe schijf aan de virtuele machine. |
Cloud |
Fout van een REST-aanvraag. |
Cloud |
Hoofdtekst van een fout van een REST-aanvraag. |
Compute |
Een gegevensschijven die zijn gekoppeld aan een virtuele machine. |
Compute |
Statusinformatie over een virtuele machine. |
Compute |
Eigenschappen van een virtuele machine die wordt geretourneerd door de Microsoft.Compute-API. |
Data |
Aanvraagtekst voor het toevoegen van een nieuwe of bestaande gegevensschijf aan een virtuele machine. |
Day |
Eigenschappen van een dagelijkse planning. |
Enable |
De status van de planning (ingeschakeld, uitgeschakeld) |
Gallery |
De referentie-informatie voor een Azure Marketplace afbeelding. |
Host |
Cacheoptie voor een gegevensschijf (d.w.w. Geen, ReadOnly, ReadWrite). |
Hour |
Eigenschappen van een uurschema. |
Inbound |
Een regel voor NAT: de poort van een VM (backendPort) weergeven op het openbare IP-adres met behulp van een load balancer. |
Lab |
Een virtuele machine. |
Lab |
Het antwoord van een lijstbewerking. |
Network |
Eigenschappen van een netwerkinterface. |
Notification |
Meldingsinstellingen voor een planning. |
Schedule |
Een planning. |
Schedule |
Eigenschappen voor het maken van een planning. |
Shared |
Eigenschappen van een virtuele machine die bepalen hoe deze is verbonden met een load balancer. |
Storage |
Het opslagtype voor de schijf (bijvoorbeeld Standard, Premium). |
Transport |
Het transportprotocol voor het eindpunt. |
Virtual |
Geeft de bron aan van het maken van een virtuele labmachine. Alleen uitvoereigenschap. |
Week |
Eigenschappen van een wekelijks schema. |
ApplicableSchedule
Schema's die van toepassing zijn op een virtuele machine. De planningen kunnen zijn gedefinieerd op een VM of op labniveau.
Name | Type | Description |
---|---|---|
id |
string |
De id van de resource. |
location |
string |
De locatie van de resource. |
name |
string |
De naam van de resource. |
properties.labVmsShutdown |
De planning voor automatisch afsluiten, als deze is ingesteld op het niveau van het lab of de labresource. |
|
properties.labVmsStartup |
Het schema voor automatisch opstarten, als deze is ingesteld op het niveau van het lab of de labresource. |
|
tags |
object |
De tags van de resource. |
type |
string |
Het type resource. |
ArtifactDeploymentStatusProperties
Eigenschappen van een artefactimplementatie.
Name | Type | Description |
---|---|---|
artifactsApplied |
integer |
Het totale aantal artefacten dat is toegepast. |
deploymentStatus |
string |
De implementatiestatus van het artefact. |
totalArtifacts |
integer |
Het totale aantal artefacten dat voorlopig is toegepast. |
ArtifactInstallProperties
Eigenschappen van een artefact.
Name | Type | Description |
---|---|---|
artifactId |
string |
De id van het artefact. |
artifactTitle |
string |
De titel van het artefact. |
deploymentStatusMessage |
string |
Het statusbericht van de implementatie. |
installTime |
string |
Het tijdstip waarop het artefact wordt geïnstalleerd op de virtuele machine. |
parameters |
De parameters van het artefact. |
|
status |
string |
De status van het artefact. |
vmExtensionStatusMessage |
string |
Het statusbericht van de extensie van de virtuele machine. |
ArtifactParameterProperties
Eigenschappen van een artefactparameter.
Name | Type | Description |
---|---|---|
name |
string |
De naam van de artefactparameter. |
value |
string |
De waarde van de artefactparameter. |
AttachNewDataDiskOptions
Eigenschappen voor het koppelen van een nieuwe schijf aan de virtuele machine.
Name | Type | Description |
---|---|---|
diskName |
string |
De naam van de schijf die moet worden gekoppeld. |
diskSizeGiB |
integer |
Grootte van de schijf die moet worden gekoppeld in Gibibytes. |
diskType |
Het opslagtype voor de schijf (bijvoorbeeld Standard, Premium). |
CloudError
Fout van een REST-aanvraag.
Name | Type | Description |
---|---|---|
error |
De cloudfout die is opgetreden |
CloudErrorBody
Hoofdtekst van een fout van een REST-aanvraag.
Name | Type | Description |
---|---|---|
code |
string |
De foutcode. |
details |
Interne fouten. |
|
message |
string |
Het foutbericht. |
target |
string |
Het foutdoel. |
ComputeDataDisk
Een gegevensschijven die zijn gekoppeld aan een virtuele machine.
Name | Type | Description |
---|---|---|
diskSizeGiB |
integer |
Hiermee wordt de grootte van de gegevensschijf in GiB opgehaald. |
diskUri |
string |
Indien ondersteund door een blob, de URI van de onderliggende blob. |
managedDiskId |
string |
Wanneer dit wordt ondersteund door een beheerde schijf, is dit de id van de rekenschijfresource. |
name |
string |
Hiermee haalt u de naam van de gegevensschijf op. |
ComputeVmInstanceViewStatus
Statusinformatie over een virtuele machine.
Name | Type | Description |
---|---|---|
code |
string |
Hiermee haalt u de statuscode op. |
displayStatus |
string |
Hiermee haalt u het korte lokaliseerbare label voor de status op. |
message |
string |
Hiermee haalt u het bericht op dat is gekoppeld aan de status. |
ComputeVmProperties
Eigenschappen van een virtuele machine die wordt geretourneerd door de Microsoft.Compute-API.
Name | Type | Description |
---|---|---|
dataDiskIds |
string[] |
Hiermee haalt u de blob-URI van gegevensschijven op voor de virtuele machine. |
dataDisks |
Hiermee haalt u alle gegevensschijven op die zijn gekoppeld aan de virtuele machine. |
|
networkInterfaceId |
string |
Hiermee haalt u de netwerkinterface-id van de virtuele machine op. |
osDiskId |
string |
Hiermee haalt u de blob-URI van de besturingssysteemschijf op voor de virtuele machine. |
osType |
string |
Hiermee haalt u het type besturingssysteem van de virtuele machine op. |
statuses |
Hiermee haalt u de statussen van de virtuele machine op. |
|
vmSize |
string |
Hiermee haalt u de grootte van de virtuele machine op. |
DataDiskProperties
Aanvraagtekst voor het toevoegen van een nieuwe of bestaande gegevensschijf aan een virtuele machine.
Name | Type | Description |
---|---|---|
attachNewDataDiskOptions |
Hiermee geeft u opties voor het koppelen van een nieuwe schijf aan de virtuele machine. |
|
existingLabDiskId |
string |
Hiermee geeft u de bestaande labschijf-id aan die aan de virtuele machine moet worden gekoppeld. |
hostCaching |
Cacheoptie voor een gegevensschijf (d.w.w. Geen, ReadOnly, ReadWrite). |
DayDetails
Eigenschappen van een dagelijkse planning.
Name | Type | Description |
---|---|---|
time |
string |
Het tijdstip van de dag waarop de planning plaatsvindt. |
EnableStatus
De status van de planning (ingeschakeld, uitgeschakeld)
Name | Type | Description |
---|---|---|
Disabled |
string |
|
Enabled |
string |
GalleryImageReference
De referentie-informatie voor een Azure Marketplace afbeelding.
Name | Type | Description |
---|---|---|
offer |
string |
De aanbieding van de galerieafbeelding. |
osType |
string |
Het type besturingssysteem van de galerie-installatiekopieën. |
publisher |
string |
De uitgever van de galerieafbeelding. |
sku |
string |
De SKU van de galerieafbeelding. |
version |
string |
De versie van de galerie-installatiekopieën. |
HostCachingOptions
Cacheoptie voor een gegevensschijf (d.w.w. Geen, ReadOnly, ReadWrite).
Name | Type | Description |
---|---|---|
None |
string |
|
ReadOnly |
string |
|
ReadWrite |
string |
HourDetails
Eigenschappen van een uurschema.
Name | Type | Description |
---|---|---|
minute |
integer |
Minuten van het uur dat de planning wordt uitgevoerd. |
InboundNatRule
Een regel voor NAT: de poort van een VM (backendPort) weergeven op het openbare IP-adres met behulp van een load balancer.
Name | Type | Description |
---|---|---|
backendPort |
integer |
De poort waarnaar het externe verkeer wordt omgeleid. |
frontendPort |
integer |
De poort van het externe eindpunt van de binnenkomende verbinding. Mogelijke waarden liggen tussen 1 en 65535, inclusief. Als dit niet wordt opgegeven, wordt er automatisch een waarde toegewezen. |
transportProtocol |
Het transportprotocol voor het eindpunt. |
LabVirtualMachine
Een virtuele machine.
Name | Type | Default value | Description |
---|---|---|---|
id |
string |
De id van de resource. |
|
location |
string |
De locatie van de resource. |
|
name |
string |
De naam van de resource. |
|
properties.allowClaim |
boolean |
False |
Geeft aan of een andere gebruiker eigenaar kan worden van de virtuele machine |
properties.applicableSchedule |
Het toepasselijke schema voor de virtuele machine. |
||
properties.artifactDeploymentStatus |
De implementatiestatus van het artefact voor de virtuele machine. |
||
properties.artifacts |
De artefacten die op de virtuele machine moeten worden geïnstalleerd. |
||
properties.computeId |
string |
De resource-id (Microsoft.Compute) van de virtuele machine. |
|
properties.computeVm |
De eigenschappen van de virtuele machine berekenen. |
||
properties.createdByUser |
string |
Het e-mailadres van de maker van de virtuele machine. |
|
properties.createdByUserId |
string |
De object-id van de maker van de virtuele machine. |
|
properties.createdDate |
string |
De aanmaakdatum van de virtuele machine. |
|
properties.customImageId |
string |
De aangepaste installatiekopieën-id van de virtuele machine. |
|
properties.dataDiskParameters |
Nieuwe of bestaande gegevensschijven die na het maken aan de virtuele machine moeten worden gekoppeld |
||
properties.disallowPublicIpAddress |
boolean |
False |
Geeft aan of de virtuele machine moet worden gemaakt zonder een openbaar IP-adres. |
properties.environmentId |
string |
De resource-id van de omgeving die deze virtuele machine bevat, indien van toepassing. |
|
properties.expirationDate |
string |
De vervaldatum voor de VM. |
|
properties.fqdn |
string |
De volledig gekwalificeerde domeinnaam van de virtuele machine. |
|
properties.galleryImageReference |
De Microsoft Azure Marketplace verwijzing naar de installatiekopieën van de virtuele machine. |
||
properties.isAuthenticationWithSshKey |
boolean |
Hiermee wordt aangegeven of deze virtuele machine een SSH-sleutel gebruikt voor verificatie. |
|
properties.labSubnetName |
string |
De naam van het labsubnet van de virtuele machine. |
|
properties.labVirtualNetworkId |
string |
De lab-id van het virtuele netwerk van de virtuele machine. |
|
properties.lastKnownPowerState |
string |
Laatst bekende rekenkrachtstatus die is vastgelegd in DTL |
|
properties.networkInterface |
De eigenschappen van de netwerkinterface. |
||
properties.notes |
string |
De notities van de virtuele machine. |
|
properties.osType |
string |
Het type besturingssysteem van de virtuele machine. |
|
properties.ownerObjectId |
string |
dynamicValue |
De object-id van de eigenaar van de virtuele machine. |
properties.ownerUserPrincipalName |
string |
De user principal name van de eigenaar van de virtuele machine. |
|
properties.password |
string |
Het wachtwoord van de beheerder van de virtuele machine. |
|
properties.planId |
string |
De id van het plan dat is gekoppeld aan de installatiekopieën van de virtuele machine |
|
properties.provisioningState |
string |
De inrichtingsstatus van de resource. |
|
properties.scheduleParameters |
Planningen voor virtuele machines die moeten worden gemaakt |
||
properties.size |
string |
De grootte van de virtuele machine. |
|
properties.sshKey |
string |
De SSH-sleutel van de beheerder van de virtuele machine. |
|
properties.storageType |
string |
labStorageType |
Opslagtype dat moet worden gebruikt voor virtuele machines (dat wil zeggen Standard, Premium). |
properties.uniqueIdentifier |
string |
De unieke onveranderbare id van een resource (GUID). |
|
properties.userName |
string |
De gebruikersnaam van de virtuele machine. |
|
properties.virtualMachineCreationSource |
Geeft de bron aan van het maken van een virtuele labmachine. Alleen uitvoereigenschap. |
||
tags |
object |
De tags van de resource. |
|
type |
string |
Het type resource. |
LabVirtualMachineList
Het antwoord van een lijstbewerking.
Name | Type | Description |
---|---|---|
nextLink |
string |
Koppeling voor de volgende set resultaten. |
value |
Resultaten van de lijstbewerking. |
NetworkInterfaceProperties
Eigenschappen van een netwerkinterface.
Name | Type | Description |
---|---|---|
dnsName |
string |
De DNS-naam. |
privateIpAddress |
string |
Het privé-IP-adres. |
publicIpAddress |
string |
Het openbare IP-adres. |
publicIpAddressId |
string |
De resource-id van het openbare IP-adres. |
rdpAuthority |
string |
De eigenschap RdpAuthority is een DNS-hostnaam of IP-adres van de server, gevolgd door het servicepoortnummer voor RDP (Remote Desktop Protocol). |
sharedPublicIpAddressConfiguration |
De configuratie voor het delen van een openbaar IP-adres op meerdere virtuele machines. |
|
sshAuthority |
string |
De eigenschap SshAuthority is een DNS-hostnaam of IP-adres van de server, gevolgd door het servicepoortnummer voor SSH. |
subnetId |
string |
De resource-id van het subnet. |
virtualNetworkId |
string |
De resource-id van het virtuele netwerk. |
NotificationSettings
Meldingsinstellingen voor een planning.
Name | Type | Default value | Description |
---|---|---|---|
emailRecipient |
string |
De e-mailontvanger waarnaar meldingen moeten worden verzonden (dit kan een lijst zijn met door puntkomma's gescheiden e-mailadressen). |
|
notificationLocale |
string |
De landinstelling die moet worden gebruikt bij het verzenden van een melding (terugval voor niet-ondersteunde talen is EN). |
|
status | Disabled |
Als meldingen zijn ingeschakeld voor dit schema (bijvoorbeeld Ingeschakeld, Uitgeschakeld). |
|
timeInMinutes |
integer |
Tijd in minuten vóór gebeurtenis waarop de melding wordt verzonden. |
|
webhookUrl |
string |
De url van de webhook waarnaar de melding wordt verzonden. |
Schedule
Een planning.
Name | Type | Default value | Description |
---|---|---|---|
id |
string |
De id van de resource. |
|
location |
string |
De locatie van de resource. |
|
name |
string |
De naam van de resource. |
|
properties.createdDate |
string |
De aanmaakdatum van de planning. |
|
properties.dailyRecurrence |
Als de planning eenmaal per dag van de week wordt uitgevoerd, geeft u het dagelijkse terugkeerpatroon op. |
||
properties.hourlyRecurrence |
Als de planning meerdere keren per dag wordt uitgevoerd, geeft u het terugkeerpatroon per uur op. |
||
properties.notificationSettings |
Instellingen voor meldingen. |
||
properties.provisioningState |
string |
De inrichtingsstatus van de resource. |
|
properties.status | Disabled |
De status van de planning (ingeschakeld, uitgeschakeld) |
|
properties.targetResourceId |
string |
De resource-id waartoe de planning behoort |
|
properties.taskType |
string |
Het taaktype van de planning (bijvoorbeeld LabVmsShutdownTask, LabVmAutoStart). |
|
properties.timeZoneId |
string |
De tijdzone-id (bijvoorbeeld China (standaardtijd), Groenland (standaardtijd), Pacific (standaardtijd), enzovoort). De mogelijke waarden voor deze eigenschap vindt u in |
|
properties.uniqueIdentifier |
string |
De unieke onveranderbare id van een resource (GUID). |
|
properties.weeklyRecurrence |
Als de planning slechts enkele dagen van de week voorkomt, geeft u het wekelijkse terugkeerpatroon op. |
||
tags |
object |
De tags van de resource. |
|
type |
string |
Het type resource. |
ScheduleCreationParameter
Eigenschappen voor het maken van een planning.
Name | Type | Default value | Description |
---|---|---|---|
location |
string |
De locatie van de nieuwe virtuele machine of omgeving |
|
name |
string |
De naam van de virtuele machine of omgeving |
|
properties.dailyRecurrence |
Als de planning eenmaal per dag van de week wordt uitgevoerd, geeft u het dagelijkse terugkeerpatroon op. |
||
properties.hourlyRecurrence |
Als de planning meerdere keren per dag wordt uitgevoerd, geeft u het terugkeerpatroon per uur op. |
||
properties.notificationSettings |
Instellingen voor meldingen. |
||
properties.status | Disabled |
De status van de planning (ingeschakeld, uitgeschakeld) |
|
properties.targetResourceId |
string |
De resource-id waartoe de planning behoort |
|
properties.taskType |
string |
Het taaktype van de planning (bijvoorbeeld LabVmsShutdownTask, LabVmAutoStart). |
|
properties.timeZoneId |
string |
De tijdzone-id (bijvoorbeeld China (standaardtijd), Groenland (standaardtijd), Pacific (standaardtijd), enzovoort). De mogelijke waarden voor deze eigenschap vindt u in |
|
properties.weeklyRecurrence |
Als de planning slechts enkele dagen van de week voorkomt, geeft u het wekelijkse terugkeerpatroon op. |
||
tags |
object |
De tags van de resource. |
SharedPublicIpAddressConfiguration
Eigenschappen van een virtuele machine die bepalen hoe deze is verbonden met een load balancer.
Name | Type | Description |
---|---|---|
inboundNatRules |
De binnenkomende NAT-regels |
StorageType
Het opslagtype voor de schijf (bijvoorbeeld Standard, Premium).
Name | Type | Description |
---|---|---|
Premium |
string |
|
Standard |
string |
|
StandardSSD |
string |
TransportProtocol
Het transportprotocol voor het eindpunt.
Name | Type | Description |
---|---|---|
Tcp |
string |
|
Udp |
string |
VirtualMachineCreationSource
Geeft de bron aan van het maken van een virtuele labmachine. Alleen uitvoereigenschap.
Name | Type | Description |
---|---|---|
FromCustomImage |
string |
|
FromGalleryImage |
string |
|
FromSharedGalleryImage |
string |
WeekDetails
Eigenschappen van een wekelijks schema.
Name | Type | Description |
---|---|---|
time |
string |
Het tijdstip van de dag waarop de planning plaatsvindt. |
weekdays |
string[] |
De dagen van de week waarvoor de planning is ingesteld (bijvoorbeeld zondag, maandag, dinsdag, enz.). |