From 83388de18255d1a2d9de01fb3e2ed9f774c80f55 Mon Sep 17 00:00:00 2001 From: Charles Lowell Date: Fri, 20 Aug 2021 16:58:44 -0700 Subject: [PATCH] Document Pod Identity's special use of client_id (#20377) --- .../identity/_credentials/managed_identity.py | 14 +++++++------- .../identity/aio/_credentials/managed_identity.py | 14 +++++++------- 2 files changed, 14 insertions(+), 14 deletions(-) diff --git a/sdk/identity/azure-identity/azure/identity/_credentials/managed_identity.py b/sdk/identity/azure-identity/azure/identity/_credentials/managed_identity.py index 3a291c1e1df3..d66d493b73a7 100644 --- a/sdk/identity/azure-identity/azure/identity/_credentials/managed_identity.py +++ b/sdk/identity/azure-identity/azure/identity/_credentials/managed_identity.py @@ -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 + `_ 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] """ diff --git a/sdk/identity/azure-identity/azure/identity/aio/_credentials/managed_identity.py b/sdk/identity/azure-identity/azure/identity/aio/_credentials/managed_identity.py index 075dffe1d463..ecbadac079db 100644 --- a/sdk/identity/azure-identity/azure/identity/aio/_credentials/managed_identity.py +++ b/sdk/identity/azure-identity/azure/identity/aio/_credentials/managed_identity.py @@ -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 + `_ 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] """