Virtual Machines - List

Serviço:: Dev Test Labs

Versão da API:: 2018-09-15

Listar máquinas virtuais em um determinado laboratório.

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

Com parâmetros opcionais:

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
labName	path	True	string	O nome do laboratório.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string minLength: 1	A ID da assinatura de destino.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.
$expand	query		string	Especifique a consulta $expand. Exemplo: 'properties($expand=artifacts,computeVm, networkInterface,applicableSchedule)'
$filter	query		string	O filtro a ser aplicado à operação. Exemplo: '$filter=contains(name,'myName')
$orderby	query		string	A expressão de ordenação para os resultados, usando a notação OData. Exemplo: '$orderby=name desc'
$top	query		integer (int32)	O número máximo de recursos a serem retornados da operação. Exemplo: '$top=10'

Respostas

Nome	Tipo	Description
200 OK	LabVirtualMachineList	A operação do Azure foi concluída com êxito.
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory.

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

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

VirtualMachines_List

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:: 200

{
  "value": [
    {
      "name": "{vmName}",
      "type": "Microsoft.DevTestLab/labs/virtualMachines",
      "id": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}/virtualmachines/{vmName}",
      "location": "{location}",
      "properties": {
        "allowClaim": true,
        "artifactDeploymentStatus": {
          "artifactsApplied": 0,
          "totalArtifacts": 0
        },
        "computeId": "/subscriptions/{subscriptionId}/resourceGroups/{labName}-{vmName}-{randomSuffix}/providers/Microsoft.Compute/virtualMachines/{vmName}",
        "createdByUser": "",
        "createdByUserId": "",
        "createdDate": "2018-10-01T16:53:02.4830866-07:00",
        "dataDiskParameters": [],
        "disallowPublicIpAddress": true,
        "galleryImageReference": {
          "offer": "UbuntuServer",
          "osType": "Linux",
          "publisher": "Canonical",
          "sku": "16.04-LTS",
          "version": "Latest"
        },
        "labSubnetName": "{virtualNetworkName}Subnet",
        "labVirtualNetworkId": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}/virtualnetworks/{virtualNetworkName}",
        "networkInterface": {},
        "osType": "Linux",
        "ownerObjectId": "",
        "ownerUserPrincipalName": "",
        "provisioningState": "Succeeded",
        "size": "Standard_A2_v2",
        "storageType": "Standard",
        "uniqueIdentifier": "{uniqueIdentifier}",
        "userName": "{userName}",
        "virtualMachineCreationSource": "FromGalleryImage"
      },
      "tags": {
        "tagName1": "tagValue1"
      }
    }
  ]
}

Definições

Nome	Description
ApplicableSchedule	Agendas aplicáveis a uma máquina virtual. Os agendamentos podem ter sido definidos em uma VM ou no nível do laboratório.
ArtifactDeploymentStatusProperties	Propriedades de uma implantação de artefato.
ArtifactInstallProperties	Propriedades de um artefato.
ArtifactParameterProperties	Propriedades de um parâmetro de artefato.
AttachNewDataDiskOptions	Propriedades para anexar o novo disco à Máquina Virtual.
ComputeDataDisk	Um disco de dados anexado a uma máquina virtual.
ComputeVmInstanceViewStatus	Informações de status sobre uma máquina virtual.
ComputeVmProperties	Propriedades de uma máquina virtual retornada pela API Microsoft.Compute.
DataDiskProperties	Corpo da solicitação para adicionar um disco de dados novo ou existente a uma máquina virtual.
DayDetails	Propriedades de uma agenda diária.
EnableStatus	Indica se a origem do artefato está habilitada (valores: Habilitado, Desabilitado).
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
GalleryImageReference	As informações de referência para uma imagem do Azure Marketplace.
HostCachingOptions	Opção de cache para um disco de dados (ou seja, None, ReadOnly, ReadWrite).
HourDetails	Propriedades de uma agenda por hora.
InboundNatRule	Uma regra para NAT – expondo a porta de uma VM (backendPort) no endereço IP público usando um balanceador de carga.
LabVirtualMachine	Uma máquina virtual.
LabVirtualMachineList	A resposta de uma operação de lista.
NetworkInterfaceProperties	Propriedades de um adaptador de rede.
NotificationSettings	Configurações de notificação para um agendamento.
Schedule	Uma agenda.
ScheduleCreationParameter	Propriedades para criar um agendamento.
SharedPublicIpAddressConfiguration	Propriedades de uma máquina virtual que determinam como ela está conectada a um balanceador de carga.
StorageType	O tipo de armazenamento do disco (ou seja, Standard, Premium).
TransportProtocol	O protocolo de transporte para o ponto de extremidade.
VirtualMachineCreationSource	Informa a origem da criação da máquina virtual de laboratório. Somente propriedade de saída.
WeekDetails	Propriedades de um agendamento semanal.

ApplicableSchedule

Objeto

Agendas aplicáveis a uma máquina virtual. Os agendamentos podem ter sido definidos em uma VM ou no nível do laboratório.

Nome	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 de desligamento automático, se um tiver sido definido no nível de recurso de laboratório ou laboratório.
properties.labVmsStartup	Schedule	O agendamento de inicialização automática, se um tiver sido definido no nível de recurso de laboratório ou laboratório.
tags	object	As marcas do recurso.
type	string	O tipo do recurso.

ArtifactDeploymentStatusProperties

Objeto

Propriedades de uma implantação de artefato.

Nome	Tipo	Description
artifactsApplied	integer (int32)	A contagem total dos artefatos que foram aplicados com êxito.
deploymentStatus	string	O status de implantação do artefato.
totalArtifacts	integer (int32)	A contagem total dos artefatos que foram aplicados provisoriamente.

ArtifactInstallProperties

Objeto

Propriedades de um artefato.

Nome	Tipo	Description
artifactId	string	O identificador do artefato.
artifactTitle	string	O título do artefato.
deploymentStatusMessage	string	A mensagem de status da implantação.
installTime	string (date-time)	A hora em que o artefato começa a ser instalado na máquina virtual.
parameters	ArtifactParameterProperties[]	Os parâmetros do artefato.
status	string	O status do artefato.
vmExtensionStatusMessage	string	A mensagem de status da extensão da máquina virtual.

ArtifactParameterProperties

Objeto

Propriedades de um parâmetro de artefato.

Nome	Tipo	Description
name	string	O nome do parâmetro de artefato.
value	string	O valor do parâmetro de artefato.

AttachNewDataDiskOptions

Objeto

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

Nome	Tipo	Description
diskName	string	O nome do disco a ser anexado.
diskSizeGiB	integer (int32)	Tamanho do disco a ser anexado em Gibibytes.
diskType	StorageType	O tipo de armazenamento do disco (ou seja, Standard, Premium).

ComputeDataDisk

Objeto

Um disco de dados anexado a uma máquina virtual.

Nome	Tipo	Description
diskSizeGiB	integer (int32)	Obtém o tamanho do disco de dados no GiB.
diskUri	string	Quando apoiado por um blob, o URI do blob subjacente.
managedDiskId	string	Quando apoiado pelo disco gerenciado, essa é a ID do recurso de disco de computação.
name	string	Obtém o nome do disco de dados.

ComputeVmInstanceViewStatus

Objeto

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

Nome	Tipo	Description
code	string	Obtém o código de status.
displayStatus	string	Obtém o rótulo localizável curto para o status.
message	string	Obtém a mensagem associada ao status.

ComputeVmProperties

Objeto

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

Nome	Tipo	Description
dataDiskIds	string[]	Obtém o uri de 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 a ID da interface de rede da máquina virtual.
osDiskId	string	Obtém o uri de blob de disco do sistema operacional para a máquina virtual.
osType	string	Obtém o tipo de sistema operacional da máquina virtual.
statuses	ComputeVmInstanceViewStatus[]	Obtém os status da máquina virtual.
vmSize	string	Obtém o tamanho da máquina virtual.

DataDiskProperties

Objeto

Corpo da solicitação para adicionar um disco de dados novo ou existente a uma máquina virtual.

Nome	Tipo	Description
attachNewDataDiskOptions	AttachNewDataDiskOptions	Especifica as opções para anexar um novo disco à máquina virtual.
existingLabDiskId	string	Especifica a ID de disco de laboratório existente a ser anexada à máquina virtual.
hostCaching	HostCachingOptions	Opção de cache para um disco de dados (ou seja, None, ReadOnly, ReadWrite).

DayDetails

Objeto

Propriedades de uma agenda diária.

Nome	Tipo	Description
time	string	A hora do dia em que a agenda ocorrerá.

EnableStatus

Enumeração

Indica se a origem do artefato está habilitada (valores: Habilitado, Desabilitado).

Valor	Description
Enabled
Disabled

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

GalleryImageReference

Objeto

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

Nome	Tipo	Description
offer	string	A oferta da imagem da galeria.
osType	string	O tipo de sistema operacional da imagem da galeria.
publisher	string	O editor da imagem da galeria.
sku	string	A SKU da imagem da galeria.
version	string	A versão da imagem da galeria.

HostCachingOptions

Enumeração

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

Valor	Description
None
ReadOnly
ReadWrite

HourDetails

Objeto

Propriedades de uma agenda por hora.

Nome	Tipo	Description
minute	integer (int32)	Minutos da hora em que o agendamento será executado.

InboundNatRule

Objeto

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

Nome	Tipo	Description
backendPort	integer (int32)	A porta para a qual o tráfego externo será redirecionado.
frontendPort	integer (int32)	A porta do ponto de extremidade externo da conexã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 de extremidade.

LabVirtualMachine

Objeto

Uma máquina virtual.

Nome	Tipo	Valor padrão	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 usuário pode assumir a propriedade da máquina virtual
properties.applicableSchedule	ApplicableSchedule		O agendamento aplicável para a máquina virtual.
properties.artifactDeploymentStatus	ArtifactDeploymentStatusProperties		O status de implantação do artefato para a máquina virtual.
properties.artifacts	ArtifactInstallProperties[]		Os artefatos a serem instalados 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 email do criador da máquina virtual.
properties.createdByUserId	string		O identificador de objeto do criador da máquina virtual.
properties.createdDate	string (date-time)		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		A ID do recurso do ambiente que contém essa máquina virtual, se houver.
properties.expirationDate	string (date-time)		A data de validade da VM.
properties.fqdn	string		O nome de domínio totalmente qualificado da máquina virtual.
properties.galleryImageReference	GalleryImageReference		A referência de imagem do Microsoft Azure Marketplace da máquina virtual.
properties.isAuthenticationWithSshKey	boolean		Indica se essa máquina virtual usa 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 do laboratório da máquina virtual.
properties.lastKnownPowerState	string		Último estado de energia de computação conhecido capturado em DTL
properties.networkInterface	NetworkInterfaceProperties		As propriedades do adaptador de rede.
properties.notes	string		As anotações da máquina virtual.
properties.osType	string		O tipo de sistema operacional 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 do usuário do proprietário da máquina virtual.
properties.password	string		A senha do administrador da máquina virtual.
properties.planId	string		A ID do plano associado à imagem da máquina virtual
properties.provisioningState	string		O status de provisionamento do recurso.
properties.scheduleParameters	ScheduleCreationParameter[]		Agendamentos da Máquina Virtual a serem criados
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 ser usado para 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 usuário da máquina virtual.
properties.virtualMachineCreationSource	VirtualMachineCreationSource		Informa a origem da criação da máquina virtual de laboratório. Somente propriedade de saída.
tags	object		As marcas do recurso.
type	string		O tipo do recurso.

LabVirtualMachineList

Objeto

A resposta de uma operação de lista.

Nome	Tipo	Description
nextLink	string (uri)	O link para a próxima página de itens
value	LabVirtualMachine[]	Os itens LabVirtualMachine nesta página

NetworkInterfaceProperties

Objeto

Propriedades de um adaptador de rede.

Nome	Tipo	Description
dnsName	string	O nome DNS.
privateIpAddress	string	O endereço IP privado.
publicIpAddress	string	O endereço IP público.
publicIpAddressId	string	A ID do recurso do endereço IP público.
rdpAuthority	string	A propriedade RdpAuthority é um nome de host DNS do servidor ou endereço IP seguido pelo número da porta de serviço para RDP (Protocolo de Área de Trabalho Remota).
sharedPublicIpAddressConfiguration	SharedPublicIpAddressConfiguration	A configuração para compartilhar um endereço IP público em várias máquinas virtuais.
sshAuthority	string	A propriedade SshAuthority é um nome de host DNS do servidor ou endereço IP seguido pelo número da porta de serviço para SSH.
subnetId	string	A ID do recurso da sub-rede.
virtualNetworkId	string	A ID do recurso da rede virtual.

NotificationSettings

Objeto

Configurações de notificação para um agendamento.

Nome	Tipo	Valor padrão	Description
emailRecipient	string		O destinatário de email para o qual enviar notificações (pode ser uma lista de endereços de email separados por ponto e vírgula).
notificationLocale	string		A localidade a ser usada ao enviar uma notificação (o fallback para idiomas sem suporte é EN).
status	EnableStatus	Disabled	Se as notificações estiverem habilitadas para esse agendamento (ou seja, Habilitado, Desabilitado).
timeInMinutes	integer (int32)		Tempo em minutos antes do evento em que a notificação será enviada.
webhookUrl	string		A URL do webhook para a qual a notificação será enviada.

Schedule

Objeto

Uma agenda.

Nome	Tipo	Valor padrão	Description
id	string		O identificador do recurso.
location	string		A localização do recurso.
name	string		O nome do recurso.
properties.createdDate	string (date-time)		A data de criação da agenda.
properties.dailyRecurrence	DayDetails		Se o agendamento ocorrer uma vez a cada dia da semana, especifique a recorrência diária.
properties.hourlyRecurrence	HourDetails		Se o agendamento ocorrer várias vezes por dia, especifique a recorrência por hora.
properties.notificationSettings	NotificationSettings		Configurações de notificação.
properties.provisioningState	string		O status de provisionamento do recurso.
properties.status	EnableStatus	Disabled	O status do agendamento (ou seja, Habilitado, Desabilitado)
properties.targetResourceId	string		A ID do recurso à qual o agendamento pertence
properties.taskType	string		O tipo de tarefa do agendamento (por exemplo, LabVmsShutdownTask, LabVmAutoStart).
properties.timeZoneId	string		A ID do fuso horário (por exemplo, Hora Padrão da China, Hora Padrão da Groenlândia, Hora Padrão do Pacífico etc.). Os valores possíveis para essa 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 o agendamento ocorrer apenas alguns dias da semana, especifique a recorrência semanal.
tags	object		As marcas do recurso.
type	string		O tipo do recurso.

ScheduleCreationParameter

Objeto

Propriedades para criar um agendamento.

Nome	Tipo	Valor padrão	Description
location	string		O local da nova máquina virtual ou ambiente
name	string		O nome da máquina virtual ou ambiente
properties.dailyRecurrence	DayDetails		Se o agendamento ocorrer uma vez a cada dia da semana, especifique a recorrência diária.
properties.hourlyRecurrence	HourDetails		Se o agendamento ocorrer várias vezes por dia, especifique a recorrência por hora.
properties.notificationSettings	NotificationSettings		Configurações de notificação.
properties.status	EnableStatus	Disabled	O status do agendamento (ou seja, Habilitado, Desabilitado)
properties.targetResourceId	string		A ID do recurso à qual o agendamento pertence
properties.taskType	string		O tipo de tarefa do agendamento (por exemplo, LabVmsShutdownTask, LabVmAutoStart).
properties.timeZoneId	string		A ID do fuso horário (por exemplo, Hora Padrão da China, Hora Padrão da Groenlândia, Hora Padrão do Pacífico etc.). Os valores possíveis para essa propriedade podem ser encontrados em `IReadOnlyCollection<string> TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md)
properties.weeklyRecurrence	WeekDetails		Se o agendamento ocorrer apenas alguns dias da semana, especifique a recorrência semanal.
tags	object		As marcas do recurso.

SharedPublicIpAddressConfiguration

Objeto

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

Nome	Tipo	Description
inboundNatRules	InboundNatRule[]	As regras NAT de entrada

StorageType

Enumeração

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

Valor	Description
Standard
Premium
StandardSSD

TransportProtocol

Enumeração

O protocolo de transporte para o ponto de extremidade.

Valor	Description
Tcp
Udp

VirtualMachineCreationSource

Enumeração

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

Valor	Description
FromCustomImage
FromGalleryImage
FromSharedGalleryImage

WeekDetails

Objeto

Propriedades de um agendamento semanal.

Nome	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, terça,etc.).

Compartilhar via

Virtual Machines - List

Parâmetros de URI

Respostas

Segurança

azure_auth

Escopos

Exemplos

VirtualMachines_List

Solicitação de exemplo

Resposta de exemplo

Definições

ApplicableSchedule

ArtifactDeploymentStatusProperties

ArtifactInstallProperties

ArtifactParameterProperties

AttachNewDataDiskOptions

ComputeDataDisk

ComputeVmInstanceViewStatus

ComputeVmProperties

DataDiskProperties

DayDetails

EnableStatus

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GalleryImageReference

HostCachingOptions

HourDetails

InboundNatRule

LabVirtualMachine

LabVirtualMachineList

NetworkInterfaceProperties

NotificationSettings

Schedule

ScheduleCreationParameter

SharedPublicIpAddressConfiguration

StorageType

TransportProtocol

VirtualMachineCreationSource

WeekDetails