Virtual Machines - List By Lab

Ссылка

Service:: Lab Services

API Version:: 2023-06-07

Получение всех виртуальных машин для лаборатории.
Возвращает список всех виртуальных машин для лаборатории.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labs/{labName}/virtualMachines?api-version=2023-06-07

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labs/{labName}/virtualMachines?api-version=2023-06-07&$filter={$filter}

Параметры URI

Имя	В	Обязательно	Тип	Описание
labName	path	True	string	Имя лаборатории, которая однозначно идентифицирует ее в содержательном плане лаборатории. Используется в URI ресурсов.
resourceGroupName	path	True	string	Имя группы ресурсов. Регистр букв в имени не учитывается.
subscriptionId	path	True	string	Идентификатор целевой подписки.
api-version	query	True	string	Версия API, используемая для данной операции.
$filter	query		string	Фильтр, применяемый к операции.

Ответы

Имя	Тип	Описание
200 OK	PagedVirtualMachines	Запрос выполнен успешно; Ответ содержит все виртуальные машины для данной лаборатории.
Other Status Codes	ErrorResponse	Ответ об ошибке по умолчанию.

Примеры

listVirtualMachine

Sample Request

HTTP

GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.LabServices/labs/testlab/virtualMachines?api-version=2023-06-07

Sample Response

Status code:: 200

{
  "nextLink": null,
  "value": [
    {
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.LabServices/labs/testlab/virtualMachines/template",
      "name": "default",
      "type": "Microsoft.LabServices/VirtualMachine",
      "systemData": {
        "createdBy": "identity123",
        "createdByType": "User",
        "createdAt": "2020-05-01T10:00:00Z",
        "lastModifiedBy": "identity123",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2020-06-01T09:12:28Z"
      },
      "properties": {
        "provisioningState": "Succeeded",
        "state": "Running",
        "connectionProfile": {
          "privateIpAddress": "192.168.2.1",
          "sshAuthority": "vm-42.contoso.com:22",
          "sshInBrowserUrl": "vm-42.contoso.com",
          "rdpAuthority": "vm-42.contoso.com:3389",
          "rdpInBrowserUrl": "vm-42.contoso.com",
          "adminUsername": "user123"
        },
        "claimedByUserId": "testuser567",
        "vmType": "Template"
      }
    }
  ]
}

Определения

Имя	Описание
createdByType	Тип удостоверения, создавшего ресурс.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Сообщение об ошибке
PagedVirtualMachines	Страничный список виртуальных машин служб лаборатории.
ProvisioningState	Текущее состояние подготовки виртуальной машины.
ResourceOperationError	Сведения об ошибке последнего сбоя операции в этом ресурсе
systemData	Метаданные, относящиеся к созданию и последнему изменению ресурса.
VirtualMachine	Ресурс виртуальной машины лаборатории.
VirtualMachineConnectionProfile	Сведения о подключении для виртуальной машины
VirtualMachineState	Состояние виртуальной машины.
VirtualMachineType	Тип виртуальной машины лаборатории.

createdByType

Тип удостоверения, создавшего ресурс.

Имя	Тип	Описание
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Тип дополнительных сведений.

ErrorDetail

Сведения об ошибке.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Сообщение об ошибке

Имя	Тип	Описание
error	ErrorDetail	Объект error.

PagedVirtualMachines

Страничный список виртуальных машин служб лаборатории.

Имя	Тип	Описание
nextLink	string	Ссылка для получения следующей страницы результатов виртуальной машины.
value	VirtualMachine[]	Страница массива результатов виртуальной машины.

ProvisioningState

Текущее состояние подготовки виртуальной машины.

Имя	Тип	Описание
Creating	string	Ресурс находится в процессе создания.
Deleting	string	Ресурс находится в процессе удаления.
Failed	string	Предыдущая операция с ресурсом завершилась сбоем, оставив ресурс в неработоспособном состоянии.
Locked	string	Ресурс заблокирован, а изменения в настоящее время блокируются. Это может быть связано с обслуживанием или запланированной операцией. После завершения операции блокировки состояние вернется к успешному.
Succeeded	string	Ресурс находится в работоспособном состоянии после создания или обновления.
Updating	string	К ресурсу применяются новые значения свойств.

ResourceOperationError

Сведения об ошибке последнего сбоя операции в этом ресурсе

Имя	Тип	Описание
action	string	Действие операции, которое завершилось сбоем
code	string	Код, соответствующий типу сбоя операции
message	string	Сообщение об ошибке операции
timestamp	string	Дата и время возникновения ошибки

systemData

Метаданные, относящиеся к созданию и последнему изменению ресурса.

Имя	Тип	Описание
createdAt	string	Метка времени создания ресурса (UTC).
createdBy	string	Удостоверение, создающее ресурс.
createdByType	createdByType	Тип удостоверения, создавшего ресурс.
lastModifiedAt	string	Метка времени последнего изменения ресурса (UTC)
lastModifiedBy	string	Удостоверение, которое последним изменял ресурс.
lastModifiedByType	createdByType	Тип удостоверения, которое последним изменял ресурс.

VirtualMachine

Ресурс виртуальной машины лаборатории.

Имя	Тип	Описание
id	string	Полный идентификатор ресурса. Например: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Имя ресурса.
properties.claimedByUserId	string	Идентификатор пользователя лаборатории (а не PUID!) пользователя, который затребовал виртуальную машину.
properties.connectionProfile	VirtualMachineConnectionProfile	Профиль для получения сведений о подключении к виртуальной машине.
properties.provisioningState	ProvisioningState	Текущее состояние подготовки виртуальной машины.
properties.resourceOperationError	ResourceOperationError	Сведения об ошибке последней операции, выполненной в плане лаборатории.
properties.state	VirtualMachineState	Текущее состояние виртуальной машины
properties.vmType	VirtualMachineType	Тип ресурса виртуальной машины
systemData	systemData	Системные данные виртуальной машины лаборатории.
type	string	Тип ресурса. Например, Microsoft.Compute/virtualMachines или Microsoft.Storage/storageAccounts.

VirtualMachineConnectionProfile

Сведения о подключении для виртуальной машины

Имя	Тип	Описание
adminUsername	string	Имя пользователя, используемое для входа в виртуальную машину в качестве администратора.
nonAdminUsername	string	Имя пользователя, используемое для входа на виртуальную машину в качестве администратора, если оно существует.
privateIpAddress	string	Частный IP-адрес виртуальной машины.
rdpAuthority	string	Порт и имя узла, разделенные точкой с запятой для подключения к виртуальной машине по протоколу RDP.
rdpInBrowserUrl	string	URL-адрес для подключения по протоколу RDP к виртуальной машине в браузере.
sshAuthority	string	Порт и имя узла, разделенные точкой с запятой для подключения к виртуальной машине по протоколу SSH.
sshInBrowserUrl	string	URL-адрес для подключения по протоколу SSH к виртуальной машине в браузере.

VirtualMachineState

Состояние виртуальной машины.

Имя	Тип	Описание
Redeploying	string	Виртуальная машина повторно развертывается.
Reimaging	string	Виртуальная машина переосмыслена.
ResettingPassword	string	Пароль виртуальной машины сбрасывается.
Running	string	Виртуальная машина запущена.
Starting	string	Виртуальная машина запускается.
Stopped	string	Сейчас виртуальная машина остановлена.
Stopping	string	Виртуальная машина останавливается.

VirtualMachineType

Тип виртуальной машины лаборатории.

Имя	Тип	Описание
Template	string	Шаблон виртуальной машины
User	string	Пользовательская виртуальная машина