Virtual Machines - List
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
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 de URI
Nome | Em | Obrigatório | Tipo | Description |
---|---|---|---|---|
lab
|
path | True |
string |
O nome do lab. |
resource
|
path | True |
string |
O nome do grupo de recursos. |
subscription
|
path | True |
string |
A ID da assinatura. |
api-version
|
query | True |
string |
Versão de API do cliente. |
$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 |
OK |
|
Other Status Codes |
BadRequest |
Segurança
azure_auth
Concessão Implícita OAuth2
Tipo:
oauth2
Flow:
implicit
URL de Autorização:
https://login.microsoftonline.com/common/oauth2/authorize
Escopos
Nome | Description |
---|---|
user_impersonation | Acessar o Microsoft Azure |
Exemplos
VirtualMachines_List
Solicitação de exemplo
Resposta de exemplo
{
"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
Nome | Description |
---|---|
Applicable |
Agendas aplicáveis a uma máquina virtual. Os agendamentos podem ter sido definidos em uma VM ou no nível do laboratório. |
Artifact |
Propriedades de uma implantação de artefato. |
Artifact |
Propriedades de um artefato. |
Artifact |
Propriedades de um parâmetro de artefato. |
Attach |
Propriedades para anexar um novo disco à Máquina Virtual. |
Cloud |
Erro de uma solicitação REST. |
Cloud |
Corpo de um erro de uma solicitação REST. |
Compute |
Um disco de dados anexado a uma máquina virtual. |
Compute |
Informações de status sobre uma máquina virtual. |
Compute |
Propriedades de uma máquina virtual retornada pela API Microsoft.Compute. |
Data |
Corpo da solicitação para adicionar um disco de dados novo ou existente a uma máquina virtual. |
Day |
Propriedades de uma agenda diária. |
Enable |
O status do agendamento (ou seja, Habilitado, Desabilitado) |
Gallery |
As informações de referência de uma imagem Azure Marketplace. |
Host |
Opção de cache para um disco de dados (ou seja, Nenhum, ReadOnly, ReadWrite). |
Hour |
Propriedades de um agendamento por hora. |
Inbound |
Uma regra para NAT – expondo a porta de uma VM (backendPort) no endereço IP público usando um balanceador de carga. |
Lab |
Uma máquina virtual. |
Lab |
A resposta de uma operação de lista. |
Network |
Propriedades de um adaptador de rede. |
Notification |
Configurações de notificação para um agendamento. |
Schedule |
Uma agenda. |
Schedule |
Propriedades para criar um agendamento. |
Shared |
Propriedades de uma máquina virtual que determinam como ela está conectada a um balanceador de carga. |
Storage |
O tipo de armazenamento para o disco (ou seja, Standard, Premium). |
Transport |
O protocolo de transporte para o ponto de extremidade. |
Virtual |
Informa a origem da criação da máquina virtual de laboratório. Somente propriedade de saída. |
Week |
Propriedades de um agendamento semanal. |
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.
Nome | Tipo | Description |
---|---|---|
id |
string |
O identificador do recurso. |
location |
string |
A localização do recurso. |
name |
string |
O nome do recurso. |
properties.labVmsShutdown |
O agendamento de desligamento automático, se um tiver sido definido no nível do recurso de laboratório ou laboratório. |
|
properties.labVmsStartup |
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 |
Tipo do recurso. |
ArtifactDeploymentStatusProperties
Propriedades de uma implantação de artefato.
Nome | Tipo | Description |
---|---|---|
artifactsApplied |
integer |
A contagem total dos artefatos que foram aplicados com êxito. |
deploymentStatus |
string |
O status de implantação do artefato. |
totalArtifacts |
integer |
A contagem total dos artefatos que foram aplicados provisoriamente. |
ArtifactInstallProperties
Propriedades de um artefato.
Nome | Tipo | Description |
---|---|---|
artifactId |
string |
O identificador do artefato. |
artifactTitle |
string |
O título do artefato. |
deploymentStatusMessage |
string |
A mensagem status da implantação. |
installTime |
string |
A hora em que o artefato começa a ser instalado na máquina virtual. |
parameters |
Os parâmetros do artefato. |
|
status |
string |
O status do artefato. |
vmExtensionStatusMessage |
string |
A mensagem status da extensão da máquina virtual. |
ArtifactParameterProperties
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 artifact. |
AttachNewDataDiskOptions
Propriedades para anexar um novo disco à Máquina Virtual.
Nome | Tipo | Description |
---|---|---|
diskName |
string |
O nome do disco a ser anexado. |
diskSizeGiB |
integer |
Tamanho do disco a ser anexado em Gibibytes. |
diskType |
O tipo de armazenamento para o disco (ou seja, Standard, Premium). |
CloudError
Erro de uma solicitação REST.
Nome | Tipo | Description |
---|---|---|
error |
O erro de nuvem que ocorreu |
CloudErrorBody
Corpo de um erro de uma solicitação REST.
Nome | Tipo | Description |
---|---|---|
code |
string |
O código de erro. |
details |
Erros internos. |
|
message |
string |
A mensagem de erro. |
target |
string |
O destino do erro. |
ComputeDataDisk
Um disco de dados anexado a uma máquina virtual.
Nome | Tipo | Description |
---|---|---|
diskSizeGiB |
integer |
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
Informações de status sobre uma máquina virtual.
Nome | Tipo | Description |
---|---|---|
code |
string |
Obtém o código status. |
displayStatus |
string |
Obtém o rótulo localizável curto para o status. |
message |
string |
Obtém a mensagem associada ao status. |
ComputeVmProperties
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 |
Obtém todos os discos de dados anexados à máquina virtual. |
|
networkInterfaceId |
string |
Obtém a ID do adaptador 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 |
Obtém os status da máquina virtual. |
|
vmSize |
string |
Obtém o tamanho da máquina virtual. |
DataDiskProperties
Corpo da solicitação para adicionar um disco de dados novo ou existente a uma máquina virtual.
Nome | Tipo | Description |
---|---|---|
attachNewDataDiskOptions |
Especifica 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 |
Opção de cache para um disco de dados (ou seja, Nenhum, ReadOnly, ReadWrite). |
DayDetails
Propriedades de uma agenda diária.
Nome | Tipo | Description |
---|---|---|
time |
string |
A hora do dia em que a agenda ocorrerá. |
EnableStatus
O status do agendamento (ou seja, Habilitado, Desabilitado)
Nome | Tipo | Description |
---|---|---|
Disabled |
string |
|
Enabled |
string |
GalleryImageReference
As informações de referência de uma imagem 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 |
O SKU da imagem da galeria. |
version |
string |
A versão da imagem da galeria. |
HostCachingOptions
Opção de cache para um disco de dados (ou seja, Nenhum, ReadOnly, ReadWrite).
Nome | Tipo | Description |
---|---|---|
None |
string |
|
ReadOnly |
string |
|
ReadWrite |
string |
HourDetails
Propriedades de um agendamento por hora.
Nome | Tipo | Description |
---|---|---|
minute |
integer |
Minutos da hora em que o agendamento será executado. |
InboundNatRule
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 |
A porta para a qual o tráfego externo será redirecionado. |
frontendPort |
integer |
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 |
O protocolo de transporte para o ponto de extremidade. |
LabVirtualMachine
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 |
O agendamento aplicável para a máquina virtual. |
||
properties.artifactDeploymentStatus |
A implantação do artefato status para a máquina virtual. |
||
properties.artifacts |
Os artefatos a serem instalados na máquina virtual. |
||
properties.computeId |
string |
O identificador de recurso (Microsoft.Compute) da máquina virtual. |
|
properties.computeVm |
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 |
A data de criação da máquina virtual. |
|
properties.customImageId |
string |
O identificador de imagem personalizado da máquina virtual. |
|
properties.dataDiskParameters |
Discos de dados novos ou existentes a serem anexados à 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 |
A data de validade da VM. |
|
properties.fqdn |
string |
O nome de domínio totalmente qualificado da máquina virtual. |
|
properties.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 potência de computação conhecido capturado em DTL |
|
properties.networkInterface |
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 |
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 |
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 |
Tipo do recurso. |
LabVirtualMachineList
A resposta de uma operação de lista.
Nome | Tipo | Description |
---|---|---|
nextLink |
string |
Link para o próximo conjunto de resultados. |
value |
Resultados da operação de lista. |
NetworkInterfaceProperties
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 |
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
Configurações de notificação para um agendamento.
Nome | Tipo | Valor padrão | Description |
---|---|---|---|
emailRecipient |
string |
O destinatário do 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 | Disabled |
Se as notificações estiverem habilitadas para esse agendamento (ou seja, Habilitado, Desabilitado). |
|
timeInMinutes |
integer |
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
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 |
A data de criação da agenda. |
|
properties.dailyRecurrence |
Se o agendamento ocorrer uma vez a cada dia da semana, especifique a recorrência diária. |
||
properties.hourlyRecurrence |
Se o agendamento ocorrer várias vezes por dia, especifique a recorrência por hora. |
||
properties.notificationSettings |
Configurações de notificação. |
||
properties.provisioningState |
string |
O status de provisionamento do recurso. |
|
properties.status | 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 |
|
properties.uniqueIdentifier |
string |
O identificador imutável exclusivo de um recurso (Guid). |
|
properties.weeklyRecurrence |
Se o agendamento ocorrer apenas alguns dias da semana, especifique a recorrência semanal. |
||
tags |
object |
As marcas do recurso. |
|
type |
string |
Tipo do recurso. |
ScheduleCreationParameter
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 |
Se o agendamento ocorrer uma vez a cada dia da semana, especifique a recorrência diária. |
||
properties.hourlyRecurrence |
Se o agendamento ocorrer várias vezes por dia, especifique a recorrência por hora. |
||
properties.notificationSettings |
Configurações de notificação. |
||
properties.status | 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 |
|
properties.weeklyRecurrence |
Se o agendamento ocorrer apenas alguns dias da semana, especifique a recorrência semanal. |
||
tags |
object |
As marcas do recurso. |
SharedPublicIpAddressConfiguration
Propriedades de uma máquina virtual que determinam como ela está conectada a um balanceador de carga.
Nome | Tipo | Description |
---|---|---|
inboundNatRules |
As regras NAT de entrada |
StorageType
O tipo de armazenamento para o disco (ou seja, Standard, Premium).
Nome | Tipo | Description |
---|---|---|
Premium |
string |
|
Standard |
string |
|
StandardSSD |
string |
TransportProtocol
O protocolo de transporte para o ponto de extremidade.
Nome | Tipo | Description |
---|---|---|
Tcp |
string |
|
Udp |
string |
VirtualMachineCreationSource
Informa a origem da criação da máquina virtual de laboratório. Somente propriedade de saída.
Nome | Tipo | Description |
---|---|---|
FromCustomImage |
string |
|
FromGalleryImage |
string |
|
FromSharedGalleryImage |
string |
WeekDetails
Propriedades de um agendamento semanal.
Nome | Tipo | Description |
---|---|---|
time |
string |
A hora do dia em que o agendamento ocorrerá. |
weekdays |
string[] |
Os dias da semana para os quais a agenda é definida (por exemplo, domingo, segunda- feira, terça-feira, etc.). |