Set-AzureVMExtension

Module:

Azure Module

Sets resource extensions for virtual machines.

Note

The cmdlets referenced in this documentation are for managing legacy Azure resources that use Azure Service Manager (ASM) APIs. This legacy PowerShell module isn't recommended when creating new resources since ASM is scheduled for retirement. For more information, see Azure Service Manager retirement.

The Az PowerShell module is the recommended PowerShell module for managing Azure Resource Manager (ARM) resources with PowerShell.

Syntax

SetByExtensionName (Default)

Set-AzureVMExtension
    [-ExtensionName] <String>
    [-Publisher] <String>
    [-Version] <String>
    [[-ReferenceName] <String>]
    [[-PublicConfiguration] <String>]
    [[-PrivateConfiguration] <String>]
    [[-PublicConfigKey] <String>]
    [[-PrivateConfigKey] <String>]
    -VM <IPersistentVM>
    [-Disable]
    [-Uninstall]
    [-ForceUpdate]
    [-Profile <AzureSMProfile>]
    [-InformationAction <ActionPreference>]
    [-InformationVariable <String>]
    [<CommonParameters>]

SetByExtensionNameAndConfigFile

Set-AzureVMExtension
    [-ExtensionName] <String>
    [-Publisher] <String>
    [-Version] <String>
    [[-ReferenceName] <String>]
    [[-PublicConfigPath] <String>]
    [[-PrivateConfigPath] <String>]
    [[-PublicConfigKey] <String>]
    [[-PrivateConfigKey] <String>]
    -VM <IPersistentVM>
    [-Disable]
    [-Uninstall]
    [-ForceUpdate]
    [-Profile <AzureSMProfile>]
    [-InformationAction <ActionPreference>]
    [-InformationVariable <String>]
    [<CommonParameters>]

SetByReferenceName

Set-AzureVMExtension
    [-ReferenceName] <String>
    [[-PublicConfiguration] <String>]
    [[-PrivateConfiguration] <String>]
    [[-PublicConfigKey] <String>]
    [[-PrivateConfigKey] <String>]
    -VM <IPersistentVM>
    [-Disable]
    [-Uninstall]
    [-ForceUpdate]
    [-Profile <AzureSMProfile>]
    [-InformationAction <ActionPreference>]
    [-InformationVariable <String>]
    [<CommonParameters>]

SetByReferenceNameAndConfigFile

Set-AzureVMExtension
    [-ReferenceName] <String>
    [[-PublicConfigPath] <String>]
    [[-PrivateConfigPath] <String>]
    [[-PublicConfigKey] <String>]
    [[-PrivateConfigKey] <String>]
    -VM <IPersistentVM>
    [-Disable]
    [-Uninstall]
    [-ForceUpdate]
    [-Profile <AzureSMProfile>]
    [-InformationAction <ActionPreference>]
    [-InformationVariable <String>]
    [<CommonParameters>]

Description

The Set-AzureVMExtension cmdlet sets resource extensions for virtual machines.

Examples

Example 1: Create a virtual machine with resource extensions applied

PS C:\> $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;

This command creates a virtual machine with resource extensions applied.

Parameters

-Disable

Indicates that this cmdlet disables the extension state.

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	7
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-ExtensionName

Specifies the extension name of the virtual machine.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

SetByExtensionName

Position:	1
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

SetByExtensionNameAndConfigFile

Position:	1
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-ForceUpdate

Indicates that this cmdlet re-applies a configuration to an extension when the configuration has not been updated.

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	11
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-InformationAction

Specifies how this cmdlet responds to an information event.

The acceptable values for this parameter are:

• Continue
• Ignore
• Inquire
• SilentlyContinue
• Stop
• Suspend

Parameter properties

Type:	ActionPreference
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	infa

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-InformationVariable

Specifies an information variable.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	iv

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-PrivateConfigKey

Specifies a private configuration key.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	10
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-PrivateConfigPath

Specifies the private configuration path.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

SetByExtensionNameAndConfigFile

Position:	6
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

SetByReferenceNameAndConfigFile

Position:	6
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-PrivateConfiguration

Specifies the private configuration text.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

SetByExtensionName

Position:	6
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

SetByReferenceName

Position:	6
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-Profile

Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.

Parameter properties

Type:	AzureSMProfile
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-PublicConfigKey

Specifies the public configuration key.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	9
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-PublicConfigPath

Specifies the public configuration path.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

SetByExtensionNameAndConfigFile

Position:	5
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

SetByReferenceNameAndConfigFile

Position:	5
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-PublicConfiguration

Specifies the public configuration text.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

SetByExtensionName

Position:	5
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

SetByReferenceName

Position:	5
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-Publisher

Specifies the publisher of the extension.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

SetByExtensionName

Position:	2
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

SetByExtensionNameAndConfigFile

Position:	2
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-ReferenceName

Specifies the reference name of the extension.

This is a user-defined string that can be used to refer to an extension. You need to specify it when the extension is added to the virtual machine for the first time. For subsequent updates, you need to specify the previously used reference name while updating the extension. The ReferenceName assigned to an extension is returned using the Get-AzureVM cmdlet.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

SetByExtensionName

Position:	4
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

SetByExtensionNameAndConfigFile

Position:	4
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-Uninstall

Indicates that this cmdlet uninstalls the resource extension from the virtual machine.

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	8
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-Version

Specifies the extension version.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

SetByExtensionName

Position:	3
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

SetByExtensionNameAndConfigFile

Position:	3
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-VM

Specifies the persistent virtual machine object.

Parameter properties

Type:	IPersistentVM
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	InputObject

Parameter sets

(All)

Position:	Named
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	True
Value from remaining arguments:	False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Related Links

• Get-AzureVMExtension
• Remove-AzureVMExtension
• Get-AzureVM