EnvironmentCredential Classe

  • Riferimento

Credenziali configurate dalle variabili di ambiente.

Questa credenziale è in grado di eseguire l'autenticazione come entità servizio usando un segreto client o un certificato o come utente con nome utente e password. La configurazione viene tentata in questo ordine, usando queste variabili di ambiente:

Entità servizio con segreto:

  • AZURE_TENANT_ID: ID del tenant dell'entità servizio. Chiamato anche l'ID "directory".

  • AZURE_CLIENT_ID: ID client dell'entità servizio

  • AZURE_CLIENT_SECRET: uno dei segreti client dell'entità servizio

  • AZURE_AUTHORITY_HOST: autorità di un endpoint di Azure Active Directory, ad esempio "login.microsoftonline.com", l'autorità per il cloud pubblico di Azure, ovvero l'impostazione predefinita quando non viene assegnato alcun valore.

Entità servizio con certificato:

  • AZURE_TENANT_ID: ID del tenant dell'entità servizio. Chiamato anche l'ID "directory".

  • AZURE_CLIENT_ID: ID client dell'entità servizio

  • AZURE_CLIENT_CERTIFICATE_PATH: percorso di un file di certificato PEM o PKCS12, inclusa la chiave privata.

  • AZURE_CLIENT_CERTIFICATE_PASSWORD: (facoltativo) password del file di certificato, se presente.

  • AZURE_AUTHORITY_HOST: autorità di un endpoint di Azure Active Directory, ad esempio "login.microsoftonline.com", l'autorità per il cloud pubblico di Azure, ovvero l'impostazione predefinita quando non viene assegnato alcun valore.

Utente con nome utente e password:

  • AZURE_CLIENT_ID: ID client dell'applicazione

  • AZURE_USERNAME: un nome utente (in genere un indirizzo di posta elettronica)

  • AZURE_PASSWORD: password dell'utente

  • AZURE_TENANT_ID: (facoltativo) ID del tenant dell'entità servizio. Chiamato anche l'ID "directory". Se non specificato, per impostazione predefinita viene usato il tenant "organizzazioni", che supporta solo gli account aziendali o dell'istituto di istruzione di Azure Active Directory.

  • AZURE_AUTHORITY_HOST: autorità di un endpoint di Azure Active Directory, ad esempio "login.microsoftonline.com", l'autorità per il cloud pubblico di Azure, ovvero l'impostazione predefinita quando non viene assegnato alcun valore.

Ereditarietà
builtins.object
EnvironmentCredential

Costruttore

EnvironmentCredential(**kwargs: Any)

Esempio

Creare un oggetto EnvironmentCredential.


   from azure.identity import EnvironmentCredential

   credential = EnvironmentCredential()

Metodi

close

Chiudere la sessione di trasporto delle credenziali.
get_token

Richiedere un token di accesso per gli ambiti.

Questo metodo viene chiamato automaticamente dai client Azure SDK.

close

Chiudere la sessione di trasporto delle credenziali.

close() -> None

get_token

Richiedere un token di accesso per gli ambiti.

Questo metodo viene chiamato automaticamente dai client Azure SDK.

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

Parametri

scopes
str
Necessario

ambiti desiderati per il token di accesso. Questo metodo richiede almeno un ambito. Per altre informazioni sugli ambiti, vedere https://learn.microsoft.com/azure/active-directory/develop/scopes-oidc.

claims
str

attestazioni aggiuntive richieste nel token, ad esempio quelle restituite nella richiesta di attestazioni di un provider di risorse in seguito a un errore di autorizzazione.

tenant_id
str

tenant facoltativo da includere nella richiesta di token.

Restituisce

Token di accesso con gli ambiti desiderati.

Tipo restituito

AccessToken

Eccezioni

CredentialUnavailableError

la configurazione delle variabili di ambiente è incompleta