Welcome to Pulumi Registry, your window into the cloud. Read the announcement.

Azure Classic

v4.28.0 published on Monday, Nov 22, 2021 by Pulumi

getKubernetesCluster

Use this data source to access information about an existing Managed Kubernetes Cluster (AKS).

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var example = Output.Create(Azure.ContainerService.GetKubernetesCluster.InvokeAsync(new Azure.ContainerService.GetKubernetesClusterArgs
        {
            Name = "myakscluster",
            ResourceGroupName = "my-example-resource-group",
        }));
    }

}
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := containerservice.LookupKubernetesCluster(ctx, &containerservice.LookupKubernetesClusterArgs{
			Name:              "myakscluster",
			ResourceGroupName: "my-example-resource-group",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
import pulumi
import pulumi_azure as azure

example = azure.containerservice.get_kubernetes_cluster(name="myakscluster",
    resource_group_name="my-example-resource-group")
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = pulumi.output(azure.containerservice.getKubernetesCluster({
    name: "myakscluster",
    resourceGroupName: "my-example-resource-group",
}));

Using getKubernetesCluster

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getKubernetesCluster(args: GetKubernetesClusterArgs, opts?: InvokeOptions): Promise<GetKubernetesClusterResult>
function getKubernetesClusterOutput(args: GetKubernetesClusterOutputArgs, opts?: InvokeOptions): Output<GetKubernetesClusterResult>
def get_kubernetes_cluster(name: Optional[str] = None,
                           resource_group_name: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetKubernetesClusterResult
def get_kubernetes_cluster_output(name: Optional[pulumi.Input[str]] = None,
                           resource_group_name: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetKubernetesClusterResult]
func LookupKubernetesCluster(ctx *Context, args *LookupKubernetesClusterArgs, opts ...InvokeOption) (*LookupKubernetesClusterResult, error)
func LookupKubernetesClusterOutput(ctx *Context, args *LookupKubernetesClusterOutputArgs, opts ...InvokeOption) LookupKubernetesClusterResultOutput

> Note: This function is named LookupKubernetesCluster in the Go SDK.

public static class GetKubernetesCluster 
{
    public static Task<GetKubernetesClusterResult> InvokeAsync(GetKubernetesClusterArgs args, InvokeOptions? opts = null)
    public static Output<GetKubernetesClusterResult> Invoke(GetKubernetesClusterInvokeArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

Name string
The name of the managed Kubernetes Cluster.
ResourceGroupName string
The name of the Resource Group in which the managed Kubernetes Cluster exists.
Name string
The name of the managed Kubernetes Cluster.
ResourceGroupName string
The name of the Resource Group in which the managed Kubernetes Cluster exists.
name string
The name of the managed Kubernetes Cluster.
resourceGroupName string
The name of the Resource Group in which the managed Kubernetes Cluster exists.
name str
The name of the managed Kubernetes Cluster.
resource_group_name str
The name of the Resource Group in which the managed Kubernetes Cluster exists.

getKubernetesCluster Result

The following output properties are available:

AddonProfiles List<GetKubernetesClusterAddonProfile>
A addon_profile block as documented below.
AgentPoolProfiles List<GetKubernetesClusterAgentPoolProfile>
An agent_pool_profile block as documented below.
ApiServerAuthorizedIpRanges List<string>
The IP ranges to whitelist for incoming traffic to the primaries.
DiskEncryptionSetId string
The ID of the Disk Encryption Set used for the Nodes and Volumes.
DnsPrefix string
The DNS Prefix of the managed Kubernetes cluster.
Fqdn string
The FQDN of the Azure Kubernetes Managed Cluster.
Id string
The provider-assigned unique ID for this managed resource.
Identities List<GetKubernetesClusterIdentity>
A identity block as documented below.
KubeAdminConfigRaw string
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 and local accounts are not disabled.
KubeAdminConfigs List<GetKubernetesClusterKubeAdminConfig>
A kube_admin_config block as defined below. This is only available when Role Based Access Control with Azure Active Directory is enabled and local accounts are not disabled.
KubeConfigRaw string
Base64 encoded Kubernetes configuration.
KubeConfigs List<GetKubernetesClusterKubeConfig>
A kube_config block as defined below.
KubeletIdentities List<GetKubernetesClusterKubeletIdentity>
A kubelet_identity block as documented below.
KubernetesVersion string
The version of Kubernetes used on the managed Kubernetes Cluster.
LinuxProfiles List<GetKubernetesClusterLinuxProfile>
A linux_profile block as documented below.
Location string
The Azure Region in which the managed Kubernetes Cluster exists.
Name string
The name assigned to this pool of agents.
NetworkProfiles List<GetKubernetesClusterNetworkProfile>
A network_profile block as documented below.
NodeResourceGroup string
Auto-generated Resource Group containing AKS Cluster resources.
PrivateClusterEnabled bool
If the cluster has the Kubernetes API only exposed on internal IP addresses.
PrivateFqdn string
The FQDN of this Kubernetes Cluster when private link has been enabled. This name is only resolvable inside the Virtual Network where the Azure Kubernetes Service is located
PrivateLinkEnabled bool
ResourceGroupName string
RoleBasedAccessControls List<GetKubernetesClusterRoleBasedAccessControl>
A role_based_access_control block as documented below.
ServicePrincipals List<GetKubernetesClusterServicePrincipal>
A service_principal block as documented below.
Tags Dictionary<string, string>
A mapping of tags to assign to the resource.
WindowsProfiles List<GetKubernetesClusterWindowsProfile>
A windows_profile block as documented below.
AddonProfiles []GetKubernetesClusterAddonProfile
A addon_profile block as documented below.
AgentPoolProfiles []GetKubernetesClusterAgentPoolProfile
An agent_pool_profile block as documented below.
ApiServerAuthorizedIpRanges []string
The IP ranges to whitelist for incoming traffic to the primaries.
DiskEncryptionSetId string
The ID of the Disk Encryption Set used for the Nodes and Volumes.
DnsPrefix string
The DNS Prefix of the managed Kubernetes cluster.
Fqdn string
The FQDN of the Azure Kubernetes Managed Cluster.
Id string
The provider-assigned unique ID for this managed resource.
Identities []GetKubernetesClusterIdentity
A identity block as documented below.
KubeAdminConfigRaw string
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 and local accounts are not disabled.
KubeAdminConfigs []GetKubernetesClusterKubeAdminConfig
A kube_admin_config block as defined below. This is only available when Role Based Access Control with Azure Active Directory is enabled and local accounts are not disabled.
KubeConfigRaw string
Base64 encoded Kubernetes configuration.
KubeConfigs []GetKubernetesClusterKubeConfig
A kube_config block as defined below.
KubeletIdentities []GetKubernetesClusterKubeletIdentity
A kubelet_identity block as documented below.
KubernetesVersion string
The version of Kubernetes used on the managed Kubernetes Cluster.
LinuxProfiles []GetKubernetesClusterLinuxProfile
A linux_profile block as documented below.
Location string
The Azure Region in which the managed Kubernetes Cluster exists.
Name string
The name assigned to this pool of agents.
NetworkProfiles []GetKubernetesClusterNetworkProfile
A network_profile block as documented below.
NodeResourceGroup string
Auto-generated Resource Group containing AKS Cluster resources.
PrivateClusterEnabled bool
If the cluster has the Kubernetes API only exposed on internal IP addresses.
PrivateFqdn string
The FQDN of this Kubernetes Cluster when private link has been enabled. This name is only resolvable inside the Virtual Network where the Azure Kubernetes Service is located
PrivateLinkEnabled bool
ResourceGroupName string
RoleBasedAccessControls []GetKubernetesClusterRoleBasedAccessControl
A role_based_access_control block as documented below.
ServicePrincipals []GetKubernetesClusterServicePrincipal
A service_principal block as documented below.
Tags map[string]string
A mapping of tags to assign to the resource.
WindowsProfiles []GetKubernetesClusterWindowsProfile
A windows_profile block as documented below.
addonProfiles GetKubernetesClusterAddonProfile[]
A addon_profile block as documented below.
agentPoolProfiles GetKubernetesClusterAgentPoolProfile[]
An agent_pool_profile block as documented below.
apiServerAuthorizedIpRanges string[]
The IP ranges to whitelist for incoming traffic to the primaries.
diskEncryptionSetId string
The ID of the Disk Encryption Set used for the Nodes and Volumes.
dnsPrefix string
The DNS Prefix of the managed Kubernetes cluster.
fqdn string
The FQDN of the Azure Kubernetes Managed Cluster.
id string
The provider-assigned unique ID for this managed resource.
identities GetKubernetesClusterIdentity[]
A identity block as documented below.
kubeAdminConfigRaw string
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 and local accounts are not disabled.
kubeAdminConfigs GetKubernetesClusterKubeAdminConfig[]
A kube_admin_config block as defined below. This is only available when Role Based Access Control with Azure Active Directory is enabled and local accounts are not disabled.
kubeConfigRaw string
Base64 encoded Kubernetes configuration.
kubeConfigs GetKubernetesClusterKubeConfig[]
A kube_config block as defined below.
kubeletIdentities GetKubernetesClusterKubeletIdentity[]
A kubelet_identity block as documented below.
kubernetesVersion string
The version of Kubernetes used on the managed Kubernetes Cluster.
linuxProfiles GetKubernetesClusterLinuxProfile[]
A linux_profile block as documented below.
location string
The Azure Region in which the managed Kubernetes Cluster exists.
name string
The name assigned to this pool of agents.
networkProfiles GetKubernetesClusterNetworkProfile[]
A network_profile block as documented below.
nodeResourceGroup string
Auto-generated Resource Group containing AKS Cluster resources.
privateClusterEnabled boolean
If the cluster has the Kubernetes API only exposed on internal IP addresses.
privateFqdn string
The FQDN of this Kubernetes Cluster when private link has been enabled. This name is only resolvable inside the Virtual Network where the Azure Kubernetes Service is located
privateLinkEnabled boolean
resourceGroupName string
roleBasedAccessControls GetKubernetesClusterRoleBasedAccessControl[]
A role_based_access_control block as documented below.
servicePrincipals GetKubernetesClusterServicePrincipal[]
A service_principal block as documented below.
tags {[key: string]: string}
A mapping of tags to assign to the resource.
windowsProfiles GetKubernetesClusterWindowsProfile[]
A windows_profile block as documented below.
addon_profiles Sequence[GetKubernetesClusterAddonProfile]
A addon_profile block as documented below.
agent_pool_profiles Sequence[GetKubernetesClusterAgentPoolProfile]
An agent_pool_profile block as documented below.
api_server_authorized_ip_ranges Sequence[str]
The IP ranges to whitelist for incoming traffic to the primaries.
disk_encryption_set_id str
The ID of the Disk Encryption Set used for the Nodes and Volumes.
dns_prefix str
The DNS Prefix of the managed Kubernetes cluster.
fqdn str
The FQDN of the Azure Kubernetes Managed Cluster.
id str
The provider-assigned unique ID for this managed resource.
identities Sequence[GetKubernetesClusterIdentity]
A identity block as documented below.
kube_admin_config_raw str
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 and local accounts are not disabled.
kube_admin_configs Sequence[GetKubernetesClusterKubeAdminConfig]
A kube_admin_config block as defined below. This is only available when Role Based Access Control with Azure Active Directory is enabled and local accounts are not disabled.
kube_config_raw str
Base64 encoded Kubernetes configuration.
kube_configs Sequence[GetKubernetesClusterKubeConfig]
A kube_config block as defined below.
kubelet_identities Sequence[GetKubernetesClusterKubeletIdentity]
A kubelet_identity block as documented below.
kubernetes_version str
The version of Kubernetes used on the managed Kubernetes Cluster.
linux_profiles Sequence[GetKubernetesClusterLinuxProfile]
A linux_profile block as documented below.
location str
The Azure Region in which the managed Kubernetes Cluster exists.
name str
The name assigned to this pool of agents.
network_profiles Sequence[GetKubernetesClusterNetworkProfile]
A network_profile block as documented below.
node_resource_group str
Auto-generated Resource Group containing AKS Cluster resources.
private_cluster_enabled bool
If the cluster has the Kubernetes API only exposed on internal IP addresses.
private_fqdn str
The FQDN of this Kubernetes Cluster when private link has been enabled. This name is only resolvable inside the Virtual Network where the Azure Kubernetes Service is located
private_link_enabled bool
resource_group_name str
role_based_access_controls Sequence[GetKubernetesClusterRoleBasedAccessControl]
A role_based_access_control block as documented below.
service_principals Sequence[GetKubernetesClusterServicePrincipal]
A service_principal block as documented below.
tags Mapping[str, str]
A mapping of tags to assign to the resource.
windows_profiles Sequence[GetKubernetesClusterWindowsProfile]
A windows_profile block as documented below.

Supporting Types

GetKubernetesClusterAddonProfile

GetKubernetesClusterAddonProfileAzurePolicy

Enabled bool
Is Role Based Access Control enabled?
Enabled bool
Is Role Based Access Control enabled?
enabled boolean
Is Role Based Access Control enabled?
enabled bool
Is Role Based Access Control enabled?

GetKubernetesClusterAddonProfileHttpApplicationRouting

Enabled bool
Is Role Based Access Control enabled?
HttpApplicationRoutingZoneName string
The Zone Name of the HTTP Application Routing.
Enabled bool
Is Role Based Access Control enabled?
HttpApplicationRoutingZoneName string
The Zone Name of the HTTP Application Routing.
enabled boolean
Is Role Based Access Control enabled?
httpApplicationRoutingZoneName string
The Zone Name of the HTTP Application Routing.
enabled bool
Is Role Based Access Control enabled?
http_application_routing_zone_name str
The Zone Name of the HTTP Application Routing.

GetKubernetesClusterAddonProfileIngressApplicationGateway

EffectiveGatewayId string
The ID of the Application Gateway associated with the ingress controller deployed to this Kubernetes Cluster.
Enabled bool
Is Role Based Access Control enabled?
GatewayId string
The ID of the Application Gateway integrated with the ingress controller of this Kubernetes Cluster. This attribute is only set when gateway_id is specified when configuring the ingress_application_gateway addon.
IngressApplicationGatewayIdentities List<GetKubernetesClusterAddonProfileIngressApplicationGatewayIngressApplicationGatewayIdentity>
An ingress_application_gateway_identity block as defined below.
SubnetCidr string
The subnet CIDR used to create an Application Gateway, which in turn will be integrated with the ingress controller of this Kubernetes Cluster. This attribute is only set when subnet_cidr is specified when configuring the ingress_application_gateway addon.
SubnetId string
The ID of the subnet on which to create an Application Gateway, which in turn will be integrated with the ingress controller of this Kubernetes Cluster. This attribute is only set when subnet_id is specified when configuring the ingress_application_gateway addon.
EffectiveGatewayId string
The ID of the Application Gateway associated with the ingress controller deployed to this Kubernetes Cluster.
Enabled bool
Is Role Based Access Control enabled?
GatewayId string
The ID of the Application Gateway integrated with the ingress controller of this Kubernetes Cluster. This attribute is only set when gateway_id is specified when configuring the ingress_application_gateway addon.
IngressApplicationGatewayIdentities []GetKubernetesClusterAddonProfileIngressApplicationGatewayIngressApplicationGatewayIdentity
An ingress_application_gateway_identity block as defined below.
SubnetCidr string
The subnet CIDR used to create an Application Gateway, which in turn will be integrated with the ingress controller of this Kubernetes Cluster. This attribute is only set when subnet_cidr is specified when configuring the ingress_application_gateway addon.
SubnetId string
The ID of the subnet on which to create an Application Gateway, which in turn will be integrated with the ingress controller of this Kubernetes Cluster. This attribute is only set when subnet_id is specified when configuring the ingress_application_gateway addon.
effectiveGatewayId string
The ID of the Application Gateway associated with the ingress controller deployed to this Kubernetes Cluster.
enabled boolean
Is Role Based Access Control enabled?
gatewayId string
The ID of the Application Gateway integrated with the ingress controller of this Kubernetes Cluster. This attribute is only set when gateway_id is specified when configuring the ingress_application_gateway addon.
ingressApplicationGatewayIdentities GetKubernetesClusterAddonProfileIngressApplicationGatewayIngressApplicationGatewayIdentity[]
An ingress_application_gateway_identity block as defined below.
subnetCidr string
The subnet CIDR used to create an Application Gateway, which in turn will be integrated with the ingress controller of this Kubernetes Cluster. This attribute is only set when subnet_cidr is specified when configuring the ingress_application_gateway addon.
subnetId string
The ID of the subnet on which to create an Application Gateway, which in turn will be integrated with the ingress controller of this Kubernetes Cluster. This attribute is only set when subnet_id is specified when configuring the ingress_application_gateway addon.
effective_gateway_id str
The ID of the Application Gateway associated with the ingress controller deployed to this Kubernetes Cluster.
enabled bool
Is Role Based Access Control enabled?
gateway_id str
The ID of the Application Gateway integrated with the ingress controller of this Kubernetes Cluster. This attribute is only set when gateway_id is specified when configuring the ingress_application_gateway addon.
ingress_application_gateway_identities Sequence[GetKubernetesClusterAddonProfileIngressApplicationGatewayIngressApplicationGatewayIdentity]
An ingress_application_gateway_identity block as defined below.
subnet_cidr str
The subnet CIDR used to create an Application Gateway, which in turn will be integrated with the ingress controller of this Kubernetes Cluster. This attribute is only set when subnet_cidr is specified when configuring the ingress_application_gateway addon.
subnet_id str
The ID of the subnet on which to create an Application Gateway, which in turn will be integrated with the ingress controller of this Kubernetes Cluster. This attribute is only set when subnet_id is specified when configuring the ingress_application_gateway addon.

GetKubernetesClusterAddonProfileIngressApplicationGatewayIngressApplicationGatewayIdentity

ClientId string
The Client ID of the user-defined Managed Identity assigned to the Kubelets.
ObjectId string
The Object ID of the user-defined Managed Identity assigned to the Kubelets.
UserAssignedIdentityId string
The ID of the User Assigned Identity assigned to the Kubelets.
ClientId string
The Client ID of the user-defined Managed Identity assigned to the Kubelets.
ObjectId string
The Object ID of the user-defined Managed Identity assigned to the Kubelets.
UserAssignedIdentityId string
The ID of the User Assigned Identity assigned to the Kubelets.
clientId string
The Client ID of the user-defined Managed Identity assigned to the Kubelets.
objectId string
The Object ID of the user-defined Managed Identity assigned to the Kubelets.
userAssignedIdentityId string
The ID of the User Assigned Identity assigned to the Kubelets.
client_id str
The Client ID of the user-defined Managed Identity assigned to the Kubelets.
object_id str
The Object ID of the user-defined Managed Identity assigned to the Kubelets.
user_assigned_identity_id str
The ID of the User Assigned Identity assigned to the Kubelets.

GetKubernetesClusterAddonProfileKubeDashboard

Enabled bool
Is Role Based Access Control enabled?
Enabled bool
Is Role Based Access Control enabled?
enabled boolean
Is Role Based Access Control enabled?
enabled bool
Is Role Based Access Control enabled?

GetKubernetesClusterAddonProfileOmsAgent

Enabled bool
Is Role Based Access Control enabled?
LogAnalyticsWorkspaceId string
The ID of the Log Analytics Workspace which the OMS Agent should send data to.
OmsAgentIdentities List<GetKubernetesClusterAddonProfileOmsAgentOmsAgentIdentity>
An oms_agent_identity block as defined below.
Enabled bool
Is Role Based Access Control enabled?
LogAnalyticsWorkspaceId string
The ID of the Log Analytics Workspace which the OMS Agent should send data to.
OmsAgentIdentities []GetKubernetesClusterAddonProfileOmsAgentOmsAgentIdentity
An oms_agent_identity block as defined below.
enabled boolean
Is Role Based Access Control enabled?
logAnalyticsWorkspaceId string
The ID of the Log Analytics Workspace which the OMS Agent should send data to.
omsAgentIdentities GetKubernetesClusterAddonProfileOmsAgentOmsAgentIdentity[]
An oms_agent_identity block as defined below.
enabled bool
Is Role Based Access Control enabled?
log_analytics_workspace_id str
The ID of the Log Analytics Workspace which the OMS Agent should send data to.
oms_agent_identities Sequence[GetKubernetesClusterAddonProfileOmsAgentOmsAgentIdentity]
An oms_agent_identity block as defined below.

GetKubernetesClusterAddonProfileOmsAgentOmsAgentIdentity

ClientId string
The Client ID of the user-defined Managed Identity assigned to the Kubelets.
ObjectId string
The Object ID of the user-defined Managed Identity assigned to the Kubelets.
UserAssignedIdentityId string
The ID of the User Assigned Identity assigned to the Kubelets.
ClientId string
The Client ID of the user-defined Managed Identity assigned to the Kubelets.
ObjectId string
The Object ID of the user-defined Managed Identity assigned to the Kubelets.
UserAssignedIdentityId string
The ID of the User Assigned Identity assigned to the Kubelets.
clientId string
The Client ID of the user-defined Managed Identity assigned to the Kubelets.
objectId string
The Object ID of the user-defined Managed Identity assigned to the Kubelets.
userAssignedIdentityId string
The ID of the User Assigned Identity assigned to the Kubelets.
client_id str
The Client ID of the user-defined Managed Identity assigned to the Kubelets.
object_id str
The Object ID of the user-defined Managed Identity assigned to the Kubelets.
user_assigned_identity_id str
The ID of the User Assigned Identity assigned to the Kubelets.

GetKubernetesClusterAddonProfileOpenServiceMesh

Enabled bool
Is Role Based Access Control enabled?
Enabled bool
Is Role Based Access Control enabled?
enabled boolean
Is Role Based Access Control enabled?
enabled bool
Is Role Based Access Control enabled?

GetKubernetesClusterAgentPoolProfile

AvailabilityZones List<string>
The availability zones used for the nodes.
Count int
The number of Agents (VM’s) in the Pool.
EnableAutoScaling bool
If the auto-scaler is enabled.
EnableNodePublicIp bool
If the Public IPs for the nodes in this Agent Pool are enabled.
MaxCount int
Maximum number of nodes for auto-scaling
MaxPods int
The maximum number of pods that can run on each agent.
MinCount int
Minimum number of nodes for auto-scaling
Name string
The name of the managed Kubernetes Cluster.
NodeLabels Dictionary<string, string>
NodePublicIpPrefixId string
Resource ID for the Public IP Addresses Prefix for the nodes in this Agent Pool.
NodeTaints List<string>
OrchestratorVersion string
Kubernetes version used for the Agents.
OsDiskSizeGb int
The size of the Agent VM’s Operating System Disk in GB.
OsType string
The Operating System used for the Agents.
Tags Dictionary<string, string>
A mapping of tags to assign to the resource.
Type string
The type of identity used for the managed cluster.
UpgradeSettings List<GetKubernetesClusterAgentPoolProfileUpgradeSetting>
A upgrade_settings block as documented below.
VmSize string
The size of each VM in the Agent Pool (e.g. Standard_F1).
VnetSubnetId string
The ID of the Subnet where the Agents in the Pool are provisioned.
AvailabilityZones []string
The availability zones used for the nodes.
Count int
The number of Agents (VM’s) in the Pool.
EnableAutoScaling bool
If the auto-scaler is enabled.
EnableNodePublicIp bool
If the Public IPs for the nodes in this Agent Pool are enabled.
MaxCount int
Maximum number of nodes for auto-scaling
MaxPods int
The maximum number of pods that can run on each agent.
MinCount int
Minimum number of nodes for auto-scaling
Name string
The name of the managed Kubernetes Cluster.
NodeLabels map[string]string
NodePublicIpPrefixId string
Resource ID for the Public IP Addresses Prefix for the nodes in this Agent Pool.
NodeTaints []string
OrchestratorVersion string
Kubernetes version used for the Agents.
OsDiskSizeGb int
The size of the Agent VM’s Operating System Disk in GB.
OsType string
The Operating System used for the Agents.
Tags map[string]string
A mapping of tags to assign to the resource.
Type string
The type of identity used for the managed cluster.
UpgradeSettings []GetKubernetesClusterAgentPoolProfileUpgradeSetting
A upgrade_settings block as documented below.
VmSize string
The size of each VM in the Agent Pool (e.g. Standard_F1).
VnetSubnetId string
The ID of the Subnet where the Agents in the Pool are provisioned.
availabilityZones string[]
The availability zones used for the nodes.
count number
The number of Agents (VM’s) in the Pool.
enableAutoScaling boolean
If the auto-scaler is enabled.
enableNodePublicIp boolean
If the Public IPs for the nodes in this Agent Pool are enabled.
maxCount number
Maximum number of nodes for auto-scaling
maxPods number
The maximum number of pods that can run on each agent.
minCount number
Minimum number of nodes for auto-scaling
name string
The name of the managed Kubernetes Cluster.
nodeLabels {[key: string]: string}
nodePublicIpPrefixId string
Resource ID for the Public IP Addresses Prefix for the nodes in this Agent Pool.
nodeTaints string[]
orchestratorVersion string
Kubernetes version used for the Agents.
osDiskSizeGb number
The size of the Agent VM’s Operating System Disk in GB.
osType string
The Operating System used for the Agents.
tags {[key: string]: string}
A mapping of tags to assign to the resource.
type string
The type of identity used for the managed cluster.
upgradeSettings GetKubernetesClusterAgentPoolProfileUpgradeSetting[]
A upgrade_settings block as documented below.
vmSize string
The size of each VM in the Agent Pool (e.g. Standard_F1).
vnetSubnetId string
The ID of the Subnet where the Agents in the Pool are provisioned.
availability_zones Sequence[str]
The availability zones used for the nodes.
count int
The number of Agents (VM’s) in the Pool.
enable_auto_scaling bool
If the auto-scaler is enabled.
enable_node_public_ip bool
If the Public IPs for the nodes in this Agent Pool are enabled.
max_count int
Maximum number of nodes for auto-scaling
max_pods int
The maximum number of pods that can run on each agent.
min_count int
Minimum number of nodes for auto-scaling
name str
The name of the managed Kubernetes Cluster.
node_labels Mapping[str, str]
node_public_ip_prefix_id str
Resource ID for the Public IP Addresses Prefix for the nodes in this Agent Pool.
node_taints Sequence[str]
orchestrator_version str
Kubernetes version used for the Agents.
os_disk_size_gb int
The size of the Agent VM’s Operating System Disk in GB.
os_type str
The Operating System used for the Agents.
tags Mapping[str, str]
A mapping of tags to assign to the resource.
type str
The type of identity used for the managed cluster.
upgrade_settings Sequence[GetKubernetesClusterAgentPoolProfileUpgradeSetting]
A upgrade_settings block as documented below.
vm_size str
The size of each VM in the Agent Pool (e.g. Standard_F1).
vnet_subnet_id str
The ID of the Subnet where the Agents in the Pool are provisioned.

GetKubernetesClusterAgentPoolProfileUpgradeSetting

MaxSurge string
The maximum number or percentage of nodes which will be added to the Node Pool size during an upgrade.
MaxSurge string
The maximum number or percentage of nodes which will be added to the Node Pool size during an upgrade.
maxSurge string
The maximum number or percentage of nodes which will be added to the Node Pool size during an upgrade.
max_surge str
The maximum number or percentage of nodes which will be added to the Node Pool size during an upgrade.

GetKubernetesClusterIdentity

PrincipalId string
The principal id of the system assigned identity which is used by primary components.
TenantId string
The tenant id of the system assigned identity which is used by primary components.
Type string
The type of identity used for the managed cluster.
UserAssignedIdentityId string
The ID of the User Assigned Identity assigned to the Kubelets.
PrincipalId string
The principal id of the system assigned identity which is used by primary components.
TenantId string
The tenant id of the system assigned identity which is used by primary components.
Type string
The type of identity used for the managed cluster.
UserAssignedIdentityId string
The ID of the User Assigned Identity assigned to the Kubelets.
principalId string
The principal id of the system assigned identity which is used by primary components.
tenantId string
The tenant id of the system assigned identity which is used by primary components.
type string
The type of identity used for the managed cluster.
userAssignedIdentityId string
The ID of the User Assigned Identity assigned to the Kubelets.
principal_id str
The principal id of the system assigned identity which is used by primary components.
tenant_id str
The tenant id of the system assigned identity which is used by primary components.
type str
The type of identity used for the managed cluster.
user_assigned_identity_id str
The ID of the User Assigned Identity assigned to the Kubelets.

GetKubernetesClusterKubeAdminConfig

ClientCertificate string
Base64 encoded public certificate used by clients to authenticate to the Kubernetes cluster.
ClientKey string
Base64 encoded private key used by clients to authenticate to the Kubernetes cluster.
ClusterCaCertificate string
Base64 encoded public CA certificate used as the root of trust for the Kubernetes cluster.
Host string
The Kubernetes cluster server host.
Password string
A password or token used to authenticate to the Kubernetes cluster.
Username string
A username used to authenticate to the Kubernetes cluster.
ClientCertificate string
Base64 encoded public certificate used by clients to authenticate to the Kubernetes cluster.
ClientKey string
Base64 encoded private key used by clients to authenticate to the Kubernetes cluster.
ClusterCaCertificate string
Base64 encoded public CA certificate used as the root of trust for the Kubernetes cluster.
Host string
The Kubernetes cluster server host.
Password string
A password or token used to authenticate to the Kubernetes cluster.
Username string
A username used to authenticate to the Kubernetes cluster.
clientCertificate string
Base64 encoded public certificate used by clients to authenticate to the Kubernetes cluster.
clientKey string
Base64 encoded private key used by clients to authenticate to the Kubernetes cluster.
clusterCaCertificate string
Base64 encoded public CA certificate used as the root of trust for the Kubernetes cluster.
host string
The Kubernetes cluster server host.
password string
A password or token used to authenticate to the Kubernetes cluster.
username string
A username used to authenticate to the Kubernetes cluster.
client_certificate str
Base64 encoded public certificate used by clients to authenticate to the Kubernetes cluster.
client_key str
Base64 encoded private key used by clients to authenticate to the Kubernetes cluster.
cluster_ca_certificate str
Base64 encoded public CA certificate used as the root of trust for the Kubernetes cluster.
host str
The Kubernetes cluster server host.
password str
A password or token used to authenticate to the Kubernetes cluster.
username str
A username used to authenticate to the Kubernetes cluster.

GetKubernetesClusterKubeConfig

ClientCertificate string
Base64 encoded public certificate used by clients to authenticate to the Kubernetes cluster.
ClientKey string
Base64 encoded private key used by clients to authenticate to the Kubernetes cluster.
ClusterCaCertificate string
Base64 encoded public CA certificate used as the root of trust for the Kubernetes cluster.
Host string
The Kubernetes cluster server host.
Password string
A password or token used to authenticate to the Kubernetes cluster.
Username string
A username used to authenticate to the Kubernetes cluster.
ClientCertificate string
Base64 encoded public certificate used by clients to authenticate to the Kubernetes cluster.
ClientKey string
Base64 encoded private key used by clients to authenticate to the Kubernetes cluster.
ClusterCaCertificate string
Base64 encoded public CA certificate used as the root of trust for the Kubernetes cluster.
Host string
The Kubernetes cluster server host.
Password string
A password or token used to authenticate to the Kubernetes cluster.
Username string
A username used to authenticate to the Kubernetes cluster.
clientCertificate string
Base64 encoded public certificate used by clients to authenticate to the Kubernetes cluster.
clientKey string
Base64 encoded private key used by clients to authenticate to the Kubernetes cluster.
clusterCaCertificate string
Base64 encoded public CA certificate used as the root of trust for the Kubernetes cluster.
host string
The Kubernetes cluster server host.
password string
A password or token used to authenticate to the Kubernetes cluster.
username string
A username used to authenticate to the Kubernetes cluster.
client_certificate str
Base64 encoded public certificate used by clients to authenticate to the Kubernetes cluster.
client_key str
Base64 encoded private key used by clients to authenticate to the Kubernetes cluster.
cluster_ca_certificate str
Base64 encoded public CA certificate used as the root of trust for the Kubernetes cluster.
host str
The Kubernetes cluster server host.
password str
A password or token used to authenticate to the Kubernetes cluster.
username str
A username used to authenticate to the Kubernetes cluster.

GetKubernetesClusterKubeletIdentity

ClientId string
The Client ID of the user-defined Managed Identity assigned to the Kubelets.
ObjectId string
The Object ID of the user-defined Managed Identity assigned to the Kubelets.
UserAssignedIdentityId string
The ID of the User Assigned Identity assigned to the Kubelets.
ClientId string
The Client ID of the user-defined Managed Identity assigned to the Kubelets.
ObjectId string
The Object ID of the user-defined Managed Identity assigned to the Kubelets.
UserAssignedIdentityId string
The ID of the User Assigned Identity assigned to the Kubelets.
clientId string
The Client ID of the user-defined Managed Identity assigned to the Kubelets.
objectId string
The Object ID of the user-defined Managed Identity assigned to the Kubelets.
userAssignedIdentityId string
The ID of the User Assigned Identity assigned to the Kubelets.
client_id str
The Client ID of the user-defined Managed Identity assigned to the Kubelets.
object_id str
The Object ID of the user-defined Managed Identity assigned to the Kubelets.
user_assigned_identity_id str
The ID of the User Assigned Identity assigned to the Kubelets.

GetKubernetesClusterLinuxProfile

AdminUsername string
The username associated with the administrator account of the Windows VMs.
SshKeys List<GetKubernetesClusterLinuxProfileSshKey>
An ssh_key block as defined below.
AdminUsername string
The username associated with the administrator account of the Windows VMs.
SshKeys []GetKubernetesClusterLinuxProfileSshKey
An ssh_key block as defined below.
adminUsername string
The username associated with the administrator account of the Windows VMs.
sshKeys GetKubernetesClusterLinuxProfileSshKey[]
An ssh_key block as defined below.
admin_username str
The username associated with the administrator account of the Windows VMs.
ssh_keys Sequence[GetKubernetesClusterLinuxProfileSshKey]
An ssh_key block as defined below.

GetKubernetesClusterLinuxProfileSshKey

KeyData string
The Public SSH Key used to access the cluster.
KeyData string
The Public SSH Key used to access the cluster.
keyData string
The Public SSH Key used to access the cluster.
key_data str
The Public SSH Key used to access the cluster.

GetKubernetesClusterNetworkProfile

DnsServiceIp string
IP address within the Kubernetes service address range used by cluster service discovery (kube-dns).
DockerBridgeCidr string
IP address (in CIDR notation) used as the Docker bridge IP address on nodes.
LoadBalancerSku string
NetworkPlugin string
Network plugin used such as azure or kubenet.
NetworkPolicy string
Network policy to be used with Azure CNI. Eg: calico or azure
PodCidr string
The CIDR used for pod IP addresses.
ServiceCidr string
Network range used by the Kubernetes service.
DnsServiceIp string
IP address within the Kubernetes service address range used by cluster service discovery (kube-dns).
DockerBridgeCidr string
IP address (in CIDR notation) used as the Docker bridge IP address on nodes.
LoadBalancerSku string
NetworkPlugin string
Network plugin used such as azure or kubenet.
NetworkPolicy string
Network policy to be used with Azure CNI. Eg: calico or azure
PodCidr string
The CIDR used for pod IP addresses.
ServiceCidr string
Network range used by the Kubernetes service.
dnsServiceIp string
IP address within the Kubernetes service address range used by cluster service discovery (kube-dns).
dockerBridgeCidr string
IP address (in CIDR notation) used as the Docker bridge IP address on nodes.
loadBalancerSku string
networkPlugin string
Network plugin used such as azure or kubenet.
networkPolicy string
Network policy to be used with Azure CNI. Eg: calico or azure
podCidr string
The CIDR used for pod IP addresses.
serviceCidr string
Network range used by the Kubernetes service.
dns_service_ip str
IP address within the Kubernetes service address range used by cluster service discovery (kube-dns).
docker_bridge_cidr str
IP address (in CIDR notation) used as the Docker bridge IP address on nodes.
load_balancer_sku str
network_plugin str
Network plugin used such as azure or kubenet.
network_policy str
Network policy to be used with Azure CNI. Eg: calico or azure
pod_cidr str
The CIDR used for pod IP addresses.
service_cidr str
Network range used by the Kubernetes service.

GetKubernetesClusterRoleBasedAccessControl

AzureActiveDirectories List<GetKubernetesClusterRoleBasedAccessControlAzureActiveDirectory>
A azure_active_directory block as documented above.
Enabled bool
Is Role Based Access Control enabled?
AzureActiveDirectories []GetKubernetesClusterRoleBasedAccessControlAzureActiveDirectory
A azure_active_directory block as documented above.
Enabled bool
Is Role Based Access Control enabled?
azureActiveDirectories GetKubernetesClusterRoleBasedAccessControlAzureActiveDirectory[]
A azure_active_directory block as documented above.
enabled boolean
Is Role Based Access Control enabled?
azure_active_directories Sequence[GetKubernetesClusterRoleBasedAccessControlAzureActiveDirectory]
A azure_active_directory block as documented above.
enabled bool
Is Role Based Access Control enabled?

GetKubernetesClusterRoleBasedAccessControlAzureActiveDirectory

AdminGroupObjectIds List<string>
The list of Object IDs of Azure Active Directory Groups which have Admin Role on the Cluster (when using a Managed integration).
ClientAppId string
The Client ID of an Azure Active Directory Application.
Managed bool
Is the Azure Active Directory Integration managed (also known as AAD Integration V2)?
ServerAppId string
The Server ID of an Azure Active Directory Application.
TenantId string
The tenant id of the system assigned identity which is used by primary components.
AdminGroupObjectIds []string
The list of Object IDs of Azure Active Directory Groups which have Admin Role on the Cluster (when using a Managed integration).
ClientAppId string
The Client ID of an Azure Active Directory Application.
Managed bool
Is the Azure Active Directory Integration managed (also known as AAD Integration V2)?
ServerAppId string
The Server ID of an Azure Active Directory Application.
TenantId string
The tenant id of the system assigned identity which is used by primary components.
adminGroupObjectIds string[]
The list of Object IDs of Azure Active Directory Groups which have Admin Role on the Cluster (when using a Managed integration).
clientAppId string
The Client ID of an Azure Active Directory Application.
managed boolean
Is the Azure Active Directory Integration managed (also known as AAD Integration V2)?
serverAppId string
The Server ID of an Azure Active Directory Application.
tenantId string
The tenant id of the system assigned identity which is used by primary components.
admin_group_object_ids Sequence[str]
The list of Object IDs of Azure Active Directory Groups which have Admin Role on the Cluster (when using a Managed integration).
client_app_id str
The Client ID of an Azure Active Directory Application.
managed bool
Is the Azure Active Directory Integration managed (also known as AAD Integration V2)?
server_app_id str
The Server ID of an Azure Active Directory Application.
tenant_id str
The tenant id of the system assigned identity which is used by primary components.

GetKubernetesClusterServicePrincipal

ClientId string
The Client ID of the user-defined Managed Identity assigned to the Kubelets.
ClientId string
The Client ID of the user-defined Managed Identity assigned to the Kubelets.
clientId string
The Client ID of the user-defined Managed Identity assigned to the Kubelets.
client_id str
The Client ID of the user-defined Managed Identity assigned to the Kubelets.

GetKubernetesClusterWindowsProfile

AdminUsername string
The username associated with the administrator account of the Windows VMs.
AdminUsername string
The username associated with the administrator account of the Windows VMs.
adminUsername string
The username associated with the administrator account of the Windows VMs.
admin_username str
The username associated with the administrator account of the Windows VMs.

Package Details

Repository
https://github.com/pulumi/pulumi-azure
License
Apache-2.0
Notes
This Pulumi package is based on the azurerm Terraform Provider.