Lab Plans - Create Or Update

Service:: Lab Services

API-versie:: 2023-06-07

Hiermee wordt een labplanresource bijgewerkt of gemaakt.
Bewerking om een labplanresource te maken of bij te werken.

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

URI-parameters

Name	In	Vereist	Type	Description
labPlanName	path	True	string minLength: 1 maxLength: 100	De naam van het labplan dat het uniek identificeert binnen de resourcegroep. Wordt gebruikt in resource-URI's en in de gebruikersinterface.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
subscriptionId	path	True	string minLength: 1	De id van het doelabonnement.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagbody

Name	Vereist	Type	Description
location	True	string	De geografische locatie waar de resource zich bevindt
identity		Identity	Informatie over beheerde identiteit
properties.allowedRegions		string[]	De toegestane regio's die de maker van het lab kan gebruiken bij het maken van labs met behulp van dit labplan.
properties.defaultAutoShutdownProfile		AutoShutdownProfile	Het standaardprofiel voor het afsluiten van het lab. Dit kan worden gewijzigd in een labresource en biedt alleen een standaardprofiel.
properties.defaultConnectionProfile		ConnectionProfile	Het standaardprofiel voor labverbindingen. Dit kan worden gewijzigd in een labresource en biedt alleen een standaardprofiel.
properties.defaultNetworkProfile		LabPlanNetworkProfile	Het netwerkprofiel van het labplan. Als u beleidsregels voor labnetwerk wilt afdwingen, moeten ze hier worden gedefinieerd en kunnen ze niet worden gewijzigd wanneer er bestaande labs zijn gekoppeld aan dit labplan.
properties.linkedLmsInstance		string minLength: 3 maxLength: 2000	De basis-URL van het lms-exemplaar van dit labplan kan labroosters koppelen aan.
properties.sharedGalleryId		string minLength: 3 maxLength: 2000	Resource-id van de Shared Image Gallery die is gekoppeld aan dit labplan. Wanneer u een installatiekopieën van een virtuele labsjabloon opslaat, wordt deze in deze galerie bewaard. Gedeelde installatiekopieën uit de galerie kunnen beschikbaar worden gesteld voor gebruik bij het maken van nieuwe labs.
properties.supportInfo		SupportInfo	Contactgegevens en instructies voor ondersteuning voor gebruikers van het labplan. Deze informatie wordt weergegeven voor labeigenaren en gebruikers van virtuele machines voor alle labs in het labplan.
tags		object	Resourcetags.

Antwoorden

Name	Type	Description
200 OK	LabPlan	De update is voltooid; het antwoord bevat het labplan.
201 Created	LabPlan	Het maken is geslaagd; het antwoord bevat het labplan.
202 Accepted	LabPlan	De update is geslaagd en heeft een langdurige bewerking; het antwoord bevat het labplan.
Other Status Codes	ErrorResponse	Het standaardfoutantwoord.

Voorbeelden

putLabPlan

Voorbeeldaanvraag

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

Voorbeeldrespons

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

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

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

Definities

Name	Description
AutoShutdownProfile	Profiel voor het afhandelen van het afsluiten van virtuele machines.
ConnectionProfile	Verbindingsprofiel voor de wijze waarop gebruikers verbinding maken met virtuele machines van het lab.
ConnectionType	Het ingeschakelde toegangsniveau voor Web Access via SSH.
createdByType	Het type identiteit waarmee de resource is gemaakt.
EnableState	Of afsluiten bij verbreken is ingeschakeld
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
Identity	Identiteit voor de resource.
LabPlan	Labplannen fungeren als een machtigingscontainer voor het maken van labs via labs.azure.com. Daarnaast kunnen ze een set standaardconfiguraties opgeven die van toepassing zijn op het moment van het maken van een lab, maar deze standaardinstellingen kunnen nog steeds worden overschreven.
LabPlanNetworkProfile	Profiel voor het afhandelen van netwerken voor Lab Plans.
ProvisioningState	Huidige inrichtingsstatus van het labplan.
ResourceIdentityType	Het identiteitstype.
ResourceOperationError	Foutdetails van de meest recente bewerkingsfout voor deze resource
shutdownOnIdleMode	Hiermee definieert u of de VM moet worden afgesloten bij niet-actieve en de criteria voor inactiviteitsdetectie.
SupportInfo	Contactgegevens en instructies voor ondersteuning.
systemData	Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

AutoShutdownProfile

Object

Profiel voor het afhandelen van het afsluiten van virtuele machines.

Name	Type	Default value	Description
disconnectDelay	string (duration)		De hoeveelheid tijd die een VIRTUELE machine actief blijft nadat een gebruiker de verbinding heeft verbroken als dit gedrag is ingeschakeld.
idleDelay	string (duration)		De hoeveelheid tijd die een VIRTUELE machine inactief maakt voordat deze wordt afgesloten als dit gedrag is ingeschakeld.
noConnectDelay	string (duration)		De hoeveelheid tijd die een virtuele machine actief blijft voordat deze wordt afgesloten als er geen verbinding wordt gemaakt en dit gedrag is ingeschakeld.
shutdownOnDisconnect	EnableState	Disabled	Of afsluiten bij verbreken is ingeschakeld
shutdownOnIdle	shutdownOnIdleMode	None	Of een VIRTUELE machine wordt afgesloten wanneer deze gedurende een bepaalde periode inactief is.
shutdownWhenNotConnected	EnableState	Disabled	Of een VIRTUELE machine wordt afgesloten wanneer deze na een bepaalde periode niet is verbonden.

ConnectionProfile

Object

Verbindingsprofiel voor de wijze waarop gebruikers verbinding maken met virtuele machines van het lab.

Name	Type	Default value	Description
clientRdpAccess	ConnectionType	None	Het ingeschakelde toegangsniveau voor clienttoegang via RDP.
clientSshAccess	ConnectionType	None	Het ingeschakelde toegangsniveau voor clienttoegang via SSH.
webRdpAccess	ConnectionType	None	Het ingeschakelde toegangsniveau voor Web Access via RDP.
webSshAccess	ConnectionType	None	Het ingeschakelde toegangsniveau voor Web Access via SSH.

ConnectionType

Inventarisatie

Het ingeschakelde toegangsniveau voor Web Access via SSH.

Waarde	Description
Public
Private
None

createdByType

Inventarisatie

Het type identiteit waarmee de resource is gemaakt.

Waarde	Description
User
Application
ManagedIdentity
Key

EnableState

Inventarisatie

Of afsluiten bij verbreken is ingeschakeld

Waarde	Description
Enabled
Disabled

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

Object

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Object

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

Identity

Object

Identiteit voor de resource.

Name	Type	Description
principalId	string	De principal-id van de resource-id.
tenantId	string	De tenant-id van de resource.
type	ResourceIdentityType	Het identiteitstype.

LabPlan

Object

Labplannen fungeren als een machtigingscontainer voor het maken van labs via labs.azure.com. Daarnaast kunnen ze een set standaardconfiguraties opgeven die van toepassing zijn op het moment van het maken van een lab, maar deze standaardinstellingen kunnen nog steeds worden overschreven.

Name	Type	Description
id	string	Volledig gekwalificeerde resource-id voor de resource. Vb.: - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	Identity	Informatie over beheerde identiteit
location	string	De geografische locatie waar de resource zich bevindt
name	string	De naam van de resource
properties.allowedRegions	string[]	De toegestane regio's die de maker van het lab kan gebruiken bij het maken van labs met behulp van dit labplan.
properties.defaultAutoShutdownProfile	AutoShutdownProfile	Het standaardprofiel voor het afsluiten van het lab. Dit kan worden gewijzigd in een labresource en biedt alleen een standaardprofiel.
properties.defaultConnectionProfile	ConnectionProfile	Het standaardprofiel voor labverbindingen. Dit kan worden gewijzigd in een labresource en biedt alleen een standaardprofiel.
properties.defaultNetworkProfile	LabPlanNetworkProfile	Het netwerkprofiel van het labplan. Als u beleidsregels voor labnetwerk wilt afdwingen, moeten ze hier worden gedefinieerd en kunnen ze niet worden gewijzigd wanneer er bestaande labs zijn gekoppeld aan dit labplan.
properties.linkedLmsInstance	string minLength: 3 maxLength: 2000	De basis-URL van het lms-exemplaar van dit labplan kan labroosters koppelen aan.
properties.provisioningState	ProvisioningState	Huidige inrichtingsstatus van het labplan.
properties.resourceOperationError	ResourceOperationError	Foutdetails van de laatste bewerking die is uitgevoerd in het labplan.
properties.sharedGalleryId	string minLength: 3 maxLength: 2000	Resource-id van de Shared Image Gallery die is gekoppeld aan dit labplan. Wanneer u een installatiekopieën van een virtuele labsjabloon opslaat, wordt deze in deze galerie bewaard. Gedeelde installatiekopieën uit de galerie kunnen beschikbaar worden gesteld voor gebruik bij het maken van nieuwe labs.
properties.supportInfo	SupportInfo	Contactgegevens en instructies voor ondersteuning voor gebruikers van het labplan. Deze informatie wordt weergegeven voor labeigenaren en gebruikers van virtuele machines voor alle labs in het labplan.
systemData	systemData	Metagegevens met betrekking tot het maken en de laatste wijziging van het labplan.
tags	object	Resourcetags.
type	string	Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

LabPlanNetworkProfile

Object

Profiel voor het afhandelen van netwerken voor Lab Plans.

Name	Type	Description
subnetId	string minLength: 3 maxLength: 2000	De resource-id van het externe subnet

ProvisioningState

Inventarisatie

Huidige inrichtingsstatus van het labplan.

Waarde	Description
Creating	De resource wordt gemaakt.
Updating	Nieuwe eigenschapswaarden worden toegepast op de resource.
Deleting	De resource wordt verwijderd.
Succeeded	De resource heeft de status In orde na het maken of bijwerken.
Failed	De vorige bewerking voor de resource is mislukt, waardoor de resource niet in orde is.
Locked	De resource is vergrendeld en wijzigingen worden momenteel geblokkeerd. Dit kan worden veroorzaakt door onderhoud of een geplande bewerking. De status wordt weer voltooid zodra de vergrendelingsbewerking is voltooid.

ResourceIdentityType

Inventarisatie

Het identiteitstype.

Waarde	Description
SystemAssigned

ResourceOperationError

Object

Foutdetails van de meest recente bewerkingsfout voor deze resource

Name	Type	Description
action	string	De bewerkingsactie die is mislukt
code	string	De code die overeenkomt met het type bewerkingsfout
message	string	Het foutbericht over de bewerking
timestamp	string (date-time)	De datum/tijd waarop de fout is opgetreden

shutdownOnIdleMode

Inventarisatie

Hiermee definieert u of de VM moet worden afgesloten bij niet-actieve en de criteria voor inactiviteitsdetectie.

Waarde	Description
None	De VIRTUELE machine wordt niet afgesloten wanneer deze niet actief is.
UserAbsence	De VIRTUELE machine wordt beschouwd als niet-actief wanneer er geen toetsenbord- of muisinvoer is.
LowUsage	De VM wordt beschouwd als niet-actief wanneer de gebruiker afwezig is en het verbruik van de resource (CPU en schijf) laag is.

SupportInfo

Object

Contactgegevens en instructies voor ondersteuning.

Name	Type	Description
email	string minLength: 6 maxLength: 254	E-mailadres van ondersteuningsmedewerker.
instructions	string	Ondersteuningsinstructies.
phone	string minLength: 1 maxLength: 31	Telefoonnummer van ondersteuningscontactpersoon.
url	string minLength: 3 maxLength: 2000	Ondersteuningswebadres.

systemData

Object

Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

Name	Type	Description
createdAt	string (date-time)	De tijdstempel van het maken van resources (UTC).
createdBy	string	De identiteit waarmee de resource is gemaakt.
createdByType	createdByType	Het type identiteit waarmee de resource is gemaakt.
lastModifiedAt	string (date-time)	De tijdstempel van de laatste wijziging van de resource (UTC)
lastModifiedBy	string	De identiteit die de resource voor het laatst heeft gewijzigd.
lastModifiedByType	createdByType	Het type identiteit dat de resource voor het laatst heeft gewijzigd.

Delen via

Lab Plans - Create Or Update

URI-parameters

Aanvraagbody

Antwoorden

Voorbeelden

putLabPlan

Voorbeeldaanvraag

Voorbeeldrespons

Definities

AutoShutdownProfile

ConnectionProfile

ConnectionType

createdByType

EnableState

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

Identity

LabPlan

LabPlanNetworkProfile

ProvisioningState

ResourceIdentityType

ResourceOperationError

shutdownOnIdleMode

SupportInfo

systemData