ExtensionArgs

data class ExtensionArgs(val arcSettingName: Output<String>? = null, val autoUpgradeMinorVersion: Output<Boolean>? = null, val clusterName: Output<String>? = null, val enableAutomaticUpgrade: Output<Boolean>? = null, val extensionName: Output<String>? = null, val forceUpdateTag: Output<String>? = null, val protectedSettings: Output<Any>? = null, val publisher: Output<String>? = null, val resourceGroupName: Output<String>? = null, val settings: Output<Any>? = null, val type: Output<String>? = null, val typeHandlerVersion: Output<String>? = null) : ConvertibleToJava<ExtensionArgs>

Details of a particular extension in HCI Cluster. Uses Azure REST API version 2024-04-01. In version 2.x of the Azure Native provider, it used API version 2023-03-01. Other available API versions: 2022-12-15-preview, 2023-02-01, 2023-03-01, 2023-06-01, 2023-08-01, 2023-08-01-preview, 2023-11-01-preview, 2024-01-01, 2024-02-15-preview, 2024-09-01-preview, 2024-12-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native azurestackhci [ApiVersion]. See the ../../../version-guide/#accessing-any-api-version-via-local-packages for details.

Example Usage

Create Arc Extension

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var extension = new AzureNative.AzureStackHCI.Extension("extension", new()
{
ArcSettingName = "default",
ClusterName = "myCluster",
EnableAutomaticUpgrade = false,
ExtensionName = "MicrosoftMonitoringAgent",
ProtectedSettings = new Dictionary<string, object?>
{
["workspaceKey"] = "xx",
},
Publisher = "Microsoft.Compute",
ResourceGroupName = "test-rg",
Settings = new Dictionary<string, object?>
{
["workspaceId"] = "xx",
},
Type = "MicrosoftMonitoringAgent",
TypeHandlerVersion = "1.10",
});
});
package main
import (
azurestackhci "github.com/pulumi/pulumi-azure-native-sdk/azurestackhci/v2"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := azurestackhci.NewExtension(ctx, "extension", &azurestackhci.ExtensionArgs{
ArcSettingName: pulumi.String("default"),
ClusterName: pulumi.String("myCluster"),
EnableAutomaticUpgrade: pulumi.Bool(false),
ExtensionName: pulumi.String("MicrosoftMonitoringAgent"),
ProtectedSettings: pulumi.Any(map[string]interface{}{
"workspaceKey": "xx",
}),
Publisher: pulumi.String("Microsoft.Compute"),
ResourceGroupName: pulumi.String("test-rg"),
Settings: pulumi.Any(map[string]interface{}{
"workspaceId": "xx",
}),
Type: pulumi.String("MicrosoftMonitoringAgent"),
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.azurestackhci.Extension;
import com.pulumi.azurenative.azurestackhci.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 extension = new Extension("extension", ExtensionArgs.builder()
.arcSettingName("default")
.clusterName("myCluster")
.enableAutomaticUpgrade(false)
.extensionName("MicrosoftMonitoringAgent")
.protectedSettings(Map.of("workspaceKey", "xx"))
.publisher("Microsoft.Compute")
.resourceGroupName("test-rg")
.settings(Map.of("workspaceId", "xx"))
.type("MicrosoftMonitoringAgent")
.typeHandlerVersion("1.10")
.build());
}
}

Import

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

$ pulumi import azure-native:azurestackhci:Extension MicrosoftMonitoringAgent /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/arcSettings/{arcSettingName}/extensions/{extensionName}

Constructors

Link copied to clipboard
constructor(arcSettingName: Output<String>? = null, autoUpgradeMinorVersion: Output<Boolean>? = null, clusterName: Output<String>? = null, enableAutomaticUpgrade: Output<Boolean>? = null, extensionName: Output<String>? = null, forceUpdateTag: Output<String>? = null, protectedSettings: Output<Any>? = null, publisher: Output<String>? = null, resourceGroupName: Output<String>? = null, settings: Output<Any>? = null, type: Output<String>? = null, typeHandlerVersion: Output<String>? = null)

Properties

Link copied to clipboard
val arcSettingName: Output<String>? = null

The name of the proxy resource holding details of HCI ArcSetting information.

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

Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true.

Link copied to clipboard
val clusterName: Output<String>? = null

The name of the cluster.

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

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

Link copied to clipboard
val extensionName: Output<String>? = null

The name of the machine extension.

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

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

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

Protected settings (may contain secrets).

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

The name of the extension handler publisher.

Link copied to clipboard
val resourceGroupName: Output<String>? = null

The name of the resource group. The name is case insensitive.

Link copied to clipboard
val settings: Output<Any>? = null

Json formatted public settings for the extension.

Link copied to clipboard
val type: Output<String>? = null

Specifies the type of the extension; an example is "CustomScriptExtension".

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

Specifies the version of the script handler. Latest version would be used if not specified.

Functions

Link copied to clipboard
open override fun toJava(): ExtensionArgs