Lab Plans - Create Or Update

Usługa:: Lab Services

Wersja interfejsu API:: 2023-06-07

Aktualizuje lub tworzy zasób planu laboratorium.
Operacja tworzenia lub aktualizowania zasobu planu laboratorium.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
labPlanName	path	True	string minLength: 1 maxLength: 100	Nazwa planu laboratorium, który jednoznacznie identyfikuje go w ramach zawierającej grupę zasobów. Używane w identyfikatorach URI zasobów i w interfejsie użytkownika.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
subscriptionId	path	True	string minLength: 1	Identyfikator subskrypcji docelowej.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

Treść żądania

Nazwa	Wymagane	Typ	Opis
location	True	string	Lokalizacja geograficzna, w której znajduje się zasób
identity		Identity	Informacje o tożsamości zarządzanej
properties.allowedRegions		string[]	Dozwolone regiony dla twórcy laboratorium do użycia podczas tworzenia laboratoriów przy użyciu tego planu laboratorium.
properties.defaultAutoShutdownProfile		AutoShutdownProfile	Domyślny profil zamknięcia laboratorium. Można to zmienić w zasobie laboratorium i zawiera tylko profil domyślny.
properties.defaultConnectionProfile		ConnectionProfile	Domyślny profil połączenia laboratorium. Można to zmienić w zasobie laboratorium i zawiera tylko profil domyślny.
properties.defaultNetworkProfile		LabPlanNetworkProfile	Profil sieciowy planu laboratorium. Aby wymusić zasady sieci laboratorium, należy je zdefiniować w tym miejscu i nie można ich zmienić, jeśli istnieją laboratoria skojarzone z tym planem laboratorium.
properties.linkedLmsInstance		string minLength: 3 maxLength: 2000	Podstawowy adres URL wystąpienia lms, z którym ten plan laboratorium może łączyć składy laboratorium.
properties.sharedGalleryId		string minLength: 3 maxLength: 2000	Identyfikator zasobu galerii obrazów udostępnionych dołączony do tego planu laboratorium. Podczas zapisywania obrazu maszyny wirtualnej szablonu laboratorium będzie on utrwalany w tej galerii. Udostępnione obrazy z galerii można udostępniać podczas tworzenia nowych laboratoriów.
properties.supportInfo		SupportInfo	Informacje kontaktowe i instrukcje pomocy technicznej dla użytkowników planu laboratorium. Te informacje są wyświetlane właścicielom laboratoriów i użytkownikom maszyn wirtualnych dla wszystkich laboratoriów w planie laboratorium.
tags		object	Tagi zasobów.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	LabPlan	Aktualizacja zakończyła się pomyślnie; odpowiedź zawiera plan laboratorium.
201 Created	LabPlan	Tworzenie zakończyło się pomyślnie; odpowiedź zawiera plan laboratorium.
202 Accepted	LabPlan	Aktualizacja zakończyła się pomyślnie i ma długotrwałą operację; odpowiedź zawiera plan laboratorium.
Other Status Codes	ErrorResponse	Domyślna odpowiedź o błędzie.

Przykłady

putLabPlan

Przykładowe żądanie

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

Przykładowa odpowiedź

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

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

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

Definicje

Nazwa	Opis
AutoShutdownProfile	Profil obsługi zamykania maszyn wirtualnych.
ConnectionProfile	Profil połączenia przedstawiający sposób łączenia użytkowników z maszynami wirtualnymi laboratorium.
ConnectionType	Poziom dostępu włączonego dla dostępu do sieci Web za pośrednictwem protokołu SSH.
createdByType	Typ tożsamości, która utworzyła zasób.
EnableState	Czy zamknięcie przy rozłączeniu jest włączone
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
Identity	Tożsamość zasobu.
LabPlan	Plany laboratorium działają jako kontener uprawnień do tworzenia laboratoriów za pośrednictwem labs.azure.com. Ponadto mogą one udostępnić zestaw domyślnych konfiguracji, które będą stosowane w czasie tworzenia laboratorium, ale te ustawienia domyślne mogą być nadal zastępowane.
LabPlanNetworkProfile	Profil obsługi sieci dla planów laboratorium.
ProvisioningState	Bieżący stan aprowizacji planu laboratorium.
ResourceIdentityType	Typ tożsamości.
ResourceOperationError	Szczegóły błędu dotyczące najnowszego błędu operacji w tym zasobie
shutdownOnIdleMode	Określa, czy należy zamknąć maszynę wirtualną w stanie bezczynności i kryteria wykrywania bezczynności.
SupportInfo	Informacje kontaktowe i instrukcje pomocy technicznej.
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

AutoShutdownProfile

Objekt

Profil obsługi zamykania maszyn wirtualnych.

Nazwa	Typ	Domyślna wartość	Opis
disconnectDelay	string (duration)		Czas, przez jaki maszyna wirtualna pozostanie uruchomiona po rozłączeniu użytkownika w przypadku włączenia tego zachowania.
idleDelay	string (duration)		Czas bezczynności maszyny wirtualnej przed jej zamknięciem, jeśli to zachowanie jest włączone.
noConnectDelay	string (duration)		Czas, przez jaki maszyna wirtualna pozostanie uruchomiona, zanim zostanie ona zamknięta, jeśli połączenie nie zostanie nawiązane i to zachowanie zostanie włączone.
shutdownOnDisconnect	EnableState	Disabled	Czy zamknięcie przy rozłączeniu jest włączone
shutdownOnIdle	shutdownOnIdleMode	None	Określa, czy maszyna wirtualna zostanie zamknięta, gdy będzie bezczynna przez pewien czas.
shutdownWhenNotConnected	EnableState	Disabled	Czy maszyna wirtualna zostanie zamknięta, gdy nie została połączona z maszyną wirtualną po upływie okresu.

ConnectionProfile

Objekt

Profil połączenia przedstawiający sposób łączenia użytkowników z maszynami wirtualnymi laboratorium.

Nazwa	Typ	Domyślna wartość	Opis
clientRdpAccess	ConnectionType	None	Poziom dostępu włączonego dla dostępu klienta za pośrednictwem protokołu RDP.
clientSshAccess	ConnectionType	None	Włączony poziom dostępu dla dostępu klienta za pośrednictwem protokołu SSH.
webRdpAccess	ConnectionType	None	Poziom dostępu włączonego dla dostępu do sieci Web za pośrednictwem protokołu RDP.
webSshAccess	ConnectionType	None	Poziom dostępu włączonego dla dostępu do sieci Web za pośrednictwem protokołu SSH.

ConnectionType

Wyliczanie

Poziom dostępu włączonego dla dostępu do sieci Web za pośrednictwem protokołu SSH.

Wartość	Opis
Public
Private
None

createdByType

Wyliczanie

Typ tożsamości, która utworzyła zasób.

Wartość	Opis
User
Application
ManagedIdentity
Key

EnableState

Wyliczanie

Czy zamknięcie przy rozłączeniu jest włączone

Wartość	Opis
Enabled
Disabled

ErrorAdditionalInfo

Objekt

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Objekt

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Objekt

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

Identity

Objekt

Tożsamość zasobu.

Nazwa	Typ	Opis
principalId	string	Identyfikator podmiotu zabezpieczeń tożsamości zasobu.
tenantId	string	Identyfikator dzierżawy zasobu.
type	ResourceIdentityType	Typ tożsamości.

LabPlan

Objekt

Plany laboratorium działają jako kontener uprawnień do tworzenia laboratoriów za pośrednictwem labs.azure.com. Ponadto mogą one udostępnić zestaw domyślnych konfiguracji, które będą stosowane w czasie tworzenia laboratorium, ale te ustawienia domyślne mogą być nadal zastępowane.

Nazwa	Typ	Opis
id	string	W pełni kwalifikowany identyfikator zasobu dla zasobu. Przykład - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	Identity	Informacje o tożsamości zarządzanej
location	string	Lokalizacja geograficzna, w której znajduje się zasób
name	string	Nazwa zasobu
properties.allowedRegions	string[]	Dozwolone regiony dla twórcy laboratorium do użycia podczas tworzenia laboratoriów przy użyciu tego planu laboratorium.
properties.defaultAutoShutdownProfile	AutoShutdownProfile	Domyślny profil zamknięcia laboratorium. Można to zmienić w zasobie laboratorium i zawiera tylko profil domyślny.
properties.defaultConnectionProfile	ConnectionProfile	Domyślny profil połączenia laboratorium. Można to zmienić w zasobie laboratorium i zawiera tylko profil domyślny.
properties.defaultNetworkProfile	LabPlanNetworkProfile	Profil sieciowy planu laboratorium. Aby wymusić zasady sieci laboratorium, należy je zdefiniować w tym miejscu i nie można ich zmienić, jeśli istnieją laboratoria skojarzone z tym planem laboratorium.
properties.linkedLmsInstance	string minLength: 3 maxLength: 2000	Podstawowy adres URL wystąpienia lms, z którym ten plan laboratorium może łączyć składy laboratorium.
properties.provisioningState	ProvisioningState	Bieżący stan aprowizacji planu laboratorium.
properties.resourceOperationError	ResourceOperationError	Szczegóły błędu ostatniej operacji wykonanej w planie laboratorium.
properties.sharedGalleryId	string minLength: 3 maxLength: 2000	Identyfikator zasobu galerii obrazów udostępnionych dołączony do tego planu laboratorium. Podczas zapisywania obrazu maszyny wirtualnej szablonu laboratorium będzie on utrwalany w tej galerii. Udostępnione obrazy z galerii można udostępniać podczas tworzenia nowych laboratoriów.
properties.supportInfo	SupportInfo	Informacje kontaktowe i instrukcje pomocy technicznej dla użytkowników planu laboratorium. Te informacje są wyświetlane właścicielom laboratoriów i użytkownikom maszyn wirtualnych dla wszystkich laboratoriów w planie laboratorium.
systemData	systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji planu laboratorium.
tags	object	Tagi zasobów.
type	string	Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

LabPlanNetworkProfile

Objekt

Profil obsługi sieci dla planów laboratorium.

Nazwa	Typ	Opis
subnetId	string minLength: 3 maxLength: 2000	Identyfikator zasobu podsieci zewnętrznej

ProvisioningState

Wyliczanie

Bieżący stan aprowizacji planu laboratorium.

Wartość	Opis
Creating	Zasób jest w trakcie tworzenia.
Updating	Nowe wartości właściwości są stosowane do zasobu.
Deleting	Zasób jest w trakcie usuwania.
Succeeded	Zasób jest w dobrej kondycji po utworzeniu lub operacji aktualizacji.
Failed	Poprzednia operacja zasobu nie powiodła się, pozostawiając zasób w złej kondycji.
Locked	Zasób jest zablokowany i zmiany są obecnie blokowane. Może to być spowodowane konserwacją lub zaplanowaną operacją. Stan powróci do powodzenia po zakończeniu operacji blokowania.

ResourceIdentityType

Wyliczanie

Typ tożsamości.

Wartość	Opis
SystemAssigned

ResourceOperationError

Objekt

Szczegóły błędu dotyczące najnowszego błędu operacji w tym zasobie

Nazwa	Typ	Opis
action	string	Akcja operacji, która nie powiodła się
code	string	Kod odpowiadający typowi błędu operacji
message	string	Komunikat o niepowodzeniu operacji
timestamp	string (date-time)	Data/godzina wystąpienia błędu

shutdownOnIdleMode

Wyliczanie

Określa, czy należy zamknąć maszynę wirtualną w stanie bezczynności i kryteria wykrywania bezczynności.

Wartość	Opis
None	Maszyna wirtualna nie zostanie zamknięta, gdy będzie bezczynna.
UserAbsence	Maszyna wirtualna będzie traktowana jako bezczynna, gdy nie ma klawiatury ani danych wejściowych myszy.
LowUsage	Maszyna wirtualna będzie traktowana jako bezczynna, gdy użytkownik jest nieobecny, a zużycie zasobów (procesora CPU i dysku) jest niskie.

SupportInfo

Objekt

Informacje kontaktowe i instrukcje pomocy technicznej.

Nazwa	Typ	Opis
email	string minLength: 6 maxLength: 254	Kontaktowy adres e-mail pomocy technicznej.
instructions	string	Instrukcje pomocy technicznej.
phone	string minLength: 1 maxLength: 31	Numer telefonu kontaktu z pomocą techniczną.
url	string minLength: 3 maxLength: 2000	Obsługa adresu internetowego.

systemData

Objekt

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string (date-time)	Sygnatura czasowa tworzenia zasobu (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string (date-time)	Znacznik czasu ostatniej modyfikacji zasobu (UTC)
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.

Udostępnij za pośrednictwem

Lab Plans - Create Or Update

Parametry identyfikatora URI

Treść żądania

Odpowiedzi

Przykłady

putLabPlan

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

AutoShutdownProfile

ConnectionProfile

ConnectionType

createdByType

EnableState

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

Identity

LabPlan

LabPlanNetworkProfile

ProvisioningState

ResourceIdentityType

ResourceOperationError

shutdownOnIdleMode

SupportInfo

systemData