ClientSecretCredential Classe

  • Referência

Autentica como uma entidade de serviço usando um segredo do cliente.

Herança
azure.identity.aio._internal.AsyncContextManager
ClientSecretCredential
azure.identity.aio._internal.get_token_mixin.GetTokenMixin
ClientSecretCredential

Construtor

ClientSecretCredential(tenant_id: str, client_id: str, client_secret: str, **kwargs: Any)

Parâmetros

tenant_id
str
Obrigatório

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

client_id
str
Obrigatório

A ID do cliente da entidade de serviço

client_secret
str
Obrigatório

Um dos segredos do cliente da entidade de serviço

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.

cache_persistence_options
TokenCachePersistenceOptions

Configuração para cache de token persistente. Se não for especificado, a credencial armazenará tokens em cache na memória.

additionally_allowed_tenants
List[str]

Especifica locatários além do "tenant_id" especificado para o qual a credencial pode adquirir tokens. Adicione o valor curinga "*" para permitir que a credencial adquira tokens para qualquer locatário que o aplicativo possa acessar.

Exemplos

Crie um ClientSecretCredential.


   from azure.identity.aio import ClientSecretCredential

   credential = ClientSecretCredential(
       tenant_id="<tenant_id>",
       client_id="<client_id>",
       client_secret="<client_secret>",
   )

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.

async close() -> None

get_token

Solicite um token de acesso para escopos.

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

a credencial não pode tentar a autenticação porque não tem dados, estado ou suporte à plataforma necessários

ClientAuthenticationError

falha na autenticação. O atributo do message erro fornece um motivo.