Configuration Class

public static final Configuration NONE

No-op Configuration object used to opt out of using global configurations when constructing client libraries.

public static final String PROPERTY_AZURE_AUTHORITY_HOST

The Azure Active Directory endpoint to connect to.

public static final String PROPERTY_AZURE_CLIENT_CERTIFICATE_PASSWORD

Password for a PFX/PEM certificate used when performing service principal authentication with Azure.

public static final String PROPERTY_AZURE_CLIENT_CERTIFICATE_PATH

Path of a PFX/PEM certificate file to use when performing service principal authentication with Azure.

public static final String PROPERTY_AZURE_CLIENT_ID

Client id to use when performing service principal authentication with Azure.

public static final String PROPERTY_AZURE_CLIENT_SECRET

Client secret to use when performing service principal authentication with Azure.

public static final String PROPERTY_AZURE_CLIENT_SEND_CERTIFICATE_CHAIN

Flag to enable sending the certificate chain in x5c header to support subject name / issuer based authentication.

public static final String PROPERTY_AZURE_CLOUD

Name of the Azure cloud to connect to.

public static final String PROPERTY_AZURE_HTTP_CLIENT_IMPLEMENTATION

Sets the name of the HttpClientProvider implementation that should be used to construct instances of HttpClient.

The name must be the full class name, ex com.azure.core.http.netty.NettyAsyncHttpClientProvider and not NettyAsyncHttpClientProvider, to disambiguate multiple providers with the same name but from different packages.

If the value isn't set or is an empty string the first HttpClientProvider resolved by ServiceLoader will be used to create an instance of HttpClient. If the value is set and doesn't match any HttpClientProvider resolved by ServiceLoader an IllegalStateException will be thrown when attempting to create an instance of HttpClient.

public static final String PROPERTY_AZURE_HTTP_LOG_DETAIL_LEVEL

Enables HTTP request/response logging by setting an HTTP log detail level.

public static final String PROPERTY_AZURE_IDENTITY_DISABLE_CP1

Flag to disable the CP1 client capabilities in Azure Identity Token credentials.

public static final String PROPERTY_AZURE_LOG_LEVEL

Enables logging by setting a log level.

public static final String PROPERTY_AZURE_METRICS_DISABLED

Disables metrics.

public static final String PROPERTY_AZURE_METRICS_IMPLEMENTATION

Sets the name of the MeterProvider implementation that should be used to construct instances of Meter.

The name must be the full class name, e.g. com.azure.core.tracing.opentelemetry.OpenTelemetryMeterProvider and not OpenTelemetryMeterProvider.

If the value isn't set or is an empty string the first MeterProvider resolved by ServiceLoader will be used to create an instance of Meter. If the value is set and doesn't match any MeterProvider resolved by ServiceLoader an IllegalStateException will be thrown when attempting to create an instance of MeterProvider.

public static final String PROPERTY_AZURE_PASSWORD

Username to use when performing username/password authentication with Azure.

public static final String PROPERTY_AZURE_POD_IDENTITY_TOKEN_URL

URL used by Bridge To Kubernetes to redirect IMDS calls in the development environment.

public static final String PROPERTY_AZURE_REGIONAL_AUTHORITY_NAME

Name of Azure AAD regional authority.

public static final String PROPERTY_AZURE_REQUEST_CONNECT_TIMEOUT

Sets the default timeout, in milliseconds, for a request to connect to the remote host.

If the configured value is equal to or less than 0 no timeout will be applied.

public static final String PROPERTY_AZURE_REQUEST_READ_TIMEOUT

Sets the default timeout interval, in milliseconds, allowed between each byte read in a response.

If the configured value is equal to or less than 0 no timeout will be applied.

public static final String PROPERTY_AZURE_REQUEST_RESPONSE_TIMEOUT

Sets the default timeout, in milliseconds, for a request to receive a response from the remote host.

If the configured value is equal to or less than 0 no timeout will be applied.

public static final String PROPERTY_AZURE_REQUEST_RETRY_COUNT

Sets the default number of times a request will be retried, if it passes the conditions for retrying, before it fails.

public static final String PROPERTY_AZURE_REQUEST_WRITE_TIMEOUT

Sets the default timeout interval, in milliseconds, allowed between each byte written by a request.

If the configured value is equal to or less than 0 no timeout will be applied.

public static final String PROPERTY_AZURE_RESOURCE_GROUP

Name of the Azure resource group.

public static final String PROPERTY_AZURE_SUBSCRIPTION_ID

Subscription id to use when connecting to Azure resources.

public static final String PROPERTY_AZURE_TELEMETRY_DISABLED

Disables telemetry collection.

public static final String PROPERTY_AZURE_TENANT_ID

Tenant id for the Azure resources.

public static final String PROPERTY_AZURE_TRACING_DISABLED

Disables tracing.

public static final String PROPERTY_AZURE_TRACING_IMPLEMENTATION

Sets the name of the TracerProvider implementation that should be used to construct instances of Tracer.

The name must be the full class name, e.g. com.azure.core.tracing.opentelemetry.OpenTelemetryTracerProvider and not OpenTelemetryTracerProvider.

If the value isn't set or is an empty string the first TracerProvider resolved by ServiceLoader will be used to create an instance of Tracer. If the value is set and doesn't match any TracerProvider resolved by ServiceLoader an IllegalStateException will be thrown when attempting to create an instance of TracerProvider.

public static final String PROPERTY_AZURE_USERNAME

Username to use when performing username/password authentication with Azure.

public static final String PROPERTY_HTTPS_PROXY

URL of the proxy for HTTPS connections.

public static final String PROPERTY_HTTP_PROXY

URL of the proxy for HTTP connections.

public static final String PROPERTY_IDENTITY_ENDPOINT

Endpoint to connect to when using Azure Active Directory managed service identity (MSI).

public static final String PROPERTY_IDENTITY_HEADER

Header when connecting to Azure Active Directory using managed service identity (MSI).

public static final String PROPERTY_MSI_ENDPOINT

Endpoint to connect to when using Azure Active Directory managed service identity (MSI).

public static final String PROPERTY_MSI_SECRET

Secret when connecting to Azure Active Directory using managed service identity (MSI).

public static final String PROPERTY_NO_PROXY

A list of hosts or CIDR to not use proxy HTTP/HTTPS connections through.

@Deprecated
public Configuration()

Deprecated

Constructs a configuration containing the known Azure properties constants.

public T get(ConfigurationProperty property)

Gets property value from all available sources in the following order:

• Explicit configuration from given ConfigurationSource by property name
• Explicit configuration by property aliases in the order they were provided in ConfigurationProperty<T>
• Explicit configuration by property name in the shared section (if ConfigurationProperty<T> is shared)
• Explicit configuration by property aliases in the shared section (if ConfigurationProperty<T> is shared)
• System property (if set)
• Environment variable (if set)

Property value is converted to specified type. If property value is missing and not required, default value is returned.

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:

Returns:

public T get(String name, T defaultValue)

Gets the value of system property or environment variable converted to given primitive T using corresponding parse method on this type. Use get(ConfigurationProperty<T> property) overload to get explicit configuration or environment configuration from specific source.

This method first checks the values previously loaded from the environment, if the configuration is found there it will be returned. Otherwise, this will attempt to load the value from the environment.

If no configuration is found, the defaultValue is returned.

Following types are supported:

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

Parameters:

Returns:

public T get(String name, Function converter)

Gets the value of system property or environment variable and converts it with the converter.

This method first checks the values previously loaded from the environment, if the configuration is found there it will be returned. Otherwise, this will attempt to load the value from the environment.

If no configuration is found the converter won't be called and null will be returned.

Parameters:

Returns:

@Deprecated
public Configuration clone()

Deprecated

Clones this Configuration object.

Overrides:

Returns:

public boolean contains(ConfigurationProperty property)

Checks if configuration contains the property. If property can be shared between clients, checks this Configuration and falls back to shared section. If property has aliases, system property or environment variable defined, checks them as well.

Value is not validated.

Parameters:

Returns:

public boolean contains(String name)

Determines if the system property or environment variable is defined.

Use contains(ConfigurationProperty<?> property) overload to get explicit configuration or environment configuration from specific source.

This only checks against values previously loaded into the Configuration object, this won't inspect the environment for containing the value.

Parameters:

Returns:

public String get(String name)

Gets the value of system property or environment variable. Use get(ConfigurationProperty<T> property) overload to get explicit configuration or environment configuration from specific source.

This method first checks the values previously loaded from the environment, if the configuration is found there it will be returned. Otherwise, this will attempt to load the value from the environment.

Parameters:

Returns:

public static Configuration getGlobalConfiguration()

Gets the global configuration store shared by all client libraries.

Returns:

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

Deprecated

Adds a configuration with the given value.

This will overwrite the previous configuration value if it existed.

Parameters:

Returns:

@Deprecated
public String remove(String name)

Deprecated

Removes the configuration.

This returns the value of the configuration if it previously existed.

Parameters:

Returns: