Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document Pod Identity's special use of client_id #20377

Merged
merged 1 commit into from
Aug 20, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -26,15 +26,15 @@ class ManagedIdentityCredential(object):
"""Authenticates with an Azure managed identity in any hosting environment which supports managed identities.

This credential defaults to using a system-assigned identity. To configure a user-assigned identity, use one of
the keyword arguments.
the keyword arguments. See `Azure Active Directory documentation
<https://docs.microsoft.com/azure/active-directory/managed-identities-azure-resources/overview>`_ for more
information about configuring managed identity for applications.

See Azure Active Directory documentation for more information about configuring managed identity for applications:
https://docs.microsoft.com/azure/active-directory/managed-identities-azure-resources/overview

:keyword str client_id: a user-assigned identity's client ID. This is supported in all hosting environments.
:keyword str client_id: a user-assigned identity's client ID or, when using Pod Identity, the client ID of an Azure
AD app registration. This argument is supported in all hosting environments.
:keyword identity_config: a mapping ``{parameter_name: value}`` specifying a user-assigned identity by its object
or resource ID, for example ``{"object_id": "..."}``. Check the documentation for your hosting environment to
learn what values it expects.
or resource ID, for example ``{"object_id": "..."}``. Check the documentation for your hosting environment to
learn what values it expects.
:paramtype identity_config: Mapping[str, str]
"""

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,15 +23,15 @@ class ManagedIdentityCredential(AsyncContextManager):
"""Authenticates with an Azure managed identity in any hosting environment which supports managed identities.

This credential defaults to using a system-assigned identity. To configure a user-assigned identity, use one of
the keyword arguments.
the keyword arguments. See `Azure Active Directory documentation
<https://docs.microsoft.com/azure/active-directory/managed-identities-azure-resources/overview>`_ for more
information about configuring managed identity for applications.

See Azure Active Directory documentation for more information about configuring managed identity for applications:
https://docs.microsoft.com/azure/active-directory/managed-identities-azure-resources/overview

:keyword str client_id: a user-assigned identity's client ID. This is supported in all hosting environments.
:keyword str client_id: a user-assigned identity's client ID or, when using Pod Identity, the client ID of an Azure
AD app registration. This argument is supported in all hosting environments.
:keyword identity_config: a mapping ``{parameter_name: value}`` specifying a user-assigned identity by its object
or resource ID, for example ``{"object_id": "..."}``. Check the documentation for your hosting environment to
learn what values it expects.
or resource ID, for example ``{"object_id": "..."}``. Check the documentation for your hosting environment to
learn what values it expects.
:paramtype identity_config: Mapping[str, str]
"""

Expand Down