identity Pacote

Credenciais para clientes Azure SDK.

Pacote

aio

Credenciais para clientes assíncronos Azure SDK.

Classes

AuthenticationRecord

Informações de conta não secretas para um utilizador autenticado

Esta classe permite e InteractiveBrowserCredential aceder a dados DeviceCodeCredential de autenticação previamente em cache. As candidaturas não devem construir casos desta classe. Em vez disso, deveriam adquirir um a partir do método de autenticação de uma credencial, tais como <xref:InteractiveBrowserCredential.authenticate>. Consulte a amostra user_authentication para mais detalhes.

AuthenticationRequiredError

A autenticação interativa é necessária para adquirir um token.

Este erro é levantado apenas por credenciais de utilizador interativas configuradas para não solicitar automaticamente a interação do utilizador conforme necessário. As suas propriedades fornecem informações adicionais que podem ser necessárias para autenticar. A amostra control_interactive_prompts demonstra o manuseamento deste erro chamando o método de "autenticação" de uma credencial.

AuthorizationCodeCredential

Autenticando através do resgate de um código de autorização previamente obtido a partir do Diretório Ativo Azure.

Consulte a documentação do Diretório Ativo Azure para obter mais informações sobre o fluxo de autenticação.

AzureAuthorityHosts

Credenciais para clientes Azure SDK.

AzureCliCredential

Autentica-se solicitando um token do Azure CLI.

Isto requer login previamente no Azure através de "az login", e utilizará o CLI's atualmente registado na identidade.

AzurePowerShellCredential

Autentica-se solicitando um token de Azure PowerShell.

Isto requer login previamente no Azure através do "Connect-AzAccount", e utilizará o atualmente registado na identidade.

CertificateCredential

Autentica-se como principal de serviço utilizando um certificado.

O certificado deve ter uma chave privada RSA, porque esta credencial assina afirmações usando RS256. Consulte a documentação do Diretório Ativo Azure para obter mais informações sobre a autenticação de certificados configurados.

ChainedTokenCredential

Uma sequência de credenciais que é em si uma credencial.

O seu get_token método requer get_token cada credencial na sequência, por ordem, devolvendo o primeiro token válido recebido.

ClientAssertionCredential

Credenciais para clientes Azure SDK.

ClientSecretCredential

Autentica como diretor de serviço usando um segredo de cliente.

CredentialUnavailableError

A credencial não tentou autenticar porque os dados ou estado necessários não estão disponíveis.

DefaultAzureCredential

Uma credencial padrão capaz de lidar com a maioria dos cenários de autenticação Azure SDK.

A identidade que usa depende do ambiente. Quando um sinal de acesso é necessário, solicita que se utilize estas identidades por sua vez, parando quando se fornece um símbolo:

  1. Um diretor de serviço configurado por variáveis ambientais. Veja EnvironmentCredential mais detalhes.

  2. Uma identidade gerida pelo Azure. Veja ManagedIdentityCredential mais detalhes.

  3. Apenas no Windows: um utilizador que tenha assinado com uma aplicação da Microsoft, como o Visual Studio. Se várias identidades estiverem na cache, então o valor da variável AZURE_USERNAME ambiental é usado para selecionar qual identidade usar. Veja SharedTokenCacheCredential mais detalhes.

  4. O utilizador inscreveu-se atualmente no Código do Estúdio Visual.

  5. A identidade está atualmente registada no Azure CLI.

  6. A identidade está a registar-se no Azure PowerShell.

Este comportamento padrão é configurável com argumentos de palavras-chave.

DeviceCodeCredential

Autentica os utilizadores através do fluxo de código do dispositivo.

Quando <xref:azure.identity.get_token> é chamado, esta credencial adquire um URL de verificação e código da Azure Ative Directory. Um utilizador deve navegar pelo URL, introduzir o código e autenticar com o Azure Ative Directory. Se o utilizador autenticar com sucesso, a credencial recebe um token de acesso.

Esta credencial é principalmente útil para autenticar um utilizador num ambiente sem um navegador web, como uma sessão de SSH. Se um navegador está disponível, InteractiveBrowserCredential é mais conveniente porque abre automaticamente um navegador para a página de login.

EnvironmentCredential

Uma credencial configurada por variáveis ambientais.

Esta credencial é capaz de autenticar como principal de serviço utilizando um segredo de cliente ou certificado, ou como utilizador com um nome de utilizador e senha. A configuração é tentada nesta ordem, utilizando estas variáveis ambientais:

Diretor de serviço com segredo:

  • AZURE_TENANT_ID: Identificação do inquilino do diretor de serviço. Também chamou a sua identificação de "diretório".

  • AZURE_CLIENT_ID: ID do cliente do diretor de serviço

  • AZURE_CLIENT_SECRET: um dos segredos do cliente do diretor de serviço

  • AZURE_AUTHORITY_HOST: autoridade de um ponto final do Azure Ative Directory, por exemplo "login.microsoftonline.com", a autoridade da Azure Public Cloud, que é o padrão quando não é dado qualquer valor.

Com certificado:

  • AZURE_TENANT_ID: Identificação do inquilino do diretor de serviço. Também chamou a sua identificação de "diretório".

  • AZURE_CLIENT_ID: ID do cliente do diretor de serviço

  • AZURE_CLIENT_CERTIFICATE_PATH: caminho para um ficheiro de certificado PEM ou PKCS12, incluindo a chave privada. O certificado não deve estar protegido por palavra-passe.

  • AZURE_AUTHORITY_HOST: autoridade de um ponto final do Azure Ative Directory, por exemplo "login.microsoftonline.com", a autoridade da Azure Public Cloud, que é o padrão quando não é dado qualquer valor.

Utilizador com nome de utilizador e senha:

  • AZURE_CLIENT_ID: ID do cliente da aplicação

  • AZURE_USERNAME: um nome de utilizador (geralmente um endereço de e-mail)

  • AZURE_PASSWORD: a palavra-passe do utilizador

  • AZURE_TENANT_ID: Identificação (opcional) do inquilino do prestador de serviços. Também chamou a sua identificação de "diretório". Caso não seja fornecido, o incumprimento do inquilino das "organizações", que suporta apenas o trabalho do Azure Ative Directory ou as contas escolares.

  • AZURE_AUTHORITY_HOST: autoridade de um ponto final do Azure Ative Directory, por exemplo "login.microsoftonline.com", a autoridade da Azure Public Cloud, que é o padrão quando não é dado qualquer valor.

InteractiveBrowserCredential

Abre um browser para autenticar interativamente um utilizador.

<xref:azure.identity.get_token> abre um navegador a um URL de login fornecido pelo Azure Ative Directory e autentica um utilizador lá com o fluxo de código de autorização, utilizando o PKCE (Chave de Prova para Troca de Códigos) internamente para proteger o código.

KnownAuthorities

Pseudónimo de AzureAuthorityHosts

ManagedIdentityCredential

Autentica-se com uma identidade gerida aZure em qualquer ambiente de hospedagem que suporte identidades geridas.

Esta credencial falha na utilização de uma identidade atribuída ao sistema. Para configurar uma identidade atribuída ao utilizador, utilize um dos argumentos de palavra-chave. Consulte a documentação do Diretório Ativo Azure para obter mais informações sobre a configuração da identidade gerida para os pedidos.

OnBehalfOfCredential

Autentica um principal de serviço através do fluxo em nome.

Este fluxo é normalmente utilizado por serviços de nível médio que autorizam pedidos a outros serviços com identidade de utilizador delegada. Como este não é um fluxo de autenticação interativa, uma aplicação que o utilize deve ter o consentimento administrativo para quaisquer permissões delegadas antes de pedir fichas para os mesmos. Consulte a documentação do Diretório Ativo Azure para obter uma descrição mais detalhada do fluxo em nome do fluxo.

SharedTokenCacheCredential

Autenticações usando fichas na cache local partilhadas entre aplicações da Microsoft.

TokenCachePersistenceOptions

Opções para caching token persistente.

A maioria das credenciais aceita um exemplo desta classe para configurar caching token persistente. Os valores predefinidos configuram uma credencial para usar uma cache partilhada com as ferramentas de desenvolvimento da Microsoft e SharedTokenCacheCredential. Para isolar os dados de uma credencial de outras aplicações, especifique um nome para a cache.

Por padrão, a cache é encriptada com a API de proteção de dados do utilizador da plataforma atual, e irá levantar um erro quando este não estiver disponível. Para configurar a cache para voltar a cair para um ficheiro não encriptado em vez de levantar um erro, especifique allow_unencrypted_storage=Verdadeiro.

Aviso

A cache contém segredos de autenticação. Se a cache não é encriptada, protegendo-a é a

responsabilidade da aplicação. Uma violação do seu conteúdo comprometerá totalmente as contas.

Configurar uma credencial para o caching persistente

cache_options = Opções tokenCachePersistence()

credencial = InteractiveBrowserCredential (cache_persistence_options=cache_options)

especificar um nome de cache para isolar a cache de outras aplicações

Opções tokenCachePersistence (nome="my_application")

configurar a cache para voltar a ser descodificar quando a encriptação não estiver disponível

Opções tokenCachePersistence (allow_unencrypted_storage=Verdade)

UsernamePasswordCredential

Autentica um utilizador com um nome de utilizador e senha.

Em geral, a Microsoft não recomenda este tipo de autenticação, porque é menos segura do que outros fluxos de autenticação.

A autenticação com esta credencial não é interativa, pelo que não é compatível com qualquer forma de autenticação ou consentimento de vários fatores. O pedido já deve ter o consentimento do utilizador ou de um administrador de diretório.

Esta credencial só pode autenticar contas de trabalho e escola; As contas da Microsoft não são suportadas. Consulte a documentação do Azure Ative Directory para obter mais informações sobre tipos de conta.

VisualStudioCodeCredential

Autentica como o utilizador Azure assinou no Código do Estúdio Visual.