Skip to content

Commit 88fcb7a

Browse files
Merge pull request #293949 from RoseHJM/ade-freshness-jan
ADE - freshness pass January
2 parents b2275d4 + 999b675 commit 88fcb7a

File tree

3 files changed

+16
-11
lines changed

3 files changed

+16
-11
lines changed

articles/deployment-environments/how-to-authenticate.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,20 @@
11
---
22
title: Authenticate to Azure Deployment Environments REST APIs
3-
description: Learn how to authenticate to Azure Deployment Environments REST APIs by using Microsoft Entra ID.
3+
description: Learn how to authenticate to Azure Deployment Environments REST APIs as administrator or developer, by using the Azure CLI.
44
ms.service: azure-deployment-environments
55
ms.custom: build-2023
6-
ms.topic: conceptual
6+
ms.topic: concept-article
77
ms.author: rosemalcolm
88
author: RoseHJM
9-
ms.date: 11/22/2023
9+
ms.date: 01/31/2025
10+
11+
#customer intent: As a developer, I want to learn how to authenticate to Microsoft Dev Box REST APIs, so that I can securely interact with Microsoft Dev Box services.
1012
---
1113

1214
# Authenticate to Azure Deployment Environments REST APIs
1315

16+
In this article, you'll learn how to authenticate to Microsoft Dev Box REST APIs using the Azure CLI. Authentication is a crucial step for accessing both administrator (control plane) and developer (data plane) APIs. This guide walks you through retrieving an access token from Microsoft Entra ID, understanding the token's structure and validity, and using the bearer token to access REST APIs. By following these steps, you can securely interact with Microsoft Dev Box services.
17+
1418
> [!TIP]
1519
> Before authenticating, ensure that the user or identity has the appropriate permissions to perform the desired action. For more information, see [Provide access for dev team leads](./how-to-configure-project-admin.md) and [Provide access for developers](./how-to-configure-deployment-environments-user.md).
1620
@@ -30,7 +34,7 @@ az login
3034

3135
The command opens a browser window to the Microsoft Azure authentication page, where you can choose an account. The page requires you to give your Microsoft Entra ID username and password.
3236

33-
Next, set the correct subscription context. If you authenticate from an incorrect subscription or tenant, you might receive unexpected **403 Forbidden** errors.
37+
Next, set the correct subscription context. If you authenticate from an incorrect subscription or tenant, you might receive unexpected *403 Forbidden* errors.
3438

3539
```azurecli
3640
az account set --subscription <subscription_id>
@@ -74,6 +78,6 @@ The token is a Base64 string. The token is valid for at least five minutes. The
7478

7579
To access REST APIs, you must set the authorization header on your request. The header value should be the string `Bearer` followed by a space and the token you received in the previous step.
7680

77-
## Next steps
81+
## Related content
7882

79-
- [Review Microsoft Entra ID fundamentals](../../articles/active-directory/fundamentals/whatis.md)
83+
- Review [Microsoft Entra ID fundamentals](../../articles/active-directory/fundamentals/whatis.md)

articles/deployment-environments/how-to-install-devcenter-cli-extension.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@ ms.custom: build-2023, devx-track-azurecli
88
ms.topic: how-to
99
ms.author: rosemalcolm
1010
author: RoseHJM
11-
ms.date: 11/22/2023
11+
ms.date: 01/31/2025
12+
1213
#Customer intent: As a platform engineer, I want to install the devcenter extension so that I can create Deployment Environments resources from the command line.
1314
---
1415

@@ -74,6 +75,6 @@ You might find the following commands useful while you work with the devcenter e
7475
az devcenter admin --help
7576
```
7677
77-
## Next steps
78+
## Related content
7879
7980
For complete command listings, see the [Microsoft Dev Box and Azure Deployment Environments Azure CLI documentation](https://aka.ms/CLI-reference).

articles/dev-box/how-to-authenticate.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ ms.date: 01/31/2025
1111
---
1212
# Authenticating to Microsoft Dev Box REST APIs
1313

14-
In this article, you will learn how to authenticate to Microsoft Dev Box REST APIs using the Azure CLI. Authentication is a crucial step for accessing both administrator (control plane) and developer (data plane) APIs. This guide will walk you through retrieving an access token from Microsoft Entra ID, understanding the token's structure and validity, and using the bearer token to access REST APIs. By following these steps, you can securely interact with Microsoft Dev Box services.
14+
In this article, you'll learn how to authenticate to Microsoft Dev Box REST APIs using the Azure CLI. Authentication is a crucial step for accessing both administrator (control plane) and developer (data plane) APIs. This guide walks you through retrieving an access token from Microsoft Entra ID, understanding the token's structure and validity, and using the bearer token to access REST APIs. By following these steps, you can securely interact with Microsoft Dev Box services.
1515

1616
> [!TIP]
1717
> Before authenticating, ensure that the user or identity has the appropriate permissions to perform the desired action. For more information, see [configuring project admins](./how-to-project-admin.md) and [configuring Dev Box users](./how-to-dev-box-user.md).
@@ -33,7 +33,7 @@ az login
3333

3434
The command opens a browser window to the Microsoft Entra authentication page. It requires you to give your Microsoft Entra user ID and password.
3535

36-
Next, set the correct subscription context. If you authenticate from an incorrect subscription or tenant, you might receive unexpected 403 Forbidden errors.
36+
Next, set the correct subscription context. If you authenticate from an incorrect subscription or tenant, you might receive unexpected *403 Forbidden* errors.
3737

3838
```azurecli
3939
az account set --subscription <subscription_id>
@@ -69,7 +69,7 @@ After authentication is successful, Microsoft Entra ID returns an access token f
6969
}
7070
```
7171

72-
The token is a Base64 string. The token is valid for at least 5 minutes with the maximum of 90 minutes. The expiresOn defines the actual token expiration time.
72+
The token is a Base64 string. The token is valid for at least 5 minutes with the maximum of 90 minutes. The `expiresOn` defines the actual token expiration time.
7373

7474
> [!TIP]
7575
> Developer API tokens for the service are encrypted and can't be decoded using JWT decoding tools. They can only be processed by the service.

0 commit comments

Comments
 (0)