Partilhar via


Configuration Classe

  • java.lang.Object
    • com.azure.core.util.Configuration

Implementações

public class Configuration
implements Cloneable

Contém informações de configuração usadas durante a construção de bibliotecas de clientes.

Configuration configuration = new ConfigurationBuilder(new SampleSource(properties))
     .root("azure.sdk")
     .buildSection("client-name");

 ConfigurationProperty<String> proxyHostnameProperty = ConfigurationPropertyBuilder.ofString("http.proxy.hostname")
     .shared(true)
     .build();
 System.out.println(configuration.get(proxyHostnameProperty));

Resumo do campo

Modificador e tipo Campo e descrição
static final Configuration NONE

Objeto sem operações Configuration usado para recusar o uso de configurações globais ao construir bibliotecas de cliente.

static final String PROPERTY_AZURE_AUTHORITY_HOST

O ponto de extremidade do Azure Active Directory ao qual se conectar.

static final String PROPERTY_AZURE_CLIENT_CERTIFICATE_PASSWORD

Senha para um certificado PFX/PEM usado ao executar a autenticação da entidade de serviço com o Azure.

static final String PROPERTY_AZURE_CLIENT_CERTIFICATE_PATH

Caminho de um arquivo de certificado PFX/PEM a ser usado ao executar a autenticação da entidade de serviço com o Azure.

static final String PROPERTY_AZURE_CLIENT_ID

ID do cliente a ser usada ao executar a autenticação da entidade de serviço com o Azure.

static final String PROPERTY_AZURE_CLIENT_SECRET

Segredo do cliente a ser usado ao executar a autenticação da entidade de serviço com o Azure.

static final String PROPERTY_AZURE_CLOUD

Nome da nuvem do Azure à qual se conectar.

static final String PROPERTY_AZURE_HTTP_CLIENT_IMPLEMENTATION

Define o nome da HttpClientProvider implementação que deve ser usada para construir instâncias do HttpClient.

static final String PROPERTY_AZURE_HTTP_LOG_DETAIL_LEVEL

Habilita o log de solicitação/resposta HTTP definindo um nível de detalhes do log HTTP.

static final String PROPERTY_AZURE_IDENTITY_DISABLE_CP1

Sinalizador para desabilitar os recursos do cliente CP1 nas credenciais do Token de Identidade do Azure.

static final String PROPERTY_AZURE_LOG_LEVEL

Habilita o registro em log definindo um nível de log.

static final String PROPERTY_AZURE_METRICS_DISABLED

Desabilita as métricas.

static final String PROPERTY_AZURE_METRICS_IMPLEMENTATION

Define o nome da MeterProvider implementação que deve ser usada para construir instâncias do Meter.

static final String PROPERTY_AZURE_PASSWORD

Nome de usuário a ser usado ao executar a autenticação de nome de usuário/senha com o Azure.

static final String PROPERTY_AZURE_POD_IDENTITY_TOKEN_URL

URL usada pelo Bridge To Kubernetes para redirecionar chamadas IMDS no ambiente de desenvolvimento.

static final String PROPERTY_AZURE_REGIONAL_AUTHORITY_NAME

Nome da autoridade regional do Azure AAD.

static final String PROPERTY_AZURE_REQUEST_CONNECT_TIMEOUT

Define o tempo limite padrão, em milissegundos, para que uma solicitação se conecte ao host remoto.

static final String PROPERTY_AZURE_REQUEST_READ_TIMEOUT

Define o intervalo de tempo limite padrão, em milissegundos, permitido entre cada byte lido em uma resposta.

static final String PROPERTY_AZURE_REQUEST_RESPONSE_TIMEOUT

Define o tempo limite padrão, em milissegundos, para que uma solicitação receba uma resposta do host remoto.

static final String PROPERTY_AZURE_REQUEST_RETRY_COUNT

Define o número padrão de vezes que uma solicitação será repetida, se ela passar as condições para repetição, antes de falhar.

static final String PROPERTY_AZURE_REQUEST_WRITE_TIMEOUT

Define o intervalo de tempo limite padrão, em milissegundos, permitido entre cada byte gravado por uma solicitação.

static final String PROPERTY_AZURE_RESOURCE_GROUP

Nome do grupo de recursos do Azure.

static final String PROPERTY_AZURE_SUBSCRIPTION_ID

ID da assinatura a ser usada ao se conectar aos recursos do Azure.

static final String PROPERTY_AZURE_TELEMETRY_DISABLED

Desabilita a coleta de telemetria.

static final String PROPERTY_AZURE_TENANT_ID

ID do locatário para os recursos do Azure.

static final String PROPERTY_AZURE_TRACING_DISABLED

Desabilita o rastreamento.

static final String PROPERTY_AZURE_TRACING_IMPLEMENTATION

Define o nome da TracerProvider implementação que deve ser usada para construir instâncias do Tracer.

static final String PROPERTY_AZURE_USERNAME

Nome de usuário a ser usado ao executar a autenticação de nome de usuário/senha com o Azure.

static final String PROPERTY_HTTPS_PROXY

URL do proxy para conexões HTTPS.

static final String PROPERTY_HTTP_PROXY

URL do proxy para conexões HTTP.

static final String PROPERTY_IDENTITY_ENDPOINT

Ponto de extremidade ao qual se conectar ao usar a MSI (identidade de serviço gerenciada) do Azure Active Directory.

static final String PROPERTY_IDENTITY_HEADER

Cabeçalho ao se conectar ao Azure Active Directory usando a MSI (identidade de serviço gerenciada).

static final String PROPERTY_MSI_ENDPOINT

Ponto de extremidade ao qual se conectar ao usar a MSI (identidade de serviço gerenciada) do Azure Active Directory.

static final String PROPERTY_MSI_SECRET

Segredo ao se conectar ao Azure Active Directory usando a MSI (identidade de serviço gerenciada).

static final String PROPERTY_NO_PROXY

Uma lista de hosts ou CIDR para não usar conexões HTTP/HTTPS de proxy.

Resumo do Construtor

Construtor Description
Configuration()

Preterido

Use ConfigurationBuilder e ConfigurationSource que permitem fornecer todas as propriedades antes de criar a configuração e mantê-la imutável.

Constrói uma configuração que contém as constantes de propriedades conhecidas do Azure.

Resumo do método

Modificador e tipo Método e descrição
T get(ConfigurationProperty<T> property)

Obtém o valor da propriedade de todas as fontes disponíveis na seguinte ordem:

  • Configuração explícita de fornecido ConfigurationSource pelo nome da propriedade
  • Configuração explícita por aliases de propriedade na ordem em que foram fornecidos ConfigurationProperty<T>
  • Configuração explícita por nome da propriedade na seção compartilhada (se ConfigurationProperty<T> for compartilhado)
  • Configuração explícita por aliases de propriedade na seção compartilhada (se ConfigurationProperty<T> for compartilhado)
  • Propriedade system (se definido)
  • Variável de ambiente (se definida)
T get(String name, T defaultValue)

Obtém o valor da propriedade do sistema ou da variável de ambiente convertida em determinada primitiva T usando o método correspondente parse nesse tipo.

T get(String name, Function<String,T> converter)

Obtém o valor da propriedade do sistema ou da variável de ambiente e converte-o com o converter.

Configuration clone()

Preterido

Use ConfigurationBuilder e ConfigurationSource para criar a configuração.

Clona esse objeto Configuration.

boolean contains(ConfigurationProperty<?> property)

Verifica se a configuração contém a propriedade .

boolean contains(String name)

Determina se a propriedade do sistema ou variável de ambiente está definida.

String get(String name)

Obtém o valor da propriedade do sistema ou da variável de ambiente.

static Configuration getGlobalConfiguration()

Obtém o repositório de configuração global compartilhado por todas as bibliotecas de cliente.

Configuration put(String name, String value)

Preterido

Use ConfigurationBuilder e ConfigurationSource para fornecer todas as propriedades antes de criar a configuração.

Adiciona uma configuração com o valor fornecido.

String remove(String name)

Preterido

Use ConfigurationBuilder e ConfigurationSource para fornecer todas as propriedades antes de criar a configuração.

Remove a configuração.

Métodos herdados de java.lang.Object

Detalhes do campo

NONE

public static final Configuration NONE

Objeto sem operações Configuration usado para recusar o uso de configurações globais ao construir bibliotecas de cliente.

PROPERTY_AZURE_AUTHORITY_HOST

public static final String PROPERTY_AZURE_AUTHORITY_HOST

O ponto de extremidade do Azure Active Directory ao qual se conectar.

PROPERTY_AZURE_CLIENT_CERTIFICATE_PASSWORD

public static final String PROPERTY_AZURE_CLIENT_CERTIFICATE_PASSWORD

Senha para um certificado PFX/PEM usado ao executar a autenticação da entidade de serviço com o Azure.

PROPERTY_AZURE_CLIENT_CERTIFICATE_PATH

public static final String PROPERTY_AZURE_CLIENT_CERTIFICATE_PATH

Caminho de um arquivo de certificado PFX/PEM a ser usado ao executar a autenticação da entidade de serviço com o Azure.

PROPERTY_AZURE_CLIENT_ID

public static final String PROPERTY_AZURE_CLIENT_ID

ID do cliente a ser usada ao executar a autenticação da entidade de serviço com o Azure.

PROPERTY_AZURE_CLIENT_SECRET

public static final String PROPERTY_AZURE_CLIENT_SECRET

Segredo do cliente a ser usado ao executar a autenticação da entidade de serviço com o Azure.

PROPERTY_AZURE_CLOUD

public static final String PROPERTY_AZURE_CLOUD

Nome da nuvem do Azure à qual se conectar.

PROPERTY_AZURE_HTTP_CLIENT_IMPLEMENTATION

public static final String PROPERTY_AZURE_HTTP_CLIENT_IMPLEMENTATION

Define o nome da HttpClientProvider implementação que deve ser usada para construir instâncias do HttpClient.

O nome deve ser o nome completo da classe, ex com.azure.core.http.netty.NettyAsyncHttpClientProvider e não NettyAsyncHttpClientProvider, para desambiguar vários provedores com o mesmo nome, mas de pacotes diferentes.

Se o valor não estiver definido ou for uma cadeia de caracteres vazia, o primeiro HttpClientProvider resolvido pelo ServiceLoader será usado para criar uma instância do HttpClient. Se o valor for definido e não corresponder a nenhum HttpClientProvider resolvido pelo ServiceLoader , um IllegalStateException será gerado ao tentar criar uma instância do HttpClient.

PROPERTY_AZURE_HTTP_LOG_DETAIL_LEVEL

public static final String PROPERTY_AZURE_HTTP_LOG_DETAIL_LEVEL

Habilita o log de solicitação/resposta HTTP definindo um nível de detalhes do log HTTP.

PROPERTY_AZURE_IDENTITY_DISABLE_CP1

public static final String PROPERTY_AZURE_IDENTITY_DISABLE_CP1

Sinalizador para desabilitar os recursos do cliente CP1 nas credenciais do Token de Identidade do Azure.

PROPERTY_AZURE_LOG_LEVEL

public static final String PROPERTY_AZURE_LOG_LEVEL

Habilita o registro em log definindo um nível de log.

PROPERTY_AZURE_METRICS_DISABLED

public static final String PROPERTY_AZURE_METRICS_DISABLED

Desabilita as métricas.

PROPERTY_AZURE_METRICS_IMPLEMENTATION

public static final String PROPERTY_AZURE_METRICS_IMPLEMENTATION

Define o nome da MeterProvider implementação que deve ser usada para construir instâncias do Meter.

O nome deve ser o nome completo da classe, por exemplo com.azure.core.tracing.opentelemetry.OpenTelemetryMeterProvider , e não OpenTelemetryMeterProvider.

Se o valor não estiver definido ou for uma cadeia de caracteres vazia, o primeiro MeterProvider resolvido pelo ServiceLoader será usado para criar uma instância do Meter. Se o valor for definido e não corresponder a nenhum MeterProvider resolvido pelo ServiceLoader , um IllegalStateException será gerado ao tentar criar uma instância do MeterProvider.

PROPERTY_AZURE_PASSWORD

public static final String PROPERTY_AZURE_PASSWORD

Nome de usuário a ser usado ao executar a autenticação de nome de usuário/senha com o Azure.

PROPERTY_AZURE_POD_IDENTITY_TOKEN_URL

public static final String PROPERTY_AZURE_POD_IDENTITY_TOKEN_URL

URL usada pelo Bridge To Kubernetes para redirecionar chamadas IMDS no ambiente de desenvolvimento.

PROPERTY_AZURE_REGIONAL_AUTHORITY_NAME

public static final String PROPERTY_AZURE_REGIONAL_AUTHORITY_NAME

Nome da autoridade regional do Azure AAD.

PROPERTY_AZURE_REQUEST_CONNECT_TIMEOUT

public static final String PROPERTY_AZURE_REQUEST_CONNECT_TIMEOUT

Define o tempo limite padrão, em milissegundos, para que uma solicitação se conecte ao host remoto.

Se o valor configurado for igual ou menor que 0, nenhum tempo limite será aplicado.

PROPERTY_AZURE_REQUEST_READ_TIMEOUT

public static final String PROPERTY_AZURE_REQUEST_READ_TIMEOUT

Define o intervalo de tempo limite padrão, em milissegundos, permitido entre cada byte lido em uma resposta.

Se o valor configurado for igual ou menor que 0, nenhum tempo limite será aplicado.

PROPERTY_AZURE_REQUEST_RESPONSE_TIMEOUT

public static final String PROPERTY_AZURE_REQUEST_RESPONSE_TIMEOUT

Define o tempo limite padrão, em milissegundos, para que uma solicitação receba uma resposta do host remoto.

Se o valor configurado for igual ou menor que 0, nenhum tempo limite será aplicado.

PROPERTY_AZURE_REQUEST_RETRY_COUNT

public static final String PROPERTY_AZURE_REQUEST_RETRY_COUNT

Define o número padrão de vezes que uma solicitação será repetida, se ela passar as condições para repetição, antes de falhar.

PROPERTY_AZURE_REQUEST_WRITE_TIMEOUT

public static final String PROPERTY_AZURE_REQUEST_WRITE_TIMEOUT

Define o intervalo de tempo limite padrão, em milissegundos, permitido entre cada byte gravado por uma solicitação.

Se o valor configurado for igual ou menor que 0, nenhum tempo limite será aplicado.

PROPERTY_AZURE_RESOURCE_GROUP

public static final String PROPERTY_AZURE_RESOURCE_GROUP

Nome do grupo de recursos do Azure.

PROPERTY_AZURE_SUBSCRIPTION_ID

public static final String PROPERTY_AZURE_SUBSCRIPTION_ID

ID da assinatura a ser usada ao se conectar aos recursos do Azure.

PROPERTY_AZURE_TELEMETRY_DISABLED

public static final String PROPERTY_AZURE_TELEMETRY_DISABLED

Desabilita a coleta de telemetria.

PROPERTY_AZURE_TENANT_ID

public static final String PROPERTY_AZURE_TENANT_ID

ID do locatário para os recursos do Azure.

PROPERTY_AZURE_TRACING_DISABLED

public static final String PROPERTY_AZURE_TRACING_DISABLED

Desabilita o rastreamento.

PROPERTY_AZURE_TRACING_IMPLEMENTATION

public static final String PROPERTY_AZURE_TRACING_IMPLEMENTATION

Define o nome da TracerProvider implementação que deve ser usada para construir instâncias do Tracer.

O nome deve ser o nome completo da classe, por exemplo com.azure.core.tracing.opentelemetry.OpenTelemetryTracerProvider , e não OpenTelemetryTracerProvider.

Se o valor não estiver definido ou for uma cadeia de caracteres vazia, o primeiro TracerProvider resolvido pelo ServiceLoader será usado para criar uma instância do Tracer. Se o valor for definido e não corresponder a nenhum TracerProvider resolvido pelo ServiceLoader , um IllegalStateException será gerado ao tentar criar uma instância do TracerProvider.

PROPERTY_AZURE_USERNAME

public static final String PROPERTY_AZURE_USERNAME

Nome de usuário a ser usado ao executar a autenticação de nome de usuário/senha com o Azure.

PROPERTY_HTTPS_PROXY

public static final String PROPERTY_HTTPS_PROXY

URL do proxy para conexões HTTPS.

PROPERTY_HTTP_PROXY

public static final String PROPERTY_HTTP_PROXY

URL do proxy para conexões HTTP.

PROPERTY_IDENTITY_ENDPOINT

public static final String PROPERTY_IDENTITY_ENDPOINT

Ponto de extremidade ao qual se conectar ao usar a MSI (identidade de serviço gerenciada) do Azure Active Directory.

PROPERTY_IDENTITY_HEADER

public static final String PROPERTY_IDENTITY_HEADER

Cabeçalho ao se conectar ao Azure Active Directory usando a MSI (identidade de serviço gerenciada).

PROPERTY_MSI_ENDPOINT

public static final String PROPERTY_MSI_ENDPOINT

Ponto de extremidade ao qual se conectar ao usar a MSI (identidade de serviço gerenciada) do Azure Active Directory.

PROPERTY_MSI_SECRET

public static final String PROPERTY_MSI_SECRET

Segredo ao se conectar ao Azure Active Directory usando a MSI (identidade de serviço gerenciada).

PROPERTY_NO_PROXY

public static final String PROPERTY_NO_PROXY

Uma lista de hosts ou CIDR para não usar conexões HTTP/HTTPS de proxy.

Detalhes do construtor

Configuration

@Deprecated
public Configuration()

Preterido

Use ConfigurationBuilder e ConfigurationSource que permitem fornecer todas as propriedades antes de criar a configuração e mantê-la imutável.

Constrói uma configuração que contém as constantes de propriedades conhecidas do Azure.

Detalhes do método

get

public T get(ConfigurationProperty property)

Obtém o valor da propriedade de todas as fontes disponíveis na seguinte ordem:

  • Configuração explícita de fornecido ConfigurationSource pelo nome da propriedade
  • Configuração explícita por aliases de propriedade na ordem em que foram fornecidos ConfigurationProperty<T>
  • Configuração explícita por nome da propriedade na seção compartilhada (se ConfigurationProperty<T> for compartilhado)
  • Configuração explícita por aliases de propriedade na seção compartilhada (se ConfigurationProperty<T> for compartilhado)
  • Propriedade system (se definido)
  • Variável de ambiente (se definida)

O valor da propriedade é convertido em tipo especificado. Se o valor da propriedade estiver ausente e não for necessário, o valor padrão será retornado.

ConfigurationProperty<String> property = ConfigurationPropertyBuilder.ofString("http.proxy.hostname")
     .shared(true)
     .logValue(true)
     .systemPropertyName("http.proxyHost")
     .build();

 // attempts to get local `azure.sdk.<client-name>.http.proxy.host` property and falls back to
 // shared azure.sdk.http.proxy.port
 System.out.println(configuration.get(property));

Parâmetros:

property - do Service Fabric.

Retornos:

O valor da propriedade se ela existir, caso contrário, o valor padrão da propriedade.

get

public T get(String name, T defaultValue)

Obtém o valor da propriedade do sistema ou da variável de ambiente convertida em determinada primitiva T usando o método correspondente parse nesse tipo. Use get(ConfigurationProperty<T> property) a sobrecarga para obter configuração explícita ou configuração de ambiente de origem específica.

Esse método primeiro verifica os valores carregados anteriormente do ambiente, se a configuração for encontrada lá, ele será retornado. Caso contrário, isso tentará carregar o valor do ambiente.

Se nenhuma configuração for encontrada, o defaultValue será retornado.

Os seguintes tipos têm suporte:

  • Byte
  • Short
  • Integer
  • Long
  • Float
  • Double
  • Boolean

Parâmetros:

name - Nome da configuração.
defaultValue - Valor a ser retornado se a configuração não for encontrada.

Retornos:

A configuração convertida, se encontrada, caso contrário, o valor padrão será retornado.

get

public T get(String name, Function converter)

Obtém o valor da propriedade do sistema ou da variável de ambiente e converte-o com o converter.

Esse método primeiro verifica os valores carregados anteriormente do ambiente, se a configuração for encontrada lá, ele será retornado. Caso contrário, isso tentará carregar o valor do ambiente.

Se nenhuma configuração for encontrada, o converter não será chamado e nulo será retornado.

Parâmetros:

name - Nome da configuração.
converter - Conversor usado para mapear a configuração para T.

Retornos:

A configuração convertida se encontrada, caso contrário, nula.

clone

@Deprecated
public Configuration clone()

Preterido

Use ConfigurationBuilder e ConfigurationSource para criar a configuração.

Clona esse objeto Configuration.

Substituições:

Configuration.clone()

Retornos:

Um clone do objeto Configuration.

contains

public boolean contains(ConfigurationProperty property)

Verifica se a configuração contém a propriedade . Se a propriedade puder ser compartilhada entre clientes, verifique isso Configuration e volte para a seção compartilhada. Se a propriedade tiver aliases, propriedade do sistema ou variável de ambiente definida, verifique-os também.

O valor não é validado.

Parâmetros:

property - do Service Fabric.

Retornos:

true se a propriedade estiver disponível, caso contrário, false.

contains

public boolean contains(String name)

Determina se a propriedade do sistema ou variável de ambiente está definida.

Use contains(ConfigurationProperty<?> property) a sobrecarga para obter configuração explícita ou configuração de ambiente de origem específica.

Isso verifica apenas os valores carregados anteriormente no objeto Configuration. Isso não inspecionará o ambiente para conter o valor.

Parâmetros:

name - Nome da configuração.

Retornos:

True se a configuração existir, caso contrário, false.

get

public String get(String name)

Obtém o valor da propriedade do sistema ou da variável de ambiente. Use get(ConfigurationProperty<T> property) a sobrecarga para obter configuração explícita ou configuração de ambiente de origem específica.

Esse método primeiro verifica os valores carregados anteriormente do ambiente, se a configuração for encontrada lá, ele será retornado. Caso contrário, isso tentará carregar o valor do ambiente.

Parâmetros:

name - Nome da configuração.

Retornos:

Valor da configuração, se encontrado, caso contrário, nulo.

getGlobalConfiguration

public static Configuration getGlobalConfiguration()

Obtém o repositório de configuração global compartilhado por todas as bibliotecas de cliente.

Retornos:

O repositório de configuração global.

put

@Deprecated
public Configuration put(String name, String value)

Preterido

Use ConfigurationBuilder e ConfigurationSource para fornecer todas as propriedades antes de criar a configuração.

Adiciona uma configuração com o valor fornecido.

Isso substituirá o valor de configuração anterior se ele existir.

Parâmetros:

name - Nome da configuração.
value - Valor da configuração.

Retornos:

O objeto Configuration atualizado.

remove

@Deprecated
public String remove(String name)

Preterido

Use ConfigurationBuilder e ConfigurationSource para fornecer todas as propriedades antes de criar a configuração.

Remove a configuração.

Isso retorna o valor da configuração se ela existia anteriormente.

Parâmetros:

name - Nome da configuração.

Retornos:

A configuração se ela existia anteriormente, caso contrário, nula.

Aplica-se a