Labs - Get

Referentie

Service:: Lab Services

API-versie:: 2023-06-07

Haal een labresource op.
Retourneert de eigenschappen van een labresource.

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

URI-parameters

Name	In	Vereist	Type	Description
labName	path	True	string minLength: 1 maxLength: 100	De naam van het lab dat het uniek identificeert in het labplan. Wordt gebruikt in resource-URI's.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
subscriptionId	path	True	string minLength: 1	De id van het doelabonnement.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Antwoorden

Name	Type	Description
200 OK	Lab	De aanvraag is geslaagd; het antwoord bevat het lab.
Other Status Codes	ErrorResponse	Het standaardfoutantwoord.

Voorbeelden

getLab

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

Statuscode:: 200

{
  "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": "Disabled"
    },
    "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"
  }
}

Definities

Name	Description
AutoShutdownProfile	Profiel voor het afhandelen van het afsluiten van virtuele machines.
ConnectionProfile	Verbindingsprofiel voor de wijze waarop gebruikers verbinding maken met virtuele machines van het lab.
ConnectionType	Het ingeschakelde toegangsniveau voor Web Access via SSH.
createdByType	Het type identiteit waarmee de resource is gemaakt.
CreateOption	Geeft aan op welke virtuele machines van het lab worden gemaakt.
Credentials	Referenties voor een gebruiker op een lab-VM.
EnableState	Of afsluiten bij verbreken is ingeschakeld
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
ImageReference	Referentie-informatie over afbeeldingen. Wordt gebruikt in het profiel van de virtuele machine.
Lab	De labresource.
LabNetworkProfile	Profiel voor het afhandelen van netwerken voor Labs.
LabState	De status van een virtuele machine.
OsType	Het type besturingssysteem van de installatiekopie
ProvisioningState	Huidige inrichtingsstatus van het lab.
ResourceOperationError	Foutdetails van de meest recente bewerkingsfout voor deze resource
RosterProfile	Het gebruikerslijstprofiel voor labgebruikers.
SecurityProfile	Het beveiligingsprofiel van het lab.
shutdownOnIdleMode	Hiermee definieert u of de VM moet worden afgesloten bij niet-actieve en de criteria voor inactiviteitsdetectie.
Sku	De definitie van het resourcemodel die de SKU vertegenwoordigt
SkuTier	Dit veld moet worden geïmplementeerd door de resourceprovider als de service meer dan één laag heeft, maar niet vereist is voor een PUT.
systemData	Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.
VirtualMachineAdditionalCapabilities	De extra mogelijkheden voor een lab-VM.
VirtualMachineProfile	De basisconfiguratie van virtuele machines voor een lab.

AutoShutdownProfile

Object

Profiel voor het afhandelen van het afsluiten van virtuele machines.

Name	Type	Default value	Description
disconnectDelay	string (duration)		De hoeveelheid tijd die een VIRTUELE machine actief blijft nadat een gebruiker de verbinding heeft verbroken als dit gedrag is ingeschakeld.
idleDelay	string (duration)		De hoeveelheid tijd die een VIRTUELE machine inactief maakt voordat deze wordt afgesloten als dit gedrag is ingeschakeld.
noConnectDelay	string (duration)		De hoeveelheid tijd die een virtuele machine actief blijft voordat deze wordt afgesloten als er geen verbinding wordt gemaakt en dit gedrag is ingeschakeld.
shutdownOnDisconnect	EnableState	Disabled	Of afsluiten bij verbreken is ingeschakeld
shutdownOnIdle	shutdownOnIdleMode	None	Of een VIRTUELE machine wordt afgesloten wanneer deze gedurende een bepaalde periode inactief is.
shutdownWhenNotConnected	EnableState	Disabled	Of een VIRTUELE machine wordt afgesloten wanneer deze na een bepaalde periode niet is verbonden.

ConnectionProfile

Object

Verbindingsprofiel voor de wijze waarop gebruikers verbinding maken met virtuele machines van het lab.

Name	Type	Default value	Description
clientRdpAccess	ConnectionType	None	Het ingeschakelde toegangsniveau voor clienttoegang via RDP.
clientSshAccess	ConnectionType	None	Het ingeschakelde toegangsniveau voor clienttoegang via SSH.
webRdpAccess	ConnectionType	None	Het ingeschakelde toegangsniveau voor Web Access via RDP.
webSshAccess	ConnectionType	None	Het ingeschakelde toegangsniveau voor Web Access via SSH.

ConnectionType

Inventarisatie

Het ingeschakelde toegangsniveau voor Web Access via SSH.

Waarde	Description
None
Private
Public

createdByType

Inventarisatie

Het type identiteit waarmee de resource is gemaakt.

Waarde	Description
Application
Key
ManagedIdentity
User

CreateOption

Inventarisatie

Geeft aan op welke virtuele machines van het lab worden gemaakt.

Waarde	Description
Image	Er wordt een installatiekopieën gebruikt om alle virtuele machines van labgebruikers te maken. Wanneer deze optie is ingesteld, wordt er geen sjabloon-VM gemaakt.
TemplateVM	Een sjabloon-VM wordt gebruikt om alle virtuele machines van labgebruikers te maken.

Credentials

Object

Referenties voor een gebruiker op een lab-VM.

Name	Type	Description
password	string	Het wachtwoord voor de gebruiker. Dit is vereist voor de TemplateVM createOption.
username	string	De gebruikersnaam die moet worden gebruikt bij het aanmelden bij lab-VM's.

EnableState

Inventarisatie

Of afsluiten bij verbreken is ingeschakeld

Waarde	Description
Disabled
Enabled

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

Object

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Object

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

ImageReference

Object

Referentie-informatie over afbeeldingen. Wordt gebruikt in het profiel van de virtuele machine.

Name	Type	Description
exactVersion	string	De werkelijke versie van de installatiekopieën na gebruik.
id	string minLength: 3 maxLength: 2000	Resource-id van installatiekopieën
offer	string	De afbeeldingsaanbieding indien van toepassing.
publisher	string	De uitgever van de installatiekopieën
sku	string	De installatiekopieën-SKU
version	string	De versie van de installatiekopie die is opgegeven bij het maken.

Lab

Object

De labresource.

Name	Type	Description
id	string	Volledig gekwalificeerde resource-id voor de resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	De geografische locatie waar de resource zich bevindt
name	string	De naam van de resource
properties.autoShutdownProfile	AutoShutdownProfile	De configuratie voor het automatisch afsluiten van resources voor het lab. Hiermee bepaalt u of er acties worden uitgevoerd op resources die niet actief zijn.
properties.connectionProfile	ConnectionProfile	Het verbindingsprofiel voor het lab. Hiermee worden instellingen zoals webtoegang tot labbronnen bepaald of RDP- of SSH-poorten zijn geopend.
properties.description	string	De beschrijving van het lab.
properties.labPlanId	string minLength: 3 maxLength: 2000	De id van het labplan. Wordt gebruikt tijdens het maken van resources om standaardinstellingen te bieden en fungeert als een machtigingscontainer bij het maken van een lab via labs.azure.com. Het instellen van een labPlanId op een bestaand lab biedt organisatie..
properties.networkProfile	LabNetworkProfile	Het netwerkprofiel voor het lab, meestal toegepast via een labplan. Dit profiel kan niet worden gewijzigd nadat een lab is gemaakt.
properties.provisioningState	ProvisioningState	Huidige inrichtingsstatus van het lab.
properties.resourceOperationError	ResourceOperationError	Foutdetails van de laatste bewerking die in het lab is uitgevoerd.
properties.rosterProfile	RosterProfile	Het gebruikerslijstprofiel voor labgebruikers.
properties.securityProfile	SecurityProfile	Het beveiligingsprofiel van het lab.
properties.state	LabState	De labstatus.
properties.title	string minLength: 1 maxLength: 120	De titel van het lab.
properties.virtualMachineProfile	VirtualMachineProfile	Het profiel dat wordt gebruikt voor het maken van virtuele labmachines.
systemData	systemData	Metagegevens met betrekking tot het maken en de laatste wijziging van het lab.
tags	object	Resourcetags.
type	string	Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

LabNetworkProfile

Object

Profiel voor het afhandelen van netwerken voor Labs.

Name	Type	Description
loadBalancerId	string minLength: 3 maxLength: 2000	De resource-id van de externe load balancer
publicIpId	string minLength: 3 maxLength: 2000	De resource-id van het externe openbare IP-adres
subnetId	string minLength: 3 maxLength: 2000	De resource-id van het externe subnet

LabState

Inventarisatie

De status van een virtuele machine.

Waarde	Description
Draft	Het lab is momenteel in concept (is niet gepubliceerd).
Published	Het lab is gepubliceerd.
Publishing	Het lab publiceert.
Scaling	Het lab wordt geschaald.
Syncing	Het lab synchroniseert gebruikers.

OsType

Inventarisatie

Het type besturingssysteem van de installatiekopie

Waarde	Description
Linux
Windows

ProvisioningState

Inventarisatie

Huidige inrichtingsstatus van het lab.

Waarde	Description
Creating	De resource wordt gemaakt.
Deleting	De resource wordt verwijderd.
Failed	De vorige bewerking voor de resource is mislukt, waardoor de resource niet in orde is.
Locked	De resource is vergrendeld en wijzigingen worden momenteel geblokkeerd. Dit kan worden veroorzaakt door onderhoud of een geplande bewerking. De status wordt weer voltooid zodra de vergrendelingsbewerking is voltooid.
Succeeded	De resource heeft de status In orde na het maken of bijwerken.
Updating	Nieuwe eigenschapswaarden worden toegepast op de resource.

ResourceOperationError

Object

Foutdetails van de meest recente bewerkingsfout voor deze resource

Name	Type	Description
action	string	De bewerkingsactie die is mislukt
code	string	De code die overeenkomt met het type bewerkingsfout
message	string	Het foutbericht over de bewerking
timestamp	string (date-time)	De datum/tijd waarop de fout is opgetreden

RosterProfile

Object

Het gebruikerslijstprofiel voor labgebruikers.

Name	Type	Description
activeDirectoryGroupId	string	De AAD-groeps-id waaruit dit labrooster wordt ingevuld. Als u deze set hebt ingesteld, wordt de AAD-synchronisatiemodus ingeschakeld.
lmsInstance	string	De basis-URI die het lms-exemplaar identificeert.
ltiClientId	string	De unieke id van het hulpprogramma Azure Lab Services in het lms.
ltiContextId	string	De unieke context-id voor het lab in het lms.
ltiRosterEndpoint	string	De URI van het service-eindpunt voor namen en rollen in het lms voor de klasse die aan dit lab is gekoppeld.

SecurityProfile

Object

Het beveiligingsprofiel van het lab.

Name	Type	Description
openAccess	EnableState	Of een gebruiker of alleen opgegeven gebruikers zich kunnen registreren bij een lab.
registrationCode	string	De registratiecode voor het lab.

shutdownOnIdleMode

Inventarisatie

Hiermee definieert u of de VM moet worden afgesloten bij niet-actieve en de criteria voor inactiviteitsdetectie.

Waarde	Description
LowUsage	De VM wordt beschouwd als niet-actief wanneer de gebruiker afwezig is en het verbruik van de resource (CPU en schijf) laag is.
None	De VIRTUELE machine wordt niet afgesloten wanneer deze niet actief is.
UserAbsence	De VIRTUELE machine wordt beschouwd als niet-actief wanneer er geen toetsenbord- of muisinvoer is.

Sku

Object

De definitie van het resourcemodel die de SKU vertegenwoordigt

Name	Type	Description
capacity	integer (int32)	Als de SKU uitschalen/inschalen ondersteunt, moet het gehele getal van de capaciteit worden opgenomen. Als uitschalen/inschalen niet mogelijk is voor de resource, kan dit worden weggelaten.
family	string	Als de service verschillende generaties hardware heeft, voor dezelfde SKU, kan die hier worden vastgelegd.
name	string	De naam van de SKU. Ex - P3. Dit is meestal een letter+cijfercode
size	string	De SKU-grootte. Wanneer het naamveld de combinatie van de laag en een andere waarde is, is dit de zelfstandige code.
tier	SkuTier	Dit veld moet worden geïmplementeerd door de resourceprovider als de service meer dan één laag heeft, maar niet vereist is voor een PUT.

SkuTier

Inventarisatie

Dit veld moet worden geïmplementeerd door de resourceprovider als de service meer dan één laag heeft, maar niet vereist is voor een PUT.

Waarde	Description
Basic
Free
Premium
Standard

systemData

Object

Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

Name	Type	Description
createdAt	string (date-time)	De tijdstempel van het maken van resources (UTC).
createdBy	string	De identiteit waarmee de resource is gemaakt.
createdByType	createdByType	Het type identiteit waarmee de resource is gemaakt.
lastModifiedAt	string (date-time)	De tijdstempel van de laatste wijziging van de resource (UTC)
lastModifiedBy	string	De identiteit die de resource voor het laatst heeft gewijzigd.
lastModifiedByType	createdByType	Het type identiteit dat de resource voor het laatst heeft gewijzigd.

VirtualMachineAdditionalCapabilities

Object

De extra mogelijkheden voor een lab-VM.

Name	Type	Default value	Description
installGpuDrivers	EnableState	Disabled	Vlag toevoegen om toegewezen GPU-stuurprogramma's vooraf te installeren.

VirtualMachineProfile

Object

De basisconfiguratie van virtuele machines voor een lab.

Name	Type	Default value	Description
additionalCapabilities	VirtualMachineAdditionalCapabilities		Aanvullende VM-mogelijkheden.
adminUser	Credentials		Referenties voor de gebruiker met beheerdersrechten op de virtuele machine.
createOption	CreateOption		Geeft aan op welke virtuele machines van het lab worden gemaakt.
imageReference	ImageReference		De installatiekopieënconfiguratie voor virtuele labmachines.
nonAdminUser	Credentials		Referenties voor de niet-beheerdersgebruiker op de VIRTUELE machine, indien aanwezig.
osType	OsType		Het type besturingssysteem van de installatiekopie
sku	Sku		De SKU voor het lab. Definieert het type virtuele machines dat in het lab wordt gebruikt.
usageQuota	string (duration)		Het aanvankelijke quotum dat aan elke labgebruiker is toegewezen. Moet een tijdsduur tussen 0 en 9999 uur zijn.
useSharedPassword	EnableState	Disabled	Als u deze optie inschakelt, wordt hetzelfde wachtwoord gebruikt voor alle vm's van gebruikers.

Delen via

Labs - Get

URI-parameters

Antwoorden

Voorbeelden

getLab

Voorbeeldaanvraag

Voorbeeldrespons

Definities

AutoShutdownProfile

ConnectionProfile

ConnectionType

createdByType

CreateOption

Credentials

EnableState

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ImageReference

Lab

LabNetworkProfile

LabState

OsType

ProvisioningState

ResourceOperationError

RosterProfile

SecurityProfile

shutdownOnIdleMode

Sku

SkuTier

systemData

VirtualMachineAdditionalCapabilities

VirtualMachineProfile