Share via

Microsoft.Web sites/sourcecontrols

  • Article

Bicep 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.

Resource format

To create a Microsoft.Web/sites/sourcecontrols resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Web/sites/sourcecontrols@2022-09-01' = {
  name: 'web'
  kind: 'string'
  parent: resourceSymbolicName
  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
name The resource name

See how to set names and types for child resources in Bicep.		 'web'
kind Kind of resource. string
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 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.

Template Description
PubNub Realtime Gateway for Azure Event Hubs

Deploy to Azure		 The PubNub Realtime Gateway for Azure provides a realtime data stream bridge between the PubNub Data Stream Network and Azure Event Hubs. -- consider it a bi-directional bridge between PubNub and Azure!
WordPress on App Service with MySQL In App

Deploy to Azure		 This template deploys a WordPress Web App on a Windows App Service with MySQL in app
eShop Website with ILB ASE

Deploy to Azure		 An App Service Environment is a Premium service plan option of Azure App Service that provides a fully isolated and dedicated environment for securely running Azure App Service apps at high scale, including Web Apps, Mobile Apps, and API Apps.
Create a zero touch Azure Cosmos account and Azure Web App

Deploy to Azure		 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.
Azure Logic App with Function

Deploy to Azure		 This template creates a Serverless app in Azure with Logic Apps and Functions. The Logic App triggers on an HTTP POST, calls the Azure Function, and returns the response.
App Service Quickstart - Linux App

Deploy to Azure		 This template is to be used with /azure/app-service/quickstart-arm-template
App Service Quickstart - Windows app

Deploy to Azure		 This template is to be used with /azure/app-service/quickstart-arm-template
Provision a function app with source deployed from GitHub

Deploy to Azure		 This template deploys a Function App hosted in a new dedicated App Service Plan. The Function App has a child resource that enables continous integration and deploys the function code from a GitHub repository.
Web App Deployment from GitHub

Deploy to Azure		 This template allows you to create an WebApp linked with a GitHub Repository linked.
App Service Quickstart - Windows app

Deploy to Azure		 This template is to be used with /azure/app-service/quickstart-arm-template

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.

Resource format

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.

Template Description
PubNub Realtime Gateway for Azure Event Hubs

Deploy to Azure		 The PubNub Realtime Gateway for Azure provides a realtime data stream bridge between the PubNub Data Stream Network and Azure Event Hubs. -- consider it a bi-directional bridge between PubNub and Azure!
WordPress on App Service with MySQL In App

Deploy to Azure		 This template deploys a WordPress Web App on a Windows App Service with MySQL in app
eShop Website with ILB ASE

Deploy to Azure		 An App Service Environment is a Premium service plan option of Azure App Service that provides a fully isolated and dedicated environment for securely running Azure App Service apps at high scale, including Web Apps, Mobile Apps, and API Apps.
Create a zero touch Azure Cosmos account and Azure Web App

Deploy to Azure		 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.
Azure Logic App with Function

Deploy to Azure		 This template creates a Serverless app in Azure with Logic Apps and Functions. The Logic App triggers on an HTTP POST, calls the Azure Function, and returns the response.
App Service Quickstart - Linux App

Deploy to Azure		 This template is to be used with /azure/app-service/quickstart-arm-template
App Service Quickstart - Windows app

Deploy to Azure		 This template is to be used with /azure/app-service/quickstart-arm-template
Provision a function app with source deployed from GitHub

Deploy to Azure		 This template deploys a Function App hosted in a new dedicated App Service Plan. The Function App has a child resource that enables continous integration and deploys the function code from a GitHub repository.
Web App Deployment from GitHub

Deploy to Azure		 This template allows you to create an WebApp linked with a GitHub Repository linked.
App Service Quickstart - Windows app

Deploy to Azure		 This template is to be used with /azure/app-service/quickstart-arm-template

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@2022-09-01"
  name = "web"
  parent_id = "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"
    }
    kind = "string"
  })
}

Property values

sites/sourcecontrols

Name Description Value
type The resource type "Microsoft.Web/sites/sourcecontrols@2022-09-01"
name The resource name "web"
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: sites
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