Update-AzLabServicesLabPlan
Operation to update a Lab Plan resource.
Syntax
UpdateExpanded (Default)
Update-AzLabServicesLabPlan
-Name <String>
-ResourceGroupName <String>
[-SubscriptionId <String>]
[-AllowedRegion <String[]>]
[-DefaultAutoShutdownProfileDisconnectDelay <TimeSpan>]
[-DefaultAutoShutdownProfileIdleDelay <TimeSpan>]
[-DefaultAutoShutdownProfileNoConnectDelay <TimeSpan>]
[-DefaultAutoShutdownProfileShutdownOnDisconnect <EnableState>]
[-DefaultAutoShutdownProfileShutdownOnIdle <ShutdownOnIdleMode>]
[-DefaultAutoShutdownProfileShutdownWhenNotConnected <EnableState>]
[-DefaultConnectionProfileClientRdpAccess <ConnectionType>]
[-DefaultConnectionProfileClientSshAccess <ConnectionType>]
[-DefaultConnectionProfileWebRdpAccess <ConnectionType>]
[-DefaultConnectionProfileWebSshAccess <ConnectionType>]
[-DefaultNetworkProfileSubnetId <String>]
[-LinkedLmsInstance <String>]
[-SharedGalleryId <String>]
[-SupportInfoEmail <String>]
[-SupportInfoInstruction <String>]
[-SupportInfoPhone <String>]
[-SupportInfoUrl <String>]
[-Tag <String[]>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
LabPlan
Update-AzLabServicesLabPlan
-LabPlan <LabPlan>
[-SubscriptionId <String>]
[-AllowedRegion <String[]>]
[-DefaultAutoShutdownProfileDisconnectDelay <TimeSpan>]
[-DefaultAutoShutdownProfileIdleDelay <TimeSpan>]
[-DefaultAutoShutdownProfileNoConnectDelay <TimeSpan>]
[-DefaultAutoShutdownProfileShutdownOnDisconnect <EnableState>]
[-DefaultAutoShutdownProfileShutdownOnIdle <ShutdownOnIdleMode>]
[-DefaultAutoShutdownProfileShutdownWhenNotConnected <EnableState>]
[-DefaultNetworkProfileSubnetId <String>]
[-LinkedLmsInstance <String>]
[-SharedGalleryId <String>]
[-SupportInfoEmail <String>]
[-SupportInfoInstruction <String>]
[-SupportInfoPhone <String>]
[-SupportInfoUrl <String>]
[-Tag <String[]>]
[-DefaultConnectionProfileClientRdpAccessEnabled <ConnectionType>]
[-DefaultConnectionProfileClientSshAccessEnabled <ConnectionType>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Operation to update a Lab Plan resource.
Examples
Example 1: Update Lab plan
Update-AzLabServicesLabPlan -ResourceGroupName "Group Name" -Name "LabPlan Name" -DefaultAutoShutdownProfileShutdownOnDisconnect 'Enabled' -DefaultAutoShutdownProfileDisconnectDelay "00:17:00"
Location Name
-------- ----
westus2 LabPlan Name
This example updates the lab plan enabling the Shutdown on disconnect with a delay of 17 minutes.
Parameters
-AllowedRegion
The allowed regions for the lab creator to use when creating labs using this lab plan.
Parameter properties
Type: String [ ]
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-AsJob
Run the command as a job
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: cf
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DefaultAutoShutdownProfileDisconnectDelay
The amount of time a VM will stay running after a user disconnects if this behavior is enabled.
Parameter properties
Type: TimeSpan
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DefaultAutoShutdownProfileIdleDelay
The amount of time a VM will idle before it is shutdown if this behavior is enabled.
Parameter properties
Type: TimeSpan
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DefaultAutoShutdownProfileNoConnectDelay
The amount of time a VM will stay running before it is shutdown if no connection is made and this behavior is enabled.
Parameter properties
Type: TimeSpan
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DefaultAutoShutdownProfileShutdownOnDisconnect
Whether shutdown on disconnect is enabled
Parameter properties
Type: EnableState
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DefaultAutoShutdownProfileShutdownOnIdle
Whether a VM will get shutdown when it has idled for a period of time.
Parameter properties
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DefaultAutoShutdownProfileShutdownWhenNotConnected
Whether a VM will get shutdown when it hasn't been connected to after a period of time.
Parameter properties
Type: EnableState
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DefaultConnectionProfileClientRdpAccess
The enabled access level for Client Access over RDP.
Parameter properties
Type: ConnectionType
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DefaultConnectionProfileClientRdpAccessEnabled
Operation to update a Lab Plan resource.
Parameter properties
Type: ConnectionType
Default value: None Supports wildcards: False DontShow: False
Parameter sets
LabPlan
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DefaultConnectionProfileClientSshAccess
The enabled access level for Client Access over SSH.
Parameter properties
Type: ConnectionType
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DefaultConnectionProfileClientSshAccessEnabled
Operation to update a Lab Plan resource.
Parameter properties
Type: ConnectionType
Default value: None Supports wildcards: False DontShow: False
Parameter sets
LabPlan
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DefaultConnectionProfileWebRdpAccess
The enabled access level for Web Access over RDP.
Parameter properties
Type: ConnectionType
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DefaultConnectionProfileWebSshAccess
The enabled access level for Web Access over SSH.
Parameter properties
Type: ConnectionType
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DefaultNetworkProfileSubnetId
The external subnet resource id
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DefaultProfile
The DefaultProfile parameter is not functional.
Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.
Parameter properties
Type: PSObject
Default value: None Supports wildcards: False DontShow: False Aliases: AzureRMContext, AzureCredential
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-LabPlan
To construct, see NOTES section for LABPLAN properties and create a hash table.
Parameter properties
Type: LabPlan
Default value: None Supports wildcards: False DontShow: False
Parameter sets
LabPlan
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-LinkedLmsInstance
Base Url of the lms instance this lab plan can link lab rosters against.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Name
The name of the lab plan that uniquely identifies it within containing resource group.
Used in resource URIs and in UI.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False Aliases: LabPlanName
Parameter sets
UpdateExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-NoWait
Run the command asynchronously
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ResourceGroupName
The name of the resource group.
The name is case insensitive.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SharedGalleryId
Resource ID of the Shared Image Gallery attached to this lab plan.
When saving a lab template virtual machine image it will be persisted in this gallery.
Shared images from the gallery can be made available to use when creating new labs.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SubscriptionId
The ID of the target subscription.
Parameter properties
Type: String
Default value: (Get-AzContext).Subscription.Id Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SupportInfoEmail
Support contact email address.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SupportInfoInstruction
Support instructions.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SupportInfoPhone
Support contact phone number.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SupportInfoUrl
Support web address.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Tag
Resource tags.
Parameter properties
Type: String [ ]
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-WhatIf
Shows what would happen if the cmdlet runs.
The cmdlet is not run.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: wi
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable,
-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
about_CommonParameters .
Outputs