Share via

Configuration Classe

  • Référence
Paquet:
com.azure.core.util
Artefact Maven:
com.azure:azure-core:1.49.0
  • java.lang.Object
    • com.azure.core.util.Configuration

Implémente

Cloneable

public class Configuration
implements Cloneable

Contient des informations de configuration utilisées lors de la construction des bibliothèques 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));

Récapitulatif du champ

Modificateur et type Champ et description
static final Configuration NONE

Objet no-op Configuration utilisé pour refuser l’utilisation de configurations globales lors de la construction de bibliothèques clientes.
static final String PROPERTY_AZURE_AUTHORITY_HOST

Point de terminaison Azure Active Directory auquel se connecter.
static final String PROPERTY_AZURE_CLIENT_CERTIFICATE_PASSWORD

Mot de passe d’un certificat PFX/PEM utilisé lors de l’authentification du principal de service avec Azure.
static final String PROPERTY_AZURE_CLIENT_CERTIFICATE_PATH

Chemin d’un fichier de certificat PFX/PEM à utiliser lors de l’authentification du principal de service avec Azure.
static final String PROPERTY_AZURE_CLIENT_ID

ID client à utiliser lors de l’authentification du principal de service avec Azure.
static final String PROPERTY_AZURE_CLIENT_SECRET

Clé secrète client à utiliser lors de l’authentification du principal de service avec Azure.
static final String PROPERTY_AZURE_CLOUD

Nom du cloud Azure auquel se connecter.
static final String PROPERTY_AZURE_HTTP_CLIENT_IMPLEMENTATION

Définit le nom de l’implémentation HttpClientProvider qui doit être utilisée pour construire des instances de HttpClient.
static final String PROPERTY_AZURE_HTTP_LOG_DETAIL_LEVEL

Active la journalisation des requêtes/réponses HTTP en définissant un niveau de détail du journal HTTP.
static final String PROPERTY_AZURE_IDENTITY_DISABLE_CP1

Indicateur pour désactiver les fonctionnalités du client CP1 dans les informations d’identification du jeton d’identité Azure.
static final String PROPERTY_AZURE_LOG_LEVEL

Active la journalisation en définissant un niveau de journal.
static final String PROPERTY_AZURE_METRICS_DISABLED

Désactive les métriques.
static final String PROPERTY_AZURE_METRICS_IMPLEMENTATION

Définit le nom de l’implémentation MeterProvider qui doit être utilisée pour construire des instances de Meter.
static final String PROPERTY_AZURE_PASSWORD

Nom d’utilisateur à utiliser lors de l’authentification par nom d’utilisateur/mot de passe avec Azure.
static final String PROPERTY_AZURE_POD_IDENTITY_TOKEN_URL

URL utilisée par Bridge To Kubernetes pour rediriger les appels IMDS dans l’environnement de développement.
static final String PROPERTY_AZURE_REGIONAL_AUTHORITY_NAME

Nom de l’autorité régionale Azure AAD.
static final String PROPERTY_AZURE_REQUEST_CONNECT_TIMEOUT

Définit le délai d’attente par défaut, en millisecondes, pour une demande de connexion à l’hôte distant.
static final String PROPERTY_AZURE_REQUEST_READ_TIMEOUT

Définit l’intervalle de délai d’attente par défaut, en millisecondes, autorisé entre chaque octet lu dans une réponse.
static final String PROPERTY_AZURE_REQUEST_RESPONSE_TIMEOUT

Définit le délai d’attente par défaut, en millisecondes, pour une demande de réception d’une réponse de l’hôte distant.
static final String PROPERTY_AZURE_REQUEST_RETRY_COUNT

Définit le nombre par défaut de tentatives de nouvelle tentative d’une requête, si elle réussit les conditions de nouvelle tentative, avant qu’elle échoue.
static final String PROPERTY_AZURE_REQUEST_WRITE_TIMEOUT

Définit l’intervalle de délai d’expiration par défaut, en millisecondes, autorisé entre chaque octet écrit par une requête.
static final String PROPERTY_AZURE_RESOURCE_GROUP

Nom du groupe de ressources Azure.
static final String PROPERTY_AZURE_SUBSCRIPTION_ID

ID d’abonnement à utiliser lors de la connexion aux ressources Azure.
static final String PROPERTY_AZURE_TELEMETRY_DISABLED

Désactive la collecte de données de télémétrie.
static final String PROPERTY_AZURE_TENANT_ID

ID de locataire pour les ressources Azure.
static final String PROPERTY_AZURE_TRACING_DISABLED

Désactive le suivi.
static final String PROPERTY_AZURE_TRACING_IMPLEMENTATION

Définit le nom de l’implémentation TracerProvider qui doit être utilisée pour construire des instances de Tracer.
static final String PROPERTY_AZURE_USERNAME

Nom d’utilisateur à utiliser lors de l’authentification par nom d’utilisateur/mot de passe avec Azure.
static final String PROPERTY_HTTPS_PROXY

URL du proxy pour les connexions HTTPS.
static final String PROPERTY_HTTP_PROXY

URL du proxy pour les connexions HTTP.
static final String PROPERTY_IDENTITY_ENDPOINT

Point de terminaison auquel se connecter lors de l’utilisation de l’identité de service managé (MSI) Azure Active Directory.
static final String PROPERTY_IDENTITY_HEADER

En-tête lors de la connexion à Azure Active Directory à l’aide de l’identité de service managé (MSI).
static final String PROPERTY_MSI_ENDPOINT

Point de terminaison auquel se connecter lors de l’utilisation de l’identité de service managé (MSI) Azure Active Directory.
static final String PROPERTY_MSI_SECRET

Secret lors de la connexion à Azure Active Directory à l’aide de l’identité de service managé (MSI).
static final String PROPERTY_NO_PROXY

Liste des hôtes ou CIDR via ant utilisant les connexions HTTP/HTTPS de proxy.

Récapitulatif du constructeur

Constructeur Description
Configuration()

Déprécié

Utilisez ConfigurationBuilder et ConfigurationSource qui permettent de fournir toutes les propriétés avant de créer la configuration et de la conserver immuable.

Construit une configuration contenant les constantes de propriétés Azure connues.

Résumé de la méthode

Modificateur et type Méthode et description
T get(ConfigurationProperty<T> property)

Obtient la valeur de la propriété de toutes les sources disponibles dans l’ordre suivant :

  • Configuration explicite à partir de donnée ConfigurationSource par nom de propriété
  • Configuration explicite par alias de propriété dans l’ordre dans lequel ils ont été fournis ConfigurationProperty<T>
  • Configuration explicite par nom de propriété dans la section partagée (si ConfigurationProperty<T> est partagé)
  • Configuration explicite par alias de propriété dans la section partagée (si ConfigurationProperty<T> est partagé)
  • Propriété système (si définie)
  • Variable d’environnement (si définie)
T get(String name, T defaultValue)

Obtient la valeur de la propriété système ou de la variable d’environnement convertie en primitive T donnée à l’aide de la méthode correspondante parse sur ce type.
T get(String name, Function<String,T> converter)

Obtient la valeur de la propriété système ou de la variable d’environnement et la convertit avec .converter
Configuration clone()

Déprécié

Utilisez ConfigurationBuilder et ConfigurationSource pour créer une configuration.

Clone cet objet Configuration.
boolean contains(ConfigurationProperty<?> property)

Vérifie si la configuration contient la propriété .
boolean contains(String name)

Détermine si la propriété système ou la variable d’environnement est définie.
String get(String name)

Obtient la valeur de la propriété système ou de la variable d’environnement.
static Configuration getGlobalConfiguration()

Obtient le magasin de configuration global partagé par toutes les bibliothèques clientes.
Configuration put(String name, String value)

Déprécié

Utilisez ConfigurationBuilder et ConfigurationSource pour fournir toutes les propriétés avant de créer la configuration.

Ajoute une configuration avec la valeur donnée.
String remove(String name)

Déprécié

Utilisez ConfigurationBuilder et ConfigurationSource pour fournir toutes les propriétés avant de créer la configuration.

Supprime la configuration.

Méthodes héritées de java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Détails du champ

NONE

public static final Configuration NONE

Objet no-op Configuration utilisé pour refuser l’utilisation de configurations globales lors de la construction de bibliothèques clientes.

PROPERTY_AZURE_AUTHORITY_HOST

public static final String PROPERTY_AZURE_AUTHORITY_HOST

Point de terminaison Azure Active Directory auquel se connecter.

PROPERTY_AZURE_CLIENT_CERTIFICATE_PASSWORD

public static final String PROPERTY_AZURE_CLIENT_CERTIFICATE_PASSWORD

Mot de passe d’un certificat PFX/PEM utilisé lors de l’authentification du principal de service avec Azure.

PROPERTY_AZURE_CLIENT_CERTIFICATE_PATH

public static final String PROPERTY_AZURE_CLIENT_CERTIFICATE_PATH

Chemin d’un fichier de certificat PFX/PEM à utiliser lors de l’authentification du principal de service avec Azure.

PROPERTY_AZURE_CLIENT_ID

public static final String PROPERTY_AZURE_CLIENT_ID

ID client à utiliser lors de l’authentification du principal de service avec Azure.

PROPERTY_AZURE_CLIENT_SECRET

public static final String PROPERTY_AZURE_CLIENT_SECRET

Clé secrète client à utiliser lors de l’authentification du principal de service avec Azure.

PROPERTY_AZURE_CLOUD

public static final String PROPERTY_AZURE_CLOUD

Nom du cloud Azure auquel se connecter.

PROPERTY_AZURE_HTTP_CLIENT_IMPLEMENTATION

public static final String PROPERTY_AZURE_HTTP_CLIENT_IMPLEMENTATION

Définit le nom de l’implémentation HttpClientProvider qui doit être utilisée pour construire des instances de HttpClient.

Le nom doit être le nom complet de la classe, ex com.azure.core.http.netty.NettyAsyncHttpClientProvider et non NettyAsyncHttpClientProvider, pour lever l’ambiguïté de plusieurs fournisseurs portant le même nom, mais à partir de packages différents.

Si la valeur n’est pas définie ou s’il s’agit d’une chaîne vide, le premier HttpClientProvider résolu par ServiceLoader sera utilisé pour créer un instance de HttpClient. Si la valeur est définie et ne correspond à aucune HttpClientProvider des valeurs résolues par ServiceLoader, un IllegalStateException sera levée lors de la tentative de création d’un instance de HttpClient.

PROPERTY_AZURE_HTTP_LOG_DETAIL_LEVEL

public static final String PROPERTY_AZURE_HTTP_LOG_DETAIL_LEVEL

Active la journalisation des requêtes/réponses HTTP en définissant un niveau de détail du journal HTTP.

PROPERTY_AZURE_IDENTITY_DISABLE_CP1

public static final String PROPERTY_AZURE_IDENTITY_DISABLE_CP1

Indicateur pour désactiver les fonctionnalités du client CP1 dans les informations d’identification du jeton d’identité Azure.

PROPERTY_AZURE_LOG_LEVEL

public static final String PROPERTY_AZURE_LOG_LEVEL

Active la journalisation en définissant un niveau de journal.

PROPERTY_AZURE_METRICS_DISABLED

public static final String PROPERTY_AZURE_METRICS_DISABLED

Désactive les métriques.

PROPERTY_AZURE_METRICS_IMPLEMENTATION

public static final String PROPERTY_AZURE_METRICS_IMPLEMENTATION

Définit le nom de l’implémentation MeterProvider qui doit être utilisée pour construire des instances de Meter.

Le nom doit être le nom complet de la classe, par exemple com.azure.core.tracing.opentelemetry.OpenTelemetryMeterProvider et non OpenTelemetryMeterProvider.

Si la valeur n’est pas définie ou s’il s’agit d’une chaîne vide, le premier MeterProvider résolu par ServiceLoader sera utilisé pour créer un instance de Meter. Si la valeur est définie et ne correspond à aucune MeterProvider des valeurs résolues par ServiceLoader, un IllegalStateException sera levée lors de la tentative de création d’un instance de MeterProvider.

PROPERTY_AZURE_PASSWORD

public static final String PROPERTY_AZURE_PASSWORD

Nom d’utilisateur à utiliser lors de l’authentification par nom d’utilisateur/mot de passe avec Azure.

PROPERTY_AZURE_POD_IDENTITY_TOKEN_URL

public static final String PROPERTY_AZURE_POD_IDENTITY_TOKEN_URL

URL utilisée par Bridge To Kubernetes pour rediriger les appels IMDS dans l’environnement de développement.

PROPERTY_AZURE_REGIONAL_AUTHORITY_NAME

public static final String PROPERTY_AZURE_REGIONAL_AUTHORITY_NAME

Nom de l’autorité régionale Azure AAD.

PROPERTY_AZURE_REQUEST_CONNECT_TIMEOUT

public static final String PROPERTY_AZURE_REQUEST_CONNECT_TIMEOUT

Définit le délai d’attente par défaut, en millisecondes, pour une demande de connexion à l’hôte distant.

Si la valeur configurée est égale ou inférieure à 0, aucun délai d’attente n’est appliqué.

PROPERTY_AZURE_REQUEST_READ_TIMEOUT

public static final String PROPERTY_AZURE_REQUEST_READ_TIMEOUT

Définit l’intervalle de délai d’attente par défaut, en millisecondes, autorisé entre chaque octet lu dans une réponse.

Si la valeur configurée est égale ou inférieure à 0, aucun délai d’attente n’est appliqué.

PROPERTY_AZURE_REQUEST_RESPONSE_TIMEOUT

public static final String PROPERTY_AZURE_REQUEST_RESPONSE_TIMEOUT

Définit le délai d’attente par défaut, en millisecondes, pour une demande de réception d’une réponse de l’hôte distant.

Si la valeur configurée est égale ou inférieure à 0, aucun délai d’attente n’est appliqué.

PROPERTY_AZURE_REQUEST_RETRY_COUNT

public static final String PROPERTY_AZURE_REQUEST_RETRY_COUNT

Définit le nombre par défaut de tentatives de nouvelle tentative d’une requête, si elle réussit les conditions de nouvelle tentative, avant qu’elle échoue.

PROPERTY_AZURE_REQUEST_WRITE_TIMEOUT

public static final String PROPERTY_AZURE_REQUEST_WRITE_TIMEOUT

Définit l’intervalle de délai d’expiration par défaut, en millisecondes, autorisé entre chaque octet écrit par une requête.

Si la valeur configurée est égale ou inférieure à 0, aucun délai d’attente n’est appliqué.

PROPERTY_AZURE_RESOURCE_GROUP

public static final String PROPERTY_AZURE_RESOURCE_GROUP

Nom du groupe de ressources Azure.

PROPERTY_AZURE_SUBSCRIPTION_ID

public static final String PROPERTY_AZURE_SUBSCRIPTION_ID

ID d’abonnement à utiliser lors de la connexion aux ressources Azure.

PROPERTY_AZURE_TELEMETRY_DISABLED

public static final String PROPERTY_AZURE_TELEMETRY_DISABLED

Désactive la collecte de données de télémétrie.

PROPERTY_AZURE_TENANT_ID

public static final String PROPERTY_AZURE_TENANT_ID

ID de locataire pour les ressources Azure.

PROPERTY_AZURE_TRACING_DISABLED

public static final String PROPERTY_AZURE_TRACING_DISABLED

Désactive le suivi.

PROPERTY_AZURE_TRACING_IMPLEMENTATION

public static final String PROPERTY_AZURE_TRACING_IMPLEMENTATION

Définit le nom de l’implémentation TracerProvider qui doit être utilisée pour construire des instances de Tracer.

Le nom doit être le nom complet de la classe, par exemple com.azure.core.tracing.opentelemetry.OpenTelemetryTracerProvider et non OpenTelemetryTracerProvider.

Si la valeur n’est pas définie ou s’il s’agit d’une chaîne vide, le premier TracerProvider résolu par ServiceLoader sera utilisé pour créer un instance de Tracer. Si la valeur est définie et ne correspond à aucune TracerProvider des valeurs résolues par ServiceLoader, un IllegalStateException sera levée lors de la tentative de création d’un instance de TracerProvider.

PROPERTY_AZURE_USERNAME

public static final String PROPERTY_AZURE_USERNAME

Nom d’utilisateur à utiliser lors de l’authentification par nom d’utilisateur/mot de passe avec Azure.

PROPERTY_HTTPS_PROXY

public static final String PROPERTY_HTTPS_PROXY

URL du proxy pour les connexions HTTPS.

PROPERTY_HTTP_PROXY

public static final String PROPERTY_HTTP_PROXY

URL du proxy pour les connexions HTTP.

PROPERTY_IDENTITY_ENDPOINT

public static final String PROPERTY_IDENTITY_ENDPOINT

Point de terminaison auquel se connecter lors de l’utilisation de l’identité de service managé (MSI) Azure Active Directory.

PROPERTY_IDENTITY_HEADER

public static final String PROPERTY_IDENTITY_HEADER

En-tête lors de la connexion à Azure Active Directory à l’aide de l’identité de service managé (MSI).

PROPERTY_MSI_ENDPOINT

public static final String PROPERTY_MSI_ENDPOINT

Point de terminaison auquel se connecter lors de l’utilisation de l’identité de service managé (MSI) Azure Active Directory.

PROPERTY_MSI_SECRET

public static final String PROPERTY_MSI_SECRET

Secret lors de la connexion à Azure Active Directory à l’aide de l’identité de service managé (MSI).

PROPERTY_NO_PROXY

public static final String PROPERTY_NO_PROXY

Liste des hôtes ou CIDR via ant utilisant les connexions HTTP/HTTPS de proxy.

Détails du constructeur

Configuration

@Deprecated
public Configuration()

Déprécié

Utilisez ConfigurationBuilder et ConfigurationSource qui permettent de fournir toutes les propriétés avant de créer la configuration et de la conserver immuable.

Construit une configuration contenant les constantes de propriétés Azure connues.

Détails de la méthode

get

public T get(ConfigurationProperty property)

Obtient la valeur de la propriété de toutes les sources disponibles dans l’ordre suivant :

  • Configuration explicite à partir de donnée ConfigurationSource par nom de propriété
  • Configuration explicite par alias de propriété dans l’ordre dans lequel ils ont été fournis ConfigurationProperty<T>
  • Configuration explicite par nom de propriété dans la section partagée (si ConfigurationProperty<T> est partagé)
  • Configuration explicite par alias de propriété dans la section partagée (si ConfigurationProperty<T> est partagé)
  • Propriété système (si définie)
  • Variable d’environnement (si définie)

La valeur de propriété est convertie en type spécifié. Si la valeur de propriété est manquante et n’est pas obligatoire, la valeur par défaut est retournée.

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:

Valeur de la propriété si elle existe, sinon valeur par défaut de la propriété.

get

public T get(String name, T defaultValue)

Obtient la valeur de la propriété système ou de la variable d’environnement convertie en primitive T donnée à l’aide de la méthode correspondante parse sur ce type. Utilisez la get(ConfigurationProperty<T> property) surcharge pour obtenir une configuration explicite ou une configuration d’environnement à partir d’une source spécifique.

Cette méthode vérifie d’abord les valeurs précédemment chargées à partir de l’environnement. Si la configuration y est trouvée, elle sera retournée. Sinon, cela tentera de charger la valeur à partir de l’environnement.

Si aucune configuration n’est trouvée, le defaultValue est retourné.

Les types suivants sont pris en charge :

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

Parameters:

name - Nom de la configuration.
defaultValue - Valeur à retourner si la configuration est introuvable.

Returns:

Configuration convertie si elle est trouvée, sinon la valeur par défaut est retournée.

get

public T get(String name, Function converter)

Obtient la valeur de la propriété système ou de la variable d’environnement et la convertit avec .converter

Cette méthode vérifie d’abord les valeurs précédemment chargées à partir de l’environnement. Si la configuration y est trouvée, elle sera retournée. Sinon, cela tentera de charger la valeur à partir de l’environnement.

Si aucune configuration n’est trouvée, le converter ne sera pas appelé et null sera retourné.

Parameters:

name - Nom de la configuration.
converter - Convertisseur utilisé pour mapper la configuration à T.

Returns:

Configuration convertie si elle est trouvée, sinon null.

clone

@Deprecated
public Configuration clone()

Déprécié

Utilisez ConfigurationBuilder et ConfigurationSource pour créer une configuration.

Clone cet objet Configuration.

Overrides:

Configuration.clone()

Returns:

Clone de l’objet Configuration.

contains

public boolean contains(ConfigurationProperty property)

Vérifie si la configuration contient la propriété . Si la propriété peut être partagée entre les clients, vérifiez cela Configuration et revenez à la section partagée. Si la propriété a des alias, une propriété système ou une variable d’environnement définie, vérifiez-les également.

La valeur n’est pas validée.

Parameters:

property - Service Fabric.

Returns:

true si la propriété est disponible, false dans le cas contraire.

contains

public boolean contains(String name)

Détermine si la propriété système ou la variable d’environnement est définie.

Utilisez la contains(ConfigurationProperty<?> property) surcharge pour obtenir une configuration explicite ou une configuration d’environnement à partir d’une source spécifique.

Cela vérifie uniquement les valeurs précédemment chargées dans l’objet Configuration. Cela n’inspectera pas l’environnement pour contenir la valeur.

Parameters:

name - Nom de la configuration.

Returns:

True si la configuration existe, sinon false.

get

public String get(String name)

Obtient la valeur de la propriété système ou de la variable d’environnement. Utilisez la get(ConfigurationProperty<T> property) surcharge pour obtenir une configuration explicite ou une configuration d’environnement à partir d’une source spécifique.

Cette méthode vérifie d’abord les valeurs précédemment chargées à partir de l’environnement. Si la configuration y est trouvée, elle sera retournée. Sinon, cela tentera de charger la valeur à partir de l’environnement.

Parameters:

name - Nom de la configuration.

Returns:

Valeur de la configuration si elle est trouvée, sinon null.

getGlobalConfiguration

public static Configuration getGlobalConfiguration()

Obtient le magasin de configuration global partagé par toutes les bibliothèques clientes.

Returns:

Magasin de configuration global.

put

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

Déprécié

Utilisez ConfigurationBuilder et ConfigurationSource pour fournir toutes les propriétés avant de créer la configuration.

Ajoute une configuration avec la valeur donnée.

Cela remplacera la valeur de configuration précédente si elle existait.

Parameters:

name - Nom de la configuration.
value - Valeur de la configuration.

Returns:

Objet Configuration mis à jour.

remove

@Deprecated
public String remove(String name)

Déprécié

Utilisez ConfigurationBuilder et ConfigurationSource pour fournir toutes les propriétés avant de créer la configuration.

Supprime la configuration.

Cette opération retourne la valeur de la configuration si elle existait précédemment.

Parameters:

name - Nom de la configuration.

Returns:

Configuration si elle existait précédemment, sinon null.

S’applique à