source_control_configurations

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

Overview

Name	source_control_configurations
Type	Resource
Id	azure.kubernetes_configuration.source_control_configurations

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
properties	object	Properties to create a Source Control 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 Source Control 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, sourceControlConfigurationName		Gets details of the Source Control Configuration.
list	select	subscriptionId, resourceGroupName, clusterRp, clusterResourceName, clusterName		List all Source Control Configurations.
create_or_update	insert	subscriptionId, resourceGroupName, clusterRp, clusterResourceName, clusterName, sourceControlConfigurationName		Create a new Kubernetes Source Control Configuration.
delete	delete	subscriptionId, resourceGroupName, clusterRp, clusterResourceName, clusterName, sourceControlConfigurationName		This will delete the YAML file used to set up the Source control 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.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
sourceControlConfigurationName	string	Name of the Source Control Configuration.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

Gets details of the Source Control Configuration.

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

list

List all Source Control Configurations.

SELECT
properties,
systemData
FROM azure.kubernetes_configuration.source_control_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 Source Control Configuration.

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

Manifest

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

DELETE examples

delete

This will delete the YAML file used to set up the Source control configuration, thus stopping future sync from the source repo.

DELETE FROM azure.kubernetes_configuration.source_control_configurations
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND clusterRp = '{{ clusterRp }}' --required
AND clusterResourceName = '{{ clusterResourceName }}' --required
AND clusterName = '{{ clusterName }}' --required
AND sourceControlConfigurationName = '{{ sourceControlConfigurationName }}' --required
;