disable_instance_discovery (Azure#28816)

Author: xiangyan99

sdk/identity/azure-identity/CHANGELOG.md

@@ -4,6 +4,8 @@
 
 ### Features Added
 
+- Changed parameter from `instance_discovery` to `disable_instance_discovery` to make it more explicit.
+
 ### Breaking Changes
 
 ### Bugs Fixed

sdk/identity/azure-identity/azure/identity/_internal/msal_credentials.py

@@ -24,11 +24,11 @@ def __init__(
             additionally_allowed_tenants: Optional[List[str]] = None,
             allow_broker: Optional[bool] = None,
             authority: Optional[str] = None,
-            instance_discovery: Optional[bool] = None,
+            disable_instance_discovery: Optional[bool] = None,
             tenant_id: Optional[str] = None,
             **kwargs
     ) -> None:
-        self._instance_discovery = instance_discovery
+        self._instance_discovery = None if disable_instance_discovery is None else not disable_instance_discovery
         self._authority = normalize_authority(authority) if authority else get_default_authority()
         self._regional_authority = os.environ.get(EnvironmentVariables.AZURE_REGIONAL_AUTHORITY_NAME)
         if self._regional_authority and self._regional_authority.lower() in ["tryautodetect", "true"]:

sdk/identity/azure-identity/tests/test_device_code_credential.py

@@ -203,7 +203,7 @@ def test_device_code_credential():
 
     callback = Mock()
     credential = DeviceCodeCredential(
-        client_id=client_id, prompt_callback=callback, transport=transport, instance_discovery=False,
+        client_id=client_id, prompt_callback=callback, transport=transport, disable_instance_discovery=True,
     )
 
     now = datetime.datetime.utcnow()
@@ -259,7 +259,7 @@ def test_tenant_id():
 
     callback = Mock()
     credential = DeviceCodeCredential(
-        client_id=client_id, prompt_callback=callback, transport=transport, instance_discovery=False, additionally_allowed_tenants=['*']
+        client_id=client_id, prompt_callback=callback, transport=transport, disable_instance_discovery=True, additionally_allowed_tenants=['*']
     )
 
     now = datetime.datetime.utcnow()
@@ -274,7 +274,7 @@ def test_timeout():
         msal_app.initiate_device_flow.return_value = flow
         msal_app.acquire_token_by_device_flow.return_value = {"error": "authorization_pending"}
 
-        credential = DeviceCodeCredential(client_id="_", timeout=1, instance_discovery=False)
+        credential = DeviceCodeCredential(client_id="_", timeout=1, disable_instance_discovery=True)
         with pytest.raises(ClientAuthenticationError) as ex:
             credential.get_token("scope")
         assert "timed out" in ex.value.message.lower()

sdk/identity/azure-identity/tests/test_instance_discovery.py

@@ -8,14 +8,14 @@
 def test_instance_discovery():
     credential = MsalCredential(
         client_id="CLIENT_ID",
-        instance_discovery=False,
+        disable_instance_discovery=True,
     )
     app = credential._get_app()
     assert not app._instance_discovery
 
     credential = MsalCredential(
         client_id="CLIENT_ID",
-        instance_discovery=True,
+        disable_instance_discovery=False,
     )
     app = credential._get_app()
     assert app._instance_discovery

sdk/identity/azure-identity/tests/test_username_password_credential.py

@@ -111,7 +111,7 @@ def test_username_password_credential():
         username="user@azure",
         password="secret_password",
         transport=transport,
-        instance_discovery=False,  # kwargs are passed to MSAL; this one prevents an AAD verification request
+        disable_instance_discovery=True,  # kwargs are passed to MSAL; this one prevents an AAD verification request
     )
 
     token = credential.get_token("scope")