Virtual Machines - List

Serviço:: Dev Test Labs

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

Liste 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 do URI

Name	Em	Necessá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 utilizar para esta operação.
$expand	query		string	Especifique o $expand consulta. 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 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

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

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

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

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

VirtualMachines_List

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:: 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

Name	Description
ApplicableSchedule	Agendas aplicáveis a uma máquina virtual. As agendas podem ter sido definidas em uma VM ou em nível de 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 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 programação diária.
EnableStatus	Indica se a origem do artefato está habilitada (valores: Habilitado, Desabilitado).
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
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 um horário horário.
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 uma interface de rede.
NotificationSettings	Configurações de notificação para uma agenda.
Schedule	Um horário.
ScheduleCreationParameter	Propriedades para criar uma agenda.
SharedPublicIpAddressConfiguration	Propriedades de uma máquina virtual que determinam como ela é conectada a um balanceador de carga.
StorageType	O tipo de armazenamento para o disco (ou seja, Standard, Premium).
TransportProtocol	O protocolo de transporte para o ponto de extremidade.
VirtualMachineCreationSource	Informa a fonte de criação da máquina virtual de laboratório. Somente propriedade de saída.
WeekDetails	Propriedades de um horário semanal.

ApplicableSchedule

Object

Agendas aplicáveis a uma máquina virtual. As agendas podem ter sido definidas em uma VM ou em nível de 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	A agenda de desligamento automático, se tiver sido definida no nível de recursos de laboratório ou laboratório.
properties.labVmsStartup	Schedule	O agendamento de inicialização automática, se tiver sido definido no nível de recurso de laboratório ou laboratório.
tags	object	As tags do recurso.
type	string	O tipo do recurso.

ArtifactDeploymentStatusProperties

Object

Propriedades de uma implantação de artefato.

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

ArtifactInstallProperties

Object

Propriedades de um artefato.

Name	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

Object

Propriedades de um parâmetro de artefato.

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

AttachNewDataDiskOptions

Object

Propriedades para anexar novo disco à máquina virtual.

Name	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 para o disco (ou seja, Standard, Premium).

ComputeDataDisk

Object

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

Name	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 o backup é feito pelo disco gerenciado, esse é o ID do recurso de disco de computação.
name	string	Obtém o nome do disco de dados.

ComputeVmInstanceViewStatus

Object

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

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

ComputeVmProperties

Object

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

Name	Tipo	Description
dataDiskIds	string[]	Obtém discos de dados blob uri 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 do 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

Object

Corpo da solicitação 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 a ID do 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

Object

Propriedades de uma programação diária.

Name	Tipo	Description
time	string	A hora do dia o horário ocorrerá.

EnableStatus

Enumeração

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

Valor	Description
Enabled
Disabled

ErrorAdditionalInfo

Object

O erro de gerenciamento de recursos informações adicionais.

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

ErrorDetail

Object

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
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

Object

Resposta de erro

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

GalleryImageReference

Object

As informações de referência para uma imagem do 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 editor da imagem da galeria.
sku	string	O 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

Object

Propriedades de um horário horário.

Name	Tipo	Description
minute	integer (int32)	Minutos da hora em que o horário será executado.

InboundNatRule

Object

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

Name	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

Object

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 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 e-mail 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 expiração 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 de 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 em 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 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 de máquinas virtuais 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 único imutável de um recurso (Guid).
properties.userName	string		O nome de usuário da máquina virtual.
properties.virtualMachineCreationSource	VirtualMachineCreationSource		Informa a fonte de criação da máquina virtual de laboratório. Somente propriedade de saída.
tags	object		As tags do recurso.
type	string		O tipo do recurso.

LabVirtualMachineList

Object

A resposta de uma operação de lista.

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

NetworkInterfaceProperties

Object

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 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	O ID do recurso da sub-rede.
virtualNetworkId	string	O ID do recurso da rede virtual.

NotificationSettings

Object

Configuraçõ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 ponto-e-vírgula).
notificationLocale	string		A localidade a ser usada ao enviar uma notificação (fallback para idiomas não suportados é EN).
status	EnableStatus	Disabled	Se as notificações estiverem habilitadas para esse agendamento (ou seja, Habilitado, Desativado).
timeInMinutes	integer (int32)		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

Object

Um horário.

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 (date-time)		A data de criação do cronograma.
properties.dailyRecurrence	DayDetails		Se o horário ocorrer uma vez em cada dia da semana, especifique a recorrência diária.
properties.hourlyRecurrence	HourDetails		Se o agendamento ocorrer várias vezes ao dia, especifique a recorrência horária.
properties.notificationSettings	NotificationSettings		Configurações de notificação.
properties.provisioningState	string		O status de provisionamento do recurso.
properties.status	EnableStatus	Disabled	O status da agenda (ou seja, Habilitado, Desativado)
properties.targetResourceId	string		O ID do recurso ao qual a agenda pertence
properties.taskType	string		O tipo de tarefa do cronograma (por exemplo, LabVmsShutdownTask, LabVmAutoStart).
properties.timeZoneId	string		O 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 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 único imutável de um recurso (Guid).
properties.weeklyRecurrence	WeekDetails		Se o horário ocorrer apenas alguns dias da semana, especifique a recorrência semanal.
tags	object		As tags do recurso.
type	string		O tipo do recurso.

ScheduleCreationParameter

Object

Propriedades para criar uma agenda.

Name	Tipo	Default value	Description
location	string		O local da nova máquina virtual ou ambiente
name	string		O nome da máquina virtual ou do ambiente
properties.dailyRecurrence	DayDetails		Se o horário ocorrer uma vez em cada dia da semana, especifique a recorrência diária.
properties.hourlyRecurrence	HourDetails		Se o agendamento ocorrer várias vezes ao dia, especifique a recorrência horária.
properties.notificationSettings	NotificationSettings		Configurações de notificação.
properties.status	EnableStatus	Disabled	O status da agenda (ou seja, Habilitado, Desativado)
properties.targetResourceId	string		O ID do recurso ao qual a agenda pertence
properties.taskType	string		O tipo de tarefa do cronograma (por exemplo, LabVmsShutdownTask, LabVmAutoStart).
properties.timeZoneId	string		O 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 esta propriedade podem ser encontrados em `IReadOnlyCollection<string> TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md)
properties.weeklyRecurrence	WeekDetails		Se o horário ocorrer apenas alguns dias da semana, especifique a recorrência semanal.
tags	object		As tags do recurso.

SharedPublicIpAddressConfiguration

Object

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

Name	Tipo	Description
inboundNatRules	InboundNatRule[]	As novas regras NAT

StorageType

Enumeração

O tipo de armazenamento para o 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 fonte de criação da máquina virtual de laboratório. Somente propriedade de saída.

Valor	Description
FromCustomImage
FromGalleryImage
FromSharedGalleryImage

WeekDetails

Object

Propriedades de um horário semanal.

Name	Tipo	Description
time	string	A hora do dia em que ocorrerá o agendamento.
weekdays	string[]	Os dias da semana para os quais o horário está definido (por exemplo, domingo, segunda-feira, terça-feira, etc.).

Partilhar via

Virtual Machines - List

Parâmetros do URI

Respostas

Segurança

azure_auth

Âmbitos

Exemplos

VirtualMachines_List

Pedido de amostra

Resposta da amostra

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