Lab Plans - Create Or Update

Referencia

Szolgáltatás:: Lab Services

API-verzió:: 2023-06-07

Frissíti vagy létrehozza a tesztkörnyezetterv-erőforrást.
Tesztkörnyezetterv-erőforrás létrehozásához vagy frissítéséhez szükséges művelet.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
labPlanName	path	True	string minLength: 1 maxLength: 100	Annak a labortervnek a neve, amely egyedileg azonosítja azt az erőforráscsoporton belül. Erőforrás-URI-kban és felhasználói felületen használatos.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
subscriptionId	path	True	string minLength: 1	A cél-előfizetés azonosítója.
api-version	query	True	string minLength: 1	A művelethez használni kívánt API-verzió.

Kérelem törzse

Name	Kötelező	Típus	Description
location	True	string	Az a földrajzi hely, ahol az erőforrás él
identity		Identity	Felügyelt identitás adatai
properties.allowedRegions		string[]	A tesztkörnyezet létrehozójának engedélyezett régiói, amelyek felhasználhatók tesztkörnyezetek létrehozásakor ezzel a tesztkörnyezettervvel.
properties.defaultAutoShutdownProfile		AutoShutdownProfile	Az alapértelmezett tesztkörnyezetleállítási profil. Ez egy tesztkörnyezeti erőforráson módosítható, és csak egy alapértelmezett profilt biztosít.
properties.defaultConnectionProfile		ConnectionProfile	Az alapértelmezett tesztkörnyezeti kapcsolatprofil. Ez egy tesztkörnyezeti erőforráson módosítható, és csak egy alapértelmezett profilt biztosít.
properties.defaultNetworkProfile		LabPlanNetworkProfile	A laborterv hálózati profilja. A laborhálózati szabályzatok érvényesítéséhez itt kell definiálni őket, és nem módosíthatók, ha a labortervhez meglévő laborok vannak társítva.
properties.linkedLmsInstance		string minLength: 3 maxLength: 2000	Az lms-példány alap URL-címe, amelyhez a tesztkörnyezet-terv csatolhatja a labornévsorokat.
properties.sharedGalleryId		string minLength: 3 maxLength: 2000	A labortervhez csatolt megosztott képgyűjtemény erőforrás-azonosítója. Tesztkörnyezetsablon virtuálisgép-lemezképének mentésekor az ebben a gyűjteményben marad meg. A katalógusból származó megosztott képek felhasználhatók új tesztkörnyezetek létrehozásakor.
properties.supportInfo		SupportInfo	Támogatási kapcsolattartási információk és utasítások a tesztkörnyezeti terv felhasználói számára. Ezek az információk megjelennek a tesztkörnyezet tulajdonosai és a virtuálisgép-felhasználók számára a tesztkörnyezet-terv összes tesztkörnyezetében.
tags		object	Erőforráscímkék.

Válaszok

Name	Típus	Description
200 OK	LabPlan	A frissítés sikeres volt; válasz tartalmazza a tesztkörnyezettervet.
201 Created	LabPlan	A létrehozás sikeres volt; válasz tartalmazza a tesztkörnyezettervet.
202 Accepted	LabPlan	A frissítés sikeres volt, és hosszú ideig futó művelettel rendelkezik; válasz tartalmazza a tesztkörnyezettervet.
Other Status Codes	ErrorResponse	Az alapértelmezett hibaválasz.

Példák

putLabPlan

Mintakérelem

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

Mintaválasz

Állapotkó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."
    }
  }
}

Állapotkó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."
    }
  }
}

Állapotkó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."
    }
  }
}

Definíciók

Name	Description
AutoShutdownProfile	Profil a virtuális gépek leállításának kezeléséhez.
ConnectionProfile	Kapcsolatprofil a felhasználók tesztkörnyezeti virtuális gépekhez való kapcsolódásához.
ConnectionType	A Webes hozzáférés engedélyezett hozzáférési szintje SSH-kapcsolaton keresztül.
createdByType	Az erőforrást létrehozó identitás típusa.
EnableState	Azt jelzi, hogy engedélyezve van-e a leállítás a kapcsolat bontásakor
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Hibaválasz
Identity	Az erőforrás identitása.
LabPlan	A tesztkörnyezettervek engedélytárolóként működnek a tesztkörnyezetek labs.azure.com keresztüli létrehozásához. Emellett olyan alapértelmezett konfigurációkat is megadhatnak, amelyek a tesztkörnyezet létrehozásakor érvényesek lesznek, de ezek az alapértelmezett beállítások továbbra is felülírhatók.
LabPlanNetworkProfile	Profil a labortervek hálózatkezeléséhez.
ProvisioningState	A laborterv jelenlegi kiépítési állapota.
ResourceIdentityType	Az identitás típusa.
ResourceOperationError	Az erőforrás legutóbbi művelethibájának hibaadatai
shutdownOnIdleMode	Meghatározza, hogy a virtuális gépet inaktív állapotban kell-e leállítani, és hogy milyen feltételek teljesülnek az inaktív állapot észleléséhez.
SupportInfo	Támogatási kapcsolattartási információk és utasítások.
systemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

AutoShutdownProfile

Objektum

Profil a virtuális gépek leállításának kezeléséhez.

Name	Típus	Alapértelmezett érték	Description
disconnectDelay	string (duration)		A virtuális gép futási ideje a felhasználó leválasztása után, ha ez a viselkedés engedélyezve van.
idleDelay	string (duration)		A virtuális gép leállítása előtt üresjárati idő, ha ez a viselkedés engedélyezve van.
noConnectDelay	string (duration)		A virtuális gép futási ideje a leállítás előtt, ha nincs kapcsolat, és ez a viselkedés engedélyezve van.
shutdownOnDisconnect	EnableState	Disabled	Azt jelzi, hogy engedélyezve van-e a leállítás a kapcsolat bontásakor
shutdownOnIdle	shutdownOnIdleMode	None	Azt jelzi, hogy egy virtuális gép le lesz-e állítva, amikor egy ideig inaktív.
shutdownWhenNotConnected	EnableState	Disabled	Azt jelzi, hogy egy virtuális gép le lesz-e állítva, ha egy idő után nem csatlakozott hozzá.

ConnectionProfile

Objektum

Kapcsolatprofil a felhasználók tesztkörnyezeti virtuális gépekhez való kapcsolódásához.

Name	Típus	Alapértelmezett érték	Description
clientRdpAccess	ConnectionType	None	Az rdp-en keresztüli ügyfélhozzáférés engedélyezett hozzáférési szintje.
clientSshAccess	ConnectionType	None	Az ügyfélhozzáférés engedélyezett hozzáférési szintje SSH-kapcsolaton keresztül.
webRdpAccess	ConnectionType	None	A webes hozzáférés rdp-en keresztüli engedélyezett hozzáférési szintje.
webSshAccess	ConnectionType	None	A Webes hozzáférés engedélyezett hozzáférési szintje SSH-kapcsolaton keresztül.

ConnectionType

Enumerálás

A Webes hozzáférés engedélyezett hozzáférési szintje SSH-kapcsolaton keresztül.

Érték	Description
None
Private
Public

createdByType

Enumerálás

Az erőforrást létrehozó identitás típusa.

Érték	Description
Application
Key
ManagedIdentity
User

EnableState

Enumerálás

Azt jelzi, hogy engedélyezve van-e a leállítás a kapcsolat bontásakor

Érték	Description
Disabled
Enabled

ErrorAdditionalInfo

Objektum

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további információtípus.

ErrorDetail

Objektum

A hiba részletei.

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorDetail[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hibacél.

ErrorResponse

Objektum

Hibaválasz

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

Identity

Objektum

Az erőforrás identitása.

Name	Típus	Description
principalId	string	Az erőforrás-identitás egyszerű azonosítója.
tenantId	string	Az erőforrás bérlőazonosítója.
type	ResourceIdentityType	Az identitás típusa.

LabPlan

Objektum

A tesztkörnyezettervek engedélytárolóként működnek a tesztkörnyezetek labs.azure.com keresztüli létrehozásához. Emellett olyan alapértelmezett konfigurációkat is megadhatnak, amelyek a tesztkörnyezet létrehozásakor érvényesek lesznek, de ezek az alapértelmezett beállítások továbbra is felülírhatók.

Name	Típus	Description
id	string	Az erőforrás teljes erőforrás-azonosítója. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	Identity	Felügyelt identitás adatai
location	string	Az a földrajzi hely, ahol az erőforrás él
name	string	Az erőforrás neve
properties.allowedRegions	string[]	A tesztkörnyezet létrehozójának engedélyezett régiói, amelyek felhasználhatók tesztkörnyezetek létrehozásakor ezzel a tesztkörnyezettervvel.
properties.defaultAutoShutdownProfile	AutoShutdownProfile	Az alapértelmezett tesztkörnyezetleállítási profil. Ez egy tesztkörnyezeti erőforráson módosítható, és csak egy alapértelmezett profilt biztosít.
properties.defaultConnectionProfile	ConnectionProfile	Az alapértelmezett tesztkörnyezeti kapcsolatprofil. Ez egy tesztkörnyezeti erőforráson módosítható, és csak egy alapértelmezett profilt biztosít.
properties.defaultNetworkProfile	LabPlanNetworkProfile	A laborterv hálózati profilja. A laborhálózati szabályzatok érvényesítéséhez itt kell definiálni őket, és nem módosíthatók, ha a labortervhez meglévő laborok vannak társítva.
properties.linkedLmsInstance	string minLength: 3 maxLength: 2000	Az lms-példány alap URL-címe, amelyhez a tesztkörnyezet-terv csatolhatja a labornévsorokat.
properties.provisioningState	ProvisioningState	A laborterv jelenlegi kiépítési állapota.
properties.resourceOperationError	ResourceOperationError	A tesztkörnyezeti terv legutóbbi műveletének hibaadatai.
properties.sharedGalleryId	string minLength: 3 maxLength: 2000	A labortervhez csatolt megosztott képgyűjtemény erőforrás-azonosítója. Tesztkörnyezetsablon virtuálisgép-lemezképének mentésekor az ebben a gyűjteményben marad meg. A katalógusból származó megosztott képek felhasználhatók új tesztkörnyezetek létrehozásakor.
properties.supportInfo	SupportInfo	Támogatási kapcsolattartási információk és utasítások a tesztkörnyezeti terv felhasználói számára. Ezek az információk megjelennek a tesztkörnyezet tulajdonosai és a virtuálisgép-felhasználók számára a tesztkörnyezet-terv összes tesztkörnyezetében.
systemData	systemData	A laborterv létrehozásával és utolsó módosításával kapcsolatos metaadatok.
tags	object	Erőforráscímkék.
type	string	Az erőforrás típusa. Pl. "Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"

LabPlanNetworkProfile

Objektum

Profil a labortervek hálózatkezeléséhez.

Name	Típus	Description
subnetId	string minLength: 3 maxLength: 2000	A külső alhálózati erőforrás azonosítója

ProvisioningState

Enumerálás

A laborterv jelenlegi kiépítési állapota.

Érték	Description
Creating	Az erőforrás létrehozása folyamatban van.
Deleting	Az erőforrás törlése folyamatban van.
Failed	Az erőforrás előző művelete sikertelen volt, így az erőforrás nem kifogástalan állapotban maradt.
Locked	Az erőforrás zárolva van, és a módosítások jelenleg le vannak tiltva. Ennek oka lehet karbantartás vagy ütemezett művelet. Az állapot a zárolási művelet befejeződése után ismét sikeres lesz.
Succeeded	Az erőforrás kifogástalan állapotban van a létrehozás vagy a frissítési művelet után.
Updating	Új tulajdonságértékek lesznek alkalmazva az erőforrásra.

ResourceIdentityType

Enumerálás

Az identitás típusa.

Érték	Description
SystemAssigned

ResourceOperationError

Objektum

Az erőforrás legutóbbi művelethibájának hibaadatai

Name	Típus	Description
action	string	A sikertelen művelet
code	string	A művelethiba típusának megfelelő kód
message	string	A művelet sikertelenségét jelző üzenet
timestamp	string (date-time)	A hiba bekövetkezésének dátuma

shutdownOnIdleMode

Enumerálás

Meghatározza, hogy a virtuális gépet inaktív állapotban kell-e leállítani, és hogy milyen feltételek teljesülnek az inaktív állapot észleléséhez.

Érték	Description
LowUsage	A virtuális gép tétlennek minősül, ha a felhasználó hiányzik, és az erőforrás (CPU és lemez) használata alacsony.
None	A virtuális gép tétlen állapotban nem lesz leállítva.
UserAbsence	A virtuális gép tétlennek minősül, ha nincs billentyűzet- vagy egérbemenet.

SupportInfo

Objektum

Támogatási kapcsolattartási információk és utasítások.

Name	Típus	Description
email	string minLength: 6 maxLength: 254	Támogatási kapcsolattartó e-mail-címe.
instructions	string	Támogatási utasítások.
phone	string minLength: 1 maxLength: 31	Támogatási kapcsolattartó telefonszáma.
url	string minLength: 3 maxLength: 2000	Támogatási webcím.

systemData

Objektum

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

Name	Típus	Description
createdAt	string (date-time)	Az erőforrás-létrehozás időbélyege (UTC).
createdBy	string	Az erőforrást létrehozó identitás.
createdByType	createdByType	Az erőforrást létrehozó identitás típusa.
lastModifiedAt	string (date-time)	Az erőforrás utolsó módosításának időbélyege (UTC)
lastModifiedBy	string	Az erőforrást legutóbb módosító identitás.
lastModifiedByType	createdByType	Az erőforrást legutóbb módosító identitás típusa.

Megosztás a következőn keresztül:

Lab Plans - Create Or Update

URI-paraméterek

Kérelem törzse

Válaszok

Példák

putLabPlan

Mintakérelem

Mintaválasz

Definíciók

AutoShutdownProfile

ConnectionProfile

ConnectionType

createdByType

EnableState

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

Identity

LabPlan

LabPlanNetworkProfile

ProvisioningState

ResourceIdentityType

ResourceOperationError

shutdownOnIdleMode

SupportInfo

systemData

További források