Deprecate UseEmbeddedWebView property in BrowserCustomizationOptions (#50516)

Copilot · christothes · JonathanCrd · web-flow · commit cc0c30ec6484 · 2025-10-02T00:26:11.000Z
* Initial plan for issue

* Add [Obsolete] attribute to UseEmbeddedWebView property with deprecation message

Co-authored-by: christothes &lt;1279263+christothes@users.noreply.github.com&gt;

* Export API

* disable warning in clone

* Add changelog entry for UseEmbeddedWebView deprecation

Co-authored-by: JonathanCrd &lt;17486462+JonathanCrd@users.noreply.github.com&gt;

---------

Co-authored-by: copilot-swe-agent[bot] &lt;198982749+Copilot@users.noreply.github.com&gt;
Co-authored-by: christothes &lt;1279263+christothes@users.noreply.github.com&gt;
Co-authored-by: JonathanCrd &lt;JonathanCrd@users.noreply.github.com&gt;
Co-authored-by: JonathanCrd &lt;17486462+JonathanCrd@users.noreply.github.com&gt;
diff --git a/sdk/identity/Azure.Identity/CHANGELOG.md b/sdk/identity/Azure.Identity/CHANGELOG.md
@@ -12,6 +12,8 @@
 
 ### Other Changes
 
+- Deprecated `BrowserCustomizationOptions.UseEmbeddedWebView` property. This option requires additional dependencies on Microsoft.Identity.Client.Desktop and is no longer supported. Consider using brokered authentication instead.
+
 ## 1.16.0 (2025-09-09)
 
 ### Features Added
diff --git a/sdk/identity/Azure.Identity/api/Azure.Identity.net8.0.cs b/sdk/identity/Azure.Identity/api/Azure.Identity.net8.0.cs
@@ -115,6 +115,7 @@ public partial class BrowserCustomizationOptions
         public BrowserCustomizationOptions() { }
         public string ErrorMessage { get { throw null; } set { } }
         public string SuccessMessage { get { throw null; } set { } }
+        [System.ObsoleteAttribute("This option requires additional dependencies on Microsoft.Identity.Client.Desktop and is no longer supported. Consider using brokered authentication instead")]
         public bool? UseEmbeddedWebView { get { throw null; } set { } }
     }
     public partial class ChainedTokenCredential : Azure.Core.TokenCredential
diff --git a/sdk/identity/Azure.Identity/api/Azure.Identity.netstandard2.0.cs b/sdk/identity/Azure.Identity/api/Azure.Identity.netstandard2.0.cs
@@ -113,6 +113,7 @@ public partial class BrowserCustomizationOptions
         public BrowserCustomizationOptions() { }
         public string ErrorMessage { get { throw null; } set { } }
         public string SuccessMessage { get { throw null; } set { } }
+        [System.ObsoleteAttribute("This option requires additional dependencies on Microsoft.Identity.Client.Desktop and is no longer supported. Consider using brokered authentication instead")]
         public bool? UseEmbeddedWebView { get { throw null; } set { } }
     }
     public partial class ChainedTokenCredential : Azure.Core.TokenCredential
diff --git a/sdk/identity/Azure.Identity/src/Credentials/BrowserCustomizationOptions.cs b/sdk/identity/Azure.Identity/src/Credentials/BrowserCustomizationOptions.cs
@@ -17,6 +17,7 @@ public class BrowserCustomizationOptions
         /// Specifies if the public client application should used an embedded web browser
         /// or the system default browser
         /// </summary>
+        [Obsolete("This option requires additional dependencies on Microsoft.Identity.Client.Desktop and is no longer supported. Consider using brokered authentication instead")]
         public bool? UseEmbeddedWebView { get; set; }
 
         internal SystemWebViewOptions SystemBrowserOptions;
diff --git a/sdk/identity/Azure.Identity/src/Credentials/InteractiveBrowserCredentialOptions.cs b/sdk/identity/Azure.Identity/src/Credentials/InteractiveBrowserCredentialOptions.cs
@@ -92,7 +92,9 @@ public string TenantId
                     {
                         ErrorMessage = BrowserCustomization.ErrorMessage,
                         SuccessMessage = BrowserCustomization.SuccessMessage,
+#pragma warning disable CS0618 // Type or member is obsolete
                         UseEmbeddedWebView = BrowserCustomization.UseEmbeddedWebView ?? false
+#pragma warning restore CS0618 // Type or member is obsolete
                     };
                 }
             }
diff --git a/sdk/identity/Azure.Identity/src/MsalPublicClient.cs b/sdk/identity/Azure.Identity/src/MsalPublicClient.cs
@@ -286,10 +286,12 @@ protected virtual async ValueTask<AuthenticationResult> AcquireTokenInteractiveC
             }
             if (browserOptions != null)
             {
+#pragma warning disable CS0618 // Type or member is obsolete
                 if (browserOptions.UseEmbeddedWebView.HasValue)
                 {
                     builder.WithUseEmbeddedWebView(browserOptions.UseEmbeddedWebView.Value);
                 }
+#pragma warning restore CS0618 // Type or member is obsolete
                 if (browserOptions.SystemBrowserOptions != null)
                 {
                     builder.WithSystemWebViewOptions(browserOptions.SystemBrowserOptions);
diff --git a/sdk/identity/Azure.Identity/tests/InteractiveBrowserCredentialTests.cs b/sdk/identity/Azure.Identity/tests/InteractiveBrowserCredentialTests.cs
@@ -339,7 +339,9 @@ public async Task BrowserCustomizationsHtmlMessage([Values(null, "<p> Login Succ
             {
                 InteractiveAuthFactory = (_, _, _, _, _, _, browserOptions, _) =>
                 {
+#pragma warning disable CS0618 // Type or member is obsolete
                     Assert.AreEqual(false, browserOptions.UseEmbeddedWebView);
+#pragma warning restore CS0618 // Type or member is obsolete
                     Assert.AreEqual(htmlMessageSuccess, browserOptions.SuccessMessage);
                     Assert.AreEqual(htmlMessageError, browserOptions.ErrorMessage);
                     return AuthenticationResultFactory.Create(Guid.NewGuid().ToString(), expiresOn: DateTimeOffset.UtcNow.AddMinutes(5));
@@ -349,7 +351,9 @@ public async Task BrowserCustomizationsHtmlMessage([Values(null, "<p> Login Succ
             {
                 BrowserCustomization = new BrowserCustomizationOptions()
                 {
+#pragma warning disable CS0618 // Type or member is obsolete
                     UseEmbeddedWebView = false,
+#pragma warning restore CS0618 // Type or member is obsolete
                     SuccessMessage = htmlMessageSuccess,
                     ErrorMessage = htmlMessageError
                 }
@@ -367,7 +371,9 @@ public async Task BrowserCustomizedUseEmbeddedWebView([Values(null, true, false)
             {
                 InteractiveAuthFactory = (_, _, _, _, _, _, browserOptions, _) =>
                 {
+#pragma warning disable CS0618 // Type or member is obsolete
                     Assert.AreEqual(useEmbeddedWebView, browserOptions.UseEmbeddedWebView);
+#pragma warning restore CS0618 // Type or member is obsolete
                     Assert.AreEqual(htmlMessageError, browserOptions.ErrorMessage);
                     return AuthenticationResultFactory.Create(Guid.NewGuid().ToString(), expiresOn: DateTimeOffset.UtcNow.AddMinutes(5));
                 }
@@ -376,7 +382,9 @@ public async Task BrowserCustomizedUseEmbeddedWebView([Values(null, true, false)
             {
                 BrowserCustomization = new BrowserCustomizationOptions()
                 {
+#pragma warning disable CS0618 // Type or member is obsolete
                     UseEmbeddedWebView = useEmbeddedWebView,
+#pragma warning restore CS0618 // Type or member is obsolete
                     ErrorMessage = htmlMessageError
                 }
             };

Original file line number	Diff line number	Diff line change
`@@ -115,6 +115,7 @@ public partial class BrowserCustomizationOptions`
`115`	`115`	`public BrowserCustomizationOptions() { }`
`116`	`116`	`public string ErrorMessage { get { throw null; } set { } }`
`117`	`117`	`public string SuccessMessage { get { throw null; } set { } }`
	`118`	`+ [System.ObsoleteAttribute("This option requires additional dependencies on Microsoft.Identity.Client.Desktop and is no longer supported. Consider using brokered authentication instead")]`
`118`	`119`	`public bool? UseEmbeddedWebView { get { throw null; } set { } }`
`119`	`120`	`}`
`120`	`121`	`public partial class ChainedTokenCredential : Azure.Core.TokenCredential`
Original file line number	Diff line number	Diff line change
`@@ -113,6 +113,7 @@ public partial class BrowserCustomizationOptions`
`113`	`113`	`public BrowserCustomizationOptions() { }`
`114`	`114`	`public string ErrorMessage { get { throw null; } set { } }`
`115`	`115`	`public string SuccessMessage { get { throw null; } set { } }`
	`116`	`+ [System.ObsoleteAttribute("This option requires additional dependencies on Microsoft.Identity.Client.Desktop and is no longer supported. Consider using brokered authentication instead")]`
`116`	`117`	`public bool? UseEmbeddedWebView { get { throw null; } set { } }`
`117`	`118`	`}`
`118`	`119`	`public partial class ChainedTokenCredential : Azure.Core.TokenCredential`
Original file line number	Diff line number	Diff line change
`@@ -92,7 +92,9 @@ public string TenantId`
`92`	`92`	`{`
`93`	`93`	`ErrorMessage = BrowserCustomization.ErrorMessage,`
`94`	`94`	`SuccessMessage = BrowserCustomization.SuccessMessage,`
	`95`	`+#pragma warning disable CS0618 // Type or member is obsolete`
`95`	`96`	`UseEmbeddedWebView = BrowserCustomization.UseEmbeddedWebView ?? false`
	`97`	`+#pragma warning restore CS0618 // Type or member is obsolete`
`96`	`98`	`};`
`97`	`99`	`}`
`98`	`100`	`}`
Original file line number	Diff line number	Diff line change
`@@ -286,10 +286,12 @@ protected virtual async ValueTask<AuthenticationResult> AcquireTokenInteractiveC`
`286`	`286`	`}`
`287`	`287`	`if (browserOptions != null)`
`288`	`288`	`{`
	`289`	`+#pragma warning disable CS0618 // Type or member is obsolete`
`289`	`290`	`if (browserOptions.UseEmbeddedWebView.HasValue)`
`290`	`291`	`{`
`291`	`292`	`builder.WithUseEmbeddedWebView(browserOptions.UseEmbeddedWebView.Value);`
`292`	`293`	`}`
	`294`	`+#pragma warning restore CS0618 // Type or member is obsolete`
`293`	`295`	`if (browserOptions.SystemBrowserOptions != null)`
`294`	`296`	`{`
`295`	`297`	`builder.WithSystemWebViewOptions(browserOptions.SystemBrowserOptions);`
Original file line number	Diff line number	Diff line change
`@@ -339,7 +339,9 @@ public async Task BrowserCustomizationsHtmlMessage([Values(null, "<p> Login Succ`
`339`	`339`	`{`
`340`	`340`	`InteractiveAuthFactory = (_, _, _, _, _, _, browserOptions, _) =>`
`341`	`341`	`{`
	`342`	`+#pragma warning disable CS0618 // Type or member is obsolete`
`342`	`343`	`Assert.AreEqual(false, browserOptions.UseEmbeddedWebView);`
	`344`	`+#pragma warning restore CS0618 // Type or member is obsolete`
`343`	`345`	`Assert.AreEqual(htmlMessageSuccess, browserOptions.SuccessMessage);`
`344`	`346`	`Assert.AreEqual(htmlMessageError, browserOptions.ErrorMessage);`
`345`	`347`	`return AuthenticationResultFactory.Create(Guid.NewGuid().ToString(), expiresOn: DateTimeOffset.UtcNow.AddMinutes(5));`
`@@ -349,7 +351,9 @@ public async Task BrowserCustomizationsHtmlMessage([Values(null, "<p> Login Succ`
`349`	`351`	`{`
`350`	`352`	`BrowserCustomization = new BrowserCustomizationOptions()`
`351`	`353`	`{`
	`354`	`+#pragma warning disable CS0618 // Type or member is obsolete`
`352`	`355`	`UseEmbeddedWebView = false,`
	`356`	`+#pragma warning restore CS0618 // Type or member is obsolete`
`353`	`357`	`SuccessMessage = htmlMessageSuccess,`
`354`	`358`	`ErrorMessage = htmlMessageError`
`355`	`359`	`}`
`@@ -367,7 +371,9 @@ public async Task BrowserCustomizedUseEmbeddedWebView([Values(null, true, false)`
`367`	`371`	`{`
`368`	`372`	`InteractiveAuthFactory = (_, _, _, _, _, _, browserOptions, _) =>`
`369`	`373`	`{`
	`374`	`+#pragma warning disable CS0618 // Type or member is obsolete`
`370`	`375`	`Assert.AreEqual(useEmbeddedWebView, browserOptions.UseEmbeddedWebView);`
	`376`	`+#pragma warning restore CS0618 // Type or member is obsolete`
`371`	`377`	`Assert.AreEqual(htmlMessageError, browserOptions.ErrorMessage);`
`372`	`378`	`return AuthenticationResultFactory.Create(Guid.NewGuid().ToString(), expiresOn: DateTimeOffset.UtcNow.AddMinutes(5));`
`373`	`379`	`}`
`@@ -376,7 +382,9 @@ public async Task BrowserCustomizedUseEmbeddedWebView([Values(null, true, false)`
`376`	`382`	`{`
`377`	`383`	`BrowserCustomization = new BrowserCustomizationOptions()`
`378`	`384`	`{`
	`385`	`+#pragma warning disable CS0618 // Type or member is obsolete`
`379`	`386`	`UseEmbeddedWebView = useEmbeddedWebView,`
	`387`	`+#pragma warning restore CS0618 // Type or member is obsolete`
`380`	`388`	`ErrorMessage = htmlMessageError`
`381`	`389`	`}`
`382`	`390`	`};`