OpenShiftClusters Interface

Package:
com.azure.resourcemanager.redhatopenshift.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-redhatopenshift:1.0.0

public interface OpenShiftClusters

Resource collection API of OpenShiftClusters.

Method Summary

Modifier and Type Method and Description
abstract Blank define(String name)

Begins definition for a new OpenShiftCluster resource.
abstract void delete(String resourceGroupName, String resourceName, Context context)

Deletes a OpenShift cluster with the specified subscription, resource group and resource name.
abstract void deleteById(String id)

Deletes a OpenShift cluster with the specified subscription, resource group and resource name.
abstract void deleteByIdWithResponse(String id, Context context)

Deletes a OpenShift cluster with the specified subscription, resource group and resource name.
abstract void deleteByResourceGroup(String resourceGroupName, String resourceName)

Deletes a OpenShift cluster with the specified subscription, resource group and resource name.
abstract OpenShiftCluster getById(String id)

Gets a OpenShift cluster with the specified subscription, resource group and resource name.
abstract Response<OpenShiftCluster> getByIdWithResponse(String id, Context context)

Gets a OpenShift cluster with the specified subscription, resource group and resource name.
abstract OpenShiftCluster getByResourceGroup(String resourceGroupName, String resourceName)

Gets a OpenShift cluster with the specified subscription, resource group and resource name.
abstract Response<OpenShiftCluster> getByResourceGroupWithResponse(String resourceGroupName, String resourceName, Context context)

Gets a OpenShift cluster with the specified subscription, resource group and resource name.
abstract PagedIterable<OpenShiftCluster> list()

Lists OpenShift clusters in the specified subscription.
abstract PagedIterable<OpenShiftCluster> list(Context context)

Lists OpenShift clusters in the specified subscription.
abstract OpenShiftClusterAdminKubeconfig listAdminCredentials(String resourceGroupName, String resourceName)

Lists admin kubeconfig of an OpenShift cluster with the specified subscription, resource group and resource name.
abstract Response<OpenShiftClusterAdminKubeconfig> listAdminCredentialsWithResponse(String resourceGroupName, String resourceName, Context context)

Lists admin kubeconfig of an OpenShift cluster with the specified subscription, resource group and resource name.
abstract PagedIterable<OpenShiftCluster> listByResourceGroup(String resourceGroupName)

Lists OpenShift clusters in the specified subscription and resource group.
abstract PagedIterable<OpenShiftCluster> listByResourceGroup(String resourceGroupName, Context context)

Lists OpenShift clusters in the specified subscription and resource group.
abstract OpenShiftClusterCredentials listCredentials(String resourceGroupName, String resourceName)

Lists credentials of an OpenShift cluster with the specified subscription, resource group and resource name.
abstract Response<OpenShiftClusterCredentials> listCredentialsWithResponse(String resourceGroupName, String resourceName, Context context)

Lists credentials of an OpenShift cluster with the specified subscription, resource group and resource name.

Method Details

define

public abstract OpenShiftCluster.DefinitionStages.Blank define(String name)

Begins definition for a new OpenShiftCluster resource.

Parameters:

name - resource name.

Returns:

the first stage of the new OpenShiftCluster definition.

delete

public abstract void delete(String resourceGroupName, String resourceName, Context context)

Deletes a OpenShift cluster with the specified subscription, resource group and resource name. The operation returns nothing.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
resourceName - The name of the OpenShift cluster resource.
context - The context to associate with this operation.

deleteById

public abstract void deleteById(String id)

Deletes a OpenShift cluster with the specified subscription, resource group and resource name. The operation returns nothing.

Parameters:

id - the resource ID.

deleteByIdWithResponse

public abstract void deleteByIdWithResponse(String id, Context context)

Deletes a OpenShift cluster with the specified subscription, resource group and resource name. The operation returns nothing.

Parameters:

id - the resource ID.
context - The context to associate with this operation.

deleteByResourceGroup

public abstract void deleteByResourceGroup(String resourceGroupName, String resourceName)

Deletes a OpenShift cluster with the specified subscription, resource group and resource name. The operation returns nothing.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
resourceName - The name of the OpenShift cluster resource.

getById

public abstract OpenShiftCluster getById(String id)

Gets a OpenShift cluster with the specified subscription, resource group and resource name. The operation returns properties of a OpenShift cluster.

Parameters:

id - the resource ID.

Returns:

a OpenShift cluster with the specified subscription, resource group and resource name. The operation returns properties of a OpenShift cluster along with Response<T>.

getByIdWithResponse

public abstract Response<OpenShiftCluster> getByIdWithResponse(String id, Context context)

Gets a OpenShift cluster with the specified subscription, resource group and resource name. The operation returns properties of a OpenShift cluster.

Parameters:

id - the resource ID.
context - The context to associate with this operation.

Returns:

a OpenShift cluster with the specified subscription, resource group and resource name. The operation returns properties of a OpenShift cluster along with Response<T>.

getByResourceGroup

public abstract OpenShiftCluster getByResourceGroup(String resourceGroupName, String resourceName)

Gets a OpenShift cluster with the specified subscription, resource group and resource name. The operation returns properties of a OpenShift cluster.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
resourceName - The name of the OpenShift cluster resource.

Returns:

a OpenShift cluster with the specified subscription, resource group and resource name. The operation returns properties of a OpenShift cluster.

getByResourceGroupWithResponse

public abstract Response<OpenShiftCluster> getByResourceGroupWithResponse(String resourceGroupName, String resourceName, Context context)

Gets a OpenShift cluster with the specified subscription, resource group and resource name. The operation returns properties of a OpenShift cluster.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
resourceName - The name of the OpenShift cluster resource.
context - The context to associate with this operation.

Returns:

a OpenShift cluster with the specified subscription, resource group and resource name. The operation returns properties of a OpenShift cluster along with Response<T>.

list

public abstract PagedIterable<OpenShiftCluster> list()

Lists OpenShift clusters in the specified subscription. The operation returns properties of each OpenShift cluster.

Returns:

openShiftClusterList represents a list of OpenShift clusters as paginated response with PagedIterable<T>.

list

public abstract PagedIterable<OpenShiftCluster> list(Context context)

Lists OpenShift clusters in the specified subscription. The operation returns properties of each OpenShift cluster.

Parameters:

context - The context to associate with this operation.

Returns:

openShiftClusterList represents a list of OpenShift clusters as paginated response with PagedIterable<T>.

listAdminCredentials

public abstract OpenShiftClusterAdminKubeconfig listAdminCredentials(String resourceGroupName, String resourceName)

Lists admin kubeconfig of an OpenShift cluster with the specified subscription, resource group and resource name. The operation returns the admin kubeconfig.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
resourceName - The name of the OpenShift cluster resource.

Returns:

openShiftClusterAdminKubeconfig represents an OpenShift cluster's admin kubeconfig.

listAdminCredentialsWithResponse

public abstract Response<OpenShiftClusterAdminKubeconfig> listAdminCredentialsWithResponse(String resourceGroupName, String resourceName, Context context)

Lists admin kubeconfig of an OpenShift cluster with the specified subscription, resource group and resource name. The operation returns the admin kubeconfig.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
resourceName - The name of the OpenShift cluster resource.
context - The context to associate with this operation.

Returns:

openShiftClusterAdminKubeconfig represents an OpenShift cluster's admin kubeconfig along with Response<T>.

listByResourceGroup

public abstract PagedIterable<OpenShiftCluster> listByResourceGroup(String resourceGroupName)

Lists OpenShift clusters in the specified subscription and resource group. The operation returns properties of each OpenShift cluster.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

Returns:

openShiftClusterList represents a list of OpenShift clusters as paginated response with PagedIterable<T>.

listByResourceGroup

public abstract PagedIterable<OpenShiftCluster> listByResourceGroup(String resourceGroupName, Context context)

Lists OpenShift clusters in the specified subscription and resource group. The operation returns properties of each OpenShift cluster.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
context - The context to associate with this operation.

Returns:

openShiftClusterList represents a list of OpenShift clusters as paginated response with PagedIterable<T>.

listCredentials

public abstract OpenShiftClusterCredentials listCredentials(String resourceGroupName, String resourceName)

Lists credentials of an OpenShift cluster with the specified subscription, resource group and resource name. The operation returns the credentials.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
resourceName - The name of the OpenShift cluster resource.

Returns:

openShiftClusterCredentials represents an OpenShift cluster's credentials.

listCredentialsWithResponse

public abstract Response<OpenShiftClusterCredentials> listCredentialsWithResponse(String resourceGroupName, String resourceName, Context context)

Lists credentials of an OpenShift cluster with the specified subscription, resource group and resource name. The operation returns the credentials.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
resourceName - The name of the OpenShift cluster resource.
context - The context to associate with this operation.

Returns:

openShiftClusterCredentials represents an OpenShift cluster's credentials along with Response<T>.

Applies to