Skip to content

Commit c9fa717

Browse files
authored
AzurePipelinesCredential doc updates (Azure#46668)
1 parent 28bae8e commit c9fa717

File tree

3 files changed

+9
-4
lines changed

3 files changed

+9
-4
lines changed

sdk/identity/Azure.Identity/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -241,7 +241,7 @@ Not all credentials require this configuration. Credentials that authenticate th
241241

242242
|Credential | Usage | Reference
243243
|-|-|-
244-
|[`AzurePipelinesCredential`][ref_AzurePipelinesCredential]|Supports [Microsoft Entra Workload ID](https://learn.microsoft.com/azure/devops/pipelines/release/configure-workload-identity?view=azure-devops) on Azure Pipelines.| [example](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/identity/Azure.Identity/samples/OtherCredentialSamples.md#AzurePipelinesCredential_example)
244+
|[`AzurePipelinesCredential`][ref_AzurePipelinesCredential]|Supports [Microsoft Entra Workload ID](https://learn.microsoft.com/azure/devops/pipelines/release/configure-workload-identity?view=azure-devops) on Azure Pipelines.| [example](https://aka.ms/azsdk/net/identity/azurepipelinescredential/usage)
245245
|[`ClientAssertionCredential`][ref_ClientAssertionCredential]|Authenticates a service principal using a signed client assertion. |
246246
|[`ClientCertificateCredential`][ref_ClientCertificateCredential]|Authenticates a service principal using a certificate. | [Service principal authentication](https://learn.microsoft.com/entra/identity-platform/app-objects-and-service-principals)
247247
|[`ClientSecretCredential`][ref_ClientSecretCredential]|Authenticates a service principal using a secret. | [Service principal authentication](https://learn.microsoft.com/entra/identity-platform/app-objects-and-service-principals)

sdk/identity/Azure.Identity/samples/OtherCredentialSamples.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
To set up a federated identity credential (FIC) in Azure Pipelines, you can set up the Azure Resource Manager service connection as an [automatic recommended approach](https://learn.microsoft.com/azure/devops/pipelines/library/connect-to-azure?view=azure-devops#create-an-azure-resource-manager-service-connection-that-uses-workload-identity-federation).
66
You can also create it manually either using a [user-assigned managed identity to accept the ADO-issued token as a FIC](https://learn.microsoft.com/azure/devops/pipelines/release/configure-workload-identity?view=azure-devops#set-a-workload-identity-service-connection-to-use-managed-identity-authentication) or using an [App Registration to accept the Azure DevOps-issued token as a FIC](https://learn.microsoft.com/azure/devops/pipelines/release/configure-workload-identity?view=azure-devops#set-a-workload-identity-service-connection-to-use-service-principal-authentication).
77

8-
Make sure you use one of the [recommended Azure Pipelines tasks](https://learn.microsoft.com/azure/devops/pipelines/release/troubleshoot-workload-identity?view=azure-devops#review-pipeline-tasks) so that FIC is available in Azure Pipelines.
8+
Make sure you use one of the [recommended Azure Pipelines tasks][az_pipelines_tasks] so that FIC is available in Azure Pipelines.
99

1010
To use `AzurePipelinesCredential`, configure the following values in the constructor:
1111

@@ -17,7 +17,7 @@ To use `AzurePipelinesCredential`, configure the following values in the constru
1717

1818
## Example of using an Azure Pipelines task
1919

20-
The following task YAML is an example of configuring the [AzureCLI@2](https://learn.microsoft.com/azure/devops/pipelines/tasks/reference/azure-cli-v2?view=azure-pipelines) task for using service connections federated identity with @azure/identity. See the list of [recommended Azure Pipelines tasks](https://learn.microsoft.com/azure/devops/pipelines/release/troubleshoot-workload-identity?view=azure-devops#review-pipeline-tasks).
20+
The following task YAML is an example of configuring the [AzureCLI@2](https://learn.microsoft.com/azure/devops/pipelines/tasks/reference/azure-cli-v2?view=azure-pipelines) task for using service connections federated identity with the Azure Identity library. See the list of [recommended Azure Pipelines tasks][az_pipelines_tasks].
2121

2222
```yml
2323
trigger:
@@ -93,3 +93,6 @@ var credential = new OnBehalfOfCredential(tenantId, clientId, getManagedIdentity
9393
// Use the credential to authenticate with the Key Vault client.
9494
var client = new SecretClient(new Uri("https://keyvault-name.vault.azure.net/"), credential);
9595
```
96+
97+
<!-- LINKS -->
98+
[az_pipelines_tasks]: https://aka.ms/azdo-rm-workload-identity-tasks

sdk/identity/Azure.Identity/src/Credentials/AzurePipelinesCredential.cs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,9 @@
1212
namespace Azure.Identity
1313
{
1414
/// <summary>
15-
/// Credential which authenticates using an Azure Pipelines service connection.
15+
/// Credential which authenticates using an Azure Pipelines service connection. For usage instructions, see
16+
/// <see href="https://aka.ms/azsdk/net/identity/azurepipelinescredential/usage">Authenticating in Azure
17+
/// Pipelines with service connections</see>.
1618
/// </summary>
1719
public class AzurePipelinesCredential : TokenCredential
1820
{

0 commit comments

Comments
 (0)