Lab Plans - Create Or Update

Služba:: Lab Services

Verze rozhraní API:: 2023-06-07

Aktualizuje nebo vytvoří prostředek plánu testovacího prostředí.
Operace vytvoření nebo aktualizace prostředku plánu testovacího prostředí

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
labPlanName	path	True	string minLength: 1 maxLength: 100	Název plánu testovacího prostředí, který ho jednoznačně identifikuje v rámci obsahující skupinu prostředků. Používá se v identifikátorech URI prostředků a v uživatelském rozhraní.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
subscriptionId	path	True	string minLength: 1	ID cílového předplatného.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Text požadavku

Name	Vyžadováno	Typ	Description
location	True	string	Geografické umístění, ve kterém se nachází zdroj
identity		Identity	Informace o spravované identitě
properties.allowedRegions		string[]	Povolené oblasti, které tvůrce testovacího prostředí může použít při vytváření testovacích prostředí pomocí tohoto plánu testovacího prostředí.
properties.defaultAutoShutdownProfile		AutoShutdownProfile	Výchozí profil vypnutí testovacího prostředí. To je možné změnit u prostředku testovacího prostředí a poskytuje pouze výchozí profil.
properties.defaultConnectionProfile		ConnectionProfile	Výchozí profil připojení testovacího prostředí. To je možné změnit u prostředku testovacího prostředí a poskytuje pouze výchozí profil.
properties.defaultNetworkProfile		LabPlanNetworkProfile	Profil sítě plánu testovacího prostředí. Pokud chcete vynutit zásady sítě testovacího prostředí, musí být zde definovány a nelze je změnit, pokud existují testovací prostředí přidružená k tomuto plánu testovacího prostředí.
properties.linkedLmsInstance		string minLength: 3 maxLength: 2000	Základní adresa URL instance lms, proti které tento plán testovacího prostředí může propojit seznam testovacích prostředí.
properties.sharedGalleryId		string minLength: 3 maxLength: 2000	ID prostředku sdílené galerie imagí připojeného k tomuto plánu testovacího prostředí Při ukládání image virtuálního počítače šablony testovacího prostředí bude v této galerii zachována. Sdílené image z galerie je možné zpřístupnit při vytváření nových testovacích prostředí.
properties.supportInfo		SupportInfo	Kontaktní informace a pokyny podpory pro uživatele plánu testovacího prostředí Tyto informace se zobrazí vlastníkům testovacích prostředí a uživatelům virtuálních počítačů pro všechna testovací prostředí v plánu testovacího prostředí.
tags		object	Značky prostředků

Odpovědi

Name	Typ	Description
200 OK	LabPlan	Aktualizace byla úspěšná; odpověď obsahuje plán testovacího prostředí.
201 Created	LabPlan	Vytvoření bylo úspěšné; odpověď obsahuje plán testovacího prostředí.
202 Accepted	LabPlan	Aktualizace byla úspěšná a má dlouho běžící operaci; odpověď obsahuje plán testovacího prostředí.
Other Status Codes	ErrorResponse	Výchozí chybová odpověď.

Příklady

putLabPlan

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:: 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."
    }
  }
}

Stavový kód:: 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."
    }
  }
}

Stavový kód:: 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."
    }
  }
}

Definice

Name	Description
AutoShutdownProfile	Profil pro zpracování vypnutí virtuálních počítačů
ConnectionProfile	Profil připojení pro způsob, jakým se uživatelé připojují k virtuálním počítačům testovacího prostředí
ConnectionType	Povolená úroveň přístupu pro Webový přístup přes SSH.
createdByType	Typ identity, která prostředek vytvořila.
EnableState	Jestli je povolené vypnutí při odpojení
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď
Identity	Identita prostředku
LabPlan	Plány testovacího prostředí fungují jako kontejner oprávnění pro vytváření testovacích prostředí prostřednictvím labs.azure.com. Kromě toho můžou poskytnout sadu výchozích konfigurací, které se použijí při vytváření testovacího prostředí, ale tyto výchozí hodnoty je možné přepsat.
LabPlanNetworkProfile	Profil pro zpracování sítí pro plány testovacího prostředí
ProvisioningState	Aktuální stav zřizování plánu testovacího prostředí
ResourceIdentityType	Typ identity.
ResourceOperationError	Podrobnosti o chybě nejnovější operace u tohoto prostředku
shutdownOnIdleMode	Definuje, jestli se má virtuální počítač vypnout na nečinnosti, a kritéria pro detekci nečinnosti.
SupportInfo	Kontaktní informace a pokyny podpory.
systemData	Metadata týkající se vytvoření a poslední změny prostředku.

AutoShutdownProfile

Objekt

Profil pro zpracování vypnutí virtuálních počítačů

Name	Typ	Default value	Description
disconnectDelay	string (duration)		Doba, po kterou bude virtuální počítač běžet, když se uživatel odpojí, pokud je toto chování povolené.
idleDelay	string (duration)		Doba, po kterou bude virtuální počítač nečinný, než se vypne, pokud je toto chování povolené.
noConnectDelay	string (duration)		Doba, po kterou bude virtuální počítač běžet, než se vypne, pokud se nevytáčí žádné připojení a toto chování je povolené.
shutdownOnDisconnect	EnableState	Disabled	Jestli je povolené vypnutí při odpojení
shutdownOnIdle	shutdownOnIdleMode	None	Jestli se virtuální počítač po určitou dobu vypne.
shutdownWhenNotConnected	EnableState	Disabled	Jestli se virtuální počítač vypne, když se po určité době nepřipojí.

ConnectionProfile

Objekt

Profil připojení pro způsob, jakým se uživatelé připojují k virtuálním počítačům testovacího prostředí

Name	Typ	Default value	Description
clientRdpAccess	ConnectionType	None	Povolená úroveň přístupu pro klientský přístup přes protokol RDP.
clientSshAccess	ConnectionType	None	Povolená úroveň přístupu pro klientský přístup přes SSH.
webRdpAccess	ConnectionType	None	Povolená úroveň přístupu pro Webový přístup přes protokol RDP.
webSshAccess	ConnectionType	None	Povolená úroveň přístupu pro Webový přístup přes SSH.

ConnectionType

Výčet

Povolená úroveň přístupu pro Webový přístup přes SSH.

Hodnota	Description
Public
Private
None

createdByType

Výčet

Typ identity, která prostředek vytvořila.

Hodnota	Description
User
Application
ManagedIdentity
Key

EnableState

Výčet

Jestli je povolené vypnutí při odpojení

Hodnota	Description
Enabled
Disabled

ErrorAdditionalInfo

Objekt

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorDetail

Objekt

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorResponse

Objekt

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

Identity

Objekt

Identita prostředku

Name	Typ	Description
principalId	string	ID objektu zabezpečení identity prostředku.
tenantId	string	ID tenanta prostředku.
type	ResourceIdentityType	Typ identity.

LabPlan

Objekt

Plány testovacího prostředí fungují jako kontejner oprávnění pro vytváření testovacích prostředí prostřednictvím labs.azure.com. Kromě toho můžou poskytnout sadu výchozích konfigurací, které se použijí při vytváření testovacího prostředí, ale tyto výchozí hodnoty je možné přepsat.

Name	Typ	Description
id	string	Plně kvalifikované ID prostředku pro prostředek. Příklad : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	Identity	Informace o spravované identitě
location	string	Geografické umístění, ve kterém se nachází zdroj
name	string	Název prostředku
properties.allowedRegions	string[]	Povolené oblasti, které tvůrce testovacího prostředí může použít při vytváření testovacích prostředí pomocí tohoto plánu testovacího prostředí.
properties.defaultAutoShutdownProfile	AutoShutdownProfile	Výchozí profil vypnutí testovacího prostředí. To je možné změnit u prostředku testovacího prostředí a poskytuje pouze výchozí profil.
properties.defaultConnectionProfile	ConnectionProfile	Výchozí profil připojení testovacího prostředí. To je možné změnit u prostředku testovacího prostředí a poskytuje pouze výchozí profil.
properties.defaultNetworkProfile	LabPlanNetworkProfile	Profil sítě plánu testovacího prostředí. Pokud chcete vynutit zásady sítě testovacího prostředí, musí být zde definovány a nelze je změnit, pokud existují testovací prostředí přidružená k tomuto plánu testovacího prostředí.
properties.linkedLmsInstance	string minLength: 3 maxLength: 2000	Základní adresa URL instance lms, proti které tento plán testovacího prostředí může propojit seznam testovacích prostředí.
properties.provisioningState	ProvisioningState	Aktuální stav zřizování plánu testovacího prostředí
properties.resourceOperationError	ResourceOperationError	Podrobnosti o chybě poslední operace provedené v plánu testovacího prostředí
properties.sharedGalleryId	string minLength: 3 maxLength: 2000	ID prostředku sdílené galerie imagí připojeného k tomuto plánu testovacího prostředí Při ukládání image virtuálního počítače šablony testovacího prostředí bude v této galerii zachována. Sdílené image z galerie je možné zpřístupnit při vytváření nových testovacích prostředí.
properties.supportInfo	SupportInfo	Kontaktní informace a pokyny podpory pro uživatele plánu testovacího prostředí Tyto informace se zobrazí vlastníkům testovacích prostředí a uživatelům virtuálních počítačů pro všechna testovací prostředí v plánu testovacího prostředí.
systemData	systemData	Metadata týkající se vytvoření a poslední změny plánu testovacího prostředí
tags	object	Značky prostředků
type	string	Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

LabPlanNetworkProfile

Objekt

Profil pro zpracování sítí pro plány testovacího prostředí

Name	Typ	Description
subnetId	string minLength: 3 maxLength: 2000	ID prostředku externí podsítě

ProvisioningState

Výčet

Aktuální stav zřizování plánu testovacího prostředí

Hodnota	Description
Creating	Prostředek probíhá při vytváření.
Updating	Na prostředek se použijí nové hodnoty vlastností.
Deleting	Prostředek probíhá v procesu odstranění.
Succeeded	Prostředek je po vytvoření nebo operaci aktualizace v pořádku.
Failed	Předchozí operace u prostředku selhala, protože prostředek není v pořádku.
Locked	Prostředek je uzamčený a změny jsou aktuálně blokované. Důvodem může být údržba nebo plánovaná operace. Jakmile se operace uzamčení dokončí, stav se vrátí k úspěšnému dokončení.

ResourceIdentityType

Výčet

Typ identity.

Hodnota	Description
SystemAssigned

ResourceOperationError

Objekt

Podrobnosti o chybě nejnovější operace u tohoto prostředku

Name	Typ	Description
action	string	Akce operace, která selhala
code	string	Kód odpovídající typu selhání operace
message	string	Zpráva o selhání operace
timestamp	string (date-time)	Datum a čas výskytu chyby

shutdownOnIdleMode

Výčet

Definuje, jestli se má virtuální počítač vypnout na nečinnosti, a kritéria pro detekci nečinnosti.

Hodnota	Description
None	Virtuální počítač se při nečinnosti nevypne.
UserAbsence	Virtuální počítač se bude považovat za nečinný, pokud není k dispozici vstup klávesnice nebo myši.
LowUsage	Virtuální počítač se bude považovat za nečinný, když uživatel chybí a spotřeba prostředků (procesoru a disku) je nízká.

SupportInfo

Objekt

Kontaktní informace a pokyny podpory.

Name	Typ	Description
email	string minLength: 6 maxLength: 254	Kontaktní e-mailová adresa podpory
instructions	string	Pokyny pro podporu.
phone	string minLength: 1 maxLength: 31	Kontaktujte telefonní číslo podpory.
url	string minLength: 3 maxLength: 2000	Webová adresa podpory

systemData

Objekt

Metadata týkající se vytvoření a poslední změny prostředku.

Name	Typ	Description
createdAt	string (date-time)	Časové razítko vytvoření prostředku (UTC).
createdBy	string	Identita, která prostředek vytvořila.
createdByType	createdByType	Typ identity, která prostředek vytvořila.
lastModifiedAt	string (date-time)	Časové razítko poslední změny zdroje (UTC)
lastModifiedBy	string	Identita, která naposledy změnila prostředek.
lastModifiedByType	createdByType	Typ identity, která naposledy změnila prostředek.

Sdílet prostřednictvím

Lab Plans - Create Or Update

Parametry identifikátoru URI

Text požadavku

Odpovědi

Příklady

putLabPlan

Ukázkový požadavek

Ukázková odpověď

Definice

AutoShutdownProfile

ConnectionProfile

ConnectionType

createdByType

EnableState

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

Identity

LabPlan

LabPlanNetworkProfile

ProvisioningState

ResourceIdentityType

ResourceOperationError

shutdownOnIdleMode

SupportInfo

systemData