Lab Plans - Create Or Update

Referência

Service:: Lab Services

API Version:: 2023-06-07

Atualizações ou cria um recurso de Plano de Laboratório.
Operação para criar ou atualizar um recurso do 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 de URI

Nome	Em	Obrigatório	Tipo	Description
labPlanName	path	True	string	O nome do plano de laboratório que o identifica exclusivamente dentro do grupo de recursos que contém. Usado em URIs de recurso e na interface do usuário.
resourceGroupName	path	True	string	O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string	A ID da assinatura de destino.
api-version	query	True	string	A versão da API a ser usada para esta operação.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
location	True	string	A localização geográfica em que o recurso reside
identity		Identity	Informações de identidade gerenciada
properties.allowedRegions		string[]	As regiões permitidas para o criador do laboratório usar ao criar laboratórios usando esse plano de laboratório.
properties.defaultAutoShutdownProfile		AutoShutdownProfile	O perfil de desligamento do 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 há laboratórios existentes associados a esse plano de laboratório.
properties.linkedLmsInstance		string	Url base da instância lms em que este plano de laboratório pode vincular listas de laboratório.
properties.sharedGalleryId		string	A ID do recurso do 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. As imagens compartilhadas da galeria podem ser disponibilizadas para uso ao criar novos laboratórios.
properties.supportInfo		SupportInfo	Suporte a informações de contato e instruções para usuários do plano de laboratório. Essas informações são exibidas para proprietários de laboratório e usuários de máquina virtual para todos os laboratórios no plano de laboratório.
tags		object	Marcas de recurso.

Respostas

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

Exemplos

putLabPlan

Sample Request

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

Sample Response

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

Response Body

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

Response Body

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

Nome	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 por SSH.
createdByType	O tipo de identidade que criou o recurso.
EnableState	Se o desligamento na desconexão está habilitado
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
Identity	Identidade do recurso.
LabPlan	Os Planos de Laboratório atuam como um contêiner de permissão para criar laboratórios por meio de 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 a rede para Planos de Laboratório.
ProvisioningState	Estado de provisionamento atual do plano de laboratório.
ResourceIdentityType	O tipo de identidade.
ResourceOperationError	Detalhes do erro da falha de operação mais recente neste recurso
shutdownOnIdleMode	Define se a VM deve ser desligada em ociosidade e os critérios para detecção ociosa.
SupportInfo	Suporte a informações e instruções de contato.
systemData	Metadados relativos à criação e à última modificação do recurso.

AutoShutdownProfile

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

Nome	Tipo	Valor padrão	Description
disconnectDelay	string		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		A quantidade de tempo que uma VM ficará ociosa antes de ser desligada se esse comportamento estiver habilitado.
noConnectDelay	string		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 na desconexão 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

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

Nome	Tipo	Valor padrão	Description
clientRdpAccess	ConnectionType	None	O nível de acesso habilitado para Acesso ao Cliente por RDP.
clientSshAccess	ConnectionType	None	O nível de acesso habilitado para Acesso ao Cliente por SSH.
webRdpAccess	ConnectionType	None	O nível de acesso habilitado para Acesso à Web por RDP.
webSshAccess	ConnectionType	None	O nível de acesso habilitado para Acesso à Web por SSH.

ConnectionType

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

Nome	Tipo	Description
None	string
Private	string
Public	string

createdByType

O tipo de identidade que criou o recurso.

Nome	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

EnableState

Se o desligamento na desconexão está habilitado

Nome	Tipo	Description
Disabled	string
Enabled	string

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

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

ErrorDetail

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
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

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

Identity

Identidade do recurso.

Nome	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

Os Planos de Laboratório atuam como um contêiner de permissão para criar laboratórios por meio de 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.

Nome	Tipo	Description
id	string	ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	Identity	Informações de identidade gerenciada
location	string	A localização geográfica em que o recurso reside
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 esse plano de laboratório.
properties.defaultAutoShutdownProfile	AutoShutdownProfile	O perfil de desligamento do 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 há laboratórios existentes associados a esse plano de laboratório.
properties.linkedLmsInstance	string	Url base da instância lms em que este plano de laboratório pode vincular listas de laboratório.
properties.provisioningState	ProvisioningState	Estado de provisionamento atual do plano de laboratório.
properties.resourceOperationError	ResourceOperationError	Detalhes do erro da última operação feita no plano de laboratório.
properties.sharedGalleryId	string	A ID do recurso do 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. As imagens compartilhadas da galeria podem ser disponibilizadas para uso ao criar novos laboratórios.
properties.supportInfo	SupportInfo	Suporte a informações de contato e instruções para usuários do plano de laboratório. Essas informações são exibidas para proprietários de laboratório e usuários de máquina virtual para todos os laboratórios no plano de laboratório.
systemData	systemData	Metadados relativos à criação e à última modificação do plano de laboratório.
tags	object	Marcas de recurso.
type	string	Tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

LabPlanNetworkProfile

Perfil de como lidar com a rede para Planos de Laboratório.

Nome	Tipo	Description
subnetId	string	A ID do recurso de sub-rede externa

ProvisioningState

Estado de provisionamento atual do plano de laboratório.

Nome	Tipo	Description
Creating	string	O recurso está em processo de criação.
Deleting	string	O recurso está em processo de exclusão.
Failed	string	A operação anterior no recurso falhou ao deixar o recurso em estado não íntegro.
Locked	string	O recurso está bloqueado e as alterações estão bloqueadas no momento. Isso pode ser devido à manutenção ou a uma operação agendada. O estado voltará a ser bem-sucedido depois que a operação de bloqueio for concluída.
Succeeded	string	O recurso está em estado íntegro após a criação ou a operação de atualização.
Updating	string	Novos valores de propriedade estão sendo aplicados ao recurso.

ResourceIdentityType

O tipo de identidade.

Nome	Tipo	Description
SystemAssigned	string

ResourceOperationError

Detalhes do erro da falha de operação mais recente neste recurso

Nome	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	O datetime de quando o erro ocorreu

shutdownOnIdleMode

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

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

SupportInfo

Suporte a informações e instruções de contato.

Nome	Tipo	Description
email	string	Endereço de email de contato de suporte.
instructions	string	Instruções de suporte.
phone	string	Número de telefone de contato de suporte.
url	string	Endereço Web de suporte.

systemData

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

Nome	Tipo	Description
createdAt	string	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	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.