Lab Plans - Create Or Update

Servizio:: Lab Services

Versione API:: 2023-06-07

Aggiorna o crea una risorsa del piano lab.
Operazione per creare o aggiornare una risorsa del piano lab.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
labPlanName	path	True	string minLength: 1 maxLength: 100	Nome del piano lab che lo identifica in modo univoco all'interno del gruppo di risorse contenitore. Usato negli URI delle risorse e nell'interfaccia utente.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.
subscriptionId	path	True	string minLength: 1	ID della sottoscrizione di destinazione.
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
location	True	string	Posizione geografica in cui risiede la risorsa
identity		Identity	Informazioni sull'identità gestita
properties.allowedRegions		string[]	Le aree consentite per l'autore del lab da usare durante la creazione di lab usando questo piano lab.
properties.defaultAutoShutdownProfile		AutoShutdownProfile	Profilo di arresto del lab predefinito. Questa operazione può essere modificata in una risorsa lab e fornisce solo un profilo predefinito.
properties.defaultConnectionProfile		ConnectionProfile	Profilo di connessione lab predefinito. Questa operazione può essere modificata in una risorsa lab e fornisce solo un profilo predefinito.
properties.defaultNetworkProfile		LabPlanNetworkProfile	Profilo di rete del piano lab. Per applicare i criteri di rete del lab, devono essere definiti qui e non possono essere modificati quando sono presenti lab esistenti associati a questo piano di lab.
properties.linkedLmsInstance		string minLength: 3 maxLength: 2000	L'URL di base dell'istanza lms di questo piano lab può collegare i rosters del lab.
properties.sharedGalleryId		string minLength: 3 maxLength: 2000	ID risorsa della raccolta immagini condivise collegata a questo piano lab. Quando si salva un'immagine di macchina virtuale modello di lab, questa verrà salvata in modo permanente in questa raccolta. Le immagini condivise dalla raccolta possono essere rese disponibili per l'uso durante la creazione di nuovi lab.
properties.supportInfo		SupportInfo	Informazioni di contatto del supporto e istruzioni per gli utenti del piano lab. Queste informazioni vengono visualizzate ai proprietari del lab e agli utenti delle macchine virtuali per tutti i lab nel piano lab.
tags		object	Tag di risorsa.

Risposte

Nome	Tipo	Descrizione
200 OK	LabPlan	L'aggiornamento è riuscito; la risposta contiene il piano lab.
201 Created	LabPlan	La creazione ha avuto esito positivo; la risposta contiene il piano lab.
202 Accepted	LabPlan	L'aggiornamento ha avuto esito positivo e ha un'operazione a esecuzione prolungata; la risposta contiene il piano lab.
Other Status Codes	ErrorResponse	Risposta di errore predefinita.

Esempio

putLabPlan

Esempio di richiesta

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

Risposta di esempio

Codice di stato:: 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."
    }
  }
}

Codice di stato:: 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."
    }
  }
}

Codice di stato:: 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."
    }
  }
}

Definizioni

Nome	Descrizione
AutoShutdownProfile	Profilare come gestire l'arresto delle macchine virtuali.
ConnectionProfile	Profilo di connessione per il modo in cui gli utenti si connettono alle macchine virtuali lab.
ConnectionType	Livello di accesso abilitato per Accesso Web tramite SSH.
createdByType	Tipo di identità che ha creato la risorsa.
EnableState	Indica se l'arresto alla disconnessione è abilitato
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore
Identity	Identità per la risorsa.
LabPlan	I piani lab fungono da contenitore di autorizzazioni per la creazione di lab tramite labs.azure.com. Inoltre, possono fornire un set di configurazioni predefinite che verranno applicate al momento della creazione di un lab, ma queste impostazioni predefinite possono comunque essere sovrascritte.
LabPlanNetworkProfile	Profilare come gestire la rete per i piani lab.
ProvisioningState	Stato di provisioning corrente del piano del lab.
ResourceIdentityType	Tipo di identità.
ResourceOperationError	Dettagli dell'errore dell'operazione più recente in questa risorsa
shutdownOnIdleMode	Definisce se arrestare la macchina virtuale inattiva e i criteri per il rilevamento inattivo.
SupportInfo	Informazioni e istruzioni sul contatto del supporto tecnico.
systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.

AutoShutdownProfile

Object

Profilare come gestire l'arresto delle macchine virtuali.

Nome	Tipo	Valore predefinito	Descrizione
disconnectDelay	string (duration)		La quantità di tempo per cui una macchina virtuale rimarrà in esecuzione dopo che un utente si disconnette se questo comportamento è abilitato.
idleDelay	string (duration)		Periodo di inattività di una macchina virtuale prima dell'arresto se questo comportamento è abilitato.
noConnectDelay	string (duration)		La quantità di tempo in cui una macchina virtuale rimarrà in esecuzione prima dell'arresto se non viene stabilita alcuna connessione e questo comportamento è abilitato.
shutdownOnDisconnect	EnableState	Disabled	Indica se l'arresto alla disconnessione è abilitato
shutdownOnIdle	shutdownOnIdleMode	None	Indica se una macchina virtuale viene arrestata quando è inattiva per un periodo di tempo.
shutdownWhenNotConnected	EnableState	Disabled	Indica se una macchina virtuale viene arrestata quando non è stata connessa dopo un periodo di tempo.

ConnectionProfile

Object

Profilo di connessione per il modo in cui gli utenti si connettono alle macchine virtuali lab.

Nome	Tipo	Valore predefinito	Descrizione
clientRdpAccess	ConnectionType	None	Livello di accesso abilitato per Accesso client su RDP.
clientSshAccess	ConnectionType	None	Livello di accesso abilitato per Accesso client tramite SSH.
webRdpAccess	ConnectionType	None	Livello di accesso abilitato per Accesso Web tramite RDP.
webSshAccess	ConnectionType	None	Livello di accesso abilitato per Accesso Web tramite SSH.

ConnectionType

Enumerazione

Livello di accesso abilitato per Accesso Web tramite SSH.

Valore	Descrizione
Public
Private
None

createdByType

Enumerazione

Tipo di identità che ha creato la risorsa.

Valore	Descrizione
User
Application
ManagedIdentity
Key

EnableState

Enumerazione

Indica se l'arresto alla disconnessione è abilitato

Valore	Descrizione
Enabled
Disabled

ErrorAdditionalInfo

Object

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorDetail

Object

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorDetail[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorResponse

Object

Risposta di errore

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

Identity

Object

Identità per la risorsa.

Nome	Tipo	Descrizione
principalId	string	ID principale dell'identità della risorsa.
tenantId	string	ID tenant della risorsa.
type	ResourceIdentityType	Tipo di identità.

LabPlan

Object

I piani lab fungono da contenitore di autorizzazioni per la creazione di lab tramite labs.azure.com. Inoltre, possono fornire un set di configurazioni predefinite che verranno applicate al momento della creazione di un lab, ma queste impostazioni predefinite possono comunque essere sovrascritte.

Nome	Tipo	Descrizione
id	string	ID risorsa completo per la risorsa. Ad esempio - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	Identity	Informazioni sull'identità gestita
location	string	Posizione geografica in cui risiede la risorsa
name	string	Nome della risorsa
properties.allowedRegions	string[]	Le aree consentite per l'autore del lab da usare durante la creazione di lab usando questo piano lab.
properties.defaultAutoShutdownProfile	AutoShutdownProfile	Profilo di arresto del lab predefinito. Questa operazione può essere modificata in una risorsa lab e fornisce solo un profilo predefinito.
properties.defaultConnectionProfile	ConnectionProfile	Profilo di connessione lab predefinito. Questa operazione può essere modificata in una risorsa lab e fornisce solo un profilo predefinito.
properties.defaultNetworkProfile	LabPlanNetworkProfile	Profilo di rete del piano lab. Per applicare i criteri di rete del lab, devono essere definiti qui e non possono essere modificati quando sono presenti lab esistenti associati a questo piano di lab.
properties.linkedLmsInstance	string minLength: 3 maxLength: 2000	L'URL di base dell'istanza lms di questo piano lab può collegare i rosters del lab.
properties.provisioningState	ProvisioningState	Stato di provisioning corrente del piano del lab.
properties.resourceOperationError	ResourceOperationError	Dettagli dell'errore dell'ultima operazione eseguita sul piano lab.
properties.sharedGalleryId	string minLength: 3 maxLength: 2000	ID risorsa della raccolta immagini condivise collegata a questo piano lab. Quando si salva un'immagine di macchina virtuale modello di lab, questa verrà salvata in modo permanente in questa raccolta. Le immagini condivise dalla raccolta possono essere rese disponibili per l'uso durante la creazione di nuovi lab.
properties.supportInfo	SupportInfo	Informazioni di contatto del supporto e istruzioni per gli utenti del piano lab. Queste informazioni vengono visualizzate ai proprietari del lab e agli utenti delle macchine virtuali per tutti i lab nel piano lab.
systemData	systemData	Metadati relativi alla creazione e all'ultima modifica del piano del lab.
tags	object	Tag di risorsa.
type	string	Tipo della risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

LabPlanNetworkProfile

Object

Profilare come gestire la rete per i piani lab.

Nome	Tipo	Descrizione
subnetId	string minLength: 3 maxLength: 2000	ID risorsa subnet esterna

ProvisioningState

Enumerazione

Stato di provisioning corrente del piano del lab.

Valore	Descrizione
Creating	La risorsa è in corso di creazione.
Updating	Alla risorsa vengono applicati nuovi valori di proprietà.
Deleting	La risorsa è in corso di eliminazione.
Succeeded	La risorsa è in stato integro dopo la creazione o l'operazione di aggiornamento.
Failed	L'operazione precedente sulla risorsa non è riuscita a lasciare la risorsa in stato non integro.
Locked	La risorsa è bloccata e le modifiche sono attualmente bloccate. Ciò potrebbe essere dovuto alla manutenzione o a un'operazione pianificata. Lo stato tornerà al completamento dell'operazione di blocco.

ResourceIdentityType

Enumerazione

Tipo di identità.

Valore	Descrizione
SystemAssigned

ResourceOperationError

Object

Dettagli dell'errore dell'operazione più recente in questa risorsa

Nome	Tipo	Descrizione
action	string	Azione dell'operazione non riuscita
code	string	Codice che corrisponde al tipo di errore dell'operazione
message	string	Messaggio di errore dell'operazione
timestamp	string (date-time)	Datetime di quando si è verificato l'errore

shutdownOnIdleMode

Enumerazione

Definisce se arrestare la macchina virtuale inattiva e i criteri per il rilevamento inattivo.

Valore	Descrizione
None	La macchina virtuale non verrà arrestata quando è inattiva.
UserAbsence	La macchina virtuale verrà considerata inattiva quando non è presente alcuna tastiera o input del mouse.
LowUsage	La macchina virtuale verrà considerata inattiva quando l'utente è assente e il consumo di risorse (CPU e disco) è basso.

SupportInfo

Object

Informazioni e istruzioni sul contatto del supporto tecnico.

Nome	Tipo	Descrizione
email	string minLength: 6 maxLength: 254	Indirizzo di posta elettronica del contatto di supporto.
instructions	string	Istruzioni di supporto.
phone	string minLength: 1 maxLength: 31	Numero di telefono del contatto di supporto.
url	string minLength: 3 maxLength: 2000	Supporto dell'indirizzo Web.

systemData

Object

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome	Tipo	Descrizione
createdAt	string (date-time)	Timestamp della creazione della risorsa (UTC).
createdBy	string	Identità che ha creato la risorsa.
createdByType	createdByType	Tipo di identità che ha creato la risorsa.
lastModifiedAt	string (date-time)	Timestamp dell'ultima modifica della risorsa (UTC)
lastModifiedBy	string	Identità che ha modificato l'ultima volta la risorsa.
lastModifiedByType	createdByType	Tipo di identità che ha modificato l'ultima volta la risorsa.

Condividi tramite

Lab Plans - Create Or Update

Parametri dell'URI

Corpo della richiesta

Risposte

Esempio

putLabPlan

Esempio di richiesta

Risposta di esempio

Definizioni

AutoShutdownProfile

ConnectionProfile

ConnectionType

createdByType

EnableState

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

Identity

LabPlan

LabPlanNetworkProfile

ProvisioningState

ResourceIdentityType

ResourceOperationError

shutdownOnIdleMode

SupportInfo

systemData