Export (0) Print
Expand All
Expand Minimize

Set-AzureVMExtension

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

Set-AzureVMExtension

Sets resource extensions for virtual machines (VMs).

Syntax

Parameter Set: SetByExtensionName
Set-AzureVMExtension [-ExtensionName] <String> [-Publisher] <String> [-Version] <String> [[-ReferenceName] <String> ] [[-PublicConfiguration] <String> ] [[-PrivateConfiguration] <String> ] [[-Disable]] [[-Uninstall]] [[-PublicConfigKey] <String> ] [[-PrivateConfigKey] <String> ] -VM <IPersistentVM> [ <CommonParameters>]

Parameter Set: SetByExtensionNameAndConfigFile
Set-AzureVMExtension [-ExtensionName] <String> [-Publisher] <String> [-Version] <String> [[-ReferenceName] <String> ] [[-PublicConfigPath] <String> ] [[-PrivateConfigPath] <String> ] [[-Disable]] [[-Uninstall]] [[-PublicConfigKey] <String> ] [[-PrivateConfigKey] <String> ] -VM <IPersistentVM> [ <CommonParameters>]

Parameter Set: SetByReferenceName
Set-AzureVMExtension [-ReferenceName] <String> [[-PublicConfiguration] <String> ] [[-PrivateConfiguration] <String> ] [[-Disable]] [[-Uninstall]] [[-PublicConfigKey] <String> ] [[-PrivateConfigKey] <String> ] -VM <IPersistentVM> [ <CommonParameters>]

Parameter Set: SetByReferenceNameAndConfigFile
Set-AzureVMExtension [-ReferenceName] <String> [[-PublicConfigPath] <String> ] [[-PrivateConfigPath] <String> ] [[-Disable]] [[-Uninstall]] [[-PublicConfigKey] <String> ] [[-PrivateConfigKey] <String> ] -VM <IPersistentVM> [ <CommonParameters>]




Detailed Description

This cmdlet sets resource extensions for VMs.

Parameters

-Disable

Sets the extension state to 'Disable'.


Aliases

none

Required?

false

Position?

5

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-ExtensionName<String>

Specifies the name of the extension.


Aliases

none

Required?

true

Position?

2

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-PrivateConfigKey<String>

Aliases

none

Required?

false

Position?

8

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-PrivateConfigPath<String>

Specifies the private configuration path.


Aliases

none

Required?

false

Position?

7

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-PrivateConfiguration<String>

Specifies the private configuration text.


Aliases

none

Required?

false

Position?

4

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-PublicConfigKey<String>

Aliases

none

Required?

false

Position?

10

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-PublicConfigPath<String>

Specifies the public configuration path.


Aliases

none

Required?

false

Position?

3

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-PublicConfiguration<String>

Specifies the public configuration text.


Aliases

none

Required?

false

Position?

6

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Publisher<String>

Specifies the extension's publisher.


Aliases

none

Required?

true

Position?

3

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-ReferenceName<String>

Specifies the extension's reference name.


Aliases

none

Required?

true

Position?

2

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Uninstall

Aliases

none

Required?

false

Position?

9

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Version<String>

Specifies the extension version.


Aliases

none

Required?

true

Position?

4

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-VM<IPersistentVM>

Specifies the VM object.


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 (http://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.

Examples

EXAMPLE 1

This example creates a new VM with resource extensions applied.


C:\PS>$x = New-AzureVMConfig -Name $vm -InstanceSize Small -ImageName $img;$x = Add-AzureProvisioningConfig -VM $x -Password $pwd -AdminUsername $usr -Windows;$x = Set-AzureVMExtension -VM $x -ExtensionName $ext1 -Publisher $publisher -Version $ver -PublicConfiguration $p1 -PrivateConfiguration $p2;$x = Set-AzureVMExtension -VM $x -ExtensionName $ext2 -Publisher $publisher -Version $ver -PublicConfiguration $p3 -PrivateConfiguration $p4;New-AzureVM -Location $loc -ServiceName $svc -VM $x;

Related topics

Show:
© 2015 Microsoft