Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The sourceControlConfigurations resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.KubernetesConfiguration/sourceControlConfigurations resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.KubernetesConfiguration/sourceControlConfigurations@2023-05-01' = {
scope: resourceSymbolicName or scope
name: 'string'
properties: {
configurationProtectedSettings: {
{customized property}: 'string'
}
enableHelmOperator: bool
helmOperatorProperties: {
chartValues: 'string'
chartVersion: 'string'
}
operatorInstanceName: 'string'
operatorNamespace: 'string'
operatorParams: 'string'
operatorScope: 'string'
operatorType: 'string'
repositoryUrl: 'string'
sshKnownHostsContents: 'string'
}
}
Property Values
Microsoft.KubernetesConfiguration/sourceControlConfigurations
| Name | Description | Value |
|---|---|---|
| name | The resource name | string (required) |
| properties | Properties to create a Source Control Configuration resource | SourceControlConfigurationProperties |
| scope | Use when creating a resource at a scope that is different than the deployment scope. | Set this property to the symbolic name of a resource to apply the extension resource. |
ConfigurationProtectedSettings
| Name | Description | Value |
|---|
HelmOperatorProperties
| Name | Description | Value |
|---|---|---|
| chartValues | Values override for the operator Helm chart. | string |
| chartVersion | Version of the operator Helm chart. | string |
SourceControlConfigurationProperties
| Name | Description | Value |
|---|---|---|
| configurationProtectedSettings | Name-value pairs of protected configuration settings for the configuration | ConfigurationProtectedSettings |
| enableHelmOperator | Option to enable Helm Operator for this git configuration. | bool |
| helmOperatorProperties | Properties for Helm operator. | HelmOperatorProperties |
| operatorInstanceName | Instance name of the operator - identifying the specific configuration. | string |
| operatorNamespace | The namespace to which this operator is installed to. Maximum of 253 lower case alphanumeric characters, hyphen and period only. | string |
| operatorParams | Any Parameters for the Operator instance in string format. | string |
| operatorScope | Scope at which the operator will be installed. | 'cluster' 'namespace' |
| operatorType | Type of the operator | 'Flux' |
| repositoryUrl | Url of the SourceControl Repository. | string |
| sshKnownHostsContents | Base64-encoded known_hosts contents containing public SSH keys required to access private Git instances | string |
ARM template resource definition
The sourceControlConfigurations resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.KubernetesConfiguration/sourceControlConfigurations resource, add the following JSON to your template.
{
"type": "Microsoft.KubernetesConfiguration/sourceControlConfigurations",
"apiVersion": "2023-05-01",
"name": "string",
"properties": {
"configurationProtectedSettings": {
"{customized property}": "string"
},
"enableHelmOperator": "bool",
"helmOperatorProperties": {
"chartValues": "string",
"chartVersion": "string"
},
"operatorInstanceName": "string",
"operatorNamespace": "string",
"operatorParams": "string",
"operatorScope": "string",
"operatorType": "string",
"repositoryUrl": "string",
"sshKnownHostsContents": "string"
}
}
Property Values
Microsoft.KubernetesConfiguration/sourceControlConfigurations
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2023-05-01' |
| name | The resource name | string (required) |
| properties | Properties to create a Source Control Configuration resource | SourceControlConfigurationProperties |
| type | The resource type | 'Microsoft.KubernetesConfiguration/sourceControlConfigurations' |
ConfigurationProtectedSettings
| Name | Description | Value |
|---|
HelmOperatorProperties
| Name | Description | Value |
|---|---|---|
| chartValues | Values override for the operator Helm chart. | string |
| chartVersion | Version of the operator Helm chart. | string |
SourceControlConfigurationProperties
| Name | Description | Value |
|---|---|---|
| configurationProtectedSettings | Name-value pairs of protected configuration settings for the configuration | ConfigurationProtectedSettings |
| enableHelmOperator | Option to enable Helm Operator for this git configuration. | bool |
| helmOperatorProperties | Properties for Helm operator. | HelmOperatorProperties |
| operatorInstanceName | Instance name of the operator - identifying the specific configuration. | string |
| operatorNamespace | The namespace to which this operator is installed to. Maximum of 253 lower case alphanumeric characters, hyphen and period only. | string |
| operatorParams | Any Parameters for the Operator instance in string format. | string |
| operatorScope | Scope at which the operator will be installed. | 'cluster' 'namespace' |
| operatorType | Type of the operator | 'Flux' |
| repositoryUrl | Url of the SourceControl Repository. | string |
| sshKnownHostsContents | Base64-encoded known_hosts contents containing public SSH keys required to access private Git instances | string |
Usage Examples
Terraform (AzAPI provider) resource definition
The sourceControlConfigurations resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.KubernetesConfiguration/sourceControlConfigurations resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.KubernetesConfiguration/sourceControlConfigurations@2023-05-01"
name = "string"
parent_id = "string"
body = {
properties = {
configurationProtectedSettings = {
{customized property} = "string"
}
enableHelmOperator = bool
helmOperatorProperties = {
chartValues = "string"
chartVersion = "string"
}
operatorInstanceName = "string"
operatorNamespace = "string"
operatorParams = "string"
operatorScope = "string"
operatorType = "string"
repositoryUrl = "string"
sshKnownHostsContents = "string"
}
}
}
Property Values
Microsoft.KubernetesConfiguration/sourceControlConfigurations
| Name | Description | Value |
|---|---|---|
| name | The resource name | string (required) |
| parent_id | The ID of the resource to apply this extension resource to. | string (required) |
| properties | Properties to create a Source Control Configuration resource | SourceControlConfigurationProperties |
| type | The resource type | "Microsoft.KubernetesConfiguration/sourceControlConfigurations@2023-05-01" |
ConfigurationProtectedSettings
| Name | Description | Value |
|---|
HelmOperatorProperties
| Name | Description | Value |
|---|---|---|
| chartValues | Values override for the operator Helm chart. | string |
| chartVersion | Version of the operator Helm chart. | string |
SourceControlConfigurationProperties
| Name | Description | Value |
|---|---|---|
| configurationProtectedSettings | Name-value pairs of protected configuration settings for the configuration | ConfigurationProtectedSettings |
| enableHelmOperator | Option to enable Helm Operator for this git configuration. | bool |
| helmOperatorProperties | Properties for Helm operator. | HelmOperatorProperties |
| operatorInstanceName | Instance name of the operator - identifying the specific configuration. | string |
| operatorNamespace | The namespace to which this operator is installed to. Maximum of 253 lower case alphanumeric characters, hyphen and period only. | string |
| operatorParams | Any Parameters for the Operator instance in string format. | string |
| operatorScope | Scope at which the operator will be installed. | 'cluster' 'namespace' |
| operatorType | Type of the operator | 'Flux' |
| repositoryUrl | Url of the SourceControl Repository. | string |
| sshKnownHostsContents | Base64-encoded known_hosts contents containing public SSH keys required to access private Git instances | string |