Compartilhar via

EnvironmentCredential Classe

  • Referência

Uma credencial configurada por variáveis de ambiente.

Essa credencial é capaz de se autenticar como uma entidade de serviço usando um segredo do cliente ou um certificado ou como um usuário com um nome de usuário e senha. A configuração é tentada nesta ordem, usando estas variáveis de ambiente:

Entidade de serviço com segredo:

  • AZURE_TENANT_ID: ID do locatário da entidade de serviço. Também chamou sua ID de "diretório".

  • AZURE_CLIENT_ID: a ID do cliente da entidade de serviço

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

  • AZURE_AUTHORITY_HOST: 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 quando nenhum valor é fornecido.

Entidade de serviço com certificado:

  • AZURE_TENANT_ID: ID do locatário da entidade de serviço. Também chamou sua ID de "diretório".

  • AZURE_CLIENT_ID: a ID do cliente da entidade de serviço

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

  • AZURE_CLIENT_CERTIFICATE_PASSWORD: senha (opcional) do arquivo de certificado, se houver.

  • AZURE_AUTHORITY_HOST: 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 quando nenhum valor é fornecido.

Usuário com nome de usuário e senha:

  • AZURE_CLIENT_ID: a ID do cliente do aplicativo

  • AZURE_USERNAME: um nome de usuário (geralmente um endereço de email)

  • AZURE_PASSWORD: a senha desse usuário

  • AZURE_TENANT_ID: ID (opcional) do locatário da entidade de serviço. Também chamou sua ID de "diretó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.

  • AZURE_AUTHORITY_HOST: 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 quando nenhum valor é fornecido.

Herança
builtins.object
EnvironmentCredential

Construtor

EnvironmentCredential(**kwargs: Any)

Exemplos

Criar um EnvironmentCredential.


   from azure.identity import EnvironmentCredential

   credential = EnvironmentCredential()

Métodos

close

Feche a sessão de transporte da credencial.
get_token

Solicite um token de acesso para escopos.

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

close

Feche a sessão de transporte da credencial.

close() -> None

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) -> 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.

Retornos

Um token de acesso com os escopos desejados.

Tipo de retorno

AccessToken

Exceções

CredentialUnavailableError

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