• Home
• com.azure.resourcemanager
• azure-resourcemanager-hybridkubernetes
• 1.0.0
• source code
• ConnectedClusters.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.azure.resourcemanager.hybridkubernetes.models.ConnectedClusters Maven / Gradle / Ivy

// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
// Code generated by Microsoft (R) AutoRest Code Generator.

package com.azure.resourcemanager.hybridkubernetes.models;

import com.azure.core.http.rest.PagedIterable;
import com.azure.core.http.rest.Response;
import com.azure.core.util.Context;

/**
 * Resource collection API of ConnectedClusters.
 */
public interface ConnectedClusters {
    /**
     * Get the properties of the specified connected cluster.
     * 
     * Returns the properties of the specified connected cluster, including name, identity, properties, and additional
     * cluster details.
     * 
     * @param resourceGroupName The name of the resource group. The name is case insensitive.
     * @param clusterName The name of the Kubernetes cluster on which get is called.
     * @param context The context to associate with this operation.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     * @return represents a connected cluster along with {@link Response}.
     */
    Response getByResourceGroupWithResponse(String resourceGroupName, String clusterName,
        Context context);

    /**
     * Get the properties of the specified connected cluster.
     * 
     * Returns the properties of the specified connected cluster, including name, identity, properties, and additional
     * cluster details.
     * 
     * @param resourceGroupName The name of the resource group. The name is case insensitive.
     * @param clusterName The name of the Kubernetes cluster on which get is called.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     * @return represents a connected cluster.
     */
    ConnectedCluster getByResourceGroup(String resourceGroupName, String clusterName);

    /**
     * Delete a connected cluster.
     * 
     * Delete a connected cluster, removing the tracked resource in Azure Resource Manager (ARM).
     * 
     * @param resourceGroupName The name of the resource group. The name is case insensitive.
     * @param clusterName The name of the Kubernetes cluster on which get is called.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     */
    void deleteByResourceGroup(String resourceGroupName, String clusterName);

    /**
     * Delete a connected cluster.
     * 
     * Delete a connected cluster, removing the tracked resource in Azure Resource Manager (ARM).
     * 
     * @param resourceGroupName The name of the resource group. The name is case insensitive.
     * @param clusterName The name of the Kubernetes cluster on which get is called.
     * @param context The context to associate with this operation.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     */
    void delete(String resourceGroupName, String clusterName, Context context);

    /**
     * Gets cluster user credentials of a connected cluster
     * 
     * Gets cluster user credentials of the connected cluster with a specified resource group and name.
     * 
     * @param resourceGroupName The name of the resource group. The name is case insensitive.
     * @param clusterName The name of the Kubernetes cluster on which get is called.
     * @param properties ListClusterUserCredential properties.
     * @param context The context to associate with this operation.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     * @return cluster user credentials of the connected cluster with a specified resource group and name along with
     * {@link Response}.
     */
    Response listClusterUserCredentialWithResponse(String resourceGroupName, String clusterName,
        ListClusterUserCredentialProperties properties, Context context);

    /**
     * Gets cluster user credentials of a connected cluster
     * 
     * Gets cluster user credentials of the connected cluster with a specified resource group and name.
     * 
     * @param resourceGroupName The name of the resource group. The name is case insensitive.
     * @param clusterName The name of the Kubernetes cluster on which get is called.
     * @param properties ListClusterUserCredential properties.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     * @return cluster user credentials of the connected cluster with a specified resource group and name.
     */
    CredentialResults listClusterUserCredential(String resourceGroupName, String clusterName,
        ListClusterUserCredentialProperties properties);

    /**
     * Lists all connected clusters
     * 
     * API to enumerate registered connected K8s clusters under a Resource Group.
     * 
     * @param resourceGroupName The name of the resource group. The name is case insensitive.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     * @return the paginated list of connected Clusters as paginated response with {@link PagedIterable}.
     */
    PagedIterable listByResourceGroup(String resourceGroupName);

    /**
     * Lists all connected clusters
     * 
     * API to enumerate registered connected K8s clusters under a Resource Group.
     * 
     * @param resourceGroupName The name of the resource group. The name is case insensitive.
     * @param context The context to associate with this operation.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     * @return the paginated list of connected Clusters as paginated response with {@link PagedIterable}.
     */
    PagedIterable listByResourceGroup(String resourceGroupName, Context context);

    /**
     * Lists all connected clusters
     * 
     * API to enumerate registered connected K8s clusters under a Subscription.
     * 
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     * @return the paginated list of connected Clusters as paginated response with {@link PagedIterable}.
     */
    PagedIterable list();

    /**
     * Lists all connected clusters
     * 
     * API to enumerate registered connected K8s clusters under a Subscription.
     * 
     * @param context The context to associate with this operation.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     * @return the paginated list of connected Clusters as paginated response with {@link PagedIterable}.
     */
    PagedIterable list(Context context);

    /**
     * Get the properties of the specified connected cluster.
     * 
     * Returns the properties of the specified connected cluster, including name, identity, properties, and additional
     * cluster details.
     * 
     * @param id the resource ID.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     * @return represents a connected cluster along with {@link Response}.
     */
    ConnectedCluster getById(String id);

    /**
     * Get the properties of the specified connected cluster.
     * 
     * Returns the properties of the specified connected cluster, including name, identity, properties, and additional
     * cluster details.
     * 
     * @param id the resource ID.
     * @param context The context to associate with this operation.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     * @return represents a connected cluster along with {@link Response}.
     */
    Response getByIdWithResponse(String id, Context context);

    /**
     * Delete a connected cluster.
     * 
     * Delete a connected cluster, removing the tracked resource in Azure Resource Manager (ARM).
     * 
     * @param id the resource ID.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     */
    void deleteById(String id);

    /**
     * Delete a connected cluster.
     * 
     * Delete a connected cluster, removing the tracked resource in Azure Resource Manager (ARM).
     * 
     * @param id the resource ID.
     * @param context The context to associate with this operation.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     */
    void deleteByIdWithResponse(String id, Context context);

    /**
     * Begins definition for a new ConnectedCluster resource.
     * 
     * @param name resource name.
     * @return the first stage of the new ConnectedCluster definition.
     */
    ConnectedCluster.DefinitionStages.Blank define(String name);
}