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.

Create a Extension Resource

new Extension(name: string, args: ExtensionArgs, opts?: CustomResourceOptions);

def Extension(resource_name, opts=None, auto_upgrade_minor_version=None, name=None, protected_settings=None, publisher=None, settings=None, tags=None, type=None, type_handler_version=None, virtual_machine_id=None, __props__=None);

func NewExtension(ctx *Context, name string, args ExtensionArgs, opts ...ResourceOption) (*Extension, error)

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

name string: The unique name of the resource.
args ExtensionArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args ExtensionArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ExtensionArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

Extension Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The Extension resource accepts the following input properties:

Publisher string: The publisher of the extension, available publishers can be found by using the Azure CLI.
Type string: The type of extension, available types for a publisher can be found using the Azure CLI.
TypeHandlerVersion string: Specifies the version of the extension to use, available versions can be found using the Azure CLI.
VirtualMachineId string: The ID of the Virtual Machine. Changing this forces a new resource to be created
AutoUpgradeMinorVersion bool: Specifies if the platform deploys the latest minor version update to the type_handler_version specified.
Name string: The name of the virtual machine extension peering. Changing this forces a new resource to be created.
ProtectedSettings string: The protected_settings passed to the extension, like settings, these are specified as a JSON object in a string.
Settings string: The settings passed to the extension, these are specified as a JSON object in a string.
Tags Dictionary<string, string>: A mapping of tags to assign to the resource.

Publisher string: The publisher of the extension, available publishers can be found by using the Azure CLI.
Type string: The type of extension, available types for a publisher can be found using the Azure CLI.
TypeHandlerVersion string: Specifies the version of the extension to use, available versions can be found using the Azure CLI.
VirtualMachineId string: The ID of the Virtual Machine. Changing this forces a new resource to be created
AutoUpgradeMinorVersion bool: Specifies if the platform deploys the latest minor version update to the type_handler_version specified.
Name string: The name of the virtual machine extension peering. Changing this forces a new resource to be created.
ProtectedSettings string: The protected_settings passed to the extension, like settings, these are specified as a JSON object in a string.
Settings string: The settings passed to the extension, these are specified as a JSON object in a string.
Tags map[string]string: A mapping of tags to assign to the resource.

publisher string: The publisher of the extension, available publishers can be found by using the Azure CLI.
type string: The type of extension, available types for a publisher can be found using the Azure CLI.
typeHandlerVersion string: Specifies the version of the extension to use, available versions can be found using the Azure CLI.
virtualMachineId string: The ID of the Virtual Machine. Changing this forces a new resource to be created
autoUpgradeMinorVersion boolean: Specifies if the platform deploys the latest minor version update to the type_handler_version specified.
name string: The name of the virtual machine extension peering. Changing this forces a new resource to be created.
protectedSettings string: The protected_settings passed to the extension, like settings, these are specified as a JSON object in a string.
settings string: The settings passed to the extension, these are specified as a JSON object in a string.
tags {[key: string]: string}: A mapping of tags to assign to the resource.

publisher str: The publisher of the extension, available publishers can be found by using the Azure CLI.
type str: The type of extension, available types for a publisher can be found using the Azure CLI.
type_handler_version str: Specifies the version of the extension to use, available versions can be found using the Azure CLI.
virtual_machine_id str: The ID of the Virtual Machine. Changing this forces a new resource to be created
auto_upgrade_minor_version bool: Specifies if the platform deploys the latest minor version update to the type_handler_version specified.
name str: The name of the virtual machine extension peering. Changing this forces a new resource to be created.
protected_settings str: The protected_settings passed to the extension, like settings, these are specified as a JSON object in a string.
settings str: The settings passed to the extension, these are specified as a JSON object in a string.
tags Dict[str, str]: A mapping of tags to assign to the resource.

Outputs

All input properties are implicitly available as output properties. Additionally, the Extension resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

Look up an Existing Extension Resource

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

public static get(name: string, id: Input<ID>, state?: ExtensionState, opts?: CustomResourceOptions): Extension

static get(resource_name, id, opts=None, auto_upgrade_minor_version=None, name=None, protected_settings=None, publisher=None, settings=None, tags=None, type=None, type_handler_version=None, virtual_machine_id=None, __props__=None);

func GetExtension(ctx *Context, name string, id IDInput, state *ExtensionState, opts ...ResourceOption) (*Extension, error)

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

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

AutoUpgradeMinorVersion bool: Specifies if the platform deploys the latest minor version update to the type_handler_version specified.
Name string: The name of the virtual machine extension peering. Changing this forces a new resource to be created.
ProtectedSettings string: The protected_settings passed to the extension, like settings, these are specified as a JSON object in a string.
Publisher string: The publisher of the extension, available publishers can be found by using the Azure CLI.
Settings string: The settings passed to the extension, these are specified as a JSON object in a string.
Tags Dictionary<string, string>: A mapping of tags to assign to the resource.
Type string: The type of extension, available types for a publisher can be found using the Azure CLI.
TypeHandlerVersion string: Specifies the version of the extension to use, available versions can be found using the Azure CLI.
VirtualMachineId string: The ID of the Virtual Machine. Changing this forces a new resource to be created

AutoUpgradeMinorVersion bool: Specifies if the platform deploys the latest minor version update to the type_handler_version specified.
Name string: The name of the virtual machine extension peering. Changing this forces a new resource to be created.
ProtectedSettings string: The protected_settings passed to the extension, like settings, these are specified as a JSON object in a string.
Publisher string: The publisher of the extension, available publishers can be found by using the Azure CLI.
Settings string: The settings passed to the extension, these are specified as a JSON object in a string.
Tags map[string]string: A mapping of tags to assign to the resource.
Type string: The type of extension, available types for a publisher can be found using the Azure CLI.
TypeHandlerVersion string: Specifies the version of the extension to use, available versions can be found using the Azure CLI.
VirtualMachineId string: The ID of the Virtual Machine. Changing this forces a new resource to be created

autoUpgradeMinorVersion boolean: Specifies if the platform deploys the latest minor version update to the type_handler_version specified.
name string: The name of the virtual machine extension peering. Changing this forces a new resource to be created.
protectedSettings string: The protected_settings passed to the extension, like settings, these are specified as a JSON object in a string.
publisher string: The publisher of the extension, available publishers can be found by using the Azure CLI.
settings string: The settings passed to the extension, these are specified as a JSON object in a string.
tags {[key: string]: string}: A mapping of tags to assign to the resource.
type string: The type of extension, available types for a publisher can be found using the Azure CLI.
typeHandlerVersion string: Specifies the version of the extension to use, available versions can be found using the Azure CLI.
virtualMachineId string: The ID of the Virtual Machine. Changing this forces a new resource to be created

auto_upgrade_minor_version bool: Specifies if the platform deploys the latest minor version update to the type_handler_version specified.
name str: The name of the virtual machine extension peering. Changing this forces a new resource to be created.
protected_settings str: The protected_settings passed to the extension, like settings, these are specified as a JSON object in a string.
publisher str: The publisher of the extension, available publishers can be found by using the Azure CLI.
settings str: The settings passed to the extension, these are specified as a JSON object in a string.
tags Dict[str, str]: A mapping of tags to assign to the resource.
type str: The type of extension, available types for a publisher can be found using the Azure CLI.
type_handler_version str: Specifies the version of the extension to use, available versions can be found using the Azure CLI.
virtual_machine_id str: The ID of the Virtual Machine. Changing this forces a new resource to be created

Package Details

Repository: https://github.com/pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud