Update-AzLabServicesLabPlan

Reference

Module:: Az.LabServices

Operation to update a Lab Plan resource.

Syntax

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>]

Update-AzLabServicesLabPlan
      [-SubscriptionId <String>]
      -LabPlan <LabPlan>
      [-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.

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-AsJob

Run the command as a job

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultAutoShutdownProfileDisconnectDelay

The amount of time a VM will stay running after a user disconnects if this behavior is enabled.

Type:	TimeSpan
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultAutoShutdownProfileIdleDelay

The amount of time a VM will idle before it is shutdown if this behavior is enabled.

Type:	TimeSpan
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	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.

Type:	TimeSpan
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultAutoShutdownProfileShutdownOnDisconnect

Whether shutdown on disconnect is enabled

Type:	EnableState
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultAutoShutdownProfileShutdownOnIdle

Whether a VM will get shutdown when it has idled for a period of time.

Type:	ShutdownOnIdleMode
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultAutoShutdownProfileShutdownWhenNotConnected

Whether a VM will get shutdown when it hasn't been connected to after a period of time.

Type:	EnableState
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultConnectionProfileClientRdpAccess

The enabled access level for Client Access over RDP.

Type:	ConnectionType
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultConnectionProfileClientRdpAccessEnabled

Type:	ConnectionType
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultConnectionProfileClientSshAccess

The enabled access level for Client Access over SSH.

Type:	ConnectionType
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultConnectionProfileClientSshAccessEnabled

Type:	ConnectionType
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultConnectionProfileWebRdpAccess

The enabled access level for Web Access over RDP.

Type:	ConnectionType
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultConnectionProfileWebSshAccess

The enabled access level for Web Access over SSH.

Type:	ConnectionType
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultNetworkProfileSubnetId

The external subnet resource id

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

Type:	PSObject
Aliases:	AzureRMContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-LabPlan

To construct, see NOTES section for LABPLAN properties and create a hash table.

Type:	LabPlan
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-LinkedLmsInstance

Base Url of the lms instance this lab plan can link lab rosters against.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Name

The name of the lab plan that uniquely identifies it within containing resource group. Used in resource URIs and in UI.

Type:	String
Aliases:	LabPlanName
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-NoWait

Run the command asynchronously

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ResourceGroupName

The name of the resource group. The name is case insensitive.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	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.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-SubscriptionId

The ID of the target subscription.

Type:	String
Position:	Named
Default value:	(Get-AzContext).Subscription.Id
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-SupportInfoEmail

Support contact email address.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-SupportInfoInstruction

Support instructions.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-SupportInfoPhone

Support contact phone number.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-SupportInfoUrl

Support web address.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Tag

Resource tags.

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

LabPlan

Outputs

ILabPlan

Share via