Microsoft.Web sites/sourcecontrols

12/28/2020
2 minutes to read

Template format

To create a Microsoft.Web/sites/sourcecontrols resource, add the following JSON to the resources section of your template.

{
  "type": "Microsoft.Web/sites/sourcecontrols",
  "apiVersion": "2020-09-01",
  "kind": "string",
  "systemData": {
    "createdBy": "string",
    "createdByType": "string",
    "lastModifiedAt": "string"
  },
  "properties": {
    "repoUrl": "string",
    "branch": "string",
    "isManualIntegration": "boolean",
    "isGitHubAction": "boolean",
    "deploymentRollbackEnabled": "boolean",
    "isMercurial": "boolean"
  }
}

Property values

The following tables describe the values you need to set in the schema.

Microsoft.Web/sites/sourcecontrols object

Name	Type	Required	Value
type	enum	Yes	sourcecontrols -or- Microsoft.Web/sites/sourcecontrols See Set name and type for child resources.
apiVersion	enum	Yes	2020-09-01
kind	string	No	Kind of resource.
systemData	object	No	The system metadata relating to this resource. - SystemData object
properties	object	Yes	SiteSourceControl resource specific properties - SiteSourceControlProperties object

SystemData object

Name	Type	Required	Value
createdBy	string	No	The identity that created the resource.
createdByType	enum	No	The type of identity that created the resource. - User, Application, ManagedIdentity, Key
lastModifiedAt	string	No	The type of identity that last modified the resource.

SiteSourceControlProperties object

Name	Type	Required	Value
repoUrl	string	No	Repository or source control URL.
branch	string	No	Name of branch to use for deployment.
isManualIntegration	boolean	No	`true` to limit to manual integration; `false` to enable continuous integration (which configures webhooks into online repos like GitHub).
isGitHubAction	boolean	No	`true` if this is deployed via GitHub action.
deploymentRollbackEnabled	boolean	No	`true` to enable deployment rollback; otherwise, `false`.
isMercurial	boolean	No	`true` for a Mercurial repository; `false` for a Git repository.

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
App Service Quickstart - Windows app	This template is to be used with https://docs.microsoft.com/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.
Azure Logic App with Function	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 - Windows app	This template is to be used with https://docs.microsoft.com/azure/app-service/quickstart-arm-template
Provision a function app with source deployed from GitHub	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.
WebApp GitHub	This template allows you to create an WebApp linked with a GitHub Repository linked.
eShop Website with ILB ASE	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.
PubNub Realtime Gateway for Azure Event Hubs	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	This template deploys a WordPress Web App on a Windows App Service with MySQL in app