You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: sdk/identity/Azure.Identity/README.md
+1-5Lines changed: 1 addition & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -77,11 +77,7 @@ See [Credential Classes](#credential-classes) for a complete listing of availabl
77
77
78
78
### DefaultAzureCredential
79
79
80
-
The `DefaultAzureCredential` is appropriate for most scenarios where the application is intended to ultimately be run in Azure. This is because the `DefaultAzureCredential` combines credentials commonly used to authenticate when deployed, with credentials used to authenticate in a development environment.
81
-
82
-
> Note: `DefaultAzureCredential` is intended to simplify getting started with the SDK by handling common scenarios with reasonable default behaviors. Developers who want more control or whose scenario isn't served by the default settings should use other credential types.
83
-
84
-
The `DefaultAzureCredential` attempts to authenticate via the following mechanisms, in this order, stopping when one succeeds:
80
+
The `DefaultAzureCredential` simplifies authentication while developing applications that deploy to Azure by combining credentials used in Azure hosting environments and credentials used in local development. In production, it's better to use a specific credential type so authentication is more predictable and easier to debug. `DefaultAzureCredential` attempts to authenticate via the following mechanisms in this order, stopping when one succeeds:
Copy file name to clipboardExpand all lines: sdk/identity/Azure.Identity/src/Credentials/DeviceCodeCredential.cs
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -52,7 +52,7 @@ public DeviceCodeCredential(DeviceCodeCredentialOptions options)
52
52
/// Creates a new DeviceCodeCredential with the specified options, which will authenticate users with the specified application.
53
53
/// </summary>
54
54
/// <param name="deviceCodeCallback">The callback to be executed to display the device code to the user</param>
55
-
/// <param name="clientId">The client id of the application to which the users will authenticate</param>
55
+
/// <param name="clientId">The client ID of the application to which the users will authenticate. It's recommended that developers register their applications and assign appropriate roles. For more information, visit <see href="https://aka.ms/azsdk/identity/AppRegistrationAndRoleAssignment"/>. If not specified, users will authenticate to an Azure development application, which isn't recommended for production scenarios.</param>
56
56
/// <param name="options">The client options for the newly created DeviceCodeCredential</param>
@@ -65,7 +65,7 @@ public DeviceCodeCredential(Func<DeviceCodeInfo, CancellationToken, Task> device
65
65
/// </summary>
66
66
/// <param name="deviceCodeCallback">The callback to be executed to display the device code to the user</param>
67
67
/// <param name="tenantId">The tenant id of the application to which users will authenticate. This can be null for multi-tenanted applications.</param>
68
-
/// <param name="clientId">The client id of the application to which the users will authenticate</param>
68
+
/// <param name="clientId">The client id of the application to which the users will authenticate. It is recommended that developers register their applications and assign appropriate roles. For more information, visit <see href="https://aka.ms/azsdk/identity/AppRegistrationAndRoleAssignment"/>. If not specified, users will authenticate to an Azure development application, which is not recommended for production scenarios.</param>
69
69
/// <param name="options">The client options for the newly created DeviceCodeCredential</param>
Copy file name to clipboardExpand all lines: sdk/identity/Azure.Identity/src/Credentials/DeviceCodeCredentialOptions.cs
+2Lines changed: 2 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -39,6 +39,8 @@ public string TenantId
39
39
40
40
/// <summary>
41
41
/// The client ID of the application used to authenticate the user. If not specified the user will be authenticated with an Azure development application.
42
+
/// It is recommended that developers register their applications and assign appropriate roles. For more information, visit <see href="https://aka.ms/azsdk/identity/AppRegistrationAndRoleAssignment"/>.
43
+
/// If not specified, users will authenticate to an Azure development application, which is not recommended for production scenarios.
Copy file name to clipboardExpand all lines: sdk/identity/Azure.Identity/src/Credentials/InteractiveBrowserCredential.cs
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -57,7 +57,7 @@ public InteractiveBrowserCredential(InteractiveBrowserCredentialOptions options)
57
57
/// <summary>
58
58
/// Creates a new <see cref="InteractiveBrowserCredential"/> with the specified options, which will authenticate users with the specified application.
59
59
/// </summary>
60
-
/// <param name="clientId">The client id of the application to which the users will authenticate</param>
60
+
/// <param name="clientId">The client id of the application to which the users will authenticate. It is recommended that developers register their applications and assign appropriate roles. For more information, visit <see href="https://aka.ms/azsdk/identity/AppRegistrationAndRoleAssignment"/>. If not specified, users will authenticate to an Azure development application, which is not recommended for production scenarios.</param>
@@ -67,7 +67,7 @@ public InteractiveBrowserCredential(string clientId)
67
67
/// Creates a new <see cref="InteractiveBrowserCredential"/> with the specified options, which will authenticate users with the specified application.
68
68
/// </summary>
69
69
/// <param name="tenantId">The tenant id of the application and the users to authenticate. Can be null in the case of multi-tenant applications.</param>
70
-
/// <param name="clientId">The client id of the application to which the users will authenticate</param>
70
+
/// <param name="clientId">The client id of the application to which the users will authenticate. It is recommended that developers register their applications and assign appropriate roles. For more information, visit <see href="https://aka.ms/azsdk/identity/AppRegistrationAndRoleAssignment"/>. If not specified, users will authenticate to an Azure development application, which is not recommended for production scenarios.</param>
71
71
/// TODO: need to link to info on how the application has to be created to authenticate users, for multiple applications
72
72
/// <param name="options">The client options for the newly created <see cref="InteractiveBrowserCredential"/>.</param>
/// The client ID of the application used to authenticate the user. If not specified the user will be authenticated with an Azure development application.
41
+
/// The client ID of the application used to authenticate the user. It is recommended that developers register their applications and assign appropriate roles. For more information, visit <see href="https://aka.ms/azsdk/identity/AppRegistrationAndRoleAssignment"/>.
42
+
/// If not specified, users will authenticate to an Azure development application, which is not recommended for production scenarios.
0 commit comments