Lab Plans - Create Or Update

Aktualizacje 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=2022-08-01

Parametry identyfikatora URI

Name In Required Type Description
labPlanName
path True
  • string

Nazwa planu laboratorium, który jednoznacznie identyfikuje go w ramach grupy zasobów. Używane w identyfikatorach URI zasobów i w interfejsie użytkownika.

resourceGroupName
path True
  • string

Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.

subscriptionId
path True
  • string

Identyfikator subskrypcji docelowej.

api-version
query True
  • string

Wersja interfejsu API do użycia na potrzeby tej operacji.

Treść żądania

Name Required Type Description
location True
  • string

Lokalizacja geograficzna, w której znajduje się zasób

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

Domyślny profil zamykania laboratorium. Można to zmienić w zasobie laboratorium i zawiera tylko profil domyślny.

properties.defaultConnectionProfile

Domyślny profil połączenia laboratorium. Można to zmienić w zasobie laboratorium i zawiera tylko profil domyślny.

properties.defaultNetworkProfile

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

Podstawowy adres URL wystąpienia lms, z którym ten plan laboratorium może łączyć składy laboratorium.

properties.sharedGalleryId
  • string

Identyfikator zasobu Shared Image Gallery 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

Informacje kontaktowe pomocy technicznej i instrukcje dla użytkowników planu laboratorium. Te informacje są wyświetlane dla właścicieli laboratoriów i użytkowników maszyn wirtualnych dla wszystkich laboratoriów w planie laboratorium.

tags
  • object

Tagi zasobów.

Odpowiedzi

Name Type Description
200 OK

Aktualizacja zakończyła się pomyślnie; odpowiedź zawiera plan laboratorium.

201 Created

Tworzenie zakończyło się pomyślnie; odpowiedź zawiera plan laboratorium.

202 Accepted

Aktualizacja zakończyła się pomyślnie i ma długotrwałą operację; odpowiedź zawiera plan laboratorium.

Other Status Codes

Domyślna odpowiedź na błąd.

Przykłady

putLabPlan

Sample Request

PUT https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.LabServices/labPlans/testlabplan?api-version=2022-08-01

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

Sample Response

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

Definicje

AutoShutdownProfile

Profil obsługi zamykania maszyn wirtualnych.

ConnectionProfile

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

ConnectionType

Włączony poziom dostępu 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 momencie tworzenia laboratorium, ale te wartości domyślne nadal można zastąpić.

LabPlanNetworkProfile

Profil dotyczący obsługi sieci w planach laboratoryjnych.

ProvisioningState

Bieżący stan aprowizacji planu laboratorium.

ResourceIdentityType

Typ tożsamości.

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

Profil obsługi zamykania maszyn wirtualnych.

Name Type Default Value Description
disconnectDelay
  • string

Czas, przez jaki maszyna wirtualna pozostanie uruchomiona po rozłączeniu użytkownika, jeśli to zachowanie jest włączone.

idleDelay
  • string

Czas bezczynności maszyny wirtualnej przed jej zamknięciem, jeśli to zachowanie jest włączone.

noConnectDelay
  • string

Czas, przez jaki maszyna wirtualna pozostanie uruchomiona przed jej zamknięciem, jeśli nie zostanie nawiązane żadne połączenie i to zachowanie zostanie włączone.

shutdownOnDisconnect Disabled

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

shutdownOnIdle None

Czy maszyna wirtualna zostanie zamknięta po bezczynności przez pewien czas.

shutdownWhenNotConnected Disabled

Czy maszyna wirtualna zostanie zamknięta, gdy nie została połączona z maszyną wirtualną po upływie okresu czasu.

ConnectionProfile

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

Name Type Default Value Description
clientRdpAccess None

Włączony poziom dostępu dla dostępu klienta za pośrednictwem protokołu RDP.

clientSshAccess None

Włączony poziom dostępu dla dostępu klienta za pośrednictwem protokołu SSH.

webRdpAccess None

Włączony poziom dostępu do sieci Web za pośrednictwem protokołu RDP.

webSshAccess None

Włączony poziom dostępu dla dostępu do sieci Web za pośrednictwem protokołu SSH.

ConnectionType

Włączony poziom dostępu dla dostępu do sieci Web za pośrednictwem protokołu SSH.

Name Type Description
None
  • string
Private
  • string
Public
  • string

createdByType

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

Name Type Description
Application
  • string
Key
  • string
ManagedIdentity
  • string
User
  • string

EnableState

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

Name Type Description
Disabled
  • string
Enabled
  • string

ErrorAdditionalInfo

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

Name Type Description
info
  • object

Dodatkowe informacje.

type
  • string

Dodatkowy typ informacji.

ErrorDetail

Szczegóły błędu.

Name Type Description
additionalInfo

Dodatkowe informacje o błędzie.

code
  • string

Kod błędu.

details

Szczegóły błędu.

message
  • string

Komunikat o błędzie.

target
  • string

Element docelowy błędu.

ErrorResponse

Odpowiedź na błąd

Name Type Description
error

Obiekt error.

Identity

Tożsamość zasobu.

Name Type Description
principalId
  • string

Identyfikator podmiotu zabezpieczeń tożsamości zasobu.

tenantId
  • string

Identyfikator dzierżawy zasobu.

type

Typ tożsamości.

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 momencie tworzenia laboratorium, ale te wartości domyślne nadal można zastąpić.

Name Type Description
id
  • string

W pełni kwalifikowany identyfikator zasobu dla zasobu. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

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

Domyślny profil zamykania laboratorium. Można to zmienić w zasobie laboratorium i zawiera tylko profil domyślny.

properties.defaultConnectionProfile

Domyślny profil połączenia laboratorium. Można to zmienić w zasobie laboratorium i zawiera tylko profil domyślny.

properties.defaultNetworkProfile

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

Podstawowy adres URL wystąpienia lms, z którym ten plan laboratorium może łączyć składy laboratorium.

properties.provisioningState

Bieżący stan aprowizacji planu laboratorium.

properties.sharedGalleryId
  • string

Identyfikator zasobu Shared Image Gallery 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

Informacje kontaktowe pomocy technicznej i instrukcje dla użytkowników planu laboratorium. Te informacje są wyświetlane dla właścicieli laboratoriów i użytkowników maszyn wirtualnych dla wszystkich laboratoriów w planie laboratorium.

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

Profil dotyczący obsługi sieci w planach laboratoryjnych.

Name Type Description
subnetId
  • string

Identyfikator zasobu podsieci zewnętrznej

ProvisioningState

Bieżący stan aprowizacji planu laboratorium.

Name Type Description
Creating
  • string

Zasób jest w trakcie tworzenia.

Deleting
  • string

Zasób jest w trakcie usuwania.

Failed
  • string

Poprzednia operacja na zasobie nie powiodła się, pozostawiając zasób w złej kondycji.

Locked
  • string

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.

Succeeded
  • string

Zasób jest w dobrej kondycji po utworzeniu lub operacji aktualizacji.

Updating
  • string

Nowe wartości właściwości są stosowane do zasobu.

ResourceIdentityType

Typ tożsamości.

Name Type Description
SystemAssigned
  • string

shutdownOnIdleMode

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

Name Type Description
LowUsage
  • string

Maszyna wirtualna będzie traktowana jako bezczynna, gdy użytkownik jest nieobecny, a zużycie zasobów (procesora CPU i dysku) jest niskie.

None
  • string

Maszyna wirtualna nie zostanie zamknięta, gdy będzie bezczynna.

UserAbsence
  • string

Maszyna wirtualna będzie traktowana jako bezczynna, gdy nie ma żadnych danych wejściowych klawiatury ani myszy.

SupportInfo

Informacje kontaktowe i instrukcje pomocy technicznej.

Name Type Description
email
  • string

Kontaktowy adres e-mail pomocy technicznej.

instructions
  • string

Instrukcje pomocy technicznej.

phone
  • string

Numer telefonu kontaktu z pomocą techniczną.

url
  • string

Obsługa adresu internetowego.

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Name Type Description
createdAt
  • string

Sygnatura czasowa tworzenia zasobów (UTC).

createdBy
  • string

Tożsamość, która utworzyła zasób.

createdByType

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

lastModifiedAt
  • string

Sygnatura czasowa ostatniej modyfikacji zasobu (UTC)

lastModifiedBy
  • string

Tożsamość, która ostatnio zmodyfikowała zasób.

lastModifiedByType

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