Skip to content

Commit e81050e

Browse files
authored
Document Pod Identity's special use of client_id (#20377)
1 parent 0cce1ba commit e81050e

File tree

2 files changed

+14
-14
lines changed

2 files changed

+14
-14
lines changed

sdk/identity/azure-identity/azure/identity/_credentials/managed_identity.py

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -26,15 +26,15 @@ class ManagedIdentityCredential(object):
2626
"""Authenticates with an Azure managed identity in any hosting environment which supports managed identities.
2727
2828
This credential defaults to using a system-assigned identity. To configure a user-assigned identity, use one of
29-
the keyword arguments.
29+
the keyword arguments. See `Azure Active Directory documentation
30+
<https://docs.microsoft.com/azure/active-directory/managed-identities-azure-resources/overview>`_ for more
31+
information about configuring managed identity for applications.
3032
31-
See Azure Active Directory documentation for more information about configuring managed identity for applications:
32-
https://docs.microsoft.com/azure/active-directory/managed-identities-azure-resources/overview
33-
34-
:keyword str client_id: a user-assigned identity's client ID. This is supported in all hosting environments.
33+
:keyword str client_id: a user-assigned identity's client ID or, when using Pod Identity, the client ID of an Azure
34+
AD app registration. This argument is supported in all hosting environments.
3535
:keyword identity_config: a mapping ``{parameter_name: value}`` specifying a user-assigned identity by its object
36-
or resource ID, for example ``{"object_id": "..."}``. Check the documentation for your hosting environment to
37-
learn what values it expects.
36+
or resource ID, for example ``{"object_id": "..."}``. Check the documentation for your hosting environment to
37+
learn what values it expects.
3838
:paramtype identity_config: Mapping[str, str]
3939
"""
4040

sdk/identity/azure-identity/azure/identity/aio/_credentials/managed_identity.py

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -23,15 +23,15 @@ class ManagedIdentityCredential(AsyncContextManager):
2323
"""Authenticates with an Azure managed identity in any hosting environment which supports managed identities.
2424
2525
This credential defaults to using a system-assigned identity. To configure a user-assigned identity, use one of
26-
the keyword arguments.
26+
the keyword arguments. See `Azure Active Directory documentation
27+
<https://docs.microsoft.com/azure/active-directory/managed-identities-azure-resources/overview>`_ for more
28+
information about configuring managed identity for applications.
2729
28-
See Azure Active Directory documentation for more information about configuring managed identity for applications:
29-
https://docs.microsoft.com/azure/active-directory/managed-identities-azure-resources/overview
30-
31-
:keyword str client_id: a user-assigned identity's client ID. This is supported in all hosting environments.
30+
:keyword str client_id: a user-assigned identity's client ID or, when using Pod Identity, the client ID of an Azure
31+
AD app registration. This argument is supported in all hosting environments.
3232
:keyword identity_config: a mapping ``{parameter_name: value}`` specifying a user-assigned identity by its object
33-
or resource ID, for example ``{"object_id": "..."}``. Check the documentation for your hosting environment to
34-
learn what values it expects.
33+
or resource ID, for example ``{"object_id": "..."}``. Check the documentation for your hosting environment to
34+
learn what values it expects.
3535
:paramtype identity_config: Mapping[str, str]
3636
"""
3737

0 commit comments

Comments
 (0)