Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. containerservice
  5. KubernetesClusterExtension

We recommend using Azure Native.

Azure Classic v6.2.0 published on Friday, Sep 27, 2024 by Pulumi
pulumi/pulumi-azure

azure.containerservice.KubernetesClusterExtension

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v6.2.0 published on Friday, Sep 27, 2024 by Pulumi
pulumi/pulumi-azure

    Manages a Kubernetes Cluster Extension.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = new azure.core.ResourceGroup("example", {
    name: "example-resources",
    location: "West Europe",
});
const exampleKubernetesCluster = new azure.containerservice.KubernetesCluster("example", {
    name: "example-aks",
    location: "West Europe",
    resourceGroupName: example.name,
    dnsPrefix: "example-aks",
    defaultNodePool: {
        name: "default",
        nodeCount: 1,
        vmSize: "Standard_DS2_v2",
    },
    identity: {
        type: "SystemAssigned",
    },
});
const exampleKubernetesClusterExtension = new azure.containerservice.KubernetesClusterExtension("example", {
    name: "example-ext",
    clusterId: exampleKubernetesCluster.id,
    extensionType: "microsoft.flux",
});

    import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="example-resources",
    location="West Europe")
example_kubernetes_cluster = azure.containerservice.KubernetesCluster("example",
    name="example-aks",
    location="West Europe",
    resource_group_name=example.name,
    dns_prefix="example-aks",
    default_node_pool={
        "name": "default",
        "node_count": 1,
        "vm_size": "Standard_DS2_v2",
    },
    identity={
        "type": "SystemAssigned",
    })
example_kubernetes_cluster_extension = azure.containerservice.KubernetesClusterExtension("example",
    name="example-ext",
    cluster_id=example_kubernetes_cluster.id,
    extension_type="microsoft.flux")

    package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/containerservice"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("example-resources"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleKubernetesCluster, err := containerservice.NewKubernetesCluster(ctx, "example", &containerservice.KubernetesClusterArgs{
			Name:              pulumi.String("example-aks"),
			Location:          pulumi.String("West Europe"),
			ResourceGroupName: example.Name,
			DnsPrefix:         pulumi.String("example-aks"),
			DefaultNodePool: &containerservice.KubernetesClusterDefaultNodePoolArgs{
				Name:      pulumi.String("default"),
				NodeCount: pulumi.Int(1),
				VmSize:    pulumi.String("Standard_DS2_v2"),
			},
			Identity: &containerservice.KubernetesClusterIdentityArgs{
				Type: pulumi.String("SystemAssigned"),
			},
		})
		if err != nil {
			return err
		}
		_, err = containerservice.NewKubernetesClusterExtension(ctx, "example", &containerservice.KubernetesClusterExtensionArgs{
			Name:          pulumi.String("example-ext"),
			ClusterId:     exampleKubernetesCluster.ID(),
			ExtensionType: pulumi.String("microsoft.flux"),
		})
		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 example = new Azure.Core.ResourceGroup("example", new()
    {
        Name = "example-resources",
        Location = "West Europe",
    });

    var exampleKubernetesCluster = new Azure.ContainerService.KubernetesCluster("example", new()
    {
        Name = "example-aks",
        Location = "West Europe",
        ResourceGroupName = example.Name,
        DnsPrefix = "example-aks",
        DefaultNodePool = new Azure.ContainerService.Inputs.KubernetesClusterDefaultNodePoolArgs
        {
            Name = "default",
            NodeCount = 1,
            VmSize = "Standard_DS2_v2",
        },
        Identity = new Azure.ContainerService.Inputs.KubernetesClusterIdentityArgs
        {
            Type = "SystemAssigned",
        },
    });

    var exampleKubernetesClusterExtension = new Azure.ContainerService.KubernetesClusterExtension("example", new()
    {
        Name = "example-ext",
        ClusterId = exampleKubernetesCluster.Id,
        ExtensionType = "microsoft.flux",
    });

});

    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.containerservice.KubernetesCluster;
import com.pulumi.azure.containerservice.KubernetesClusterArgs;
import com.pulumi.azure.containerservice.inputs.KubernetesClusterDefaultNodePoolArgs;
import com.pulumi.azure.containerservice.inputs.KubernetesClusterIdentityArgs;
import com.pulumi.azure.containerservice.KubernetesClusterExtension;
import com.pulumi.azure.containerservice.KubernetesClusterExtensionArgs;
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 example = new ResourceGroup("example", ResourceGroupArgs.builder()
            .name("example-resources")
            .location("West Europe")
            .build());

        var exampleKubernetesCluster = new KubernetesCluster("exampleKubernetesCluster", KubernetesClusterArgs.builder()
            .name("example-aks")
            .location("West Europe")
            .resourceGroupName(example.name())
            .dnsPrefix("example-aks")
            .defaultNodePool(KubernetesClusterDefaultNodePoolArgs.builder()
                .name("default")
                .nodeCount(1)
                .vmSize("Standard_DS2_v2")
                .build())
            .identity(KubernetesClusterIdentityArgs.builder()
                .type("SystemAssigned")
                .build())
            .build());

        var exampleKubernetesClusterExtension = new KubernetesClusterExtension("exampleKubernetesClusterExtension", KubernetesClusterExtensionArgs.builder()
            .name("example-ext")
            .clusterId(exampleKubernetesCluster.id())
            .extensionType("microsoft.flux")
            .build());

    }
}

    resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  exampleKubernetesCluster:
    type: azure:containerservice:KubernetesCluster
    name: example
    properties:
      name: example-aks
      location: West Europe
      resourceGroupName: ${example.name}
      dnsPrefix: example-aks
      defaultNodePool:
        name: default
        nodeCount: 1
        vmSize: Standard_DS2_v2
      identity:
        type: SystemAssigned
  exampleKubernetesClusterExtension:
    type: azure:containerservice:KubernetesClusterExtension
    name: example
    properties:
      name: example-ext
      clusterId: ${exampleKubernetesCluster.id}
      extensionType: microsoft.flux

    Create KubernetesClusterExtension Resource

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

    Constructor syntax

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

@overload
def KubernetesClusterExtension(resource_name: str,
                               opts: Optional[ResourceOptions] = None,
                               cluster_id: Optional[str] = None,
                               extension_type: Optional[str] = None,
                               configuration_protected_settings: Optional[Mapping[str, str]] = None,
                               configuration_settings: Optional[Mapping[str, str]] = None,
                               name: Optional[str] = None,
                               plan: Optional[KubernetesClusterExtensionPlanArgs] = None,
                               release_namespace: Optional[str] = None,
                               release_train: Optional[str] = None,
                               target_namespace: Optional[str] = None,
                               version: Optional[str] = None)
    func NewKubernetesClusterExtension(ctx *Context, name string, args KubernetesClusterExtensionArgs, opts ...ResourceOption) (*KubernetesClusterExtension, error)
    public KubernetesClusterExtension(string name, KubernetesClusterExtensionArgs args, CustomResourceOptions? opts = null)
    public KubernetesClusterExtension(String name, KubernetesClusterExtensionArgs args)
public KubernetesClusterExtension(String name, KubernetesClusterExtensionArgs args, CustomResourceOptions options)

    type: azure:containerservice:KubernetesClusterExtension
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 KubernetesClusterExtensionArgs
    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 KubernetesClusterExtensionArgs
    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 KubernetesClusterExtensionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args KubernetesClusterExtensionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args KubernetesClusterExtensionArgs
    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 kubernetesClusterExtensionResource = new Azure.ContainerService.KubernetesClusterExtension("kubernetesClusterExtensionResource", new()
{
    ClusterId = "string",
    ExtensionType = "string",
    ConfigurationProtectedSettings = 
    {
        { "string", "string" },
    },
    ConfigurationSettings = 
    {
        { "string", "string" },
    },
    Name = "string",
    Plan = new Azure.ContainerService.Inputs.KubernetesClusterExtensionPlanArgs
    {
        Name = "string",
        Product = "string",
        Publisher = "string",
        PromotionCode = "string",
        Version = "string",
    },
    ReleaseNamespace = "string",
    ReleaseTrain = "string",
    TargetNamespace = "string",
    Version = "string",
});

    example, err := containerservice.NewKubernetesClusterExtension(ctx, "kubernetesClusterExtensionResource", &containerservice.KubernetesClusterExtensionArgs{
	ClusterId:     pulumi.String("string"),
	ExtensionType: pulumi.String("string"),
	ConfigurationProtectedSettings: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	ConfigurationSettings: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Name: pulumi.String("string"),
	Plan: &containerservice.KubernetesClusterExtensionPlanArgs{
		Name:          pulumi.String("string"),
		Product:       pulumi.String("string"),
		Publisher:     pulumi.String("string"),
		PromotionCode: pulumi.String("string"),
		Version:       pulumi.String("string"),
	},
	ReleaseNamespace: pulumi.String("string"),
	ReleaseTrain:     pulumi.String("string"),
	TargetNamespace:  pulumi.String("string"),
	Version:          pulumi.String("string"),
})

    var kubernetesClusterExtensionResource = new KubernetesClusterExtension("kubernetesClusterExtensionResource", KubernetesClusterExtensionArgs.builder()
    .clusterId("string")
    .extensionType("string")
    .configurationProtectedSettings(Map.of("string", "string"))
    .configurationSettings(Map.of("string", "string"))
    .name("string")
    .plan(KubernetesClusterExtensionPlanArgs.builder()
        .name("string")
        .product("string")
        .publisher("string")
        .promotionCode("string")
        .version("string")
        .build())
    .releaseNamespace("string")
    .releaseTrain("string")
    .targetNamespace("string")
    .version("string")
    .build());

    kubernetes_cluster_extension_resource = azure.containerservice.KubernetesClusterExtension("kubernetesClusterExtensionResource",
    cluster_id="string",
    extension_type="string",
    configuration_protected_settings={
        "string": "string",
    },
    configuration_settings={
        "string": "string",
    },
    name="string",
    plan={
        "name": "string",
        "product": "string",
        "publisher": "string",
        "promotionCode": "string",
        "version": "string",
    },
    release_namespace="string",
    release_train="string",
    target_namespace="string",
    version="string")

    const kubernetesClusterExtensionResource = new azure.containerservice.KubernetesClusterExtension("kubernetesClusterExtensionResource", {
    clusterId: "string",
    extensionType: "string",
    configurationProtectedSettings: {
        string: "string",
    },
    configurationSettings: {
        string: "string",
    },
    name: "string",
    plan: {
        name: "string",
        product: "string",
        publisher: "string",
        promotionCode: "string",
        version: "string",
    },
    releaseNamespace: "string",
    releaseTrain: "string",
    targetNamespace: "string",
    version: "string",
});

    type: azure:containerservice:KubernetesClusterExtension
properties:
    clusterId: string
    configurationProtectedSettings:
        string: string
    configurationSettings:
        string: string
    extensionType: string
    name: string
    plan:
        name: string
        product: string
        promotionCode: string
        publisher: string
        version: string
    releaseNamespace: string
    releaseTrain: string
    targetNamespace: string
    version: string

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

    ClusterId string
    Specifies the Cluster ID. Changing this forces a new Kubernetes Cluster Extension to be created.
    ExtensionType string
    Specifies the type of extension. It must be one of the extension types registered with Microsoft.KubernetesConfiguration by the Extension publisher. For more information, please refer to Available Extensions for AKS. Changing this forces a new Kubernetes Cluster Extension to be created.
    ConfigurationProtectedSettings Dictionary<string, string>
    Configuration settings that are sensitive, as name-value pairs for configuring this extension.
    ConfigurationSettings Dictionary<string, string>
    Configuration settings, as name-value pairs for configuring this extension.
    Name string
    Specifies the name which should be used for this Kubernetes Cluster Extension. Changing this forces a new Kubernetes Cluster Extension to be created.
    Plan KubernetesClusterExtensionPlan
    A plan block as defined below. Changing this forces a new resource to be created.
    ReleaseNamespace string
    Namespace where the extension release must be placed for a cluster scoped extension. If this namespace does not exist, it will be created. Changing this forces a new Kubernetes Cluster Extension to be created.
    ReleaseTrain string
    The release train used by this extension. Possible values include but are not limited to Stable, Preview. Changing this forces a new Kubernetes Cluster Extension to be created.
    TargetNamespace string
    Namespace where the extension will be created for a namespace scoped extension. If this namespace does not exist, it will be created. Changing this forces a new Kubernetes Cluster Extension to be created.
    Version string
    User-specified version that the extension should pin to. If it is not set, Azure will use the latest version and auto upgrade it. Changing this forces a new Kubernetes Cluster Extension to be created.
    ClusterId string
    Specifies the Cluster ID. Changing this forces a new Kubernetes Cluster Extension to be created.
    ExtensionType string
    Specifies the type of extension. It must be one of the extension types registered with Microsoft.KubernetesConfiguration by the Extension publisher. For more information, please refer to Available Extensions for AKS. Changing this forces a new Kubernetes Cluster Extension to be created.
    ConfigurationProtectedSettings map[string]string
    Configuration settings that are sensitive, as name-value pairs for configuring this extension.
    ConfigurationSettings map[string]string
    Configuration settings, as name-value pairs for configuring this extension.
    Name string
    Specifies the name which should be used for this Kubernetes Cluster Extension. Changing this forces a new Kubernetes Cluster Extension to be created.
    Plan KubernetesClusterExtensionPlanArgs
    A plan block as defined below. Changing this forces a new resource to be created.
    ReleaseNamespace string
    Namespace where the extension release must be placed for a cluster scoped extension. If this namespace does not exist, it will be created. Changing this forces a new Kubernetes Cluster Extension to be created.
    ReleaseTrain string
    The release train used by this extension. Possible values include but are not limited to Stable, Preview. Changing this forces a new Kubernetes Cluster Extension to be created.
    TargetNamespace string
    Namespace where the extension will be created for a namespace scoped extension. If this namespace does not exist, it will be created. Changing this forces a new Kubernetes Cluster Extension to be created.
    Version string
    User-specified version that the extension should pin to. If it is not set, Azure will use the latest version and auto upgrade it. Changing this forces a new Kubernetes Cluster Extension to be created.
    clusterId String
    Specifies the Cluster ID. Changing this forces a new Kubernetes Cluster Extension to be created.
    extensionType String
    Specifies the type of extension. It must be one of the extension types registered with Microsoft.KubernetesConfiguration by the Extension publisher. For more information, please refer to Available Extensions for AKS. Changing this forces a new Kubernetes Cluster Extension to be created.
    configurationProtectedSettings Map<String,String>
    Configuration settings that are sensitive, as name-value pairs for configuring this extension.
    configurationSettings Map<String,String>
    Configuration settings, as name-value pairs for configuring this extension.
    name String
    Specifies the name which should be used for this Kubernetes Cluster Extension. Changing this forces a new Kubernetes Cluster Extension to be created.
    plan KubernetesClusterExtensionPlan
    A plan block as defined below. Changing this forces a new resource to be created.
    releaseNamespace String
    Namespace where the extension release must be placed for a cluster scoped extension. If this namespace does not exist, it will be created. Changing this forces a new Kubernetes Cluster Extension to be created.
    releaseTrain String
    The release train used by this extension. Possible values include but are not limited to Stable, Preview. Changing this forces a new Kubernetes Cluster Extension to be created.
    targetNamespace String
    Namespace where the extension will be created for a namespace scoped extension. If this namespace does not exist, it will be created. Changing this forces a new Kubernetes Cluster Extension to be created.
    version String
    User-specified version that the extension should pin to. If it is not set, Azure will use the latest version and auto upgrade it. Changing this forces a new Kubernetes Cluster Extension to be created.
    clusterId string
    Specifies the Cluster ID. Changing this forces a new Kubernetes Cluster Extension to be created.
    extensionType string
    Specifies the type of extension. It must be one of the extension types registered with Microsoft.KubernetesConfiguration by the Extension publisher. For more information, please refer to Available Extensions for AKS. Changing this forces a new Kubernetes Cluster Extension to be created.
    configurationProtectedSettings {[key: string]: string}
    Configuration settings that are sensitive, as name-value pairs for configuring this extension.
    configurationSettings {[key: string]: string}
    Configuration settings, as name-value pairs for configuring this extension.
    name string
    Specifies the name which should be used for this Kubernetes Cluster Extension. Changing this forces a new Kubernetes Cluster Extension to be created.
    plan KubernetesClusterExtensionPlan
    A plan block as defined below. Changing this forces a new resource to be created.
    releaseNamespace string
    Namespace where the extension release must be placed for a cluster scoped extension. If this namespace does not exist, it will be created. Changing this forces a new Kubernetes Cluster Extension to be created.
    releaseTrain string
    The release train used by this extension. Possible values include but are not limited to Stable, Preview. Changing this forces a new Kubernetes Cluster Extension to be created.
    targetNamespace string
    Namespace where the extension will be created for a namespace scoped extension. If this namespace does not exist, it will be created. Changing this forces a new Kubernetes Cluster Extension to be created.
    version string
    User-specified version that the extension should pin to. If it is not set, Azure will use the latest version and auto upgrade it. Changing this forces a new Kubernetes Cluster Extension to be created.
    cluster_id str
    Specifies the Cluster ID. Changing this forces a new Kubernetes Cluster Extension to be created.
    extension_type str
    Specifies the type of extension. It must be one of the extension types registered with Microsoft.KubernetesConfiguration by the Extension publisher. For more information, please refer to Available Extensions for AKS. Changing this forces a new Kubernetes Cluster Extension to be created.
    configuration_protected_settings Mapping[str, str]
    Configuration settings that are sensitive, as name-value pairs for configuring this extension.
    configuration_settings Mapping[str, str]
    Configuration settings, as name-value pairs for configuring this extension.
    name str
    Specifies the name which should be used for this Kubernetes Cluster Extension. Changing this forces a new Kubernetes Cluster Extension to be created.
    plan KubernetesClusterExtensionPlanArgs
    A plan block as defined below. Changing this forces a new resource to be created.
    release_namespace str
    Namespace where the extension release must be placed for a cluster scoped extension. If this namespace does not exist, it will be created. Changing this forces a new Kubernetes Cluster Extension to be created.
    release_train str
    The release train used by this extension. Possible values include but are not limited to Stable, Preview. Changing this forces a new Kubernetes Cluster Extension to be created.
    target_namespace str
    Namespace where the extension will be created for a namespace scoped extension. If this namespace does not exist, it will be created. Changing this forces a new Kubernetes Cluster Extension to be created.
    version str
    User-specified version that the extension should pin to. If it is not set, Azure will use the latest version and auto upgrade it. Changing this forces a new Kubernetes Cluster Extension to be created.
    clusterId String
    Specifies the Cluster ID. Changing this forces a new Kubernetes Cluster Extension to be created.
    extensionType String
    Specifies the type of extension. It must be one of the extension types registered with Microsoft.KubernetesConfiguration by the Extension publisher. For more information, please refer to Available Extensions for AKS. Changing this forces a new Kubernetes Cluster Extension to be created.
    configurationProtectedSettings Map<String>
    Configuration settings that are sensitive, as name-value pairs for configuring this extension.
    configurationSettings Map<String>
    Configuration settings, as name-value pairs for configuring this extension.
    name String
    Specifies the name which should be used for this Kubernetes Cluster Extension. Changing this forces a new Kubernetes Cluster Extension to be created.
    plan Property Map
    A plan block as defined below. Changing this forces a new resource to be created.
    releaseNamespace String
    Namespace where the extension release must be placed for a cluster scoped extension. If this namespace does not exist, it will be created. Changing this forces a new Kubernetes Cluster Extension to be created.
    releaseTrain String
    The release train used by this extension. Possible values include but are not limited to Stable, Preview. Changing this forces a new Kubernetes Cluster Extension to be created.
    targetNamespace String
    Namespace where the extension will be created for a namespace scoped extension. If this namespace does not exist, it will be created. Changing this forces a new Kubernetes Cluster Extension to be created.
    version String
    User-specified version that the extension should pin to. If it is not set, Azure will use the latest version and auto upgrade it. Changing this forces a new Kubernetes Cluster Extension to be created.

    Outputs

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

    AksAssignedIdentities List<KubernetesClusterExtensionAksAssignedIdentity>
    An aks_assigned_identity block as defined below.
    CurrentVersion string
    The current version of the extension.
    Id string
    The provider-assigned unique ID for this managed resource.
    AksAssignedIdentities []KubernetesClusterExtensionAksAssignedIdentity
    An aks_assigned_identity block as defined below.
    CurrentVersion string
    The current version of the extension.
    Id string
    The provider-assigned unique ID for this managed resource.
    aksAssignedIdentities List<KubernetesClusterExtensionAksAssignedIdentity>
    An aks_assigned_identity block as defined below.
    currentVersion String
    The current version of the extension.
    id String
    The provider-assigned unique ID for this managed resource.
    aksAssignedIdentities KubernetesClusterExtensionAksAssignedIdentity[]
    An aks_assigned_identity block as defined below.
    currentVersion string
    The current version of the extension.
    id string
    The provider-assigned unique ID for this managed resource.
    aks_assigned_identities Sequence[KubernetesClusterExtensionAksAssignedIdentity]
    An aks_assigned_identity block as defined below.
    current_version str
    The current version of the extension.
    id str
    The provider-assigned unique ID for this managed resource.
    aksAssignedIdentities List<Property Map>
    An aks_assigned_identity block as defined below.
    currentVersion String
    The current version of the extension.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing KubernetesClusterExtension Resource

    Get an existing KubernetesClusterExtension 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?: KubernetesClusterExtensionState, opts?: CustomResourceOptions): KubernetesClusterExtension
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        aks_assigned_identities: Optional[Sequence[KubernetesClusterExtensionAksAssignedIdentityArgs]] = None,
        cluster_id: Optional[str] = None,
        configuration_protected_settings: Optional[Mapping[str, str]] = None,
        configuration_settings: Optional[Mapping[str, str]] = None,
        current_version: Optional[str] = None,
        extension_type: Optional[str] = None,
        name: Optional[str] = None,
        plan: Optional[KubernetesClusterExtensionPlanArgs] = None,
        release_namespace: Optional[str] = None,
        release_train: Optional[str] = None,
        target_namespace: Optional[str] = None,
        version: Optional[str] = None) -> KubernetesClusterExtension
    func GetKubernetesClusterExtension(ctx *Context, name string, id IDInput, state *KubernetesClusterExtensionState, opts ...ResourceOption) (*KubernetesClusterExtension, error)
    public static KubernetesClusterExtension Get(string name, Input<string> id, KubernetesClusterExtensionState? state, CustomResourceOptions? opts = null)
    public static KubernetesClusterExtension get(String name, Output<String> id, KubernetesClusterExtensionState 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:
    AksAssignedIdentities List<KubernetesClusterExtensionAksAssignedIdentity>
    An aks_assigned_identity block as defined below.
    ClusterId string
    Specifies the Cluster ID. Changing this forces a new Kubernetes Cluster Extension to be created.
    ConfigurationProtectedSettings Dictionary<string, string>
    Configuration settings that are sensitive, as name-value pairs for configuring this extension.
    ConfigurationSettings Dictionary<string, string>
    Configuration settings, as name-value pairs for configuring this extension.
    CurrentVersion string
    The current version of the extension.
    ExtensionType string
    Specifies the type of extension. It must be one of the extension types registered with Microsoft.KubernetesConfiguration by the Extension publisher. For more information, please refer to Available Extensions for AKS. Changing this forces a new Kubernetes Cluster Extension to be created.
    Name string
    Specifies the name which should be used for this Kubernetes Cluster Extension. Changing this forces a new Kubernetes Cluster Extension to be created.
    Plan KubernetesClusterExtensionPlan
    A plan block as defined below. Changing this forces a new resource to be created.
    ReleaseNamespace string
    Namespace where the extension release must be placed for a cluster scoped extension. If this namespace does not exist, it will be created. Changing this forces a new Kubernetes Cluster Extension to be created.
    ReleaseTrain string
    The release train used by this extension. Possible values include but are not limited to Stable, Preview. Changing this forces a new Kubernetes Cluster Extension to be created.
    TargetNamespace string
    Namespace where the extension will be created for a namespace scoped extension. If this namespace does not exist, it will be created. Changing this forces a new Kubernetes Cluster Extension to be created.
    Version string
    User-specified version that the extension should pin to. If it is not set, Azure will use the latest version and auto upgrade it. Changing this forces a new Kubernetes Cluster Extension to be created.
    AksAssignedIdentities []KubernetesClusterExtensionAksAssignedIdentityArgs
    An aks_assigned_identity block as defined below.
    ClusterId string
    Specifies the Cluster ID. Changing this forces a new Kubernetes Cluster Extension to be created.
    ConfigurationProtectedSettings map[string]string
    Configuration settings that are sensitive, as name-value pairs for configuring this extension.
    ConfigurationSettings map[string]string
    Configuration settings, as name-value pairs for configuring this extension.
    CurrentVersion string
    The current version of the extension.
    ExtensionType string
    Specifies the type of extension. It must be one of the extension types registered with Microsoft.KubernetesConfiguration by the Extension publisher. For more information, please refer to Available Extensions for AKS. Changing this forces a new Kubernetes Cluster Extension to be created.
    Name string
    Specifies the name which should be used for this Kubernetes Cluster Extension. Changing this forces a new Kubernetes Cluster Extension to be created.
    Plan KubernetesClusterExtensionPlanArgs
    A plan block as defined below. Changing this forces a new resource to be created.
    ReleaseNamespace string
    Namespace where the extension release must be placed for a cluster scoped extension. If this namespace does not exist, it will be created. Changing this forces a new Kubernetes Cluster Extension to be created.
    ReleaseTrain string
    The release train used by this extension. Possible values include but are not limited to Stable, Preview. Changing this forces a new Kubernetes Cluster Extension to be created.
    TargetNamespace string
    Namespace where the extension will be created for a namespace scoped extension. If this namespace does not exist, it will be created. Changing this forces a new Kubernetes Cluster Extension to be created.
    Version string
    User-specified version that the extension should pin to. If it is not set, Azure will use the latest version and auto upgrade it. Changing this forces a new Kubernetes Cluster Extension to be created.
    aksAssignedIdentities List<KubernetesClusterExtensionAksAssignedIdentity>
    An aks_assigned_identity block as defined below.
    clusterId String
    Specifies the Cluster ID. Changing this forces a new Kubernetes Cluster Extension to be created.
    configurationProtectedSettings Map<String,String>
    Configuration settings that are sensitive, as name-value pairs for configuring this extension.
    configurationSettings Map<String,String>
    Configuration settings, as name-value pairs for configuring this extension.
    currentVersion String
    The current version of the extension.
    extensionType String
    Specifies the type of extension. It must be one of the extension types registered with Microsoft.KubernetesConfiguration by the Extension publisher. For more information, please refer to Available Extensions for AKS. Changing this forces a new Kubernetes Cluster Extension to be created.
    name String
    Specifies the name which should be used for this Kubernetes Cluster Extension. Changing this forces a new Kubernetes Cluster Extension to be created.
    plan KubernetesClusterExtensionPlan
    A plan block as defined below. Changing this forces a new resource to be created.
    releaseNamespace String
    Namespace where the extension release must be placed for a cluster scoped extension. If this namespace does not exist, it will be created. Changing this forces a new Kubernetes Cluster Extension to be created.
    releaseTrain String
    The release train used by this extension. Possible values include but are not limited to Stable, Preview. Changing this forces a new Kubernetes Cluster Extension to be created.
    targetNamespace String
    Namespace where the extension will be created for a namespace scoped extension. If this namespace does not exist, it will be created. Changing this forces a new Kubernetes Cluster Extension to be created.
    version String
    User-specified version that the extension should pin to. If it is not set, Azure will use the latest version and auto upgrade it. Changing this forces a new Kubernetes Cluster Extension to be created.
    aksAssignedIdentities KubernetesClusterExtensionAksAssignedIdentity[]
    An aks_assigned_identity block as defined below.
    clusterId string
    Specifies the Cluster ID. Changing this forces a new Kubernetes Cluster Extension to be created.
    configurationProtectedSettings {[key: string]: string}
    Configuration settings that are sensitive, as name-value pairs for configuring this extension.
    configurationSettings {[key: string]: string}
    Configuration settings, as name-value pairs for configuring this extension.
    currentVersion string
    The current version of the extension.
    extensionType string
    Specifies the type of extension. It must be one of the extension types registered with Microsoft.KubernetesConfiguration by the Extension publisher. For more information, please refer to Available Extensions for AKS. Changing this forces a new Kubernetes Cluster Extension to be created.
    name string
    Specifies the name which should be used for this Kubernetes Cluster Extension. Changing this forces a new Kubernetes Cluster Extension to be created.
    plan KubernetesClusterExtensionPlan
    A plan block as defined below. Changing this forces a new resource to be created.
    releaseNamespace string
    Namespace where the extension release must be placed for a cluster scoped extension. If this namespace does not exist, it will be created. Changing this forces a new Kubernetes Cluster Extension to be created.
    releaseTrain string
    The release train used by this extension. Possible values include but are not limited to Stable, Preview. Changing this forces a new Kubernetes Cluster Extension to be created.
    targetNamespace string
    Namespace where the extension will be created for a namespace scoped extension. If this namespace does not exist, it will be created. Changing this forces a new Kubernetes Cluster Extension to be created.
    version string
    User-specified version that the extension should pin to. If it is not set, Azure will use the latest version and auto upgrade it. Changing this forces a new Kubernetes Cluster Extension to be created.
    aks_assigned_identities Sequence[KubernetesClusterExtensionAksAssignedIdentityArgs]
    An aks_assigned_identity block as defined below.
    cluster_id str
    Specifies the Cluster ID. Changing this forces a new Kubernetes Cluster Extension to be created.
    configuration_protected_settings Mapping[str, str]
    Configuration settings that are sensitive, as name-value pairs for configuring this extension.
    configuration_settings Mapping[str, str]
    Configuration settings, as name-value pairs for configuring this extension.
    current_version str
    The current version of the extension.
    extension_type str
    Specifies the type of extension. It must be one of the extension types registered with Microsoft.KubernetesConfiguration by the Extension publisher. For more information, please refer to Available Extensions for AKS. Changing this forces a new Kubernetes Cluster Extension to be created.
    name str
    Specifies the name which should be used for this Kubernetes Cluster Extension. Changing this forces a new Kubernetes Cluster Extension to be created.
    plan KubernetesClusterExtensionPlanArgs
    A plan block as defined below. Changing this forces a new resource to be created.
    release_namespace str
    Namespace where the extension release must be placed for a cluster scoped extension. If this namespace does not exist, it will be created. Changing this forces a new Kubernetes Cluster Extension to be created.
    release_train str
    The release train used by this extension. Possible values include but are not limited to Stable, Preview. Changing this forces a new Kubernetes Cluster Extension to be created.
    target_namespace str
    Namespace where the extension will be created for a namespace scoped extension. If this namespace does not exist, it will be created. Changing this forces a new Kubernetes Cluster Extension to be created.
    version str
    User-specified version that the extension should pin to. If it is not set, Azure will use the latest version and auto upgrade it. Changing this forces a new Kubernetes Cluster Extension to be created.
    aksAssignedIdentities List<Property Map>
    An aks_assigned_identity block as defined below.
    clusterId String
    Specifies the Cluster ID. Changing this forces a new Kubernetes Cluster Extension to be created.
    configurationProtectedSettings Map<String>
    Configuration settings that are sensitive, as name-value pairs for configuring this extension.
    configurationSettings Map<String>
    Configuration settings, as name-value pairs for configuring this extension.
    currentVersion String
    The current version of the extension.
    extensionType String
    Specifies the type of extension. It must be one of the extension types registered with Microsoft.KubernetesConfiguration by the Extension publisher. For more information, please refer to Available Extensions for AKS. Changing this forces a new Kubernetes Cluster Extension to be created.
    name String
    Specifies the name which should be used for this Kubernetes Cluster Extension. Changing this forces a new Kubernetes Cluster Extension to be created.
    plan Property Map
    A plan block as defined below. Changing this forces a new resource to be created.
    releaseNamespace String
    Namespace where the extension release must be placed for a cluster scoped extension. If this namespace does not exist, it will be created. Changing this forces a new Kubernetes Cluster Extension to be created.
    releaseTrain String
    The release train used by this extension. Possible values include but are not limited to Stable, Preview. Changing this forces a new Kubernetes Cluster Extension to be created.
    targetNamespace String
    Namespace where the extension will be created for a namespace scoped extension. If this namespace does not exist, it will be created. Changing this forces a new Kubernetes Cluster Extension to be created.
    version String
    User-specified version that the extension should pin to. If it is not set, Azure will use the latest version and auto upgrade it. Changing this forces a new Kubernetes Cluster Extension to be created.

    Supporting Types

    KubernetesClusterExtensionAksAssignedIdentity, KubernetesClusterExtensionAksAssignedIdentityArgs

    PrincipalId string
    The principal ID of resource identity.
    TenantId string
    The tenant ID of resource.
    Type string
    The identity type.
    PrincipalId string
    The principal ID of resource identity.
    TenantId string
    The tenant ID of resource.
    Type string
    The identity type.
    principalId String
    The principal ID of resource identity.
    tenantId String
    The tenant ID of resource.
    type String
    The identity type.
    principalId string
    The principal ID of resource identity.
    tenantId string
    The tenant ID of resource.
    type string
    The identity type.
    principal_id str
    The principal ID of resource identity.
    tenant_id str
    The tenant ID of resource.
    type str
    The identity type.
    principalId String
    The principal ID of resource identity.
    tenantId String
    The tenant ID of resource.
    type String
    The identity type.

    KubernetesClusterExtensionPlan, KubernetesClusterExtensionPlanArgs

    Name string
    Specifies the name of the plan from the marketplace. Changing this forces a new Kubernetes Cluster Extension to be created.
    Product string
    Specifies the product of the plan from the marketplace. Changing this forces a new Kubernetes Cluster Extension to be created.
    Publisher string
    Specifies the publisher of the plan. Changing this forces a new Kubernetes Cluster Extension to be created.
    PromotionCode string
    Specifies the promotion code to use with the plan. Changing this forces a new Kubernetes Cluster Extension to be created.
    Version string

    Specifies the version of the plan from the marketplace. Changing this forces a new Kubernetes Cluster Extension to be created.

    NOTE: When plan is specified, legal terms must be accepted for this item on this subscription before creating the Kubernetes Cluster Extension. The azure.marketplace.Agreement resource or AZ CLI tool can be used to do this.

    Name string
    Specifies the name of the plan from the marketplace. Changing this forces a new Kubernetes Cluster Extension to be created.
    Product string
    Specifies the product of the plan from the marketplace. Changing this forces a new Kubernetes Cluster Extension to be created.
    Publisher string
    Specifies the publisher of the plan. Changing this forces a new Kubernetes Cluster Extension to be created.
    PromotionCode string
    Specifies the promotion code to use with the plan. Changing this forces a new Kubernetes Cluster Extension to be created.
    Version string

    Specifies the version of the plan from the marketplace. Changing this forces a new Kubernetes Cluster Extension to be created.

    NOTE: When plan is specified, legal terms must be accepted for this item on this subscription before creating the Kubernetes Cluster Extension. The azure.marketplace.Agreement resource or AZ CLI tool can be used to do this.

    name String
    Specifies the name of the plan from the marketplace. Changing this forces a new Kubernetes Cluster Extension to be created.
    product String
    Specifies the product of the plan from the marketplace. Changing this forces a new Kubernetes Cluster Extension to be created.
    publisher String
    Specifies the publisher of the plan. Changing this forces a new Kubernetes Cluster Extension to be created.
    promotionCode String
    Specifies the promotion code to use with the plan. Changing this forces a new Kubernetes Cluster Extension to be created.
    version String

    Specifies the version of the plan from the marketplace. Changing this forces a new Kubernetes Cluster Extension to be created.

    NOTE: When plan is specified, legal terms must be accepted for this item on this subscription before creating the Kubernetes Cluster Extension. The azure.marketplace.Agreement resource or AZ CLI tool can be used to do this.

    name string
    Specifies the name of the plan from the marketplace. Changing this forces a new Kubernetes Cluster Extension to be created.
    product string
    Specifies the product of the plan from the marketplace. Changing this forces a new Kubernetes Cluster Extension to be created.
    publisher string
    Specifies the publisher of the plan. Changing this forces a new Kubernetes Cluster Extension to be created.
    promotionCode string
    Specifies the promotion code to use with the plan. Changing this forces a new Kubernetes Cluster Extension to be created.
    version string

    Specifies the version of the plan from the marketplace. Changing this forces a new Kubernetes Cluster Extension to be created.

    NOTE: When plan is specified, legal terms must be accepted for this item on this subscription before creating the Kubernetes Cluster Extension. The azure.marketplace.Agreement resource or AZ CLI tool can be used to do this.

    name str
    Specifies the name of the plan from the marketplace. Changing this forces a new Kubernetes Cluster Extension to be created.
    product str
    Specifies the product of the plan from the marketplace. Changing this forces a new Kubernetes Cluster Extension to be created.
    publisher str
    Specifies the publisher of the plan. Changing this forces a new Kubernetes Cluster Extension to be created.
    promotion_code str
    Specifies the promotion code to use with the plan. Changing this forces a new Kubernetes Cluster Extension to be created.
    version str

    Specifies the version of the plan from the marketplace. Changing this forces a new Kubernetes Cluster Extension to be created.

    NOTE: When plan is specified, legal terms must be accepted for this item on this subscription before creating the Kubernetes Cluster Extension. The azure.marketplace.Agreement resource or AZ CLI tool can be used to do this.

    name String
    Specifies the name of the plan from the marketplace. Changing this forces a new Kubernetes Cluster Extension to be created.
    product String
    Specifies the product of the plan from the marketplace. Changing this forces a new Kubernetes Cluster Extension to be created.
    publisher String
    Specifies the publisher of the plan. Changing this forces a new Kubernetes Cluster Extension to be created.
    promotionCode String
    Specifies the promotion code to use with the plan. Changing this forces a new Kubernetes Cluster Extension to be created.
    version String

    Specifies the version of the plan from the marketplace. Changing this forces a new Kubernetes Cluster Extension to be created.

    NOTE: When plan is specified, legal terms must be accepted for this item on this subscription before creating the Kubernetes Cluster Extension. The azure.marketplace.Agreement resource or AZ CLI tool can be used to do this.

    Import

    Kubernetes Cluster Extension can be imported using the resource id for different cluster_resource_name, e.g.

    $ pulumi import azure:containerservice/kubernetesClusterExtension:KubernetesClusterExtension example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup1/providers/Microsoft.ContainerService/managedClusters/cluster1/providers/Microsoft.KubernetesConfiguration/extensions/extension1

    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 v6.2.0 published on Friday, Sep 27, 2024 by Pulumi
    pulumi/pulumi-azure