FluxConfigurations interface

Package:

@azure/arm-kubernetesconfiguration

Interface representing a FluxConfigurations.

Methods

beginCreateOrUpdate(string, string, string, string, string, FluxConfiguration, FluxConfigurationsCreateOrUpdateOptionalParams)	Create a new Kubernetes Flux Configuration.
beginCreateOrUpdateAndWait(string, string, string, string, string, FluxConfiguration, FluxConfigurationsCreateOrUpdateOptionalParams)	Create a new Kubernetes Flux Configuration.
beginDelete(string, string, string, string, string, FluxConfigurationsDeleteOptionalParams)	This will delete the YAML file used to set up the Flux Configuration, thus stopping future sync from the source repo.
beginDeleteAndWait(string, string, string, string, string, FluxConfigurationsDeleteOptionalParams)	This will delete the YAML file used to set up the Flux Configuration, thus stopping future sync from the source repo.
beginUpdate(string, string, string, string, string, FluxConfigurationPatch, FluxConfigurationsUpdateOptionalParams)	Update an existing Kubernetes Flux Configuration.
beginUpdateAndWait(string, string, string, string, string, FluxConfigurationPatch, FluxConfigurationsUpdateOptionalParams)	Update an existing Kubernetes Flux Configuration.
get(string, string, string, string, string, FluxConfigurationsGetOptionalParams)	Gets details of the Flux Configuration.
list(string, string, string, string, FluxConfigurationsListOptionalParams)	List all Flux Configurations.

Method Details

beginCreateOrUpdate(string, string, string, string, string, FluxConfiguration, FluxConfigurationsCreateOrUpdateOptionalParams)

Create a new Kubernetes Flux Configuration.

function beginCreateOrUpdate(resourceGroupName: string, clusterRp: string, clusterResourceName: string, clusterName: string, fluxConfigurationName: string, fluxConfiguration: FluxConfiguration, options?: FluxConfigurationsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<FluxConfiguration>, FluxConfiguration>>

Parameters

resourceGroupName

string

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

clusterRp

string

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

clusterResourceName

string

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

clusterName

string

The name of the kubernetes cluster.

fluxConfigurationName

string

Name of the Flux Configuration.

fluxConfiguration

FluxConfiguration

Properties necessary to Create a FluxConfiguration.

options

FluxConfigurationsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<FluxConfiguration>, FluxConfiguration>>

beginCreateOrUpdateAndWait(string, string, string, string, string, FluxConfiguration, FluxConfigurationsCreateOrUpdateOptionalParams)

Create a new Kubernetes Flux Configuration.

function beginCreateOrUpdateAndWait(resourceGroupName: string, clusterRp: string, clusterResourceName: string, clusterName: string, fluxConfigurationName: string, fluxConfiguration: FluxConfiguration, options?: FluxConfigurationsCreateOrUpdateOptionalParams): Promise<FluxConfiguration>

Parameters

resourceGroupName

string

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

clusterRp

string

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

clusterResourceName

string

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

clusterName

string

The name of the kubernetes cluster.

fluxConfigurationName

string

Name of the Flux Configuration.

fluxConfiguration

FluxConfiguration

Properties necessary to Create a FluxConfiguration.

options

FluxConfigurationsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<FluxConfiguration>

beginDelete(string, string, string, string, string, FluxConfigurationsDeleteOptionalParams)

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

function beginDelete(resourceGroupName: string, clusterRp: string, clusterResourceName: string, clusterName: string, fluxConfigurationName: string, options?: FluxConfigurationsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

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

clusterRp

string

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

clusterResourceName

string

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

clusterName

string

The name of the kubernetes cluster.

fluxConfigurationName

string

Name of the Flux Configuration.

options

FluxConfigurationsDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, string, string, string, FluxConfigurationsDeleteOptionalParams)

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

function beginDeleteAndWait(resourceGroupName: string, clusterRp: string, clusterResourceName: string, clusterName: string, fluxConfigurationName: string, options?: FluxConfigurationsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

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

clusterRp

string

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

clusterResourceName

string

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

clusterName

string

The name of the kubernetes cluster.

fluxConfigurationName

string

Name of the Flux Configuration.

options

FluxConfigurationsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginUpdate(string, string, string, string, string, FluxConfigurationPatch, FluxConfigurationsUpdateOptionalParams)

Update an existing Kubernetes Flux Configuration.

function beginUpdate(resourceGroupName: string, clusterRp: string, clusterResourceName: string, clusterName: string, fluxConfigurationName: string, fluxConfigurationPatch: FluxConfigurationPatch, options?: FluxConfigurationsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<FluxConfiguration>, FluxConfiguration>>

Parameters

resourceGroupName

string

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

clusterRp

string

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

clusterResourceName

string

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

clusterName

string

The name of the kubernetes cluster.

fluxConfigurationName

string

Name of the Flux Configuration.

fluxConfigurationPatch

FluxConfigurationPatch

Properties to Patch in an existing Flux Configuration.

options

FluxConfigurationsUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<FluxConfiguration>, FluxConfiguration>>

beginUpdateAndWait(string, string, string, string, string, FluxConfigurationPatch, FluxConfigurationsUpdateOptionalParams)

Update an existing Kubernetes Flux Configuration.

function beginUpdateAndWait(resourceGroupName: string, clusterRp: string, clusterResourceName: string, clusterName: string, fluxConfigurationName: string, fluxConfigurationPatch: FluxConfigurationPatch, options?: FluxConfigurationsUpdateOptionalParams): Promise<FluxConfiguration>

Parameters

resourceGroupName

string

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

clusterRp

string

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

clusterResourceName

string

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

clusterName

string

The name of the kubernetes cluster.

fluxConfigurationName

string

Name of the Flux Configuration.

fluxConfigurationPatch

FluxConfigurationPatch

Properties to Patch in an existing Flux Configuration.

options

FluxConfigurationsUpdateOptionalParams

The options parameters.

Returns

Promise<FluxConfiguration>

get(string, string, string, string, string, FluxConfigurationsGetOptionalParams)

Gets details of the Flux Configuration.

function get(resourceGroupName: string, clusterRp: string, clusterResourceName: string, clusterName: string, fluxConfigurationName: string, options?: FluxConfigurationsGetOptionalParams): Promise<FluxConfiguration>

Parameters

resourceGroupName

string

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

clusterRp

string

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

clusterResourceName

string

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

clusterName

string

The name of the kubernetes cluster.

fluxConfigurationName

string

Name of the Flux Configuration.

options

FluxConfigurationsGetOptionalParams

The options parameters.

Returns

Promise<FluxConfiguration>

list(string, string, string, string, FluxConfigurationsListOptionalParams)

List all Flux Configurations.

function list(resourceGroupName: string, clusterRp: string, clusterResourceName: string, clusterName: string, options?: FluxConfigurationsListOptionalParams): PagedAsyncIterableIterator<FluxConfiguration, FluxConfiguration[], PageSettings>

Parameters

resourceGroupName

string

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

clusterRp

string

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

clusterResourceName

string

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

clusterName

string

The name of the kubernetes cluster.

options

FluxConfigurationsListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<FluxConfiguration, FluxConfiguration[], PageSettings>