Freigeben über


Labs - Update

Vorgang zum Aktualisieren einer Labressource.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
labName
path True

string

Der Name des Labs, das es innerhalb des lab-Plans eindeutig identifiziert. Wird in Ressourcen-URIs 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 Typ Beschreibung
properties.autoShutdownProfile

AutoShutdownProfile

Die Konfiguration für das automatische Herunterfahren der Ressource für das Lab. Dadurch wird gesteuert, ob Aktionen für Ressourcen ausgeführt werden, die sich im Leerlauf befinden.

properties.connectionProfile

ConnectionProfile

Das Verbindungsprofil für das Lab. Dadurch werden Einstellungen wie der Webzugriff auf Labressourcen oder ob RDP- oder SSH-Ports geöffnet sind, gesteuert.

properties.description

string

Die Beschreibung des Labs.

properties.labPlanId

string

Die ID des Labplans. Wird während der Ressourcenerstellung verwendet, um Standardwerte bereitzustellen, und fungiert als Berechtigungscontainer, wenn ein Lab über labs.azure.com erstellt wird. Das Festlegen einer labPlanId für ein vorhandenes Lab bietet organization..

properties.rosterProfile

RosterProfile

Das Verwaltungsprofil für die Lab-Benutzerliste.

properties.securityProfile

SecurityProfile

Das Lab-Sicherheitsprofil.

properties.title

string

Der Titel des Labs.

properties.virtualMachineProfile

VirtualMachineProfile

Das Profil, das zum Erstellen von virtuellen Labcomputern verwendet wird.

tags

string[]

Ressourcentags.

Antworten

Name Typ Beschreibung
200 OK

Lab

Die Ressource wurde aktualisiert. -Antwort enthält das Lab.

202 Accepted

Lab

Die Ressource wurde aktualisiert und hat einen zeitintensiven Vorgang. -Antwort enthält das Lab.

Other Status Codes

ErrorResponse

Die Standardfehlerantwort.

Beispiele

patchLab

Sample Request

PATCH https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.LabServices/labs/testlab?api-version=2023-06-07

{
  "properties": {
    "securityProfile": {
      "openAccess": "Enabled"
    }
  }
}

Sample Response

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.LabServices/labs/testlab",
  "name": "testlabplan",
  "type": "Microsoft.LabServices/Lab",
  "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",
    "connectionProfile": {
      "webSshAccess": "None",
      "webRdpAccess": "None",
      "clientSshAccess": "Public",
      "clientRdpAccess": "Public"
    },
    "autoShutdownProfile": {
      "shutdownOnDisconnect": "Enabled",
      "shutdownWhenNotConnected": "Enabled",
      "shutdownOnIdle": "UserAbsence",
      "disconnectDelay": "PT5M",
      "noConnectDelay": "PT5M",
      "idleDelay": "PT5M"
    },
    "securityProfile": {
      "registrationCode": "fAkEcodE",
      "openAccess": "Enabled"
    },
    "networkProfile": {
      "subnetId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/id"
    },
    "virtualMachineProfile": {
      "createOption": "TemplateVM",
      "imageReference": {
        "offer": "WindowsServer",
        "publisher": "Microsoft",
        "sku": "2019-Datacenter",
        "version": "2019.0.20190410"
      },
      "sku": {
        "name": "Medium",
        "capacity": 20
      },
      "additionalCapabilities": {
        "installGpuDrivers": "Disabled"
      },
      "usageQuota": "PT10H",
      "useSharedPassword": "Disabled",
      "adminUser": {
        "username": "test-user"
      }
    },
    "title": "Test Lab",
    "description": "This is a test lab.",
    "labPlanId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.LabServices/labPlans/testlabplan",
    "state": "Draft"
  }
}
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/labs/testlab",
  "name": "testlabplan",
  "type": "Microsoft.LabServices/Lab",
  "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",
    "connectionProfile": {
      "webSshAccess": "None",
      "webRdpAccess": "None",
      "clientSshAccess": "Public",
      "clientRdpAccess": "Public"
    },
    "autoShutdownProfile": {
      "shutdownOnDisconnect": "Enabled",
      "shutdownWhenNotConnected": "Enabled",
      "shutdownOnIdle": "UserAbsence",
      "disconnectDelay": "PT5M",
      "noConnectDelay": "PT5M",
      "idleDelay": "PT5M"
    },
    "securityProfile": {
      "registrationCode": "fAkEcodE",
      "openAccess": "Enabled"
    },
    "networkProfile": {
      "subnetId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/default"
    },
    "virtualMachineProfile": {
      "createOption": "TemplateVM",
      "imageReference": {
        "offer": "WindowsServer",
        "publisher": "Microsoft",
        "sku": "2019-Datacenter",
        "version": "2019.0.20190410"
      },
      "osType": "Windows",
      "sku": {
        "name": "Medium",
        "capacity": 20
      },
      "additionalCapabilities": {
        "installGpuDrivers": "Disabled"
      },
      "usageQuota": "PT10H",
      "useSharedPassword": "Disabled",
      "adminUser": {
        "username": "test-user"
      }
    },
    "title": "Test Lab",
    "description": "This is a test lab.",
    "labPlanId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.LabServices/labPlans/testlabplan",
    "state": "Draft"
  }
}

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.

CreateOption

Gibt an, aus welchen Lab-VMs erstellt wird.

Credentials

Anmeldeinformationen für einen Benutzer auf einer Lab-VM.

EnableState

Ob das Herunterfahren bei Trennung aktiviert ist

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

ErrorDetail

Die Fehlerdetails.

ErrorResponse

Fehlerantwort

ImageReference

Bildverweisinformationen. Wird im VM-Profil verwendet.

Lab

Die Labressource.

LabNetworkProfile

Profil für den Umgang mit Netzwerken für Labs.

LabState

Der Status eines virtuellen Computers.

LabUpdate

Die Labressource für Updates.

OsType

Der Betriebssystemtyp des Images

ProvisioningState

Aktueller Bereitstellungsstatus des Labs.

ResourceOperationError

Fehlerdetails des letzten Vorgangsfehlers für diese Ressource

RosterProfile

Das Verwaltungsprofil der Lab-Benutzerliste.

SecurityProfile

Das Sicherheitsprofil des Labs.

shutdownOnIdleMode

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

Sku

Die Ressourcenmodelldefinition, die die SKU darstellt

SkuTier

Dieses Feld muss vom Ressourcenanbieter implementiert werden, wenn der Dienst über mehrere Ebenen verfügt, aber für einen PUT nicht erforderlich ist.

systemData

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

VirtualMachineAdditionalCapabilities

Die zusätzlichen Funktionen für eine Lab-VM.

VirtualMachineProfile

Die Konfiguration des virtuellen Basiscomputers für ein Lab.

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

CreateOption

Gibt an, aus welchen Lab-VMs erstellt wird.

Name Typ Beschreibung
Image

string

Ein Image wird verwendet, um alle virtuellen Computer des Labbenutzers zu erstellen. Wenn diese Option festgelegt ist, wird keine Vorlagen-VM erstellt.

TemplateVM

string

Eine Vorlagen-VM wird verwendet, um alle virtuellen Computer für Labbenutzer zu erstellen.

Credentials

Anmeldeinformationen für einen Benutzer auf einer Lab-VM.

Name Typ Beschreibung
password

string

Das Kennwort für den Benutzer. Dies ist für templateVM createOption erforderlich.

username

string

Der Benutzername, der bei der Anmeldung bei Lab-VMs verwendet werden soll.

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.

ImageReference

Bildverweisinformationen. Wird im VM-Profil verwendet.

Name Typ Beschreibung
exactVersion

string

Die tatsächliche Version des Images nach der Verwendung.

id

string

Imageressourcen-ID

offer

string

Das Imageangebot, falls zutreffend.

publisher

string

Der Imageherausgeber

sku

string

Die Image-SKU

version

string

Die bei der Erstellung angegebene Imageversion.

Lab

Die Labressource.

Name Typ Beschreibung
id

string

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

location

string

Der geografische Standort, an dem sich die Ressource befindet

name

string

Der Name der Ressource

properties.autoShutdownProfile

AutoShutdownProfile

Die Konfiguration des automatischen Herunterfahrens der Ressource für das Lab. Dadurch wird gesteuert, ob Aktionen für Ressourcen ausgeführt werden, die sich im Leerlauf befinden.

properties.connectionProfile

ConnectionProfile

Das Verbindungsprofil für das Lab. Dadurch werden Einstellungen gesteuert, z. B. webzugriff auf Labressourcen oder ob RDP- oder SSH-Ports geöffnet sind.

properties.description

string

Die Beschreibung des Labs.

properties.labPlanId

string

Die ID des Labplans. Wird während der Ressourcenerstellung verwendet, um Standardwerte bereitzustellen, und fungiert als Berechtigungscontainer beim Erstellen eines Labs über labs.azure.com. Das Festlegen einer labPlanId für ein vorhandenes Lab bietet organization..

properties.networkProfile

LabNetworkProfile

Das Netzwerkprofil für das Lab, das in der Regel über einen Labplan angewendet wird. Dieses Profil kann nicht geändert werden, nachdem ein Lab erstellt wurde.

properties.provisioningState

ProvisioningState

Aktueller Bereitstellungsstatus des Labs.

properties.resourceOperationError

ResourceOperationError

Fehlerdetails des letzten Vorgangs im Lab.

properties.rosterProfile

RosterProfile

Das Verwaltungsprofil der Lab-Benutzerliste.

properties.securityProfile

SecurityProfile

Das Sicherheitsprofil des Labs.

properties.state

LabState

Der Labstatus.

properties.title

string

Der Titel des Labs.

properties.virtualMachineProfile

VirtualMachineProfile

Das Profil, das zum Erstellen virtueller Labcomputer verwendet wird.

systemData

systemData

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

tags

object

Ressourcentags.

type

string

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

LabNetworkProfile

Profil für den Umgang mit Netzwerken für Labs.

Name Typ Beschreibung
loadBalancerId

string

Die Ressourcen-ID des externen Lastenausgleichs

publicIpId

string

Die ressourcen-ID der externen öffentlichen IP-Adresse

subnetId

string

Die Ressourcen-ID des externen Subnetzes

LabState

Der Status eines virtuellen Computers.

Name Typ Beschreibung
Draft

string

Das Lab befindet sich derzeit im Entwurf (wurde nicht veröffentlicht).

Published

string

Das Lab wurde veröffentlicht.

Publishing

string

Das Lab wird veröffentlicht.

Scaling

string

Das Lab wird skaliert.

Syncing

string

Das Lab synchronisiert Benutzer.

LabUpdate

Die Labressource für Updates.

Name Typ Beschreibung
properties.autoShutdownProfile

AutoShutdownProfile

Die Konfiguration des automatischen Herunterfahrens der Ressource für das Lab. Dadurch wird gesteuert, ob Aktionen für Ressourcen ausgeführt werden, die sich im Leerlauf befinden.

properties.connectionProfile

ConnectionProfile

Das Verbindungsprofil für das Lab. Dadurch werden Einstellungen gesteuert, z. B. webzugriff auf Labressourcen oder ob RDP- oder SSH-Ports geöffnet sind.

properties.description

string

Die Beschreibung des Labs.

properties.labPlanId

string

Die ID des Labplans. Wird während der Ressourcenerstellung verwendet, um Standardwerte bereitzustellen, und fungiert als Berechtigungscontainer beim Erstellen eines Labs über labs.azure.com. Das Festlegen einer labPlanId für ein vorhandenes Lab bietet organization..

properties.rosterProfile

RosterProfile

Das Verwaltungsprofil der Lab-Benutzerliste.

properties.securityProfile

SecurityProfile

Das Sicherheitsprofil des Labs.

properties.title

string

Der Titel des Labs.

properties.virtualMachineProfile

VirtualMachineProfile

Das Profil, das zum Erstellen virtueller Labcomputer verwendet wird.

tags

string[]

Ressourcentags.

OsType

Der Betriebssystemtyp des Images

Name Typ Beschreibung
Linux

string

Windows

string

ProvisioningState

Aktueller Bereitstellungsstatus des Labs.

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, und die Ressource wurde in einem fehlerhaften Zustand belassen.

Locked

string

Die Ressource ist gesperrt, und Änderungen werden derzeit blockiert. Dies kann auf eine Wartung oder einen geplanten Betrieb zurückzuführen sein. Nach Abschluss des Sperrvorgangs wechselt der Status zurück zu "erfolgreich".

Succeeded

string

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

Updating

string

Neue Eigenschaftswerte werden auf die Ressource angewendet.

ResourceOperationError

Fehlerdetails des letzten 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

Meldung zum Vorgangsfehler

timestamp

string

Datetime des Fehlers

RosterProfile

Das Verwaltungsprofil der Lab-Benutzerliste.

Name Typ Beschreibung
activeDirectoryGroupId

string

Die AAD-Gruppen-ID, aus der diese Labliste aufgefüllt wird. Mit diesem Satz wird der AAD-Synchronisierungsmodus aktiviert.

lmsInstance

string

Der Basis-URI, der die lms-instance identifiziert.

ltiClientId

string

Die eindeutige ID des Azure Lab Services-Tools in lms.

ltiContextId

string

Der eindeutige Kontextbezeichner für das Lab in der lms.

ltiRosterEndpoint

string

Der URI der Namen und Rollen des Dienstendpunkts auf dem lms für die klasse, die diesem Lab angefügt ist.

SecurityProfile

Das Sicherheitsprofil des Labs.

Name Typ Beschreibung
openAccess

EnableState

Gibt an, ob sich ein beliebiger Benutzer oder nur angegebene Benutzer bei einem Lab registrieren kann.

registrationCode

string

Der Registrierungscode für das Lab.

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.

Sku

Die Ressourcenmodelldefinition, die die SKU darstellt

Name Typ Beschreibung
capacity

integer

Wenn die SKU horizontales/horizontales Hochskalieren unterstützt, sollte die Kapazitäts-Ganzzahl eingeschlossen werden. Wenn horizontales/in für die Ressource nicht möglich ist, wird dies möglicherweise weggelassen.

family

string

Wenn der Dienst über unterschiedliche Hardwaregenerationen für dieselbe SKU verfügt, kann dies hier erfasst werden.

name

string

Der Name der SKU. Beispiel: P3. Es handelt sich in der Regel um einen Buchstaben+Zahlencode.

size

string

Die SKU-Größe. Wenn das Namensfeld die Kombination aus Ebene und einem anderen Wert ist, wäre dies der eigenständige Code.

tier

SkuTier

Dieses Feld muss vom Ressourcenanbieter implementiert werden, wenn der Dienst über mehrere Ebenen verfügt, aber für einen PUT nicht erforderlich ist.

SkuTier

Dieses Feld muss vom Ressourcenanbieter implementiert werden, wenn der Dienst über mehrere Ebenen verfügt, aber für einen PUT nicht erforderlich ist.

Name Typ Beschreibung
Basic

string

Free

string

Premium

string

Standard

string

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.

VirtualMachineAdditionalCapabilities

Die zusätzlichen Funktionen für eine Lab-VM.

Name Typ Standardwert Beschreibung
installGpuDrivers

EnableState

Disabled

Kennzeichnen Sie die Vorinstallation dedizierter GPU-Treiber.

VirtualMachineProfile

Die Konfiguration des virtuellen Basiscomputers für ein Lab.

Name Typ Standardwert Beschreibung
additionalCapabilities

VirtualMachineAdditionalCapabilities

Zusätzliche VM-Funktionen.

adminUser

Credentials

Anmeldeinformationen für den Administratorbenutzer auf dem virtuellen Computer.

createOption

CreateOption

Gibt an, aus welchen Lab-VMs erstellt wird.

imageReference

ImageReference

Die Imagekonfiguration für virtuelle Lab-Computer.

nonAdminUser

Credentials

Anmeldeinformationen für den Nicht-Administratorbenutzer auf dem virtuellen Computer, sofern vorhanden.

osType

OsType

Der Betriebssystemtyp des Images

sku

Sku

Die SKU für das Lab. Definiert den Typ der virtuellen Computer, die im Lab verwendet werden.

usageQuota

string

Das anfängliche Kontingent, das jedem Labbenutzer zugewiesen wird. Muss eine Zeitspanne zwischen 0 und 9999 Stunden sein.

useSharedPassword

EnableState

Disabled

Wenn Sie diese Option aktivieren, wird für alle Benutzer-VMs dasselbe Kennwort verwendet.