Class Extension

Manages a Virtual Machine Extension to provide post deployment configuration and run automated tasks.

NOTE: Custom Script Extensions for Linux & Windows require that the commandToExecute returns a 0 exit code to be classified as successfully deployed. You can achieve this by appending exit 0 to the end of your commandToExecute.

NOTE: Custom Script Extensions require that the Azure Virtual Machine Guest Agent is running on the Virtual Machine.

Inheritance

System.Object

Resource

CustomResource

Extension

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Azure.Compute

Assembly: Pulumi.Azure.dll

Syntax

public class Extension : CustomResource

Constructors

Extension(String, ExtensionArgs, CustomResourceOptions)

Create a Extension resource with the given unique name, arguments, and options.

Declaration

public Extension(string name, ExtensionArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
ExtensionArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

AutoUpgradeMinorVersion

Specifies if the platform deploys the latest minor version update to the type_handler_version specified.

Declaration

public Output<bool?> AutoUpgradeMinorVersion { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

Name

The name of the virtual machine extension peering. Changing this forces a new resource to be created.

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

ProtectedSettings

The protected_settings passed to the extension, like settings, these are specified as a JSON object in a string.

Declaration

public Output<string> ProtectedSettings { get; }

Property Value

Type	Description
Output<System.String>

Publisher

The publisher of the extension, available publishers can be found by using the Azure CLI.

Declaration

public Output<string> Publisher { get; }

Property Value

Type	Description
Output<System.String>

Settings

The settings passed to the extension, these are specified as a JSON object in a string.

Declaration

public Output<string> Settings { get; }

Property Value

Type	Description
Output<System.String>

Tags

A mapping of tags to assign to the resource.

Declaration

public Output<ImmutableDictionary<string, string>> Tags { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.String>>

Type

The type of extension, available types for a publisher can be found using the Azure CLI.

Declaration

public Output<string> Type { get; }

Property Value

Type	Description
Output<System.String>

TypeHandlerVersion

Specifies the version of the extension to use, available versions can be found using the Azure CLI.

Declaration

public Output<string> TypeHandlerVersion { get; }

Property Value

Type	Description
Output<System.String>

VirtualMachineId

The ID of the Virtual Machine. Changing this forces a new resource to be created

Declaration

public Output<string> VirtualMachineId { get; }

Property Value

Type	Description
Output<System.String>

Methods

Get(String, Input<String>, ExtensionState, CustomResourceOptions)

Get an existing Extension resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration

public static Extension Get(string name, Input<string> id, ExtensionState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
ExtensionState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
Extension