ARM template resource definition
The sites/sourcecontrols resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log.
To create a Microsoft.Web/sites/sourcecontrols resource, add the following JSON to your template.
{
"type": "Microsoft.Web/sites/sourcecontrols",
"apiVersion": "2022-09-01",
"name": "web",
"kind": "string",
"properties": {
"branch": "string",
"deploymentRollbackEnabled": "bool",
"gitHubActionConfiguration": {
"codeConfiguration": {
"runtimeStack": "string",
"runtimeVersion": "string"
},
"containerConfiguration": {
"imageName": "string",
"password": "string",
"serverUrl": "string",
"username": "string"
},
"generateWorkflowFile": "bool",
"isLinux": "bool"
},
"isGitHubAction": "bool",
"isManualIntegration": "bool",
"isMercurial": "bool",
"repoUrl": "string"
}
}
Property values
sites/sourcecontrols
Name |
Description |
Value |
type |
The resource type |
'Microsoft.Web/sites/sourcecontrols' |
apiVersion |
The resource api version |
'2022-09-01' |
name |
The resource name
See how to set names and types for child resources in JSON ARM templates. |
'web' |
kind |
Kind of resource. |
string |
properties |
SiteSourceControl resource specific properties |
SiteSourceControlProperties |
SiteSourceControlProperties
Name |
Description |
Value |
branch |
Name of branch to use for deployment. |
string |
deploymentRollbackEnabled |
true to enable deployment rollback; otherwise, false . |
bool |
gitHubActionConfiguration |
If GitHub Action is selected, than the associated configuration. |
GitHubActionConfiguration |
isGitHubAction |
true if this is deployed via GitHub action. |
bool |
isManualIntegration |
true to limit to manual integration; false to enable continuous integration (which configures webhooks into online repos like GitHub). |
bool |
isMercurial |
true for a Mercurial repository; false for a Git repository. |
bool |
repoUrl |
Repository or source control URL. |
string |
GitHubActionConfiguration
Name |
Description |
Value |
codeConfiguration |
GitHub Action code configuration. |
GitHubActionCodeConfiguration |
containerConfiguration |
GitHub Action container configuration. |
GitHubActionContainerConfiguration |
generateWorkflowFile |
Workflow option to determine whether the workflow file should be generated and written to the repository. |
bool |
isLinux |
This will help determine the workflow configuration to select. |
bool |
GitHubActionCodeConfiguration
Name |
Description |
Value |
runtimeStack |
Runtime stack is used to determine the workflow file content for code base apps. |
string |
runtimeVersion |
Runtime version is used to determine what build version to set in the workflow file. |
string |
GitHubActionContainerConfiguration
Name |
Description |
Value |
imageName |
The image name for the build. |
string |
password |
The password used to upload the image to the container registry. |
string |
serverUrl |
The server URL for the container registry where the build will be hosted. |
string |
username |
The username used to upload the image to the container registry. |
string |
Quickstart templates
The following quickstart templates deploy this resource type.