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_HTTP_LOG_DETAIL_LEVEL
Enables HTTP request/response logging by setting an HTTP log detail level.
|
static String |
PROPERTY_AZURE_IDENTITY_DISABLE_CP1
Flag to disable the CP1 client capabilities in Azure Identity Token credentials.
|
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_POD_IDENTITY_TOKEN_URL
URL used by Bridge To Kubernetes to redirect IMDS calls in the development environment.
|
static String |
PROPERTY_AZURE_REGIONAL_AUTHORITY_NAME |
static String |
PROPERTY_AZURE_REQUEST_CONNECT_TIMEOUT
Sets the default timeout, in milliseconds, for a request to connect to the remote host.
|
static String |
PROPERTY_AZURE_REQUEST_READ_TIMEOUT
Sets the default timeout interval, in milliseconds, allowed between each byte read in a response.
|
static String |
PROPERTY_AZURE_REQUEST_RESPONSE_TIMEOUT
Sets the default timeout, in milliseconds, for a request to receive a response from the remote host.
|
static 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.
|
static String |
PROPERTY_AZURE_REQUEST_WRITE_TIMEOUT
Sets the default timeout interval, in milliseconds, allowed between each byte written by a request.
|
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 and Description |
---|
Configuration()
Constructs a configuration containing the known Azure properties constants.
|
Modifier and Type | Method and Description |
---|---|
Configuration |
clone()
Clones this Configuration object.
|
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 value of the configuration and converts it with the
converter . |
<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.
|
public static final String PROPERTY_HTTP_PROXY
public static final String PROPERTY_HTTPS_PROXY
public static final String PROPERTY_IDENTITY_ENDPOINT
public static final String PROPERTY_IDENTITY_HEADER
public static final String PROPERTY_NO_PROXY
public static final String PROPERTY_MSI_ENDPOINT
public static final String PROPERTY_MSI_SECRET
public static final String PROPERTY_AZURE_SUBSCRIPTION_ID
public static final String PROPERTY_AZURE_USERNAME
public static final String PROPERTY_AZURE_PASSWORD
public static final String PROPERTY_AZURE_CLIENT_ID
public static final String PROPERTY_AZURE_CLIENT_SECRET
public static final String PROPERTY_AZURE_TENANT_ID
public static final String PROPERTY_AZURE_CLIENT_CERTIFICATE_PATH
public static final String PROPERTY_AZURE_IDENTITY_DISABLE_CP1
public static final String PROPERTY_AZURE_POD_IDENTITY_TOKEN_URL
public static final String PROPERTY_AZURE_REGIONAL_AUTHORITY_NAME
public static final String PROPERTY_AZURE_RESOURCE_GROUP
public static final String PROPERTY_AZURE_CLOUD
public static final String PROPERTY_AZURE_AUTHORITY_HOST
public static final String PROPERTY_AZURE_TELEMETRY_DISABLED
public static final String PROPERTY_AZURE_LOG_LEVEL
public static final String PROPERTY_AZURE_HTTP_LOG_DETAIL_LEVEL
public static final String PROPERTY_AZURE_TRACING_DISABLED
public static final String PROPERTY_AZURE_REQUEST_RETRY_COUNT
public static final String PROPERTY_AZURE_REQUEST_CONNECT_TIMEOUT
If the configured value is equal to or less than 0 no timeout will be applied.
public static final String PROPERTY_AZURE_REQUEST_WRITE_TIMEOUT
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
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
If the configured value is equal to or less than 0 no timeout will be applied.
public static final Configuration NONE
Configuration
object used to opt out of using global configurations when constructing client
libraries.public Configuration()
public static Configuration getGlobalConfiguration()
public String get(String name)
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.
name
- Name of the configuration.public <T> T get(String name, T defaultValue)
T
.
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.
T
- Type that the configuration is converted to if found.name
- Name of the configuration.defaultValue
- Value to return if the configuration isn't found.public <T> T get(String name, Function<String,T> converter)
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.
T
- Type that the configuration is converted to if found.name
- Name of the configuration.converter
- Converter used to map the configuration to T
.public Configuration put(String name, String value)
This will overwrite the previous configuration value if it existed.
name
- Name of the configuration.value
- Value of the configuration.public String remove(String name)
This returns the value of the configuration if it previously existed.
name
- Name of the configuration.public boolean contains(String name)
This only checks against values previously loaded into the Configuration object, this won't inspect the environment for containing the value.
name
- Name of the configuration.public Configuration clone()
Copyright © 2021 Microsoft Corporation. All rights reserved.