< Back

Remove-AzureRmVMDscExtension

Tue Jan 29, 2019 9:39 pm

NAME Remove-AzureRmVMDscExtension



SYNOPSIS

Removes a DSC extension handler from a virtual machine in a resource group.





SYNTAX

Remove-AzureRmVMDscExtension [-ResourceGroupName] <String> [-VMName] <String> [[-Name] <String>] [-DefaultProfile <IAzureContextContainer>]

[-Confirm] [-WhatIf] [<CommonParameters>]





DESCRIPTION

The Remove-AzureRmVMDscExtension cmdlet removes a Desired State Configuration (DSC) extension handler from a virtual machine in a resource group.





PARAMETERS

-DefaultProfile <IAzureContextContainer>

The credentials, account, tenant, and subscription used for communication with azure.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Name <String>

Specifies the name of the DSC extension that this cmdlet removes. The Set-AzureRmVMDscExtension cmdlet sets this name to

Microsoft.Powershell.DSC, which is the default value used by Remove-AzureRmVMDscExtension .



Required? false

Position? 2

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-ResourceGroupName <String>

Specifies the name of the resource group of the virtual machine.



Required? true

Position? 0

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-VMName <String>

Specifies the name of a virtual machine from which this cmdlet removes the DSC extension.



Required? true

Position? 1

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Confirm [<SwitchParameter>]

Prompts you for confirmation before running the cmdlet.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]

Shows what would happen if the cmdlet runs.



The cmdlet is not run.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

None

This cmdlet does not accept any input.





OUTPUTS

Microsoft.Azure.Commands.Compute.Models.PSAzureOperationResponse







NOTES









Example 1: Remove a DSC extension



PS C:\\> Remove-AzureRmVMDscExtension -ResourceGroupName "ResourceGroup001" -VMName "VM07" -Name "DSC"



This command removes the extension named DSC on virtual machine named VM07.







RELATED LINKS

Online Version: https://docs.microsoft.com/en-us/powers ... cextension

Get-AzureRmVMDscExtension

Set-AzureRmVMDscExtension