Lab Plans - Create Or Update

Servicio:: Lab Services

Versión de la API:: 2023-06-07

Actualiza o crea un recurso de Plan de laboratorio.
Operación para crear o actualizar un recurso de Plan de laboratorio.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
labPlanName	path	True	string minLength: 1 maxLength: 100	Nombre del plan de laboratorio que lo identifica de forma única dentro del grupo de recursos contenedor. Se usa en los URI de recursos y en la interfaz de usuario.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.
subscriptionId	path	True	string minLength: 1	Identificador de la suscripción de destino.
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
location	True	string	Ubicación geográfica donde reside el recurso
identity		Identity	Información de identidad administrada
properties.allowedRegions		string[]	Las regiones permitidas para que el creador del laboratorio las use al crear laboratorios mediante este plan de laboratorio.
properties.defaultAutoShutdownProfile		AutoShutdownProfile	Perfil de apagado de laboratorio predeterminado. Esto se puede cambiar en un recurso de laboratorio y solo proporciona un perfil predeterminado.
properties.defaultConnectionProfile		ConnectionProfile	Perfil de conexión de laboratorio predeterminado. Esto se puede cambiar en un recurso de laboratorio y solo proporciona un perfil predeterminado.
properties.defaultNetworkProfile		LabPlanNetworkProfile	Perfil de red del plan de laboratorio. Para aplicar las directivas de red de laboratorio, deben definirse aquí y no se pueden cambiar cuando hay laboratorios existentes asociados a este plan de laboratorio.
properties.linkedLmsInstance		string minLength: 3 maxLength: 2000	La dirección URL base de la instancia lms en la que este plan de laboratorio puede vincular listas de laboratorio.
properties.sharedGalleryId		string minLength: 3 maxLength: 2000	Identificador de recurso de shared Image Gallery asociado a este plan de laboratorio. Al guardar una imagen de máquina virtual de plantilla de laboratorio, se conservará en esta galería. Las imágenes compartidas de la galería pueden estar disponibles para su uso al crear nuevos laboratorios.
properties.supportInfo		SupportInfo	Información de contacto de soporte técnico e instrucciones para los usuarios del plan de laboratorio. Esta información se muestra a los propietarios del laboratorio y a los usuarios de máquinas virtuales para todos los laboratorios del plan de laboratorio.
tags		object	Etiquetas de recursos.

Respuestas

Nombre	Tipo	Description
200 OK	LabPlan	La actualización se realizó correctamente; la respuesta contiene el plan de laboratorio.
201 Created	LabPlan	La creación se realizó correctamente; la respuesta contiene el plan de laboratorio.
202 Accepted	LabPlan	La actualización se realizó correctamente y tiene una operación de larga duración; la respuesta contiene el plan de laboratorio.
Other Status Codes	ErrorResponse	Respuesta de error predeterminada.

Ejemplos

putLabPlan

Solicitud de ejemplo

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

Respuesta de muestra

status code:: 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."
    }
  }
}

status code:: 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."
    }
  }
}

status code:: 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."
    }
  }
}

Definiciones

Nombre	Description
AutoShutdownProfile	Perfil de cómo controlar el apagado de máquinas virtuales.
ConnectionProfile	Perfil de conexión para cómo se conectan los usuarios a máquinas virtuales de laboratorio.
ConnectionType	Nivel de acceso habilitado para El acceso web a través de SSH.
createdByType	Tipo de identidad que creó el recurso.
EnableState	Indica si el apagado en la desconexión está habilitado
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
Identity	Identidad del recurso.
LabPlan	Los planes de laboratorio actúan como un contenedor de permisos para crear laboratorios a través de labs.azure.com. Además, pueden proporcionar un conjunto de configuraciones predeterminadas que se aplicarán en el momento de crear un laboratorio, pero estos valores predeterminados se pueden sobrescribir.
LabPlanNetworkProfile	Perfil para controlar las redes de los planes de laboratorio.
ProvisioningState	Estado de aprovisionamiento actual del plan de laboratorio.
ResourceIdentityType	Tipo de identidad.
ResourceOperationError	Detalles del error de la operación más reciente en este recurso
shutdownOnIdleMode	Define si se va a apagar la máquina virtual en modo inactivo y los criterios para la detección de inactividad.
SupportInfo	Información de contacto de soporte técnico e instrucciones.
systemData	Metadatos relativos a la creación y última modificación del recurso.

AutoShutdownProfile

Object

Perfil de cómo controlar el apagado de máquinas virtuales.

Nombre	Tipo	Valor predeterminado	Description
disconnectDelay	string (duration)		La cantidad de tiempo que una máquina virtual permanecerá ejecutándose después de que un usuario se desconecte si este comportamiento está habilitado.
idleDelay	string (duration)		La cantidad de tiempo que una máquina virtual estará inactiva antes de que se apague si este comportamiento está habilitado.
noConnectDelay	string (duration)		La cantidad de tiempo que una máquina virtual permanecerá ejecutándose antes de que se cierre si no se realiza ninguna conexión y este comportamiento está habilitado.
shutdownOnDisconnect	EnableState	Disabled	Indica si el apagado en la desconexión está habilitado
shutdownOnIdle	shutdownOnIdleMode	None	Si una máquina virtual se apagará cuando se haya inactivo durante un período de tiempo.
shutdownWhenNotConnected	EnableState	Disabled	Si una máquina virtual se apagará cuando no se haya conectado después de un período de tiempo.

ConnectionProfile

Object

Perfil de conexión para cómo se conectan los usuarios a máquinas virtuales de laboratorio.

Nombre	Tipo	Valor predeterminado	Description
clientRdpAccess	ConnectionType	None	Nivel de acceso habilitado para el acceso de cliente a través de RDP.
clientSshAccess	ConnectionType	None	Nivel de acceso habilitado para el acceso de cliente a través de SSH.
webRdpAccess	ConnectionType	None	Nivel de acceso habilitado para Acceso web a través de RDP.
webSshAccess	ConnectionType	None	Nivel de acceso habilitado para El acceso web a través de SSH.

ConnectionType

Enumeración

Nivel de acceso habilitado para El acceso web a través de SSH.

Valor	Description
Public
Private
None

createdByType

Enumeración

Tipo de identidad que creó el recurso.

Valor	Description
User
Application
ManagedIdentity
Key

EnableState

Enumeración

Indica si el apagado en la desconexión está habilitado

Valor	Description
Enabled
Disabled

ErrorAdditionalInfo

Object

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Object

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	Mensaje de error.
target	string	Destino del error.

ErrorResponse

Object

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

Identity

Object

Identidad del recurso.

Nombre	Tipo	Description
principalId	string	Identificador de entidad de seguridad de la identidad del recurso.
tenantId	string	Identificador de inquilino del recurso.
type	ResourceIdentityType	Tipo de identidad.

LabPlan

Object

Los planes de laboratorio actúan como un contenedor de permisos para crear laboratorios a través de labs.azure.com. Además, pueden proporcionar un conjunto de configuraciones predeterminadas que se aplicarán en el momento de crear un laboratorio, pero estos valores predeterminados se pueden sobrescribir.

Nombre	Tipo	Description
id	string	Identificador de recurso completo para el recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	Identity	Información de identidad administrada
location	string	Ubicación geográfica donde reside el recurso
name	string	Nombre del recurso
properties.allowedRegions	string[]	Las regiones permitidas para que el creador del laboratorio las use al crear laboratorios mediante este plan de laboratorio.
properties.defaultAutoShutdownProfile	AutoShutdownProfile	Perfil de apagado de laboratorio predeterminado. Esto se puede cambiar en un recurso de laboratorio y solo proporciona un perfil predeterminado.
properties.defaultConnectionProfile	ConnectionProfile	Perfil de conexión de laboratorio predeterminado. Esto se puede cambiar en un recurso de laboratorio y solo proporciona un perfil predeterminado.
properties.defaultNetworkProfile	LabPlanNetworkProfile	Perfil de red del plan de laboratorio. Para aplicar las directivas de red de laboratorio, deben definirse aquí y no se pueden cambiar cuando hay laboratorios existentes asociados a este plan de laboratorio.
properties.linkedLmsInstance	string minLength: 3 maxLength: 2000	La dirección URL base de la instancia lms en la que este plan de laboratorio puede vincular listas de laboratorio.
properties.provisioningState	ProvisioningState	Estado de aprovisionamiento actual del plan de laboratorio.
properties.resourceOperationError	ResourceOperationError	Detalles del error de la última operación realizada en el plan de laboratorio.
properties.sharedGalleryId	string minLength: 3 maxLength: 2000	Identificador de recurso de shared Image Gallery asociado a este plan de laboratorio. Al guardar una imagen de máquina virtual de plantilla de laboratorio, se conservará en esta galería. Las imágenes compartidas de la galería pueden estar disponibles para su uso al crear nuevos laboratorios.
properties.supportInfo	SupportInfo	Información de contacto de soporte técnico e instrucciones para los usuarios del plan de laboratorio. Esta información se muestra a los propietarios del laboratorio y a los usuarios de máquinas virtuales para todos los laboratorios del plan de laboratorio.
systemData	systemData	Metadatos relacionados con la creación y última modificación del plan de laboratorio.
tags	object	Etiquetas de recursos.
type	string	Tipo del recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

LabPlanNetworkProfile

Object

Perfil para controlar las redes de los planes de laboratorio.

Nombre	Tipo	Description
subnetId	string minLength: 3 maxLength: 2000	Identificador de recurso de subred externo

ProvisioningState

Enumeración

Estado de aprovisionamiento actual del plan de laboratorio.

Valor	Description
Creating	El recurso está en proceso de creación.
Updating	Los nuevos valores de propiedad se aplican al recurso.
Deleting	El recurso está en proceso de eliminación.
Succeeded	El recurso está en buen estado después de la creación o la operación de actualización.
Failed	La operación anterior en el recurso no ha podido dejar el recurso en estado incorrecto.
Locked	El recurso está bloqueado y los cambios están bloqueados actualmente. Esto podría deberse al mantenimiento o a una operación programada. El estado volverá a realizarse correctamente una vez finalizada la operación de bloqueo.

ResourceIdentityType

Enumeración

Tipo de identidad.

Valor	Description
SystemAssigned

ResourceOperationError

Object

Detalles del error de la operación más reciente en este recurso

Nombre	Tipo	Description
action	string	Acción de operación que produjo un error
code	string	Código que corresponde al tipo de error de operación.
message	string	Mensaje de error de la operación
timestamp	string (date-time)	Fecha y hora de cuándo se produjo el error

shutdownOnIdleMode

Enumeración

Define si se va a apagar la máquina virtual en modo inactivo y los criterios para la detección de inactividad.

Valor	Description
None	La máquina virtual no se apagará cuando esté inactiva.
UserAbsence	La máquina virtual se considerará inactiva cuando no haya ninguna entrada de teclado o mouse.
LowUsage	La máquina virtual se considerará inactiva cuando el usuario esté ausente y el consumo de recursos (CPU y disco) sea bajo.

SupportInfo

Object

Información de contacto de soporte técnico e instrucciones.

Nombre	Tipo	Description
email	string minLength: 6 maxLength: 254	Dirección de correo electrónico de contacto de soporte técnico.
instructions	string	Instrucciones de soporte técnico.
phone	string minLength: 1 maxLength: 31	Número de teléfono de contacto de soporte técnico.
url	string minLength: 3 maxLength: 2000	Dirección web de soporte técnico.

systemData

Object

Metadatos relativos a la creación y última modificación del recurso.

Nombre	Tipo	Description
createdAt	string (date-time)	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string (date-time)	Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.

Compartir a través de

Lab Plans - Create Or Update

Parámetros de identificador URI

Cuerpo de la solicitud

Respuestas

Ejemplos

putLabPlan

Solicitud de ejemplo

Respuesta de muestra

Definiciones

AutoShutdownProfile

ConnectionProfile

ConnectionType

createdByType

EnableState

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

Identity

LabPlan

LabPlanNetworkProfile

ProvisioningState

ResourceIdentityType

ResourceOperationError

shutdownOnIdleMode

SupportInfo

systemData