KubernetesCluster Interface

Package:

com.azure.resourcemanager.containerservice.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-containerservice:2.38.0

Implements

GroupableResource<ContainerServiceManager,ManagedClusterInner> SupportsListingPrivateEndpointConnection SupportsListingPrivateLinkResource Refreshable<KubernetesCluster> Updatable<Update>

public interface KubernetesCluster
extends GroupableResource<ContainerServiceManager,ManagedClusterInner>, Refreshable<KubernetesCluster>, Updatable<Update>, SupportsListingPrivateLinkResource, SupportsListingPrivateEndpointConnection

A client-side representation for a managed Kubernetes cluster.

Method Summary

Modifier and Type	Method and Description
abstract Map<String,ManagedClusterAddonProfile>	addonProfiles()
abstract byte[]	adminKubeConfigContent()
abstract List<CredentialResult>	adminKubeConfigs()
abstract String	agentPoolResourceGroup() Gets the resource group containing agent pool nodes.
abstract Map<String,KubernetesClusterAgentPool>	agentPools()
abstract List<String>	azureActiveDirectoryGroupIds()
abstract Accepted<AgentPool>	beginCreateAgentPool(String agentPoolName, AgentPoolData agentPool) Begins creating the agent pool resource.
abstract String	diskEncryptionSetId()
abstract String	dnsPrefix()
abstract boolean	enableRBAC()
abstract String	fqdn()
abstract boolean	isAzureRbacEnabled()
abstract boolean	isLocalAccountsEnabled()
abstract String	linuxRootUsername()
abstract ContainerServiceNetworkProfile	networkProfile()
abstract String	nodeResourceGroup()
abstract PowerState	powerState()
abstract String	provisioningState()
abstract PublicNetworkAccess	publicNetworkAccess() Whether the kubernetes cluster can be accessed from public network.
abstract String	servicePrincipalClientId()
abstract String	servicePrincipalSecret()
abstract ManagedClusterSku	sku()
abstract String	sshKey()
abstract void	start() Starts a stopped Kubernetes cluster.
abstract Mono<Void>	startAsync() Starts a stopped Kubernetes cluster.
abstract void	stop() Stops a running Kubernetes cluster.
abstract Mono<Void>	stopAsync() Stops a running Kubernetes cluster.
abstract String	systemAssignedManagedServiceIdentityPrincipalId()
abstract byte[]	userKubeConfigContent()
abstract byte[]	userKubeConfigContent(Format format)
abstract List<CredentialResult>	userKubeConfigs()
abstract List<CredentialResult>	userKubeConfigs(Format format)
abstract String	version()

Method Details

addonProfiles

public abstract Map addonProfiles()

Returns:

the cluster's add-on's profiles

adminKubeConfigContent

public abstract byte[] adminKubeConfigContent()

Returns:

the Kubernetes configuration file content with administrative privileges to the cluster

adminKubeConfigs

public abstract List adminKubeConfigs()

Returns:

the Kubernetes credentials with administrative privileges to the cluster

agentPoolResourceGroup

public abstract String agentPoolResourceGroup()

Gets the resource group containing agent pool nodes.

Returns:

The resource group containing agent pool nodes.

agentPools

public abstract Map agentPools()

Returns:

the agent pools in the Kubernetes cluster

azureActiveDirectoryGroupIds

public abstract List azureActiveDirectoryGroupIds()

Returns:

the IDs (object IDs) of the Azure AD groups as the admin group of the cluster.

beginCreateAgentPool

public abstract Accepted beginCreateAgentPool(String agentPoolName, AgentPoolData agentPool)

Begins creating the agent pool resource.

Parameters:

agentPoolName - the name of the agent pool.

agentPool - the agent pool.

Returns:

the accepted create operation

diskEncryptionSetId

public abstract String diskEncryptionSetId()

Returns:

resource ID of the disk encryption set.

dnsPrefix

public abstract String dnsPrefix()

Returns:

the DNS prefix which was specified at creation time

enableRBAC

public abstract boolean enableRBAC()

Returns:

true if Kubernetes Role-Based Access Control is enabled

fqdn

public abstract String fqdn()

Returns:

the FQDN for the master pool

isAzureRbacEnabled

public abstract boolean isAzureRbacEnabled()

Returns:

whether Azure Role-Based Access Control for Kubernetes authorization is enabled.

isLocalAccountsEnabled

public abstract boolean isLocalAccountsEnabled()

Returns:

whether local accounts is enabled.

linuxRootUsername

public abstract String linuxRootUsername()

Returns:

the Linux root username

networkProfile

public abstract ContainerServiceNetworkProfile networkProfile()

Returns:

the network profile settings for the cluster

nodeResourceGroup

public abstract String nodeResourceGroup()

Returns:

the name of the resource group containing agent pool nodes

powerState

public abstract PowerState powerState()

Returns:

the power state

provisioningState

public abstract String provisioningState()

Returns:

the provisioning state of the Kubernetes cluster

publicNetworkAccess

public abstract PublicNetworkAccess publicNetworkAccess()

Whether the kubernetes cluster can be accessed from public network.

Returns:

whether the kubernetes cluster can be accessed from public network.

servicePrincipalClientId

public abstract String servicePrincipalClientId()

Returns:

the service principal client ID

servicePrincipalSecret

public abstract String servicePrincipalSecret()

Returns:

the service principal secret

sku

public abstract ManagedClusterSku sku()

Returns:

the SKU of a Managed Cluster

sshKey

public abstract String sshKey()

Returns:

the Linux SSH key

start

public abstract void start()

Starts a stopped Kubernetes cluster.

startAsync

public abstract Mono startAsync()

Starts a stopped Kubernetes cluster.

Returns:

the completion.

stop

public abstract void stop()

Stops a running Kubernetes cluster.

stopAsync

public abstract Mono stopAsync()

Stops a running Kubernetes cluster.

Returns:

the completion.

systemAssignedManagedServiceIdentityPrincipalId

public abstract String systemAssignedManagedServiceIdentityPrincipalId()

Returns:

the System Assigned Managed Service Identity specific Active Directory service principal ID assigned to the Kubernetes cluster.

userKubeConfigContent

public abstract byte[] userKubeConfigContent()

Returns:

the Kubernetes configuration file content with user-level privileges to the cluster

userKubeConfigContent

public abstract byte[] userKubeConfigContent(Format format)

Parameters:

format - Only apply to AAD clusters, specifies the format of returned kubeconfig. Format 'azure' will return azure auth-provider kubeconfig; format 'exec' will return exec format kubeconfig, which requires kubelogin binary in the path.

Returns:

the Kubernetes configuration file content with user-level privileges to the cluster

userKubeConfigs

public abstract List userKubeConfigs()

Returns:

the Kubernetes credentials with user-level privileges to the cluster

userKubeConfigs

public abstract List userKubeConfigs(Format format)

Parameters:

format - Only apply to AAD clusters, specifies the format of returned kubeconfig. Format 'azure' will return azure auth-provider kubeconfig; format 'exec' will return exec format kubeconfig, which requires kubelogin binary in the path.

Returns:

the Kubernetes credentials with user-level privileges to the cluster

version

public abstract String version()

Returns:

the Kubernetes version