Lab Plans - Create Or Update

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

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

Параметры URI

Name In Required Type Description
labPlanName
path True
  • string

Имя плана лаборатории, который однозначно идентифицирует его в содержащей группе ресурсов. Используется в URI ресурсов и в пользовательском интерфейсе.

resourceGroupName
path True
  • string

Имя группы ресурсов. Регистр букв в имени не учитывается.

subscriptionId
path True
  • string

Идентификатор целевой подписки.

api-version
query True
  • string

Версия API, используемая для данной операции.

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

Name Required Type Description
location True
  • string

Географическое расположение, в котором находится ресурс.

identity

Сведения об управляемом удостоверении

properties.allowedRegions
  • string[]

Разрешенные регионы для создателя лаборатории, которые будут использоваться при создании лабораторий с помощью этого плана лаборатории.

properties.defaultAutoShutdownProfile

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

properties.defaultConnectionProfile

Профиль подключения лаборатории по умолчанию. Это можно изменить в ресурсе лаборатории и предоставляет только профиль по умолчанию.

properties.defaultNetworkProfile

Сетевой профиль плана лаборатории. Чтобы применить политики сети лаборатории, они должны быть определены здесь и не могут быть изменены при наличии существующих лабораторий, связанных с этим планом лаборатории.

properties.linkedLmsInstance
  • string

Базовый URL-адрес экземпляра lms, с помощью этого плана лаборатории можно связать списки лабораторий.

properties.sharedGalleryId
  • string

Идентификатор ресурса Galeria de Imagens Compartilhadas, присоединенного к этому плану лаборатории. При сохранении образа виртуальной машины шаблона лаборатории он будет сохранен в этой коллекции. Общие образы из коллекции можно сделать доступными для использования при создании новых лабораторий.

properties.supportInfo

Поддержка контактных данных и инструкций для пользователей плана лаборатории. Эти сведения отображаются владельцам лабораторий и пользователям виртуальных машин для всех лабораторий в плане лаборатории.

tags
  • object

Теги ресурсов.

Ответы

Name Type Description
200 OK

Обновление выполнено успешно; ответ содержит план лаборатории.

201 Created

Создание выполнено успешно; ответ содержит план лаборатории.

202 Accepted

Обновление прошло успешно и имеет длительную операцию; ответ содержит план лаборатории.

Other Status Codes

Ответ об ошибке по умолчанию.

Примеры

putLabPlan

Sample Request

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

{
  "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."
    }
  }
}

Sample Response

{
  "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."
    }
  }
}
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."
    }
  }
}
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

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

shutdownOnIdleMode

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

SupportInfo

Контактные данные и инструкции службы поддержки.

systemData

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

AutoShutdownProfile

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

Name Type Default Value Description
disconnectDelay
  • string

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

idleDelay
  • string

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

noConnectDelay
  • string

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

shutdownOnDisconnect Disabled

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

shutdownOnIdle None

Указывает, будет ли виртуальная машина завершать работу, когда она простаивала в течение определенного периода времени.

shutdownWhenNotConnected Disabled

Указывает, будет ли виртуальная машина завершать работу, когда она не была подключена через период времени.

ConnectionProfile

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

Name Type Default Value Description
clientRdpAccess None

Включенный уровень доступа для клиентского доступа по протоколу RDP.

clientSshAccess None

Включенный уровень доступа для клиентского доступа по протоколу SSH.

webRdpAccess None

Включенный уровень доступа для веб-доступа по протоколу RDP.

webSshAccess None

Включенный уровень доступа для веб-доступа по протоколу SSH.

ConnectionType

Включенный уровень доступа для веб-доступа по протоколу SSH.

Name Type Description
None
  • string
Private
  • string
Public
  • string

createdByType

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

Name Type Description
Application
  • string
Key
  • string
ManagedIdentity
  • string
User
  • string

EnableState

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

Name Type Description
Disabled
  • string
Enabled
  • string

ErrorAdditionalInfo

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

Name Type Description
info
  • object

Дополнительные сведения.

type
  • string

Дополнительный тип сведений.

ErrorDetail

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

Name Type Description
additionalInfo

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

code
  • string

Код ошибки.

details

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

message
  • string

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

target
  • string

Целевой объект ошибки.

ErrorResponse

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

Name Type Description
error

Объект ошибки.

Identity

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

Name Type Description
principalId
  • string

Идентификатор субъекта удостоверения ресурса.

tenantId
  • string

Идентификатор клиента ресурса.

type

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

LabPlan

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

Name Type Description
id
  • string

Полный идентификатор ресурса. Например, /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

identity

Сведения об управляемом удостоверении

location
  • string

Географическое расположение, в котором находится ресурс.

name
  • string

Имя ресурса.

properties.allowedRegions
  • string[]

Разрешенные регионы для создателя лаборатории, которые будут использоваться при создании лабораторий с помощью этого плана лаборатории.

properties.defaultAutoShutdownProfile

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

properties.defaultConnectionProfile

Профиль подключения лаборатории по умолчанию. Это можно изменить в ресурсе лаборатории и предоставляет только профиль по умолчанию.

properties.defaultNetworkProfile

Сетевой профиль плана лаборатории. Чтобы применить политики сети лаборатории, они должны быть определены здесь и не могут быть изменены при наличии существующих лабораторий, связанных с этим планом лаборатории.

properties.linkedLmsInstance
  • string

Базовый URL-адрес экземпляра lms, с помощью этого плана лаборатории можно связать списки лабораторий.

properties.provisioningState

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

properties.sharedGalleryId
  • string

Идентификатор ресурса Galeria de Imagens Compartilhadas, присоединенного к этому плану лаборатории. При сохранении образа виртуальной машины шаблона лаборатории он будет сохранен в этой коллекции. Общие образы из коллекции можно сделать доступными для использования при создании новых лабораторий.

properties.supportInfo

Поддержка контактных данных и инструкций для пользователей плана лаборатории. Эти сведения отображаются владельцам лабораторий и пользователям виртуальных машин для всех лабораторий в плане лаборатории.

systemData

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

tags
  • object

Теги ресурсов.

type
  • string

Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

LabPlanNetworkProfile

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

Name Type Description
subnetId
  • string

Идентификатор ресурса внешней подсети

ProvisioningState

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

Name Type Description
Creating
  • string

Ресурс находится в процессе создания.

Deleting
  • string

Ресурс находится в процессе удаления.

Failed
  • string

Предыдущая операция с ресурсом завершилась сбоем, оставив ресурс в неработоспособном состоянии.

Locked
  • string

Ресурс заблокирован и изменения в настоящее время блокируются. Это может быть связано с обслуживанием или запланированной операцией. Состояние вернется к успешному выполнению после завершения операции блокировки.

Succeeded
  • string

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

Updating
  • string

К ресурсу применяются новые значения свойств.

ResourceIdentityType

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

Name Type Description
SystemAssigned
  • string

shutdownOnIdleMode

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

Name Type Description
LowUsage
  • string

Виртуальная машина будет считаться неактивной, если пользователь отсутствует, а потребление ресурсов (ЦП и диска) низкое.

None
  • string

Виртуальная машина не будет выключена, когда она простаит.

UserAbsence
  • string

Виртуальная машина будет считаться неактивной, если нет ввода с клавиатуры или мыши.

SupportInfo

Контактные данные и инструкции службы поддержки.

Name Type Description
email
  • string

Адрес электронной почты контакта в службу поддержки.

instructions
  • string

Инструкции по поддержке.

phone
  • string

Контактный номер телефона службы поддержки.

url
  • string

Поддержка веб-адреса.

systemData

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

Name Type Description
createdAt
  • string

Метка времени создания ресурса (UTC).

createdBy
  • string

Удостоверение, создающее ресурс.

createdByType

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

lastModifiedAt
  • string

Метка времени последнего изменения ресурса (UTC)

lastModifiedBy
  • string

Удостоверение, которое последнее изменение ресурса.

lastModifiedByType

Тип удостоверения, который последний раз изменил ресурс.