Azure Native v1.102.0, May 2 23

azure-native.azurestackhci.Extension

Explore with Pulumi AI

Details of a particular extension in HCI Cluster. API Version: 2021-01-01-preview.

Example Usage

Create Arc Extension

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

return await Deployment.RunAsync(() => 
{
    var extension = new AzureNative.AzureStackHCI.Extension("extension", new()
    {
        ArcSettingName = "default",
        ClusterName = "myCluster",
        ExtensionName = "MicrosoftMonitoringAgent",
        ProtectedSettings = 
        {
            { "workspaceKey", "xx" },
        },
        Publisher = "Microsoft.Compute",
        ResourceGroupName = "test-rg",
        Settings = 
        {
            { "workspaceId", "xx" },
        },
        Type = "MicrosoftMonitoringAgent",
        TypeHandlerVersion = "1.10",
    });

});

package main

import (
	azurestackhci "github.com/pulumi/pulumi-azure-native/sdk/go/azure/azurestackhci"
	"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"),
			ExtensionName:  pulumi.String("MicrosoftMonitoringAgent"),
			ProtectedSettings: pulumi.Any{
				WorkspaceKey: "xx",
			},
			Publisher:         pulumi.String("Microsoft.Compute"),
			ResourceGroupName: pulumi.String("test-rg"),
			Settings: pulumi.Any{
				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")
            .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 pulumi
import pulumi_azure_native as azure_native

extension = azure_native.azurestackhci.Extension("extension",
    arc_setting_name="default",
    cluster_name="myCluster",
    extension_name="MicrosoftMonitoringAgent",
    protected_settings={
        "workspaceKey": "xx",
    },
    publisher="Microsoft.Compute",
    resource_group_name="test-rg",
    settings={
        "workspaceId": "xx",
    },
    type="MicrosoftMonitoringAgent",
    type_handler_version="1.10")

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

const extension = new azure_native.azurestackhci.Extension("extension", {
    arcSettingName: "default",
    clusterName: "myCluster",
    extensionName: "MicrosoftMonitoringAgent",
    protectedSettings: {
        workspaceKey: "xx",
    },
    publisher: "Microsoft.Compute",
    resourceGroupName: "test-rg",
    settings: {
        workspaceId: "xx",
    },
    type: "MicrosoftMonitoringAgent",
    typeHandlerVersion: "1.10",
});

resources:
  extension:
    type: azure-native:azurestackhci:Extension
    properties:
      arcSettingName: default
      clusterName: myCluster
      extensionName: MicrosoftMonitoringAgent
      protectedSettings:
        workspaceKey: xx
      publisher: Microsoft.Compute
      resourceGroupName: test-rg
      settings:
        workspaceId: xx
      type: MicrosoftMonitoringAgent
      typeHandlerVersion: '1.10'

Create Extension Resource

new Extension(name: string, args: ExtensionArgs, opts?: CustomResourceOptions);

@overload
def Extension(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              arc_setting_name: Optional[str] = None,
              auto_upgrade_minor_version: Optional[bool] = None,
              cluster_name: Optional[str] = None,
              created_at: Optional[str] = None,
              created_by: Optional[str] = None,
              created_by_type: Optional[Union[str, CreatedByType]] = None,
              extension_name: Optional[str] = None,
              force_update_tag: Optional[str] = None,
              last_modified_at: Optional[str] = None,
              last_modified_by: Optional[str] = None,
              last_modified_by_type: Optional[Union[str, CreatedByType]] = None,
              protected_settings: Optional[Any] = None,
              publisher: Optional[str] = None,
              resource_group_name: Optional[str] = None,
              settings: Optional[Any] = None,
              type: Optional[str] = None,
              type_handler_version: Optional[str] = None)
@overload
def Extension(resource_name: str,
              args: ExtensionArgs,
              opts: Optional[ResourceOptions] = 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-native:azurestackhci:Extension
properties: # The arguments to resource properties.
options: # 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.

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.

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:

ArcSettingName string: The name of the proxy resource holding details of HCI ArcSetting information.
ClusterName string: The name of the cluster.
ResourceGroupName string: The name of the resource group. The name is case insensitive.
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.
CreatedAt string: The timestamp of resource creation (UTC).
CreatedBy string: The identity that created the resource.
CreatedByType string | Pulumi.AzureNative.AzureStackHCI.CreatedByType: The type of identity that created the resource.
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.
LastModifiedAt string: The timestamp of resource last modification (UTC)
LastModifiedBy string: The identity that last modified the resource.
LastModifiedByType string | Pulumi.AzureNative.AzureStackHCI.CreatedByType: The type of identity that last modified the resource.
ProtectedSettings object: Protected settings (may contain secrets).
Publisher string: The name of the extension handler publisher.
Settings object: Json formatted public settings for the extension.
Type string: Specifies the type of the extension; an example is "CustomScriptExtension".
TypeHandlerVersion string: Specifies the version of the script handler.

ArcSettingName string: The name of the proxy resource holding details of HCI ArcSetting information.
ClusterName string: The name of the cluster.
ResourceGroupName string: The name of the resource group. The name is case insensitive.
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.
CreatedAt string: The timestamp of resource creation (UTC).
CreatedBy string: The identity that created the resource.
CreatedByType string | CreatedByType: The type of identity that created the resource.
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.
LastModifiedAt string: The timestamp of resource last modification (UTC)
LastModifiedBy string: The identity that last modified the resource.
LastModifiedByType string | CreatedByType: The type of identity that last modified the resource.
ProtectedSettings interface{}: Protected settings (may contain secrets).
Publisher string: The name of the extension handler publisher.
Settings interface{}: Json formatted public settings for the extension.
Type string: Specifies the type of the extension; an example is "CustomScriptExtension".
TypeHandlerVersion string: Specifies the version of the script handler.

arcSettingName String: The name of the proxy resource holding details of HCI ArcSetting information.
clusterName String: The name of the cluster.
resourceGroupName String: The name of the resource group. The name is case insensitive.
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.
createdAt String: The timestamp of resource creation (UTC).
createdBy String: The identity that created the resource.
createdByType String | CreatedByType: The type of identity that created the resource.
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.
lastModifiedAt String: The timestamp of resource last modification (UTC)
lastModifiedBy String: The identity that last modified the resource.
lastModifiedByType String | CreatedByType: The type of identity that last modified the resource.
protectedSettings Object: Protected settings (may contain secrets).
publisher String: The name of the extension handler publisher.
settings Object: Json formatted public settings for the extension.
type String: Specifies the type of the extension; an example is "CustomScriptExtension".
typeHandlerVersion String: Specifies the version of the script handler.

arcSettingName string: The name of the proxy resource holding details of HCI ArcSetting information.
clusterName string: The name of the cluster.
resourceGroupName string: The name of the resource group. The name is case insensitive.
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.
createdAt string: The timestamp of resource creation (UTC).
createdBy string: The identity that created the resource.
createdByType string | CreatedByType: The type of identity that created the resource.
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.
lastModifiedAt string: The timestamp of resource last modification (UTC)
lastModifiedBy string: The identity that last modified the resource.
lastModifiedByType string | CreatedByType: The type of identity that last modified the resource.
protectedSettings any: Protected settings (may contain secrets).
publisher string: The name of the extension handler publisher.
settings any: Json formatted public settings for the extension.
type string: Specifies the type of the extension; an example is "CustomScriptExtension".
typeHandlerVersion string: Specifies the version of the script handler.

arc_setting_name str: The name of the proxy resource holding details of HCI ArcSetting information.
cluster_name str: The name of the cluster.
resource_group_name str: The name of the resource group. The name is case insensitive.
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.
created_at str: The timestamp of resource creation (UTC).
created_by str: The identity that created the resource.
created_by_type str | CreatedByType: The type of identity that created the resource.
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.
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 | CreatedByType: The type of identity that last modified the resource.
protected_settings Any: Protected settings (may contain secrets).
publisher str: The name of the extension handler publisher.
settings Any: Json formatted public settings for the extension.
type str: Specifies the type of the extension; an example is "CustomScriptExtension".
type_handler_version str: Specifies the version of the script handler.

arcSettingName String: The name of the proxy resource holding details of HCI ArcSetting information.
clusterName String: The name of the cluster.
resourceGroupName String: The name of the resource group. The name is case insensitive.
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.
createdAt String: The timestamp of resource creation (UTC).
createdBy String: The identity that created the resource.
createdByType String | "User" | "Application" | "ManagedIdentity" | "Key": The type of identity that created the resource.
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.
lastModifiedAt String: The timestamp of resource last modification (UTC)
lastModifiedBy String: The identity that last modified the resource.
lastModifiedByType String | "User" | "Application" | "ManagedIdentity" | "Key": The type of identity that last modified the resource.
protectedSettings Any: Protected settings (may contain secrets).
publisher String: The name of the extension handler publisher.
settings Any: Json formatted public settings for the extension.
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 Extension resource produces the following output properties:

AggregateState string: Aggregate state of Arc Extensions across the nodes in this HCI cluster.
Id string: The provider-assigned unique ID for this managed resource.
Name string: The name of the resource
PerNodeExtensionDetails List<Pulumi.AzureNative.AzureStackHCI.Outputs.PerNodeExtensionStateResponse>: State of Arc Extension in each of the nodes.
ProvisioningState string: Provisioning state of the Extension proxy resource.

AggregateState string: Aggregate state of Arc Extensions across the nodes in this HCI cluster.
Id string: The provider-assigned unique ID for this managed resource.
Name string: The name of the resource
PerNodeExtensionDetails []PerNodeExtensionStateResponse: State of Arc Extension in each of the nodes.
ProvisioningState string: Provisioning state of the Extension proxy resource.

aggregateState String: Aggregate state of Arc Extensions across the nodes in this HCI cluster.
id String: The provider-assigned unique ID for this managed resource.
name String: The name of the resource
perNodeExtensionDetails List<PerNodeExtensionStateResponse>: State of Arc Extension in each of the nodes.
provisioningState String: Provisioning state of the Extension proxy resource.

aggregateState string: Aggregate state of Arc Extensions across the nodes in this HCI cluster.
id string: The provider-assigned unique ID for this managed resource.
name string: The name of the resource
perNodeExtensionDetails PerNodeExtensionStateResponse[]: State of Arc Extension in each of the nodes.
provisioningState string: Provisioning state of the Extension proxy resource.

aggregate_state str: Aggregate state of Arc Extensions across the nodes in this HCI cluster.
id str: The provider-assigned unique ID for this managed resource.
name str: The name of the resource
per_node_extension_details Sequence[PerNodeExtensionStateResponse]: State of Arc Extension in each of the nodes.
provisioning_state str: Provisioning state of the Extension proxy resource.

aggregateState String: Aggregate state of Arc Extensions across the nodes in this HCI cluster.
id String: The provider-assigned unique ID for this managed resource.
name String: The name of the resource
perNodeExtensionDetails List<Property Map>: State of Arc Extension in each of the nodes.
provisioningState String: Provisioning state of the Extension proxy resource.

Supporting Types

CreatedByType

User: User
Application: Application
ManagedIdentity: ManagedIdentity
Key: Key

CreatedByTypeUser: User
CreatedByTypeApplication: Application
CreatedByTypeManagedIdentity: ManagedIdentity
CreatedByTypeKey: Key

User: User
Application: Application
ManagedIdentity: ManagedIdentity
Key: Key

User: User
Application: Application
ManagedIdentity: ManagedIdentity
Key: Key

USER: User
APPLICATION: Application
MANAGED_IDENTITY: ManagedIdentity
KEY: Key

"User": User
"Application": Application
"ManagedIdentity": ManagedIdentity
"Key": Key

PerNodeExtensionStateResponse

Extension string: Fully qualified resource ID for the particular Arc Extension on this node.
Name string: Name of the node in HCI Cluster.
State string: State of Arc Extension in this node.

Extension string: Fully qualified resource ID for the particular Arc Extension on this node.
Name string: Name of the node in HCI Cluster.
State string: State of Arc Extension in this node.

extension String: Fully qualified resource ID for the particular Arc Extension on this node.
name String: Name of the node in HCI Cluster.
state String: State of Arc Extension in this node.

extension string: Fully qualified resource ID for the particular Arc Extension on this node.
name string: Name of the node in HCI Cluster.
state string: State of Arc Extension in this node.

extension str: Fully qualified resource ID for the particular Arc Extension on this node.
name str: Name of the node in HCI Cluster.
state str: State of Arc Extension in this node.

extension String: Fully qualified resource ID for the particular Arc Extension on this node.
name String: Name of the node in HCI Cluster.
state String: State of Arc Extension in this node.

Import

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

$ pulumi import azure-native:azurestackhci:Extension MicrosoftMonitoringAgent /subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/arcSettings/default/extensions/MicrosoftMonitoringAgent

Package Details

Repository: Azure Native pulumi/pulumi-azure-native
License: Apache-2.0