Source Controls - Create

Service:: Sentinel

API Version:: 2025-09-01

Creates a source control.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/sourcecontrols/{sourceControlId}?api-version=2025-09-01

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
sourceControlId	path	True	string	Source control Id
subscriptionId	path	True	string (uuid)	The ID of the target subscription. The value must be an UUID.
workspaceName	path	True	string minLength: 1 maxLength: 90 pattern: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$	The name of the workspace.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Request Body

Name	Required	Type	Description
properties.contentTypes	True	ContentType[]	Array of source control content types.
properties.displayName	True	string	The display name of the source control
properties.repoType	True	RepoType	The repository type of the source control
properties.repository	True	Repository	Repository metadata.
etag		string	Etag of the azure resource
properties.description		string	A description of the source control
properties.repositoryAccess		RepositoryAccess	Repository access credentials. This is write-only object and it never returns back to a user.
properties.repositoryResourceInfo		RepositoryResourceInfo	Information regarding the resources created in user's repository.
properties.servicePrincipal		ServicePrincipal	Service principal metadata.

Responses

Name	Type	Description
200 OK	SourceControl	Updated
201 Created	SourceControl	Created
Other Status Codes	CloudError	Error response describing why the operation failed.

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

Examples

Creates or updates a source control.

Sample request

HTTP

PUT https://management.azure.com/subscriptions/b28fbe4a-0bb1-4593-960b-061c8655a550/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/sourcecontrols/789e0c1f-4a3d-43ad-809c-e713b677b04a?api-version=2025-09-01

{
  "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"",
  "properties": {
    "displayName": "My Source Control",
    "description": "This is a source control",
    "repoType": "Github",
    "contentTypes": [
      "AnalyticsRule",
      "Workbook"
    ],
    "repository": {
      "url": "https://github.com/user/repo",
      "branch": "master",
      "displayUrl": "https://github.com/user/repo"
    },
    "repositoryAccess": {
      "kind": "OAuth",
      "code": "939fd7c6caf754f4f41f",
      "state": "state",
      "clientId": "54b3c2c0-1f48-4a1c-af9f-6399c3240b73"
    }
  }
}

Sample response

Status code:: 200

{
  "id": "/subscriptions/b28fbe4a-0bb1-4593-960b-061c8655a550/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/sourcecontrols/789e0c1f-4a3d-43ad-809c-e713b677b04a",
  "version": "V2",
  "name": "789e0c1f-4a3d-43ad-809c-e713b677b04a",
  "type": "Microsoft.SecurityInsights/SourceControls",
  "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"",
  "properties": {
    "id": "789e0c1f-4a3d-43ad-809c-e713b677b04a",
    "displayName": "My Source Control",
    "description": "this is a source control",
    "repoType": "Github",
    "contentTypes": [
      "AnalyticsRule",
      "Workbook"
    ],
    "repository": {
      "url": "https://github.com/user/repo",
      "branch": "master",
      "displayUrl": "https://github.com/user/repo",
      "deploymentLogsUrl": "https://github.com/user/repo/actions"
    },
    "servicePrincipal": {
      "id": "6a5f9fbd-6ce5-45a5-a729-79f8943472f3",
      "tenantId": "336ffe99-ff10-48fa-8c21-6da2a653dcce",
      "appId": "307ef030-13ed-4342-8cc2-c11760649f4d"
    },
    "workloadIdentityFederation": {
      "id": "c2c12197-fc2c-4880-9b18-0996ffe7aeca",
      "tenantId": "336ffe99-ff10-48fa-8c21-6da2a653dcce",
      "appId": "307ef030-13ed-4342-8cc2-c11760649f4d",
      "subject": "repo:user/repo:ref:refs/heads/branch",
      "issuer": "https://token.actions.githubusercontent.com"
    },
    "repositoryResourceInfo": {
      "webhook": {
        "webhookId": "342768323",
        "webhookUrl": "https://cac.sentinel.azure.com/workspaces/eeca17ff-d744-4a8b-9f5e-1edcc3346a1d/webhooks/ado/sourceControl/789e0c1f-4a3d-43ad-809c-e713b677b04a",
        "webhookSecretUpdateTime": "2021-01-01T17:18:19.1234567Z"
      },
      "gitHubResourceInfo": {
        "appInstallationId": "123"
      },
      "azureDevOpsResourceInfo": null
    },
    "lastDeploymentInfo": {
      "deploymentFetchStatus": "Success",
      "deployment": {
        "deploymentId": "4985046420",
        "deploymentState": "Completed",
        "deploymentResult": "Success",
        "deploymentTime": "2021-01-01T17:18:19.1234567Z",
        "deploymentLogsUrl": "https://github.com/user/repo/actions"
      },
      "message": "Successful deployment"
    },
    "pullRequest": {
      "url": "https://github.com/user/repo/pull/123",
      "state": "Open"
    }
  },
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2021-01-01T17:18:19.1234567Z",
    "lastModifiedBy": "user2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2021-01-02T17:18:19.1234567Z"
  }
}

Status code:: 201

{
  "id": "/subscriptions/b28fbe4a-0bb1-4593-960b-061c8655a550/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/sourcecontrols/789e0c1f-4a3d-43ad-809c-e713b677b04a",
  "version": "V2",
  "name": "789e0c1f-4a3d-43ad-809c-e713b677b04a",
  "type": "Microsoft.SecurityInsights/SourceControls",
  "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"",
  "properties": {
    "id": "789e0c1f-4a3d-43ad-809c-e713b677b04a",
    "displayName": "My Source Control",
    "description": "this is a source control",
    "repoType": "Github",
    "contentTypes": [
      "AnalyticsRule",
      "Workbook"
    ],
    "repository": {
      "url": "https://github.com/user/repo",
      "branch": "master",
      "displayUrl": "https://github.com/user/repo",
      "deploymentLogsUrl": "https://github.com/user/repo/actions"
    },
    "servicePrincipal": {
      "id": "6a5f9fbd-6ce5-45a5-a729-79f8943472f3",
      "tenantId": "336ffe99-ff10-48fa-8c21-6da2a653dcce",
      "appId": "307ef030-13ed-4342-8cc2-c11760649f4d"
    },
    "workloadIdentityFederation": {
      "id": "c2c12197-fc2c-4880-9b18-0996ffe7aeca",
      "tenantId": "336ffe99-ff10-48fa-8c21-6da2a653dcce",
      "appId": "307ef030-13ed-4342-8cc2-c11760649f4d",
      "subject": "repo:user/repo:ref:refs/heads/branch",
      "issuer": "https://token.actions.githubusercontent.com"
    },
    "repositoryResourceInfo": {
      "webhook": {
        "webhookId": "342768323",
        "webhookUrl": "https://cac.sentinel.azure.com/workspaces/eeca17ff-d744-4a8b-9f5e-1edcc3346a1d/webhooks/ado/sourceControl/789e0c1f-4a3d-43ad-809c-e713b677b04a",
        "webhookSecretUpdateTime": "2021-01-01T17:18:19.1234567Z"
      },
      "gitHubResourceInfo": {
        "appInstallationId": "123"
      },
      "azureDevOpsResourceInfo": null
    },
    "lastDeploymentInfo": {
      "deploymentFetchStatus": "Success",
      "deployment": {
        "deploymentId": "4985046420",
        "deploymentState": "Completed",
        "deploymentResult": "Success",
        "deploymentTime": "2021-01-01T17:18:19.1234567Z",
        "deploymentLogsUrl": "https://github.com/user/repo/actions"
      },
      "message": "Successful deployment"
    },
    "pullRequest": {
      "url": "https://github.com/user/repo/pull/123",
      "state": "Open"
    }
  },
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2021-01-01T17:18:19.1234567Z",
    "lastModifiedBy": "user2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2021-01-02T17:18:19.1234567Z"
  }
}

Definitions

Name	Description
AzureDevOpsResourceInfo	Resources created in Azure DevOps repository.
CloudError	Error response structure.
CloudErrorBody	Error details.
ContentType	The content type of a source control path.
createdByType	The type of identity that created the resource.
Deployment	Description about a deployment.
DeploymentFetchStatus	Status while trying to fetch the deployment information.
DeploymentInfo	Information regarding a deployment.
DeploymentResult	Status while trying to fetch the deployment information.
DeploymentState	The current state of the deployment.
GitHubResourceInfo	Resources created in GitHub repository.
PullRequest	Information regarding pull request for protected branches.
Repository	metadata of a repository.
RepositoryAccess	Credentials to access repository.
RepositoryAccessKind	The kind of repository access credentials
RepositoryResourceInfo	Resources created in user's repository for the source-control.
RepoType	The type of repository.
ServicePrincipal	Service principal metadata.
SourceControl	Represents a SourceControl in Azure Security Insights.
state	State of the pull request
systemData	Metadata pertaining to creation and last modification of the resource.
Version	The version of the source control.
Webhook	Detail about the webhook object.
WorkloadIdentityFederation	Workload Identity Federation metadata.

AzureDevOpsResourceInfo

Object

Resources created in Azure DevOps repository.

Name	Type	Description
pipelineId	string	Id of the pipeline created for the source-control.
serviceConnectionId	string	Id of the service-connection created for the source-control.

CloudError

Object

Error response structure.

Name	Type	Description
error	CloudErrorBody	Error data

CloudErrorBody

Object

Error details.

Name	Type	Description
code	string	An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
message	string	A message describing the error, intended to be suitable for display in a user interface.

ContentType

Enumeration

The content type of a source control path.

Value	Description
AnalyticsRule
AutomationRule
HuntingQuery
Parser
Playbook
Workbook

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

Deployment

Object

Description about a deployment.

Name	Type	Description
deploymentId	string	Deployment identifier.
deploymentLogsUrl	string	Url to access repository action logs.
deploymentResult	DeploymentResult	The outcome of the deployment.
deploymentState	DeploymentState	Current status of the deployment.
deploymentTime	string (date-time)	The time when the deployment finished.

DeploymentFetchStatus

Enumeration

Status while trying to fetch the deployment information.

Value	Description
Success
Unauthorized
NotFound

DeploymentInfo

Object

Information regarding a deployment.

Name	Type	Description
deployment	Deployment	Deployment information.
deploymentFetchStatus	DeploymentFetchStatus	Status while fetching the last deployment.
message	string	Additional details about the deployment that can be shown to the user.

DeploymentResult

Enumeration

Status while trying to fetch the deployment information.

Value	Description
Success
Canceled
Failed

DeploymentState

Enumeration

The current state of the deployment.

Value	Description
In_Progress
Completed
Queued
Canceling

GitHubResourceInfo

Object

Resources created in GitHub repository.

Name	Type	Description
appInstallationId	string	GitHub application installation id.

PullRequest

Object

Information regarding pull request for protected branches.

Name	Type	Description
state	state	State of the pull request
url	string	URL of pull request

Repository

Object

metadata of a repository.

Name	Type	Description
branch	string	Branch name of repository.
deploymentLogsUrl	string	Url to access repository action logs.
displayUrl	string	Display url of repository.
url	string	Url of repository.

RepositoryAccess

Object

Credentials to access repository.

Name	Type	Description
clientId	string	OAuth ClientId. Required when `kind` is `OAuth`
code	string	OAuth Code. Required when `kind` is `OAuth`
installationId	string	Application installation ID. Required when `kind` is `App`. Supported by `GitHub` only.
kind	RepositoryAccessKind	The kind of repository access credentials
state	string	OAuth State. Required when `kind` is `OAuth`
token	string	Personal Access Token. Required when `kind` is `PAT`

RepositoryAccessKind

Enumeration

The kind of repository access credentials

Value	Description
OAuth
PAT
App

RepositoryResourceInfo

Object

Resources created in user's repository for the source-control.

Name	Type	Description
azureDevOpsResourceInfo	AzureDevOpsResourceInfo	Resources created in Azure DevOps for this source-control.
gitHubResourceInfo	GitHubResourceInfo	Resources created in GitHub for this source-control.
webhook	Webhook	The webhook object created for the source-control.

RepoType

Enumeration

The type of repository.

Value	Description
Github
AzureDevOps

ServicePrincipal

Object

Service principal metadata.

Name	Type	Description
appId	string	App id of service principal.
credentialsExpireOn	string (date-time)	Expiration time of service principal credentials.
id	string	Id of service principal.
tenantId	string	Tenant id of service principal.

SourceControl

Object

Represents a SourceControl in Azure Security Insights.

Name	Type	Description
etag	string	Etag of the azure resource
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties.contentTypes	ContentType[]	Array of source control content types.
properties.description	string	A description of the source control
properties.displayName	string	The display name of the source control
properties.id	string	The id (a Guid) of the source control
properties.lastDeploymentInfo	DeploymentInfo	Information regarding the latest deployment for the source control.
properties.pullRequest	PullRequest	Information regarding the pull request of the source control.
properties.repoType	RepoType	The repository type of the source control
properties.repository	Repository	Repository metadata.
properties.repositoryAccess	RepositoryAccess	Repository access credentials. This is write-only object and it never returns back to a user.
properties.repositoryResourceInfo	RepositoryResourceInfo	Information regarding the resources created in user's repository.
properties.servicePrincipal	ServicePrincipal	Service principal metadata.
properties.version	Version	The version number associated with the source control
properties.workloadIdentityFederation	WorkloadIdentityFederation	Workload Identity metadata.
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

state

Enumeration

State of the pull request

Value	Description
Open
Closed

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

Version

Enumeration

The version of the source control.

Value	Description
V1
V2

Webhook

Object

Detail about the webhook object.

Name	Type	Description
rotateWebhookSecret	boolean	A flag to instruct the backend service to rotate webhook secret.
webhookId	string	Unique identifier for the webhook.
webhookSecretUpdateTime	string (date-time)	Time when the webhook secret was updated.
webhookUrl	string	URL that gets invoked by the webhook.

WorkloadIdentityFederation

Object

Workload Identity Federation metadata.

Name	Type	Description
appId	string	App id of Workload Identity Federation.
id	string	Id of Workload Identity Federation.
issuer	string	Issuer of Workload Identity Federation.
subject	string	Subject of Workload Identity Federation.
tenantId	string	Tenant id of Workload Identity Federation.

Share via

Source Controls - Create

URI Parameters

Request Body

Responses

Security

azure_auth

Scopes

Examples

Creates or updates a source control.

Sample request

Sample response

Definitions

AzureDevOpsResourceInfo

CloudError

CloudErrorBody

ContentType

createdByType

Deployment

DeploymentFetchStatus

DeploymentInfo

DeploymentResult

DeploymentState

GitHubResourceInfo

PullRequest

Repository

RepositoryAccess

RepositoryAccessKind

RepositoryResourceInfo

RepoType

ServicePrincipal

SourceControl

state

systemData

Version

Webhook

WorkloadIdentityFederation