Virtual Machines - List By Lab

Ссылка

Служба:: Lab Services

Версия API:: 2023-06-07

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

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labs/{labName}/virtualMachines?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&$filter={$filter}

Параметры URI

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

Ответы

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

Примеры

listVirtualMachine

Образец запроса

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

Пример ответа

Код состояния:: 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
Key
ManagedIdentity
User

ErrorAdditionalInfo

Object

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

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

ErrorDetail

Object

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

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

ErrorResponse

Object

Ответ на ошибку

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

PagedVirtualMachines

Object

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

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

ProvisioningState

Перечисление

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

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

ResourceOperationError

Object

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

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

systemData

Object

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

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

VirtualMachine

Object

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

Имя	Тип	Описание
id	string	Полный идентификатор ресурса для ресурса. Ex - /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

Object

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

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

VirtualMachineState

Перечисление

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

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

VirtualMachineType

Перечисление

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

Значение	Описание
Template	Виртуальная машина шаблона
User	Виртуальная машина пользователя

Поделиться через

Virtual Machines - List By Lab

Параметры URI

Ответы

Примеры

listVirtualMachine

Образец запроса

Пример ответа

Определения

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

PagedVirtualMachines

ProvisioningState

ResourceOperationError

systemData

VirtualMachine

VirtualMachineConnectionProfile

VirtualMachineState

VirtualMachineType

Дополнительные ресурсы