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


Lab Plans - Create Or Update

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

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

Параметры URI

Имя В Обязательно Тип Описание
labPlanName
path True

string

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

resourceGroupName
path True

string

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

subscriptionId
path True

string

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

api-version
query True

string

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

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

Имя Обязательно Тип Описание
location True

string

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

identity

Identity

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

properties.allowedRegions

string[]

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

properties.defaultAutoShutdownProfile

AutoShutdownProfile

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

properties.defaultConnectionProfile

ConnectionProfile

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

properties.defaultNetworkProfile

LabPlanNetworkProfile

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

properties.linkedLmsInstance

string

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

properties.sharedGalleryId

string

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

properties.supportInfo

SupportInfo

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

tags

object

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

Ответы

Имя Тип Описание
200 OK

LabPlan

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

201 Created

LabPlan

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

202 Accepted

LabPlan

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

Other Status Codes

ErrorResponse

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

Примеры

putLabPlan

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

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

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

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

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

ResourceOperationError

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

shutdownOnIdleMode

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

SupportInfo

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

systemData

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

AutoShutdownProfile

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

Имя Тип Default value Описание
disconnectDelay

string

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

idleDelay

string

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

noConnectDelay

string

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

shutdownOnDisconnect

EnableState

Disabled

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

shutdownOnIdle

shutdownOnIdleMode

None

Будет ли виртуальная машина завершена при простое в течение определенного периода времени.

shutdownWhenNotConnected

EnableState

Disabled

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

ConnectionProfile

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

Имя Тип Default value Описание
clientRdpAccess

ConnectionType

None

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

clientSshAccess

ConnectionType

None

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

webRdpAccess

ConnectionType

None

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

webSshAccess

ConnectionType

None

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

ConnectionType

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

Имя Тип Описание
None

string

Private

string

Public

string

createdByType

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

Имя Тип Описание
Application

string

Key

string

ManagedIdentity

string

User

string

EnableState

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

Имя Тип Описание
Disabled

string

Enabled

string

ErrorAdditionalInfo

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

Имя Тип Описание
info

object

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

type

string

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

ErrorDetail

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

Имя Тип Описание
additionalInfo

ErrorAdditionalInfo[]

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

code

string

Код ошибки.

details

ErrorDetail[]

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

message

string

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

target

string

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

ErrorResponse

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

Имя Тип Описание
error

ErrorDetail

Объект error.

Identity

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

Имя Тип Описание
principalId

string

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

tenantId

string

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

type

ResourceIdentityType

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

LabPlan

Планы лабораторий выступают в качестве контейнера разрешений для создания лабораторий с помощью 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

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

properties.provisioningState

ProvisioningState

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

properties.resourceOperationError

ResourceOperationError

Сведения об ошибке последней операции, выполненной в плане лаборатории.

properties.sharedGalleryId

string

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

properties.supportInfo

SupportInfo

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

systemData

systemData

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

tags

object

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

type

string

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

LabPlanNetworkProfile

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

Имя Тип Описание
subnetId

string

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

ProvisioningState

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

Имя Тип Описание
Creating

string

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

Deleting

string

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

Failed

string

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

Locked

string

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

Succeeded

string

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

Updating

string

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

ResourceIdentityType

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

Имя Тип Описание
SystemAssigned

string

ResourceOperationError

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

Имя Тип Описание
action

string

Действие операции, которое завершилось сбоем

code

string

Код, соответствующий типу сбоя операции

message

string

Сообщение об ошибке операции

timestamp

string

Дата и время возникновения ошибки

shutdownOnIdleMode

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

Имя Тип Описание
LowUsage

string

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

None

string

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

UserAbsence

string

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

SupportInfo

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

Имя Тип Описание
email

string

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

instructions

string

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

phone

string

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

url

string

Веб-адрес поддержки.

systemData

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

Имя Тип Описание
createdAt

string

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

createdBy

string

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

createdByType

createdByType

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

lastModifiedAt

string

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

lastModifiedBy

string

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

lastModifiedByType

createdByType

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