1. Packages
  2. Azure Classic
  3. API Docs
  4. arcmachine
  5. Extension

We recommend using Azure Native.

Azure Classic v5.84.0 published on Tuesday, Jul 16, 2024 by Pulumi

azure.arcmachine.Extension

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.84.0 published on Tuesday, Jul 16, 2024 by Pulumi

    Manages a Hybrid Compute Machine Extension.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const exampleResourceGroup = new azure.core.ResourceGroup("example", {
        name: "example",
        location: "West Europe",
    });
    const example = azure.arcmachine.getOutput({
        name: "existing-hcmachine",
        resourceGroupName: exampleResourceGroup.name,
    });
    const exampleExtension = new azure.arcmachine.Extension("example", {
        name: "example",
        location: "West Europe",
        arcMachineId: example.apply(example => example.id),
        publisher: "Microsoft.Azure.Monitor",
        type: "AzureMonitorLinuxAgent",
    });
    
    import pulumi
    import pulumi_azure as azure
    
    example_resource_group = azure.core.ResourceGroup("example",
        name="example",
        location="West Europe")
    example = azure.arcmachine.get_output(name="existing-hcmachine",
        resource_group_name=example_resource_group.name)
    example_extension = azure.arcmachine.Extension("example",
        name="example",
        location="West Europe",
        arc_machine_id=example.id,
        publisher="Microsoft.Azure.Monitor",
        type="AzureMonitorLinuxAgent")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/arcmachine"
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		exampleResourceGroup, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
    			Name:     pulumi.String("example"),
    			Location: pulumi.String("West Europe"),
    		})
    		if err != nil {
    			return err
    		}
    		example := arcmachine.GetOutput(ctx, arcmachine.GetOutputArgs{
    			Name:              pulumi.String("existing-hcmachine"),
    			ResourceGroupName: exampleResourceGroup.Name,
    		}, nil)
    		_, err = arcmachine.NewExtension(ctx, "example", &arcmachine.ExtensionArgs{
    			Name:     pulumi.String("example"),
    			Location: pulumi.String("West Europe"),
    			ArcMachineId: example.ApplyT(func(example arcmachine.GetResult) (*string, error) {
    				return &example.Id, nil
    			}).(pulumi.StringPtrOutput),
    			Publisher: pulumi.String("Microsoft.Azure.Monitor"),
    			Type:      pulumi.String("AzureMonitorLinuxAgent"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Azure = Pulumi.Azure;
    
    return await Deployment.RunAsync(() => 
    {
        var exampleResourceGroup = new Azure.Core.ResourceGroup("example", new()
        {
            Name = "example",
            Location = "West Europe",
        });
    
        var example = Azure.ArcMachine.Get.Invoke(new()
        {
            Name = "existing-hcmachine",
            ResourceGroupName = exampleResourceGroup.Name,
        });
    
        var exampleExtension = new Azure.ArcMachine.Extension("example", new()
        {
            Name = "example",
            Location = "West Europe",
            ArcMachineId = example.Apply(getResult => getResult.Id),
            Publisher = "Microsoft.Azure.Monitor",
            Type = "AzureMonitorLinuxAgent",
        });
    
    });
    
    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.arcmachine.ArcmachineFunctions;
    import com.pulumi.azure.arcmachine.inputs.GetArgs;
    import com.pulumi.azure.arcmachine.Extension;
    import com.pulumi.azure.arcmachine.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()
                .name("example")
                .location("West Europe")
                .build());
    
            final var example = ArcmachineFunctions.get(GetArgs.builder()
                .name("existing-hcmachine")
                .resourceGroupName(exampleResourceGroup.name())
                .build());
    
            var exampleExtension = new Extension("exampleExtension", ExtensionArgs.builder()
                .name("example")
                .location("West Europe")
                .arcMachineId(example.applyValue(getResult -> getResult).applyValue(example -> example.applyValue(getResult -> getResult.id())))
                .publisher("Microsoft.Azure.Monitor")
                .type("AzureMonitorLinuxAgent")
                .build());
    
        }
    }
    
    resources:
      exampleResourceGroup:
        type: azure:core:ResourceGroup
        name: example
        properties:
          name: example
          location: West Europe
      exampleExtension:
        type: azure:arcmachine:Extension
        name: example
        properties:
          name: example
          location: West Europe
          arcMachineId: ${example.id}
          publisher: Microsoft.Azure.Monitor
          type: AzureMonitorLinuxAgent
    variables:
      example:
        fn::invoke:
          Function: azure:arcmachine:get
          Arguments:
            name: existing-hcmachine
            resourceGroupName: ${exampleResourceGroup.name}
    

    Create Extension Resource

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

    Constructor syntax

    new Extension(name: string, args: ExtensionArgs, opts?: CustomResourceOptions);
    @overload
    def Extension(resource_name: str,
                  args: ExtensionArgs,
                  opts: Optional[ResourceOptions] = None)
    
    @overload
    def Extension(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  arc_machine_id: Optional[str] = None,
                  publisher: Optional[str] = None,
                  type: Optional[str] = None,
                  automatic_upgrade_enabled: Optional[bool] = None,
                  force_update_tag: Optional[str] = None,
                  location: Optional[str] = None,
                  name: Optional[str] = None,
                  protected_settings: Optional[str] = None,
                  settings: Optional[str] = None,
                  tags: Optional[Mapping[str, str]] = None,
                  type_handler_version: Optional[str] = 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:arcmachine:Extension
    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 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.

    Constructor example

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

    var extensionResource = new Azure.ArcMachine.Extension("extensionResource", new()
    {
        ArcMachineId = "string",
        Publisher = "string",
        Type = "string",
        AutomaticUpgradeEnabled = false,
        ForceUpdateTag = "string",
        Location = "string",
        Name = "string",
        ProtectedSettings = "string",
        Settings = "string",
        Tags = 
        {
            { "string", "string" },
        },
        TypeHandlerVersion = "string",
    });
    
    example, err := arcmachine.NewExtension(ctx, "extensionResource", &arcmachine.ExtensionArgs{
    	ArcMachineId:            pulumi.String("string"),
    	Publisher:               pulumi.String("string"),
    	Type:                    pulumi.String("string"),
    	AutomaticUpgradeEnabled: pulumi.Bool(false),
    	ForceUpdateTag:          pulumi.String("string"),
    	Location:                pulumi.String("string"),
    	Name:                    pulumi.String("string"),
    	ProtectedSettings:       pulumi.String("string"),
    	Settings:                pulumi.String("string"),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	TypeHandlerVersion: pulumi.String("string"),
    })
    
    var extensionResource = new Extension("extensionResource", ExtensionArgs.builder()
        .arcMachineId("string")
        .publisher("string")
        .type("string")
        .automaticUpgradeEnabled(false)
        .forceUpdateTag("string")
        .location("string")
        .name("string")
        .protectedSettings("string")
        .settings("string")
        .tags(Map.of("string", "string"))
        .typeHandlerVersion("string")
        .build());
    
    extension_resource = azure.arcmachine.Extension("extensionResource",
        arc_machine_id="string",
        publisher="string",
        type="string",
        automatic_upgrade_enabled=False,
        force_update_tag="string",
        location="string",
        name="string",
        protected_settings="string",
        settings="string",
        tags={
            "string": "string",
        },
        type_handler_version="string")
    
    const extensionResource = new azure.arcmachine.Extension("extensionResource", {
        arcMachineId: "string",
        publisher: "string",
        type: "string",
        automaticUpgradeEnabled: false,
        forceUpdateTag: "string",
        location: "string",
        name: "string",
        protectedSettings: "string",
        settings: "string",
        tags: {
            string: "string",
        },
        typeHandlerVersion: "string",
    });
    
    type: azure:arcmachine:Extension
    properties:
        arcMachineId: string
        automaticUpgradeEnabled: false
        forceUpdateTag: string
        location: string
        name: string
        protectedSettings: string
        publisher: string
        settings: string
        tags:
            string: string
        type: string
        typeHandlerVersion: string
    

    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:

    ArcMachineId string
    The ID of the Hybrid Compute Machine Extension. Changing this forces a new Hybrid Compute Machine Extension to be created.
    Publisher string
    The name of the extension handler publisher, such as Microsoft.Azure.Monitor. Changing this forces a new Hybrid Compute Machine Extension to be created.
    Type string
    Specifies the type of the extension. For example CustomScriptExtension or AzureMonitorLinuxAgent. Changing this forces a new Hybrid Compute Machine Extension to be created.
    AutomaticUpgradeEnabled bool

    Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. Supported values are true and false. Defaults to true.

    NOTE: When automatic_upgrade_enabled can only be set during creation. Any later change will be ignored.

    NOTE: When automatic_upgrade_enabled is set to true, the type_handler_version is automatically updated by the Azure platform when a new version is available and any change in type_handler_version will be automatically ignored.

    ForceUpdateTag string
    How the extension handler should be forced to update even if the extension configuration has not changed.
    Location string
    The Azure Region where the Hybrid Compute Machine Extension should exist. Changing this forces a new Hybrid Compute Machine Extension to be created.
    Name string
    The name which should be used for this Hybrid Compute Machine Extension. Changing this forces a new Hybrid Compute Machine Extension to be created.
    ProtectedSettings string
    Json formatted protected settings for the extension.
    Settings string
    Json formatted public settings for the extension.
    Tags Dictionary<string, string>
    A mapping of tags which should be assigned to the Hybrid Compute Machine Extension.
    TypeHandlerVersion string

    Specifies the version of the script handler.

    NOTE: 1. When automatic_upgrade_enabled is set to false and no type_handler_version is specified, the type_handler_version change should be manually ignored by ignore_changes lifecycle block. This is because the type_handler_version is set by the Azure platform when the extension is created. 2. When automatic_upgrade_enabled is set to false and type_handler_version is specified, the provider will check whether the version prefix is aligned with user input. For example, if user specifies 1.24 in type_handler_version, 1.24.1 will be considered as no diff.

    ArcMachineId string
    The ID of the Hybrid Compute Machine Extension. Changing this forces a new Hybrid Compute Machine Extension to be created.
    Publisher string
    The name of the extension handler publisher, such as Microsoft.Azure.Monitor. Changing this forces a new Hybrid Compute Machine Extension to be created.
    Type string
    Specifies the type of the extension. For example CustomScriptExtension or AzureMonitorLinuxAgent. Changing this forces a new Hybrid Compute Machine Extension to be created.
    AutomaticUpgradeEnabled bool

    Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. Supported values are true and false. Defaults to true.

    NOTE: When automatic_upgrade_enabled can only be set during creation. Any later change will be ignored.

    NOTE: When automatic_upgrade_enabled is set to true, the type_handler_version is automatically updated by the Azure platform when a new version is available and any change in type_handler_version will be automatically ignored.

    ForceUpdateTag string
    How the extension handler should be forced to update even if the extension configuration has not changed.
    Location string
    The Azure Region where the Hybrid Compute Machine Extension should exist. Changing this forces a new Hybrid Compute Machine Extension to be created.
    Name string
    The name which should be used for this Hybrid Compute Machine Extension. Changing this forces a new Hybrid Compute Machine Extension to be created.
    ProtectedSettings string
    Json formatted protected settings for the extension.
    Settings string
    Json formatted public settings for the extension.
    Tags map[string]string
    A mapping of tags which should be assigned to the Hybrid Compute Machine Extension.
    TypeHandlerVersion string

    Specifies the version of the script handler.

    NOTE: 1. When automatic_upgrade_enabled is set to false and no type_handler_version is specified, the type_handler_version change should be manually ignored by ignore_changes lifecycle block. This is because the type_handler_version is set by the Azure platform when the extension is created. 2. When automatic_upgrade_enabled is set to false and type_handler_version is specified, the provider will check whether the version prefix is aligned with user input. For example, if user specifies 1.24 in type_handler_version, 1.24.1 will be considered as no diff.

    arcMachineId String
    The ID of the Hybrid Compute Machine Extension. Changing this forces a new Hybrid Compute Machine Extension to be created.
    publisher String
    The name of the extension handler publisher, such as Microsoft.Azure.Monitor. Changing this forces a new Hybrid Compute Machine Extension to be created.
    type String
    Specifies the type of the extension. For example CustomScriptExtension or AzureMonitorLinuxAgent. Changing this forces a new Hybrid Compute Machine Extension to be created.
    automaticUpgradeEnabled Boolean

    Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. Supported values are true and false. Defaults to true.

    NOTE: When automatic_upgrade_enabled can only be set during creation. Any later change will be ignored.

    NOTE: When automatic_upgrade_enabled is set to true, the type_handler_version is automatically updated by the Azure platform when a new version is available and any change in type_handler_version will be automatically ignored.

    forceUpdateTag String
    How the extension handler should be forced to update even if the extension configuration has not changed.
    location String
    The Azure Region where the Hybrid Compute Machine Extension should exist. Changing this forces a new Hybrid Compute Machine Extension to be created.
    name String
    The name which should be used for this Hybrid Compute Machine Extension. Changing this forces a new Hybrid Compute Machine Extension to be created.
    protectedSettings String
    Json formatted protected settings for the extension.
    settings String
    Json formatted public settings for the extension.
    tags Map<String,String>
    A mapping of tags which should be assigned to the Hybrid Compute Machine Extension.
    typeHandlerVersion String

    Specifies the version of the script handler.

    NOTE: 1. When automatic_upgrade_enabled is set to false and no type_handler_version is specified, the type_handler_version change should be manually ignored by ignore_changes lifecycle block. This is because the type_handler_version is set by the Azure platform when the extension is created. 2. When automatic_upgrade_enabled is set to false and type_handler_version is specified, the provider will check whether the version prefix is aligned with user input. For example, if user specifies 1.24 in type_handler_version, 1.24.1 will be considered as no diff.

    arcMachineId string
    The ID of the Hybrid Compute Machine Extension. Changing this forces a new Hybrid Compute Machine Extension to be created.
    publisher string
    The name of the extension handler publisher, such as Microsoft.Azure.Monitor. Changing this forces a new Hybrid Compute Machine Extension to be created.
    type string
    Specifies the type of the extension. For example CustomScriptExtension or AzureMonitorLinuxAgent. Changing this forces a new Hybrid Compute Machine Extension to be created.
    automaticUpgradeEnabled boolean

    Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. Supported values are true and false. Defaults to true.

    NOTE: When automatic_upgrade_enabled can only be set during creation. Any later change will be ignored.

    NOTE: When automatic_upgrade_enabled is set to true, the type_handler_version is automatically updated by the Azure platform when a new version is available and any change in type_handler_version will be automatically ignored.

    forceUpdateTag string
    How the extension handler should be forced to update even if the extension configuration has not changed.
    location string
    The Azure Region where the Hybrid Compute Machine Extension should exist. Changing this forces a new Hybrid Compute Machine Extension to be created.
    name string
    The name which should be used for this Hybrid Compute Machine Extension. Changing this forces a new Hybrid Compute Machine Extension to be created.
    protectedSettings string
    Json formatted protected settings for the extension.
    settings string
    Json formatted public settings for the extension.
    tags {[key: string]: string}
    A mapping of tags which should be assigned to the Hybrid Compute Machine Extension.
    typeHandlerVersion string

    Specifies the version of the script handler.

    NOTE: 1. When automatic_upgrade_enabled is set to false and no type_handler_version is specified, the type_handler_version change should be manually ignored by ignore_changes lifecycle block. This is because the type_handler_version is set by the Azure platform when the extension is created. 2. When automatic_upgrade_enabled is set to false and type_handler_version is specified, the provider will check whether the version prefix is aligned with user input. For example, if user specifies 1.24 in type_handler_version, 1.24.1 will be considered as no diff.

    arc_machine_id str
    The ID of the Hybrid Compute Machine Extension. Changing this forces a new Hybrid Compute Machine Extension to be created.
    publisher str
    The name of the extension handler publisher, such as Microsoft.Azure.Monitor. Changing this forces a new Hybrid Compute Machine Extension to be created.
    type str
    Specifies the type of the extension. For example CustomScriptExtension or AzureMonitorLinuxAgent. Changing this forces a new Hybrid Compute Machine Extension to be created.
    automatic_upgrade_enabled bool

    Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. Supported values are true and false. Defaults to true.

    NOTE: When automatic_upgrade_enabled can only be set during creation. Any later change will be ignored.

    NOTE: When automatic_upgrade_enabled is set to true, the type_handler_version is automatically updated by the Azure platform when a new version is available and any change in type_handler_version will be automatically ignored.

    force_update_tag str
    How the extension handler should be forced to update even if the extension configuration has not changed.
    location str
    The Azure Region where the Hybrid Compute Machine Extension should exist. Changing this forces a new Hybrid Compute Machine Extension to be created.
    name str
    The name which should be used for this Hybrid Compute Machine Extension. Changing this forces a new Hybrid Compute Machine Extension to be created.
    protected_settings str
    Json formatted protected settings for the extension.
    settings str
    Json formatted public settings for the extension.
    tags Mapping[str, str]
    A mapping of tags which should be assigned to the Hybrid Compute Machine Extension.
    type_handler_version str

    Specifies the version of the script handler.

    NOTE: 1. When automatic_upgrade_enabled is set to false and no type_handler_version is specified, the type_handler_version change should be manually ignored by ignore_changes lifecycle block. This is because the type_handler_version is set by the Azure platform when the extension is created. 2. When automatic_upgrade_enabled is set to false and type_handler_version is specified, the provider will check whether the version prefix is aligned with user input. For example, if user specifies 1.24 in type_handler_version, 1.24.1 will be considered as no diff.

    arcMachineId String
    The ID of the Hybrid Compute Machine Extension. Changing this forces a new Hybrid Compute Machine Extension to be created.
    publisher String
    The name of the extension handler publisher, such as Microsoft.Azure.Monitor. Changing this forces a new Hybrid Compute Machine Extension to be created.
    type String
    Specifies the type of the extension. For example CustomScriptExtension or AzureMonitorLinuxAgent. Changing this forces a new Hybrid Compute Machine Extension to be created.
    automaticUpgradeEnabled Boolean

    Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. Supported values are true and false. Defaults to true.

    NOTE: When automatic_upgrade_enabled can only be set during creation. Any later change will be ignored.

    NOTE: When automatic_upgrade_enabled is set to true, the type_handler_version is automatically updated by the Azure platform when a new version is available and any change in type_handler_version will be automatically ignored.

    forceUpdateTag String
    How the extension handler should be forced to update even if the extension configuration has not changed.
    location String
    The Azure Region where the Hybrid Compute Machine Extension should exist. Changing this forces a new Hybrid Compute Machine Extension to be created.
    name String
    The name which should be used for this Hybrid Compute Machine Extension. Changing this forces a new Hybrid Compute Machine Extension to be created.
    protectedSettings String
    Json formatted protected settings for the extension.
    settings String
    Json formatted public settings for the extension.
    tags Map<String>
    A mapping of tags which should be assigned to the Hybrid Compute Machine Extension.
    typeHandlerVersion String

    Specifies the version of the script handler.

    NOTE: 1. When automatic_upgrade_enabled is set to false and no type_handler_version is specified, the type_handler_version change should be manually ignored by ignore_changes lifecycle block. This is because the type_handler_version is set by the Azure platform when the extension is created. 2. When automatic_upgrade_enabled is set to false and type_handler_version is specified, the provider will check whether the version prefix is aligned with user input. For example, if user specifies 1.24 in type_handler_version, 1.24.1 will be considered as no diff.

    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,
            arc_machine_id: Optional[str] = None,
            automatic_upgrade_enabled: Optional[bool] = None,
            force_update_tag: Optional[str] = None,
            location: Optional[str] = None,
            name: Optional[str] = None,
            protected_settings: Optional[str] = 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) -> 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:
    ArcMachineId string
    The ID of the Hybrid Compute Machine Extension. Changing this forces a new Hybrid Compute Machine Extension to be created.
    AutomaticUpgradeEnabled bool

    Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. Supported values are true and false. Defaults to true.

    NOTE: When automatic_upgrade_enabled can only be set during creation. Any later change will be ignored.

    NOTE: When automatic_upgrade_enabled is set to true, the type_handler_version is automatically updated by the Azure platform when a new version is available and any change in type_handler_version will be automatically ignored.

    ForceUpdateTag string
    How the extension handler should be forced to update even if the extension configuration has not changed.
    Location string
    The Azure Region where the Hybrid Compute Machine Extension should exist. Changing this forces a new Hybrid Compute Machine Extension to be created.
    Name string
    The name which should be used for this Hybrid Compute Machine Extension. Changing this forces a new Hybrid Compute Machine Extension to be created.
    ProtectedSettings string
    Json formatted protected settings for the extension.
    Publisher string
    The name of the extension handler publisher, such as Microsoft.Azure.Monitor. Changing this forces a new Hybrid Compute Machine Extension to be created.
    Settings string
    Json formatted public settings for the extension.
    Tags Dictionary<string, string>
    A mapping of tags which should be assigned to the Hybrid Compute Machine Extension.
    Type string
    Specifies the type of the extension. For example CustomScriptExtension or AzureMonitorLinuxAgent. Changing this forces a new Hybrid Compute Machine Extension to be created.
    TypeHandlerVersion string

    Specifies the version of the script handler.

    NOTE: 1. When automatic_upgrade_enabled is set to false and no type_handler_version is specified, the type_handler_version change should be manually ignored by ignore_changes lifecycle block. This is because the type_handler_version is set by the Azure platform when the extension is created. 2. When automatic_upgrade_enabled is set to false and type_handler_version is specified, the provider will check whether the version prefix is aligned with user input. For example, if user specifies 1.24 in type_handler_version, 1.24.1 will be considered as no diff.

    ArcMachineId string
    The ID of the Hybrid Compute Machine Extension. Changing this forces a new Hybrid Compute Machine Extension to be created.
    AutomaticUpgradeEnabled bool

    Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. Supported values are true and false. Defaults to true.

    NOTE: When automatic_upgrade_enabled can only be set during creation. Any later change will be ignored.

    NOTE: When automatic_upgrade_enabled is set to true, the type_handler_version is automatically updated by the Azure platform when a new version is available and any change in type_handler_version will be automatically ignored.

    ForceUpdateTag string
    How the extension handler should be forced to update even if the extension configuration has not changed.
    Location string
    The Azure Region where the Hybrid Compute Machine Extension should exist. Changing this forces a new Hybrid Compute Machine Extension to be created.
    Name string
    The name which should be used for this Hybrid Compute Machine Extension. Changing this forces a new Hybrid Compute Machine Extension to be created.
    ProtectedSettings string
    Json formatted protected settings for the extension.
    Publisher string
    The name of the extension handler publisher, such as Microsoft.Azure.Monitor. Changing this forces a new Hybrid Compute Machine Extension to be created.
    Settings string
    Json formatted public settings for the extension.
    Tags map[string]string
    A mapping of tags which should be assigned to the Hybrid Compute Machine Extension.
    Type string
    Specifies the type of the extension. For example CustomScriptExtension or AzureMonitorLinuxAgent. Changing this forces a new Hybrid Compute Machine Extension to be created.
    TypeHandlerVersion string

    Specifies the version of the script handler.

    NOTE: 1. When automatic_upgrade_enabled is set to false and no type_handler_version is specified, the type_handler_version change should be manually ignored by ignore_changes lifecycle block. This is because the type_handler_version is set by the Azure platform when the extension is created. 2. When automatic_upgrade_enabled is set to false and type_handler_version is specified, the provider will check whether the version prefix is aligned with user input. For example, if user specifies 1.24 in type_handler_version, 1.24.1 will be considered as no diff.

    arcMachineId String
    The ID of the Hybrid Compute Machine Extension. Changing this forces a new Hybrid Compute Machine Extension to be created.
    automaticUpgradeEnabled Boolean

    Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. Supported values are true and false. Defaults to true.

    NOTE: When automatic_upgrade_enabled can only be set during creation. Any later change will be ignored.

    NOTE: When automatic_upgrade_enabled is set to true, the type_handler_version is automatically updated by the Azure platform when a new version is available and any change in type_handler_version will be automatically ignored.

    forceUpdateTag String
    How the extension handler should be forced to update even if the extension configuration has not changed.
    location String
    The Azure Region where the Hybrid Compute Machine Extension should exist. Changing this forces a new Hybrid Compute Machine Extension to be created.
    name String
    The name which should be used for this Hybrid Compute Machine Extension. Changing this forces a new Hybrid Compute Machine Extension to be created.
    protectedSettings String
    Json formatted protected settings for the extension.
    publisher String
    The name of the extension handler publisher, such as Microsoft.Azure.Monitor. Changing this forces a new Hybrid Compute Machine Extension to be created.
    settings String
    Json formatted public settings for the extension.
    tags Map<String,String>
    A mapping of tags which should be assigned to the Hybrid Compute Machine Extension.
    type String
    Specifies the type of the extension. For example CustomScriptExtension or AzureMonitorLinuxAgent. Changing this forces a new Hybrid Compute Machine Extension to be created.
    typeHandlerVersion String

    Specifies the version of the script handler.

    NOTE: 1. When automatic_upgrade_enabled is set to false and no type_handler_version is specified, the type_handler_version change should be manually ignored by ignore_changes lifecycle block. This is because the type_handler_version is set by the Azure platform when the extension is created. 2. When automatic_upgrade_enabled is set to false and type_handler_version is specified, the provider will check whether the version prefix is aligned with user input. For example, if user specifies 1.24 in type_handler_version, 1.24.1 will be considered as no diff.

    arcMachineId string
    The ID of the Hybrid Compute Machine Extension. Changing this forces a new Hybrid Compute Machine Extension to be created.
    automaticUpgradeEnabled boolean

    Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. Supported values are true and false. Defaults to true.

    NOTE: When automatic_upgrade_enabled can only be set during creation. Any later change will be ignored.

    NOTE: When automatic_upgrade_enabled is set to true, the type_handler_version is automatically updated by the Azure platform when a new version is available and any change in type_handler_version will be automatically ignored.

    forceUpdateTag string
    How the extension handler should be forced to update even if the extension configuration has not changed.
    location string
    The Azure Region where the Hybrid Compute Machine Extension should exist. Changing this forces a new Hybrid Compute Machine Extension to be created.
    name string
    The name which should be used for this Hybrid Compute Machine Extension. Changing this forces a new Hybrid Compute Machine Extension to be created.
    protectedSettings string
    Json formatted protected settings for the extension.
    publisher string
    The name of the extension handler publisher, such as Microsoft.Azure.Monitor. Changing this forces a new Hybrid Compute Machine Extension to be created.
    settings string
    Json formatted public settings for the extension.
    tags {[key: string]: string}
    A mapping of tags which should be assigned to the Hybrid Compute Machine Extension.
    type string
    Specifies the type of the extension. For example CustomScriptExtension or AzureMonitorLinuxAgent. Changing this forces a new Hybrid Compute Machine Extension to be created.
    typeHandlerVersion string

    Specifies the version of the script handler.

    NOTE: 1. When automatic_upgrade_enabled is set to false and no type_handler_version is specified, the type_handler_version change should be manually ignored by ignore_changes lifecycle block. This is because the type_handler_version is set by the Azure platform when the extension is created. 2. When automatic_upgrade_enabled is set to false and type_handler_version is specified, the provider will check whether the version prefix is aligned with user input. For example, if user specifies 1.24 in type_handler_version, 1.24.1 will be considered as no diff.

    arc_machine_id str
    The ID of the Hybrid Compute Machine Extension. Changing this forces a new Hybrid Compute Machine Extension to be created.
    automatic_upgrade_enabled bool

    Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. Supported values are true and false. Defaults to true.

    NOTE: When automatic_upgrade_enabled can only be set during creation. Any later change will be ignored.

    NOTE: When automatic_upgrade_enabled is set to true, the type_handler_version is automatically updated by the Azure platform when a new version is available and any change in type_handler_version will be automatically ignored.

    force_update_tag str
    How the extension handler should be forced to update even if the extension configuration has not changed.
    location str
    The Azure Region where the Hybrid Compute Machine Extension should exist. Changing this forces a new Hybrid Compute Machine Extension to be created.
    name str
    The name which should be used for this Hybrid Compute Machine Extension. Changing this forces a new Hybrid Compute Machine Extension to be created.
    protected_settings str
    Json formatted protected settings for the extension.
    publisher str
    The name of the extension handler publisher, such as Microsoft.Azure.Monitor. Changing this forces a new Hybrid Compute Machine Extension to be created.
    settings str
    Json formatted public settings for the extension.
    tags Mapping[str, str]
    A mapping of tags which should be assigned to the Hybrid Compute Machine Extension.
    type str
    Specifies the type of the extension. For example CustomScriptExtension or AzureMonitorLinuxAgent. Changing this forces a new Hybrid Compute Machine Extension to be created.
    type_handler_version str

    Specifies the version of the script handler.

    NOTE: 1. When automatic_upgrade_enabled is set to false and no type_handler_version is specified, the type_handler_version change should be manually ignored by ignore_changes lifecycle block. This is because the type_handler_version is set by the Azure platform when the extension is created. 2. When automatic_upgrade_enabled is set to false and type_handler_version is specified, the provider will check whether the version prefix is aligned with user input. For example, if user specifies 1.24 in type_handler_version, 1.24.1 will be considered as no diff.

    arcMachineId String
    The ID of the Hybrid Compute Machine Extension. Changing this forces a new Hybrid Compute Machine Extension to be created.
    automaticUpgradeEnabled Boolean

    Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. Supported values are true and false. Defaults to true.

    NOTE: When automatic_upgrade_enabled can only be set during creation. Any later change will be ignored.

    NOTE: When automatic_upgrade_enabled is set to true, the type_handler_version is automatically updated by the Azure platform when a new version is available and any change in type_handler_version will be automatically ignored.

    forceUpdateTag String
    How the extension handler should be forced to update even if the extension configuration has not changed.
    location String
    The Azure Region where the Hybrid Compute Machine Extension should exist. Changing this forces a new Hybrid Compute Machine Extension to be created.
    name String
    The name which should be used for this Hybrid Compute Machine Extension. Changing this forces a new Hybrid Compute Machine Extension to be created.
    protectedSettings String
    Json formatted protected settings for the extension.
    publisher String
    The name of the extension handler publisher, such as Microsoft.Azure.Monitor. Changing this forces a new Hybrid Compute Machine Extension to be created.
    settings String
    Json formatted public settings for the extension.
    tags Map<String>
    A mapping of tags which should be assigned to the Hybrid Compute Machine Extension.
    type String
    Specifies the type of the extension. For example CustomScriptExtension or AzureMonitorLinuxAgent. Changing this forces a new Hybrid Compute Machine Extension to be created.
    typeHandlerVersion String

    Specifies the version of the script handler.

    NOTE: 1. When automatic_upgrade_enabled is set to false and no type_handler_version is specified, the type_handler_version change should be manually ignored by ignore_changes lifecycle block. This is because the type_handler_version is set by the Azure platform when the extension is created. 2. When automatic_upgrade_enabled is set to false and type_handler_version is specified, the provider will check whether the version prefix is aligned with user input. For example, if user specifies 1.24 in type_handler_version, 1.24.1 will be considered as no diff.

    Import

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

    $ pulumi import azure:arcmachine/extension:Extension example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.HybridCompute/machines/hcmachine1/extensions/ext1
    

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

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Azure Classic v5.84.0 published on Tuesday, Jul 16, 2024 by Pulumi