Class VirtualMachineExtension

Describes a Virtual Machine Extension.

Inheritance
Object
Resource
VirtualMachineExtension
Inherited Members
Namespace: System.Dynamic.ExpandoObject
Assembly: Microsoft.Azure.Management.Compute.dll
Syntax
[Microsoft.Rest.Serialization.JsonTransformation]
public class VirtualMachineExtension : Microsoft.Azure.Management.Compute.Models.Resource

Constructors

VirtualMachineExtension()

Initializes a new instance of the VirtualMachineExtension class.

Declaration
public VirtualMachineExtension ();

VirtualMachineExtension(String, String, String, String, IDictionary<String,String>, String, String, String, String, Nullable<Boolean>, Object, Object, String, VirtualMachineExtensionInstanceView)

Initializes a new instance of the VirtualMachineExtension class.

Declaration
public VirtualMachineExtension (string location, string id = null, string name = null, string type = null, System.Collections.Generic.IDictionary<string,string> tags = null, string forceUpdateTag = null, string publisher = null, string virtualMachineExtensionType = null, string typeHandlerVersion = null, Nullable<bool> autoUpgradeMinorVersion = null, object settings = null, object protectedSettings = null, string provisioningState = null, Microsoft.Azure.Management.Compute.Models.VirtualMachineExtensionInstanceView instanceView = null);
Parameters
String location

Resource location
String id

Resource Id
String name

Resource name
String type

Resource type
IDictionary<String,String> tags

Resource tags
String forceUpdateTag

How the extension handler should be forced to update even if the extension configuration has not changed.
String publisher

The name of the extension handler publisher.
String virtualMachineExtensionType

Specifies the type of the extension; an example is "CustomScriptExtension".
String typeHandlerVersion

Specifies the version of the script handler.
Nullable<Boolean> autoUpgradeMinorVersion

Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true.
Object settings

Json formatted public settings for the extension.
Object protectedSettings

The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
String provisioningState

The provisioning state, which only appears in the response.
VirtualMachineExtensionInstanceView instanceView

The virtual machine extension instance view.

Properties

AutoUpgradeMinorVersion

Gets or sets indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true.

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.autoUpgradeMinorVersion")]
public Nullable<bool> AutoUpgradeMinorVersion { get; set; }
Property Value
Nullable<Boolean>

ForceUpdateTag

Gets or sets how the extension handler should be forced to update even if the extension configuration has not changed.

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.forceUpdateTag")]
public string ForceUpdateTag { get; set; }
Property Value
String

InstanceView

Gets or sets the virtual machine extension instance view.

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.instanceView")]
public Microsoft.Azure.Management.Compute.Models.VirtualMachineExtensionInstanceView InstanceView { get; set; }
Property Value
VirtualMachineExtensionInstanceView

ProtectedSettings

Gets or sets the extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.protectedSettings")]
public object ProtectedSettings { get; set; }
Property Value
Object

ProvisioningState

Gets the provisioning state, which only appears in the response.

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.provisioningState")]
public string ProvisioningState { get; }
Property Value
String

Publisher

Gets or sets the name of the extension handler publisher.

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.publisher")]
public string Publisher { get; set; }
Property Value
String

Settings

Gets or sets json formatted public settings for the extension.

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.settings")]
public object Settings { get; set; }
Property Value
Object

TypeHandlerVersion

Gets or sets specifies the version of the script handler.

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.typeHandlerVersion")]
public string TypeHandlerVersion { get; set; }
Property Value
String

VirtualMachineExtensionType

Gets or sets specifies the type of the extension; an example is "CustomScriptExtension".

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.type")]
public string VirtualMachineExtensionType { get; set; }
Property Value
String

Methods

Validate()

Validate the object.

Declaration
public override void Validate ();
Exceptions
ValidationException

Thrown if validation fails