Get-AzureVMDscExtension

[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]

Get-AzureVMDscExtension

Gets the settings of the DSC extension on a particular VM.

Syntax

Parameter Set: Default
Get-AzureVMDscExtension [[-Version] <String> ] -VM <IPersistentVM> [ <CommonParameters>]

Detailed Description

Gets the settings of the DSC extension on a particular VM.

Parameters

-Version<String>

The specific version of the DSC extension that Get-AzureVMDSCExtension will get the settings from.

Aliases

none

Required?

false

Position?

2

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-VM<IPersistentVM>

The Virtual Machine to get the settings from.

Aliases

InputObject

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByValue, ByPropertyName)

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see  about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

  • Microsoft.WindowsAzure.Commands.ServiceManagement.IaaS.Extensions.VirtualMachineDscExtensionContext

Examples

-------------------------- EXAMPLE 1 --------------------------

Description

-----------

This command gets the settings of the DSC Extension on a VM.

C:\PS>Get-AzureVMDscExtension -VM $vm

ModulesUrl            : https://myaccount.blob.core.windows.net/windows-powershell-dsc/MyConfiguration.ps1.zip
ConfigurationFunction : MyConfiguration.ps1\MyConfiguration
Properties            : {ServerName}
ExtensionName         : DSC
Publisher             : Microsoft.Powershell
Version               : 1.*
PrivateConfiguration  :
PublicConfiguration   : {
"ModulesUrl": "https://myaccount.blob.core.windows.net/windows-powershell-dsc/MyConfiguration.ps1.zip",
"ConfigurationFunction": "MyConfiguration.ps1\\MyConfiguration",
"Properties": {
"ServerName": "C:\\MyDirectory"
}
}
ReferenceName         : DSC
State                 : Enable
RoleName              : my-vm