PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/sourcecontrols/web/?api-version=2023-01-01

Description for Updates the source control configuration of an app.

Servers

Path parameters

Name Type Required Description
name String Yes

Name of the app.

slot String Yes

Name of the deployment slot. If a slot is not specified, the API will update the source control configuration for the production slot.

subscriptionId String Yes

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

resourceGroupName String Yes

Name of the resource group to which the resource belongs.

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
id String No

Resource Id.

name String No

Resource Name.

properties Object No

SiteSourceControl resource specific properties

properties.isManualIntegration Boolean No

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

properties.gitHubActionConfiguration Object No

The GitHub action configuration.

properties.gitHubActionConfiguration.isLinux Boolean No

This will help determine the workflow configuration to select.

properties.gitHubActionConfiguration.containerConfiguration Object No

The GitHub action container configuration.

properties.gitHubActionConfiguration.containerConfiguration.username String No

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

properties.gitHubActionConfiguration.containerConfiguration.password String No

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

properties.gitHubActionConfiguration.containerConfiguration.serverUrl String No

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

properties.gitHubActionConfiguration.containerConfiguration.imageName String No

The image name for the build.

properties.gitHubActionConfiguration.codeConfiguration Object No

The GitHub action code configuration.

properties.gitHubActionConfiguration.codeConfiguration.runtimeStack String No

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

properties.gitHubActionConfiguration.codeConfiguration.runtimeVersion String No

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

properties.gitHubActionConfiguration.generateWorkflowFile Boolean No

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

properties.isGitHubAction Boolean No

true if this is deployed via GitHub action.

properties.branch String No

Name of branch to use for deployment.

properties.isMercurial Boolean No

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

properties.deploymentRollbackEnabled Boolean No

true to enable deployment rollback; otherwise, false.

properties.repoUrl String No

Repository or source control URL.

type String No

Resource type.

kind String No

Kind of resource.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.