flux_configurations

Creates, updates, deletes, gets or lists a flux_configurations resource.

Overview

Name	flux_configurations
Type	Resource
Id	azure.kubernetes_configuration.flux_configurations

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
properties	object	Properties to create a Flux Configuration resource
systemData	object	Top level metadata https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-contracts.md#system-metadata-for-all-azure-resources

list

Name	Datatype	Description
properties	object	Properties to create a Flux Configuration resource
systemData	object	Top level metadata https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-contracts.md#system-metadata-for-all-azure-resources

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, clusterRp, clusterResourceName, clusterName, fluxConfigurationName		Gets details of the Flux Configuration.
list	select	subscriptionId, resourceGroupName, clusterRp, clusterResourceName, clusterName		List all Flux Configurations.
create_or_update	insert	subscriptionId, resourceGroupName, clusterRp, clusterResourceName, clusterName, fluxConfigurationName		Create a new Kubernetes Flux Configuration.
update	update	subscriptionId, resourceGroupName, clusterRp, clusterResourceName, clusterName, fluxConfigurationName		Update an existing Kubernetes Flux Configuration.
delete	delete	subscriptionId, resourceGroupName, clusterRp, clusterResourceName, clusterName, fluxConfigurationName	forceDelete	This will delete the YAML file used to set up the Flux Configuration, thus stopping future sync from the source repo.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
clusterName	string	The name of the kubernetes cluster.
clusterResourceName	string	The Kubernetes cluster resource name - i.e. managedClusters, connectedClusters, provisionedClusters.
clusterRp	string	The Kubernetes cluster RP - i.e. Microsoft.ContainerService, Microsoft.Kubernetes, Microsoft.HybridContainerService.
fluxConfigurationName	string	Name of the Flux Configuration.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.
forceDelete	boolean	Delete the extension resource in Azure - not the normal asynchronous delete.

SELECT examples

get

Gets details of the Flux Configuration.

SELECT
properties,
systemData
FROM azure.kubernetes_configuration.flux_configurations
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND clusterRp = '{{ clusterRp }}' -- required
AND clusterResourceName = '{{ clusterResourceName }}' -- required
AND clusterName = '{{ clusterName }}' -- required
AND fluxConfigurationName = '{{ fluxConfigurationName }}' -- required
;

list

List all Flux Configurations.

SELECT
properties,
systemData
FROM azure.kubernetes_configuration.flux_configurations
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND clusterRp = '{{ clusterRp }}' -- required
AND clusterResourceName = '{{ clusterResourceName }}' -- required
AND clusterName = '{{ clusterName }}' -- required
;

INSERT examples

create_or_update

Create a new Kubernetes Flux Configuration.

INSERT INTO azure.kubernetes_configuration.flux_configurations (
data__properties,
subscriptionId,
resourceGroupName,
clusterRp,
clusterResourceName,
clusterName,
fluxConfigurationName
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ clusterRp }}',
'{{ clusterResourceName }}',
'{{ clusterName }}',
'{{ fluxConfigurationName }}'
RETURNING
properties,
systemData
;

Manifest

# Description fields are for documentation purposes
- name: flux_configurations
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the flux_configurations resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the flux_configurations resource.
    - name: clusterRp
      value: string
      description: Required parameter for the flux_configurations resource.
    - name: clusterResourceName
      value: string
      description: Required parameter for the flux_configurations resource.
    - name: clusterName
      value: string
      description: Required parameter for the flux_configurations resource.
    - name: fluxConfigurationName
      value: string
      description: Required parameter for the flux_configurations resource.
    - name: properties
      value: object
      description: |
        Properties to create a Flux Configuration resource

UPDATE examples

update

Update an existing Kubernetes Flux Configuration.

UPDATE azure.kubernetes_configuration.flux_configurations
SET 
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND clusterRp = '{{ clusterRp }}' --required
AND clusterResourceName = '{{ clusterResourceName }}' --required
AND clusterName = '{{ clusterName }}' --required
AND fluxConfigurationName = '{{ fluxConfigurationName }}' --required
RETURNING
properties,
systemData;

DELETE examples

delete

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

DELETE FROM azure.kubernetes_configuration.flux_configurations
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND clusterRp = '{{ clusterRp }}' --required
AND clusterResourceName = '{{ clusterResourceName }}' --required
AND clusterName = '{{ clusterName }}' --required
AND fluxConfigurationName = '{{ fluxConfigurationName }}' --required
AND forceDelete = '{{ forceDelete }}'
;