Package version:

Interface FluxConfigurations

Interface representing a FluxConfigurations.

interface FluxConfigurations {
    beginCreateOrUpdate(resourceGroupName: string, clusterRp: string, clusterResourceName: string, clusterName: string, fluxConfigurationName: string, fluxConfiguration: FluxConfiguration, options?: FluxConfigurationsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<FluxConfiguration>, FluxConfiguration>>;
    beginCreateOrUpdateAndWait(resourceGroupName: string, clusterRp: string, clusterResourceName: string, clusterName: string, fluxConfigurationName: string, fluxConfiguration: FluxConfiguration, options?: FluxConfigurationsCreateOrUpdateOptionalParams): Promise<FluxConfiguration>;
    beginDelete(resourceGroupName: string, clusterRp: string, clusterResourceName: string, clusterName: string, fluxConfigurationName: string, options?: FluxConfigurationsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
    beginDeleteAndWait(resourceGroupName: string, clusterRp: string, clusterResourceName: string, clusterName: string, fluxConfigurationName: string, options?: FluxConfigurationsDeleteOptionalParams): Promise<void>;
    beginUpdate(resourceGroupName: string, clusterRp: string, clusterResourceName: string, clusterName: string, fluxConfigurationName: string, fluxConfigurationPatch: FluxConfigurationPatch, options?: FluxConfigurationsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<FluxConfiguration>, FluxConfiguration>>;
    beginUpdateAndWait(resourceGroupName: string, clusterRp: string, clusterResourceName: string, clusterName: string, fluxConfigurationName: string, fluxConfigurationPatch: FluxConfigurationPatch, options?: FluxConfigurationsUpdateOptionalParams): Promise<FluxConfiguration>;
    get(resourceGroupName: string, clusterRp: string, clusterResourceName: string, clusterName: string, fluxConfigurationName: string, options?: FluxConfigurationsGetOptionalParams): Promise<FluxConfiguration>;
    list(resourceGroupName: string, clusterRp: string, clusterResourceName: string, clusterName: string, options?: FluxConfigurationsListOptionalParams): PagedAsyncIterableIterator<FluxConfiguration>;
}

Methods

beginCreateOrUpdate beginCreateOrUpdateAndWait beginDelete beginDeleteAndWait beginUpdate beginUpdateAndWait get list

Methods

beginCreateOrUpdate

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

  • Create a new Kubernetes Flux Configuration.

    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, appliances.

    • clusterName: string

      The name of the kubernetes cluster.

    • fluxConfigurationName: string

      Name of the Flux Configuration.

    • fluxConfiguration: FluxConfiguration

      Properties necessary to Create a FluxConfiguration.

    • Optionaloptions: FluxConfigurationsCreateOrUpdateOptionalParams

      The options parameters.

    Returns Promise<SimplePollerLike<OperationState<FluxConfiguration>, FluxConfiguration>>

beginCreateOrUpdateAndWait

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

  • Create a new Kubernetes Flux Configuration.

    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, appliances.

    • clusterName: string

      The name of the kubernetes cluster.

    • fluxConfigurationName: string

      Name of the Flux Configuration.

    • fluxConfiguration: FluxConfiguration

      Properties necessary to Create a FluxConfiguration.

    • Optionaloptions: FluxConfigurationsCreateOrUpdateOptionalParams

      The options parameters.

    Returns Promise<FluxConfiguration>

beginDelete

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

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

    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, appliances.

    • clusterName: string

      The name of the kubernetes cluster.

    • fluxConfigurationName: string

      Name of the Flux Configuration.

    • Optionaloptions: FluxConfigurationsDeleteOptionalParams

      The options parameters.

    Returns Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

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

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

    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, appliances.

    • clusterName: string

      The name of the kubernetes cluster.

    • fluxConfigurationName: string

      Name of the Flux Configuration.

    • Optionaloptions: FluxConfigurationsDeleteOptionalParams

      The options parameters.

    Returns Promise<void>

beginUpdate

  • beginUpdate(resourceGroupName, clusterRp, clusterResourceName, clusterName, fluxConfigurationName, fluxConfigurationPatch, options?): Promise<SimplePollerLike<OperationState<FluxConfiguration>, FluxConfiguration>>

  • Update an existing Kubernetes Flux Configuration.

    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, appliances.

    • 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.

    • Optionaloptions: FluxConfigurationsUpdateOptionalParams

      The options parameters.

    Returns Promise<SimplePollerLike<OperationState<FluxConfiguration>, FluxConfiguration>>

beginUpdateAndWait

  • beginUpdateAndWait(resourceGroupName, clusterRp, clusterResourceName, clusterName, fluxConfigurationName, fluxConfigurationPatch, options?): Promise<FluxConfiguration>

  • Update an existing Kubernetes Flux Configuration.

    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, appliances.

    • 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.

    • Optionaloptions: FluxConfigurationsUpdateOptionalParams

      The options parameters.

    Returns Promise<FluxConfiguration>

get

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

  • Gets details of the Flux Configuration.

    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, appliances.

    • clusterName: string

      The name of the kubernetes cluster.

    • fluxConfigurationName: string

      Name of the Flux Configuration.

    • Optionaloptions: FluxConfigurationsGetOptionalParams

      The options parameters.

    Returns Promise<FluxConfiguration>

list

  • list(resourceGroupName, clusterRp, clusterResourceName, clusterName, options?): PagedAsyncIterableIterator<FluxConfiguration>

  • List all Flux Configurations.

    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, appliances.

    • clusterName: string

      The name of the kubernetes cluster.

    • Optionaloptions: FluxConfigurationsListOptionalParams

      The options parameters.

    Returns PagedAsyncIterableIterator<FluxConfiguration>

Settings

Member Visibility