> ## Documentation Index
> Fetch the complete documentation index at: https://sourcebot-whoisthey-language-model-input-modalities.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Linking code from Azure Devops Server

If you're not familiar with Sourcebot [connections](/docs/connections/indexing-your-code), please read that overview first.

## Examples

<AccordionGroup>
  <Accordion title="Enable TFS path support">
    This is required if you're using an older version of ADO Server which has `/tfs` in the repo paths.

    ```json theme={null}
    {
        "type": "azuredevops",
        "deploymentType": "server",
        "useTfsPath": true,
        "repos": [
            "organizationName/projectName/repoName",
            "organizationName/projectName/repoName2
        ]
    }   
    ```
  </Accordion>

  <Accordion title="Sync individual repos">
    ```json theme={null}
    {
        "type": "azuredevops",
        "deploymentType": "server",
        "repos": [
            "organizationName/projectName/repoName",
            "organizationName/projectName/repoName2
        ]
    }
    ```
  </Accordion>

  <Accordion title="Sync all repos in a collection">
    ```json theme={null}
    {
        "type": "azuredevops",
        "deploymentType": "server",
        "orgs": [
            "collectionName",
            "collectionName2"
        ]
    }
    ```
  </Accordion>

  <Accordion title="Sync all repos in a project">
    ```json theme={null}
    {
        "type": "azuredevops",
        "deploymentType": "server",
        "projects": [
            "collectionName/projectName",
            "collectionName/projectName2"
        ]
    }
    ```
  </Accordion>

  <Accordion title="Exclude repos from syncing">
    ```json theme={null}
    {
        "type": "azuredevops",
        "deploymentType": "server",
        // Include all repos in my-org...
        "orgs": [
            "my-org"
        ],
        // ...except:
        "exclude": {
            // repos that are disabled 
            "disabled": true,
            // repos that match these glob patterns
            "repos": [
                "reposToExclude*"
            ],
            // projects that match these glob patterns
            "projects": [
                "projectstoExclude*"
            ]
            // repos less than the defined min OR larger than the defined max
            "size": {
                // repos that are less than 1MB (in bytes)...
                "min": 1048576,
                // or repos greater than 100MB (in bytes)
                "max": 104857600 
            }
        }
    }
    ```
  </Accordion>
</AccordionGroup>

## Authenticating with Azure Devops Server

Azure Devops Server requires you to provide a PAT in order to index your repositories. To learn how to create PAT, check out the [Azure Devops docs](https://learn.microsoft.com/en-us/azure/devops/organizations/accounts/use-personal-access-tokens-to-authenticate?view=azure-devops\&tabs=Windows).
Sourcebot needs the `Read` access for the `Code` scope in order to find and clone your repos.

Next, provide the access [token](/docs/configuration/config-file#tokens) via an environment variable which is referenced in the `token` property:

<Tabs>
  <Tab title="Environment Variable">
    1. Add the `token` property to your connection config:

    ```json theme={null}
    {
        "type": "azuredevops",
        "deploymentType": "server",
        "token": {
            // note: this env var can be named anything. It
            // doesn't need to be `ADO_TOKEN`.
            "env": "ADO_TOKEN"
        },
        // At least one of the following is required to specify which repos to sync:
        "repos": ["collectionName/projectName/repoName"],
        // "orgs": ["collectionName"],
        // "projects": ["collectionName/projectName"]
    }
    ```

    2. Pass this environment variable each time you run Sourcebot:

    ```bash theme={null}
    docker run \
        -e ADO_TOKEN=<PAT> \
        /* additional args */ \
        ghcr.io/sourcebot-dev/sourcebot:latest
    ```
  </Tab>
</Tabs>

## Schema reference

<Accordion title="Reference">
  [schemas/v3/azuredevops.json](https://github.com/sourcebot-dev/sourcebot/blob/main/schemas/v3/azuredevops.json)

  ```json theme={null}
  {
    "$schema": "http://json-schema.org/draft-07/schema#",
    "type": "object",
    "title": "AzureDevOpsConnectionConfig",
    "properties": {
      "type": {
        "const": "azuredevops",
        "description": "Azure DevOps Configuration"
      },
      "token": {
        "description": "A Personal Access Token (PAT).",
        "anyOf": [
          {
            "type": "object",
            "properties": {
              "env": {
                "type": "string",
                "description": "The name of the environment variable that contains the token."
              }
            },
            "required": [
              "env"
            ],
            "additionalProperties": false
          },
          {
            "type": "object",
            "properties": {
              "googleCloudSecret": {
                "type": "string",
                "description": "The resource name of a Google Cloud secret. Must be in the format `projects/<project-id>/secrets/<secret-name>/versions/<version-id>`. See https://cloud.google.com/secret-manager/docs/creating-and-accessing-secrets"
              }
            },
            "required": [
              "googleCloudSecret"
            ],
            "additionalProperties": false
          }
        ]
      },
      "url": {
        "type": "string",
        "format": "url",
        "default": "https://dev.azure.com",
        "description": "The URL of the Azure DevOps host. For Azure DevOps Cloud, use https://dev.azure.com. For Azure DevOps Server, use your server URL.",
        "examples": [
          "https://dev.azure.com",
          "https://azuredevops.example.com"
        ],
        "pattern": "^https?:\\/\\/[^\\s/$.?#].[^\\s]*$"
      },
      "deploymentType": {
        "type": "string",
        "enum": [
          "cloud",
          "server"
        ],
        "description": "The type of Azure DevOps deployment"
      },
      "useTfsPath": {
        "type": "boolean",
        "default": false,
        "description": "Use legacy TFS path format (/tfs) in API URLs. Required for older TFS installations (TFS 2018 and earlier). When true, API URLs will include /tfs in the path (e.g., https://server/tfs/collection/_apis/...)."
      },
      "orgs": {
        "type": "array",
        "items": {
          "type": "string",
          "pattern": "^[\\w.-]+$"
        },
        "default": [],
        "examples": [
          [
            "my-org"
          ]
        ],
        "description": "List of organizations to sync with. For Cloud, this is the organization name. For Server, this is the collection name. All projects and repositories visible to the provided `token` will be synced, unless explicitly defined in the `exclude` property."
      },
      "projects": {
        "type": "array",
        "items": {
          "type": "string",
          "pattern": "^[\\w.-]+\\/[\\w. -]+$"
        },
        "default": [],
        "examples": [
          [
            "my-org/my-project",
            "my-collection/my-project"
          ]
        ],
        "description": "List of specific projects to sync with. Expected to be formatted as '{orgName}/{projectName}' for Cloud or '{collectionName}/{projectName}' for Server."
      },
      "repos": {
        "type": "array",
        "items": {
          "type": "string",
          "pattern": "^[\\w.-]+\\/[\\w. -]+\\/[\\w. -]+$"
        },
        "default": [],
        "examples": [
          [
            "my-org/my-project/my-repo"
          ]
        ],
        "description": "List of individual repositories to sync with. Expected to be formatted as '{orgName}/{projectName}/{repoName}'."
      },
      "exclude": {
        "type": "object",
        "properties": {
          "disabled": {
            "type": "boolean",
            "default": false,
            "description": "Exclude disabled repositories from syncing."
          },
          "repos": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "default": [],
            "description": "List of repositories to exclude from syncing. Glob patterns are supported."
          },
          "projects": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "default": [],
            "description": "List of projects to exclude from syncing. Glob patterns are supported."
          },
          "size": {
            "type": "object",
            "description": "Exclude repositories based on their size.",
            "properties": {
              "min": {
                "type": "integer",
                "description": "Minimum repository size (in bytes) to sync (inclusive). Repositories less than this size will be excluded from syncing."
              },
              "max": {
                "type": "integer",
                "description": "Maximum repository size (in bytes) to sync (inclusive). Repositories greater than this size will be excluded from syncing."
              }
            },
            "additionalProperties": false
          }
        },
        "additionalProperties": false
      },
      "revisions": {
        "type": "object",
        "description": "The revisions (branches, tags) that should be included when indexing. The default branch (HEAD) is always indexed. A maximum of 64 revisions can be indexed, with any additional revisions being ignored.",
        "properties": {
          "branches": {
            "type": "array",
            "description": "List of branches to include when indexing. For a given repo, only the branches that exist on the repo's remote *and* match at least one of the provided `branches` will be indexed. The default branch (HEAD) is always indexed. Glob patterns are supported. A maximum of 64 branches can be indexed, with any additional branches being ignored.",
            "items": {
              "type": "string"
            },
            "examples": [
              [
                "main",
                "release/*"
              ],
              [
                "**"
              ]
            ],
            "default": []
          },
          "tags": {
            "type": "array",
            "description": "List of tags to include when indexing. For a given repo, only the tags that exist on the repo's remote *and* match at least one of the provided `tags` will be indexed. Glob patterns are supported. A maximum of 64 tags can be indexed, with any additional tags being ignored.",
            "items": {
              "type": "string"
            },
            "examples": [
              [
                "latest",
                "v2.*.*"
              ],
              [
                "**"
              ]
            ],
            "default": []
          }
        },
        "additionalProperties": false
      },
      "enforcePermissions": {
        "type": "boolean",
        "description": "Controls whether repository permissions are enforced for this connection. When `PERMISSION_SYNC_ENABLED` is false, this setting has no effect. Defaults to the value of `PERMISSION_SYNC_ENABLED`. See https://docs.sourcebot.dev/docs/features/permission-syncing"
      },
      "enforcePermissionsForPublicRepos": {
        "type": "boolean",
        "default": false,
        "description": "Controls whether repository permissions are enforced for public repositories in this connection. When true, public repositories are only visible to users with a linked account for this connection's code host. When false, public repositories are visible to all users. Has no effect when enforcePermissions is false. Defaults to false. See https://docs.sourcebot.dev/docs/features/permission-syncing"
      }
    },
    "required": [
      "type",
      "token",
      "deploymentType"
    ],
    "additionalProperties": false
  }
  ```
</Accordion>