Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v1
  3. API Docs
  4. hybridcompute
  5. MachineExtension
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

azure-native.hybridcompute.MachineExtension

Explore with Pulumi AI

azure-native-v1 logo
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

    Describes a Machine Extension. API Version: 2020-08-02.

    Example Usage

    Create or Update a Machine Extension (PUT)

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var machineExtension = new AzureNative.HybridCompute.MachineExtension("machineExtension", new()
    {
        ExtensionName = "CustomScriptExtension",
        Location = "eastus2euap",
        Name = "myMachine",
        Publisher = "Microsoft.Compute",
        ResourceGroupName = "myResourceGroup",
        Settings = 
        {
            { "commandToExecute", "powershell.exe -c \"Get-Process | Where-Object { $_.CPU -gt 10000 }\"" },
        },
        Type = "CustomScriptExtension",
        TypeHandlerVersion = "1.10",
    });

});

    package main

import (
	hybridcompute "github.com/pulumi/pulumi-azure-native-sdk/hybridcompute"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := hybridcompute.NewMachineExtension(ctx, "machineExtension", &hybridcompute.MachineExtensionArgs{
			ExtensionName:     pulumi.String("CustomScriptExtension"),
			Location:          pulumi.String("eastus2euap"),
			Name:              pulumi.String("myMachine"),
			Publisher:         pulumi.String("Microsoft.Compute"),
			ResourceGroupName: pulumi.String("myResourceGroup"),
			Settings: pulumi.Any{
				CommandToExecute: "powershell.exe -c \"Get-Process | Where-Object { $_.CPU -gt 10000 }\"",
			},
			Type:               pulumi.String("CustomScriptExtension"),
			TypeHandlerVersion: pulumi.String("1.10"),
		})
		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.azurenative.hybridcompute.MachineExtension;
import com.pulumi.azurenative.hybridcompute.MachineExtensionArgs;
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 machineExtension = new MachineExtension("machineExtension", MachineExtensionArgs.builder()        
            .extensionName("CustomScriptExtension")
            .location("eastus2euap")
            .name("myMachine")
            .publisher("Microsoft.Compute")
            .resourceGroupName("myResourceGroup")
            .settings(Map.of("commandToExecute", "powershell.exe -c \"Get-Process | Where-Object { $_.CPU -gt 10000 }\""))
            .type("CustomScriptExtension")
            .typeHandlerVersion("1.10")
            .build());

    }
}

    import pulumi
import pulumi_azure_native as azure_native

machine_extension = azure_native.hybridcompute.MachineExtension("machineExtension",
    extension_name="CustomScriptExtension",
    location="eastus2euap",
    name="myMachine",
    publisher="Microsoft.Compute",
    resource_group_name="myResourceGroup",
    settings={
        "commandToExecute": "powershell.exe -c \"Get-Process | Where-Object { $_.CPU -gt 10000 }\"",
    },
    type="CustomScriptExtension",
    type_handler_version="1.10")

    import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const machineExtension = new azure_native.hybridcompute.MachineExtension("machineExtension", {
    extensionName: "CustomScriptExtension",
    location: "eastus2euap",
    name: "myMachine",
    publisher: "Microsoft.Compute",
    resourceGroupName: "myResourceGroup",
    settings: {
        commandToExecute: "powershell.exe -c \"Get-Process | Where-Object { $_.CPU -gt 10000 }\"",
    },
    type: "CustomScriptExtension",
    typeHandlerVersion: "1.10",
});

    resources:
  machineExtension:
    type: azure-native:hybridcompute:MachineExtension
    properties:
      extensionName: CustomScriptExtension
      location: eastus2euap
      name: myMachine
      publisher: Microsoft.Compute
      resourceGroupName: myResourceGroup
      settings:
        commandToExecute: powershell.exe -c "Get-Process | Where-Object { $_.CPU -gt 10000 }"
      type: CustomScriptExtension
      typeHandlerVersion: '1.10'

    Create MachineExtension Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new MachineExtension(name: string, args: MachineExtensionArgs, opts?: CustomResourceOptions);
    @overload
def MachineExtension(resource_name: str,
                     args: MachineExtensionArgs,
                     opts: Optional[ResourceOptions] = None)

@overload
def MachineExtension(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     name: Optional[str] = None,
                     resource_group_name: Optional[str] = None,
                     auto_upgrade_minor_version: Optional[bool] = None,
                     extension_name: Optional[str] = None,
                     force_update_tag: Optional[str] = None,
                     location: Optional[str] = None,
                     protected_settings: Optional[Any] = None,
                     publisher: Optional[str] = None,
                     settings: Optional[Any] = None,
                     tags: Optional[Mapping[str, str]] = None,
                     type: Optional[str] = None,
                     type_handler_version: Optional[str] = None)
    func NewMachineExtension(ctx *Context, name string, args MachineExtensionArgs, opts ...ResourceOption) (*MachineExtension, error)
    public MachineExtension(string name, MachineExtensionArgs args, CustomResourceOptions? opts = null)
    public MachineExtension(String name, MachineExtensionArgs args)
public MachineExtension(String name, MachineExtensionArgs args, CustomResourceOptions options)

    type: azure-native:hybridcompute:MachineExtension
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

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

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var azure_nativeMachineExtensionResource = new AzureNative.Hybridcompute.MachineExtension("azure-nativeMachineExtensionResource", new()
{
    Name = "string",
    ResourceGroupName = "string",
    AutoUpgradeMinorVersion = false,
    ExtensionName = "string",
    ForceUpdateTag = "string",
    Location = "string",
    ProtectedSettings = "any",
    Publisher = "string",
    Settings = "any",
    Tags = 
    {
        { "string", "string" },
    },
    Type = "string",
    TypeHandlerVersion = "string",
});

    example, err := hybridcompute.NewMachineExtension(ctx, "azure-nativeMachineExtensionResource", &hybridcompute.MachineExtensionArgs{
	Name:                    "string",
	ResourceGroupName:       "string",
	AutoUpgradeMinorVersion: false,
	ExtensionName:           "string",
	ForceUpdateTag:          "string",
	Location:                "string",
	ProtectedSettings:       "any",
	Publisher:               "string",
	Settings:                "any",
	Tags: map[string]interface{}{
		"string": "string",
	},
	Type:               "string",
	TypeHandlerVersion: "string",
})

    var azure_nativeMachineExtensionResource = new MachineExtension("azure-nativeMachineExtensionResource", MachineExtensionArgs.builder()
    .name("string")
    .resourceGroupName("string")
    .autoUpgradeMinorVersion(false)
    .extensionName("string")
    .forceUpdateTag("string")
    .location("string")
    .protectedSettings("any")
    .publisher("string")
    .settings("any")
    .tags(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .type("string")
    .typeHandlerVersion("string")
    .build());

    azure_native_machine_extension_resource = azure_native.hybridcompute.MachineExtension("azure-nativeMachineExtensionResource",
    name=string,
    resource_group_name=string,
    auto_upgrade_minor_version=False,
    extension_name=string,
    force_update_tag=string,
    location=string,
    protected_settings=any,
    publisher=string,
    settings=any,
    tags={
        string: string,
    },
    type=string,
    type_handler_version=string)

    const azure_nativeMachineExtensionResource = new azure_native.hybridcompute.MachineExtension("azure-nativeMachineExtensionResource", {
    name: "string",
    resourceGroupName: "string",
    autoUpgradeMinorVersion: false,
    extensionName: "string",
    forceUpdateTag: "string",
    location: "string",
    protectedSettings: "any",
    publisher: "string",
    settings: "any",
    tags: {
        string: "string",
    },
    type: "string",
    typeHandlerVersion: "string",
});

    type: azure-native:hybridcompute:MachineExtension
properties:
    autoUpgradeMinorVersion: false
    extensionName: string
    forceUpdateTag: string
    location: string
    name: string
    protectedSettings: any
    publisher: string
    resourceGroupName: string
    settings: any
    tags:
        string: string
    type: string
    typeHandlerVersion: string

    MachineExtension 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 MachineExtension resource accepts the following input properties:

    Name string
    The name of the machine where the extension should be created or updated.
    ResourceGroupName string
    The name of the resource group.
    AutoUpgradeMinorVersion bool
    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.
    ExtensionName string
    The name of the machine extension.
    ForceUpdateTag string
    How the extension handler should be forced to update even if the extension configuration has not changed.
    Location string
    The geo-location where the resource lives
    ProtectedSettings object
    The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
    Publisher string
    The name of the extension handler publisher.
    Settings object
    Json formatted public settings for the extension.
    Tags Dictionary<string, string>
    Resource tags.
    Type string
    Specifies the type of the extension; an example is "CustomScriptExtension".
    TypeHandlerVersion string
    Specifies the version of the script handler.
    Name string
    The name of the machine where the extension should be created or updated.
    ResourceGroupName string
    The name of the resource group.
    AutoUpgradeMinorVersion bool
    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.
    ExtensionName string
    The name of the machine extension.
    ForceUpdateTag string
    How the extension handler should be forced to update even if the extension configuration has not changed.
    Location string
    The geo-location where the resource lives
    ProtectedSettings interface{}
    The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
    Publisher string
    The name of the extension handler publisher.
    Settings interface{}
    Json formatted public settings for the extension.
    Tags map[string]string
    Resource tags.
    Type string
    Specifies the type of the extension; an example is "CustomScriptExtension".
    TypeHandlerVersion string
    Specifies the version of the script handler.
    name String
    The name of the machine where the extension should be created or updated.
    resourceGroupName String
    The name of the resource group.
    autoUpgradeMinorVersion 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.
    extensionName String
    The name of the machine extension.
    forceUpdateTag String
    How the extension handler should be forced to update even if the extension configuration has not changed.
    location String
    The geo-location where the resource lives
    protectedSettings Object
    The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
    publisher String
    The name of the extension handler publisher.
    settings Object
    Json formatted public settings for the extension.
    tags Map<String,String>
    Resource tags.
    type String
    Specifies the type of the extension; an example is "CustomScriptExtension".
    typeHandlerVersion String
    Specifies the version of the script handler.
    name string
    The name of the machine where the extension should be created or updated.
    resourceGroupName string
    The name of the resource group.
    autoUpgradeMinorVersion 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.
    extensionName string
    The name of the machine extension.
    forceUpdateTag string
    How the extension handler should be forced to update even if the extension configuration has not changed.
    location string
    The geo-location where the resource lives
    protectedSettings any
    The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
    publisher string
    The name of the extension handler publisher.
    settings any
    Json formatted public settings for the extension.
    tags {[key: string]: string}
    Resource tags.
    type string
    Specifies the type of the extension; an example is "CustomScriptExtension".
    typeHandlerVersion string
    Specifies the version of the script handler.
    name str
    The name of the machine where the extension should be created or updated.
    resource_group_name str
    The name of the resource group.
    auto_upgrade_minor_version bool
    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.
    extension_name str
    The name of the machine extension.
    force_update_tag str
    How the extension handler should be forced to update even if the extension configuration has not changed.
    location str
    The geo-location where the resource lives
    protected_settings Any
    The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
    publisher str
    The name of the extension handler publisher.
    settings Any
    Json formatted public settings for the extension.
    tags Mapping[str, str]
    Resource tags.
    type str
    Specifies the type of the extension; an example is "CustomScriptExtension".
    type_handler_version str
    Specifies the version of the script handler.
    name String
    The name of the machine where the extension should be created or updated.
    resourceGroupName String
    The name of the resource group.
    autoUpgradeMinorVersion 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.
    extensionName String
    The name of the machine extension.
    forceUpdateTag String
    How the extension handler should be forced to update even if the extension configuration has not changed.
    location String
    The geo-location where the resource lives
    protectedSettings Any
    The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
    publisher String
    The name of the extension handler publisher.
    settings Any
    Json formatted public settings for the extension.
    tags Map<String>
    Resource tags.
    type String
    Specifies the type of the extension; an example is "CustomScriptExtension".
    typeHandlerVersion String
    Specifies the version of the script handler.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    ProvisioningState string
    The provisioning state, which only appears in the response.
    InstanceView Pulumi.AzureNative.HybridCompute.Outputs.MachineExtensionPropertiesResponseInstanceView
    The machine extension instance view.
    Id string
    The provider-assigned unique ID for this managed resource.
    ProvisioningState string
    The provisioning state, which only appears in the response.
    InstanceView MachineExtensionPropertiesResponseInstanceView
    The machine extension instance view.
    id String
    The provider-assigned unique ID for this managed resource.
    provisioningState String
    The provisioning state, which only appears in the response.
    instanceView MachineExtensionPropertiesResponseInstanceView
    The machine extension instance view.
    id string
    The provider-assigned unique ID for this managed resource.
    provisioningState string
    The provisioning state, which only appears in the response.
    instanceView MachineExtensionPropertiesResponseInstanceView
    The machine extension instance view.
    id str
    The provider-assigned unique ID for this managed resource.
    provisioning_state str
    The provisioning state, which only appears in the response.
    instance_view MachineExtensionPropertiesResponseInstanceView
    The machine extension instance view.
    id String
    The provider-assigned unique ID for this managed resource.
    provisioningState String
    The provisioning state, which only appears in the response.
    instanceView Property Map
    The machine extension instance view.

    Supporting Types

    MachineExtensionInstanceViewResponseStatus, MachineExtensionInstanceViewResponseStatusArgs

    Code string
    The status code.
    DisplayStatus string
    The short localizable label for the status.
    Level string
    The level code.
    Message string
    The detailed status message, including for alerts and error messages.
    Time string
    The time of the status.
    Code string
    The status code.
    DisplayStatus string
    The short localizable label for the status.
    Level string
    The level code.
    Message string
    The detailed status message, including for alerts and error messages.
    Time string
    The time of the status.
    code String
    The status code.
    displayStatus String
    The short localizable label for the status.
    level String
    The level code.
    message String
    The detailed status message, including for alerts and error messages.
    time String
    The time of the status.
    code string
    The status code.
    displayStatus string
    The short localizable label for the status.
    level string
    The level code.
    message string
    The detailed status message, including for alerts and error messages.
    time string
    The time of the status.
    code str
    The status code.
    display_status str
    The short localizable label for the status.
    level str
    The level code.
    message str
    The detailed status message, including for alerts and error messages.
    time str
    The time of the status.
    code String
    The status code.
    displayStatus String
    The short localizable label for the status.
    level String
    The level code.
    message String
    The detailed status message, including for alerts and error messages.
    time String
    The time of the status.

    MachineExtensionPropertiesResponseInstanceView, MachineExtensionPropertiesResponseInstanceViewArgs

    Name string
    The machine extension name.
    Type string
    Specifies the type of the extension; an example is "CustomScriptExtension".
    TypeHandlerVersion string
    Specifies the version of the script handler.
    Status Pulumi.AzureNative.HybridCompute.Inputs.MachineExtensionInstanceViewResponseStatus
    Instance view status.
    Name string
    The machine extension name.
    Type string
    Specifies the type of the extension; an example is "CustomScriptExtension".
    TypeHandlerVersion string
    Specifies the version of the script handler.
    Status MachineExtensionInstanceViewResponseStatus
    Instance view status.
    name String
    The machine extension name.
    type String
    Specifies the type of the extension; an example is "CustomScriptExtension".
    typeHandlerVersion String
    Specifies the version of the script handler.
    status MachineExtensionInstanceViewResponseStatus
    Instance view status.
    name string
    The machine extension name.
    type string
    Specifies the type of the extension; an example is "CustomScriptExtension".
    typeHandlerVersion string
    Specifies the version of the script handler.
    status MachineExtensionInstanceViewResponseStatus
    Instance view status.
    name str
    The machine extension name.
    type str
    Specifies the type of the extension; an example is "CustomScriptExtension".
    type_handler_version str
    Specifies the version of the script handler.
    status MachineExtensionInstanceViewResponseStatus
    Instance view status.
    name String
    The machine extension name.
    type String
    Specifies the type of the extension; an example is "CustomScriptExtension".
    typeHandlerVersion String
    Specifies the version of the script handler.
    status Property Map
    Instance view status.

    Import

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

    $ pulumi import azure-native:hybridcompute:MachineExtension CustomScriptExtension /subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/Machines/myMachine/Extensions/CustomScriptExtension

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    azure-native-v1 pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native-v1 logo
    These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
    Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
    pulumi/pulumi-azure-native