ClientSecretCredential Classe
Autentica-se como um principal de serviço com um segredo do cliente.
- Herança
-
azure.identity._internal.client_credential_base.ClientCredentialBaseClientSecretCredential
Construtor
ClientSecretCredential(tenant_id: str, client_id: str, client_secret: str, **kwargs: Any)
Parâmetros
- tenant_id
- str
ID do inquilino do principal de serviço. Também denominado ID de "diretório".
- authority
- str
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). AzureAuthorityHosts define as autoridades para outras clouds.
- cache_persistence_options
- TokenCachePersistenceOptions
Configuração para colocação em cache de tokens persistentes. Se não for especificado, a credencial colocará os tokens em cache na memória.
- disable_instance_discovery
- bool
Determina se a deteção de instâncias é ou não efetuada ao tentar autenticar. Definir isto como verdadeiro irá desativar completamente a deteção de instâncias e a validação da autoridade. Esta funcionalidade destina-se a ser utilizada em cenários em que não é possível alcançar o ponto final de metadados, como em clouds privadas ou no Azure Stack. O processo de deteção de instâncias implica a obtenção de metadados de autoridade de https://login.microsoft.com/ para validar a autoridade. Ao defini-lo como Verdadeiro, a validação da autoridade está desativada. Como resultado, é crucial garantir que o anfitrião de autoridade configurado é válido e fidedigno.
Especifica inquilinos para além do "tenant_id" especificado para o qual a credencial pode adquirir tokens. Adicione o valor de caráter universal "*" para permitir que a credencial adquira tokens para qualquer inquilino a que a aplicação possa aceder.
Exemplos
Crie um ClientSecretCredential.
from azure.identity import ClientSecretCredential
credential = ClientSecretCredential(
tenant_id="<tenant_id>",
client_id="<client_id>",
client_secret="<client_secret>",
)
Métodos
close | |
get_token |
Pedir um token de acesso para âmbitos. Este método é chamado automaticamente pelos clientes do SDK do Azure. |
close
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
â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.
- enable_cae
- bool
indica se pretende ativar a Avaliação de Acesso Contínuo (CAE) para o token pedido. A predefinição é Falso.
Devoluções
Um token de acesso com os âmbitos pretendidos.
Tipo de retorno
Exceções
a credencial não consegue tentar autenticação porque não tem os dados necessários, o estado ou o suporte da plataforma
falha na autenticação. O atributo do message
erro dá um motivo.