Lab Plans - Create Or Update

  • Referência
Service:
Lab Services
API Version:
2023-06-07

Atualizações ou cria um recurso do 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 do URI

Name Em Necessário Tipo Description
labPlanName
 path True

string

O nome do plano de laboratório que o identifica exclusivamente no grupo de recursos. Utilizado em URIs de recursos e na IU.
resourceGroupName
 path True

string

O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.
subscriptionId
 path True

string

O ID da subscrição de destino.
api-version
 query True

string

A versão da API a utilizar para esta operação.

Corpo do Pedido

Name Necessário Tipo Description
location True

string

A localização geográfica onde o recurso se encontra
identity

Identity

Informações de Identidade Gerida
properties.allowedRegions

string[]

As regiões permitidas para o criador do laboratório utilizar ao criar laboratórios com este plano de laboratório.
properties.defaultAutoShutdownProfile

AutoShutdownProfile

O perfil de encerramento do laboratório predefinido. Isto pode ser alterado num recurso de laboratório e apenas fornece um perfil predefinido.
properties.defaultConnectionProfile

ConnectionProfile

O perfil de ligação de laboratório predefinido. Isto pode ser alterado num recurso de laboratório e apenas fornece um perfil predefinido.
properties.defaultNetworkProfile

LabPlanNetworkProfile

O perfil de rede do plano de laboratório. Para impor políticas de rede de laboratório, têm de ser definidas aqui e não podem ser alteradas quando existem laboratórios associados a este plano de laboratório.
properties.linkedLmsInstance

string

URL base da instância do lms ao qual este plano de laboratório pode ligar listas de laboratório.
properties.sharedGalleryId

string

ID do recurso do Shared Image Gallery anexado a este plano de laboratório. Ao guardar uma imagem de máquina virtual de modelo de laboratório, esta será mantida nesta galeria. As imagens partilhadas da galeria podem ser disponibilizadas para utilização ao criar novos laboratórios.
properties.supportInfo

SupportInfo

Suporte para informações de contacto e instruções para os utilizadores do plano de laboratório. Estas informações são apresentadas aos proprietários do laboratório e aos utilizadores de máquinas virtuais de todos os laboratórios no plano de laboratório.
tags

object

Etiquetas de recursos.

Respostas

Name Tipo Description
200 OK

LabPlan

A atualização foi efetuada com êxito; A resposta contém o Plano de Laboratório.
201 Created

LabPlan

A criação foi efetuada com êxito; 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 predefinida.

Exemplos

putLabPlan

Sample Request

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

Name Description
AutoShutdownProfile

Perfil para saber como lidar com o encerramento de máquinas virtuais.
ConnectionProfile

Perfil de ligação para saber como os utilizadores se ligam a máquinas virtuais de laboratório.
ConnectionType

O nível de acesso ativado para o Acesso Web através de SSH.
createdByType

O tipo de identidade que criou o recurso.
EnableState

Se o encerramento ao desligar está ativado
ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.
ErrorDetail

O detalhe do erro.
ErrorResponse

Resposta a erros
Identity

Identidade do recurso.
LabPlan

Os Planos de Laboratório funcionam como um contentor de permissões para criar laboratórios através de labs.azure.com. Além disso, podem fornecer um conjunto de configurações predefinidas que serão aplicadas no momento da criação de um laboratório, mas estas predefinições ainda podem ser substituídas.
LabPlanNetworkProfile

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

Estado de aprovisionamento atual do plano de laboratório.
ResourceIdentityType

O tipo de identidade.
ResourceOperationError

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

Define se pretende encerrar a VM em inatividade e os critérios para deteção inativa.
SupportInfo

Suporte para informações de contacto e instruções.
systemData

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

AutoShutdownProfile

Perfil para saber como lidar com o encerramento de máquinas virtuais.

Name Tipo Valor Predefinido Description
disconnectDelay

string

A quantidade de tempo que uma VM permanecerá em execução depois de um utilizador desligar se este comportamento estiver ativado.
idleDelay

string

A quantidade de tempo que uma VM irá inativar antes de ser encerrada se este comportamento estiver ativado.
noConnectDelay

string

A quantidade de tempo que uma VM permanecerá em execução antes de ser encerrada se não for efetuada nenhuma ligação e este comportamento estiver ativado.
shutdownOnDisconnect

EnableState

Disabled

Se o encerramento ao desligar está ativado
shutdownOnIdle

shutdownOnIdleMode

None

Se uma VM será encerrada quando estiver inativa durante um período de tempo.
shutdownWhenNotConnected

EnableState

Disabled

Se uma VM será encerrada quando não estiver ligada após um período de tempo.

ConnectionProfile

Perfil de ligação para saber como os utilizadores se ligam a máquinas virtuais de laboratório.

Name Tipo Valor Predefinido Description
clientRdpAccess

ConnectionType

None

O nível de acesso ativado para o Acesso do Cliente através de RDP.
clientSshAccess

ConnectionType

None

O nível de acesso ativado para o Acesso ao Cliente através de SSH.
webRdpAccess

ConnectionType

None

O nível de acesso ativado para o Acesso Web através de RDP.
webSshAccess

ConnectionType

None

O nível de acesso ativado para o Acesso Web através de SSH.

ConnectionType

O nível de acesso ativado para o Acesso Web através de SSH.

Name Tipo Description
None

string

Private

string

Public

string

createdByType

O tipo de identidade que criou o recurso.

Name Tipo Description
Application

string

Key

string

ManagedIdentity

string

User

string

EnableState

Se o encerramento ao desligar está ativado

Name Tipo Description
Disabled

string

Enabled

string

ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.

Name Tipo Description
info

object

As informações adicionais.
type

string

O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Name 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 a erros

Name Tipo Description
error

ErrorDetail

O objeto de erro.

Identity

Identidade do recurso.

Name Tipo Description
principalId

string

O ID principal da identidade de recurso.
tenantId

string

O ID do inquilino do recurso.
type

ResourceIdentityType

O tipo de identidade.

LabPlan

Os Planos de Laboratório funcionam como um contentor de permissões para criar laboratórios através de labs.azure.com. Além disso, podem fornecer um conjunto de configurações predefinidas que serão aplicadas no momento da criação de um laboratório, mas estas predefinições ainda podem ser substituídas.

Name Tipo Description
id

string

ID de recurso completamente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity

Identity

Informações de Identidade Gerida
location

string

A localização geográfica onde o recurso se encontra
name

string

O nome do recurso
properties.allowedRegions

string[]

As regiões permitidas para o criador do laboratório utilizar ao criar laboratórios com este plano de laboratório.
properties.defaultAutoShutdownProfile

AutoShutdownProfile

O perfil de encerramento do laboratório predefinido. Isto pode ser alterado num recurso de laboratório e apenas fornece um perfil predefinido.
properties.defaultConnectionProfile

ConnectionProfile

O perfil de ligação de laboratório predefinido. Isto pode ser alterado num recurso de laboratório e apenas fornece um perfil predefinido.
properties.defaultNetworkProfile

LabPlanNetworkProfile

O perfil de rede do plano de laboratório. Para impor políticas de rede de laboratório, têm de ser definidas aqui e não podem ser alteradas quando existem laboratórios associados a este plano de laboratório.
properties.linkedLmsInstance

string

Url base da instância lms em que este plano de laboratório pode ligar listas de laboratório.
properties.provisioningState

ProvisioningState

Estado de aprovisionamento atual do plano de laboratório.
properties.resourceOperationError

ResourceOperationError

Detalhes do erro da última operação efetuada no plano de laboratório.
properties.sharedGalleryId

string

ID de recurso do Shared Image Gallery anexado a este plano de laboratório. Ao guardar uma imagem de máquina virtual de modelo de laboratório, esta será mantida nesta galeria. As imagens partilhadas da galeria podem ser disponibilizadas para utilização ao criar novos laboratórios.
properties.supportInfo

SupportInfo

Suporte para informações de contacto e instruções para os utilizadores do plano de laboratório. Estas informações são apresentadas aos proprietários de laboratórios e utilizadores de máquinas virtuais 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

Etiquetas de recursos.
type

string

O tipo de recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

LabPlanNetworkProfile

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

Name Tipo Description
subnetId

string

O ID de recurso da sub-rede externa

ProvisioningState

Estado de aprovisionamento atual do plano de laboratório.

Name Tipo Description
Creating

string

O recurso está a ser criado.
Deleting

string

O recurso está a ser eliminado.
Failed

string

A operação anterior no recurso falhou ao deixar o recurso em mau estado de funcionamento.
Locked

string

O recurso está bloqueado e as alterações estão atualmente bloqueadas. Tal pode dever-se à manutenção ou a uma operação agendada. O estado voltará a ser bem-sucedido assim que a operação de bloqueio estiver concluída.
Succeeded

string

O recurso está em bom estado de funcionamento após a criação ou operação de atualização.
Updating

string

Estão a ser aplicados novos valores de propriedade ao recurso.

ResourceIdentityType

O tipo de identidade.

Name Tipo Description
SystemAssigned

string

ResourceOperationError

Detalhes do erro da falha da operação mais recente 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

O datetime de quando ocorreu o erro

shutdownOnIdleMode

Define se pretende encerrar a VM em inatividade e os critérios para deteção inativa.

Name Tipo Description
LowUsage

string

A VM será considerada inativa quando o utilizador estiver ausente e o consumo de recursos (CPU e disco) for baixo.
None

string

A VM não será encerrada quando estiver inativa.
UserAbsence

string

A VM será considerada inativa quando não existir nenhuma entrada de teclado ou rato.

SupportInfo

Suporte para informações de contacto e instruções.

Name Tipo Description
email

string

Endereço de e-mail de contacto de suporte.
instructions

string

Instruções de suporte.
phone

string

Número de telefone de contacto de suporte.
url

string

Suporte de endereço Web.

systemData

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

Name 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.