1. Packages
  2. Azure Native
  3. API Docs
  4. connectedvmwarevsphere
  5. MachineExtension
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.29.0 published on Friday, Feb 16, 2024 by Pulumi

azure-native.connectedvmwarevsphere.MachineExtension

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.29.0 published on Friday, Feb 16, 2024 by Pulumi

    Describes a Machine Extension. Azure REST API version: 2022-07-15-preview. Prior API version in Azure Native 1.x: 2020-10-01-preview.

    Other available API versions: 2022-01-10-preview, 2023-03-01-preview.

    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.ConnectedVMwarevSphere.MachineExtension("machineExtension", new()
        {
            ExtensionName = "CustomScriptExtension",
            Location = "eastus2euap",
            Publisher = "Microsoft.Compute",
            ResourceGroupName = "myResourceGroup",
            Settings = 
            {
                { "commandToExecute", "powershell.exe -c \"Get-Process | Where-Object { $_.CPU -gt 10000 }\"" },
            },
            Type = "CustomScriptExtension",
            TypeHandlerVersion = "1.10",
            VirtualMachineName = "myMachine",
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure-native-sdk/connectedvmwarevsphere/v2"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := connectedvmwarevsphere.NewMachineExtension(ctx, "machineExtension", &connectedvmwarevsphere.MachineExtensionArgs{
    			ExtensionName:     pulumi.String("CustomScriptExtension"),
    			Location:          pulumi.String("eastus2euap"),
    			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"),
    			VirtualMachineName: pulumi.String("myMachine"),
    		})
    		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.connectedvmwarevsphere.MachineExtension;
    import com.pulumi.azurenative.connectedvmwarevsphere.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")
                .publisher("Microsoft.Compute")
                .resourceGroupName("myResourceGroup")
                .settings(Map.of("commandToExecute", "powershell.exe -c \"Get-Process | Where-Object { $_.CPU -gt 10000 }\""))
                .type("CustomScriptExtension")
                .typeHandlerVersion("1.10")
                .virtualMachineName("myMachine")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    machine_extension = azure_native.connectedvmwarevsphere.MachineExtension("machineExtension",
        extension_name="CustomScriptExtension",
        location="eastus2euap",
        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",
        virtual_machine_name="myMachine")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const machineExtension = new azure_native.connectedvmwarevsphere.MachineExtension("machineExtension", {
        extensionName: "CustomScriptExtension",
        location: "eastus2euap",
        publisher: "Microsoft.Compute",
        resourceGroupName: "myResourceGroup",
        settings: {
            commandToExecute: "powershell.exe -c \"Get-Process | Where-Object { $_.CPU -gt 10000 }\"",
        },
        type: "CustomScriptExtension",
        typeHandlerVersion: "1.10",
        virtualMachineName: "myMachine",
    });
    
    resources:
      machineExtension:
        type: azure-native:connectedvmwarevsphere:MachineExtension
        properties:
          extensionName: CustomScriptExtension
          location: eastus2euap
          publisher: Microsoft.Compute
          resourceGroupName: myResourceGroup
          settings:
            commandToExecute: powershell.exe -c "Get-Process | Where-Object { $_.CPU -gt 10000 }"
          type: CustomScriptExtension
          typeHandlerVersion: '1.10'
          virtualMachineName: myMachine
    

    Create MachineExtension Resource

    new MachineExtension(name: string, args: MachineExtensionArgs, opts?: CustomResourceOptions);
    @overload
    def MachineExtension(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         auto_upgrade_minor_version: Optional[bool] = None,
                         enable_automatic_upgrade: 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,
                         resource_group_name: Optional[str] = None,
                         settings: Optional[Any] = None,
                         tags: Optional[Mapping[str, str]] = None,
                         type: Optional[str] = None,
                         type_handler_version: Optional[str] = None,
                         virtual_machine_name: Optional[str] = None)
    @overload
    def MachineExtension(resource_name: str,
                         args: MachineExtensionArgs,
                         opts: Optional[ResourceOptions] = 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:connectedvmwarevsphere:MachineExtension
    properties: # The arguments to resource properties.
    options: # 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.
    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.

    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:

    ResourceGroupName string
    The Resource Group Name.
    VirtualMachineName string
    The name of the machine where the extension should be created or updated.
    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.
    EnableAutomaticUpgrade bool
    Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available.
    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
    Gets or sets the location.
    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>
    Gets or sets the Resource tags.
    Type string
    Specifies the type of the extension; an example is "CustomScriptExtension".
    TypeHandlerVersion string
    Specifies the version of the script handler.
    ResourceGroupName string
    The Resource Group Name.
    VirtualMachineName string
    The name of the machine where the extension should be created or updated.
    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.
    EnableAutomaticUpgrade bool
    Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available.
    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
    Gets or sets the location.
    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
    Gets or sets the Resource tags.
    Type string
    Specifies the type of the extension; an example is "CustomScriptExtension".
    TypeHandlerVersion string
    Specifies the version of the script handler.
    resourceGroupName String
    The Resource Group Name.
    virtualMachineName String
    The name of the machine where the extension should be created or updated.
    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.
    enableAutomaticUpgrade Boolean
    Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available.
    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
    Gets or sets the location.
    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>
    Gets or sets the Resource tags.
    type String
    Specifies the type of the extension; an example is "CustomScriptExtension".
    typeHandlerVersion String
    Specifies the version of the script handler.
    resourceGroupName string
    The Resource Group Name.
    virtualMachineName string
    The name of the machine where the extension should be created or updated.
    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.
    enableAutomaticUpgrade boolean
    Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available.
    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
    Gets or sets the location.
    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}
    Gets or sets the Resource tags.
    type string
    Specifies the type of the extension; an example is "CustomScriptExtension".
    typeHandlerVersion string
    Specifies the version of the script handler.
    resource_group_name str
    The Resource Group Name.
    virtual_machine_name str
    The name of the machine where the extension should be created or updated.
    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.
    enable_automatic_upgrade bool
    Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available.
    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
    Gets or sets the location.
    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]
    Gets or sets the 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.
    resourceGroupName String
    The Resource Group Name.
    virtualMachineName String
    The name of the machine where the extension should be created or updated.
    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.
    enableAutomaticUpgrade Boolean
    Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available.
    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
    Gets or sets the location.
    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>
    Gets or sets the 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.
    Name string
    Gets or sets the name.
    ProvisioningState string
    The provisioning state, which only appears in the response.
    SystemData Pulumi.AzureNative.ConnectedVMwarevSphere.Outputs.SystemDataResponse
    The system data.
    InstanceView Pulumi.AzureNative.ConnectedVMwarevSphere.Outputs.MachineExtensionPropertiesResponseInstanceView
    The machine extension instance view.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Gets or sets the name.
    ProvisioningState string
    The provisioning state, which only appears in the response.
    SystemData SystemDataResponse
    The system data.
    InstanceView MachineExtensionPropertiesResponseInstanceView
    The machine extension instance view.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Gets or sets the name.
    provisioningState String
    The provisioning state, which only appears in the response.
    systemData SystemDataResponse
    The system data.
    instanceView MachineExtensionPropertiesResponseInstanceView
    The machine extension instance view.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    Gets or sets the name.
    provisioningState string
    The provisioning state, which only appears in the response.
    systemData SystemDataResponse
    The system data.
    instanceView MachineExtensionPropertiesResponseInstanceView
    The machine extension instance view.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    Gets or sets the name.
    provisioning_state str
    The provisioning state, which only appears in the response.
    system_data SystemDataResponse
    The system data.
    instance_view MachineExtensionPropertiesResponseInstanceView
    The machine extension instance view.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Gets or sets the name.
    provisioningState String
    The provisioning state, which only appears in the response.
    systemData Property Map
    The system data.
    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.ConnectedVMwarevSphere.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.

    SystemDataResponse, SystemDataResponseArgs

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    The type of identity that last modified the resource.
    created_at str
    The timestamp of resource creation (UTC).
    created_by str
    The identity that created the resource.
    created_by_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    Import

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

    $ pulumi import azure-native:connectedvmwarevsphere:MachineExtension CustomScriptExtension /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedVMwarevSphere/virtualMachines/{virtualMachineName}/extensions/{extensionName} 
    

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.29.0 published on Friday, Feb 16, 2024 by Pulumi