Edit

Remove-AzVmssExtension

  • Reference
Module:
Az.Compute

Removes an extension from the VMSS.

Syntax

Remove-AzVmssExtension
      [-VirtualMachineScaleSet] <PSVirtualMachineScaleSet>
      [-Name] <String>
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-AzVmssExtension
      [-VirtualMachineScaleSet] <PSVirtualMachineScaleSet>
      [-Id] <String>
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Remove-AzVmssExtension cmdlet removes an extension from the Virtual Machine Scale Set (VMSS).

Examples

Example 1: Remove a VMSS extension

$vmss = Get-AzVmss -ResourceGroupName $RGName -VMScaleSetName $vmssName 
Remove-AzVmssExtension -VirtualMachineScaleSet $vmss -Name $vmssExtensionName
Update-AzVmss -ResourceGroupName $RGName -Name $vmssName -VirtualMachineScaleSet $vmss

This command removes the extension of a VMSS and update the VMSS after the modification.

Example 2: Remove an instance from within a VMSS

$vmss = Get-AzVmss -ResourceGroupName $RGName -VMScaleSetName $vmssName 
Remove-AzVmssExtension -VirtualMachineScaleSet $vmss -Id $extensionId

This command removes specify extension id from the VMSS.

Parameters

-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:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Id

Specifies the ID of the extension that this cmdlet removes from the VMSS.

Type:String
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Name

Specifies the name of the extension that this cmdlet removes from the VMSS.

Type:String
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-VirtualMachineScaleSet

Specifies the VMSS from which to remove the extension from.

Type:PSVirtualMachineScaleSet
Position:0
Default value:None
Required:True
Accept pipeline input:True
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

Inputs

PSVirtualMachineScaleSet

String

Outputs

PSVirtualMachineScaleSet