VirtualMachineScaleSetExtension

Manages an Extension for a Virtual Machine Scale Set.

NOTE: This resource is not intended to be used with the azure.compute.ScaleSet resource - instead it’s intended for this to be used with the azure.compute.LinuxVirtualMachineScaleSet and azure.compute.WindowsVirtualMachineScaleSet resources.

Example Usage

using System.Collections.Generic;
using System.Text.Json;
using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var exampleLinuxVirtualMachineScaleSet = new Azure.Compute.LinuxVirtualMachineScaleSet("exampleLinuxVirtualMachineScaleSet", new Azure.Compute.LinuxVirtualMachineScaleSetArgs
        {
        });
        //...
        var exampleVirtualMachineScaleSetExtension = new Azure.Compute.VirtualMachineScaleSetExtension("exampleVirtualMachineScaleSetExtension", new Azure.Compute.VirtualMachineScaleSetExtensionArgs
        {
            VirtualMachineScaleSetId = exampleLinuxVirtualMachineScaleSet.Id,
            Publisher = "Microsoft.Azure.Extensions",
            Type = "CustomScript",
            TypeHandlerVersion = "2.0",
            Settings = JsonSerializer.Serialize(new Dictionary<string, object?>
            {
                { "commandToExecute", "echo $HOSTNAME" },
            }),
        });
    }

}

package main

import (
    "encoding/json"
    "fmt"

    "github.com/pulumi/pulumi-azure/sdk/v3/go/azure/compute"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        exampleLinuxVirtualMachineScaleSet, err := compute.NewLinuxVirtualMachineScaleSet(ctx, "exampleLinuxVirtualMachineScaleSet", nil)
        if err != nil {
            return err
        }
        tmpJSON0, err := json.Marshal(map[string]interface{}{
            "commandToExecute": fmt.Sprintf("%v%v%v", "echo ", "$", "HOSTNAME"),
        })
        if err != nil {
            return err
        }
        json0 := string(tmpJSON0)
        _, err = compute.NewVirtualMachineScaleSetExtension(ctx, "exampleVirtualMachineScaleSetExtension", &compute.VirtualMachineScaleSetExtensionArgs{
            VirtualMachineScaleSetId: exampleLinuxVirtualMachineScaleSet.ID(),
            Publisher:                pulumi.String("Microsoft.Azure.Extensions"),
            Type:                     pulumi.String("CustomScript"),
            TypeHandlerVersion:       pulumi.String("2.0"),
            Settings:                 pulumi.String(json0),
        })
        if err != nil {
            return err
        }
        return nil
    })
}

import pulumi
import json
import pulumi_azure as azure

example_linux_virtual_machine_scale_set = azure.compute.LinuxVirtualMachineScaleSet("exampleLinuxVirtualMachineScaleSet")
#...
example_virtual_machine_scale_set_extension = azure.compute.VirtualMachineScaleSetExtension("exampleVirtualMachineScaleSetExtension",
    virtual_machine_scale_set_id=example_linux_virtual_machine_scale_set.id,
    publisher="Microsoft.Azure.Extensions",
    type="CustomScript",
    type_handler_version="2.0",
    settings=json.dumps({
        "commandToExecute": "echo $HOSTNAME",
    }))

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleLinuxVirtualMachineScaleSet = new azure.compute.LinuxVirtualMachineScaleSet("exampleLinuxVirtualMachineScaleSet", {});
//...
const exampleVirtualMachineScaleSetExtension = new azure.compute.VirtualMachineScaleSetExtension("exampleVirtualMachineScaleSetExtension", {
    virtualMachineScaleSetId: exampleLinuxVirtualMachineScaleSet.id,
    publisher: "Microsoft.Azure.Extensions",
    type: "CustomScript",
    typeHandlerVersion: "2.0",
    settings: JSON.stringify({
        commandToExecute: `echo $HOSTNAME`,
    }),
});

Create a VirtualMachineScaleSetExtension Resource

new VirtualMachineScaleSetExtension(name: string, args: VirtualMachineScaleSetExtensionArgs, opts?: CustomResourceOptions);

def VirtualMachineScaleSetExtension(resource_name, opts=None, auto_upgrade_minor_version=None, force_update_tag=None, name=None, protected_settings=None, provision_after_extensions=None, publisher=None, settings=None, type=None, type_handler_version=None, virtual_machine_scale_set_id=None, __props__=None);

func NewVirtualMachineScaleSetExtension(ctx *Context, name string, args VirtualMachineScaleSetExtensionArgs, opts ...ResourceOption) (*VirtualMachineScaleSetExtension, error)

public VirtualMachineScaleSetExtension(string name, VirtualMachineScaleSetExtensionArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args VirtualMachineScaleSetExtensionArgs: 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 VirtualMachineScaleSetExtensionArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

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

VirtualMachineScaleSetExtension Resource Properties

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

Inputs

The VirtualMachineScaleSetExtension resource accepts the following input properties:

Publisher string: Specifies the Publisher of the Extension. Changing this forces a new resource to be created.
Type string: Specifies the Type of the Extension. Changing this forces a new resource to be created.
TypeHandlerVersion string: Specifies the version of the extension to use, available versions can be found using the Azure CLI.
VirtualMachineScaleSetId string: The ID of the Virtual Machine Scale Set. Changing this forces a new resource to be created.
AutoUpgradeMinorVersion bool: Should the latest version of the Extension be used at Deployment Time, if one is available? This won’t auto-update the extension on existing installation. Defaults to true.
ForceUpdateTag string: A value which, when different to the previous value can be used to force-run the Extension even if the Extension Configuration hasn’t changed.
Name string: The name for the Virtual Machine Scale Set Extension. Changing this forces a new resource to be created.
ProtectedSettings string: A JSON String which specifies Sensitive Settings (such as Passwords) for the Extension.
ProvisionAfterExtensions List<string>: An ordered list of Extension names which this should be provisioned after.
Settings string: A JSON String which specifies Settings for the Extension.

Publisher string: Specifies the Publisher of the Extension. Changing this forces a new resource to be created.
Type string: Specifies the Type of the Extension. Changing this forces a new resource to be created.
TypeHandlerVersion string: Specifies the version of the extension to use, available versions can be found using the Azure CLI.
VirtualMachineScaleSetId string: The ID of the Virtual Machine Scale Set. Changing this forces a new resource to be created.
AutoUpgradeMinorVersion bool: Should the latest version of the Extension be used at Deployment Time, if one is available? This won’t auto-update the extension on existing installation. Defaults to true.
ForceUpdateTag string: A value which, when different to the previous value can be used to force-run the Extension even if the Extension Configuration hasn’t changed.
Name string: The name for the Virtual Machine Scale Set Extension. Changing this forces a new resource to be created.
ProtectedSettings string: A JSON String which specifies Sensitive Settings (such as Passwords) for the Extension.
ProvisionAfterExtensions []string: An ordered list of Extension names which this should be provisioned after.
Settings string: A JSON String which specifies Settings for the Extension.

publisher string: Specifies the Publisher of the Extension. Changing this forces a new resource to be created.
type string: Specifies the Type of the Extension. Changing this forces a new resource to be created.
typeHandlerVersion string: Specifies the version of the extension to use, available versions can be found using the Azure CLI.
virtualMachineScaleSetId string: The ID of the Virtual Machine Scale Set. Changing this forces a new resource to be created.
autoUpgradeMinorVersion boolean: Should the latest version of the Extension be used at Deployment Time, if one is available? This won’t auto-update the extension on existing installation. Defaults to true.
forceUpdateTag string: A value which, when different to the previous value can be used to force-run the Extension even if the Extension Configuration hasn’t changed.
name string: The name for the Virtual Machine Scale Set Extension. Changing this forces a new resource to be created.
protectedSettings string: A JSON String which specifies Sensitive Settings (such as Passwords) for the Extension.
provisionAfterExtensions string[]: An ordered list of Extension names which this should be provisioned after.
settings string: A JSON String which specifies Settings for the Extension.

publisher str: Specifies the Publisher of the Extension. Changing this forces a new resource to be created.
type str: Specifies the Type of the Extension. Changing this forces a new resource to be created.
type_handler_version str: Specifies the version of the extension to use, available versions can be found using the Azure CLI.
virtual_machine_scale_set_id str: The ID of the Virtual Machine Scale Set. Changing this forces a new resource to be created.
auto_upgrade_minor_version bool: Should the latest version of the Extension be used at Deployment Time, if one is available? This won’t auto-update the extension on existing installation. Defaults to true.
force_update_tag str: A value which, when different to the previous value can be used to force-run the Extension even if the Extension Configuration hasn’t changed.
name str: The name for the Virtual Machine Scale Set Extension. Changing this forces a new resource to be created.
protected_settings str: A JSON String which specifies Sensitive Settings (such as Passwords) for the Extension.
provision_after_extensions List[str]: An ordered list of Extension names which this should be provisioned after.
settings str: A JSON String which specifies Settings for the Extension.

Outputs

All input properties are implicitly available as output properties. Additionally, the VirtualMachineScaleSetExtension 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 VirtualMachineScaleSetExtension Resource

Get an existing VirtualMachineScaleSetExtension 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?: VirtualMachineScaleSetExtensionState, opts?: CustomResourceOptions): VirtualMachineScaleSetExtension

static get(resource_name, id, opts=None, auto_upgrade_minor_version=None, force_update_tag=None, name=None, protected_settings=None, provision_after_extensions=None, publisher=None, settings=None, type=None, type_handler_version=None, virtual_machine_scale_set_id=None, __props__=None);

func GetVirtualMachineScaleSetExtension(ctx *Context, name string, id IDInput, state *VirtualMachineScaleSetExtensionState, opts ...ResourceOption) (*VirtualMachineScaleSetExtension, error)

public static VirtualMachineScaleSetExtension Get(string name, Input<string> id, VirtualMachineScaleSetExtensionState? 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: Should the latest version of the Extension be used at Deployment Time, if one is available? This won’t auto-update the extension on existing installation. Defaults to true.
ForceUpdateTag string: A value which, when different to the previous value can be used to force-run the Extension even if the Extension Configuration hasn’t changed.
Name string: The name for the Virtual Machine Scale Set Extension. Changing this forces a new resource to be created.
ProtectedSettings string: A JSON String which specifies Sensitive Settings (such as Passwords) for the Extension.
ProvisionAfterExtensions List<string>: An ordered list of Extension names which this should be provisioned after.
Publisher string: Specifies the Publisher of the Extension. Changing this forces a new resource to be created.
Settings string: A JSON String which specifies Settings for the Extension.
Type string: Specifies the Type of the Extension. Changing this forces a new resource to be created.
TypeHandlerVersion string: Specifies the version of the extension to use, available versions can be found using the Azure CLI.
VirtualMachineScaleSetId string: The ID of the Virtual Machine Scale Set. Changing this forces a new resource to be created.

AutoUpgradeMinorVersion bool: Should the latest version of the Extension be used at Deployment Time, if one is available? This won’t auto-update the extension on existing installation. Defaults to true.
ForceUpdateTag string: A value which, when different to the previous value can be used to force-run the Extension even if the Extension Configuration hasn’t changed.
Name string: The name for the Virtual Machine Scale Set Extension. Changing this forces a new resource to be created.
ProtectedSettings string: A JSON String which specifies Sensitive Settings (such as Passwords) for the Extension.
ProvisionAfterExtensions []string: An ordered list of Extension names which this should be provisioned after.
Publisher string: Specifies the Publisher of the Extension. Changing this forces a new resource to be created.
Settings string: A JSON String which specifies Settings for the Extension.
Type string: Specifies the Type of the Extension. Changing this forces a new resource to be created.
TypeHandlerVersion string: Specifies the version of the extension to use, available versions can be found using the Azure CLI.
VirtualMachineScaleSetId string: The ID of the Virtual Machine Scale Set. Changing this forces a new resource to be created.

autoUpgradeMinorVersion boolean: Should the latest version of the Extension be used at Deployment Time, if one is available? This won’t auto-update the extension on existing installation. Defaults to true.
forceUpdateTag string: A value which, when different to the previous value can be used to force-run the Extension even if the Extension Configuration hasn’t changed.
name string: The name for the Virtual Machine Scale Set Extension. Changing this forces a new resource to be created.
protectedSettings string: A JSON String which specifies Sensitive Settings (such as Passwords) for the Extension.
provisionAfterExtensions string[]: An ordered list of Extension names which this should be provisioned after.
publisher string: Specifies the Publisher of the Extension. Changing this forces a new resource to be created.
settings string: A JSON String which specifies Settings for the Extension.
type string: Specifies the Type of the Extension. Changing this forces a new resource to be created.
typeHandlerVersion string: Specifies the version of the extension to use, available versions can be found using the Azure CLI.
virtualMachineScaleSetId string: The ID of the Virtual Machine Scale Set. Changing this forces a new resource to be created.

auto_upgrade_minor_version bool: Should the latest version of the Extension be used at Deployment Time, if one is available? This won’t auto-update the extension on existing installation. Defaults to true.
force_update_tag str: A value which, when different to the previous value can be used to force-run the Extension even if the Extension Configuration hasn’t changed.
name str: The name for the Virtual Machine Scale Set Extension. Changing this forces a new resource to be created.
protected_settings str: A JSON String which specifies Sensitive Settings (such as Passwords) for the Extension.
provision_after_extensions List[str]: An ordered list of Extension names which this should be provisioned after.
publisher str: Specifies the Publisher of the Extension. Changing this forces a new resource to be created.
settings str: A JSON String which specifies Settings for the Extension.
type str: Specifies the Type of the Extension. Changing this forces a new resource to be created.
type_handler_version str: Specifies the version of the extension to use, available versions can be found using the Azure CLI.
virtual_machine_scale_set_id str: The ID of the Virtual Machine Scale Set. 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