EnvironmentCredential Classe

  • Referência

Uma credencial configurada por variáveis de ambiente.

Esta credencial é capaz de autenticar como um principal de serviço através de um segredo do cliente ou de um certificado, ou como um utilizador com um nome de utilizador e palavra-passe. A configuração é tentada por esta ordem, utilizando estas variáveis de ambiente:

Principal de serviço com segredo:

  • AZURE_TENANT_ID: ID do inquilino do principal de serviço. Também denominado ID de "diretório".

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

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

  • AZURE_AUTHORITY_HOST: autoridade de um ponto final do Azure Active Directory, por exemplo "login.microsoftonline.com", a autoridade para a Cloud Pública do Azure, que é a predefinição quando não é atribuído nenhum valor.

Principal de serviço com certificado:

  • AZURE_TENANT_ID: ID do inquilino do principal de serviço. Também denominado ID de "diretório".

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

  • AZURE_CLIENT_CERTIFICATE_PATH: caminho para um ficheiro de certificado PEM ou PKCS12, incluindo a chave privada.

  • AZURE_CLIENT_CERTIFICATE_PASSWORD: (opcional) palavra-passe do ficheiro de certificado, se existir.

  • AZURE_AUTHORITY_HOST: autoridade de um ponto final do Azure Active Directory, por exemplo "login.microsoftonline.com", a autoridade para a Cloud Pública do Azure, que é a predefinição quando não é atribuído nenhum valor.

Utilizador com nome de utilizador e palavra-passe:

  • AZURE_CLIENT_ID: o ID de cliente da aplicação

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

  • AZURE_PASSWORD: a palavra-passe desse utilizador

  • AZURE_TENANT_ID: ID (opcional) do inquilino do principal de serviço. Também denominado ID de "diretório". Se não for fornecido, a predefinição é o inquilino "organizações", que suporta apenas contas escolares ou profissionais do Azure Active Directory.

  • AZURE_AUTHORITY_HOST: autoridade de um ponto final do Azure Active Directory, por exemplo "login.microsoftonline.com", a autoridade para a Cloud Pública do Azure, que é a predefinição quando não é atribuído nenhum valor.

Herança
builtins.object
EnvironmentCredential

Construtor

EnvironmentCredential(**kwargs: Any)

Exemplos

Crie um EnvironmentCredential.


   from azure.identity import EnvironmentCredential

   credential = EnvironmentCredential()

Métodos

close

Feche a sessão de transporte da credencial.
get_token

Pedir um token de acesso para âmbitos.

Este método é chamado automaticamente pelos clientes do SDK do Azure.

close

Feche a sessão de transporte da credencial.

close() -> None

get_token

Pedir um token de acesso para âmbitos.

Este método é chamado automaticamente pelos clientes do SDK do Azure.

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

Parâmetros

scopes
str
Necessário

âmbitos pretendidos para o token de acesso. Este método requer, pelo menos, um âmbito. Para obter mais informações sobre âmbitos, consulte https://video2.skills-academy.com/azure/active-directory/develop/scopes-oidc.

claims
str

afirmações adicionais necessárias no token, como as devolvidas no desafio de afirmações de um fornecedor de recursos após uma falha de autorização.

tenant_id
str

inquilino opcional a incluir no pedido de token.

Devoluções

Um token de acesso com os âmbitos pretendidos.

Tipo de retorno

AccessToken

Exceções

CredentialUnavailableError

a configuração da variável de ambiente está incompleta