Docs Packages
  1. Pulumi Registry
  2. Azure Classic
  3. API Docs
  4. compute
  5. Extension
azure logo
Azure Classic v5.43.0, May 6 23

azure.compute.Extension

Explore with Pulumi AI

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.

Example Usage

using System.Collections.Generic;
using System.IO;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new()
    {
        Location = "West Europe",
    });

    var exampleVirtualNetwork = new Azure.Network.VirtualNetwork("exampleVirtualNetwork", new()
    {
        AddressSpaces = new[]
        {
            "10.0.0.0/16",
        },
        Location = exampleResourceGroup.Location,
        ResourceGroupName = exampleResourceGroup.Name,
    });

    var exampleSubnet = new Azure.Network.Subnet("exampleSubnet", new()
    {
        ResourceGroupName = exampleResourceGroup.Name,
        VirtualNetworkName = exampleVirtualNetwork.Name,
        AddressPrefixes = new[]
        {
            "10.0.2.0/24",
        },
    });

    var exampleNetworkInterface = new Azure.Network.NetworkInterface("exampleNetworkInterface", new()
    {
        Location = exampleResourceGroup.Location,
        ResourceGroupName = exampleResourceGroup.Name,
        IpConfigurations = new[]
        {
            new Azure.Network.Inputs.NetworkInterfaceIpConfigurationArgs
            {
                Name = "testconfiguration1",
                SubnetId = exampleSubnet.Id,
                PrivateIpAddressAllocation = "Dynamic",
            },
        },
    });

    var exampleLinuxVirtualMachine = new Azure.Compute.LinuxVirtualMachine("exampleLinuxVirtualMachine", new()
    {
        ResourceGroupName = exampleResourceGroup.Name,
        Location = exampleResourceGroup.Location,
        Size = "Standard_F2",
        AdminUsername = "adminuser",
        NetworkInterfaceIds = new[]
        {
            exampleNetworkInterface.Id,
        },
        AdminSshKeys = new[]
        {
            new Azure.Compute.Inputs.LinuxVirtualMachineAdminSshKeyArgs
            {
                Username = "adminuser",
                PublicKey = File.ReadAllText("~/.ssh/id_rsa.pub"),
            },
        },
        OsDisk = new Azure.Compute.Inputs.LinuxVirtualMachineOsDiskArgs
        {
            Caching = "ReadWrite",
            StorageAccountType = "Standard_LRS",
        },
        SourceImageReference = new Azure.Compute.Inputs.LinuxVirtualMachineSourceImageReferenceArgs
        {
            Publisher = "Canonical",
            Offer = "UbuntuServer",
            Sku = "16.04-LTS",
            Version = "latest",
        },
    });

    var exampleExtension = new Azure.Compute.Extension("exampleExtension", new()
    {
        VirtualMachineId = exampleLinuxVirtualMachine.Id,
        Publisher = "Microsoft.Azure.Extensions",
        Type = "CustomScript",
        TypeHandlerVersion = "2.0",
        Settings = @" {
  ""commandToExecute"": ""hostname && uptime""
 }
",
        Tags = 
        {
            { "environment", "Production" },
        },
    });

});

package main

import (
	"os"

	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/compute"
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/network"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func readFileOrPanic(path string) pulumi.StringPtrInput {
	data, err := os.ReadFile(path)
	if err != nil {
		panic(err.Error())
	}
	return pulumi.String(string(data))
}

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleVirtualNetwork, err := network.NewVirtualNetwork(ctx, "exampleVirtualNetwork", &network.VirtualNetworkArgs{
			AddressSpaces: pulumi.StringArray{
				pulumi.String("10.0.0.0/16"),
			},
			Location:          exampleResourceGroup.Location,
			ResourceGroupName: exampleResourceGroup.Name,
		})
		if err != nil {
			return err
		}
		exampleSubnet, err := network.NewSubnet(ctx, "exampleSubnet", &network.SubnetArgs{
			ResourceGroupName:  exampleResourceGroup.Name,
			VirtualNetworkName: exampleVirtualNetwork.Name,
			AddressPrefixes: pulumi.StringArray{
				pulumi.String("10.0.2.0/24"),
			},
		})
		if err != nil {
			return err
		}
		exampleNetworkInterface, err := network.NewNetworkInterface(ctx, "exampleNetworkInterface", &network.NetworkInterfaceArgs{
			Location:          exampleResourceGroup.Location,
			ResourceGroupName: exampleResourceGroup.Name,
			IpConfigurations: network.NetworkInterfaceIpConfigurationArray{
				&network.NetworkInterfaceIpConfigurationArgs{
					Name:                       pulumi.String("testconfiguration1"),
					SubnetId:                   exampleSubnet.ID(),
					PrivateIpAddressAllocation: pulumi.String("Dynamic"),
				},
			},
		})
		if err != nil {
			return err
		}
		exampleLinuxVirtualMachine, err := compute.NewLinuxVirtualMachine(ctx, "exampleLinuxVirtualMachine", &compute.LinuxVirtualMachineArgs{
			ResourceGroupName: exampleResourceGroup.Name,
			Location:          exampleResourceGroup.Location,
			Size:              pulumi.String("Standard_F2"),
			AdminUsername:     pulumi.String("adminuser"),
			NetworkInterfaceIds: pulumi.StringArray{
				exampleNetworkInterface.ID(),
			},
			AdminSshKeys: compute.LinuxVirtualMachineAdminSshKeyArray{
				&compute.LinuxVirtualMachineAdminSshKeyArgs{
					Username:  pulumi.String("adminuser"),
					PublicKey: readFileOrPanic("~/.ssh/id_rsa.pub"),
				},
			},
			OsDisk: &compute.LinuxVirtualMachineOsDiskArgs{
				Caching:            pulumi.String("ReadWrite"),
				StorageAccountType: pulumi.String("Standard_LRS"),
			},
			SourceImageReference: &compute.LinuxVirtualMachineSourceImageReferenceArgs{
				Publisher: pulumi.String("Canonical"),
				Offer:     pulumi.String("UbuntuServer"),
				Sku:       pulumi.String("16.04-LTS"),
				Version:   pulumi.String("latest"),
			},
		})
		if err != nil {
			return err
		}
		_, err = compute.NewExtension(ctx, "exampleExtension", &compute.ExtensionArgs{
			VirtualMachineId:   exampleLinuxVirtualMachine.ID(),
			Publisher:          pulumi.String("Microsoft.Azure.Extensions"),
			Type:               pulumi.String("CustomScript"),
			TypeHandlerVersion: pulumi.String("2.0"),
			Settings:           pulumi.String(" {\n  \"commandToExecute\": \"hostname && uptime\"\n }\n"),
			Tags: pulumi.StringMap{
				"environment": pulumi.String("Production"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.network.VirtualNetwork;
import com.pulumi.azure.network.VirtualNetworkArgs;
import com.pulumi.azure.network.Subnet;
import com.pulumi.azure.network.SubnetArgs;
import com.pulumi.azure.network.NetworkInterface;
import com.pulumi.azure.network.NetworkInterfaceArgs;
import com.pulumi.azure.network.inputs.NetworkInterfaceIpConfigurationArgs;
import com.pulumi.azure.compute.LinuxVirtualMachine;
import com.pulumi.azure.compute.LinuxVirtualMachineArgs;
import com.pulumi.azure.compute.inputs.LinuxVirtualMachineAdminSshKeyArgs;
import com.pulumi.azure.compute.inputs.LinuxVirtualMachineOsDiskArgs;
import com.pulumi.azure.compute.inputs.LinuxVirtualMachineSourceImageReferenceArgs;
import com.pulumi.azure.compute.Extension;
import com.pulumi.azure.compute.ExtensionArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()        
            .location("West Europe")
            .build());

        var exampleVirtualNetwork = new VirtualNetwork("exampleVirtualNetwork", VirtualNetworkArgs.builder()        
            .addressSpaces("10.0.0.0/16")
            .location(exampleResourceGroup.location())
            .resourceGroupName(exampleResourceGroup.name())
            .build());

        var exampleSubnet = new Subnet("exampleSubnet", SubnetArgs.builder()        
            .resourceGroupName(exampleResourceGroup.name())
            .virtualNetworkName(exampleVirtualNetwork.name())
            .addressPrefixes("10.0.2.0/24")
            .build());

        var exampleNetworkInterface = new NetworkInterface("exampleNetworkInterface", NetworkInterfaceArgs.builder()        
            .location(exampleResourceGroup.location())
            .resourceGroupName(exampleResourceGroup.name())
            .ipConfigurations(NetworkInterfaceIpConfigurationArgs.builder()
                .name("testconfiguration1")
                .subnetId(exampleSubnet.id())
                .privateIpAddressAllocation("Dynamic")
                .build())
            .build());

        var exampleLinuxVirtualMachine = new LinuxVirtualMachine("exampleLinuxVirtualMachine", LinuxVirtualMachineArgs.builder()        
            .resourceGroupName(exampleResourceGroup.name())
            .location(exampleResourceGroup.location())
            .size("Standard_F2")
            .adminUsername("adminuser")
            .networkInterfaceIds(exampleNetworkInterface.id())
            .adminSshKeys(LinuxVirtualMachineAdminSshKeyArgs.builder()
                .username("adminuser")
                .publicKey(Files.readString(Paths.get("~/.ssh/id_rsa.pub")))
                .build())
            .osDisk(LinuxVirtualMachineOsDiskArgs.builder()
                .caching("ReadWrite")
                .storageAccountType("Standard_LRS")
                .build())
            .sourceImageReference(LinuxVirtualMachineSourceImageReferenceArgs.builder()
                .publisher("Canonical")
                .offer("UbuntuServer")
                .sku("16.04-LTS")
                .version("latest")
                .build())
            .build());

        var exampleExtension = new Extension("exampleExtension", ExtensionArgs.builder()        
            .virtualMachineId(exampleLinuxVirtualMachine.id())
            .publisher("Microsoft.Azure.Extensions")
            .type("CustomScript")
            .typeHandlerVersion("2.0")
            .settings("""
 {
  "commandToExecute": "hostname && uptime"
 }
            """)
            .tags(Map.of("environment", "Production"))
            .build());

    }
}

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_virtual_network = azure.network.VirtualNetwork("exampleVirtualNetwork",
    address_spaces=["10.0.0.0/16"],
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name)
example_subnet = azure.network.Subnet("exampleSubnet",
    resource_group_name=example_resource_group.name,
    virtual_network_name=example_virtual_network.name,
    address_prefixes=["10.0.2.0/24"])
example_network_interface = azure.network.NetworkInterface("exampleNetworkInterface",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    ip_configurations=[azure.network.NetworkInterfaceIpConfigurationArgs(
        name="testconfiguration1",
        subnet_id=example_subnet.id,
        private_ip_address_allocation="Dynamic",
    )])
example_linux_virtual_machine = azure.compute.LinuxVirtualMachine("exampleLinuxVirtualMachine",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    size="Standard_F2",
    admin_username="adminuser",
    network_interface_ids=[example_network_interface.id],
    admin_ssh_keys=[azure.compute.LinuxVirtualMachineAdminSshKeyArgs(
        username="adminuser",
        public_key=(lambda path: open(path).read())("~/.ssh/id_rsa.pub"),
    )],
    os_disk=azure.compute.LinuxVirtualMachineOsDiskArgs(
        caching="ReadWrite",
        storage_account_type="Standard_LRS",
    ),
    source_image_reference=azure.compute.LinuxVirtualMachineSourceImageReferenceArgs(
        publisher="Canonical",
        offer="UbuntuServer",
        sku="16.04-LTS",
        version="latest",
    ))
example_extension = azure.compute.Extension("exampleExtension",
    virtual_machine_id=example_linux_virtual_machine.id,
    publisher="Microsoft.Azure.Extensions",
    type="CustomScript",
    type_handler_version="2.0",
    settings=""" {
  "commandToExecute": "hostname && uptime"
 }
""",
    tags={
        "environment": "Production",
    })

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

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleVirtualNetwork = new azure.network.VirtualNetwork("exampleVirtualNetwork", {
    addressSpaces: ["10.0.0.0/16"],
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
});
const exampleSubnet = new azure.network.Subnet("exampleSubnet", {
    resourceGroupName: exampleResourceGroup.name,
    virtualNetworkName: exampleVirtualNetwork.name,
    addressPrefixes: ["10.0.2.0/24"],
});
const exampleNetworkInterface = new azure.network.NetworkInterface("exampleNetworkInterface", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    ipConfigurations: [{
        name: "testconfiguration1",
        subnetId: exampleSubnet.id,
        privateIpAddressAllocation: "Dynamic",
    }],
});
const exampleLinuxVirtualMachine = new azure.compute.LinuxVirtualMachine("exampleLinuxVirtualMachine", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    size: "Standard_F2",
    adminUsername: "adminuser",
    networkInterfaceIds: [exampleNetworkInterface.id],
    adminSshKeys: [{
        username: "adminuser",
        publicKey: fs.readFileSync("~/.ssh/id_rsa.pub"),
    }],
    osDisk: {
        caching: "ReadWrite",
        storageAccountType: "Standard_LRS",
    },
    sourceImageReference: {
        publisher: "Canonical",
        offer: "UbuntuServer",
        sku: "16.04-LTS",
        version: "latest",
    },
});
const exampleExtension = new azure.compute.Extension("exampleExtension", {
    virtualMachineId: exampleLinuxVirtualMachine.id,
    publisher: "Microsoft.Azure.Extensions",
    type: "CustomScript",
    typeHandlerVersion: "2.0",
    settings: ` {
  "commandToExecute": "hostname && uptime"
 }
`,
    tags: {
        environment: "Production",
    },
});

resources:
  exampleResourceGroup:
    type: azure:core:ResourceGroup
    properties:
      location: West Europe
  exampleVirtualNetwork:
    type: azure:network:VirtualNetwork
    properties:
      addressSpaces:
        - 10.0.0.0/16
      location: ${exampleResourceGroup.location}
      resourceGroupName: ${exampleResourceGroup.name}
  exampleSubnet:
    type: azure:network:Subnet
    properties:
      resourceGroupName: ${exampleResourceGroup.name}
      virtualNetworkName: ${exampleVirtualNetwork.name}
      addressPrefixes:
        - 10.0.2.0/24
  exampleNetworkInterface:
    type: azure:network:NetworkInterface
    properties:
      location: ${exampleResourceGroup.location}
      resourceGroupName: ${exampleResourceGroup.name}
      ipConfigurations:
        - name: testconfiguration1
          subnetId: ${exampleSubnet.id}
          privateIpAddressAllocation: Dynamic
  exampleLinuxVirtualMachine:
    type: azure:compute:LinuxVirtualMachine
    properties:
      resourceGroupName: ${exampleResourceGroup.name}
      location: ${exampleResourceGroup.location}
      size: Standard_F2
      adminUsername: adminuser
      networkInterfaceIds:
        - ${exampleNetworkInterface.id}
      adminSshKeys:
        - username: adminuser
          publicKey:
            fn::readFile: ~/.ssh/id_rsa.pub
      osDisk:
        caching: ReadWrite
        storageAccountType: Standard_LRS
      sourceImageReference:
        publisher: Canonical
        offer: UbuntuServer
        sku: 16.04-LTS
        version: latest
  exampleExtension:
    type: azure:compute:Extension
    properties:
      virtualMachineId: ${exampleLinuxVirtualMachine.id}
      publisher: Microsoft.Azure.Extensions
      type: CustomScript
      typeHandlerVersion: '2.0'
      settings: |2
         {
          "commandToExecute": "hostname && uptime"
         }
      tags:
        environment: Production

Create Extension Resource

new Extension(name: string, args: ExtensionArgs, opts?: CustomResourceOptions);
@overload
def Extension(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              auto_upgrade_minor_version: Optional[bool] = None,
              automatic_upgrade_enabled: Optional[bool] = None,
              failure_suppression_enabled: Optional[bool] = None,
              name: Optional[str] = None,
              protected_settings: Optional[str] = None,
              protected_settings_from_key_vault: Optional[ExtensionProtectedSettingsFromKeyVaultArgs] = None,
              publisher: Optional[str] = None,
              settings: Optional[str] = None,
              tags: Optional[Mapping[str, str]] = None,
              type: Optional[str] = None,
              type_handler_version: Optional[str] = None,
              virtual_machine_id: Optional[str] = None)
@overload
def Extension(resource_name: str,
              args: ExtensionArgs,
              opts: Optional[ResourceOptions] = None)
func NewExtension(ctx *Context, name string, args ExtensionArgs, opts ...ResourceOption) (*Extension, error)
public Extension(string name, ExtensionArgs args, CustomResourceOptions? opts = null)
public Extension(String name, ExtensionArgs args)
public Extension(String name, ExtensionArgs args, CustomResourceOptions options)

type: azure:compute:Extension
properties: # The arguments to resource properties.
options: # 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.
resource_name str
The unique name of the resource.
args ExtensionArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control 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.
name String
The unique name of the resource.
args ExtensionArgs
The arguments to resource properties.
options 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 Architecture and Concepts 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. Changing this forces a new resource to be created.

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.

AutomaticUpgradeEnabled bool

Should the Extension be automatically updated whenever the Publisher releases a new version of this VM Extension?

FailureSuppressionEnabled bool

Should failures from the extension be suppressed? Possible values are true or false. Defaults to false.

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.

ProtectedSettingsFromKeyVault ExtensionProtectedSettingsFromKeyVaultArgs

A protected_settings_from_key_vault block as defined below.

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. Changing this forces a new resource to be created.

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.

AutomaticUpgradeEnabled bool

Should the Extension be automatically updated whenever the Publisher releases a new version of this VM Extension?

FailureSuppressionEnabled bool

Should failures from the extension be suppressed? Possible values are true or false. Defaults to false.

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.

ProtectedSettingsFromKeyVault ExtensionProtectedSettingsFromKeyVaultArgs

A protected_settings_from_key_vault block as defined below.

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. Changing this forces a new resource to be created.

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.

automaticUpgradeEnabled Boolean

Should the Extension be automatically updated whenever the Publisher releases a new version of this VM Extension?

failureSuppressionEnabled Boolean

Should failures from the extension be suppressed? Possible values are true or false. Defaults to false.

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.

protectedSettingsFromKeyVault ExtensionProtectedSettingsFromKeyVaultArgs

A protected_settings_from_key_vault block as defined below.

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. Changing this forces a new resource to be created.

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.

automaticUpgradeEnabled boolean

Should the Extension be automatically updated whenever the Publisher releases a new version of this VM Extension?

failureSuppressionEnabled boolean

Should failures from the extension be suppressed? Possible values are true or false. Defaults to false.

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.

protectedSettingsFromKeyVault ExtensionProtectedSettingsFromKeyVaultArgs

A protected_settings_from_key_vault block as defined below.

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. Changing this forces a new resource to be created.

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.

automatic_upgrade_enabled bool

Should the Extension be automatically updated whenever the Publisher releases a new version of this VM Extension?

failure_suppression_enabled bool

Should failures from the extension be suppressed? Possible values are true or false. Defaults to false.

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.

protected_settings_from_key_vault ExtensionProtectedSettingsFromKeyVaultArgs

A protected_settings_from_key_vault block as defined below.

settings str

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

tags Mapping[str, str]

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. Changing this forces a new resource to be created.

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.

automaticUpgradeEnabled Boolean

Should the Extension be automatically updated whenever the Publisher releases a new version of this VM Extension?

failureSuppressionEnabled Boolean

Should failures from the extension be suppressed? Possible values are true or false. Defaults to false.

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.

protectedSettingsFromKeyVault Property Map

A protected_settings_from_key_vault block as defined below.

settings String

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

tags Map<String>

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 string

The provider-assigned unique ID for this managed resource.

id str

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

Look up 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
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        auto_upgrade_minor_version: Optional[bool] = None,
        automatic_upgrade_enabled: Optional[bool] = None,
        failure_suppression_enabled: Optional[bool] = None,
        name: Optional[str] = None,
        protected_settings: Optional[str] = None,
        protected_settings_from_key_vault: Optional[ExtensionProtectedSettingsFromKeyVaultArgs] = None,
        publisher: Optional[str] = None,
        settings: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        type: Optional[str] = None,
        type_handler_version: Optional[str] = None,
        virtual_machine_id: Optional[str] = None) -> Extension
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)
public static Extension get(String name, Output<String> id, ExtensionState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
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.
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.

AutomaticUpgradeEnabled bool

Should the Extension be automatically updated whenever the Publisher releases a new version of this VM Extension?

FailureSuppressionEnabled bool

Should failures from the extension be suppressed? Possible values are true or false. Defaults to false.

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.

ProtectedSettingsFromKeyVault ExtensionProtectedSettingsFromKeyVaultArgs

A protected_settings_from_key_vault block as defined below.

Publisher string

The publisher of the extension, available publishers can be found by using the Azure CLI. Changing this forces a new resource to be created.

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.

AutomaticUpgradeEnabled bool

Should the Extension be automatically updated whenever the Publisher releases a new version of this VM Extension?

FailureSuppressionEnabled bool

Should failures from the extension be suppressed? Possible values are true or false. Defaults to false.

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.

ProtectedSettingsFromKeyVault ExtensionProtectedSettingsFromKeyVaultArgs

A protected_settings_from_key_vault block as defined below.

Publisher string

The publisher of the extension, available publishers can be found by using the Azure CLI. Changing this forces a new resource to be created.

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.

automaticUpgradeEnabled Boolean

Should the Extension be automatically updated whenever the Publisher releases a new version of this VM Extension?

failureSuppressionEnabled Boolean

Should failures from the extension be suppressed? Possible values are true or false. Defaults to false.

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.

protectedSettingsFromKeyVault ExtensionProtectedSettingsFromKeyVaultArgs

A protected_settings_from_key_vault block as defined below.

publisher String

The publisher of the extension, available publishers can be found by using the Azure CLI. Changing this forces a new resource to be created.

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.

automaticUpgradeEnabled boolean

Should the Extension be automatically updated whenever the Publisher releases a new version of this VM Extension?

failureSuppressionEnabled boolean

Should failures from the extension be suppressed? Possible values are true or false. Defaults to false.

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.

protectedSettingsFromKeyVault ExtensionProtectedSettingsFromKeyVaultArgs

A protected_settings_from_key_vault block as defined below.

publisher string

The publisher of the extension, available publishers can be found by using the Azure CLI. Changing this forces a new resource to be created.

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.

automatic_upgrade_enabled bool

Should the Extension be automatically updated whenever the Publisher releases a new version of this VM Extension?

failure_suppression_enabled bool

Should failures from the extension be suppressed? Possible values are true or false. Defaults to false.

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.

protected_settings_from_key_vault ExtensionProtectedSettingsFromKeyVaultArgs

A protected_settings_from_key_vault block as defined below.

publisher str

The publisher of the extension, available publishers can be found by using the Azure CLI. Changing this forces a new resource to be created.

settings str

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

tags Mapping[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

autoUpgradeMinorVersion Boolean

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

automaticUpgradeEnabled Boolean

Should the Extension be automatically updated whenever the Publisher releases a new version of this VM Extension?

failureSuppressionEnabled Boolean

Should failures from the extension be suppressed? Possible values are true or false. Defaults to false.

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.

protectedSettingsFromKeyVault Property Map

A protected_settings_from_key_vault block as defined below.

publisher String

The publisher of the extension, available publishers can be found by using the Azure CLI. Changing this forces a new resource to be created.

settings String

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

tags Map<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

Supporting Types

ExtensionProtectedSettingsFromKeyVault

SecretUrl string

The URL to the Key Vault Secret which stores the protected settings.

SourceVaultId string

The ID of the source Key Vault.

SecretUrl string

The URL to the Key Vault Secret which stores the protected settings.

SourceVaultId string

The ID of the source Key Vault.

secretUrl String

The URL to the Key Vault Secret which stores the protected settings.

sourceVaultId String

The ID of the source Key Vault.

secretUrl string

The URL to the Key Vault Secret which stores the protected settings.

sourceVaultId string

The ID of the source Key Vault.

secret_url str

The URL to the Key Vault Secret which stores the protected settings.

source_vault_id str

The ID of the source Key Vault.

secretUrl String

The URL to the Key Vault Secret which stores the protected settings.

sourceVaultId String

The ID of the source Key Vault.

Import

Virtual Machine Extensions can be imported using the resource id, e.g.

 $ pulumi import azure:compute/extension:Extension example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.Compute/virtualMachines/myVM/extensions/extensionName

Package Details

Repository
Azure Classic pulumi/pulumi-azure
License
Apache-2.0
Notes

This Pulumi package is based on the azurerm Terraform Provider.