Microsoft.Web sites/sourcecontrols 2021-02-01

• Latest
• 2024-04-01
• 2023-12-01
• 2023-01-01
• 2022-09-01
• 2022-03-01
• 2021-03-01
• 2021-02-01
• 2021-01-15
• 2021-01-01
• 2020-12-01
• 2020-10-01
• 2020-09-01
• 2020-06-01
• 2019-08-01
• 2018-11-01
• 2018-02-01
• 2016-08-01
• 2015-08-01

Bicep resource definition

The sites/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/sourcecontrols resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Web/sites/sourcecontrols@2021-02-01' = {
  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

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

Microsoft.Web/sites/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
properties	SiteSourceControl resource specific properties	SiteSourceControlProperties

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

Quickstart samples

The following quickstart samples deploy this resource type.

Bicep File	Description
App Service Quickstart - Linux App	This template is to be used with /azure/app-service/quickstart-arm-template
App Service Quickstart - Windows app	This template is to be used with /azure/app-service/quickstart-arm-template
App Service Quickstart - Windows app	This template is to be used with /azure/app-service/quickstart-arm-template
Create a zero touch Azure Cosmos account and Azure Web App	This template creates an Azure Cosmos account, injects the Cosmos DB endpoint and keys into Azure Web App settings, then deploys an ASP MVC web app from GitHub.
Web App Deployment from GitHub	This template allows you to create an WebApp linked with a GitHub Repository linked.

ARM template resource definition

The sites/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/sourcecontrols resource, add the following JSON to your template.

{
  "type": "Microsoft.Web/sites/sourcecontrols",
  "apiVersion": "2021-02-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

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

Microsoft.Web/sites/sourcecontrols

Name	Description	Value
apiVersion	The api version	'2021-02-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/sourcecontrols'

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

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
App Service Quickstart - Linux App	This template is to be used with /azure/app-service/quickstart-arm-template
App Service Quickstart - Windows app	This template is to be used with /azure/app-service/quickstart-arm-template
App Service Quickstart - Windows app	This template is to be used with /azure/app-service/quickstart-arm-template
Create a zero touch Azure Cosmos account and Azure Web App	This template creates an Azure Cosmos account, injects the Cosmos DB endpoint and keys into Azure Web App settings, then deploys an ASP MVC web app from GitHub.
Web App Deployment from GitHub	This template allows you to create an WebApp linked with a GitHub Repository linked.

Terraform (AzAPI provider) resource definition

The sites/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/sourcecontrols resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Web/sites/sourcecontrols@2021-02-01"
  name = "string"
  kind = "string"
  body = jsonencode({
    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

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

Microsoft.Web/sites/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
properties	SiteSourceControl resource specific properties	SiteSourceControlProperties
type	The resource type	"Microsoft.Web/sites/sourcecontrols@2021-02-01"

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