Skip to content

Commit cfb7cd4

Browse files
authored
Merge branch 'main' into users/sdanie/440878
2 parents cad7c4c + 4a05c92 commit cfb7cd4

File tree

56 files changed

+802
-273
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

56 files changed

+802
-273
lines changed

docs/artifacts/reference/limits.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Azure Artifacts is a highly scalable package management solution that enables de
2929

3030
- **NuGet packages**: limited to 500 MiB per file.
3131

32-
- **Npm packages**: limited to 500 MiB per file.
32+
- **Npm packages**: limited to 500 MiB per file. Additionally, Azure Artifacts enforces a separate hard limit of 375 KB specifically for the *package.json* file.
3333

3434
- **Maven packages**: limited to 500 MiB per file.
3535

docs/boards/github/connect-on-premises-to-github.md

Lines changed: 23 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ ms.topic: how-to
77
ms.author: chcomley
88
author: chcomley
99
monikerRange: "<azure-devops"
10-
ms.date: 07/12/2023
10+
ms.date: 06/13/2025
1111
---
1212

1313
# Connect Azure DevOps Server to GitHub (on-premises)
@@ -16,13 +16,10 @@ ms.date: 07/12/2023
1616

1717
<!--- Supports https://go.microsoft.com/fwlink/?linkid=2095009 -->
1818

19-
::: moniker range="azure-devops-2020"
2019
When you connect your Azure DevOps Server project to your GitHub repositories, you support linking between GitHub commits and pull requests to work items. You can use GitHub for software development while using Azure Boards to plan and track your work.
2120

2221
> [!NOTE]
23-
> On-premises Azure DevOps Server 2020 supports integration with GitHub.com and GitHub Enterprise Server repositories. If you want to connect from Azure DevOps Services, see [Connect Azure Boards to GitHub](./connect-to-github.md?preserve-view=true&view=azure-devops).
24-
25-
::: moniker-end
22+
> Azure DevOps Server supports integration with GitHub.com and GitHub Enterprise Server repositories. To connect from Azure DevOps Services, see [Connect Azure Boards to GitHub](./connect-to-github.md?preserve-view=true&view=azure-devops).
2623
2724
## Prerequisites
2825

@@ -34,77 +31,70 @@ When you connect your Azure DevOps Server project to your GitHub repositories, y
3431

3532
## Authentication options
3633

37-
The following authentication options are supported.
34+
The following authentication options are supported:
3835

39-
::: moniker range="azure-devops-2020"
40-
- [PAT](#server-github-ent-pat)
36+
- [GitHub PAT](#server-github-ent-pat)
4137
- [GitHub credentials](#server-github-ent-credentials)
4238

4339
> [!NOTE]
4440
> OAuth isn't supported for Azure DevOps Server 2020.
45-
::: moniker-end
4641
4742
<a id="github-oauth"></a>
4843
<a id="github-pat"></a>
4944
<a id="server-github-ent-oauth-register"></a>
5045

5146
## Connect Azure DevOps Server to GitHub Enterprise Server
5247

53-
::: moniker range="azure-devops-2020"
5448
You can connect up to 250 GitHub repositories to an Azure Boards project.
5549

50+
::: moniker range="azure-devops-2020"
5651
> [!NOTE]
57-
> Connection to more than 100 GitHub repositories requires Azure DevOps Server 2020.1 update or later version.
58-
> Connection to GitHub.com repositories requires Azure DevOps Server 2020.1.1 Patch 2 or later version.
52+
> - Connection to more than 100 GitHub repositories requires Azure DevOps Server 2020.1 update or later version.
53+
> - Connection to GitHub.com repositories requires Azure DevOps Server 2020.1.1 Patch 2 or later version.
5954
::: moniker-end
6055

61-
62-
6356
1. Open the web portal for your Azure DevOps Server.
6457

6558
2. Select the :::image type="icon" source="../../media/icons/project-icon.png" border="false"::: Azure DevOps logo to open **Projects**, and then choose the Azure Boards project you want to configure to connect to your GitHub Enterprise repositories.
6659

67-
::: moniker range="azure-devops-2020"
68-
6960
3. Select **Project settings** > **GitHub connections**.
7061

71-
:::image type="content" source="media/github-ent/open-project-settings-github-connections-2020-1.png" alt-text="Screenshot of open Project Settings>GitHub connections.":::
62+
:::image type="content" source="media/github-ent/open-project-settings-github-connections-2020-1.png" alt-text="Screenshot of open Project Settings, GitHub connections.":::
7263

73-
4. If it's the first time making a connection from the project, choose the authentication method you want to use to make the connection:
64+
4. If it's your first time making a connection from the project, choose the authentication method you want to use to make the connection:
7465

75-
- **Personal Access Token**, for details see [Connect using a Personal Access Token](#github-ent-pat).
76-
- **GitHub credentials**, see [Connect using GitHub credentials](#server-github-ent-credentials).
66+
- **GitHub Personal Access Token**: For details, see [Connect using a GitHub PAT](#github-ent-pat).
67+
- **GitHub credentials**: For details, see [Connect using GitHub credentials](#server-github-ent-credentials).
7768

7869
:::image type="content" source="media/github-ent/connect-github-account-first-time.png" alt-text="Screenshot of first time connecting with GitHub credentials.":::
7970

8071
Otherwise, select :::image type="icon" source="../../media/icons/add-light-icon.png" border="false"::: **New connection**, and the select your authentication method from the **New Connection** dialog.
81-
::: moniker-end
8272

8373
<a id="server-github-ent-pat"></a>
8474
<a id="github-ent-pat"></a>
8575

86-
#### Connect with a Personal Access Token
76+
## Connect Azure DevOps Server with a GitHub Personal Access Token
8777

88-
1. To create a PAT, see [Creating a personal access token](https://help.github.com/en/articles/creating-a-personal-access-token-for-the-command-line).
78+
1. To create a GitHub PAT, see [Create a GitHub PAT](https://help.github.com/en/articles/creating-a-personal-access-token-for-the-command-line).
8979

9080
> [!TIP]
9181
> When you create your GitHub PAT, make sure that you include these scopes: `repo, admin:repo_hook, read:user, user:email`.
9282

9383
1. Enter the URL for your GitHub Enterprise server and the **Personal access token** credentials recognized by that server. And then select **Connect**.
9484

95-
:::image type="content" source="media/github-ent/ads-add-ghe-pat.png" alt-text="Screenshot of sign in with PAT.":::
85+
:::image type="content" source="media/github-ent/ads-add-ghe-pat.png" alt-text="Screenshot of sign in with GitHub PAT.":::
9686

9787
<a id="server-github-ent-credentials"></a>
9888

99-
#### Connect with GitHub credentials
89+
## Connect Azure DevOps Server with GitHub credentials
10090

10191
1. Enter the URL for your GitHub Enterprise server and the administrator account credentials recognized by that server. And then choose **Connect**.
10292

103-
:::image type="content" source="media/github-ent/ads-add-ghe-user-name.png" alt-text="Screenshot of sign in with GitHub credentials.":::
93+
:::image type="content" source="media/github-ent/ads-add-ghe-user-name.png" alt-text="Screenshot of sign in with GitHub credentials.":::
10494

10595
2. The dialog lists all repositories for which you have GitHub administration rights. You can toggle between **Mine** and **All** to determine if others appear, and then check the ones that you want to add. Choose **Save** when you're done.
10696

107-
:::image type="content" source="media/github-ent/ads-add-ghe-repositories.png" alt-text="Screenshot of repositories to select to add.":::
97+
:::image type="content" source="media/github-ent/ads-add-ghe-repositories.png" alt-text="Screenshot of repositories to select to add.":::
10898

10999
3. To connect to a GitHub account or organization from Azure Boards for the first time, you also install the Azure Boards app for GitHub. Complete the integration by following the procedures outlined in [Confirm the connection](connect-to-github.md#confirm-connection).
110100

@@ -113,7 +103,7 @@ You can connect up to 250 GitHub repositories to an Azure Boards project.
113103
The Azure Boards-GitHub integration relies on various authentication protocols to support the connection. Changes to a user's permission scope or authentication credentials can cause revocation of the GitHub repositories connected to Azure Boards.
114104

115105
For an overview of the integration that the Azure Boards app for GitHub supports, see [Azure Boards-GitHub integration](index.md).
116-
106+
<!--
117107
#### Supported authentication options
118108
119109
The following authentication options are supported based on the GitHub platform you want to connect to.
@@ -170,33 +160,27 @@ The following authentication options are supported based on the GitHub platform
170160
:::row-end:::
171161
172162
[!INCLUDE[temp](../includes/github-platform-support.md)]
173-
174-
#### Resolve access issues
175-
176-
::: moniker range=">= azure-devops-2020"
163+
-->
177164

178165
When the Azure Boards connection to GitHub no longer has access, it shows an alert status in the user interface with a red-X. Hover over the alert and it indicates that the credentials are no longer valid. To correct the problem, remove the connection and recreate a new connection.
179166

180167
:::image type="content" source="media/troubleshoot/failed-connection.png" alt-text="Screenshot of failed connection.":::
181-
182-
::: moniker-end
183168

184-
185169
Consider the following resolutions:
186170

187171
- **If the connection is using OAuth**:
188-
- The Azure Boards application had its access denied for one of the repositories.
172+
- The Azure Boards application had access denied for one of the repositories.
189173
- GitHub might be unavailable/unreachable. This unavailability could be because of an outage in either service or an infrastructure/network issue on-premises. You can check service status from the following links:
190174
- [GitHub](https://status.github.com)
191175
- [Azure DevOps](https://status.dev.azure.com/)
192176

193177
Delete and recreate the connection to the GitHub repository. This recreated connection causes GitHub to prompt to reauthorize Azure Boards.
194178

195-
- **If the connection is using a PAT:**
196-
- The PAT was revoked or the required permission scopes changed and are insufficient.
179+
- **If the connection is using a GitHub PAT:**
180+
- The GitHub PAT was revoked or the required permission scopes changed and are insufficient.
197181
- The user perhaps lost administrative permissions on the GitHub repository.
198182

199-
Recreate the PAT and ensure the scope for the token includes the required permissions: `repo, read:user, user:email, admin:repo_hook`. For more information, see [Best practices for using PATs](../../organizations/accounts/use-personal-access-tokens-to-authenticate.md#best-practices-for-using-pats).
183+
Recreate the GitHub PAT and ensure the scope for the token includes the required permissions: `repo, read:user, user:email, admin:repo_hook`.
200184

201185
<a id="update-wits"></a>
202186

docs/boards/integrations/boards-teams.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ After the app installs, you see a welcome message in the Teams conversation pane
6060

6161
:::image type="content" source="media/integrations-teams/welcome-message.png" alt-text="Screenshot of the Welcome message in the conversation pane.":::
6262

63-
### Azure Pipelines app commands
63+
### Azure Boards app commands
6464

6565
You can use the following `@azure boards` commands to interact with the Azure Boards app in your Teams channel.
6666

docs/integrate/get-started/rest/samples.md

Lines changed: 52 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,14 @@
22
title: REST API samples
33
description: REST API samples for Azure DevOps, including personal access tokens (PATs).
44
ms.assetid: 9E17A266-051F-403F-A285-7F21D9CC52F0
5+
ai-usage: ai-assisted
56
ms.subservice: azure-devops-ecosystem
67
ms.topic: conceptual
78
ms.custom: devx-track-dotnet
89
monikerRange: '<= azure-devops'
910
ms.author: chcomley
1011
author: chcomley
11-
ms.date: 03/21/2025
12+
ms.date: 06/12/2025
1213
---
1314

1415
# REST API samples for Azure DevOps
@@ -17,26 +18,30 @@ ms.date: 03/21/2025
1718

1819
Most samples in this article use personal access tokens (PATs). While PATs are a compact example for authentication, we don't recommend using them for production applications. There are many other authentication mechanisms available, including Microsoft Authentication Library, OAuth, and Session tokens. For more information to gauge which is best suited for your scenario, see [Authentication guidance](../authentication/authentication-guidance.md).
1920

20-
For more information, see [Azure DevOps Services REST API Reference](/rest/api/azure/devops/?view=azure-devops-rest-7.2&preserve-view=true) and [Get started with REST APIs](../../how-to/call-rest-api.md).
21+
For more information, see [Azure DevOps REST API Reference](/rest/api/azure/devops/?view=azure-devops-rest-7.2&preserve-view=true) and [Get started with REST APIs](../../how-to/call-rest-api.md).
2122

22-
## Personal access tokens
23+
## Authentication
2324

24-
Authenticate with Azure DevOps when you use the REST APIs or .NET Libraries.
25+
Authenticate with Azure DevOps when using the REST APIs or .NET Libraries by following these steps:
2526

26-
Get started with these samples and [create a PAT](../../../organizations/accounts/use-personal-access-tokens-to-authenticate.md).
27+
- **Create a PAT:**
28+
Start with these samples and [create a personal access token (PAT)](../../../organizations/accounts/use-personal-access-tokens-to-authenticate.md).
2729

28-
> [!NOTE]
29-
> We don't recommend using PATs. For more secure authentication mechanisms, see [Authentication guidance](../authentication/authentication-guidance.md).
30+
[!INCLUDE [use-microsoft-entra-reduce-pats](../../../includes/use-microsoft-entra-reduce-pats.md)]
3031

31-
To provide the PAT through an HTTP header, first convert it to a Base64 string. The following example shows how to convert to Base64 using C#. You can provide the resulting string as an HTTP header in the following format:
32+
- **Use Basic Authentication with a PAT:**
33+
1. Convert your PAT to a Base64-encoded string in the format `username:PAT` (the username can be empty).
34+
2. Add the encoded string to the `Authorization` HTTP header.
3235

33-
``
34-
Authorization: Basic BASE64USERNAME:PATSTRING
35-
``
36+
**Example using Basic Authentication with curl:**
3637

37-
## REST API
38+
```bash
39+
curl -u :{yourPAT} https://dev.azure.com/{organization}/_apis/projects?api-version=7.2-preview.1
40+
```
3841

39-
See the following example of getting a list of projects for your organization via REST API.
42+
## GET request samples
43+
44+
The following C# and curl requests return a JSON response containing the list of all projects in a specified organization:
4045

4146
```cs
4247
using System.Net.Http;
@@ -69,7 +74,40 @@ using (var client = new HttpClient())
6974
//var value = response.Content.ReadAsStringAsync().Result;
7075
}
7176
}
77+
```
78+
79+
80+
```curl
81+
-u username:PAT https://dev.azure.com/{organization}/_apis/projects?api-version=6.0
82+
```
83+
84+
## POST request sample
85+
86+
The following curl request creates a new work item of the "Task" type in a specified project:
87+
88+
```curl
89+
-u username:PAT -X POST -H "Content-Type: application/json" \
90+
-d '{"fields": {"System.Title": "New Work Item"}}' \
91+
https://dev.azure.com/{organization}/{project}/_apis/wit/workitems/$Task?api-version=6.0
92+
```
93+
94+
## PUT request sample
95+
96+
The following curl request updates an existing work item by changing its state to "In Progress":
97+
98+
```curl
99+
-u username:PAT -X PATCH -H "Content-Type: application/json-patch+json" \
100+
-d '[{"op": "add", "path": "/fields/System.State", "value": "In Progress"}]' \
101+
https://dev.azure.com/{organization}/{project}/_apis/wit/workitems/{id}?api-version=6.0
102+
```
103+
104+
## DELETE request sample
105+
106+
The following curl request deletes an existing work item from a specified project:
72107

108+
```curl
109+
-u username:PAT -X DELETE \
110+
https://dev.azure.com/{organization}/{project}/_apis/wit/workitems/{id}?api-version=6.0
73111
```
74112

75113
## .NET Client Libraries
@@ -79,7 +117,7 @@ Here, we're using two of the .NET Client Libraries. Make sure you reference the
79117
- [Microsoft.TeamFoundationServer.Client](https://www.nuget.org/packages/Microsoft.TeamFoundationServer.Client/)
80118
- [Microsoft.Visual Studio.Services.Client](https://www.nuget.org/packages/Microsoft.VisualStudio.Services.Client/)
81119

82-
See the following example of getting a list of projects for your organization via .NET Client Libraries.
120+
The following example gets a list of projects for your organization via .NET Client Libraries:
83121

84122
```cs
85123
using Microsoft.TeamFoundation.Core.WebApi;

0 commit comments

Comments
 (0)