UsernamePasswordCredential Classe

Autentica un utente con un nome utente e una password.

In generale, Microsoft non consiglia questo tipo di autenticazione, perché è meno sicuro di altri flussi di autenticazione.

L'autenticazione con questa credenziale non è interattiva, quindi non è compatibile con alcuna forma di autenticazione a più fattori o richiesta di consenso. L'applicazione deve avere già il consenso dell'utente o di un amministratore della directory.

Questa credenziale può autenticare solo gli account aziendali e dell'istituto di istruzione; Gli account Microsoft non sono supportati. Per altre informazioni sui tipi di account, vedere la documentazione di Azure Active Directory .

Ereditarietà

azure.identity._internal.interactive.InteractiveCredential

UsernamePasswordCredential

Costruttore

UsernamePasswordCredential(client_id: str, username: str, password: str, **kwargs: Any)

Parametri

client_id

str

Necessario

ID client dell'applicazione

username

str

Necessario

Nome utente dell'utente (in genere un indirizzo di posta elettronica)

password

str

Necessario

Password dell'utente

authority

str

Autorità di un endpoint di Azure Active Directory, ad esempio "login.microsoftonline.com", l'autorità per Azure Public Cloud (ovvero l'impostazione predefinita). AzureAuthorityHosts definisce le autorità per altri cloud.

tenant_id

str

ID tenant o un dominio associato a un tenant. Se non specificato, l'impostazione predefinita è il tenant "organizzazioni", che supporta solo gli account aziendali o dell'istituto di istruzione di Azure Active Directory.

cache_persistence_options

TokenCachePersistenceOptions

Configurazione per la memorizzazione nella cache dei token persistenti. Se non specificato, le credenziali memorizzano nella cache i token in memoria.

disable_instance_discovery

bool

Determina se l'individuazione di istanze viene eseguita durante il tentativo di autenticazione. L'impostazione su true disabilita completamente sia l'individuazione dell'istanza che la convalida dell'autorità. Questa funzionalità è destinata all'uso negli scenari in cui non è possibile raggiungere l'endpoint dei metadati, ad esempio nei cloud privati o in Azure Stack. Il processo di individuazione dell'istanza comporta il recupero dei metadati dell'autorità da https://login.microsoft.com/ per convalidare l'autorità. Impostando questa opzione su True, la convalida dell'autorità è disabilitata. Di conseguenza, è fondamentale assicurarsi che l'host dell'autorità configurata sia valido e affidabile.

additionally_allowed_tenants

List[str]

Specifica i tenant oltre alla "tenant_id" specificata per cui le credenziali possono acquisire token. Aggiungere il valore jolly "*" per consentire alle credenziali di acquisire i token per qualsiasi tenant a cui l'applicazione può accedere.

Esempio

Creare un nome utentePasswordCredential.

   from azure.identity import UsernamePasswordCredential

   credential = UsernamePasswordCredential(
       client_id="<client_id>",
       username="<username>",
       password="<password>",
   )

Metodi

authenticate	Autenticare in modo interattivo un utente.
close
get_token	Richiedere un token di accesso per gli ambiti. Questo metodo viene chiamato automaticamente dai client Azure SDK.

authenticate

Autenticare in modo interattivo un utente.

authenticate(**kwargs: Any) -> AuthenticationRecord

Parametri

scopes

Iterable[str]

ambiti da richiedere durante l'autenticazione, ad esempio quelli forniti da scopes. Se specificato, l'autenticazione ha esito positivo memorizza nella cache un token di accesso per questi ambiti.

claims

str

attestazioni aggiuntive necessarie nel token, ad esempio quelle fornite da claims

Tipo restituito

AuthenticationRecord

Eccezioni

ClientAuthenticationError

autenticazione non riuscita. L'attributo dell'errore message fornisce un motivo.

close

close() -> None

Eccezioni

ClientAuthenticationError

autenticazione non riuscita. L'attributo dell'errore message fornisce un motivo.

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 necessarie 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.

enable_cae

bool

indica se abilitare La valutazione dell'accesso continuo (CAE) per il token richiesto. Il valore predefinito è False.

Restituisce

Token di accesso con gli ambiti desiderati.

Tipo restituito

AccessToken

Eccezioni

CredentialUnavailableError

la credenziale non è in grado di tentare l'autenticazione perché non dispone di dati, stato o supporto della piattaforma necessari

ClientAuthenticationError

autenticazione non riuscita. L'attributo dell'errore message fornisce un motivo.

AuthenticationRequiredError

L'interazione utente è necessaria per acquisire un token e la credenziale non è configurata per iniziare automaticamente questa operazione. Chiamata

authenticate

per iniziare l'autenticazione interattiva.