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.

  • Method Details

    • provisioningState

      String provisioningState()
      Gets the provisioning state of the Kubernetes cluster.
      Returns:
      the provisioning state of the Kubernetes cluster

    • dnsPrefix

      String dnsPrefix()
      Gets the DNS prefix which was specified at creation time.
      Returns:
      the DNS prefix which was specified at creation time

    • fqdn

      String fqdn()
      Gets the FQDN for the master pool.
      Returns:
      the FQDN for the master pool

    • version

      String version()
      Gets the Kubernetes version.
      Returns:
      the Kubernetes version

    • adminKubeConfigContent

      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

    • userKubeConfigContent

      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

      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

    • adminKubeConfigs

      List<CredentialResult> adminKubeConfigs()
      Gets the Kubernetes credentials with administrative privileges to the cluster.
      Returns:
      the Kubernetes credentials with administrative privileges to the cluster

    • userKubeConfigs

      List<CredentialResult> userKubeConfigs()
      Gets the Kubernetes credentials with user-level privileges to the cluster.
      Returns:
      the Kubernetes credentials with user-level privileges to the cluster

    • userKubeConfigs

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

    • servicePrincipalClientId

      String servicePrincipalClientId()
      Gets the service principal client ID.
      Returns:
      the service principal client ID

    • servicePrincipalSecret

      String servicePrincipalSecret()
      Gets the service principal secret.
      Returns:
      the service principal secret

    • linuxRootUsername

      String linuxRootUsername()
      Gets the Linux root username.
      Returns:
      the Linux root username

    • sshKey

      String sshKey()
      Gets the Linux SSH key.
      Returns:
      the Linux SSH key

    • agentPools

      Map<String,KubernetesClusterAgentPool> agentPools()
      Gets the agent pools in the Kubernetes cluster.
      Returns:
      the agent pools in the Kubernetes cluster

    • networkProfile

      ContainerServiceNetworkProfile networkProfile()
      Gets the network profile settings for the cluster.
      Returns:
      the network profile settings for the cluster

    • addonProfiles

      Map<String,ManagedClusterAddonProfile> addonProfiles()
      Gets the cluster's add-on's profiles.
      Returns:
      the cluster's add-on's profiles

    • nodeResourceGroup

      String nodeResourceGroup()
      Gets the name of the resource group containing agent pool nodes.
      Returns:
      the name of the resource group containing agent pool nodes

    • enableRBAC

      boolean enableRBAC()
      Checks whether Kubernetes Role-Based Access Control is enabled.
      Returns:
      true if Kubernetes Role-Based Access Control is enabled

    • powerState

      PowerState powerState()
      Gets the power state.
      Returns:
      the power state

    • sku

      ManagedClusterSku sku()
      Gets the SKU of a Managed Cluster.
      Returns:
      the SKU of a Managed Cluster

    • systemAssignedManagedServiceIdentityPrincipalId

      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.

    • azureActiveDirectoryGroupIds

      List<String> 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.

    • isLocalAccountsEnabled

      boolean isLocalAccountsEnabled()
      Checks whether local accounts is enabled.
      Returns:
      whether local accounts is enabled.

    • isAzureRbacEnabled

      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.

    • diskEncryptionSetId

      String diskEncryptionSetId()
      Gets resource ID of the disk encryption set.
      Returns:
      resource ID of the disk encryption set.

    • agentPoolResourceGroup

      String agentPoolResourceGroup()
      Gets the resource group containing agent pool nodes.
      Returns:
      The resource group containing agent pool nodes.

    • publicNetworkAccess

      PublicNetworkAccess publicNetworkAccess()
      Checks whether the kubernetes cluster can be accessed from public network.
      Returns:
      whether the kubernetes cluster can be accessed from public network.

    • 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.

    • beginCreateAgentPool

      Accepted<AgentPool> 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