Partilhar via


Virtual Machines - List

Listar máquinas virtuais num determinado laboratório.

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

Parâmetros do URI

Name Em Necessário Tipo Description
labName
path True

string

O nome do laboratório.

resourceGroupName
path True

string

O nome do grupo de recursos.

subscriptionId
path True

string

O ID da subscrição.

api-version
query True

string

Versão da API de Cliente.

$expand
query

string

Especifique a consulta $expand. Exemplo: "properties($expand=artifacts,computeVm,networkInterface,applicableSchedule)"

$filter
query

string

O filtro a aplicar à operação. Exemplo: '$filter=contains(name,'myName')

$orderby
query

string

A expressão de ordenação para os resultados, com a notação OData. Exemplo: "$orderby=name desc"

$top
query

integer

int32

O número máximo de recursos a devolver da operação. Exemplo: "$top=10"

Respostas

Name Tipo Description
200 OK

LabVirtualMachineList

OK

Other Status Codes

CloudError

BadRequest

Segurança

azure_auth

Concessão Implícita OAuth2

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name Description
user_impersonation Aceder ao Microsoft Azure

Exemplos

VirtualMachines_List

Pedido de amostra

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

Resposta da amostra

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

Definições

Name Description
ApplicableSchedule

Agendas aplicáveis a uma máquina virtual. As agendas podem ter sido definidas numa VM ou ao nível do laboratório.

ArtifactDeploymentStatusProperties

Propriedades de uma implementação de artefacto.

ArtifactInstallProperties

Propriedades de um artefacto.

ArtifactParameterProperties

Propriedades de um parâmetro de artefacto.

AttachNewDataDiskOptions

Propriedades para anexar o novo disco à Máquina Virtual.

CloudError

Erro de um pedido REST.

CloudErrorBody

Corpo de um erro de um pedido REST.

ComputeDataDisk

Discos de dados ligados a uma máquina virtual.

ComputeVmInstanceViewStatus

Informações de estado sobre uma máquina virtual.

ComputeVmProperties

Propriedades de uma máquina virtual devolvidas pela API Microsoft.Compute.

DataDiskProperties

Corpo do pedido para adicionar um disco de dados novo ou existente a uma máquina virtual.

DayDetails

Propriedades de uma agenda diária.

EnableStatus

O estado da agenda (ou seja, Ativado, Desativado)

GalleryImageReference

As informações de referência de uma imagem de Azure Marketplace.

HostCachingOptions

Opção de colocação em cache para um disco de dados (ou seja, Nenhum, ReadOnly, ReadWrite).

HourDetails

Propriedades de uma agenda por hora.

InboundNatRule

Uma regra para NAT – expor a porta de uma VM (backendPort) no endereço IP público com um balanceador de carga.

LabVirtualMachine

Uma máquina virtual.

LabVirtualMachineList

A resposta de uma operação de lista.

NetworkInterfaceProperties

Propriedades de uma interface de rede.

NotificationSettings

Definições de notificação para uma agenda.

Schedule

Uma agenda.

ScheduleCreationParameter

Propriedades para criar uma agenda.

SharedPublicIpAddressConfiguration

Propriedades de uma máquina virtual que determinam como está ligada a um balanceador de carga.

StorageType

O tipo de armazenamento do disco (ou seja, Standard, Premium).

TransportProtocol

O protocolo de transporte para o ponto final.

VirtualMachineCreationSource

Indica a origem da criação da máquina virtual de laboratório. Apenas propriedade de saída.

WeekDetails

Propriedades de uma agenda semanal.

ApplicableSchedule

Agendas aplicáveis a uma máquina virtual. As agendas podem ter sido definidas numa VM ou ao nível do laboratório.

Name Tipo Description
id

string

O identificador do recurso.

location

string

A localização do recurso.

name

string

O nome do recurso.

properties.labVmsShutdown

Schedule

O agendamento do encerramento automático, se tiver sido definido ao nível do laboratório ou do recurso de laboratório.

properties.labVmsStartup

Schedule

O agendamento de arranque automático, se tiver sido definido ao nível do laboratório ou do recurso de laboratório.

tags

object

As etiquetas do recurso.

type

string

O tipo do recurso.

ArtifactDeploymentStatusProperties

Propriedades de uma implementação de artefacto.

Name Tipo Description
artifactsApplied

integer

A contagem total dos artefactos que foram aplicados com êxito.

deploymentStatus

string

O estado de implementação do artefacto.

totalArtifacts

integer

A contagem total dos artefactos que foram aplicados em modo de tentativa.

ArtifactInstallProperties

Propriedades de um artefacto.

Name Tipo Description
artifactId

string

O identificador do artefacto.

artifactTitle

string

O título do artefacto.

deploymentStatusMessage

string

A mensagem de estado da implementação.

installTime

string

A hora em que o artefacto começa a ser instalado na máquina virtual.

parameters

ArtifactParameterProperties[]

Os parâmetros do artefacto.

status

string

O estado do artefacto.

vmExtensionStatusMessage

string

A mensagem de estado da extensão da máquina virtual.

ArtifactParameterProperties

Propriedades de um parâmetro de artefacto.

Name Tipo Description
name

string

O nome do parâmetro do artefacto.

value

string

O valor do parâmetro do artefacto.

AttachNewDataDiskOptions

Propriedades para anexar o novo disco à Máquina Virtual.

Name Tipo Description
diskName

string

O nome do disco a anexar.

diskSizeGiB

integer

Tamanho do disco a anexar em Gibibytes.

diskType

StorageType

O tipo de armazenamento do disco (ou seja, Standard, Premium).

CloudError

Erro de um pedido REST.

Name Tipo Description
error

CloudErrorBody

O erro na cloud que ocorreu

CloudErrorBody

Corpo de um erro de um pedido REST.

Name Tipo Description
code

string

O código de erro.

details

CloudErrorBody[]

Erros internos.

message

string

A mensagem de erro.

target

string

O destino do erro.

ComputeDataDisk

Discos de dados ligados a uma máquina virtual.

Name Tipo Description
diskSizeGiB

integer

Obtém o tamanho do disco de dados no GiB.

diskUri

string

Quando suportado por um blob, o URI do blob subjacente.

managedDiskId

string

Quando suportado pelo disco gerido, este é o ID do recurso de disco de computação.

name

string

Obtém o nome do disco de dados.

ComputeVmInstanceViewStatus

Informações de estado sobre uma máquina virtual.

Name Tipo Description
code

string

Obtém o código de estado.

displayStatus

string

Obtém a etiqueta localizável curta para o estado.

message

string

Obtém a mensagem associada ao estado.

ComputeVmProperties

Propriedades de uma máquina virtual devolvidas pela API Microsoft.Compute.

Name Tipo Description
dataDiskIds

string[]

Obtém o URI do blob de discos de dados para a máquina virtual.

dataDisks

ComputeDataDisk[]

Obtém todos os discos de dados anexados à máquina virtual.

networkInterfaceId

string

Obtém o ID da interface de rede da máquina virtual.

osDiskId

string

Obtém o URI do blob do disco do SO para a máquina virtual.

osType

string

Obtém o tipo de SO da máquina virtual.

statuses

ComputeVmInstanceViewStatus[]

Obtém os estados da máquina virtual.

vmSize

string

Obtém o tamanho da máquina virtual.

DataDiskProperties

Corpo do pedido para adicionar um disco de dados novo ou existente a uma máquina virtual.

Name Tipo Description
attachNewDataDiskOptions

AttachNewDataDiskOptions

Especifica opções para anexar um novo disco à máquina virtual.

existingLabDiskId

string

Especifica o ID de disco de laboratório existente para anexar à máquina virtual.

hostCaching

HostCachingOptions

Opção de colocação em cache para um disco de dados (ou seja, Nenhum, ReadOnly, ReadWrite).

DayDetails

Propriedades de uma agenda diária.

Name Tipo Description
time

string

A hora do dia em que a agenda ocorrerá.

EnableStatus

O estado da agenda (ou seja, Ativado, Desativado)

Name Tipo Description
Disabled

string

Enabled

string

GalleryImageReference

As informações de referência de uma imagem de Azure Marketplace.

Name Tipo Description
offer

string

A oferta da imagem da galeria.

osType

string

O tipo de SO da imagem da galeria.

publisher

string

O publicador da imagem da galeria.

sku

string

O SKU da imagem da galeria.

version

string

A versão da imagem da galeria.

HostCachingOptions

Opção de colocação em cache para um disco de dados (ou seja, Nenhum, ReadOnly, ReadWrite).

Name Tipo Description
None

string

ReadOnly

string

ReadWrite

string

HourDetails

Propriedades de uma agenda por hora.

Name Tipo Description
minute

integer

Minutos da hora em que a agenda será executada.

InboundNatRule

Uma regra para NAT – expor a porta de uma VM (backendPort) no endereço IP público com um balanceador de carga.

Name Tipo Description
backendPort

integer

A porta para a qual o tráfego externo será redirecionado.

frontendPort

integer

A porta de ponto final externo da ligação de entrada. Os valores possíveis variam entre 1 e 65535, inclusive. Se não for especificado, um valor será alocado automaticamente.

transportProtocol

TransportProtocol

O protocolo de transporte para o ponto final.

LabVirtualMachine

Uma máquina virtual.

Name Tipo Default value Description
id

string

O identificador do recurso.

location

string

A localização do recurso.

name

string

O nome do recurso.

properties.allowClaim

boolean

False

Indica se outro utilizador pode assumir a propriedade da máquina virtual

properties.applicableSchedule

ApplicableSchedule

A agenda aplicável para a máquina virtual.

properties.artifactDeploymentStatus

ArtifactDeploymentStatusProperties

O estado de implementação do artefacto da máquina virtual.

properties.artifacts

ArtifactInstallProperties[]

Os artefactos a instalar na máquina virtual.

properties.computeId

string

O identificador de recurso (Microsoft.Compute) da máquina virtual.

properties.computeVm

ComputeVmProperties

As propriedades da máquina virtual de computação.

properties.createdByUser

string

O endereço de e-mail do criador da máquina virtual.

properties.createdByUserId

string

O identificador de objeto do criador da máquina virtual.

properties.createdDate

string

A data de criação da máquina virtual.

properties.customImageId

string

O identificador de imagem personalizado da máquina virtual.

properties.dataDiskParameters

DataDiskProperties[]

Discos de dados novos ou existentes para anexar à máquina virtual após a criação

properties.disallowPublicIpAddress

boolean

False

Indica se a máquina virtual deve ser criada sem um endereço IP público.

properties.environmentId

string

O ID de recurso do ambiente que contém esta máquina virtual, se existir.

properties.expirationDate

string

A data de expiração da VM.

properties.fqdn

string

O nome de domínio completamente qualificado da máquina virtual.

properties.galleryImageReference

GalleryImageReference

O Microsoft Azure Marketplace referência de imagem da máquina virtual.

properties.isAuthenticationWithSshKey

boolean

Indica se esta máquina virtual utiliza uma chave SSH para autenticação.

properties.labSubnetName

string

O nome da sub-rede do laboratório da máquina virtual.

properties.labVirtualNetworkId

string

O identificador de rede virtual de laboratório da máquina virtual.

properties.lastKnownPowerState

string

Último estado de poder de computação conhecido capturado no DTL

properties.networkInterface

NetworkInterfaceProperties

As propriedades da interface de rede.

properties.notes

string

As notas da máquina virtual.

properties.osType

string

O tipo de SO da máquina virtual.

properties.ownerObjectId

string

dynamicValue

O identificador de objeto do proprietário da máquina virtual.

properties.ownerUserPrincipalName

string

O nome principal de utilizador do proprietário da máquina virtual.

properties.password

string

A palavra-passe do administrador da máquina virtual.

properties.planId

string

O ID do plano associado à imagem da máquina virtual

properties.provisioningState

string

O estado de aprovisionamento do recurso.

properties.scheduleParameters

ScheduleCreationParameter[]

Agendamentos de Máquinas Virtuais a criar

properties.size

string

O tamanho da máquina virtual.

properties.sshKey

string

A chave SSH do administrador da máquina virtual.

properties.storageType

string

labStorageType

Tipo de armazenamento a utilizar na máquina virtual (ou seja, Standard, Premium).

properties.uniqueIdentifier

string

O identificador imutável exclusivo de um recurso (Guid).

properties.userName

string

O nome de utilizador da máquina virtual.

properties.virtualMachineCreationSource

VirtualMachineCreationSource

Indica a origem da criação da máquina virtual de laboratório. Apenas propriedade de saída.

tags

object

As etiquetas do recurso.

type

string

O tipo do recurso.

LabVirtualMachineList

A resposta de uma operação de lista.

Name Tipo Description
nextLink

string

Ligação para o próximo conjunto de resultados.

value

LabVirtualMachine[]

Resultados da operação de lista.

NetworkInterfaceProperties

Propriedades de uma interface de rede.

Name Tipo Description
dnsName

string

O nome DNS.

privateIpAddress

string

O endereço IP privado.

publicIpAddress

string

O endereço IP público.

publicIpAddressId

string

O ID de recurso do endereço IP público.

rdpAuthority

string

A propriedade RdpAuthority é um nome de anfitrião DNS do servidor ou endereço IP seguido do número da porta de serviço para RDP (Remote Desktop Protocol).

sharedPublicIpAddressConfiguration

SharedPublicIpAddressConfiguration

A configuração para partilhar um endereço IP público em várias máquinas virtuais.

sshAuthority

string

A propriedade SshAuthority é um nome de anfitrião DNS do servidor ou endereço IP seguido do número da porta de serviço para SSH.

subnetId

string

O ID de recurso da sub-rede.

virtualNetworkId

string

O ID de recurso da rede virtual.

NotificationSettings

Definições de notificação para uma agenda.

Name Tipo Default value Description
emailRecipient

string

O destinatário do e-mail para o qual enviar notificações (pode ser uma lista de endereços de e-mail separados por pontos e vírgulas).

notificationLocale

string

A região a utilizar ao enviar uma notificação (contingência para idiomas não suportados é EN).

status

EnableStatus

Disabled

Se as notificações estiverem ativadas para esta agenda (ou seja, Ativada, Desativada).

timeInMinutes

integer

Tempo em minutos antes do evento em que a notificação será enviada.

webhookUrl

string

O URL do webhook para o qual a notificação será enviada.

Schedule

Uma agenda.

Name Tipo Default value Description
id

string

O identificador do recurso.

location

string

A localização do recurso.

name

string

O nome do recurso.

properties.createdDate

string

A data de criação da agenda.

properties.dailyRecurrence

DayDetails

Se a agenda ocorrer uma vez por dia da semana, especifique a periodicidade diária.

properties.hourlyRecurrence

HourDetails

Se a agenda ocorrer várias vezes por dia, especifique a periodicidade por hora.

properties.notificationSettings

NotificationSettings

Definições de notificação.

properties.provisioningState

string

O estado de aprovisionamento do recurso.

properties.status

EnableStatus

Disabled

O estado da agenda (ou seja, Ativado, Desativado)

properties.targetResourceId

string

O ID do recurso ao qual a agenda pertence

properties.taskType

string

O tipo de tarefa da agenda (por exemplo, LabVmsShutdownTask, LabVmAutoStart).

properties.timeZoneId

string

O ID do fuso horário (por exemplo, Hora Padrão da China, Hora Padrão da Gronelândia, Hora Padrão do Pacífico, etc.). Os valores possíveis para esta propriedade podem ser encontrados em IReadOnlyCollection<string> TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md)

properties.uniqueIdentifier

string

O identificador imutável exclusivo de um recurso (Guid).

properties.weeklyRecurrence

WeekDetails

Se a agenda ocorrer apenas alguns dias da semana, especifique a periodicidade semanal.

tags

object

As etiquetas do recurso.

type

string

O tipo de recurso.

ScheduleCreationParameter

Propriedades para criar uma agenda.

Name Tipo Default value Description
location

string

A localização da nova máquina virtual ou ambiente

name

string

O nome da máquina virtual ou do ambiente

properties.dailyRecurrence

DayDetails

Se a agenda ocorrer uma vez por dia da semana, especifique a periodicidade diária.

properties.hourlyRecurrence

HourDetails

Se a agenda ocorrer várias vezes por dia, especifique a periodicidade por hora.

properties.notificationSettings

NotificationSettings

Definições de notificação.

properties.status

EnableStatus

Disabled

O estado da agenda (ou seja, Ativado, Desativado)

properties.targetResourceId

string

O ID do recurso ao qual a agenda pertence

properties.taskType

string

O tipo de tarefa da agenda (por exemplo, LabVmsShutdownTask, LabVmAutoStart).

properties.timeZoneId

string

O ID do fuso horário (por exemplo, Hora Padrão da China, Hora Padrão da Gronelândia, Hora Padrão do Pacífico, etc.). Os valores possíveis para esta propriedade podem ser encontrados em IReadOnlyCollection<string> TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md)

properties.weeklyRecurrence

WeekDetails

Se a agenda ocorrer apenas alguns dias da semana, especifique a periodicidade semanal.

tags

object

As etiquetas do recurso.

SharedPublicIpAddressConfiguration

Propriedades de uma máquina virtual que determinam como está ligada a um balanceador de carga.

Name Tipo Description
inboundNatRules

InboundNatRule[]

As regras NAT recebidas

StorageType

O tipo de armazenamento do disco (ou seja, Standard, Premium).

Name Tipo Description
Premium

string

Standard

string

StandardSSD

string

TransportProtocol

O protocolo de transporte para o ponto final.

Name Tipo Description
Tcp

string

Udp

string

VirtualMachineCreationSource

Indica a origem da criação da máquina virtual de laboratório. Apenas propriedade de saída.

Name Tipo Description
FromCustomImage

string

FromGalleryImage

string

FromSharedGalleryImage

string

WeekDetails

Propriedades de uma agenda semanal.

Name Tipo Description
time

string

A hora do dia em que a agenda ocorrerá.

weekdays

string[]

Os dias da semana para os quais a agenda está definida (por exemplo, domingo, segunda-feira, terça-feira, etc.).