Compartir a través de

Configuration Clase

  • Referencia
Paquete:
com.azure.core.util
Artefacto Maven:
com.azure:azure-core:1.49.0
  • java.lang.Object
    • com.azure.core.util.Configuration

Implementaciones

Clonable

public class Configuration
implements Cloneable

Contiene información de configuración que se usa durante la construcción de bibliotecas cliente.

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

Resumen del campo

Modificador y tipo Campo y descripción
static final Configuration NONE

Objeto sin operación Configuration que se usa para no usar configuraciones globales al construir bibliotecas cliente.
static final String PROPERTY_AZURE_AUTHORITY_HOST

Punto de conexión de Azure Active Directory al que se va a conectar.
static final String PROPERTY_AZURE_CLIENT_CERTIFICATE_PASSWORD

Contraseña de un certificado PFX/PEM que se usa al realizar la autenticación de entidad de servicio con Azure.
static final String PROPERTY_AZURE_CLIENT_CERTIFICATE_PATH

Ruta de acceso de un archivo de certificado PFX/PEM que se va a usar al realizar la autenticación de la entidad de servicio con Azure.
static final String PROPERTY_AZURE_CLIENT_ID

Identificador de cliente que se va a usar al realizar la autenticación de entidad de servicio con Azure.
static final String PROPERTY_AZURE_CLIENT_SECRET

Secreto de cliente que se va a usar al realizar la autenticación de entidad de servicio con Azure.
static final String PROPERTY_AZURE_CLOUD

Nombre de la nube de Azure a la que se va a conectar.
static final String PROPERTY_AZURE_HTTP_CLIENT_IMPLEMENTATION

Establece el nombre de la HttpClientProvider implementación que se debe usar para construir instancias de HttpClient.
static final String PROPERTY_AZURE_HTTP_LOG_DETAIL_LEVEL

Habilita el registro de solicitudes y respuestas HTTP estableciendo un nivel de detalle del registro HTTP.
static final String PROPERTY_AZURE_IDENTITY_DISABLE_CP1

Marca para deshabilitar las funcionalidades del cliente cp1 en las credenciales del token de identidad de Azure.
static final String PROPERTY_AZURE_LOG_LEVEL

Habilita el registro estableciendo un nivel de registro.
static final String PROPERTY_AZURE_METRICS_DISABLED

Deshabilita las métricas.
static final String PROPERTY_AZURE_METRICS_IMPLEMENTATION

Establece el nombre de la MeterProvider implementación que se debe usar para construir instancias de Meter.
static final String PROPERTY_AZURE_PASSWORD

Nombre de usuario que se usará al realizar la autenticación de nombre de usuario y contraseña con Azure.
static final String PROPERTY_AZURE_POD_IDENTITY_TOKEN_URL

Dirección URL que usa Bridge To Kubernetes para redirigir las llamadas IMDS en el entorno de desarrollo.
static final String PROPERTY_AZURE_REGIONAL_AUTHORITY_NAME

Nombre de la autoridad regional de Azure AAD.
static final String PROPERTY_AZURE_REQUEST_CONNECT_TIMEOUT

Establece el tiempo de espera predeterminado, en milisegundos, para que una solicitud se conecte al host remoto.
static final String PROPERTY_AZURE_REQUEST_READ_TIMEOUT

Establece el intervalo de tiempo de espera predeterminado, en milisegundos, permitido entre cada lectura de bytes en una respuesta.
static final String PROPERTY_AZURE_REQUEST_RESPONSE_TIMEOUT

Establece el tiempo de espera predeterminado, en milisegundos, para que una solicitud reciba una respuesta del host remoto.
static final String PROPERTY_AZURE_REQUEST_RETRY_COUNT

Establece el número predeterminado de veces que se reintentará una solicitud, si pasa las condiciones de reintento, antes de que se produzca un error.
static final String PROPERTY_AZURE_REQUEST_WRITE_TIMEOUT

Establece el intervalo de tiempo de espera predeterminado, en milisegundos, permitido entre cada byte escrito por una solicitud.
static final String PROPERTY_AZURE_RESOURCE_GROUP

Nombre del grupo de recursos de Azure.
static final String PROPERTY_AZURE_SUBSCRIPTION_ID

Identificador de suscripción que se va a usar al conectarse a recursos de Azure.
static final String PROPERTY_AZURE_TELEMETRY_DISABLED

Deshabilita la recopilación de telemetría.
static final String PROPERTY_AZURE_TENANT_ID

Identificador de inquilino para los recursos de Azure.
static final String PROPERTY_AZURE_TRACING_DISABLED

Deshabilita el seguimiento.
static final String PROPERTY_AZURE_TRACING_IMPLEMENTATION

Establece el nombre de la TracerProvider implementación que se debe usar para construir instancias de Tracer.
static final String PROPERTY_AZURE_USERNAME

Nombre de usuario que se usará al realizar la autenticación de nombre de usuario y contraseña con Azure.
static final String PROPERTY_HTTPS_PROXY

Dirección URL del proxy para las conexiones HTTPS.
static final String PROPERTY_HTTP_PROXY

Dirección URL del proxy para las conexiones HTTP.
static final String PROPERTY_IDENTITY_ENDPOINT

Punto de conexión al que conectarse al usar la identidad de servicio administrada (MSI) de Azure Active Directory.
static final String PROPERTY_IDENTITY_HEADER

Encabezado al conectarse a Azure Active Directory mediante la identidad de servicio administrada (MSI).
static final String PROPERTY_MSI_ENDPOINT

Punto de conexión al que conectarse al usar la identidad de servicio administrada (MSI) de Azure Active Directory.
static final String PROPERTY_MSI_SECRET

Secreto al conectarse a Azure Active Directory mediante la identidad de servicio administrada (MSI).
static final String PROPERTY_NO_PROXY

Una lista de hosts o CIDR para no usar conexiones HTTP/HTTPS de proxy a través de .

Resumen del constructor

Constructor Description
Configuration()

Obsoleto

Use ConfigurationBuilder y ConfigurationSource que permitan proporcionar todas las propiedades antes de crear la configuración y mantenerlo inmutable.

Construye una configuración que contiene las constantes conocidas de propiedades de Azure.

Resumen del método

Modificador y tipo Método y descripción
T get(ConfigurationProperty<T> property)

Obtiene el valor de propiedad de todos los orígenes disponibles en el orden siguiente:

  • Configuración explícita de especificada ConfigurationSource por nombre de propiedad
  • Configuración explícita por alias de propiedad en el orden en que se proporcionaron ConfigurationProperty<T>
  • Configuración explícita por nombre de propiedad en la sección compartida (si ConfigurationProperty<T> se comparte)
  • Configuración explícita por alias de propiedad en la sección compartida (si ConfigurationProperty<T> se comparte)
  • Propiedad del sistema (si se establece)
  • Variable de entorno (si se establece)
T get(String name, T defaultValue)

Obtiene el valor de la propiedad del sistema o la variable de entorno convertidas en primitivos T dados mediante el método correspondiente parse en este tipo.
T get(String name, Function<String,T> converter)

Obtiene el valor de la propiedad del sistema o la variable de entorno y la convierte con .converter
Configuration clone()

Obsoleto

Use ConfigurationBuilder y ConfigurationSource para crear la configuración.

Clona este objeto Configuration.
boolean contains(ConfigurationProperty<?> property)

Comprueba si la configuración contiene la propiedad .
boolean contains(String name)

Determina si se define la propiedad del sistema o la variable de entorno.
String get(String name)

Obtiene el valor de la propiedad del sistema o la variable de entorno.
static Configuration getGlobalConfiguration()

Obtiene el almacén de configuración global compartido por todas las bibliotecas cliente.
Configuration put(String name, String value)

Obsoleto

Use ConfigurationBuilder y ConfigurationSource para proporcionar todas las propiedades antes de crear la configuración.

Agrega una configuración con el valor especificado.
String remove(String name)

Obsoleto

Use ConfigurationBuilder y ConfigurationSource para proporcionar todas las propiedades antes de crear la configuración.

Quita la configuración.

Métodos heredados de java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Detalles del campo

NONE

public static final Configuration NONE

Objeto sin operación Configuration que se usa para no usar configuraciones globales al construir bibliotecas cliente.

PROPERTY_AZURE_AUTHORITY_HOST

public static final String PROPERTY_AZURE_AUTHORITY_HOST

Punto de conexión de Azure Active Directory al que se va a conectar.

PROPERTY_AZURE_CLIENT_CERTIFICATE_PASSWORD

public static final String PROPERTY_AZURE_CLIENT_CERTIFICATE_PASSWORD

Contraseña de un certificado PFX/PEM que se usa al realizar la autenticación de entidad de servicio con Azure.

PROPERTY_AZURE_CLIENT_CERTIFICATE_PATH

public static final String PROPERTY_AZURE_CLIENT_CERTIFICATE_PATH

Ruta de acceso de un archivo de certificado PFX/PEM que se va a usar al realizar la autenticación de la entidad de servicio con Azure.

PROPERTY_AZURE_CLIENT_ID

public static final String PROPERTY_AZURE_CLIENT_ID

Identificador de cliente que se va a usar al realizar la autenticación de entidad de servicio con Azure.

PROPERTY_AZURE_CLIENT_SECRET

public static final String PROPERTY_AZURE_CLIENT_SECRET

Secreto de cliente que se va a usar al realizar la autenticación de entidad de servicio con Azure.

PROPERTY_AZURE_CLOUD

public static final String PROPERTY_AZURE_CLOUD

Nombre de la nube de Azure a la que se va a conectar.

PROPERTY_AZURE_HTTP_CLIENT_IMPLEMENTATION

public static final String PROPERTY_AZURE_HTTP_CLIENT_IMPLEMENTATION

Establece el nombre de la HttpClientProvider implementación que se debe usar para construir instancias de HttpClient.

El nombre debe ser el nombre de clase completo, por ejemplo com.azure.core.http.netty.NettyAsyncHttpClientProvider , y no NettyAsyncHttpClientProvider, para desambiguar varios proveedores con el mismo nombre, pero de paquetes diferentes.

Si el valor no se establece o es una cadena vacía, la primera HttpClientProvider resuelta por ServiceLoader se usará para crear una instancia de HttpClient. Si el valor se establece y no coincide con ningún HttpClientProvider resuelto por ServiceLoader , se iniciará al IllegalStateException intentar crear una instancia de HttpClient.

PROPERTY_AZURE_HTTP_LOG_DETAIL_LEVEL

public static final String PROPERTY_AZURE_HTTP_LOG_DETAIL_LEVEL

Habilita el registro de solicitudes y respuestas HTTP estableciendo un nivel de detalle del registro HTTP.

PROPERTY_AZURE_IDENTITY_DISABLE_CP1

public static final String PROPERTY_AZURE_IDENTITY_DISABLE_CP1

Marca para deshabilitar las funcionalidades del cliente cp1 en las credenciales del token de identidad de Azure.

PROPERTY_AZURE_LOG_LEVEL

public static final String PROPERTY_AZURE_LOG_LEVEL

Habilita el registro estableciendo un nivel de registro.

PROPERTY_AZURE_METRICS_DISABLED

public static final String PROPERTY_AZURE_METRICS_DISABLED

Deshabilita las métricas.

PROPERTY_AZURE_METRICS_IMPLEMENTATION

public static final String PROPERTY_AZURE_METRICS_IMPLEMENTATION

Establece el nombre de la MeterProvider implementación que se debe usar para construir instancias de Meter.

El nombre debe ser el nombre de clase completo, por ejemplo com.azure.core.tracing.opentelemetry.OpenTelemetryMeterProvider , y no OpenTelemetryMeterProvider.

Si el valor no se establece o es una cadena vacía, la primera MeterProvider resuelta por ServiceLoader se usará para crear una instancia de Meter. Si el valor se establece y no coincide con ningún MeterProvider resuelto por ServiceLoader , se iniciará al IllegalStateException intentar crear una instancia de MeterProvider.

PROPERTY_AZURE_PASSWORD

public static final String PROPERTY_AZURE_PASSWORD

Nombre de usuario que se usará al realizar la autenticación de nombre de usuario y contraseña con Azure.

PROPERTY_AZURE_POD_IDENTITY_TOKEN_URL

public static final String PROPERTY_AZURE_POD_IDENTITY_TOKEN_URL

Dirección URL que usa Bridge To Kubernetes para redirigir las llamadas IMDS en el entorno de desarrollo.

PROPERTY_AZURE_REGIONAL_AUTHORITY_NAME

public static final String PROPERTY_AZURE_REGIONAL_AUTHORITY_NAME

Nombre de la autoridad regional de Azure AAD.

PROPERTY_AZURE_REQUEST_CONNECT_TIMEOUT

public static final String PROPERTY_AZURE_REQUEST_CONNECT_TIMEOUT

Establece el tiempo de espera predeterminado, en milisegundos, para que una solicitud se conecte al host remoto.

Si el valor configurado es igual o menor que 0, no se aplicará ningún tiempo de espera.

PROPERTY_AZURE_REQUEST_READ_TIMEOUT

public static final String PROPERTY_AZURE_REQUEST_READ_TIMEOUT

Establece el intervalo de tiempo de espera predeterminado, en milisegundos, permitido entre cada lectura de bytes en una respuesta.

Si el valor configurado es igual o menor que 0, no se aplicará ningún tiempo de espera.

PROPERTY_AZURE_REQUEST_RESPONSE_TIMEOUT

public static final String PROPERTY_AZURE_REQUEST_RESPONSE_TIMEOUT

Establece el tiempo de espera predeterminado, en milisegundos, para que una solicitud reciba una respuesta del host remoto.

Si el valor configurado es igual o menor que 0, no se aplicará ningún tiempo de espera.

PROPERTY_AZURE_REQUEST_RETRY_COUNT

public static final String PROPERTY_AZURE_REQUEST_RETRY_COUNT

Establece el número predeterminado de veces que se reintentará una solicitud, si pasa las condiciones de reintento, antes de que se produzca un error.

PROPERTY_AZURE_REQUEST_WRITE_TIMEOUT

public static final String PROPERTY_AZURE_REQUEST_WRITE_TIMEOUT

Establece el intervalo de tiempo de espera predeterminado, en milisegundos, permitido entre cada byte escrito por una solicitud.

Si el valor configurado es igual o menor que 0, no se aplicará ningún tiempo de espera.

PROPERTY_AZURE_RESOURCE_GROUP

public static final String PROPERTY_AZURE_RESOURCE_GROUP

Nombre del grupo de recursos de Azure.

PROPERTY_AZURE_SUBSCRIPTION_ID

public static final String PROPERTY_AZURE_SUBSCRIPTION_ID

Identificador de suscripción que se va a usar al conectarse a recursos de Azure.

PROPERTY_AZURE_TELEMETRY_DISABLED

public static final String PROPERTY_AZURE_TELEMETRY_DISABLED

Deshabilita la recopilación de telemetría.

PROPERTY_AZURE_TENANT_ID

public static final String PROPERTY_AZURE_TENANT_ID

Identificador de inquilino para los recursos de Azure.

PROPERTY_AZURE_TRACING_DISABLED

public static final String PROPERTY_AZURE_TRACING_DISABLED

Deshabilita el seguimiento.

PROPERTY_AZURE_TRACING_IMPLEMENTATION

public static final String PROPERTY_AZURE_TRACING_IMPLEMENTATION

Establece el nombre de la TracerProvider implementación que se debe usar para construir instancias de Tracer.

El nombre debe ser el nombre de clase completo, por ejemplo com.azure.core.tracing.opentelemetry.OpenTelemetryTracerProvider , y no OpenTelemetryTracerProvider.

Si el valor no se establece o es una cadena vacía, la primera TracerProvider resuelta por ServiceLoader se usará para crear una instancia de Tracer. Si el valor se establece y no coincide con ningún TracerProvider resuelto por ServiceLoader , se iniciará al IllegalStateException intentar crear una instancia de TracerProvider.

PROPERTY_AZURE_USERNAME

public static final String PROPERTY_AZURE_USERNAME

Nombre de usuario que se usará al realizar la autenticación de nombre de usuario y contraseña con Azure.

PROPERTY_HTTPS_PROXY

public static final String PROPERTY_HTTPS_PROXY

Dirección URL del proxy para las conexiones HTTPS.

PROPERTY_HTTP_PROXY

public static final String PROPERTY_HTTP_PROXY

Dirección URL del proxy para las conexiones HTTP.

PROPERTY_IDENTITY_ENDPOINT

public static final String PROPERTY_IDENTITY_ENDPOINT

Punto de conexión al que conectarse al usar la identidad de servicio administrada (MSI) de Azure Active Directory.

PROPERTY_IDENTITY_HEADER

public static final String PROPERTY_IDENTITY_HEADER

Encabezado al conectarse a Azure Active Directory mediante la identidad de servicio administrada (MSI).

PROPERTY_MSI_ENDPOINT

public static final String PROPERTY_MSI_ENDPOINT

Punto de conexión al que conectarse al usar la identidad de servicio administrada (MSI) de Azure Active Directory.

PROPERTY_MSI_SECRET

public static final String PROPERTY_MSI_SECRET

Secreto al conectarse a Azure Active Directory mediante la identidad de servicio administrada (MSI).

PROPERTY_NO_PROXY

public static final String PROPERTY_NO_PROXY

Una lista de hosts o CIDR para no usar conexiones HTTP/HTTPS de proxy a través de .

Detalles del constructor

Configuration

@Deprecated
public Configuration()

Obsoleto

Use ConfigurationBuilder y ConfigurationSource que permitan proporcionar todas las propiedades antes de crear la configuración y mantenerlo inmutable.

Construye una configuración que contiene las constantes conocidas de propiedades de Azure.

Detalles del método

get

public T get(ConfigurationProperty property)

Obtiene el valor de propiedad de todos los orígenes disponibles en el orden siguiente:

  • Configuración explícita de especificada ConfigurationSource por nombre de propiedad
  • Configuración explícita por alias de propiedad en el orden en que se proporcionaron ConfigurationProperty<T>
  • Configuración explícita por nombre de propiedad en la sección compartida (si ConfigurationProperty<T> se comparte)
  • Configuración explícita por alias de propiedad en la sección compartida (si ConfigurationProperty<T> se comparte)
  • Propiedad del sistema (si se establece)
  • Variable de entorno (si se establece)

El valor de propiedad se convierte en el tipo especificado. Si falta el valor de propiedad y no es necesario, se devuelve el valor predeterminado.

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

Parameters:

property - Service Fabric.

Returns:

Valor de la propiedad si existe; de lo contrario, el valor predeterminado de la propiedad.

get

public T get(String name, T defaultValue)

Obtiene el valor de la propiedad del sistema o la variable de entorno convertidas en primitivos T dados mediante el método correspondiente parse en este tipo. Use get(ConfigurationProperty<T> property) overload para obtener la configuración explícita o la configuración del entorno de un origen específico.

En primer lugar, este método comprueba los valores cargados anteriormente desde el entorno, si la configuración se encuentra allí, se devolverá. De lo contrario, intentará cargar el valor del entorno.

Si no se encuentra ninguna configuración, se devuelve .defaultValue

Se admiten los tipos siguientes:

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

Parameters:

name - Nombre de la configuración.
defaultValue - Valor que se va a devolver si no se encuentra la configuración.

Returns:

Si se encuentra la configuración convertida, se devuelve el valor predeterminado.

get

public T get(String name, Function converter)

Obtiene el valor de la propiedad del sistema o la variable de entorno y la convierte con .converter

En primer lugar, este método comprueba los valores cargados anteriormente desde el entorno, si la configuración se encuentra allí, se devolverá. De lo contrario, intentará cargar el valor del entorno.

Si no se encuentra converter ninguna configuración, no se llamará a y se devolverá null.

Parameters:

name - Nombre de la configuración.
converter - Convertidor usado para asignar la configuración a T.

Returns:

Configuración convertida si se encuentra; en caso contrario, null.

clone

@Deprecated
public Configuration clone()

Obsoleto

Use ConfigurationBuilder y ConfigurationSource para crear la configuración.

Clona este objeto Configuration.

Overrides:

Configuration.clone()

Returns:

Clon del objeto Configuration.

contains

public boolean contains(ConfigurationProperty property)

Comprueba si la configuración contiene la propiedad . Si la propiedad se puede compartir entre clientes, comprueba esto Configuration y vuelve a la sección compartida. Si la propiedad tiene alias, propiedad del sistema o variable de entorno definida, también las comprueba.

El valor no se valida.

Parameters:

property - Service Fabric.

Returns:

True si la propiedad está disponible; de lo contrario, false.

contains

public boolean contains(String name)

Determina si se define la propiedad del sistema o la variable de entorno.

Use contains(ConfigurationProperty<?> property) overload para obtener la configuración explícita o la configuración del entorno de un origen específico.

Esto solo comprueba los valores cargados anteriormente en el objeto Configuration; esto no inspeccionará el entorno para que contenga el valor.

Parameters:

name - Nombre de la configuración.

Returns:

True si la configuración existe; de lo contrario, false.

get

public String get(String name)

Obtiene el valor de la propiedad del sistema o la variable de entorno. Use get(ConfigurationProperty<T> property) overload para obtener la configuración explícita o la configuración del entorno de un origen específico.

En primer lugar, este método comprueba los valores cargados anteriormente desde el entorno, si la configuración se encuentra allí, se devolverá. De lo contrario, intentará cargar el valor del entorno.

Parameters:

name - Nombre de la configuración.

Returns:

Valor de la configuración si se encuentra; en caso contrario, null.

getGlobalConfiguration

public static Configuration getGlobalConfiguration()

Obtiene el almacén de configuración global compartido por todas las bibliotecas cliente.

Returns:

Almacén de configuración global.

put

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

Obsoleto

Use ConfigurationBuilder y ConfigurationSource para proporcionar todas las propiedades antes de crear la configuración.

Agrega una configuración con el valor especificado.

Esto sobrescribirá el valor de configuración anterior si existía.

Parameters:

name - Nombre de la configuración.
value - Valor de la configuración.

Returns:

Objeto Configuration actualizado.

remove

@Deprecated
public String remove(String name)

Obsoleto

Use ConfigurationBuilder y ConfigurationSource para proporcionar todas las propiedades antes de crear la configuración.

Quita la configuración.

Esto devuelve el valor de la configuración si existía anteriormente.

Parameters:

name - Nombre de la configuración.

Returns:

Configuración si existía anteriormente; en caso contrario, null.

Se aplica a