Compartilhar via


TokenCredential Interface

public interface TokenCredential

A interface de credencial de token serve como um componente fundamental para gerenciar e fornecer tokens de acesso necessários para a autenticação do Azure Active Directory (Azure AD) ao fazer solicitações aos serviços do Azure.

A TokenCredential interface, as ofertas getToken(TokenRequestContext request) e getTokenSync(TokenRequestContext request) os métodos. Esses métodos são responsáveis por recuperar um token de acesso que pode ser usado para autenticar solicitações nos serviços do Azure. O parâmetro scopes especificado como parte do TokenRequestContext representa os recursos ou as permissões necessárias para o token.

A interface de Credencial de Token é implementada por várias classes de credencial na biblioteca de Identidade do Azure . Essas classes de credencial lidam com o processo de autenticação e fornecem os tokens de acesso necessários com base nos escopos especificados e em qualquer configuração adicional.

Ao utilizar a interface de Credencial de Token, você pode abstrair a lógica de autenticação do código do aplicativo. Isso permite flexibilidade na escolha de mecanismos de autenticação e simplifica o gerenciamento de tokens de acesso, incluindo cache de token e atualização. Ele fornece uma abordagem consistente para autenticar solicitações em diferentes serviços e bibliotecas do Azure.

Aqui estão alguns exemplos de classes de credencial que implementam a interface de credencial de token:

  • DefaultAzureCredential: representa uma credencial que tenta uma série de métodos de autenticação para autenticar solicitações automaticamente. Ele simplifica o processo selecionando automaticamente um mecanismo de autenticação apropriado com base no ambiente, como variáveis de ambiente, identidades gerenciadas e credenciais de ferramenta de desenvolvedor.
  • ClientSecretCredential: representa uma credencial que usa uma ID do cliente, um segredo do cliente e uma ID de locatário para autenticar. Ele é adequado para cenários em que você tem um aplicativo cliente que precisa se autenticar com os serviços do Azure usando um segredo do cliente.
  • ClientCertificateCredential: representa uma credencial que usa uma ID do cliente, um certificado do cliente e uma ID de locatário para autenticação. Essa credencial é útil quando seu aplicativo cliente tem um certificado de cliente disponível para autenticação.
  • InteractiveBrowserCredential: representa uma credencial que executa um fluxo de autenticação interativo com o usuário em um navegador. É útil para cenários em que o usuário precisa fornecer consentimento ou a autenticação multifator é necessária.

Você pode encontrar mais classes de credencial que implementam a TokenCredential interface em nossa biblioteca de Identidade do Azure .

Essas classes de credencial podem ser usadas em combinação com várias bibliotecas de clientes do Azure para autenticar solicitações e acessar serviços do Azure sem a necessidade de gerenciar tokens de acesso manualmente. A interface de Credencial de Token fornece uma maneira consistente de lidar com a autenticação do AAD (Azure Active Directory) em diferentes serviços e SDKs do Azure de maneira segura e eficiente.

Resumo do método

Modificador e tipo Método e descrição
abstract Mono<AccessToken> getToken(TokenRequestContext request)

Obtenha de forma assíncrona um token para um determinado recurso/público-alvo.

default AccessToken getTokenSync(TokenRequestContext request)

Obtenha de forma síncrona um token para um determinado recurso/público-alvo.

Detalhes do método

getToken

public abstract Mono getToken(TokenRequestContext request)

Obtenha de forma assíncrona um token para um determinado recurso/público-alvo. Esse método é chamado automaticamente por bibliotecas de clientes do SDK do Azure. Você pode chamar esse método diretamente, mas também deve lidar com cache de token e atualização de token.

Parameters:

request - os detalhes da solicitação de token

Returns:

um Publicador que emite um único token de acesso

getTokenSync

public default AccessToken getTokenSync(TokenRequestContext request)

Obtenha de forma síncrona um token para um determinado recurso/público-alvo. Esse método é chamado automaticamente por bibliotecas de clientes do SDK do Azure. Você pode chamar esse método diretamente, mas também deve lidar com cache de token e atualização de token.

Parameters:

request - os detalhes da solicitação de token

Returns:

O Token de Acesso

Aplica-se a