Lab Plans - Create Or Update

Serviço:: Lab Services

Versão da API:: 2023-06-07

Atualiza ou cria um recurso de Plano de laboratório.
Operação para criar ou atualizar um recurso de Plano de laboratório.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
labPlanName	path	True	string minLength: 1 maxLength: 100	O nome do plano de laboratório que o identifica exclusivamente dentro do grupo de recursos de contenção. Usado em URIs de recursos e na interface do usuário.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string minLength: 1	A ID da assinatura de destino.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Corpo do Pedido

Name	Necessário	Tipo	Description
location	True	string	A geolocalização onde o recurso vive
identity		Identity	Informações de identidade gerenciadas
properties.allowedRegions		string[]	As regiões permitidas para o criador do laboratório usar ao criar laboratórios usando este plano de laboratório.
properties.defaultAutoShutdownProfile		AutoShutdownProfile	O perfil de desligamento de laboratório padrão. Isso pode ser alterado em um recurso de laboratório e fornece apenas um perfil padrão.
properties.defaultConnectionProfile		ConnectionProfile	O perfil de conexão de laboratório padrão. Isso pode ser alterado em um recurso de laboratório e fornece apenas um perfil padrão.
properties.defaultNetworkProfile		LabPlanNetworkProfile	O perfil de rede do plano de laboratório. Para impor políticas de rede de laboratório, elas devem ser definidas aqui e não podem ser alteradas quando houver laboratórios existentes associados a esse plano de laboratório.
properties.linkedLmsInstance		string minLength: 3 maxLength: 2000	URL base da instância lms contra a qual este plano de laboratório pode vincular listas de laboratório.
properties.sharedGalleryId		string minLength: 3 maxLength: 2000	ID do recurso da Galeria de Imagens Compartilhadas anexada a este plano de laboratório. Ao salvar uma imagem de máquina virtual de modelo de laboratório, ela será mantida nesta galeria. Imagens compartilhadas da galeria podem ser disponibilizadas para uso ao criar novos laboratórios.
properties.supportInfo		SupportInfo	Informações de contato de suporte e instruções para usuários do plano de laboratório. Essas informações são exibidas para proprietários de laboratórios e usuários de máquinas virtuais para todos os laboratórios no plano de laboratório.
tags		object	Tags de recursos.

Respostas

Name	Tipo	Description
200 OK	LabPlan	A atualização foi bem-sucedida; contém o Plano de laboratório.
201 Created	LabPlan	A criação foi bem sucedida; contém o Plano de laboratório.
202 Accepted	LabPlan	A atualização foi bem-sucedida e tem uma operação de longa duração; contém o Plano de laboratório.
Other Status Codes	ErrorResponse	A resposta de erro padrão.

Exemplos

putLabPlan

Pedido de amostra

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

Resposta da amostra

Código de estado:: 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."
    }
  }
}

Código de estado:: 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."
    }
  }
}

Código de estado:: 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."
    }
  }
}

Definições

Name	Description
AutoShutdownProfile	Perfil de como lidar com o desligamento de máquinas virtuais.
ConnectionProfile	Perfil de conexão para como os usuários se conectam a máquinas virtuais de laboratório.
ConnectionType	O nível de acesso habilitado para Acesso à Web sobre SSH.
createdByType	O tipo de identidade que criou o recurso.
EnableState	Se o desligamento ao desconectar está habilitado
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
Identity	Identidade do recurso.
LabPlan	Os Planos de Laboratório funcionam como um recipiente de permissão para a criação de laboratórios via labs.azure.com. Além disso, eles podem fornecer um conjunto de configurações padrão que serão aplicadas no momento da criação de um laboratório, mas esses padrões ainda podem ser substituídos.
LabPlanNetworkProfile	Perfil de como lidar com redes para Planos de Laboratório.
ProvisioningState	Estado atual de provisionamento do plano de laboratório.
ResourceIdentityType	O tipo de identidade.
ResourceOperationError	Detalhes de erro da última falha de operação neste recurso
shutdownOnIdleMode	Define se a VM deve ser desligada em ociosidade e os critérios para deteção de ociosidade.
SupportInfo	Informações de contato e instruções de suporte.
systemData	Metadados referentes à criação e última modificação do recurso.

AutoShutdownProfile

Object

Perfil de como lidar com o desligamento de máquinas virtuais.

Name	Tipo	Default value	Description
disconnectDelay	string (duration)		A quantidade de tempo que uma VM permanecerá em execução depois que um usuário se desconectar se esse comportamento estiver habilitado.
idleDelay	string (duration)		A quantidade de tempo que uma VM ficará ociosa antes de ser desligada se esse comportamento estiver habilitado.
noConnectDelay	string (duration)		A quantidade de tempo que uma VM permanecerá em execução antes de ser desligada se nenhuma conexão for feita e esse comportamento estiver habilitado.
shutdownOnDisconnect	EnableState	Disabled	Se o desligamento ao desconectar está habilitado
shutdownOnIdle	shutdownOnIdleMode	None	Se uma VM será desligada quando estiver ociosa por um período de tempo.
shutdownWhenNotConnected	EnableState	Disabled	Se uma VM será desligada quando não tiver sido conectada após um período de tempo.

ConnectionProfile

Object

Perfil de conexão para como os usuários se conectam a máquinas virtuais de laboratório.

Name	Tipo	Default value	Description
clientRdpAccess	ConnectionType	None	O nível de acesso habilitado para Acesso para Cliente sobre RDP.
clientSshAccess	ConnectionType	None	O nível de acesso habilitado para Acesso para Cliente sobre SSH.
webRdpAccess	ConnectionType	None	O nível de acesso habilitado para Acesso à Web via RDP.
webSshAccess	ConnectionType	None	O nível de acesso habilitado para Acesso à Web sobre SSH.

ConnectionType

Enumeração

O nível de acesso habilitado para Acesso à Web sobre SSH.

Valor	Description
Public
Private
None

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
User
Application
ManagedIdentity
Key

EnableState

Enumeração

Se o desligamento ao desconectar está habilitado

Valor	Description
Enabled
Disabled

ErrorAdditionalInfo

Object

O erro de gerenciamento de recursos informações adicionais.

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Object

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Object

Resposta de erro

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

Identity

Object

Identidade do recurso.

Name	Tipo	Description
principalId	string	A ID principal da identidade do recurso.
tenantId	string	A ID do locatário do recurso.
type	ResourceIdentityType	O tipo de identidade.

LabPlan

Object

Os Planos de Laboratório funcionam como um recipiente de permissão para a criação de laboratórios via labs.azure.com. Além disso, eles podem fornecer um conjunto de configurações padrão que serão aplicadas no momento da criação de um laboratório, mas esses padrões ainda podem ser substituídos.

Name	Tipo	Description
id	string	ID de recurso totalmente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	Identity	Informações de identidade gerenciadas
location	string	A geolocalização onde o recurso vive
name	string	O nome do recurso
properties.allowedRegions	string[]	As regiões permitidas para o criador do laboratório usar ao criar laboratórios usando este plano de laboratório.
properties.defaultAutoShutdownProfile	AutoShutdownProfile	O perfil de desligamento de laboratório padrão. Isso pode ser alterado em um recurso de laboratório e fornece apenas um perfil padrão.
properties.defaultConnectionProfile	ConnectionProfile	O perfil de conexão de laboratório padrão. Isso pode ser alterado em um recurso de laboratório e fornece apenas um perfil padrão.
properties.defaultNetworkProfile	LabPlanNetworkProfile	O perfil de rede do plano de laboratório. Para impor políticas de rede de laboratório, elas devem ser definidas aqui e não podem ser alteradas quando houver laboratórios existentes associados a esse plano de laboratório.
properties.linkedLmsInstance	string minLength: 3 maxLength: 2000	URL base da instância lms contra a qual este plano de laboratório pode vincular listas de laboratório.
properties.provisioningState	ProvisioningState	Estado atual de provisionamento do plano de laboratório.
properties.resourceOperationError	ResourceOperationError	Detalhes do erro da última operação feita no plano de laboratório.
properties.sharedGalleryId	string minLength: 3 maxLength: 2000	ID do recurso da Galeria de Imagens Compartilhadas anexada a este plano de laboratório. Ao salvar uma imagem de máquina virtual de modelo de laboratório, ela será mantida nesta galeria. Imagens compartilhadas da galeria podem ser disponibilizadas para uso ao criar novos laboratórios.
properties.supportInfo	SupportInfo	Informações de contato de suporte e instruções para usuários do plano de laboratório. Essas informações são exibidas para proprietários de laboratórios e usuários de máquinas virtuais para todos os laboratórios no plano de laboratório.
systemData	systemData	Metadados referentes à criação e última modificação do plano de laboratório.
tags	object	Tags de recursos.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

LabPlanNetworkProfile

Object

Perfil de como lidar com redes para Planos de Laboratório.

Name	Tipo	Description
subnetId	string minLength: 3 maxLength: 2000	A id do recurso de sub-rede externa

ProvisioningState

Enumeração

Estado atual de provisionamento do plano de laboratório.

Valor	Description
Creating	O recurso está em processo de criação.
Updating	Novos valores de propriedade estão sendo aplicados ao recurso.
Deleting	O recurso está em processo de exclusão.
Succeeded	O recurso está em estado íntegro após a operação de criação ou atualização.
Failed	A operação anterior no recurso falhou, deixando o recurso em estado não íntegro.
Locked	O recurso está bloqueado e as alterações estão bloqueadas no momento. Isto pode dever-se a uma manutenção ou a uma operação programada. O Estado voltará a ter sucesso assim que a operação de bloqueio terminar.

ResourceIdentityType

Enumeração

O tipo de identidade.

Valor	Description
SystemAssigned

ResourceOperationError

Object

Detalhes de erro da última falha de operação neste recurso

Name	Tipo	Description
action	string	A ação de operação que falhou
code	string	O código que corresponde ao tipo de falha de operação
message	string	A mensagem de falha da operação
timestamp	string (date-time)	A data/hora de quando o erro ocorreu

shutdownOnIdleMode

Enumeração

Define se a VM deve ser desligada em ociosidade e os critérios para deteção de ociosidade.

Valor	Description
None	A VM não será desligada quando estiver ociosa.
UserAbsence	A VM será considerada ociosa quando não houver entrada de teclado ou mouse.
LowUsage	A VM será considerada ociosa quando o usuário estiver ausente e o consumo de recursos (CPU e disco) for baixo.

SupportInfo

Object

Informações de contato e instruções de suporte.

Name	Tipo	Description
email	string minLength: 6 maxLength: 254	Endereço de e-mail de contato do suporte.
instructions	string	Instruções de suporte.
phone	string minLength: 1 maxLength: 31	Número de telefone de contato do suporte.
url	string minLength: 3 maxLength: 2000	Endereço web de suporte.

systemData

Object

Metadados referentes à criação e última modificação do recurso.

Name	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

Partilhar via

Lab Plans - Create Or Update

Parâmetros do URI

Corpo do Pedido

Respostas

Exemplos

putLabPlan

Pedido de amostra

Resposta da amostra

Definições

AutoShutdownProfile

ConnectionProfile

ConnectionType

createdByType

EnableState

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

Identity

LabPlan

LabPlanNetworkProfile

ProvisioningState

ResourceIdentityType

ResourceOperationError

shutdownOnIdleMode

SupportInfo

systemData