Lab Plans - Create Or Update

Referenz

Dienst:: Lab Services

API-Version:: 2023-06-07

Aktualisiert oder erstellt eine Lab Plan-Ressource.
Vorgang zum Erstellen oder Aktualisieren einer Lab Plan-Ressource.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
labPlanName	path	True	string minLength: 1 maxLength: 100	Der Name des Laborplans, der ihn eindeutig innerhalb der Ressourcengruppe identifiziert. Wird in Ressourcen-URIs und in der Benutzeroberfläche verwendet.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string minLength: 1	Die ID des Zielabonnements.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
location	True	string	Der geografische Standort, an dem sich die Ressource befindet
identity		Identity	Verwaltete Identitätsinformationen
properties.allowedRegions		string[]	Die zulässigen Regionen für den Laborersteller, die beim Erstellen von Laboren mit diesem Lab-Plan verwendet werden sollen.
properties.defaultAutoShutdownProfile		AutoShutdownProfile	Das Standardprofil für das Herunterfahren des Labors. Dies kann in einer Lab-Ressource geändert werden und stellt nur ein Standardprofil bereit.
properties.defaultConnectionProfile		ConnectionProfile	Das Standardmäßige Lab-Verbindungsprofil. Dies kann in einer Lab-Ressource geändert werden und stellt nur ein Standardprofil bereit.
properties.defaultNetworkProfile		LabPlanNetworkProfile	Das Laborplan-Netzwerkprofil. Um Lab-Netzwerkrichtlinien zu erzwingen, müssen sie hier definiert werden und können nicht geändert werden, wenn diesem Laborplan vorhandene Labore zugeordnet sind.
properties.linkedLmsInstance		string minLength: 3 maxLength: 2000	Die Basis-URL der lms-Instanz, mit der dieser Lab-Plan Lab-Listen verknüpfen kann.
properties.sharedGalleryId		string minLength: 3 maxLength: 2000	Ressourcen-ID des freigegebenen Bildkatalogs, der diesem Laborplan zugeordnet ist. Beim Speichern eines virtuellen Laborvorlagenimages wird es in diesem Katalog beibehalten. Freigegebene Bilder aus dem Katalog können beim Erstellen neuer Labore zur Verfügung gestellt werden.
properties.supportInfo		SupportInfo	Supportkontaktinformationen und Anweisungen für Benutzer des Laborplans. Diese Informationen werden für Laborbesitzer und virtuelle Computerbenutzer für alle Labore im Laborplan angezeigt.
tags		object	Ressourcentags.

Antworten

Name	Typ	Beschreibung
200 OK	LabPlan	Das Update war erfolgreich; die Antwort enthält den Lab-Plan.
201 Created	LabPlan	Die Erstellung war erfolgreich; die Antwort enthält den Lab-Plan.
202 Accepted	LabPlan	Das Update war erfolgreich und hat einen langen Betrieb; die Antwort enthält den Lab-Plan.
Other Status Codes	ErrorResponse	Die Standardfehlerantwort.

Beispiele

putLabPlan

Beispielanforderung

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

Beispiel für eine Antwort

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

Definitionen

Name	Beschreibung
AutoShutdownProfile	Profil zum Behandeln des Herunterfahrens virtueller Computer.
ConnectionProfile	Verbindungsprofil für die Verbindung von Benutzern mit virtuellen Laborcomputern.
ConnectionType	Die aktivierte Zugriffsebene für Den Webzugriff über SSH.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
EnableState	Gibt an, ob das Herunterfahren beim Trennen aktiviert ist.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
Identity	Identität für die Ressource.
LabPlan	Lab-Pläne dienen als Berechtigungscontainer zum Erstellen von Laboren über labs.azure.com. Darüber hinaus können sie eine Reihe von Standardkonfigurationen bereitstellen, die zum Zeitpunkt der Erstellung eines Labors gelten, aber diese Standardwerte können weiterhin überschrieben werden.
LabPlanNetworkProfile	Profil zum Behandeln von Netzwerken für Lab-Pläne.
ProvisioningState	Aktueller Bereitstellungsstatus des Laborplans.
ResourceIdentityType	Der Identitätstyp.
ResourceOperationError	Fehlerdetails des neuesten Vorgangsfehlers für diese Ressource
shutdownOnIdleMode	Definiert, ob der virtuelle Computer im Leerlauf und die Kriterien für die Leerlauferkennung heruntergefahren werden sollen.
SupportInfo	Supportkontaktinformationen und Anweisungen.
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.

AutoShutdownProfile

Objekt

Profil zum Behandeln des Herunterfahrens virtueller Computer.

Name	Typ	Standardwert	Beschreibung
disconnectDelay	string (duration)		Der Zeitraum, in dem ein virtueller Computer ausgeführt wird, nachdem ein Benutzer die Verbindung getrennt hat, wenn dieses Verhalten aktiviert ist.
idleDelay	string (duration)		Der Zeitraum, in dem ein virtueller Computer im Leerlauf ist, bevor er heruntergefahren wird, wenn dieses Verhalten aktiviert ist.
noConnectDelay	string (duration)		Der Zeitraum, in dem ein virtueller Computer ausgeführt wird, bevor er heruntergefahren wird, wenn keine Verbindung hergestellt wird und dieses Verhalten aktiviert ist.
shutdownOnDisconnect	EnableState	Disabled	Gibt an, ob das Herunterfahren beim Trennen aktiviert ist.
shutdownOnIdle	shutdownOnIdleMode	None	Gibt an, ob ein virtueller Computer heruntergefahren wird, wenn er sich für einen bestimmten Zeitraum im Leerlauf befindet.
shutdownWhenNotConnected	EnableState	Disabled	Gibt an, ob ein virtueller Computer heruntergefahren wird, wenn er nach einem bestimmten Zeitraum noch nicht verbunden wurde.

ConnectionProfile

Objekt

Verbindungsprofil für die Verbindung von Benutzern mit virtuellen Laborcomputern.

Name	Typ	Standardwert	Beschreibung
clientRdpAccess	ConnectionType	None	Die aktivierte Zugriffsebene für den Clientzugriff über RDP.
clientSshAccess	ConnectionType	None	Die aktivierte Zugriffsebene für den Clientzugriff über SSH.
webRdpAccess	ConnectionType	None	Die aktivierte Zugriffsebene für Web Access über RDP.
webSshAccess	ConnectionType	None	Die aktivierte Zugriffsebene für Den Webzugriff über SSH.

ConnectionType

Enumeration

Die aktivierte Zugriffsebene für Den Webzugriff über SSH.

Wert	Beschreibung
None
Private
Public

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
Application
Key
ManagedIdentity
User

EnableState

Enumeration

Gibt an, ob das Herunterfahren beim Trennen aktiviert ist.

Wert	Beschreibung
Disabled
Enabled

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

Identity

Objekt

Identität für die Ressource.

Name	Typ	Beschreibung
principalId	string	Die Prinzipal-ID der Ressourcenidentität.
tenantId	string	Die Mandanten-ID der Ressource.
type	ResourceIdentityType	Der Identitätstyp.

LabPlan

Objekt

Lab-Pläne dienen als Berechtigungscontainer zum Erstellen von Laboren über labs.azure.com. Darüber hinaus können sie eine Reihe von Standardkonfigurationen bereitstellen, die zum Zeitpunkt der Erstellung eines Labors gelten, aber diese Standardwerte können weiterhin überschrieben werden.

Name	Typ	Beschreibung
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	Identity	Verwaltete Identitätsinformationen
location	string	Der geografische Standort, an dem sich die Ressource befindet
name	string	Der Name der Ressource
properties.allowedRegions	string[]	Die zulässigen Regionen für den Laborersteller, die beim Erstellen von Laboren mit diesem Lab-Plan verwendet werden sollen.
properties.defaultAutoShutdownProfile	AutoShutdownProfile	Das Standardprofil für das Herunterfahren des Labors. Dies kann in einer Lab-Ressource geändert werden und stellt nur ein Standardprofil bereit.
properties.defaultConnectionProfile	ConnectionProfile	Das Standardmäßige Lab-Verbindungsprofil. Dies kann in einer Lab-Ressource geändert werden und stellt nur ein Standardprofil bereit.
properties.defaultNetworkProfile	LabPlanNetworkProfile	Das Laborplan-Netzwerkprofil. Um Lab-Netzwerkrichtlinien zu erzwingen, müssen sie hier definiert werden und können nicht geändert werden, wenn diesem Laborplan vorhandene Labore zugeordnet sind.
properties.linkedLmsInstance	string minLength: 3 maxLength: 2000	Die Basis-URL der lms-Instanz, mit der dieser Lab-Plan Lab-Listen verknüpfen kann.
properties.provisioningState	ProvisioningState	Aktueller Bereitstellungsstatus des Laborplans.
properties.resourceOperationError	ResourceOperationError	Fehlerdetails des letzten Vorgangs, der im Laborplan ausgeführt wurde.
properties.sharedGalleryId	string minLength: 3 maxLength: 2000	Ressourcen-ID des freigegebenen Bildkatalogs, der diesem Laborplan zugeordnet ist. Beim Speichern eines virtuellen Laborvorlagenimages wird es in diesem Katalog beibehalten. Freigegebene Bilder aus dem Katalog können beim Erstellen neuer Labore zur Verfügung gestellt werden.
properties.supportInfo	SupportInfo	Supportkontaktinformationen und Anweisungen für Benutzer des Laborplans. Diese Informationen werden für Laborbesitzer und virtuelle Computerbenutzer für alle Labore im Laborplan angezeigt.
systemData	systemData	Metadaten zur Erstellung und letzten Änderung des Laborplans.
tags	object	Ressourcentags.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

LabPlanNetworkProfile

Objekt

Profil zum Behandeln von Netzwerken für Lab-Pläne.

Name	Typ	Beschreibung
subnetId	string minLength: 3 maxLength: 2000	Die ID der externen Subnetzressource

ProvisioningState

Enumeration

Aktueller Bereitstellungsstatus des Laborplans.

Wert	Beschreibung
Creating	Die Ressource wird gerade erstellt.
Deleting	Die Ressource wird gelöscht.
Failed	Der vorherige Vorgang für die Ressource ist fehlgeschlagen, wenn die Ressource im fehlerhaften Zustand verlassen wurde.
Locked	Die Ressource ist gesperrt, und Änderungen werden derzeit blockiert. Dies kann auf Wartung oder einen geplanten Betrieb zurückzuführen sein. Der Zustand wechselt zurück, um erfolgreich zu sein, nachdem der Sperrvorgang abgeschlossen ist.
Succeeded	Die Ressource befindet sich nach dem Erstellungs- oder Aktualisierungsvorgang im fehlerfreien Zustand.
Updating	Neue Eigenschaftswerte werden auf die Ressource angewendet.

ResourceIdentityType

Enumeration

Der Identitätstyp.

Wert	Beschreibung
SystemAssigned

ResourceOperationError

Objekt

Fehlerdetails des neuesten Vorgangsfehlers für diese Ressource

Name	Typ	Beschreibung
action	string	Die fehlgeschlagene Vorgangsaktion
code	string	Der Code, der dem Typ des Vorgangsfehlers entspricht
message	string	Fehlermeldung des Vorgangs
timestamp	string (date-time)	Datum und Uhrzeit des Auftretens des Fehlers

shutdownOnIdleMode

Enumeration

Definiert, ob der virtuelle Computer im Leerlauf und die Kriterien für die Leerlauferkennung heruntergefahren werden sollen.

Wert	Beschreibung
LowUsage	Der virtuelle Computer wird als Leerlauf betrachtet, wenn der Benutzer nicht vorhanden ist und der Ressourcenverbrauch (CPU und Datenträger) niedrig ist.
None	Der virtuelle Computer wird beim Leerlauf nicht heruntergefahren.
UserAbsence	Der virtuelle Computer wird als Leerlauf betrachtet, wenn keine Tastatur- oder Mauseingabe vorhanden ist.

SupportInfo

Objekt

Supportkontaktinformationen und Anweisungen.

Name	Typ	Beschreibung
email	string minLength: 6 maxLength: 254	E-Mail-Adresse des Supportkontakts.
instructions	string	Supportanweisungen.
phone	string minLength: 1 maxLength: 31	Telefonnummer des Supportkontakts.
url	string minLength: 3 maxLength: 2000	Support-Webadresse.

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.

Freigeben über

Lab Plans - Create Or Update

URI-Parameter

Anforderungstext

Antworten

Beispiele

putLabPlan

Beispielanforderung

Beispiel für eine Antwort

Definitionen

AutoShutdownProfile

ConnectionProfile

ConnectionType

createdByType

EnableState

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

Identity

LabPlan

LabPlanNetworkProfile

ProvisioningState

ResourceIdentityType

ResourceOperationError

shutdownOnIdleMode

SupportInfo

systemData