KubernetesCluster Interface

Package:

com.azure.resourcemanager.containerservice.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-containerservice:2.48.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() Gets the cluster's add-on's profiles.
abstract byte[]	adminKubeConfigContent() Gets the Kubernetes configuration file content with administrative privileges to the cluster.
abstract List<CredentialResult>	adminKubeConfigs() Gets the Kubernetes credentials with administrative privileges to the cluster.
abstract String	agentPoolResourceGroup() Gets the resource group containing agent pool nodes.
abstract Map<String,KubernetesClusterAgentPool>	agentPools() Gets the agent pools in the Kubernetes cluster.
abstract List<String>	azureActiveDirectoryGroupIds() Gets the IDs (object IDs) of the Azure AD groups as the admin group of the cluster.
abstract Accepted<AgentPool>	beginCreateAgentPool(String agentPoolName, AgentPoolData agentPool) Begins creating the agent pool resource.
abstract String	diskEncryptionSetId() Gets resource ID of the disk encryption set.
abstract String	dnsPrefix() Gets the DNS prefix which was specified at creation time.
abstract boolean	enableRBAC() Checks whether Kubernetes Role-Based Access Control is enabled.
abstract String	fqdn() Gets the FQDN for the master pool.
abstract boolean	isAzureRbacEnabled() Checks whether Azure Role-Based Access Control for Kubernetes authorization is enabled.
abstract boolean	isLocalAccountsEnabled() Checks whether local accounts is enabled.
abstract String	linuxRootUsername() Gets the Linux root username.
abstract ContainerServiceNetworkProfile	networkProfile() Gets the network profile settings for the cluster.
abstract String	nodeResourceGroup() Gets the name of the resource group containing agent pool nodes.
abstract PowerState	powerState() Gets the power state.
abstract String	provisioningState() Gets the provisioning state of the Kubernetes cluster.
abstract PublicNetworkAccess	publicNetworkAccess() Checks whether the kubernetes cluster can be accessed from public network.
abstract String	servicePrincipalClientId() Gets the service principal client ID.
abstract String	servicePrincipalSecret() Gets the service principal secret.
abstract ManagedClusterSku	sku() Gets the SKU of a Managed Cluster.
abstract String	sshKey() Gets the Linux SSH key.
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() Gets the System Assigned Managed Service Identity specific Active Directory service principal ID assigned to the Kubernetes cluster.
abstract byte[]	userKubeConfigContent() Gets the Kubernetes configuration file content with user-level privileges to the cluster.
abstract byte[]	userKubeConfigContent(Format format) Gets the Kubernetes configuration file content with user-level privileges to the cluster.
abstract List<CredentialResult>	userKubeConfigs() Gets the Kubernetes credentials with user-level privileges to the cluster.
abstract List<CredentialResult>	userKubeConfigs(Format format) Gets the Kubernetes credentials with user-level privileges to the cluster.
abstract String	version() Gets the Kubernetes version.

Method Details

addonProfiles

public abstract Map addonProfiles()

Gets the cluster's add-on's profiles.

Returns:

the cluster's add-on's profiles

adminKubeConfigContent

public abstract byte[] adminKubeConfigContent()

Gets the Kubernetes configuration file content with administrative privileges to the cluster.

Returns:

the Kubernetes configuration file content with administrative privileges to the cluster

adminKubeConfigs

public abstract List adminKubeConfigs()

Gets the Kubernetes credentials with administrative privileges to the cluster.

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()

Gets the agent pools in the Kubernetes cluster.

Returns:

the agent pools in the Kubernetes cluster

azureActiveDirectoryGroupIds

public abstract List azureActiveDirectoryGroupIds()

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

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()

Gets resource ID of the disk encryption set.

Returns:

resource ID of the disk encryption set.

dnsPrefix

public abstract String dnsPrefix()

Gets the DNS prefix which was specified at creation time.

Returns:

the DNS prefix which was specified at creation time

enableRBAC

public abstract boolean enableRBAC()

Checks whether Kubernetes Role-Based Access Control is enabled.

Returns:

true if Kubernetes Role-Based Access Control is enabled

fqdn

public abstract String fqdn()

Gets the FQDN for the master pool.

Returns:

the FQDN for the master pool

isAzureRbacEnabled

public abstract boolean isAzureRbacEnabled()

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

Returns:

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

isLocalAccountsEnabled

public abstract boolean isLocalAccountsEnabled()

Checks whether local accounts is enabled.

Returns:

whether local accounts is enabled.

linuxRootUsername

public abstract String linuxRootUsername()

Gets the Linux root username.

Returns:

the Linux root username

networkProfile

public abstract ContainerServiceNetworkProfile networkProfile()

Gets the network profile settings for the cluster.

Returns:

the network profile settings for the cluster

nodeResourceGroup

public abstract String nodeResourceGroup()

Gets the name of the resource group containing agent pool nodes.

Returns:

the name of the resource group containing agent pool nodes

powerState

public abstract PowerState powerState()

Gets the power state.

Returns:

the power state

provisioningState

public abstract String provisioningState()

Gets the provisioning state of the Kubernetes cluster.

Returns:

the provisioning state of the Kubernetes cluster

publicNetworkAccess

public abstract PublicNetworkAccess publicNetworkAccess()

Checks 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()

Gets the service principal client ID.

Returns:

the service principal client ID

servicePrincipalSecret

public abstract String servicePrincipalSecret()

Gets the service principal secret.

Returns:

the service principal secret

sku

public abstract ManagedClusterSku sku()

Gets the SKU of a Managed Cluster.

Returns:

the SKU of a Managed Cluster

sshKey

public abstract String sshKey()

Gets the Linux SSH key.

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()

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

Returns:

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

userKubeConfigContent

public abstract byte[] userKubeConfigContent()

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

Returns:

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

userKubeConfigContent

public abstract byte[] userKubeConfigContent(Format format)

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

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()

Gets the Kubernetes credentials with user-level privileges to the cluster.

Returns:

the Kubernetes credentials with user-level privileges to the cluster

userKubeConfigs

public abstract List userKubeConfigs(Format format)

Gets the Kubernetes credentials with user-level privileges to the cluster.

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()

Gets the Kubernetes version.

Returns:

the Kubernetes version