Remove-Lab

SYNOPSIS

Remove the lab

SYNTAX

ByName (Default)

Remove-Lab [[-Name] <String>] [-RemoveExternalSwitches] [-WhatIf] [-Confirm] [<CommonParameters>]

ByPath

Remove-Lab -Path <String> [-RemoveExternalSwitches] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Fully removes the current lab, the lab stored at a specific location or a named lab. For Azure-based labs, the lab resource group is removed completely, regardless of additional machines deployed to the resource group

EXAMPLES

Example 1

PS C:\> Remove-Lab -Name MyOldLab

Removes the lab with the name MyOldLab

PARAMETERS

-Name

The name of the lab

Type: String
Parameter Sets: ByName
Aliases:

Required: False
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Path

The path to the lab

Type: String
Parameter Sets: ByPath
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-RemoveExternalSwitches

Indicates that external switches should also be removed

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Confirm

Indicates that all actions need confirmation

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

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

-WhatIf

Indicates if a trial run should be executed

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

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

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES