Start-AzLabServicesVMRedeployment

Action to redeploy a lab virtual machine to a different compute node. For troubleshooting connectivity.

Syntax

Start-AzLabServicesVMRedeployment
     [-SubscriptionId <String>]
     -ResourceId <String>
     [-DefaultProfile <PSObject>]
     [-AsJob]
     [-NoWait]
     [-PassThru]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]
Start-AzLabServicesVMRedeployment
     -LabName <String>
     -ResourceGroupName <String>
     [-SubscriptionId <String>]
     -VirtualMachineName <String>
     [-DefaultProfile <PSObject>]
     [-AsJob]
     [-NoWait]
     [-PassThru]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]

Description

Action to redeploy a lab virtual machine to a different compute node. For troubleshooting connectivity.

Examples

Example 1: Redeploy the specific Virtual machine.

Start-AzLabServicesVMRedeployment -LabName "Lab Name" -ResourceGroupName "Group Name" -VirtualMachineName 1

The Redeploy removes the machine and creates a new one.

Parameters

-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

-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

-LabName

The name of the lab that uniquely identifies it within containing lab account. Used in resource URIs.

Type:String
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

-PassThru

Returns true when the command succeeds

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

-ResourceId

Type:String
Position:Named
Default value:None
Required:True
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

-VirtualMachineName

The ID of the virtual machine that uniquely identifies it within the containing lab. Used in resource URIs.

Type:String
Position:Named
Default value:None
Required:True
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

IVirtualMachine

Boolean