Compartir a través de

EnvironmentCredential Clase

  • Referencia

Credencial configurada por variables de entorno.

Esta credencial es capaz de autenticarse como entidad de servicio mediante un secreto de cliente o un certificado, o como usuario con un nombre de usuario y una contraseña. La configuración se intenta en este orden mediante estas variables de entorno:

Entidad de servicio con secreto:

  • AZURE_TENANT_ID: identificador del inquilino de la entidad de servicio. También se denomina "directorio".

  • AZURE_CLIENT_ID: identificador de cliente de la entidad de servicio

  • AZURE_CLIENT_SECRET: uno de los secretos de cliente de la entidad de servicio

  • AZURE_AUTHORITY_HOST: autoridad de un punto de conexión de Azure Active Directory, por ejemplo, "login.microsoftonline.com", la autoridad de la nube pública de Azure, que es el valor predeterminado cuando no se proporciona ningún valor.

Entidad de servicio con certificado:

  • AZURE_TENANT_ID: identificador del inquilino de la entidad de servicio. También se denomina "directorio".

  • AZURE_CLIENT_ID: identificador de cliente de la entidad de servicio

  • AZURE_CLIENT_CERTIFICATE_PATH: ruta de acceso a un archivo de certificado PEM o PKCS12, incluida la clave privada.

  • AZURE_CLIENT_CERTIFICATE_PASSWORD: (opcional) contraseña del archivo de certificado, si existe.

  • AZURE_AUTHORITY_HOST: autoridad de un punto de conexión de Azure Active Directory, por ejemplo, "login.microsoftonline.com", la autoridad de la nube pública de Azure, que es el valor predeterminado cuando no se proporciona ningún valor.

Usuario con nombre de usuario y contraseña:

  • AZURE_CLIENT_ID: identificador de cliente de la aplicación

  • AZURE_USERNAME: un nombre de usuario (normalmente una dirección de correo electrónico)

  • AZURE_PASSWORD: la contraseña del usuario

  • AZURE_TENANT_ID: (opcional) identificador del inquilino de la entidad de servicio. También se denomina "directorio". Si no se proporciona, el valor predeterminado es el inquilino de "organizaciones", que solo admite cuentas profesionales o educativas de Azure Active Directory.

  • AZURE_AUTHORITY_HOST: autoridad de un punto de conexión de Azure Active Directory, por ejemplo, "login.microsoftonline.com", la autoridad de la nube pública de Azure, que es el valor predeterminado cuando no se proporciona ningún valor.

Herencia
builtins.object
EnvironmentCredential

Constructor

EnvironmentCredential(**kwargs: Any)

Ejemplos

Cree un environmentCredential.


   from azure.identity import EnvironmentCredential

   credential = EnvironmentCredential()

Métodos

close

Cierre la sesión de transporte de la credencial.
get_token

Solicite un token de acceso para los ámbitos.

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

close

Cierre la sesión de transporte de la credencial.

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.

Devoluciones

Un token de acceso con los ámbitos deseados.

Tipo de valor devuelto

AccessToken

Excepciones

CredentialUnavailableError

La configuración de la variable de entorno está incompleta