Skip to content

Commit 67fd146

Browse files
scottaddiebillwert
andauthored
Replace azure-identity AAD references (Azure#37076)
* Replace azure-identity AAD references * Add entra to cspell config * Update JavaDoc strings * Small tweaks * Apply suggestions from code review Co-authored-by: Bill Wert <[email protected]> * React to feedback * Add paragraph tags --------- Co-authored-by: Bill Wert <[email protected]>
1 parent ac9e374 commit 67fd146

File tree

69 files changed

+379
-388
lines changed

Some content is hidden

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

69 files changed

+379
-388
lines changed

.vscode/cspell.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -274,6 +274,7 @@
274274
"embedme",
275275
"encryptor",
276276
"endtoend",
277+
"entra",
277278
"Esto",
278279
"etag",
279280
"eventhub",

sdk/identity/azure-identity-extensions/Azure-Database-for-MySQL-README.md

Lines changed: 15 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@
77
- [Prepare the working environment](#prepare-the-working-environment)
88
- [Create an Azure Database for MySQL server](#create-an-azure-database-for-mysql-server)
99
- [Configure a firewall rule for your MySQL server](#configure-a-firewall-rule-for-your-mysql-server)
10-
- [Enable Azure AD-based authentication](#enable-azure-ad-based-authentication)
10+
- [Enable Microsoft Entra-based authentication](#enable-azure-ad-based-authentication)
1111
- [Key concepts](#key-concepts)
12-
- [Azure AD authentication with MySQL](#azure-ad-authentication-with-mysql)
12+
- [Microsoft Entra authentication with MySQL](#azure-ad-authentication-with-mysql)
1313
- [Architecture](#architecture)
1414
- [Token as password](#token-as-password)
1515
- [Examples](#examples)
@@ -27,7 +27,7 @@
2727

2828
# Azure identity JDBC MySQL plugin library for Java
2929

30-
This package contains the jdbc authentication plugin to authenticate with Azure Active Directory (Azure AD) for Azure hosted MySQL services.
30+
This package contains the JDBC authentication plugin to authenticate with Microsoft Entra ID for Azure-hosted MySQL databases.
3131

3232
[Source code][mysql_source] | [API reference documentation][docs] | [Product documentation][mysql_product_docs]
3333
| [Quickstart][quick_start_mysql]
@@ -112,10 +112,10 @@ az mysql server firewall-rule create \
112112
113113
```
114114

115-
#### Enable Azure AD-based authentication
115+
#### Enable Microsoft Entra-based authentication
116116

117-
To use Azure Active Directory access with Azure Database for MySQL, you should set the Azure Active Directory (Azure AD) admin user first. Only
118-
an Azure Active Directory (Azure AD) Admin user can create/enable users for Azure Active Directory (Azure AD)-based authentication.
117+
To use Microsoft Entra access with Azure Database for MySQL, you should set the Microsoft Entra admin user first. Only
118+
an Microsoft Entra admin user can create/enable users for Microsoft Entra-based authentication.
119119

120120
```Azure CLI
121121
az mysql server ad-admin create \
@@ -127,27 +127,23 @@ az mysql server ad-admin create \
127127

128128
## Key concepts
129129

130-
### Azure AD authentication with MySQL
130+
### Microsoft Entra authentication with MySQL
131131

132-
Microsoft Azure Active Directory (Azure Active Directory (Azure AD)) authentication is a mechanism of connecting to Azure Database for MySQL
133-
using identities defined in Azure Active Directory (Azure AD). With Azure Active Directory (Azure AD) authentication, you can manage database user identities and other
134-
Microsoft services in a central location, which simplifies permission management.
132+
Microsoft Entra authentication is a mechanism of connecting to Azure Database for MySQL using identities defined in Microsoft Entra ID. With Microsoft Entra authentication, you can manage database user identities and other Microsoft services in a central location, which simplifies permission management.
135133

136-
The following high-level diagram summarizes how authentication works using Azure Active Directory (Azure AD) authentication with Azure Database
137-
for MySQL. The arrows indicate communication pathways.
134+
The following high-level diagram summarizes how authentication works using Microsoft Entra authentication with Azure Database for MySQL. The arrows indicate communication pathways.
138135

139136
![mysql-architecture.png](img/mysql-architecture.png)
140137

141-
To learn more about using Azure Active Directory (Azure AD) with MySQL, see Use (Azure Active Directory for authenticating with
142-
MySQL)[Azure Active Directory for authenticating with MySQL]
138+
To learn more about using Microsoft Entra ID with MySQL, see Use (Microsoft Entra ID for authenticating with MySQL)[Microsoft Entra ID for authenticating with MySQL]
143139

144140
### Architecture
145141

146142
This picture shows how the jdbc authentication plugin for MySQL authenticating with managed identity.
147143

148144
![mysql_design.png](img/mysql_design.png)
149145

150-
1. The JDBC auth plugin will get an access token from Azure AD.
146+
1. The JDBC auth plugin will get an access token from Microsoft Entra ID.
151147
2. The JDBC driver will take the token obtained from step 1 as the password ( `token as password`) to connect with the MySQL server.
152148
3. The MySQL server will check the access token and authenticate internally.
153149

@@ -203,10 +199,7 @@ Connection connection=DriverManager.getConnection(url,properties);
203199

204200
### Cloud Configuration
205201

206-
Credentials default to authenticating to the Azure Active Directory endpoint for Azure Public Cloud. To access resources
207-
in other clouds, such as Azure Government or a private cloud, configure credentials with the `azure.authorityHost`
208-
argument. [AzureAuthorityHosts](https://docs.microsoft.com/java/api/com.azure.identity.azureauthorityhosts?view=azure-java-stable)
209-
defines authorities for well-known clouds:
202+
Credentials default to authenticating to the Microsoft Entra endpoint for Azure Public Cloud. To access resources in other clouds, such as Azure Government or a private cloud, configure credentials with the `azure.authorityHost` argument. [AzureAuthorityHosts](https://learn.microsoft.com/java/api/com.azure.identity.azureauthorityhosts?view=azure-java-stable) defines authorities for well-known clouds:
210203

211204
```java
212205
Properties properties=new Properties();
@@ -300,11 +293,11 @@ the [contributing guide](https://github.com/Azure/azure-sdk-for-java/blob/main/C
300293

301294
<!-- LINKS -->
302295

303-
[jdk]: https://docs.microsoft.com/java/azure/jdk/
296+
[jdk]: https://learn.microsoft.com/java/azure/jdk/
304297
[azure_subscription]: https://azure.microsoft.com/free/
305298
[mysql_source]: https://github.com/Azure/azure-sdk-for-java/tree/main/sdk/identity/azure-identity-extensions
306299
[docs]: https://azure.github.io/azure-sdk-for-java/
307-
[mysql_product_docs]: https://docs.microsoft.com/azure/mysql/single-server/overview
300+
[mysql_product_docs]: https://learn.microsoft.com/azure/mysql/single-server/overview
308301
[quick_start_mysql]: https://aka.ms/passwordless/quickstart/mysql
309-
[Azure Active Directory for authenticating with MySQL]:https://docs.microsoft.com/azure/mysql/single-server/concepts-azure-ad-authentication
302+
[Microsoft Entra ID for authenticating with MySQL]:https://learn.microsoft.com/azure/mysql/single-server/concepts-azure-ad-authentication
310303
[whatismyip.akamai.com]: https://whatismyip.akamai.com/

sdk/identity/azure-identity-extensions/Azure-Database-for-PostgreSQL-README.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@
77
- [Prepare the working environment](#prepare-the-working-environment)
88
- [Create an Azure Database for PostgreSQL server](#create-an-azure-database-for-postgresql-server)
99
- [Configure a firewall rule for your PostgreSQL server](#configure-a-firewall-rule-for-your-postgresql-server)
10-
- [Enable Azure AD-based authentication](#enable-azure-ad-based-authentication)
10+
- [Enable Microsoft Entra-based authentication](#enable-azure-ad-based-authentication)
1111
- [Key concepts](#key-concepts)
12-
- [Azure AD authentication with PostgreSQL](#azure-ad-authentication-with-postgresql)
12+
- [Microsoft Entra authentication with PostgreSQL](#azure-ad-authentication-with-postgresql)
1313
- [Architecture](#architecture)
1414
- [Token as password](#token-as-password)
1515
- [Examples](#examples)
@@ -27,7 +27,7 @@
2727

2828
# Azure identity JDBC PostgreSQL plugin library for Java
2929

30-
This package contains the jdbc authentication plugin to authenticate with Azure Active Directory (Azure AD) for Azure hosted PostgreSQL services.
30+
This package contains the JDBC authentication plugin to authenticate with Microsoft Entra ID for Azure-hosted PostgreSQL databases.
3131

3232
[Source code][postgresql_source] | [API reference documentation][docs] | [Product documentation][postgresql_product_docs]
3333
| [Quickstart][quick_start_postgresql]
@@ -83,7 +83,7 @@ Replace the placeholders with the following values, which are used throughout th
8383
region closer to where you live. You can have the full list of available regions by entering az account
8484
list-locations.
8585
- ${YOUR_POSTGRESQL_AD_NON_ADMIN_USERNAME}: The username of your PostgreSQL database server. Make ensure the username is
86-
a valid user in your Azure AD tenant.
86+
a valid user in your Microsoft Entra tenant.
8787
- ${YOUR_LOCAL_IP_ADDRESS}: The IP address of your local computer, from which you'll run your Spring Boot application.
8888
One convenient way to find it is to point your browser to [whatismyip.akamai.com][whatismyip.akamai.com].
8989

@@ -114,10 +114,10 @@ az postgres server firewall-rule create \
114114
--output tsv
115115
```
116116

117-
#### Enable Azure AD-based authentication
117+
#### Enable Microsoft Entra ID-based authentication
118118

119-
To use Azure Active Directory access with Azure Database for PostgreSQL, you should set the Azure AD admin user first.
120-
Only an Azure AD Admin user can create/enable users for Azure AD-based authentication.
119+
To use Microsoft Entra access with Azure Database for PostgreSQL, you should set the Microsoft Entra admin user first.
120+
Only a Microsoft Entra admin user can create/enable users for Microsoft Entra-based authentication.
121121

122122
```Azure CLI
123123
az postgres server ad-admin create \
@@ -129,27 +129,27 @@ az postgres server ad-admin create \
129129

130130
## Key concepts
131131

132-
### Azure AD authentication with PostgreSQL
132+
### Microsoft Entra authentication with PostgreSQL
133133

134-
Microsoft Azure Active Directory (Azure AD) authentication is a mechanism of connecting to Azure Database for PostgreSQL
135-
using identities defined in Azure AD. With Azure AD authentication, you can manage database user identities and other
134+
Microsoft Entra authentication is a mechanism of connecting to Azure Database for PostgreSQL
135+
using identities defined in Microsoft Entra ID. With Microsoft Entra authentication, you can manage database user identities and other
136136
Microsoft services in a central location, which simplifies permission management.
137137

138-
The following high-level diagram summarizes how authentication works using Azure AD authentication with Azure Database
138+
The following high-level diagram summarizes how authentication works using Microsoft Entra authentication with Azure Database
139139
for PostgreSQL. The arrows indicate communication pathways.
140140

141141
![postgresql-architecture.png](img/postgresql-architecture.png)
142142

143-
To learn more about using Azure AD with PostgreSQL, see Use (Use Azure Active Directory for authenticating with
144-
PostgreSQL)[Use Azure Active Directory for authenticating with PostgreSQL]
143+
To learn more about using Microsoft Entra ID with PostgreSQL, see (Use Microsoft Entra ID for authenticating with
144+
PostgreSQL)[Use Microsoft Entra ID for authenticating with PostgreSQL].
145145

146146
### Architecture
147147

148-
This picture shows how the jdbc authentication plugin for PostgreSQl authenticating with managed identity.
148+
This picture shows how the JDBC authentication plugin for PostgreSQL authenticating with managed identity.
149149

150150
![postgresql_design.png](img/postgresql_design.png)
151151

152-
1. The JDBC auth plugin will get an access token from Azure AD.
152+
1. The JDBC auth plugin will get an access token from Microsoft Entra ID.
153153
2. The JDBC driver will take the token obtained from step 1 as the password ( `token as password`) to connect with the PostgreSQL server.
154154
3. The PostgreSQL server will check the access token and authenticate internally.
155155

@@ -200,9 +200,9 @@ Connection connection=DriverManager.getConnection(url,properties);
200200

201201
### Cloud Configuration
202202

203-
Credentials default to authenticating to the Azure Active Directory endpoint for Azure Public Cloud. To access resources
203+
Credentials default to authenticating to the Microsoft Entra endpoint for Azure Public Cloud. To access resources
204204
in other clouds, such as Azure Government or a private cloud, configure credentials with the `azure.authorityHost`
205-
argument. [AzureAuthorityHosts](https://docs.microsoft.com/java/api/com.azure.identity.azureauthorityhosts?view=azure-java-stable)
205+
argument. [AzureAuthorityHosts](https://learn.microsoft.com/java/api/com.azure.identity.azureauthorityhosts?view=azure-java-stable)
206206
defines authorities for well-known clouds:
207207

208208
```java
@@ -293,11 +293,11 @@ the [contributing guide](https://github.com/Azure/azure-sdk-for-java/blob/main/C
293293

294294
<!-- LINKS -->
295295

296-
[jdk]: https://docs.microsoft.com/java/azure/jdk/
296+
[jdk]: https://learn.microsoft.com/java/azure/jdk/
297297
[azure_subscription]: https://azure.microsoft.com/free/
298298
[postgresql_source]: https://github.com/Azure/azure-sdk-for-java/tree/main/sdk/identity/azure-identity-extensions
299299
[docs]: https://azure.github.io/azure-sdk-for-java/
300-
[postgresql_product_docs]: https://docs.microsoft.com/azure/postgresql/single-server/overview
300+
[postgresql_product_docs]: https://learn.microsoft.com/azure/postgresql/single-server/overview
301301
[quick_start_postgresql]: https://aka.ms/passwordless/quickstart/postgresql
302-
[Use Azure Active Directory for authenticating with PostgreSQL]:https://docs.microsoft.com/azure/postgresql/single-server/concepts-azure-ad-authentication
302+
[Use Microsoft Entra ID for authenticating with PostgreSQL]:https://learn.microsoft.com/azure/postgresql/single-server/concepts-azure-ad-authentication
303303
[whatismyip.akamai.com]: https://whatismyip.akamai.com/

sdk/identity/azure-identity-extensions/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111

1212
# Azure identity authentication extensions plugin library for Java
1313

14-
This package contains authentication extensions to get a token from Azure Active Directory (Azure AD) for Azure services, like Azure Database for MySQL.
14+
This package contains authentication extensions to get a token from Microsoft Entra ID for Azure services, like Azure Database for MySQL.
1515

1616
## Getting started
1717

@@ -23,8 +23,8 @@ This package contains authentication extensions to get a token from Azure Active
2323

2424
## Key concepts
2525

26-
Azure Identity Extensions contains a common template framework for users to get a token from Azure AD and
27-
use the token as a password. For example, to connect Azure hosted MySQL, get a token from Azure AD and use the
26+
Azure Identity Extensions contains a common template framework for users to get a token from Microsoft Entra ID and
27+
use the token as a password. For example, to connect Azure hosted MySQL, get a token from Microsoft Entra ID and use the
2828
token as a password to connect with MySQL.
2929

3030
## Architecture
@@ -52,6 +52,6 @@ Other useful docs are:
5252
For details on contributing to this repository, see the [contributing guide](https://github.com/Azure/azure-sdk-for-java/blob/main/CONTRIBUTING.md).
5353

5454
<!-- LINKS -->
55-
[jdk]: https://docs.microsoft.com/java/azure/jdk/
55+
[jdk]: https://learn.microsoft.com/java/azure/jdk/
5656
[azure-identity-extensions-jdbc-mysql]: https://github.com/Azure/azure-sdk-for-java/tree/main/sdk/identity/azure-identity-extensions/Azure-Database-for-MySQL-README.md
5757
[azure-identity-extensions-jdbc-postgresql]: https://github.com/Azure/azure-sdk-for-java/tree/main/sdk/identity/azure-identity-extensions/Azure-Database-for-PostgreSQL-README.md

sdk/identity/azure-identity-extensions/src/main/java/com/azure/identity/extensions/implementation/template/AzureAuthenticationTemplate.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ public Mono<String> getTokenAsPasswordAsync() {
8989
}
9090

9191
/**
92-
* Return a password which is an Azure AD token that can be used to authenticate.
92+
* Return a password which is a Microsoft Entra token that can be used to authenticate.
9393
*
9494
* Always return a valid value, and the value won't expire in a threshold.
9595
*

sdk/identity/azure-identity-extensions/src/main/java/com/azure/identity/extensions/implementation/token/AccessTokenResolverImpl.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ public AccessTokenResolverImpl(AccessTokenResolverOptions options) {
2828

2929
/**
3030
* Get a Publisher that emits a single access token.
31-
* @param tokenCredential An AAD credential that acquires a token.
31+
* @param tokenCredential A Microsoft Entra credential that acquires a token.
3232
* @return A Publisher that emits a single access token.
3333
*/
3434
@Override

sdk/identity/azure-identity-extensions/src/main/java/com/azure/identity/extensions/jdbc/mysql/AzureMysqlAuthenticationPlugin.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
import java.util.Properties;
1616

1717
/**
18-
* The authentication plugin that enables authentication with Azure AD.
18+
* The authentication plugin that enables authentication with Microsoft Entra ID.
1919
*/
2020
public class AzureMysqlAuthenticationPlugin implements AuthenticationPlugin<NativePacketPayload> {
2121
private static final ClientLogger LOGGER = new ClientLogger(AzureMysqlAuthenticationPlugin.class);

sdk/identity/azure-identity-extensions/src/main/java/com/azure/identity/extensions/jdbc/postgresql/AzurePostgresqlAuthenticationPlugin.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
import static org.postgresql.util.PSQLState.INVALID_PASSWORD;
1414

1515
/**
16-
* The authentication plugin that enables authentication with Azure AD.
16+
* The authentication plugin that enables authentication with Microsoft Entra ID.
1717
*/
1818
public class AzurePostgresqlAuthenticationPlugin implements AuthenticationPlugin {
1919

@@ -39,11 +39,11 @@ public AzurePostgresqlAuthenticationPlugin(Properties properties) {
3939
* @param type The authentication method that the server is requesting.
4040
*
4141
* <p>AzurePostgresqlAuthenticationPlugin is used as an extension to
42-
* perform authentication with Azure AD,the value here is CLEARTEXT_PASSWORD.</p>
42+
* perform authentication with Microsoft Entra ID, the value here is CLEARTEXT_PASSWORD.</p>
4343
*
4444
* When PostgreSQL client trying to connect with PostgreSQL server:
4545
* 1. Client will send startup packet to server, the server will return the AuthenticationRequestType it accepts,
46-
* If the username is used to perform Azure AD authentication, the server will return CLEARTEXT_PASSWORD.
46+
* If the username is used to perform Microsoft Entra authentication, the server will return CLEARTEXT_PASSWORD.
4747
* 2. Client will do authentication (until AuthenticationOk).
4848
*
4949
* @return The password to use.

sdk/identity/azure-identity-perf/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,4 +31,4 @@ For details on contributing to this repository, see the [contributing guide](htt
3131
1. Create new Pull Request
3232

3333
<!-- links -->
34-
[jdk_link]: https://docs.microsoft.com/java/azure/jdk/?view=azure-java-stable
34+
[jdk_link]: https://learn.microsoft.com/java/azure/jdk/?view=azure-java-stable

sdk/identity/azure-identity/CHANGELOG.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@
142142

143143
### Features Added
144144
- [[#32527]](https://github.com/Azure/azure-sdk-for-java/pull/32527) Added Azure Developer CLI Credential.
145-
- Added support to disable instance discovery on AAD credentials.
145+
- Added support to disable instance discovery on Microsoft Entra ID credentials.
146146
- `WorkloadIdentityCredential` and `DefaultAzureCredential` support Workload Identity Federation on Kubernetes. `DefaultAzureCredential` support requires environment variable configuration as set by the Workload Identity webhook.
147147

148148
## 1.8.0 (2023-02-03)
@@ -163,7 +163,7 @@
163163

164164
### Features Added
165165
- Added support to configure `clientOptions`, `httpLogOptions`, `retryPolicy`, `retryOptions` and `addPolicy` on Identity credentials.
166-
- Added support to disable instance discovery on AAD credentials.
166+
- Added support to disable instance discovery on Microsoft Entra ID credentials.
167167

168168
## 1.7.3 (2023-01-06)
169169

@@ -666,7 +666,7 @@ The `getToken(String... scopes)` methods on all the credentials are changed to `
666666
## 1.0.0-preview.3 (2019-09-09)
667667
**New features**
668668

669-
A new credential `SharedTokenCacheCredential` is added. It's currently only supported on Windows. This credential is capable of authenticating to Azure Active Directory if you are logged in in Visual Studio 2019.
669+
A new credential `SharedTokenCacheCredential` is added. It's currently only supported on Windows. This credential is capable of authenticating to Microsoft Entra ID if you are logged in in Visual Studio 2019.
670670

671671
## 1.0.0-preview.2 (2019-08-05)
672672
**Breaking changes**
@@ -710,5 +710,5 @@ See the [documentation](https://github.com/Azure/azure-sdk-for-java/blob/main/sd
710710
for more details. User authentication will be added in an upcoming preview
711711
release.
712712

713-
This release supports only global Azure Active Directory tenants, i.e. those
713+
This release supports only global Microsoft Entra tenants, i.e. those
714714
using the https://login.microsoftonline.com authentication endpoint.

0 commit comments

Comments
 (0)