Configuration (Azure SDK for Java Reference Documentation)

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

All Implemented Interfaces:

Cloneable
```
public class Configuration
extends Object
implements Cloneable
```
Contains configuration information that is used during construction of client libraries.

Field Summary

Fields
Modifier and Type	Field and Description
`static Configuration`	`NONE` No-op `Configuration` object used to opt out of using global configurations when constructing client libraries.
`static String`	`PROPERTY_AZURE_AUTHORITY_HOST` The Azure Active Directory endpoint to connect to.
`static String`	`PROPERTY_AZURE_CLIENT_CERTIFICATE_PATH` Path of a PEM certificate file to use when performing service principal authentication with Azure.
`static String`	`PROPERTY_AZURE_CLIENT_ID` Client id to use when performing service principal authentication with Azure.
`static String`	`PROPERTY_AZURE_CLIENT_SECRET` Client secret to use when performing service principal authentication with Azure.
`static String`	`PROPERTY_AZURE_CLOUD` Name of the Azure cloud to connect to.
`static String`	`PROPERTY_AZURE_LOG_LEVEL` Enables logging by setting a log level.
`static String`	`PROPERTY_AZURE_PASSWORD` Username to use when performing username/password authentication with Azure.
`static String`	`PROPERTY_AZURE_RESOURCE_GROUP` Name of the Azure resource group.
`static String`	`PROPERTY_AZURE_SUBSCRIPTION_ID` Subscription id to use when connecting to Azure resources.
`static String`	`PROPERTY_AZURE_TELEMETRY_DISABLED` Disables telemetry collection.
`static String`	`PROPERTY_AZURE_TENANT_ID` Tenant id for the Azure resources.
`static String`	`PROPERTY_AZURE_TRACING_DISABLED` Disables tracing.
`static String`	`PROPERTY_AZURE_USERNAME` Username to use when performing username/password authentication with Azure.
`static String`	`PROPERTY_HTTP_PROXY` URL of the proxy for HTTP connections.
`static String`	`PROPERTY_HTTPS_PROXY` URL of the proxy for HTTPS connections.
`static String`	`PROPERTY_IDENTITY_ENDPOINT` Endpoint to connect to when using Azure Active Directory managed service identity (MSI).
`static String`	`PROPERTY_IDENTITY_HEADER` Header when connecting to Azure Active Directory using managed service identity (MSI).
`static String`	`PROPERTY_MSI_ENDPOINT` Endpoint to connect to when using Azure Active Directory managed service identity (MSI).
`static String`	`PROPERTY_MSI_SECRET` Secret when connecting to Azure Active Directory using managed service identity (MSI).
`static String`	`PROPERTY_NO_PROXY` A list of hosts or CIDR to not use proxy HTTP/HTTPS connections through.

Constructor Summary

Constructors
Constructor and Description

Configuration()
Constructs a configuration containing the known Azure properties constants.

Constructors
Constructor and Description
`Configuration()` Constructs a configuration containing the known Azure properties constants.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Configuration`	`clone()`
`boolean`	`contains(String name)` Determines if the configuration exists.
`String`	`get(String name)` Gets the value of the configuration.
`<T> T`	`get(String name, Function<String,T> converter)` Gets the converted value of the configuration.
`<T> T`	`get(String name, T defaultValue)` Gets the value of the configuration converted to `T`.
`static Configuration`	`getGlobalConfiguration()` Gets the global configuration store shared by all client libraries.
`Configuration`	`put(String name, String value)` Adds a configuration with the given value.
`String`	`remove(String name)` Removes the configuration.

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - PROPERTY_HTTP_PROXY
```
public static final String PROPERTY_HTTP_PROXY
```
    URL of the proxy for HTTP connections.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_HTTPS_PROXY
```
public static final String PROPERTY_HTTPS_PROXY
```
    URL of the proxy for HTTPS connections.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_IDENTITY_ENDPOINT
```
public static final String PROPERTY_IDENTITY_ENDPOINT
```
    Endpoint to connect to when using Azure Active Directory managed service identity (MSI).
    
    See Also:
    
    Constant Field Values
  - PROPERTY_IDENTITY_HEADER
```
public static final String PROPERTY_IDENTITY_HEADER
```
    Header when connecting to Azure Active Directory using managed service identity (MSI).
    
    See Also:
    
    Constant Field Values
  - PROPERTY_NO_PROXY
```
public static final String PROPERTY_NO_PROXY
```
    A list of hosts or CIDR to not use proxy HTTP/HTTPS connections through.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_MSI_ENDPOINT
```
public static final String PROPERTY_MSI_ENDPOINT
```
    Endpoint to connect to when using Azure Active Directory managed service identity (MSI).
    
    See Also:
    
    Constant Field Values
  - PROPERTY_MSI_SECRET
```
public static final String PROPERTY_MSI_SECRET
```
    Secret when connecting to Azure Active Directory using managed service identity (MSI).
    
    See Also:
    
    Constant Field Values
  - PROPERTY_AZURE_SUBSCRIPTION_ID
```
public static final String PROPERTY_AZURE_SUBSCRIPTION_ID
```
    Subscription id to use when connecting to Azure resources.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_AZURE_USERNAME
```
public static final String PROPERTY_AZURE_USERNAME
```
    Username to use when performing username/password authentication with Azure.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_AZURE_PASSWORD
```
public static final String PROPERTY_AZURE_PASSWORD
```
    Username to use when performing username/password authentication with Azure.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_AZURE_CLIENT_ID
```
public static final String PROPERTY_AZURE_CLIENT_ID
```
    Client id to use when performing service principal authentication with Azure.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_AZURE_CLIENT_SECRET
```
public static final String PROPERTY_AZURE_CLIENT_SECRET
```
    Client secret to use when performing service principal authentication with Azure.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_AZURE_TENANT_ID
```
public static final String PROPERTY_AZURE_TENANT_ID
```
    Tenant id for the Azure resources.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_AZURE_CLIENT_CERTIFICATE_PATH
```
public static final String PROPERTY_AZURE_CLIENT_CERTIFICATE_PATH
```
    Path of a PEM certificate file to use when performing service principal authentication with Azure.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_AZURE_RESOURCE_GROUP
```
public static final String PROPERTY_AZURE_RESOURCE_GROUP
```
    Name of the Azure resource group.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_AZURE_CLOUD
```
public static final String PROPERTY_AZURE_CLOUD
```
    Name of the Azure cloud to connect to.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_AZURE_AUTHORITY_HOST
```
public static final String PROPERTY_AZURE_AUTHORITY_HOST
```
    The Azure Active Directory endpoint to connect to.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_AZURE_TELEMETRY_DISABLED
```
public static final String PROPERTY_AZURE_TELEMETRY_DISABLED
```
    Disables telemetry collection.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_AZURE_LOG_LEVEL
```
public static final String PROPERTY_AZURE_LOG_LEVEL
```
    Enables logging by setting a log level.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_AZURE_TRACING_DISABLED
```
public static final String PROPERTY_AZURE_TRACING_DISABLED
```
    Disables tracing.
    
    See Also:
    
    Constant Field Values
  - NONE
```
public static final Configuration NONE
```
    No-op Configuration object used to opt out of using global configurations when constructing client libraries.
- Constructor Detail
  - Configuration
```
public Configuration()
```
    Constructs a configuration containing the known Azure properties constants.
- Method Detail
  - getGlobalConfiguration
```
public static Configuration getGlobalConfiguration()
```
    Gets the global configuration store shared by all client libraries.
    
    Returns:
    
    The global configuration store.
  - get
```
public String get(String name)
```
    Gets the value of the configuration.
    
    Parameters:
    
    name - Name of the configuration.
    
    Returns:
    
    Value of the configuration if found, otherwise null.
  - get
```
public <T> T get(String name,
                 T defaultValue)
```
    Gets the value of the configuration converted to T. If no configuration is found, the defaultValue is returned.
    
    Type Parameters:
    
    T - Type that the configuration is converted to if found.
    
    Parameters:
    
    name - Name of the configuration.
    
    defaultValue - Value to return if the configuration isn't found.
    
    Returns:
    
    The converted configuration if found, otherwise the default value is returned.
  - get
```
public <T> T get(String name,
                 Function<String,T> converter)
```
    Gets the converted value of the configuration.
    
    Type Parameters:
    
    T - Generic type that the configuration is converted to if found.
    
    Parameters:
    
    name - Name of the configuration.
    
    converter - Converter used to map the configuration to T.
    
    Returns:
    
    The converted configuration if found, otherwise null.
  - put
```
public Configuration put(String name,
                         String value)
```
    Adds a configuration with the given value. If a configuration with the same name already exists, this will update it to the passed value.
    
    Parameters:
    
    name - Name of the configuration.
    
    value - Value of the configuration.
    
    Returns:
    
    The updated Configuration object.
  - remove
```
public String remove(String name)
```
    Removes the configuration.
    
    Parameters:
    
    name - Name of the configuration.
    
    Returns:
    
    If the configuration was removed the value of it, otherwise null.
  - contains
```
public boolean contains(String name)
```
    Determines if the configuration exists.
    
    Parameters:
    
    name - Name of the configuration.
    
    Returns:
    
    True if the configuration exists, otherwise false.
  - clone
```
public Configuration clone()
```
    Overrides:
    
    clone in class Object
    
    Returns:
    
    A clone of the Configuration object.

Class Configuration

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PROPERTY_HTTP_PROXY

PROPERTY_HTTPS_PROXY

PROPERTY_IDENTITY_ENDPOINT

PROPERTY_IDENTITY_HEADER

PROPERTY_NO_PROXY

PROPERTY_MSI_ENDPOINT

PROPERTY_MSI_SECRET

PROPERTY_AZURE_SUBSCRIPTION_ID

PROPERTY_AZURE_USERNAME

PROPERTY_AZURE_PASSWORD

PROPERTY_AZURE_CLIENT_ID

PROPERTY_AZURE_CLIENT_SECRET

PROPERTY_AZURE_TENANT_ID

PROPERTY_AZURE_CLIENT_CERTIFICATE_PATH

PROPERTY_AZURE_RESOURCE_GROUP

PROPERTY_AZURE_CLOUD

PROPERTY_AZURE_AUTHORITY_HOST

PROPERTY_AZURE_TELEMETRY_DISABLED

PROPERTY_AZURE_LOG_LEVEL

PROPERTY_AZURE_TRACING_DISABLED

NONE

Constructor Detail

Configuration

Method Detail

getGlobalConfiguration

get

get

get

put

remove

contains

clone