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 containerApps/sourcecontrols resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.App/containerApps/sourcecontrols resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.App/containerApps/sourcecontrols@2023-05-01' = {
parent: resourceSymbolicName
name: 'string'
properties: {
branch: 'string'
githubActionConfiguration: {
azureCredentials: {
clientId: 'string'
clientSecret: 'string'
kind: 'string'
subscriptionId: 'string'
tenantId: 'string'
}
contextPath: 'string'
githubPersonalAccessToken: 'string'
image: 'string'
os: 'string'
publishType: 'string'
registryInfo: {
registryPassword: 'string'
registryUrl: 'string'
registryUserName: 'string'
}
runtimeStack: 'string'
runtimeVersion: 'string'
}
repoUrl: 'string'
}
}
Property Values
Microsoft.App/containerApps/sourcecontrols
| Name | Description | Value |
|---|---|---|
| name | The resource name | string (required) |
| parent | In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource. |
Symbolic name for resource of type: containerApps |
| properties | SourceControl resource specific properties | SourceControlProperties |
AzureCredentials
| Name | Description | Value |
|---|---|---|
| clientId | Client Id. | string Constraints: Sensitive value. Pass in as a secure parameter. |
| clientSecret | Client Secret. | string Constraints: Sensitive value. Pass in as a secure parameter. |
| kind | Kind of auth github does for deploying the template | string |
| subscriptionId | Subscription Id. | string |
| tenantId | Tenant Id. | string Constraints: Sensitive value. Pass in as a secure parameter. |
GithubActionConfiguration
| Name | Description | Value |
|---|---|---|
| azureCredentials | AzureCredentials configurations. | AzureCredentials |
| contextPath | Context path | string |
| githubPersonalAccessToken | One time Github PAT to configure github environment | string Constraints: Sensitive value. Pass in as a secure parameter. |
| image | Image name | string |
| os | Operation system | string |
| publishType | Code or Image | string |
| registryInfo | Registry configurations. | RegistryInfo |
| runtimeStack | Runtime stack | string |
| runtimeVersion | Runtime version | string |
RegistryInfo
| Name | Description | Value |
|---|---|---|
| registryPassword | registry secret. | string Constraints: Sensitive value. Pass in as a secure parameter. |
| registryUrl | registry server Url. | string |
| registryUserName | registry username. | string |
SourceControlProperties
| Name | Description | Value |
|---|---|---|
| branch | The branch which will trigger the auto deployment | string |
| githubActionConfiguration | Container App Revision Template with all possible settings and the defaults if user did not provide them. The defaults are populated as they were at the creation time |
GithubActionConfiguration |
| repoUrl | The repo url which will be integrated to ContainerApp. | string |
ARM template resource definition
The containerApps/sourcecontrols resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.App/containerApps/sourcecontrols resource, add the following JSON to your template.
{
"type": "Microsoft.App/containerApps/sourcecontrols",
"apiVersion": "2023-05-01",
"name": "string",
"properties": {
"branch": "string",
"githubActionConfiguration": {
"azureCredentials": {
"clientId": "string",
"clientSecret": "string",
"kind": "string",
"subscriptionId": "string",
"tenantId": "string"
},
"contextPath": "string",
"githubPersonalAccessToken": "string",
"image": "string",
"os": "string",
"publishType": "string",
"registryInfo": {
"registryPassword": "string",
"registryUrl": "string",
"registryUserName": "string"
},
"runtimeStack": "string",
"runtimeVersion": "string"
},
"repoUrl": "string"
}
}
Property Values
Microsoft.App/containerApps/sourcecontrols
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2023-05-01' |
| name | The resource name | string (required) |
| properties | SourceControl resource specific properties | SourceControlProperties |
| type | The resource type | 'Microsoft.App/containerApps/sourcecontrols' |
AzureCredentials
| Name | Description | Value |
|---|---|---|
| clientId | Client Id. | string Constraints: Sensitive value. Pass in as a secure parameter. |
| clientSecret | Client Secret. | string Constraints: Sensitive value. Pass in as a secure parameter. |
| kind | Kind of auth github does for deploying the template | string |
| subscriptionId | Subscription Id. | string |
| tenantId | Tenant Id. | string Constraints: Sensitive value. Pass in as a secure parameter. |
GithubActionConfiguration
| Name | Description | Value |
|---|---|---|
| azureCredentials | AzureCredentials configurations. | AzureCredentials |
| contextPath | Context path | string |
| githubPersonalAccessToken | One time Github PAT to configure github environment | string Constraints: Sensitive value. Pass in as a secure parameter. |
| image | Image name | string |
| os | Operation system | string |
| publishType | Code or Image | string |
| registryInfo | Registry configurations. | RegistryInfo |
| runtimeStack | Runtime stack | string |
| runtimeVersion | Runtime version | string |
RegistryInfo
| Name | Description | Value |
|---|---|---|
| registryPassword | registry secret. | string Constraints: Sensitive value. Pass in as a secure parameter. |
| registryUrl | registry server Url. | string |
| registryUserName | registry username. | string |
SourceControlProperties
| Name | Description | Value |
|---|---|---|
| branch | The branch which will trigger the auto deployment | string |
| githubActionConfiguration | Container App Revision Template with all possible settings and the defaults if user did not provide them. The defaults are populated as they were at the creation time |
GithubActionConfiguration |
| repoUrl | The repo url which will be integrated to ContainerApp. | string |
Usage Examples
Terraform (AzAPI provider) resource definition
The containerApps/sourcecontrols resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.App/containerApps/sourcecontrols resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.App/containerApps/sourcecontrols@2023-05-01"
name = "string"
parent_id = "string"
body = {
properties = {
branch = "string"
githubActionConfiguration = {
azureCredentials = {
clientId = "string"
clientSecret = "string"
kind = "string"
subscriptionId = "string"
tenantId = "string"
}
contextPath = "string"
githubPersonalAccessToken = "string"
image = "string"
os = "string"
publishType = "string"
registryInfo = {
registryPassword = "string"
registryUrl = "string"
registryUserName = "string"
}
runtimeStack = "string"
runtimeVersion = "string"
}
repoUrl = "string"
}
}
}
Property Values
Microsoft.App/containerApps/sourcecontrols
| Name | Description | Value |
|---|---|---|
| name | The resource name | string (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: containerApps |
| properties | SourceControl resource specific properties | SourceControlProperties |
| type | The resource type | "Microsoft.App/containerApps/sourcecontrols@2023-05-01" |
AzureCredentials
| Name | Description | Value |
|---|---|---|
| clientId | Client Id. | string Constraints: Sensitive value. Pass in as a secure parameter. |
| clientSecret | Client Secret. | string Constraints: Sensitive value. Pass in as a secure parameter. |
| kind | Kind of auth github does for deploying the template | string |
| subscriptionId | Subscription Id. | string |
| tenantId | Tenant Id. | string Constraints: Sensitive value. Pass in as a secure parameter. |
GithubActionConfiguration
| Name | Description | Value |
|---|---|---|
| azureCredentials | AzureCredentials configurations. | AzureCredentials |
| contextPath | Context path | string |
| githubPersonalAccessToken | One time Github PAT to configure github environment | string Constraints: Sensitive value. Pass in as a secure parameter. |
| image | Image name | string |
| os | Operation system | string |
| publishType | Code or Image | string |
| registryInfo | Registry configurations. | RegistryInfo |
| runtimeStack | Runtime stack | string |
| runtimeVersion | Runtime version | string |
RegistryInfo
| Name | Description | Value |
|---|---|---|
| registryPassword | registry secret. | string Constraints: Sensitive value. Pass in as a secure parameter. |
| registryUrl | registry server Url. | string |
| registryUserName | registry username. | string |
SourceControlProperties
| Name | Description | Value |
|---|---|---|
| branch | The branch which will trigger the auto deployment | string |
| githubActionConfiguration | Container App Revision Template with all possible settings and the defaults if user did not provide them. The defaults are populated as they were at the creation time |
GithubActionConfiguration |
| repoUrl | The repo url which will be integrated to ContainerApp. | string |