Package com.azure.resourcemanager.containerservice.models

Interface KubernetesClusters

All Superinterfaces:

HasManager<ContainerServiceManager>, SupportsBatchCreation<KubernetesCluster>, SupportsCreating<KubernetesCluster.DefinitionStages.Blank>, SupportsDeletingById, SupportsDeletingByResourceGroup, SupportsGettingById<KubernetesCluster>, SupportsGettingByResourceGroup<KubernetesCluster>, SupportsListing<KubernetesCluster>, SupportsListingByResourceGroup<KubernetesCluster>

public interface KubernetesClusters
extends HasManager<ContainerServiceManager>, SupportsCreating<KubernetesCluster.DefinitionStages.Blank>, SupportsBatchCreation<KubernetesCluster>, SupportsListing<KubernetesCluster>, SupportsGettingById<KubernetesCluster>, SupportsDeletingById, SupportsDeletingByResourceGroup, SupportsListingByResourceGroup<KubernetesCluster>, SupportsGettingByResourceGroup<KubernetesCluster>

Entry point to managed Kubernetes service management API.

Method Summary

Modifier and Type	Method	Description
List<CredentialResult>	listAdminKubeConfigContent(String resourceGroupName, String kubernetesClusterName)	Returns the admin Kube.config content which can be used with a Kubernetes client.
Mono<List<CredentialResult>>	listAdminKubeConfigContentAsync(String resourceGroupName, String kubernetesClusterName)	Returns asynchronously the admin Kube.config content which can be used with a Kubernetes client.
Set<String>	listKubernetesVersions(com.azure.core.management.Region region)	Returns the list of available Kubernetes versions available for the given Azure region.
Mono<Set<String>>	listKubernetesVersionsAsync(com.azure.core.management.Region region)	Returns the list of available Kubernetes versions available for the given Azure region.
com.azure.core.http.rest.PagedIterable<OrchestratorVersionProfile>	listOrchestrators(com.azure.core.management.Region region, ContainerServiceResourceTypes resourceTypes)	Returns the list of available orchestrators for the given Azure region.
com.azure.core.http.rest.PagedFlux<OrchestratorVersionProfile>	listOrchestratorsAsync(com.azure.core.management.Region region, ContainerServiceResourceTypes resourceTypes)	Returns the list of available orchestrators for the given Azure region.
List<CredentialResult>	listUserKubeConfigContent(String resourceGroupName, String kubernetesClusterName)	Returns the user Kube.config content which can be used with a Kubernetes client.
List<CredentialResult>	listUserKubeConfigContent(String resourceGroupName, String kubernetesClusterName, Format format)	Returns the user Kube.config content which can be used with a Kubernetes client.
Mono<List<CredentialResult>>	listUserKubeConfigContentAsync(String resourceGroupName, String kubernetesClusterName)	Returns asynchronously the user Kube.config content which can be used with a Kubernetes client.
Mono<List<CredentialResult>>	listUserKubeConfigContentAsync(String resourceGroupName, String kubernetesClusterName, Format format)	Returns asynchronously the user Kube.config content which can be used with a Kubernetes client.
void	start(String resourceGroupName, String kubernetesClusterName)	Starts a stopped Kubernetes cluster.
Mono<Void>	startAsync(String resourceGroupName, String kubernetesClusterName)	Starts a stopped Kubernetes cluster.
void	stop(String resourceGroupName, String kubernetesClusterName)	Stops a running Kubernetes cluster.
Mono<Void>	stopAsync(String resourceGroupName, String kubernetesClusterName)	Stops a running Kubernetes cluster.

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

manager

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

create, create, createAsync, createAsync

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

define

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

deleteById, deleteByIdAsync

Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.collection.SupportsDeletingByResourceGroup

deleteByResourceGroup, deleteByResourceGroupAsync

Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.collection.SupportsGettingById

getById, getByIdAsync

Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.collection.SupportsGettingByResourceGroup

getByResourceGroup, getByResourceGroupAsync

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

list, listAsync

Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.collection.SupportsListingByResourceGroup

listByResourceGroup, listByResourceGroupAsync

Method Detail

listKubernetesVersions

Set<String> listKubernetesVersions(com.azure.core.management.Region region)

Returns the list of available Kubernetes versions available for the given Azure region.

Parameters:

region - the Azure region to query into

Returns:

a set of Kubernetes versions which can be used when creating a service in this region

listKubernetesVersionsAsync

Mono<Set<String>> listKubernetesVersionsAsync(com.azure.core.management.Region region)

Returns the list of available Kubernetes versions available for the given Azure region.

Parameters:

region - the Azure region to query into

Returns:

a future representation of a set of Kubernetes versions which can be used when creating a service in this region

listOrchestrators

com.azure.core.http.rest.PagedIterable<OrchestratorVersionProfile> listOrchestrators(com.azure.core.management.Region region,
                                                                                     ContainerServiceResourceTypes resourceTypes)

Returns the list of available orchestrators for the given Azure region.

Parameters:

region - the Azure region to query into

resourceTypes - the resource type of container service

Returns:

a list of orchestrators which can be used when creating a service in this region

listOrchestratorsAsync

com.azure.core.http.rest.PagedFlux<OrchestratorVersionProfile> listOrchestratorsAsync(com.azure.core.management.Region region,
                                                                                      ContainerServiceResourceTypes resourceTypes)

Returns the list of available orchestrators for the given Azure region.

Parameters:

region - the Azure region to query into

resourceTypes - the resource type of container service

Returns:

a list of orchestrators which can be used when creating a service in this region

listAdminKubeConfigContent

List<CredentialResult> listAdminKubeConfigContent(String resourceGroupName,
                                                  String kubernetesClusterName)

Returns the admin Kube.config content which can be used with a Kubernetes client.

Parameters:

resourceGroupName - the resource group name where the cluster is

kubernetesClusterName - the managed cluster name

Returns:

the Kube.config content which can be used with a Kubernetes client

listAdminKubeConfigContentAsync

Mono<List<CredentialResult>> listAdminKubeConfigContentAsync(String resourceGroupName,
                                                             String kubernetesClusterName)

Returns asynchronously the admin Kube.config content which can be used with a Kubernetes client.

Parameters:

resourceGroupName - the resource group name where the cluster is

kubernetesClusterName - the managed cluster name

Returns:

a future representation of the Kube.config content which can be used with a Kubernetes client

listUserKubeConfigContent

List<CredentialResult> listUserKubeConfigContent(String resourceGroupName,
                                                 String kubernetesClusterName)

Returns the user Kube.config content which can be used with a Kubernetes client.

Parameters:

resourceGroupName - the resource group name where the cluster is

kubernetesClusterName - the managed cluster name

Returns:

the Kube.config content which can be used with a Kubernetes client

listUserKubeConfigContent

List<CredentialResult> listUserKubeConfigContent(String resourceGroupName,
                                                 String kubernetesClusterName,
                                                 Format format)

Returns the user Kube.config content which can be used with a Kubernetes client.

Parameters:

resourceGroupName - the resource group name where the cluster is

kubernetesClusterName - the managed cluster name

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 Kube.config content which can be used with a Kubernetes client

listUserKubeConfigContentAsync

Mono<List<CredentialResult>> listUserKubeConfigContentAsync(String resourceGroupName,
                                                            String kubernetesClusterName)

Returns asynchronously the user Kube.config content which can be used with a Kubernetes client.

Parameters:

resourceGroupName - the resource group name where the cluster is

kubernetesClusterName - the managed cluster name

Returns:

a future representation of the Kube.config content which can be used with a Kubernetes client

listUserKubeConfigContentAsync

Mono<List<CredentialResult>> listUserKubeConfigContentAsync(String resourceGroupName,
                                                            String kubernetesClusterName,
                                                            Format format)

Returns asynchronously the user Kube.config content which can be used with a Kubernetes client.

Parameters:

resourceGroupName - the resource group name where the cluster is

kubernetesClusterName - the managed cluster name

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:

a future representation of the Kube.config content which can be used with a Kubernetes client

start

void start(String resourceGroupName,
           String kubernetesClusterName)

Starts a stopped Kubernetes cluster.

Parameters:

resourceGroupName - The name of the resource group.

kubernetesClusterName - The name of the managed cluster resource.

startAsync

Mono<Void> startAsync(String resourceGroupName,
                      String kubernetesClusterName)

Starts a stopped Kubernetes cluster.

Parameters:

resourceGroupName - The name of the resource group.

kubernetesClusterName - The name of the managed cluster resource.

Returns:

the completion.

stop

void stop(String resourceGroupName,
          String kubernetesClusterName)

Stops a running Kubernetes cluster.

Parameters:

resourceGroupName - The name of the resource group.

kubernetesClusterName - The name of the managed cluster resource.

stopAsync

Mono<Void> stopAsync(String resourceGroupName,
                     String kubernetesClusterName)

Stops a running Kubernetes cluster.

Parameters:

resourceGroupName - The name of the resource group.

kubernetesClusterName - The name of the managed cluster resource.

Returns:

the completion.