pulumi-azure-native-kotlin/com.pulumi.azurenative.compute.kotlin/VirtualMachineExtension

VirtualMachineExtension

class VirtualMachineExtension : KotlinCustomResource

Describes a Virtual Machine Extension. Uses Azure REST API version 2024-11-01. In version 2.x of the Azure Native provider, it used API version 2023-03-01. Other available API versions: 2022-08-01, 2022-11-01, 2023-03-01, 2023-07-01, 2023-09-01, 2024-03-01, 2024-07-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native compute [ApiVersion]. See the ../../../version-guide/#accessing-any-api-version-via-local-packages for details.

Example Usage

VirtualMachineExtension_CreateOrUpdate_MaximumSet_Gen

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
    var virtualMachineExtension = new AzureNative.Compute.VirtualMachineExtension("virtualMachineExtension", new()
    {
        AutoUpgradeMinorVersion = true,
        EnableAutomaticUpgrade = true,
        ForceUpdateTag = "a",
        InstanceView = new AzureNative.Compute.Inputs.VirtualMachineExtensionInstanceViewArgs
        {
            Name = "aaaaaaaaaaaaaaaaa",
            Statuses = new[]
            {
                new AzureNative.Compute.Inputs.InstanceViewStatusArgs
                {
                    Code = "aaaaaaaaaaaaaaaaaaaaaaa",
                    DisplayStatus = "aaaaaa",
                    Level = AzureNative.Compute.StatusLevelTypes.Info,
                    Message = "a",
                    Time = "2021-11-30T12:58:26.522Z",
                },
            },
            Substatuses = new[]
            {
                new AzureNative.Compute.Inputs.InstanceViewStatusArgs
                {
                    Code = "aaaaaaaaaaaaaaaaaaaaaaa",
                    DisplayStatus = "aaaaaa",
                    Level = AzureNative.Compute.StatusLevelTypes.Info,
                    Message = "a",
                    Time = "2021-11-30T12:58:26.522Z",
                },
            },
            Type = "aaaaaaaaa",
            TypeHandlerVersion = "aaaaaaaaaaaaaaaaaaaaaaaaaa",
        },
        Location = "westus",
        ProtectedSettings = null,
        Publisher = "extPublisher",
        ResourceGroupName = "rgcompute",
        Settings = null,
        SuppressFailures = true,
        Tags =
        {
            { "key9183", "aa" },
        },
        Type = "extType",
        TypeHandlerVersion = "1.2",
        VmExtensionName = "aaaaaaaaaaaaa",
        VmName = "aaaaaaaaaaaaaaaaaaaaaaaa",
    });
});
Content copied to clipboard
package main
import (
	compute "github.com/pulumi/pulumi-azure-native-sdk/compute/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := compute.NewVirtualMachineExtension(ctx, "virtualMachineExtension", &compute.VirtualMachineExtensionArgs{
			AutoUpgradeMinorVersion: pulumi.Bool(true),
			EnableAutomaticUpgrade:  pulumi.Bool(true),
			ForceUpdateTag:          pulumi.String("a"),
			InstanceView: &compute.VirtualMachineExtensionInstanceViewArgs{
				Name: pulumi.String("aaaaaaaaaaaaaaaaa"),
				Statuses: compute.InstanceViewStatusArray{
					&compute.InstanceViewStatusArgs{
						Code:          pulumi.String("aaaaaaaaaaaaaaaaaaaaaaa"),
						DisplayStatus: pulumi.String("aaaaaa"),
						Level:         compute.StatusLevelTypesInfo,
						Message:       pulumi.String("a"),
						Time:          pulumi.String("2021-11-30T12:58:26.522Z"),
					},
				},
				Substatuses: compute.InstanceViewStatusArray{
					&compute.InstanceViewStatusArgs{
						Code:          pulumi.String("aaaaaaaaaaaaaaaaaaaaaaa"),
						DisplayStatus: pulumi.String("aaaaaa"),
						Level:         compute.StatusLevelTypesInfo,
						Message:       pulumi.String("a"),
						Time:          pulumi.String("2021-11-30T12:58:26.522Z"),
					},
				},
				Type:               pulumi.String("aaaaaaaaa"),
				TypeHandlerVersion: pulumi.String("aaaaaaaaaaaaaaaaaaaaaaaaaa"),
			},
			Location:          pulumi.String("westus"),
			ProtectedSettings: pulumi.Any(map[string]interface{}{}),
			Publisher:         pulumi.String("extPublisher"),
			ResourceGroupName: pulumi.String("rgcompute"),
			Settings:          pulumi.Any(map[string]interface{}{}),
			SuppressFailures:  pulumi.Bool(true),
			Tags: pulumi.StringMap{
				"key9183": pulumi.String("aa"),
			},
			Type:               pulumi.String("extType"),
			TypeHandlerVersion: pulumi.String("1.2"),
			VmExtensionName:    pulumi.String("aaaaaaaaaaaaa"),
			VmName:             pulumi.String("aaaaaaaaaaaaaaaaaaaaaaaa"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.compute.VirtualMachineExtension;
import com.pulumi.azurenative.compute.VirtualMachineExtensionArgs;
import com.pulumi.azurenative.compute.inputs.VirtualMachineExtensionInstanceViewArgs;
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 virtualMachineExtension = new VirtualMachineExtension("virtualMachineExtension", VirtualMachineExtensionArgs.builder()
            .autoUpgradeMinorVersion(true)
            .enableAutomaticUpgrade(true)
            .forceUpdateTag("a")
            .instanceView(VirtualMachineExtensionInstanceViewArgs.builder()
                .name("aaaaaaaaaaaaaaaaa")
                .statuses(InstanceViewStatusArgs.builder()
                    .code("aaaaaaaaaaaaaaaaaaaaaaa")
                    .displayStatus("aaaaaa")
                    .level("Info")
                    .message("a")
                    .time("2021-11-30T12:58:26.522Z")
                    .build())
                .substatuses(InstanceViewStatusArgs.builder()
                    .code("aaaaaaaaaaaaaaaaaaaaaaa")
                    .displayStatus("aaaaaa")
                    .level("Info")
                    .message("a")
                    .time("2021-11-30T12:58:26.522Z")
                    .build())
                .type("aaaaaaaaa")
                .typeHandlerVersion("aaaaaaaaaaaaaaaaaaaaaaaaaa")
                .build())
            .location("westus")
            .protectedSettings()
            .publisher("extPublisher")
            .resourceGroupName("rgcompute")
            .settings()
            .suppressFailures(true)
            .tags(Map.of("key9183", "aa"))
            .type("extType")
            .typeHandlerVersion("1.2")
            .vmExtensionName("aaaaaaaaaaaaa")
            .vmName("aaaaaaaaaaaaaaaaaaaaaaaa")
            .build());
    }
}
Content copied to clipboard

VirtualMachineExtension_CreateOrUpdate_MinimumSet_Gen

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
    var virtualMachineExtension = new AzureNative.Compute.VirtualMachineExtension("virtualMachineExtension", new()
    {
        Location = "westus",
        ResourceGroupName = "rgcompute",
        VmExtensionName = "myVMExtension",
        VmName = "myVM",
    });
});
Content copied to clipboard
package main
import (
	compute "github.com/pulumi/pulumi-azure-native-sdk/compute/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := compute.NewVirtualMachineExtension(ctx, "virtualMachineExtension", &compute.VirtualMachineExtensionArgs{
			Location:          pulumi.String("westus"),
			ResourceGroupName: pulumi.String("rgcompute"),
			VmExtensionName:   pulumi.String("myVMExtension"),
			VmName:            pulumi.String("myVM"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.compute.VirtualMachineExtension;
import com.pulumi.azurenative.compute.VirtualMachineExtensionArgs;
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 virtualMachineExtension = new VirtualMachineExtension("virtualMachineExtension", VirtualMachineExtensionArgs.builder()
            .location("westus")
            .resourceGroupName("rgcompute")
            .vmExtensionName("myVMExtension")
            .vmName("myVM")
            .build());
    }
}
Content copied to clipboard

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:compute:VirtualMachineExtension myVMExtension /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions/{vmExtensionName}
Content copied to clipboard

Properties

Link copied to clipboard
val autoUpgradeMinorVersion: Output<Boolean>?

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.

Link copied to clipboard
val azureApiVersion: Output<String>

The Azure API version of the resource.

Link copied to clipboard
val enableAutomaticUpgrade: Output<Boolean>?

Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.

Link copied to clipboard
val forceUpdateTag: Output<String>?

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

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val instanceView: Output<VirtualMachineExtensionInstanceViewResponse>?

The virtual machine extension instance view.

Link copied to clipboard
val location: Output<String>?

Resource location

Link copied to clipboard
val name: Output<String>

Resource name

Link copied to clipboard
val protectedSettings: Output<Any>?

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

Link copied to clipboard
val protectedSettingsFromKeyVault: Output<KeyVaultSecretReferenceResponse>?

The extensions protected settings that are passed by reference, and consumed from key vault

Link copied to clipboard
val provisionAfterExtensions: Output<List<String>>?

Collection of extension names after which this extension needs to be provisioned.

Link copied to clipboard
val provisioningState: Output<String>

The provisioning state, which only appears in the response.

Link copied to clipboard
val publisher: Output<String>?

The name of the extension handler publisher.

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val settings: Output<Any>?

Json formatted public settings for the extension.

Link copied to clipboard
val suppressFailures: Output<Boolean>?

Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false.

Link copied to clipboard
val tags: Output<Map<String, String>>?

Resource tags

Link copied to clipboard
val type: Output<String>

Resource type

Link copied to clipboard
val typeHandlerVersion: Output<String>?

Specifies the version of the script handler.

Link copied to clipboard
val urn: Output<String>