Freigeben über


Lab Plans - Create Or Update

Updates oder erstellt eine Labplanressource.
Vorgang zum Erstellen oder Aktualisieren einer Labplanressource.

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

Der Name des Labplans, der ihn innerhalb einer ressourcenhaltigen Gruppe eindeutig identifiziert. Wird in Ressourcen-URIs und in der Benutzeroberfläche verwendet.

resourceGroupName
path True

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

subscriptionId
path True

string

Hierbei handelt es sich um die ID des Zielabonnements.

api-version
query True

string

Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Anforderungstext

Name Erforderlich Typ Beschreibung
location True

string

Der geografische Standort, an dem sich die Ressource befindet

identity

Identity

Informationen zu verwalteten Identitäten

properties.allowedRegions

string[]

Die zulässigen Regionen, die der Labersteller beim Erstellen von Labs mit diesem Labplan verwenden darf.

properties.defaultAutoShutdownProfile

AutoShutdownProfile

Das Standardprofil zum Herunterfahren des Labs. Dies kann für eine Labressource geändert werden und stellt nur ein Standardprofil bereit.

properties.defaultConnectionProfile

ConnectionProfile

Das Standard-Labverbindungsprofil. Dies kann für eine Labressource geändert werden und stellt nur ein Standardprofil bereit.

properties.defaultNetworkProfile

LabPlanNetworkProfile

Das Netzwerkprofil des Labplans. Zum Erzwingen von Labnetzwerkrichtlinien müssen sie hier definiert werden und können nicht geändert werden, wenn diesem Labplan vorhandene Labs zugeordnet sind.

properties.linkedLmsInstance

string

Basis-URL der lms instance mit der dieser Labplan Lab-Roster verknüpfen kann.

properties.sharedGalleryId

string

Ressourcen-ID des Shared Image Gallery diesem Labplan angefügt. Beim Speichern eines Vm-Images für eine Labvorlage wird es in diesem Katalog beibehalten. Freigegebene Images aus dem Katalog können für die Verwendung beim Erstellen neuer Labs zur Verfügung gestellt werden.

properties.supportInfo

SupportInfo

Supportkontaktinformationen und Anweisungen für Benutzer des Labplans. Diese Informationen werden Labbesitzern und Benutzern virtueller Computer für alle Labs im Labplan angezeigt.

tags

object

Ressourcentags.

Antworten

Name Typ Beschreibung
200 OK

LabPlan

Das Update war erfolgreich; response enthält den Labplan.

201 Created

LabPlan

Die Erstellung war erfolgreich; response enthält den Labplan.

202 Accepted

LabPlan

Das Update war erfolgreich und hat einen lang andauernden Vorgang. response enthält den Labplan.

Other Status Codes

ErrorResponse

Die Standardfehlerantwort.

Beispiele

putLabPlan

Beispielanforderung

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

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

Definitionen

Name Beschreibung
AutoShutdownProfile

Profil für den Umgang mit dem Herunterfahren virtueller Computer.

ConnectionProfile

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

ConnectionType

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

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

EnableState

Ob das Herunterfahren bei Trennung aktiviert ist

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

ErrorDetail

Die Fehlerdetails.

ErrorResponse

Fehlerantwort

Identity

Identität für die Ressource.

LabPlan

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

LabPlanNetworkProfile

Profil zum Behandeln von Netzwerken für Labpläne.

ProvisioningState

Aktueller Bereitstellungsstatus des Labplans.

ResourceIdentityType

Der Identitätstyp.

ResourceOperationError

Fehlerdetails des letzten Vorgangsfehlers für diese Ressource

shutdownOnIdleMode

Definiert, ob die VM im Leerlauf heruntergefahren werden soll, und die Kriterien für die Leerlauferkennung.

SupportInfo

Supportkontaktinformationen und Anweisungen.

systemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

AutoShutdownProfile

Profil für den Umgang mit dem Herunterfahren virtueller Computer.

Name Typ Standardwert Beschreibung
disconnectDelay

string

Die Dauer, in der eine VM ausgeführt wird, nachdem ein Benutzer die Verbindung getrennt hat, wenn dieses Verhalten aktiviert ist.

idleDelay

string

Die Zeitspanne, die eine VM im Leerlauf befindet, bevor sie heruntergefahren wird, wenn dieses Verhalten aktiviert ist.

noConnectDelay

string

Die Dauer, in der eine VM ausgeführt wird, bevor sie heruntergefahren wird, wenn keine Verbindung hergestellt wird und dieses Verhalten aktiviert ist.

shutdownOnDisconnect

EnableState

Disabled

Ob das Herunterfahren bei Trennung aktiviert ist

shutdownOnIdle

shutdownOnIdleMode

None

Gibt an, ob ein virtueller Computer heruntergefahren wird, wenn er für einen bestimmten Zeitraum im Leerlauf ist.

shutdownWhenNotConnected

EnableState

Disabled

Gibt an, ob ein virtueller Computer heruntergefahren wird, wenn er nach einem bestimmten Zeitraum nicht mehr verbunden wurde.

ConnectionProfile

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

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 Den Webzugriff über RDP.

webSshAccess

ConnectionType

None

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

ConnectionType

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

Name Typ Beschreibung
None

string

Private

string

Public

string

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

Name Typ Beschreibung
Application

string

Key

string

ManagedIdentity

string

User

string

EnableState

Ob das Herunterfahren bei Trennung aktiviert ist

Name Typ Beschreibung
Disabled

string

Enabled

string

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

Name Typ Beschreibung
info

object

Zusätzliche Informationen.

type

string

Typ der zusätzlichen Informationen.

ErrorDetail

Die Fehlerdetails.

Name Typ Beschreibung
additionalInfo

ErrorAdditionalInfo[]

Die zusätzlichen Fehlerinformationen.

code

string

Der Fehlercode.

details

ErrorDetail[]

Die Fehlerdetails.

message

string

Die Fehlermeldung.

target

string

Das Fehlerziel.

ErrorResponse

Fehlerantwort

Name Typ Beschreibung
error

ErrorDetail

Das Fehlerobjekt.

Identity

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

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

Name Typ Beschreibung
id

string

Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

identity

Identity

Informationen zu verwalteten Identitäten

location

string

Der geografische Standort, an dem sich die Ressource befindet

name

string

Der Name der Ressource

properties.allowedRegions

string[]

Die zulässigen Regionen, die der Labersteller beim Erstellen von Labs mit diesem Labplan verwenden darf.

properties.defaultAutoShutdownProfile

AutoShutdownProfile

Das Standardprofil zum Herunterfahren des Labs. Dies kann für eine Labressource geändert werden und stellt nur ein Standardprofil bereit.

properties.defaultConnectionProfile

ConnectionProfile

Das Standard-Labverbindungsprofil. Dies kann für eine Labressource geändert werden und stellt nur ein Standardprofil bereit.

properties.defaultNetworkProfile

LabPlanNetworkProfile

Das Netzwerkprofil des Labplans. Zum Erzwingen von Labnetzwerkrichtlinien müssen sie hier definiert werden und können nicht geändert werden, wenn diesem Labplan vorhandene Labs zugeordnet sind.

properties.linkedLmsInstance

string

Basis-URL der lms instance mit der dieser Labplan Lab-Roster verknüpfen kann.

properties.provisioningState

ProvisioningState

Aktueller Bereitstellungsstatus des Labplans.

properties.resourceOperationError

ResourceOperationError

Fehlerdetails des letzten Vorgangs im Labplan.

properties.sharedGalleryId

string

Ressourcen-ID des Shared Image Gallery diesem Labplan angefügt. Beim Speichern eines Vm-Images für eine Labvorlage wird es in diesem Katalog beibehalten. Freigegebene Images aus dem Katalog können für die Verwendung beim Erstellen neuer Labs zur Verfügung gestellt werden.

properties.supportInfo

SupportInfo

Supportkontaktinformationen und Anweisungen für Benutzer des Labplans. Diese Informationen werden Labbesitzern und Benutzern virtueller Computer für alle Labs im Labplan angezeigt.

systemData

systemData

Metadaten, die sich auf die Erstellung und letzte Änderung des Labplans beziehen.

tags

object

Ressourcentags.

type

string

Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

LabPlanNetworkProfile

Profil zum Behandeln von Netzwerken für Labpläne.

Name Typ Beschreibung
subnetId

string

Die ID der externen Subnetzressource

ProvisioningState

Aktueller Bereitstellungsstatus des Labplans.

Name Typ Beschreibung
Creating

string

Die Ressource wird gerade erstellt.

Deleting

string

Die Ressource wird gerade gelöscht.

Failed

string

Beim vorherigen Vorgang für die Ressource ist ein Fehler aufgetreten, der die Ressource im fehlerhaften Zustand belassen hat.

Locked

string

Die Ressource ist gesperrt, und Änderungen werden derzeit blockiert. Dies kann auf Eine Wartung oder einen geplanten Vorgang zurückzuführen sein. Sobald der Sperrvorgang abgeschlossen ist, wird der Status wieder auf "erfolgreich" zurückverknen.

Succeeded

string

Die Ressource befindet sich nach dem Erstellungs- oder Aktualisierungsvorgang in einem fehlerfreien Zustand.

Updating

string

Neue Eigenschaftswerte werden auf die Ressource angewendet.

ResourceIdentityType

Der Identitätstyp.

Name Typ Beschreibung
SystemAssigned

string

ResourceOperationError

Fehlerdetails des letzten Vorgangsfehlers für diese Ressource

Name Typ Beschreibung
action

string

Die Vorgangsaktion, bei der ein Fehler aufgetreten ist

code

string

Der Code, der dem Typ des Vorgangsfehlers entspricht

message

string

Meldung des Vorgangsfehlers

timestamp

string

Datum der Uhrzeit des Auftretens des Fehlers

shutdownOnIdleMode

Definiert, ob die VM im Leerlauf heruntergefahren werden soll, und die Kriterien für die Leerlauferkennung.

Name Typ Beschreibung
LowUsage

string

Die VM wird als Leerlauf betrachtet, wenn der Benutzer abwesend ist und der Ressourcenverbrauch (CPU und Datenträger) gering ist.

None

string

Die VM wird nicht heruntergefahren, wenn sie sich im Leerlauf befindet.

UserAbsence

string

Die VM wird als Leerlauf betrachtet, wenn keine Tastatur- oder Mauseingabe vorhanden ist.

SupportInfo

Supportkontaktinformationen und Anweisungen.

Name Typ Beschreibung
email

string

E-Mail-Adresse des Supportkontakts.

instructions

string

Supportanweisungen.

phone

string

Telefonnummer des Supportkontakts.

url

string

Unterstützen Sie die Webadresse.

systemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

Name Typ Beschreibung
createdAt

string

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

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.