Lab Plans - Create Or Update

Uppdateringar eller skapar en labbplansresurs.
Åtgärd för att skapa eller uppdatera en labbplansresurs.

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

URI-parametrar

Name In Required Type Description
labPlanName
path True
  • string

Namnet på den labbplan som unikt identifierar den i resursgruppen. Används i resurs-URI:er och i användargränssnittet.

resourceGroupName
path True
  • string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

subscriptionId
path True
  • string

ID för målprenumerationen.

api-version
query True
  • string

DEN API-version som ska användas för den här åtgärden.

Begärandetext

Name Required Type Description
location True
  • string

Den geo-plats där resursen finns

identity

Information om hanterad identitet

properties.allowedRegions
  • string[]

De tillåtna regioner som labbskapare kan använda när de skapar labb med den här labbplanen.

properties.defaultAutoShutdownProfile

Standardprofilen för labbavstängning. Detta kan ändras på en labbresurs och tillhandahåller bara en standardprofil.

properties.defaultConnectionProfile

Standardprofilen för labbanslutning. Detta kan ändras på en labbresurs och tillhandahåller bara en standardprofil.

properties.defaultNetworkProfile

Nätverksprofilen för labbplanen. Om du vill tillämpa nätverksprinciper för labb måste de definieras här och kan inte ändras när det finns befintliga labb som är associerade med den här labbplanen.

properties.linkedLmsInstance
  • string

Bas-URL:en för den lms-instans som den här labbplanen kan länka labblistor mot.

properties.sharedGalleryId
  • string

Resurs-ID för Shared Image Gallery som är kopplat till den här labbplanen. När du sparar en avbildning av en virtuell labbmallsdator sparas den i det här galleriet. Delade avbildningar från galleriet kan göras tillgängliga för användning när du skapar nya labb.

properties.supportInfo

Supportens kontaktinformation och instruktioner för användare av labbplanen. Den här informationen visas för labbägare och användare av virtuella datorer för alla labb i labbplanen.

tags
  • object

Resurstaggar.

Svar

Name Type Description
200 OK

Uppdateringen lyckades. svaret innehåller labbplanen.

201 Created

Det gick att skapa. svaret innehåller labbplanen.

202 Accepted

Uppdateringen lyckades och har en tidskrävande åtgärd. svaret innehåller labbplanen.

Other Status Codes

Standardfelsvaret.

Exempel

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

Definitioner

AutoShutdownProfile

Profil för hur du hanterar avstängning av virtuella datorer.

ConnectionProfile

Anslutningsprofil för hur användare ansluter till virtuella labbdatorer.

ConnectionType

Den aktiverade åtkomstnivån för webbåtkomst via SSH.

createdByType

Den typ av identitet som skapade resursen.

EnableState

Om avstängning vid frånkoppling är aktiverat

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

ErrorDetail

Felinformationen.

ErrorResponse

Felsvar

Identity

Identitet för resursen.

LabPlan

Labbplaner fungerar som en behörighetscontainer för att skapa labb via labs.azure.com. Dessutom kan de tillhandahålla en uppsättning standardkonfigurationer som gäller vid tidpunkten för skapandet av ett labb, men dessa standardvärden kan fortfarande skrivas över.

LabPlanNetworkProfile

Profil för hur du hanterar nätverk för labbplaner.

ProvisioningState

Aktuellt etableringstillstånd för labbplanen.

ResourceIdentityType

Identitetstypen.

shutdownOnIdleMode

Definierar om du vill stänga av den virtuella datorn vid inaktivitet och kriterierna för identifiering av inaktivitet.

SupportInfo

Kontaktuppgifter och instruktioner för supporten.

systemData

Metadata som rör skapande och senaste ändring av resursen.

AutoShutdownProfile

Profil för hur du hanterar avstängning av virtuella datorer.

Name Type Default Value Description
disconnectDelay
  • string

Hur lång tid en virtuell dator fortsätter att köras efter att en användare har kopplats från om det här beteendet är aktiverat.

idleDelay
  • string

Hur lång tid en virtuell dator kommer att vara inaktiv innan den stängs av om det här beteendet är aktiverat.

noConnectDelay
  • string

Hur lång tid en virtuell dator kommer att fortsätta att köras innan den stängs av om ingen anslutning upprättas och det här beteendet är aktiverat.

shutdownOnDisconnect Disabled

Om avstängning vid frånkoppling är aktiverat

shutdownOnIdle None

Om en virtuell dator ska stängas av när den har varit inaktiv under en viss tid.

shutdownWhenNotConnected Disabled

Om en virtuell dator kommer att stängas av när den inte har anslutits till efter en viss tid.

ConnectionProfile

Anslutningsprofil för hur användare ansluter till virtuella labbdatorer.

Name Type Default Value Description
clientRdpAccess None

Den aktiverade åtkomstnivån för klientåtkomst via RDP.

clientSshAccess None

Den aktiverade åtkomstnivån för klientåtkomst via SSH.

webRdpAccess None

Den aktiverade åtkomstnivån för webbåtkomst via RDP.

webSshAccess None

Den aktiverade åtkomstnivån för webbåtkomst via SSH.

ConnectionType

Den aktiverade åtkomstnivån för webbåtkomst via SSH.

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

createdByType

Den typ av identitet som skapade resursen.

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

EnableState

Om avstängning vid frånkoppling är aktiverat

Name Type Description
Disabled
  • string
Enabled
  • string

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name Type Description
info
  • object

Den ytterligare informationen.

type
  • string

Ytterligare informationstyp.

ErrorDetail

Felinformationen.

Name Type Description
additionalInfo

Ytterligare information om felet.

code
  • string

Felkoden.

details

Felinformationen.

message
  • string

Felmeddelandet.

target
  • string

Felmålet.

ErrorResponse

Felsvar

Name Type Description
error

Felobjektet.

Identity

Identitet för resursen.

Name Type Description
principalId
  • string

Huvud-ID för resursidentitet.

tenantId
  • string

Klientorganisations-ID för resursen.

type

Identitetstypen.

LabPlan

Labbplaner fungerar som en behörighetscontainer för att skapa labb via labs.azure.com. Dessutom kan de tillhandahålla en uppsättning standardkonfigurationer som gäller vid tidpunkten för skapandet av ett labb, men dessa standardvärden kan fortfarande skrivas över.

Name Type Description
id
  • string

Fullständigt kvalificerat resurs-ID för resursen. Exempel – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

identity

Information om hanterad identitet

location
  • string

Den geo-plats där resursen finns

name
  • string

Namnet på resursen

properties.allowedRegions
  • string[]

De tillåtna regioner som labbskapare kan använda när de skapar labb med den här labbplanen.

properties.defaultAutoShutdownProfile

Standardprofilen för labbavstängning. Detta kan ändras på en labbresurs och tillhandahåller bara en standardprofil.

properties.defaultConnectionProfile

Standardprofilen för labbanslutning. Detta kan ändras på en labbresurs och tillhandahåller bara en standardprofil.

properties.defaultNetworkProfile

Nätverksprofilen för labbplanen. Om du vill tillämpa nätverksprinciper för labb måste de definieras här och kan inte ändras när det finns befintliga labb som är associerade med den här labbplanen.

properties.linkedLmsInstance
  • string

Bas-URL:en för den lms-instans som den här labbplanen kan länka labblistor mot.

properties.provisioningState

Aktuellt etableringstillstånd för labbplanen.

properties.sharedGalleryId
  • string

Resurs-ID för Shared Image Gallery som är kopplat till den här labbplanen. När du sparar en avbildning av en virtuell labbmallsdator sparas den i det här galleriet. Delade avbildningar från galleriet kan göras tillgängliga för användning när du skapar nya labb.

properties.supportInfo

Supportens kontaktinformation och instruktioner för användare av labbplanen. Den här informationen visas för labbägare och användare av virtuella datorer för alla labb i labbplanen.

systemData

Metadata som rör skapande och senaste ändring av labbplanen.

tags
  • object

Resurstaggar.

type
  • string

Resurstypen. T.ex. "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

LabPlanNetworkProfile

Profil för hur du hanterar nätverk för labbplaner.

Name Type Description
subnetId
  • string

Resurs-ID för det externa undernätet

ProvisioningState

Aktuellt etableringstillstånd för labbplanen.

Name Type Description
Creating
  • string

Resursen håller på att skapas.

Deleting
  • string

Resursen håller på att tas bort.

Failed
  • string

Föregående åtgärd på resursen misslyckades med att lämna resursen i feltillstånd.

Locked
  • string

Resursen är låst och ändringarna blockeras för närvarande. Detta kan bero på underhåll eller en schemalagd åtgärd. Tillståndet återgår till lyckades när låsningsåtgärden har slutförts.

Succeeded
  • string

Resursen är i felfritt tillstånd när den har skapats eller uppdaterats.

Updating
  • string

Nya egenskapsvärden tillämpas på resursen.

ResourceIdentityType

Identitetstypen.

Name Type Description
SystemAssigned
  • string

shutdownOnIdleMode

Definierar om du vill stänga av den virtuella datorn vid inaktivitet och kriterierna för identifiering av inaktivitet.

Name Type Description
LowUsage
  • string

Den virtuella datorn betraktas som inaktiv när användaren är frånvarande och resursförbrukningen (CPU och disk) är låg.

None
  • string

Den virtuella datorn stängs inte av när den är inaktiv.

UserAbsence
  • string

Den virtuella datorn betraktas som inaktiv när det inte finns några tangentbords- eller musindata.

SupportInfo

Kontaktuppgifter och instruktioner för supporten.

Name Type Description
email
  • string

E-postadress för supportkontakt.

instructions
  • string

Supportinstruktioner.

phone
  • string

Telefonnummer för supportkontakt.

url
  • string

Supportwebbadress.

systemData

Metadata som rör skapande och senaste ändring av resursen.

Name Type Description
createdAt
  • string

Tidsstämpeln för resursskapande (UTC).

createdBy
  • string

Identiteten som skapade resursen.

createdByType

Den typ av identitet som skapade resursen.

lastModifiedAt
  • string

Tidsstämpeln för resursens senaste ändring (UTC)

lastModifiedBy
  • string

Identiteten som senast ändrade resursen.

lastModifiedByType

Den typ av identitet som senast ändrade resursen.