SharedTokenCacheCredential Classe

Executa uma autenticação usando tokens compartilhados entre aplicativos da Microsoft no cache local.

Herança

azure.identity._internal.shared_token_cache.SharedTokenCacheBase

SharedTokenCacheCredential

azure.identity.aio._internal.AsyncContextManager

SharedTokenCacheCredential

Construtor

SharedTokenCacheCredential(username: str | None = None, *, authority: str | None = None, tenant_id: str | None = None, **kwargs: Any)

Parâmetros

username

str

valor padrão: None

Nome de usuário (normalmente um endereço de email) do usuário para autenticar como. Isso é necessário porque o cache local pode conter tokens para várias identidades.

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

uma ID de locatário do Azure Active Directory. Usado para selecionar uma conta quando o cache contém tokens para várias identidades.

cache_persistence_options

TokenCachePersistenceOptions

configuração para cache de token persistente. Se não for fornecida, a credencial usará o cache persistente compartilhado por aplicativos de desenvolvimento da Microsoft

Métodos

close	Feche a sessão de transporte da credencial.
get_token	Obtenha um token de acesso para escopos do cache compartilhado. Se nenhum token de acesso for armazenado em cache, tente adquirir um usando um token de atualização armazenado em cache. Esse método é chamado automaticamente por clientes do SDK do Azure.
supported	Se o cache de token compartilhado tem suporte na plataforma atual.

close

Feche a sessão de transporte da credencial.

async close() -> None

get_token

Obtenha um token de acesso para escopos do cache compartilhado.

Se nenhum token de acesso for armazenado em cache, tente adquirir um usando um token de atualização armazenado em cache.

Esse método é chamado automaticamente por clientes do SDK do Azure.

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

Parâmetros

scopes

str

Obrigatório

escopos desejados para o token de acesso. Esse método requer pelo menos um escopo. Para obter mais informações sobre escopos, consulte https://learn.microsoft.com/azure/active-directory/develop/scopes-oidc.

claims

str

declarações adicionais necessárias no token, como as 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

AccessToken

Exceções

CredentialUnavailableError

o cache não está disponível ou contém informações insuficientes do usuário

ClientAuthenticationError

falha na autenticação. O atributo do message erro fornece um motivo. Qualquer resposta de erro do Azure Active Directory está disponível como atributo do response erro.

supported

Se o cache de token compartilhado tem suporte na plataforma atual.

static supported() -> bool

Retornos

True se o cache de token compartilhado tiver suporte na plataforma atual.

Tipo de retorno

bool