PnP.Wsl2
Search Results for

    Show / Hide Table of Contents

    Remove-PnPWsl2Instance

    SYNOPSIS

    Removes a PnP WSL2 instance.

    SYNTAX

    Remove-PnPWsl2Instance [-Instance] <Object> [-Force] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
     
    

    DESCRIPTION

    The Remove-PnPWsl2Instance cmdlet removes a specified PnP WSL2 instance. It requires the name of the instance as a mandatory parameter. The cmdlet validates the instance name before attempting to remove it. If the -Force switch is not provided, it prompts for confirmation before removing the instance.

    EXAMPLE 1

    # Remove a PnP WSL2 instance named "MyInstance"
    Remove-PnPWsl2Instance -Instance "MyInstance"
    

    EXAMPLE 2

    # Remove a PnP WSL2 instance named "MyInstance" without prompting for confirmation
    Remove-PnPWsl2Instance -Instance "MyInstance" -Force
    

    -Instance

    The name of the PnP WSL2 instance to remove. This parameter is mandatory and accepts pipeline input.

    Type: Object
    Parameter Sets: (All)
    Aliases:
    
    Required: True
    Position: 1
    Default value: None
    Accept pipeline input: True (ByValue)
    Accept wildcard characters: False
    

    -Force

    If this switch is provided, the cmdlet does not prompt for confirmation before removing the instance.

    Type: SwitchParameter
    Parameter Sets: (All)
    Aliases:
    
    Required: False
    Position: Named
    Default value: 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
    Parameter Sets: (All)
    Aliases: wi
    
    Required: False
    Position: Named
    Default value: None
    Accept pipeline input: False
    Accept wildcard characters: False
    

    -Confirm

    Prompts you for confirmation before running the cmdlet.

    Type: SwitchParameter
    Parameter Sets: (All)
    Aliases: cf
    
    Required: False
    Position: Named
    Default value: None
    Accept pipeline input: False
    Accept wildcard characters: False
    

    System.String

    • Edit this page
    In this article
    Back to top Generated by DocFX