UsernamePasswordCredential Classe
Autentica um usuário com um nome de usuário e uma senha.
Em geral, a Microsoft não recomenda esse tipo de autenticação, pois ela é menos segura do que outros fluxos de autenticação.
A autenticação com essa credencial não é interativa, portanto , não é compatível com nenhuma forma de autenticação multifator ou solicitação de consentimento. O aplicativo já deve ter o consentimento do usuário ou de um administrador de diretório.
Essa credencial só pode autenticar contas corporativas e de estudante; Não há suporte para contas da Microsoft. Confira a documentação do Azure Active Directory para obter mais informações sobre tipos de conta.
- Herança
-
azure.identity._internal.interactive.InteractiveCredentialUsernamePasswordCredential
Construtor
UsernamePasswordCredential(client_id: str, username: str, password: str, **kwargs: Any)Parâmetros
- authority
- str
Autoridade de um ponto de extremidade do Azure Active Directory, por exemplo, "login.microsoftonline.com", a autoridade para a Nuvem Pública do Azure (que é o padrão). AzureAuthorityHosts define autoridades para outras nuvens.
- tenant_id
- str
ID do locatário ou um domínio associado a um locatário. Se não for fornecido, o padrão será o locatário de "organizações", que dá suporte apenas a contas corporativas ou de estudante do Azure Active Directory.
- cache_persistence_options
- TokenCachePersistenceOptions
Configuração para cache de token persistente. Se não for especificado, a credencial armazenará tokens em cache na memória.
- disable_instance_discovery
- bool
Determina se a descoberta de instância é executada ou não ao tentar se autenticar. Definir isso como true desabilitará completamente a descoberta de instância e a validação de autoridade. Essa funcionalidade destina-se ao uso em cenários em que o ponto de extremidade de metadados não pode ser alcançado, como em nuvens privadas ou no Azure Stack. O processo de descoberta de instância envolve a recuperação de metadados de autoridade de https://login.microsoft.com/ para validar a autoridade. Ao definir isso como True, a validação da autoridade é desabilitada. Como resultado, é crucial garantir que o host de autoridade configurado seja válido e confiável.
Especifica locatários além do "tenant_id" especificado para o qual a credencial pode adquirir tokens. Adicione o valor curinga "*" para permitir que a credencial adquira tokens para qualquer locatário que o aplicativo possa acessar.
Exemplos
Crie um UsernamePasswordCredential.
from azure.identity import UsernamePasswordCredential
credential = UsernamePasswordCredential(
client_id="<client_id>",
username="<username>",
password="<password>",
)
Métodos
| authenticate |
Autenticar interativamente um usuário. |
| close | |
| get_token |
Solicite um token de acesso para escopos. Esse método é chamado automaticamente por clientes do SDK do Azure. |
authenticate
Autenticar interativamente um usuário.
authenticate(**kwargs: Any) -> AuthenticationRecordParâmetros
escopos a serem solicitados durante a autenticação, como aqueles fornecidos por scopes. Se fornecida, a autenticação bem-sucedida armazenará em cache um token de acesso para esses escopos.
Tipo de retorno
Exceções
falha na autenticação. O atributo do message erro fornece um motivo.
close
close() -> NoneExceções
falha na autenticação. O atributo do message erro fornece um motivo.
get_token
Solicite um token de acesso para escopos.
Esse método é chamado automaticamente por clientes do SDK do Azure.
get_token(*scopes: str, claims: str | None = None, tenant_id: str | None = None, **kwargs: Any) -> AccessTokenParâmetros
- scopes
- str
escopos desejados para o token de acesso. Esse método requer pelo menos um escopo. Para obter mais informações sobre escopos, consulte https://video2.skills-academy.com/azure/active-directory/develop/scopes-oidc.
- claims
- str
declarações adicionais necessárias no token, como aquelas retornadas no desafio de declarações de um provedor de recursos após uma falha de autorização
- tenant_id
- str
locatário opcional a ser incluído na solicitação de token.
- enable_cae
- bool
indica se a CAE (Avaliação contínua de acesso) deve ser habilitada para o token solicitado. Usa False como padrão.
Retornos
Um token de acesso com os escopos desejados.
Tipo de retorno
Exceções
a credencial não pode tentar a autenticação porque não tem dados, estado ou suporte à plataforma necessários
falha na autenticação. O atributo do message erro fornece um motivo.
A interação do usuário é necessária para adquirir um token e a credencial está configurada para não iniciar isso automaticamente. Chamar
para iniciar a autenticação interativa.