Interface KubernetesCluster

All Superinterfaces:
com.azure.resourcemanager.resources.fluentcore.arm.models.GroupableResource<ContainerServiceManager, ManagedClusterInner>, com.azure.resourcemanager.resources.fluentcore.arm.models.HasId, com.azure.resourcemanager.resources.fluentcore.model.HasInnerModel<ManagedClusterInner>, com.azure.resourcemanager.resources.fluentcore.arm.models.HasManager<ContainerServiceManager>, com.azure.resourcemanager.resources.fluentcore.arm.models.HasName, com.azure.resourcemanager.resources.fluentcore.arm.models.HasResourceGroup, com.azure.resourcemanager.resources.fluentcore.model.Indexable, com.azure.resourcemanager.resources.fluentcore.model.Refreshable<KubernetesCluster>, com.azure.resourcemanager.resources.fluentcore.arm.models.Resource, com.azure.resourcemanager.resources.fluentcore.collection.SupportsListingPrivateEndpointConnection, com.azure.resourcemanager.resources.fluentcore.collection.SupportsListingPrivateLinkResource, com.azure.resourcemanager.resources.fluentcore.model.Updatable<KubernetesCluster.Update>
public interface KubernetesCluster extends com.azure.resourcemanager.resources.fluentcore.arm.models.GroupableResource<ContainerServiceManager, ManagedClusterInner>, com.azure.resourcemanager.resources.fluentcore.model.Refreshable<KubernetesCluster>, com.azure.resourcemanager.resources.fluentcore.model.Updatable<KubernetesCluster.Update>, com.azure.resourcemanager.resources.fluentcore.collection.SupportsListingPrivateLinkResource, com.azure.resourcemanager.resources.fluentcore.collection.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

    com.azure.resourcemanager.resources.fluentcore.arm.models.Resource.DefinitionWithRegion<T>, com.azure.resourcemanager.resources.fluentcore.arm.models.Resource.DefinitionWithTags<T>, com.azure.resourcemanager.resources.fluentcore.arm.models.Resource.UpdateWithTags<T>

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

      com.azure.resourcemanager.resources.fluentcore.model.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