Lab Plans - Create Or Update

Aktualizace 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=2022-08-01

Parametry identifikátoru URI

Name In Required Type Description
labPlanName
path True
  • string

Název plánu testovacího prostředí, který ho jednoznačně identifikuje v rámci skupiny prostředků. Používá se v identifikátorech URI prostředků a v uživatelském rozhraní.

resourceGroupName
path True
  • string

Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.

subscriptionId
path True
  • string

ID cílového předplatného.

api-version
query True
  • string

Verze rozhraní API, která se má použít pro tuto operaci.

Text požadavku

Name Required Type Description
location True
  • string

Geografické umístění, kde se prostředek nachází

identity

Informace o spravované identitě

properties.allowedRegions
  • string[]

Povolené oblasti pro tvůrce testovacího prostředí, které se mají použít při vytváření testovacích prostředí pomocí tohoto plánu testovacího prostředí.

properties.defaultAutoShutdownProfile

Výchozí profil vypnutí testovacího prostředí To lze změnit u prostředku testovacího prostředí a poskytuje pouze výchozí profil.

properties.defaultConnectionProfile

Výchozí profil připojení testovacího prostředí To lze změnit u prostředku testovacího prostředí a poskytuje pouze výchozí profil.

properties.defaultNetworkProfile

Profil sítě plánu testovacího prostředí Pokud chcete vynutit zásady sítě testovacích prostředí, musí být zde definovány a nelze je změnit, pokud existují existující testovací prostředí přidružená k tomuto plánu testovacího prostředí.

properties.linkedLmsInstance
  • string

Základní adresa URL instance lms může tento plán testovacího prostředí propojit s seznamy testovacích prostředí.

properties.sharedGalleryId
  • string

ID prostředku Shared Image Gallery připojené 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é obrázky z galerie je možné zpřístupnit při vytváření nových testovacích prostředí.

properties.supportInfo

Podpora kontaktních informací a pokynů 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 Type Description
200 OK

Aktualizace byla úspěšná; odpověď obsahuje plán testovacího prostředí.

201 Created

Vytvoření bylo úspěšné; odpověď obsahuje plán testovacího prostředí.

202 Accepted

Aktualizace byla úspěšná a má dlouho běžící operaci; odpověď obsahuje plán testovacího prostředí.

Other Status Codes

Výchozí chybová odpověď.

Příklady

putLabPlan

Sample Request

PUT https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.LabServices/labPlans/testlabplan?api-version=2022-08-01

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

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

AutoShutdownProfile

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

ConnectionProfile

Profil připojení pro způsob připojení uživatelů k testovacím virtuálním počítačům.

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 poskytovat sadu výchozích konfigurací, které se použijí při vytváření testovacího prostředí, ale tyto výchozí hodnoty se dají 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.

shutdownOnIdleMode

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

SupportInfo

Podpora kontaktních informací a pokynů

systemData

Metadata související s vytvořením a poslední úpravou prostředku

AutoShutdownProfile

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

Name Type Default Value Description
disconnectDelay
  • string

Doba, po kterou bude virtuální počítač běžet, když se uživatel odpojí, pokud je toto chování povolené.

idleDelay
  • string

Doba nečinnosti virtuálního počítače před vypnutím, pokud je toto chování povolené.

noConnectDelay
  • string

Doba, po kterou bude virtuální počítač běžet, než se vypne, pokud se nevyvolá žádné připojení a toto chování je povolené.

shutdownOnDisconnect Disabled

Jestli je povolené vypnutí při odpojení

shutdownOnIdle None

Určuje, jestli se virtuální počítač vypne, když se po určitou dobu zdědí.

shutdownWhenNotConnected Disabled

Jestli se virtuální počítač po určité době nepřipojí k virtuálnímu počítači, bude vypnutý.

ConnectionProfile

Profil připojení pro způsob připojení uživatelů k testovacím virtuálním počítačům.

Name Type Default Value Description
clientRdpAccess None

Povolená úroveň přístupu pro klientský přístup přes protokol RDP.

clientSshAccess None

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

webRdpAccess None

Povolená úroveň přístupu pro webový přístup přes protokol RDP.

webSshAccess None

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

ConnectionType

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

Name Type Description
None
  • string
Private
  • string
Public
  • string

createdByType

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

Name Type Description
Application
  • string
Key
  • string
ManagedIdentity
  • string
User
  • string

EnableState

Jestli je povolené vypnutí při odpojení

Name Type Description
Disabled
  • string
Enabled
  • string

ErrorAdditionalInfo

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

Name Type Description
info
  • object

Další informace.

type
  • string

Další typ informací.

ErrorDetail

Podrobnosti o chybě.

Name Type Description
additionalInfo

Další informace o chybě.

code
  • string

Kód chyby

details

Podrobnosti o chybě.

message
  • string

Chybová zpráva

target
  • string

Cíl chyby.

ErrorResponse

Chybová odpověď

Name Type Description
error

Objekt chyby.

Identity

Identita prostředku

Name Type Description
principalId
  • string

ID objektu zabezpečení identity prostředku.

tenantId
  • string

ID tenanta prostředku.

type

Typ identity.

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 poskytovat sadu výchozích konfigurací, které se použijí při vytváření testovacího prostředí, ale tyto výchozí hodnoty se dají přepsat.

Name Type Description
id
  • string

Plně kvalifikované ID prostředku pro daný prostředek. Příklad – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

identity

Informace o spravované identitě

location
  • string

Geografické umístění, kde se prostředek nachází

name
  • string

Název prostředku

properties.allowedRegions
  • string[]

Povolené oblasti pro tvůrce testovacího prostředí, které se mají použít při vytváření testovacích prostředí pomocí tohoto plánu testovacího prostředí.

properties.defaultAutoShutdownProfile

Výchozí profil vypnutí testovacího prostředí To lze změnit u prostředku testovacího prostředí a poskytuje pouze výchozí profil.

properties.defaultConnectionProfile

Výchozí profil připojení testovacího prostředí To lze změnit u prostředku testovacího prostředí a poskytuje pouze výchozí profil.

properties.defaultNetworkProfile

Profil sítě plánu testovacího prostředí Pokud chcete vynutit zásady sítě testovacích prostředí, musí být zde definovány a nelze je změnit, pokud existují existující testovací prostředí přidružená k tomuto plánu testovacího prostředí.

properties.linkedLmsInstance
  • string

Základní adresa URL instance lms může tento plán testovacího prostředí propojit s seznamy testovacích prostředí.

properties.provisioningState

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

properties.sharedGalleryId
  • string

ID prostředku Shared Image Gallery připojené 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é obrázky z galerie je možné zpřístupnit při vytváření nových testovacích prostředí.

properties.supportInfo

Podpora kontaktních informací a pokynů 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

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

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

Name Type Description
subnetId
  • string

ID prostředku externí podsítě

ProvisioningState

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

Name Type Description
Creating
  • string

Prostředek probíhá v procesu vytváření.

Deleting
  • string

Prostředek probíhá v procesu odstranění.

Failed
  • string

Předchozí operace prostředku selhala, protože prostředek nebyl v pořádku.

Locked
  • string

Prostředek je uzamčený a změny jsou aktuálně zablokované. Důvodem může být údržba nebo plánovaná operace. Stav se vrátí zpět k úspěšnému po dokončení operace uzamčení.

Succeeded
  • string

Prostředek je po vytvoření nebo operaci aktualizace v pořádku.

Updating
  • string

Na prostředek se použijí nové hodnoty vlastností.

ResourceIdentityType

Typ identity.

Name Type Description
SystemAssigned
  • string

shutdownOnIdleMode

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

Name Type Description
LowUsage
  • string

Virtuální počítač bude považován za nečinný, pokud uživatel chybí a spotřeba prostředků (procesoru a disku) je nízká.

None
  • string

Virtuální počítač nebude vypnutý, když je nečinný.

UserAbsence
  • string

Virtuální počítač bude považován za nečinný, pokud není k dispozici žádná klávesnice nebo vstup myši.

SupportInfo

Podpora kontaktních informací a pokynů

Name Type Description
email
  • string

Kontaktní e-mailová adresa podpory

instructions
  • string

Pokyny k podpoře

phone
  • string

Kontaktujte telefonní číslo podpory.

url
  • string

Webová adresa podpory

systemData

Metadata související s vytvořením a poslední úpravou prostředku

Name Type Description
createdAt
  • string

Časové razítko vytvoření prostředku (UTC).

createdBy
  • string

Identita, která prostředek vytvořila.

createdByType

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

lastModifiedAt
  • string

Časové razítko poslední změny zdroje (UTC)

lastModifiedBy
  • string

Identita, která naposledy změnila prostředek.

lastModifiedByType

Typ identity, která naposledy změnila prostředek.