Class KubernetesCluster

Manages a Managed Kubernetes Cluster (also known as AKS / Azure Kubernetes Service)

Inheritance

System.Object

Resource

CustomResource

KubernetesCluster

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Azure.ContainerService

Assembly: Pulumi.Azure.dll

Syntax

public class KubernetesCluster : CustomResource

Constructors

View Source

KubernetesCluster(String, KubernetesClusterArgs, CustomResourceOptions)

Create a KubernetesCluster resource with the given unique name, arguments, and options.

Declaration

public KubernetesCluster(string name, KubernetesClusterArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
KubernetesClusterArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

View Source

AddonProfile

A addon_profile block as defined below.

Declaration

public Output<KubernetesClusterAddonProfile> AddonProfile { get; }

Property Value

Type	Description
Output<KubernetesClusterAddonProfile>

View Source

ApiServerAuthorizedIpRanges

The IP ranges to whitelist for incoming traffic to the masters.

Declaration

public Output<ImmutableArray<string>> ApiServerAuthorizedIpRanges { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

View Source

DefaultNodePool

A default_node_pool block as defined below.

Declaration

public Output<KubernetesClusterDefaultNodePool> DefaultNodePool { get; }

Property Value

Type	Description
Output<KubernetesClusterDefaultNodePool>

View Source

DnsPrefix

DNS prefix specified when creating the managed cluster. Changing this forces a new resource to be created.

Declaration

public Output<string> DnsPrefix { get; }

Property Value

Type	Description
Output<System.String>

View Source

EnablePodSecurityPolicy

Whether Pod Security Policies are enabled. Note that this also requires role based access control to be enabled.

Declaration

public Output<bool?> EnablePodSecurityPolicy { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

View Source

Fqdn

The FQDN of the Azure Kubernetes Managed Cluster.

Declaration

public Output<string> Fqdn { get; }

Property Value

Type	Description
Output<System.String>

View Source

Identity

A identity block as defined below. Changing this forces a new resource to be created.

Declaration

public Output<KubernetesClusterIdentity> Identity { get; }

Property Value

Type	Description
Output<KubernetesClusterIdentity>

View Source

KubeAdminConfigRaw

Raw Kubernetes config for the admin account to be used by kubectl and other compatible tools. This is only available when Role Based Access Control with Azure Active Directory is enabled.

Declaration

public Output<string> KubeAdminConfigRaw { get; }

Property Value

Type	Description
Output<System.String>

View Source

KubeAdminConfigs

A kube_admin_config block as defined below. This is only available when Role Based Access Control with Azure Active Directory is enabled.

Declaration

public Output<ImmutableArray<KubernetesClusterKubeAdminConfig>> KubeAdminConfigs { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<KubernetesClusterKubeAdminConfig>>

View Source

KubeConfigRaw

Raw Kubernetes config to be used by kubectl and other compatible tools

Declaration

public Output<string> KubeConfigRaw { get; }

Property Value

Type	Description
Output<System.String>

View Source

KubeConfigs

A kube_config block as defined below.

Declaration

public Output<ImmutableArray<KubernetesClusterKubeConfig>> KubeConfigs { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<KubernetesClusterKubeConfig>>

View Source

KubeletIdentities

A kubelet_identity block as defined below.

Declaration

public Output<ImmutableArray<KubernetesClusterKubeletIdentity>> KubeletIdentities { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<KubernetesClusterKubeletIdentity>>

View Source

KubernetesVersion

Version of Kubernetes specified when creating the AKS managed cluster. If not specified, the latest recommended version will be used at provisioning time (but won't auto-upgrade).

Declaration

public Output<string> KubernetesVersion { get; }

Property Value

Type	Description
Output<System.String>

View Source

LinuxProfile

A linux_profile block as defined below.

Declaration

public Output<KubernetesClusterLinuxProfile> LinuxProfile { get; }

Property Value

Type	Description
Output<KubernetesClusterLinuxProfile>

View Source

Location

The location where the Managed Kubernetes Cluster should be created. Changing this forces a new resource to be created.

Declaration

public Output<string> Location { get; }

Property Value

Type	Description
Output<System.String>

View Source

Name

The name of the Managed Kubernetes Cluster to create. Changing this forces a new resource to be created.

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

View Source

NetworkProfile

A network_profile block as defined below.

Declaration

public Output<KubernetesClusterNetworkProfile> NetworkProfile { get; }

Property Value

Type	Description
Output<KubernetesClusterNetworkProfile>

View Source

NodeResourceGroup

The name of the Resource Group where the Kubernetes Nodes should exist. Changing this forces a new resource to be created.

Declaration

public Output<string> NodeResourceGroup { get; }

Property Value

Type	Description
Output<System.String>

View Source

PrivateClusterEnabled

Should this Kubernetes Cluster have it's API server only exposed on internal IP addresses? This provides a Private IP Address for the Kubernetes API on the Virtual Network where the Kubernetes Cluster is located. Defaults to false. Changing this forces a new resource to be created.

Declaration

public Output<bool> PrivateClusterEnabled { get; }

Property Value

Type	Description
Output<System.Boolean>

View Source

PrivateFqdn

The FQDN for the Kubernetes Cluster when private link has been enabled, which is only resolvable inside the Virtual Network used by the Kubernetes Cluster.

Declaration

public Output<string> PrivateFqdn { get; }

Property Value

Type	Description
Output<System.String>

View Source

PrivateLinkEnabled

Declaration

public Output<bool> PrivateLinkEnabled { get; }

Property Value

Type	Description
Output<System.Boolean>

View Source

ResourceGroupName

Specifies the Resource Group where the Managed Kubernetes Cluster should exist. Changing this forces a new resource to be created.

Declaration

public Output<string> ResourceGroupName { get; }

Property Value

Type	Description
Output<System.String>

View Source

RoleBasedAccessControl

A role_based_access_control block. Changing this forces a new resource to be created.

Declaration

public Output<KubernetesClusterRoleBasedAccessControl> RoleBasedAccessControl { get; }

Property Value

Type	Description
Output<KubernetesClusterRoleBasedAccessControl>

View Source

ServicePrincipal

A service_principal block as documented below.

Declaration

public Output<KubernetesClusterServicePrincipal> ServicePrincipal { get; }

Property Value

Type	Description
Output<KubernetesClusterServicePrincipal>

View Source

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.String>>

WindowsProfile

A windows_profile block as defined below.

Declaration

public Output<KubernetesClusterWindowsProfile> WindowsProfile { get; }

Property Value

Type	Description
Output<KubernetesClusterWindowsProfile>

Methods

View Source

Get(String, Input<String>, KubernetesClusterState, CustomResourceOptions)

Get an existing KubernetesCluster resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration

public static KubernetesCluster Get(string name, Input<string> id, KubernetesClusterState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
KubernetesClusterState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
KubernetesCluster