Lab Plans - Create Or Update

Служба:: Lab Services

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

Обновляет или создает ресурс плана лаборатории.
Операция создания или обновления ресурса плана лаборатории.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labPlans/{labPlanName}?api-version=2023-06-07

Параметры URI

Имя	В	Обязательно	Тип	Описание
labPlanName	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, используемая для этой операции.

Текст запроса

Имя	Обязательно	Тип	Описание
location	True	string	Географическое расположение, в котором находится ресурс
identity		Identity	Сведения об управляемом удостоверении
properties.allowedRegions		string[]	Допустимые регионы для создателя лаборатории, которые будут использоваться при создании лабораторий с помощью этого плана лаборатории.
properties.defaultAutoShutdownProfile		AutoShutdownProfile	Профиль завершения работы лаборатории по умолчанию. Это можно изменить в ресурсе лаборатории и предоставляет только профиль по умолчанию.
properties.defaultConnectionProfile		ConnectionProfile	Профиль подключения лаборатории по умолчанию. Это можно изменить в ресурсе лаборатории и предоставляет только профиль по умолчанию.
properties.defaultNetworkProfile		LabPlanNetworkProfile	Профиль сети плана лаборатории. Чтобы применить политики сети лаборатории, они должны быть определены здесь и не могут быть изменены при наличии существующих лабораторий, связанных с этим планом лаборатории.
properties.linkedLmsInstance		string minLength: 3 maxLength: 2000	Базовый URL-адрес экземпляра lms, с помощью этого плана лаборатории можно связать список лабораторий.
properties.sharedGalleryId		string minLength: 3 maxLength: 2000	Идентификатор ресурса общей коллекции образов, присоединенной к этому плану лаборатории. При сохранении образа виртуальной машины шаблона лаборатории он будет сохранен в этой коллекции. Общие образы из коллекции можно сделать доступными для использования при создании новых лабораторий.
properties.supportInfo		SupportInfo	Поддержка контактных данных и инструкций для пользователей плана лаборатории. Эти сведения отображаются владельцам лабораторий и пользователям виртуальных машин для всех лабораторий в плане лаборатории.
tags		object	Теги ресурсов.

Ответы

Имя	Тип	Описание
200 OK	LabPlan	Обновление выполнено успешно; ответ содержит план лаборатории.
201 Created	LabPlan	Создание выполнено успешно; ответ содержит план лаборатории.
202 Accepted	LabPlan	Обновление успешно выполнено и имеет длительную операцию; ответ содержит план лаборатории.
Other Status Codes	ErrorResponse	Ответ об ошибке по умолчанию.

Примеры

putLabPlan

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

HTTP

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

{
  "location": "westus",
  "properties": {
    "defaultConnectionProfile": {
      "webSshAccess": "None",
      "webRdpAccess": "None",
      "clientSshAccess": "Public",
      "clientRdpAccess": "Public"
    },
    "defaultAutoShutdownProfile": {
      "shutdownOnDisconnect": "Enabled",
      "shutdownWhenNotConnected": "Enabled",
      "shutdownOnIdle": "UserAbsence",
      "disconnectDelay": "PT5M",
      "noConnectDelay": "PT5M",
      "idleDelay": "PT5M"
    },
    "defaultNetworkProfile": {
      "subnetId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/default"
    },
    "sharedGalleryId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Compute/galleries/testsig",
    "supportInfo": {
      "url": "help.contoso.com",
      "email": "help@contoso.com",
      "phone": "+1-202-555-0123",
      "instructions": "Contact support for help."
    }
  }
}

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

Код состояния:: 200

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.LabServices/labPlans/testlabplan",
  "name": "testlabplan",
  "type": "Microsoft.LabServices/LabPlan",
  "location": "westus",
  "systemData": {
    "createdBy": "identity123",
    "createdByType": "User",
    "createdAt": "2020-05-01T10:00:00Z",
    "lastModifiedBy": "identity123",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-06-01T09:12:28Z"
  },
  "properties": {
    "provisioningState": "Succeeded",
    "defaultConnectionProfile": {
      "webSshAccess": "None",
      "webRdpAccess": "None",
      "clientSshAccess": "Public",
      "clientRdpAccess": "Public"
    },
    "defaultAutoShutdownProfile": {
      "shutdownOnDisconnect": "Enabled",
      "shutdownWhenNotConnected": "Enabled",
      "shutdownOnIdle": "UserAbsence",
      "disconnectDelay": "PT5M",
      "noConnectDelay": "PT5M",
      "idleDelay": "PT5M"
    },
    "defaultNetworkProfile": {
      "subnetId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/default"
    },
    "sharedGalleryId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Compute/galleries/testsig",
    "supportInfo": {
      "url": "help.contoso.com",
      "email": "help@contoso.com",
      "phone": "+1-202-555-0123",
      "instructions": "Contact support for help."
    }
  }
}

Код состояния:: 201

Location: https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.LabServices/operationresults/a64149d8-84cb-4566-ab8e-b4ee1a074174

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.LabServices/labPlans/testlabplan",
  "name": "testlabplan",
  "type": "Microsoft.LabServices/LabPlan",
  "location": "westus",
  "systemData": {
    "createdBy": "identity123",
    "createdByType": "User",
    "createdAt": "2020-05-01T10:00:00Z",
    "lastModifiedBy": "identity123",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-06-01T09:12:28Z"
  },
  "properties": {
    "provisioningState": "Creating",
    "defaultConnectionProfile": {
      "webSshAccess": "None",
      "webRdpAccess": "None",
      "clientSshAccess": "Public",
      "clientRdpAccess": "Public"
    },
    "defaultAutoShutdownProfile": {
      "shutdownOnDisconnect": "Enabled",
      "shutdownWhenNotConnected": "Enabled",
      "shutdownOnIdle": "UserAbsence",
      "disconnectDelay": "PT5M",
      "noConnectDelay": "PT5M",
      "idleDelay": "PT5M"
    },
    "defaultNetworkProfile": {
      "subnetId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/default"
    },
    "sharedGalleryId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Compute/galleries/testsig",
    "supportInfo": {
      "url": "help.contoso.com",
      "email": "help@contoso.com",
      "phone": "+1-202-555-0123",
      "instructions": "Contact support for help."
    }
  }
}

Код состояния:: 202

Location: https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.LabServices/operationresults/a64149d8-84cb-4566-ab8e-b4ee1a074174

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.LabServices/labPlans/testlabplan",
  "name": "testlabplan",
  "type": "Microsoft.LabServices/LabPlan",
  "location": "westus",
  "systemData": {
    "createdBy": "identity123",
    "createdByType": "User",
    "createdAt": "2020-05-01T10:00:00Z",
    "lastModifiedBy": "identity123",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-06-01T09:12:28Z"
  },
  "properties": {
    "provisioningState": "Updating",
    "defaultConnectionProfile": {
      "webSshAccess": "None",
      "webRdpAccess": "None",
      "clientSshAccess": "Public",
      "clientRdpAccess": "Public"
    },
    "defaultAutoShutdownProfile": {
      "shutdownOnDisconnect": "Enabled",
      "shutdownWhenNotConnected": "Enabled",
      "shutdownOnIdle": "UserAbsence",
      "disconnectDelay": "PT5M",
      "noConnectDelay": "PT5M",
      "idleDelay": "PT5M"
    },
    "defaultNetworkProfile": {
      "subnetId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/default"
    },
    "sharedGalleryId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Compute/galleries/testsig",
    "supportInfo": {
      "url": "help.contoso.com",
      "email": "help@contoso.com",
      "phone": "+1-202-555-0123",
      "instructions": "Contact support for help."
    }
  }
}

Определения

Имя	Описание
AutoShutdownProfile	Профиль обработки завершения работы виртуальных машин.
ConnectionProfile	Профиль подключения для подключения пользователей к виртуальным машинам лаборатории.
ConnectionType	Уровень доступа с поддержкой веб-доступа по протоколу SSH.
createdByType	Тип удостоверения, создавшего ресурс.
EnableState	Включена ли завершение работы при отключении
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ на ошибку
Identity	Удостоверение ресурса.
LabPlan	Планы лабораторий служат контейнером разрешений для создания лабораторий с помощью labs.azure.com. Кроме того, они могут предоставить набор конфигураций по умолчанию, которые будут применяться во время создания лаборатории, но эти значения по умолчанию по-прежнему могут быть перезаписаны.
LabPlanNetworkProfile	Профилирование обработки сетей для планов лабораторий.
ProvisioningState	Текущее состояние подготовки плана лаборатории.
ResourceIdentityType	Тип удостоверения.
ResourceOperationError	Сведения об ошибке последней операции в этом ресурсе
shutdownOnIdleMode	Определяет, следует ли завершить работу виртуальной машины при простое и критерии для обнаружения бездействия.
SupportInfo	Поддержка контактных данных и инструкций.
systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.

AutoShutdownProfile

Object

Профиль обработки завершения работы виртуальных машин.

Имя	Тип	Default value	Описание
disconnectDelay	string (duration)		Время, когда виртуальная машина будет работать после отключения пользователя, если это поведение включено.
idleDelay	string (duration)		Время простоя виртуальной машины перед завершением работы, если это поведение включено.
noConnectDelay	string (duration)		Время, когда виртуальная машина будет работать до завершения работы, если подключение не выполнено, и это поведение включено.
shutdownOnDisconnect	EnableState	Disabled	Включена ли завершение работы при отключении
shutdownOnIdle	shutdownOnIdleMode	None	Будет ли виртуальная машина завершать работу, когда она неактивна в течение определенного периода времени.
shutdownWhenNotConnected	EnableState	Disabled	Будет ли виртуальная машина завершаться, когда она не была подключена через период времени.

ConnectionProfile

Object

Профиль подключения для подключения пользователей к виртуальным машинам лаборатории.

Имя	Тип	Default value	Описание
clientRdpAccess	ConnectionType	None	Уровень доступа включен для клиентского доступа через RDP.
clientSshAccess	ConnectionType	None	Уровень доступа включен для клиентского доступа по протоколу SSH.
webRdpAccess	ConnectionType	None	Уровень доступа с поддержкой веб-доступа через RDP.
webSshAccess	ConnectionType	None	Уровень доступа с поддержкой веб-доступа по протоколу SSH.

ConnectionType

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

Уровень доступа с поддержкой веб-доступа по протоколу SSH.

Значение	Описание
Public
Private
None

createdByType

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

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

Значение	Описание
User
Application
ManagedIdentity
Key

EnableState

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

Включена ли завершение работы при отключении

Значение	Описание
Enabled
Disabled

ErrorAdditionalInfo

Object

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

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

ErrorDetail

Object

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

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

ErrorResponse

Object

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

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

Identity

Object

Удостоверение ресурса.

Имя	Тип	Описание
principalId	string	Идентификатор субъекта удостоверения ресурса.
tenantId	string	Идентификатор клиента ресурса.
type	ResourceIdentityType	Тип удостоверения.

LabPlan

Object

Планы лабораторий служат контейнером разрешений для создания лабораторий с помощью labs.azure.com. Кроме того, они могут предоставить набор конфигураций по умолчанию, которые будут применяться во время создания лаборатории, но эти значения по умолчанию по-прежнему могут быть перезаписаны.

Имя	Тип	Описание
id	string	Полный идентификатор ресурса для ресурса. Пример - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	Identity	Сведения об управляемом удостоверении
location	string	Географическое расположение, в котором находится ресурс
name	string	Имя ресурса
properties.allowedRegions	string[]	Допустимые регионы для создателя лаборатории, которые будут использоваться при создании лабораторий с помощью этого плана лаборатории.
properties.defaultAutoShutdownProfile	AutoShutdownProfile	Профиль завершения работы лаборатории по умолчанию. Это можно изменить в ресурсе лаборатории и предоставляет только профиль по умолчанию.
properties.defaultConnectionProfile	ConnectionProfile	Профиль подключения лаборатории по умолчанию. Это можно изменить в ресурсе лаборатории и предоставляет только профиль по умолчанию.
properties.defaultNetworkProfile	LabPlanNetworkProfile	Профиль сети плана лаборатории. Чтобы применить политики сети лаборатории, они должны быть определены здесь и не могут быть изменены при наличии существующих лабораторий, связанных с этим планом лаборатории.
properties.linkedLmsInstance	string minLength: 3 maxLength: 2000	Базовый URL-адрес экземпляра lms, с помощью этого плана лаборатории можно связать список лабораторий.
properties.provisioningState	ProvisioningState	Текущее состояние подготовки плана лаборатории.
properties.resourceOperationError	ResourceOperationError	Сведения об ошибке последней операции, выполняемой в плане лаборатории.
properties.sharedGalleryId	string minLength: 3 maxLength: 2000	Идентификатор ресурса общей коллекции образов, присоединенной к этому плану лаборатории. При сохранении образа виртуальной машины шаблона лаборатории он будет сохранен в этой коллекции. Общие образы из коллекции можно сделать доступными для использования при создании новых лабораторий.
properties.supportInfo	SupportInfo	Поддержка контактных данных и инструкций для пользователей плана лаборатории. Эти сведения отображаются владельцам лабораторий и пользователям виртуальных машин для всех лабораторий в плане лаборатории.
systemData	systemData	Метаданные, относящиеся к созданию и последнему изменении плана лаборатории.
tags	object	Теги ресурсов.
type	string	Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

LabPlanNetworkProfile

Object

Профилирование обработки сетей для планов лабораторий.

Имя	Тип	Описание
subnetId	string minLength: 3 maxLength: 2000	Идентификатор ресурса внешней подсети

ProvisioningState

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

Текущее состояние подготовки плана лаборатории.

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

ResourceIdentityType

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

Тип удостоверения.

Значение	Описание
SystemAssigned

ResourceOperationError

Object

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

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

shutdownOnIdleMode

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

Определяет, следует ли завершить работу виртуальной машины при простое и критерии для обнаружения бездействия.

Значение	Описание
None	Виртуальная машина не будет выключена, когда она неактивна.
UserAbsence	Виртуальная машина будет считаться неактивной, если ввод клавиатуры или мыши отсутствует.
LowUsage	Виртуальная машина будет считаться неактивной, если пользователь отсутствует, а потребление ресурсов (ЦП и диска) низкое.

SupportInfo

Object

Поддержка контактных данных и инструкций.

Имя	Тип	Описание
email	string minLength: 6 maxLength: 254	Адрес электронной почты в службу поддержки.
instructions	string	Инструкции по поддержке.
phone	string minLength: 1 maxLength: 31	Контактный номер телефона службы поддержки.
url	string minLength: 3 maxLength: 2000	Поддержка веб-адреса.

systemData

Object

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

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

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

Lab Plans - Create Or Update

Параметры URI

Текст запроса

Ответы

Примеры

putLabPlan

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

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

Определения

AutoShutdownProfile

ConnectionProfile

ConnectionType

createdByType

EnableState

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

Identity

LabPlan

LabPlanNetworkProfile

ProvisioningState

ResourceIdentityType

ResourceOperationError

shutdownOnIdleMode

SupportInfo

systemData