Update-AzStackHCIVMVirtualMachine

Reference

Module:: Az.StackHCIVM

The operation to update a virtual machine instance.

Syntax

Update-AzStackHCIVMVirtualMachine
      -Name <String>
      -ResourceGroupName <String>
      [-SubscriptionId <String>]
      [-ProvisionVMAgent]
      [-ProvisionVMConfigAgent]
      [-VmMemoryInMB <Int64>]
      [-VmProcessor <Int32>]
      [-VmSize <String>]
      [-DefaultProfile <PSObject>]
      [-AsJob]
      [-NoWait]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzStackHCIVMVirtualMachine
      -ResourceId <String>
      [-ProvisionVMAgent]
      [-ProvisionVMConfigAgent]
      [-VmMemoryInMB <Int64>]
      [-VmProcessor <Int32>]
      [-VmSize <String>]
      [-DefaultProfile <PSObject>]
      [-AsJob]
      [-NoWait]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The operation to update a virtual machine instance.

Examples

Example 1: Update the Size of the Virtual Machine.

Update-AzStackHCIVMVirtualMachine  -Name "testVm" -ResourceGroupName "test-rg" -VmMemoryInMB "4"

Name            ResourceGroupName
----            -----------------
testVm          test-rg

This command updates an existing virtual machine in the specified resource group.

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 credentials, account, tenant, and subscription used for communication with Azure.

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

-Name

Name of the virtual machine

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

-ProvisionVMAgent

Indicates whether virtual machine agent should be provisioned on the virtual machine.

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

-ProvisionVMConfigAgent

Indicates whether virtual machine configuration agent should be provisioned on the virtual machine.

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

The ARM Resource ID of the virtual network.

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

-VmMemoryInMB

RAM in MB for the virtual machine instance

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

-VmProcessor

number of processors for the virtual machine instance

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

-VmSize

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

Outputs

IVirtualMachineInstance

Share via