Package com.azure.resourcemanager.containerservice.models

Interface KubernetesCluster

All Superinterfaces:

GroupableResource<ContainerServiceManager,ManagedClusterInner>, HasId, HasInnerModel<ManagedClusterInner>, HasManager<ContainerServiceManager>, HasName, HasResourceGroup, Indexable, Refreshable<KubernetesCluster>, Resource, SupportsListingPrivateEndpointConnection, SupportsListingPrivateLinkResource, Updatable<KubernetesCluster.Update>

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

A client-side representation for a managed Kubernetes cluster.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	KubernetesCluster.Definition	Interface for all the definitions related to a Kubernetes cluster.
static interface	KubernetesCluster.DefinitionStages	Grouping of Kubernetes cluster definition stages.
static interface	KubernetesCluster.Update	The template for an update operation, containing all the settings that can be modified.
static interface	KubernetesCluster.UpdateStages	Grouping of the Kubernetes cluster update stages.

Nested classes/interfaces inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.Resource

Resource.DefinitionWithRegion<T extends Object>, Resource.DefinitionWithTags<T extends Object>, Resource.UpdateWithTags<T extends Object>

Field Summary

Fields inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.Resource

DUMMY

Method Summary

Modifier and Type	Method	Description
Map<String,ManagedClusterAddonProfile>	addonProfiles()
byte[]	adminKubeConfigContent()
List<CredentialResult>	adminKubeConfigs()
Map<String,KubernetesClusterAgentPool>	agentPools()
String	dnsPrefix()
boolean	enableRBAC()
String	fqdn()
String	linuxRootUsername()
ContainerServiceNetworkProfile	networkProfile()
String	nodeResourceGroup()
PowerState	powerState()
String	provisioningState()
String	servicePrincipalClientId()
String	servicePrincipalSecret()
String	sshKey()
void	start()	Starts a stopped Kubernetes cluster.
Mono<Void>	startAsync()	Starts a stopped Kubernetes cluster.
void	stop()	Stops a running Kubernetes cluster.
Mono<Void>	stopAsync()	Stops a running Kubernetes cluster.
String	systemAssignedManagedServiceIdentityPrincipalId()
byte[]	userKubeConfigContent()
byte[]	userKubeConfigContent(Format format)
List<CredentialResult>	userKubeConfigs()
List<CredentialResult>	userKubeConfigs(Format format)
String	version()

Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.HasId

id

Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.model.HasInnerModel

innerModel

Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.HasManager

manager

Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.HasName

name

Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.HasResourceGroup

resourceGroupName

Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.model.Indexable

key

Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.model.Refreshable

refresh, refreshAsync

Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.Resource

region, regionName, tags, type

Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.collection.SupportsListingPrivateEndpointConnection

listPrivateEndpointConnections, listPrivateEndpointConnectionsAsync

Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.collection.SupportsListingPrivateLinkResource

listPrivateLinkResources, listPrivateLinkResourcesAsync

Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.model.Updatable

update

Method Detail

provisioningState

String provisioningState()

Returns:

the provisioning state of the Kubernetes cluster

dnsPrefix

String dnsPrefix()

Returns:

the DNS prefix which was specified at creation time

fqdn

String fqdn()

Returns:

the FQDN for the master pool

version

String version()

Returns:

the Kubernetes version

adminKubeConfigContent

byte[] adminKubeConfigContent()

Returns:

the Kubernetes configuration file content with administrative privileges to the cluster

userKubeConfigContent

byte[] userKubeConfigContent()

Returns:

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

userKubeConfigContent

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

adminKubeConfigs

List<CredentialResult> adminKubeConfigs()

Returns:

the Kubernetes credentials with administrative privileges to the cluster

userKubeConfigs

List<CredentialResult> userKubeConfigs()

Returns:

the Kubernetes credentials with user-level privileges to the cluster

userKubeConfigs

List<CredentialResult> 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

servicePrincipalClientId

String servicePrincipalClientId()

Returns:

the service principal client ID

servicePrincipalSecret

String servicePrincipalSecret()

Returns:

the service principal secret

linuxRootUsername

String linuxRootUsername()

Returns:

the Linux root username

sshKey

String sshKey()

Returns:

the Linux SSH key

agentPools

Map<String,KubernetesClusterAgentPool> agentPools()

Returns:

the agent pools in the Kubernetes cluster

networkProfile

ContainerServiceNetworkProfile networkProfile()

Returns:

the network profile settings for the cluster

addonProfiles

Map<String,ManagedClusterAddonProfile> addonProfiles()

Returns:

the cluster's add-on's profiles

nodeResourceGroup

String nodeResourceGroup()

Returns:

the name of the resource group containing agent pool nodes

enableRBAC

boolean enableRBAC()

Returns:

true if Kubernetes Role-Based Access Control is enabled

powerState

PowerState powerState()

Returns:

the power state

systemAssignedManagedServiceIdentityPrincipalId

String systemAssignedManagedServiceIdentityPrincipalId()

Returns:

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

start

void start()

Starts a stopped Kubernetes cluster.

startAsync

Mono<Void> startAsync()

Starts a stopped Kubernetes cluster.

Returns:

the completion.

stop

void stop()

Stops a running Kubernetes cluster.

stopAsync

Mono<Void> stopAsync()

Stops a running Kubernetes cluster.

Returns:

the completion.