Package com.azure.resourcemanager.kubernetesconfiguration.models

Interface FluxConfigurations

public interface FluxConfigurations

Resource collection API of FluxConfigurations.

Method Summary

Modifier and Type	Method	Description
FluxConfiguration	createOrUpdate(String resourceGroupName, String clusterRp, String clusterResourceName, String clusterName, String fluxConfigurationName, FluxConfigurationInner fluxConfiguration)	Create a new Kubernetes Flux Configuration.
FluxConfiguration	createOrUpdate(String resourceGroupName, String clusterRp, String clusterResourceName, String clusterName, String fluxConfigurationName, FluxConfigurationInner fluxConfiguration, com.azure.core.util.Context context)	Create a new Kubernetes Flux Configuration.
void	delete(String resourceGroupName, String clusterRp, String clusterResourceName, String clusterName, String fluxConfigurationName)	This will delete the YAML file used to set up the Flux Configuration, thus stopping future sync from the source repo.
void	delete(String resourceGroupName, String clusterRp, String clusterResourceName, String clusterName, String fluxConfigurationName, Boolean forceDelete)	This will delete the YAML file used to set up the Flux Configuration, thus stopping future sync from the source repo.
void	delete(String resourceGroupName, String clusterRp, String clusterResourceName, String clusterName, String fluxConfigurationName, Boolean forceDelete, com.azure.core.util.Context context)	This will delete the YAML file used to set up the Flux Configuration, thus stopping future sync from the source repo.
FluxConfiguration	get(String resourceGroupName, String clusterRp, String clusterResourceName, String clusterName, String fluxConfigurationName)	Gets details of the Flux Configuration.
com.azure.core.http.rest.Response<FluxConfiguration>	getWithResponse(String resourceGroupName, String clusterRp, String clusterResourceName, String clusterName, String fluxConfigurationName, com.azure.core.util.Context context)	Gets details of the Flux Configuration.
com.azure.core.http.rest.PagedIterable<FluxConfiguration>	list(String resourceGroupName, String clusterRp, String clusterResourceName, String clusterName)	List all Flux Configurations.
com.azure.core.http.rest.PagedIterable<FluxConfiguration>	list(String resourceGroupName, String clusterRp, String clusterResourceName, String clusterName, com.azure.core.util.Context context)	List all Flux Configurations.
FluxConfiguration	update(String resourceGroupName, String clusterRp, String clusterResourceName, String clusterName, String fluxConfigurationName, FluxConfigurationPatch fluxConfigurationPatch)	Update an existing Kubernetes Flux Configuration.
FluxConfiguration	update(String resourceGroupName, String clusterRp, String clusterResourceName, String clusterName, String fluxConfigurationName, FluxConfigurationPatch fluxConfigurationPatch, com.azure.core.util.Context context)	Update an existing Kubernetes Flux Configuration.

Method Detail

get

FluxConfiguration get(String resourceGroupName,
                      String clusterRp,
                      String clusterResourceName,
                      String clusterName,
                      String fluxConfigurationName)

Gets details of the Flux Configuration.

Parameters:

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

clusterRp - The Kubernetes cluster RP - i.e. Microsoft.ContainerService, Microsoft.Kubernetes, Microsoft.HybridContainerService.

clusterResourceName - The Kubernetes cluster resource name - i.e. managedClusters, connectedClusters, provisionedClusters.

clusterName - The name of the kubernetes cluster.

fluxConfigurationName - Name of the Flux Configuration.

Returns:

details of the Flux Configuration.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getWithResponse

com.azure.core.http.rest.Response<FluxConfiguration> getWithResponse(String resourceGroupName,
                                                                     String clusterRp,
                                                                     String clusterResourceName,
                                                                     String clusterName,
                                                                     String fluxConfigurationName,
                                                                     com.azure.core.util.Context context)

Gets details of the Flux Configuration.

Parameters:

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

clusterRp - The Kubernetes cluster RP - i.e. Microsoft.ContainerService, Microsoft.Kubernetes, Microsoft.HybridContainerService.

clusterResourceName - The Kubernetes cluster resource name - i.e. managedClusters, connectedClusters, provisionedClusters.

clusterName - The name of the kubernetes cluster.

fluxConfigurationName - Name of the Flux Configuration.

context - The context to associate with this operation.

Returns:

details of the Flux Configuration along with Response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

createOrUpdate

FluxConfiguration createOrUpdate(String resourceGroupName,
                                 String clusterRp,
                                 String clusterResourceName,
                                 String clusterName,
                                 String fluxConfigurationName,
                                 FluxConfigurationInner fluxConfiguration)

Create a new Kubernetes Flux Configuration.

Parameters:

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

clusterRp - The Kubernetes cluster RP - i.e. Microsoft.ContainerService, Microsoft.Kubernetes, Microsoft.HybridContainerService.

clusterResourceName - The Kubernetes cluster resource name - i.e. managedClusters, connectedClusters, provisionedClusters.

clusterName - The name of the kubernetes cluster.

fluxConfigurationName - Name of the Flux Configuration.

fluxConfiguration - Properties necessary to Create a FluxConfiguration.

Returns:

the Flux Configuration object returned in Get & Put response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

createOrUpdate

FluxConfiguration createOrUpdate(String resourceGroupName,
                                 String clusterRp,
                                 String clusterResourceName,
                                 String clusterName,
                                 String fluxConfigurationName,
                                 FluxConfigurationInner fluxConfiguration,
                                 com.azure.core.util.Context context)

Create a new Kubernetes Flux Configuration.

Parameters:

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

clusterRp - The Kubernetes cluster RP - i.e. Microsoft.ContainerService, Microsoft.Kubernetes, Microsoft.HybridContainerService.

clusterResourceName - The Kubernetes cluster resource name - i.e. managedClusters, connectedClusters, provisionedClusters.

clusterName - The name of the kubernetes cluster.

fluxConfigurationName - Name of the Flux Configuration.

fluxConfiguration - Properties necessary to Create a FluxConfiguration.

context - The context to associate with this operation.

Returns:

the Flux Configuration object returned in Get & Put response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

update

FluxConfiguration update(String resourceGroupName,
                         String clusterRp,
                         String clusterResourceName,
                         String clusterName,
                         String fluxConfigurationName,
                         FluxConfigurationPatch fluxConfigurationPatch)

Update an existing Kubernetes Flux Configuration.

Parameters:

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

clusterRp - The Kubernetes cluster RP - i.e. Microsoft.ContainerService, Microsoft.Kubernetes, Microsoft.HybridContainerService.

clusterResourceName - The Kubernetes cluster resource name - i.e. managedClusters, connectedClusters, provisionedClusters.

clusterName - The name of the kubernetes cluster.

fluxConfigurationName - Name of the Flux Configuration.

fluxConfigurationPatch - Properties to Patch in an existing Flux Configuration.

Returns:

the Flux Configuration object returned in Get & Put response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

update

FluxConfiguration update(String resourceGroupName,
                         String clusterRp,
                         String clusterResourceName,
                         String clusterName,
                         String fluxConfigurationName,
                         FluxConfigurationPatch fluxConfigurationPatch,
                         com.azure.core.util.Context context)

Update an existing Kubernetes Flux Configuration.

Parameters:

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

clusterRp - The Kubernetes cluster RP - i.e. Microsoft.ContainerService, Microsoft.Kubernetes, Microsoft.HybridContainerService.

clusterResourceName - The Kubernetes cluster resource name - i.e. managedClusters, connectedClusters, provisionedClusters.

clusterName - The name of the kubernetes cluster.

fluxConfigurationName - Name of the Flux Configuration.

fluxConfigurationPatch - Properties to Patch in an existing Flux Configuration.

context - The context to associate with this operation.

Returns:

the Flux Configuration object returned in Get & Put response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

delete

void delete(String resourceGroupName,
            String clusterRp,
            String clusterResourceName,
            String clusterName,
            String fluxConfigurationName,
            Boolean forceDelete)

This will delete the YAML file used to set up the Flux Configuration, thus stopping future sync from the source repo.

Parameters:

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

clusterRp - The Kubernetes cluster RP - i.e. Microsoft.ContainerService, Microsoft.Kubernetes, Microsoft.HybridContainerService.

clusterResourceName - The Kubernetes cluster resource name - i.e. managedClusters, connectedClusters, provisionedClusters.

clusterName - The name of the kubernetes cluster.

fluxConfigurationName - Name of the Flux Configuration.

forceDelete - Delete the extension resource in Azure - not the normal asynchronous delete.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

delete

void delete(String resourceGroupName,
            String clusterRp,
            String clusterResourceName,
            String clusterName,
            String fluxConfigurationName)

This will delete the YAML file used to set up the Flux Configuration, thus stopping future sync from the source repo.

Parameters:

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

clusterRp - The Kubernetes cluster RP - i.e. Microsoft.ContainerService, Microsoft.Kubernetes, Microsoft.HybridContainerService.

clusterResourceName - The Kubernetes cluster resource name - i.e. managedClusters, connectedClusters, provisionedClusters.

clusterName - The name of the kubernetes cluster.

fluxConfigurationName - Name of the Flux Configuration.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

delete

void delete(String resourceGroupName,
            String clusterRp,
            String clusterResourceName,
            String clusterName,
            String fluxConfigurationName,
            Boolean forceDelete,
            com.azure.core.util.Context context)

This will delete the YAML file used to set up the Flux Configuration, thus stopping future sync from the source repo.

Parameters:

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

clusterRp - The Kubernetes cluster RP - i.e. Microsoft.ContainerService, Microsoft.Kubernetes, Microsoft.HybridContainerService.

clusterResourceName - The Kubernetes cluster resource name - i.e. managedClusters, connectedClusters, provisionedClusters.

clusterName - The name of the kubernetes cluster.

fluxConfigurationName - Name of the Flux Configuration.

forceDelete - Delete the extension resource in Azure - not the normal asynchronous delete.

context - The context to associate with this operation.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

list

com.azure.core.http.rest.PagedIterable<FluxConfiguration> list(String resourceGroupName,
                                                               String clusterRp,
                                                               String clusterResourceName,
                                                               String clusterName)

List all Flux Configurations.

Parameters:

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

clusterRp - The Kubernetes cluster RP - i.e. Microsoft.ContainerService, Microsoft.Kubernetes, Microsoft.HybridContainerService.

clusterResourceName - The Kubernetes cluster resource name - i.e. managedClusters, connectedClusters, provisionedClusters.

clusterName - The name of the kubernetes cluster.

Returns:

result of the request to list Flux Configurations as paginated response with PagedIterable.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

list

com.azure.core.http.rest.PagedIterable<FluxConfiguration> list(String resourceGroupName,
                                                               String clusterRp,
                                                               String clusterResourceName,
                                                               String clusterName,
                                                               com.azure.core.util.Context context)

List all Flux Configurations.

Parameters:

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

clusterRp - The Kubernetes cluster RP - i.e. Microsoft.ContainerService, Microsoft.Kubernetes, Microsoft.HybridContainerService.

clusterResourceName - The Kubernetes cluster resource name - i.e. managedClusters, connectedClusters, provisionedClusters.

clusterName - The name of the kubernetes cluster.

context - The context to associate with this operation.

Returns:

result of the request to list Flux Configurations as paginated response with PagedIterable.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.