New-AzLabServicesLabPlan
Operation to create or update a Lab Plan resource.
Syntax
New-AzLabServicesLabPlan
-Name <String>
-ResourceGroupName <String>
[-SubscriptionId <String>]
-Location <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 <Hashtable>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
Operation to create or update a Lab Plan resource.
Examples
Example 1: Create a new Lab plan.
New-AzLabServicesLabPlan `
-LabPlanName "testplan" `
-ResourceGroupName "Group Name" `
-Location "westus2" `
-AllowedRegion @('westus2', 'eastus2') `
-DefaultAutoShutdownProfileShutdownOnDisconnect Disabled `
-DefaultAutoShutdownProfileShutdownOnIdle None `
-DefaultAutoShutdownProfileShutdownWhenNotConnected Disabled `
-DefaultConnectionProfileClientRdpAccess Public `
-DefaultConnectionProfileClientSshAccess None `
-SupportInfoEmail 'test@contoso.com' `
-SupportInfoInstruction 'test information' `
-SupportInfoPhone '123-456-7890' `
-SupportInfoUrl 'https:\\test.com' `
-DefaultConnectionProfileWebRdpAccess None `
-DefaultConnectionProfileWebSshAccess None
Location Name
-------- ----
westus2 testplanCreate a lab plan.
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 |
-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 |
-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 |
-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 |
-Location
The geo-location where the resource lives
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| 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: | Hashtable |
| 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 |
Outputs
Azure PowerShell