Share via

Web Apps - Get Source Control

Service:
App Service
API Version:
2025-03-01

Description for Gets the source control configuration of an app.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sourcecontrols/web?api-version=2025-03-01

URI Parameters

Name In Required Type Description
name
 path True

string

Name of the app.
resourceGroupName
 path True

string

minLength: 1
maxLength: 90
pattern: ^[-\w\._\(\)]+[^\.]$

Name of the resource group to which the resource belongs.
subscriptionId
 path True

string

Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
api-version
 query True

string

API Version

Responses

Name Type Description
200 OK

SiteSourceControl

Successfully retrieved source control for web app.
201 Created

SiteSourceControl

Create or update source control for web app still in progress.
202 Accepted

SiteSourceControl

Create or update source control for web app still in progress.
Other Status Codes

DefaultErrorResponse

App Service error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Definitions

Name Description
DefaultErrorResponse

App Service error response.
Details
Error

Error model.
GitHubActionCodeConfiguration

The GitHub action code configuration.
GitHubActionConfiguration

The GitHub action configuration.
GitHubActionContainerConfiguration

The GitHub action container configuration.
SiteSourceControl

Source control configuration for an app.

DefaultErrorResponse

Object

App Service error response.

Name Type Description
error

Error

Error model.

Details

Object
Name Type Description
code

string

Standardized string to programmatically identify the error.
message

string

Detailed error description and debugging information.
target

string

Detailed error description and debugging information.

Error

Object

Error model.

Name Type Description
code

string

Standardized string to programmatically identify the error.
details

Details[]

Detailed errors.
innererror

string

More information to debug error.
message

string

Detailed error description and debugging information.
target

string

Detailed error description and debugging information.

GitHubActionCodeConfiguration

Object

The GitHub action code configuration.

Name Type Description
runtimeStack

string

Runtime stack is used to determine the workflow file content for code base apps.
runtimeVersion

string

Runtime version is used to determine what build version to set in the workflow file.

GitHubActionConfiguration

Object

The GitHub action configuration.

Name Type Description
codeConfiguration

GitHubActionCodeConfiguration

GitHub Action code configuration.
containerConfiguration

GitHubActionContainerConfiguration

GitHub Action container configuration.
generateWorkflowFile

boolean

Workflow option to determine whether the workflow file should be generated and written to the repository.
isLinux

boolean

This will help determine the workflow configuration to select.

GitHubActionContainerConfiguration

Object

The GitHub action container configuration.

Name Type Description
imageName

string

The image name for the build.
password

string

The password used to upload the image to the container registry.
serverUrl

string

The server URL for the container registry where the build will be hosted.
username

string

The username used to upload the image to the container registry.

SiteSourceControl

Object

Source control configuration for an app.

Name Type Description
id

string

Resource Id.
kind

string

Kind of resource.
name

string

Resource Name.
properties.branch

string

Name of branch to use for deployment.
properties.deploymentRollbackEnabled

boolean

true to enable deployment rollback; otherwise, false.
properties.gitHubActionConfiguration

GitHubActionConfiguration

If GitHub Action is selected, than the associated configuration.
properties.isGitHubAction

boolean

true if this is deployed via GitHub action.
properties.isManualIntegration

boolean

true to limit to manual integration; false to enable continuous integration (which configures webhooks into online repos like GitHub).
properties.isMercurial

boolean

true for a Mercurial repository; false for a Git repository.
properties.repoUrl

string

Repository or source control URL.
type

string

Resource type.