WorkloadIdentityCredential Clase

Autentica mediante una identidad de carga de trabajo de Azure Active Directory.

La autenticación de identidad de carga de trabajo es una característica de Azure que permite a las aplicaciones que se ejecutan en máquinas virtuales (VM) acceder a otros recursos de Azure sin necesidad de una entidad de servicio o una identidad administrada. Con la autenticación de identidad de carga de trabajo, las aplicaciones se autentican mediante su propia identidad, en lugar de usar una entidad de servicio compartida o una identidad administrada. En segundo plano, la autenticación de identidad de carga de trabajo usa el concepto de credenciales de cuenta de servicio (SAC), que Azure crea automáticamente y almacena de forma segura en la máquina virtual. Mediante la autenticación de identidad de carga de trabajo, puede evitar la necesidad de administrar e rotar las entidades de servicio o las identidades administradas para cada aplicación de cada máquina virtual. Además, dado que Azure crea y administra automáticamente las SAC, no es necesario preocuparse por almacenar y proteger las credenciales confidenciales por sí mismas.

WorkloadIdentityCredential admite la autenticación de identidad de carga de trabajo de Azure en Azure Kubernetes y adquiere un token mediante las credenciales de la cuenta de servicio disponibles en el entorno de Azure Kubernetes. Consulte esta introducción a la identidad de carga de trabajo para obtener más información.

Herencia

azure.identity._credentials.client_assertion.ClientAssertionCredential

WorkloadIdentityCredential

azure.identity._credentials.workload_identity.TokenFileMixin

WorkloadIdentityCredential

Constructor

WorkloadIdentityCredential(*, tenant_id: str | None = None, client_id: str | None = None, token_file_path: str | None = None, **kwargs: Any)

Parámetros

tenant_id

str

Identificador del inquilino de Azure Active Directory de la aplicación. También se denomina su identificador de "directorio".

client_id

str

Identificador de cliente de un registro de aplicación de Azure AD.

token_file_path

str

Ruta de acceso a un archivo que contiene un token de cuenta de servicio de Kubernetes que autentica la identidad.

Ejemplos

Cree una workloadIdentityCredential.

   from azure.identity import WorkloadIdentityCredential

   credential = WorkloadIdentityCredential(
       tenant_id="<tenant_id>",
       client_id="<client_id>",
       token_file_path="<token_file_path>",
   )

   # Parameters can be omitted if the following environment variables are set:
   #   - AZURE_TENANT_ID
   #   - AZURE_CLIENT_ID
   #   - AZURE_FEDERATED_TOKEN_FILE
   credential = WorkloadIdentityCredential()

Métodos

close
get_token	Solicite un token de acceso para los ámbitos. Los clientes del SDK de Azure llaman automáticamente a este método.

close

close() -> None

get_token

Solicite un token de acceso para los ámbitos.

Los clientes del SDK de Azure llaman automáticamente a este método.

get_token(*scopes: str, claims: str | None = None, tenant_id: str | None = None, **kwargs: Any) -> AccessToken

Parámetros

scopes

str

Requerido

ámbitos deseados para el token de acceso. Este método requiere al menos un ámbito. Para obtener más información sobre los ámbitos, vea https://learn.microsoft.com/azure/active-directory/develop/scopes-oidc.

claims

str

Notificaciones adicionales necesarias en el token, como las que se devuelven en el desafío de notificaciones de un proveedor de recursos después de un error de autorización.

tenant_id

str

inquilino opcional que se va a incluir en la solicitud de token.

enable_cae

bool

indica si se va a habilitar la evaluación continua de acceso (CAE) para el token solicitado. El valor predeterminado es False.

Devoluciones

Un token de acceso con los ámbitos deseados.

Tipo de valor devuelto

AccessToken

Excepciones

CredentialUnavailableError

la credencial no puede intentar la autenticación porque no tiene compatibilidad con los datos, el estado o la plataforma necesarios.

ClientAuthenticationError

error de autenticación. El atributo del message error proporciona un motivo.