CredentialBuilderBase<T> Classe

Pacote:

com.azure.identity

Artefato Maven:

com.azure:azure-identity:1.10.4

• java.lang.Object
• • com.azure.identity.CredentialBuilderBase<T>

Parâmetros de tipo

T

o tipo do construtor de credenciais

Implementações

HttpTrait<T>

public abstract class CredentialBuilderBase
implements HttpTrait<T>

A classe base para todos os construtores de credenciais.

Resumo do método

Modificador e tipo	Método e descrição
T	addPolicy(HttpPipelinePolicy policy) Adiciona um HttpPipelinePolicy para aplicar em cada solicitação enviada.
T	clientOptions(ClientOptions clientOptions) Permite definir propriedades comuns, como ID do aplicativo, cabeçalhos, configuração de proxy etc.
T	configuration(Configuration configuration) Define o repositório de configuração usado durante a construção da credencial.
T	enableAccountIdentifierLogging() Permite que os identificadores de conta sejam conectados no lado do cliente para fins de depuração/monitoramento.
T	httpClient(HttpClient client) Define o cliente HTTP a ser usado para enviar e receber solicitações de e para o serviço.
T	httpLogOptions(HttpLogOptions logOptions) Define o HttpLogOptions a ser usado ao enviar e receber solicitações de e para o serviço.
T	httpPipeline(HttpPipeline httpPipeline) Preterido Esse método é preterido. Usar pipeline(HttpPipeline pipeline) Especifica o Pipeline Httppara enviar todas as solicitações.
T	maxRetry(int maxRetry) Especifica o número máximo de tentativas quando uma solicitação de autenticação falha.
T	pipeline(HttpPipeline pipeline) Define o HttpPipeline a ser usado para o cliente de serviço.
T	proxyOptions(ProxyOptions proxyOptions) Preterido Configure as opções de proxy no HttpClient em vez disso e, em seguida, defina esse cliente na credencial usando httpClient(HttpClient client). Especifica as opções de configuração de proxy.
T	retryOptions(RetryOptions retryOptions) Define o RetryOptions para todas as solicitações feitas por meio do cliente.
T	retryPolicy(RetryPolicy retryPolicy) Define o RetryPolicy que é usado quando cada solicitação é enviada.
T	retryTimeout(Function<Duration,Duration> retryTimeout) Especifica uma Função para calcular segundos de tempo limite em cada solicitação repetida.

Métodos herdados de java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Detalhes do método

addPolicy

public T addPolicy(HttpPipelinePolicy policy)

Adiciona um HttpPipelinePolicy para aplicar em cada solicitação enviada.

Nota: É importante entender a ordem de precedência das APIs HttpTrait. Em particular, se um HttpPipeline for especificado, isso terá precedência sobre todas as outras APIs na característica e elas serão ignoradas. Se nenhum HttpPipeline for especificado, um pipeline HTTP será construído internamente com base nas configurações fornecidas a essa característica. Além disso, pode haver outras APIs em tipos que implementam essa característica que também serão ignoradas se um HttpPipeline for especificado, portanto, consulte a documentação de tipos que implementam essa característica para entender o conjunto completo de implicações.

Parameters:

policy - Uma HttpPipelinePolicy.

Returns:

Uma instância atualizada desse construtor com a política configurada.

clientOptions

public T clientOptions(ClientOptions clientOptions)

Permite definir propriedades comuns, como ID do aplicativo, cabeçalhos, configuração de proxy etc. Observe que é recomendável que esse método seja chamado com uma instância da HttpClientOptions classe (uma subclasse da ClientOptions classe base). A subclasse HttpClientOptions fornece mais opções de configuração adequadas para clientes HTTP, que é aplicável a qualquer classe que implemente essa interface HttpTrait.

Nota: É importante entender a ordem de precedência das APIs HttpTrait. Em particular, se um HttpPipeline for especificado, isso terá precedência sobre todas as outras APIs na característica e elas serão ignoradas. Se nenhum HttpPipeline for especificado, um pipeline HTTP será construído internamente com base nas configurações fornecidas a essa característica. Além disso, pode haver outras APIs em tipos que implementam essa característica que também serão ignoradas se um HttpPipeline for especificado, portanto, consulte a documentação de tipos que implementam essa característica para entender o conjunto completo de implicações.

Parameters:

clientOptions - Uma instância configurada do HttpClientOptions.

Returns:

Uma instância atualizada desse construtor com as opções de cliente configuradas.

configuration

public T configuration(Configuration configuration)

Define o repositório de configuração usado durante a construção da credencial. O repositório de configuração padrão é um clone do global configuration store.

Parameters:

configuration - O repositório de configuração usado para carregar variáveis Env e/ou propriedades.

Returns:

Uma instância atualizada desse construtor com o repositório de configuração definido conforme especificado.

enableAccountIdentifierLogging

public T enableAccountIdentifierLogging()

Permite que os identificadores de conta sejam conectados no lado do cliente para fins de depuração/monitoramento. Por padrão, ela fica desabilitada.

Os logs do Identificador de Conta podem conter informações confidenciais e devem ser habilitados somente em computadores protegidos. A habilitação desse log registra a ID do Aplicativo, a ID do Objeto, a ID do Locatário e o Nome Principal do Usuário no nível do INFO quando um token de acesso é recuperado com êxito. Verifique se os logs de nível INFO estão habilitados para ver os logs do identificador de conta.

Returns:

Uma instância atualizada desse construtor.

httpClient

public T httpClient(HttpClient client)

Define o cliente HTTP a ser usado para enviar e receber solicitações de e para o serviço.

Parameters:

client - O cliente HTTP a ser usado para solicitações.

Returns:

Uma instância atualizada desse construtor com o cliente http definido conforme especificado.

httpLogOptions

public T httpLogOptions(HttpLogOptions logOptions)

Define o HttpLogOptions a ser usado ao enviar e receber solicitações de e para o serviço. Se um logLevel não for fornecido, o valor padrão de HttpLogDetailLevel#NONE será definido.

Nota: É importante entender a ordem de precedência das APIs HttpTrait. Em particular, se um HttpPipeline for especificado, isso terá precedência sobre todas as outras APIs na característica e elas serão ignoradas. Se nenhum HttpPipeline for especificado, um pipeline HTTP será construído internamente com base nas configurações fornecidas a essa característica. Além disso, pode haver outras APIs em tipos que implementam essa característica que também serão ignoradas se um HttpPipeline for especificado, portanto, consulte a documentação de tipos que implementam essa característica para entender o conjunto completo de implicações.

Parameters:

logOptions - O HttpLogOptions a ser usado ao enviar e receber solicitações de e para o serviço.

Returns:

Uma instância atualizada desse construtor com as opções de log Http configuradas.

httpPipeline

@Deprecated
public T httpPipeline(HttpPipeline httpPipeline)

Preterido

Esse método é preterido. Usar pipeline(HttpPipeline pipeline)

Especifica o HttpPipeline para enviar todas as solicitações. Essa configuração substitui as outras.

Parameters:

httpPipeline - o HttpPipeline para enviar todas as solicitações

Returns:

Uma instância atualizada desse construtor com o pipeline http definido conforme especificado.

maxRetry

public T maxRetry(int maxRetry)

Especifica o número máximo de tentativas quando uma solicitação de autenticação falha.

Parameters:

maxRetry - o número de repetições

Returns:

Uma instância atualizada desse construtor com o conjunto máximo de repetições, conforme especificado.

pipeline

public T pipeline(HttpPipeline pipeline)

Define o HttpPipeline a ser usado para o cliente de serviço.

Nota: É importante entender a ordem de precedência das APIs HttpTrait. Em particular, se um HttpPipeline for especificado, isso terá precedência sobre todas as outras APIs na característica e elas serão ignoradas. Se nenhum HttpPipeline for especificado, um pipeline HTTP será construído internamente com base nas configurações fornecidas a essa característica. Além disso, pode haver outras APIs em tipos que implementam essa característica que também serão ignoradas se um HttpPipeline for especificado, portanto, consulte a documentação de tipos que implementam essa característica para entender o conjunto completo de implicações.

Parameters:

pipeline - HttpPipeline a ser usado para enviar solicitações de serviço e receber respostas.

Returns:

Uma instância atualizada desse construtor com o pipeline http definido conforme especificado.

proxyOptions

@Deprecated
public T proxyOptions(ProxyOptions proxyOptions)

Preterido

Configure as opções de proxy no HttpClient em vez disso e, em seguida, defina esse cliente na credencial usando httpClient(HttpClient client).

Especifica as opções de configuração de proxy.

Parameters:

proxyOptions - as opções de configuração de proxy

Returns:

Uma instância atualizada desse construtor com as opções de proxy definidas conforme especificado.

retryOptions

public T retryOptions(RetryOptions retryOptions)

Define o RetryOptions para todas as solicitações feitas por meio do cliente.

Nota: É importante entender a ordem de precedência das APIs HttpTrait. Em particular, se um HttpPipeline for especificado, isso terá precedência sobre todas as outras APIs na característica e elas serão ignoradas. Se nenhum HttpPipeline for especificado, um pipeline HTTP será construído internamente com base nas configurações fornecidas a essa característica. Além disso, pode haver outras APIs em tipos que implementam essa característica que também serão ignoradas se um HttpPipeline for especificado, portanto, consulte a documentação de tipos que implementam essa característica para entender o conjunto completo de implicações.

Definir isso é mutuamente exclusivo com o uso de retryPolicy(RetryPolicy retryPolicy).

Parameters:

retryOptions - O RetryOptions a ser usado para todas as solicitações feitas por meio do cliente.

Returns:

Uma instância atualizada desse construtor com as opções de repetição configuradas.

retryPolicy

public T retryPolicy(RetryPolicy retryPolicy)

Define o RetryPolicy que é usado quando cada solicitação é enviada. Definir isso é mutuamente exclusivo com o uso de retryOptions(RetryOptions retryOptions). A política de repetição padrão será usada no pipeline, se não for fornecida.

Parameters:

retryPolicy - política de repetição do usuário aplicada a cada solicitação.

Returns:

Uma instância atualizada desse construtor com a política de repetição configurada.

retryTimeout

public T retryTimeout(Function retryTimeout)

Especifica uma Função para calcular segundos de tempo limite em cada solicitação repetida.

Parameters:

retryTimeout - a Função que retorna um tempo limite em segundos, considerando o número de repetições

Returns:

Uma instância atualizada desse construtor com o tempo limite de repetição definido conforme especificado.