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 sites/slots/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.Web/sites/slots/sourcecontrols resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Web/sites/slots/sourcecontrols@2023-12-01' = {
parent: resourceSymbolicName
kind: 'string'
name: 'web'
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
Microsoft.Web/sites/slots/sourcecontrols
| Name | Description | Value |
|---|---|---|
| kind | Kind of resource. | string |
| name | The resource name | 'web' (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: sites/slots |
| properties | SiteSourceControl resource specific properties | SiteSourceControlProperties |
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 |
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 |
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 Constraints: Sensitive value. Pass in as a secure parameter. |
| 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 |
SiteSourceControlProperties
| Name | Description | Value |
|---|---|---|
| branch | Name of branch to use for deployment. | string |
| deploymentRollbackEnabled | <code>true</code> to enable deployment rollback; otherwise, <code>false</code>. | bool |
| gitHubActionConfiguration | If GitHub Action is selected, than the associated configuration. | GitHubActionConfiguration |
| isGitHubAction | <code>true</code> if this is deployed via GitHub action. | bool |
| isManualIntegration | <code>true</code> to limit to manual integration; <code>false</code> to enable continuous integration (which configures webhooks into online repos like GitHub). | bool |
| isMercurial | <code>true</code> for a Mercurial repository; <code>false</code> for a Git repository. | bool |
| repoUrl | Repository or source control URL. | string |
ARM template resource definition
The sites/slots/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.Web/sites/slots/sourcecontrols resource, add the following JSON to your template.
{
"type": "Microsoft.Web/sites/slots/sourcecontrols",
"apiVersion": "2023-12-01",
"name": "string",
"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
Microsoft.Web/sites/slots/sourcecontrols
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2023-12-01' |
| kind | Kind of resource. | string |
| name | The resource name | 'web' (required) |
| properties | SiteSourceControl resource specific properties | SiteSourceControlProperties |
| type | The resource type | 'Microsoft.Web/sites/slots/sourcecontrols' |
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 |
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 |
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 Constraints: Sensitive value. Pass in as a secure parameter. |
| 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 |
SiteSourceControlProperties
| Name | Description | Value |
|---|---|---|
| branch | Name of branch to use for deployment. | string |
| deploymentRollbackEnabled | <code>true</code> to enable deployment rollback; otherwise, <code>false</code>. | bool |
| gitHubActionConfiguration | If GitHub Action is selected, than the associated configuration. | GitHubActionConfiguration |
| isGitHubAction | <code>true</code> if this is deployed via GitHub action. | bool |
| isManualIntegration | <code>true</code> to limit to manual integration; <code>false</code> to enable continuous integration (which configures webhooks into online repos like GitHub). | bool |
| isMercurial | <code>true</code> for a Mercurial repository; <code>false</code> for a Git repository. | bool |
| repoUrl | Repository or source control URL. | string |
Usage Examples
Terraform (AzAPI provider) resource definition
The sites/slots/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.Web/sites/slots/sourcecontrols resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Web/sites/slots/sourcecontrols@2023-12-01"
name = "string"
parent_id = "string"
body = {
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
Microsoft.Web/sites/slots/sourcecontrols
| Name | Description | Value |
|---|---|---|
| kind | Kind of resource. | string |
| name | The resource name | 'web' (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: sites/slots |
| properties | SiteSourceControl resource specific properties | SiteSourceControlProperties |
| type | The resource type | "Microsoft.Web/sites/slots/sourcecontrols@2023-12-01" |
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 |
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 |
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 Constraints: Sensitive value. Pass in as a secure parameter. |
| 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 |
SiteSourceControlProperties
| Name | Description | Value |
|---|---|---|
| branch | Name of branch to use for deployment. | string |
| deploymentRollbackEnabled | <code>true</code> to enable deployment rollback; otherwise, <code>false</code>. | bool |
| gitHubActionConfiguration | If GitHub Action is selected, than the associated configuration. | GitHubActionConfiguration |
| isGitHubAction | <code>true</code> if this is deployed via GitHub action. | bool |
| isManualIntegration | <code>true</code> to limit to manual integration; <code>false</code> to enable continuous integration (which configures webhooks into online repos like GitHub). | bool |
| isMercurial | <code>true</code> for a Mercurial repository; <code>false</code> for a Git repository. | bool |
| repoUrl | Repository or source control URL. | string |