< Back
Get-AzureRmVMDscExtension
Post
NAME Get-AzureRmVMDscExtension
SYNOPSIS
Gets the settings of the DSC extension on a particular virtual machine.
SYNTAX
Get-AzureRmVMDscExtension [-ResourceGroupName] <String> [-VMName] <String> [[-Name] <String>] [-DefaultProfile <IAzureContextContainer>] [-Status]
[<CommonParameters>]
DESCRIPTION
The Get-AzureRmVMDscExtension cmdlet gets the settings of the Desired State Configuration (DSC) extension on a particular virtual machine.
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 Azure Resource Manager resource that represents the extension. The Set-AzureRmVMDscExtension cmdlet sets this name
to Microsoft.Powershell.DSC, which is the same value that is used by Get-AzureRmVMDscExtension . Specify this parameter only if you changed
the default name in the Set-AzureRmVMDscExtension cmdlet or used a different resource name in a Resource Manager template.
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
-Status [<SwitchParameter>]
Indicates that this cmdlet gets the instance view of the DSC extension.
Required? false
Position? named
Default value False
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-VMName <String>
Specifies the name of a virtual machine for which this cmdlet gets the DSC extension.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
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.Extension.DSC.VirtualMachineDscExtensionContext
NOTES
Example 1: Get the settings of a DSC extension
PS C:\\> Get-AzureRmVMDscExtension -ResourceGroupName "ResourceGroup002" -VMName "VM07" -Name "DSC"
This command gets the settings of extension named DSC on the virtual machine named VM07.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... cextension
Remove-AzureRmVMDscExtension
Set-AzureRmVMDscExtension
SYNOPSIS
Gets the settings of the DSC extension on a particular virtual machine.
SYNTAX
Get-AzureRmVMDscExtension [-ResourceGroupName] <String> [-VMName] <String> [[-Name] <String>] [-DefaultProfile <IAzureContextContainer>] [-Status]
[<CommonParameters>]
DESCRIPTION
The Get-AzureRmVMDscExtension cmdlet gets the settings of the Desired State Configuration (DSC) extension on a particular virtual machine.
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 Azure Resource Manager resource that represents the extension. The Set-AzureRmVMDscExtension cmdlet sets this name
to Microsoft.Powershell.DSC, which is the same value that is used by Get-AzureRmVMDscExtension . Specify this parameter only if you changed
the default name in the Set-AzureRmVMDscExtension cmdlet or used a different resource name in a Resource Manager template.
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
-Status [<SwitchParameter>]
Indicates that this cmdlet gets the instance view of the DSC extension.
Required? false
Position? named
Default value False
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-VMName <String>
Specifies the name of a virtual machine for which this cmdlet gets the DSC extension.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
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.Extension.DSC.VirtualMachineDscExtensionContext
NOTES
Example 1: Get the settings of a DSC extension
PS C:\\> Get-AzureRmVMDscExtension -ResourceGroupName "ResourceGroup002" -VMName "VM07" -Name "DSC"
This command gets the settings of extension named DSC on the virtual machine named VM07.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... cextension
Remove-AzureRmVMDscExtension
Set-AzureRmVMDscExtension