次の方法で共有

Configuration クラス

  • リファレンス
パッケージ:
com.azure.core.util
Maven 成果物:
com.azure:azure-core:1.49.1
  • java.lang.Object
    • com.azure.core.util.Configuration

実装

複製可能

public class Configuration
implements Cloneable

クライアント ライブラリの構築中に使用される構成情報が含まれます。

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

フィールドの概要

修飾子と型 フィールドと説明
static final Configuration NONE

クライアント ライブラリの構築時にグローバル構成の使用をオプトアウトするために使用される No-op Configuration オブジェクト。
static final String PROPERTY_AZURE_AUTHORITY_HOST

接続先の Azure Active Directory エンドポイント。
static final String PROPERTY_AZURE_CLIENT_CERTIFICATE_PASSWORD

Azure でサービス プリンシパル認証を実行するときに使用される PFX/PEM 証明書のパスワード。
static final String PROPERTY_AZURE_CLIENT_CERTIFICATE_PATH

Azure でサービス プリンシパル認証を実行するときに使用する PFX/PEM 証明書ファイルのパス。
static final String PROPERTY_AZURE_CLIENT_ID

Azure でサービス プリンシパル認証を実行するときに使用するクライアント ID。
static final String PROPERTY_AZURE_CLIENT_SECRET

Azure でサービス プリンシパル認証を実行するときに使用するクライアント シークレット。
static final String PROPERTY_AZURE_CLOUD

接続先の Azure クラウドの名前。
static final String PROPERTY_AZURE_HTTP_CLIENT_IMPLEMENTATION

のインスタンスを HttpClientProvider 構築するために使用する実装の HttpClient名前を設定します。
static final String PROPERTY_AZURE_HTTP_LOG_DETAIL_LEVEL

HTTP ログの詳細レベルを設定して、HTTP 要求/応答のログ記録を有効にします。
static final String PROPERTY_AZURE_IDENTITY_DISABLE_CP1

Azure Identity Token 資格情報で CP1 クライアント機能を無効にするフラグ。
static final String PROPERTY_AZURE_LOG_LEVEL

ログ レベルを設定してログ記録を有効にします。
static final String PROPERTY_AZURE_METRICS_DISABLED

メトリックを無効にします。
static final String PROPERTY_AZURE_METRICS_IMPLEMENTATION

のインスタンスを MeterProvider 構築するために使用する実装の Meter名前を設定します。
static final String PROPERTY_AZURE_PASSWORD

Azure でユーザー名/パスワード認証を実行するときに使用するユーザー名。
static final String PROPERTY_AZURE_POD_IDENTITY_TOKEN_URL

Bridge To Kubernetes が開発環境で IMDS 呼び出しをリダイレクトするために使用する URL。
static final String PROPERTY_AZURE_REGIONAL_AUTHORITY_NAME

Azure AAD リージョン機関の名前。
static final String PROPERTY_AZURE_REQUEST_CONNECT_TIMEOUT

リモート ホストに接続する要求の既定のタイムアウトをミリ秒単位で設定します。
static final String PROPERTY_AZURE_REQUEST_READ_TIMEOUT

応答で読み取られた各バイト間で許可される既定のタイムアウト間隔をミリ秒単位で設定します。
static final String PROPERTY_AZURE_REQUEST_RESPONSE_TIMEOUT

要求がリモート ホストから応答を受信するための既定のタイムアウトをミリ秒単位で設定します。
static final String PROPERTY_AZURE_REQUEST_RETRY_COUNT

要求が再試行の条件に合格した場合に失敗する前に、要求が再試行される既定の回数を設定します。
static final String PROPERTY_AZURE_REQUEST_WRITE_TIMEOUT

要求によって書き込まれた各バイト間で許可される既定のタイムアウト間隔をミリ秒単位で設定します。
static final String PROPERTY_AZURE_RESOURCE_GROUP

Azure リソース グループの名前。
static final String PROPERTY_AZURE_SUBSCRIPTION_ID

Azure リソースに接続するときに使用するサブスクリプション ID。
static final String PROPERTY_AZURE_TELEMETRY_DISABLED

テレメトリ収集を無効にします。
static final String PROPERTY_AZURE_TENANT_ID

Azure リソースのテナント ID。
static final String PROPERTY_AZURE_TRACING_DISABLED

トレースを無効にします。
static final String PROPERTY_AZURE_TRACING_IMPLEMENTATION

のインスタンスを TracerProvider 構築するために使用する実装の Tracer名前を設定します。
static final String PROPERTY_AZURE_USERNAME

Azure でユーザー名/パスワード認証を実行するときに使用するユーザー名。
static final String PROPERTY_HTTPS_PROXY

HTTPS 接続のプロキシの URL。
static final String PROPERTY_HTTP_PROXY

HTTP 接続のプロキシの URL。
static final String PROPERTY_IDENTITY_ENDPOINT

Azure Active Directory マネージド サービス ID (MSI) を使用するときに接続するエンドポイント。
static final String PROPERTY_IDENTITY_HEADER

マネージド サービス ID (MSI) を使用して Azure Active Directory に接続するときのヘッダー。
static final String PROPERTY_MSI_ENDPOINT

Azure Active Directory マネージド サービス ID (MSI) を使用するときに接続するエンドポイント。
static final String PROPERTY_MSI_SECRET

マネージド サービス ID (MSI) を使用して Azure Active Directory に接続するときのシークレット。
static final String PROPERTY_NO_PROXY

プロキシ HTTP/HTTPS 接続を使用しないホストまたは CIDR のリスト。

コンストラクターの概要

コンストラクター 説明
Configuration()

非推奨

と ConfigurationSource を使用ConfigurationBuilderすると、構成を作成する前にすべてのプロパティを指定し、不変に保つことができます。

既知の Azure プロパティ定数を含む構成を構築します。

メソッドの概要

修飾子と型 メソッドと説明
T get(ConfigurationProperty<T> property)

使用可能なすべてのソースから次の順序でプロパティ値を取得します。

  • プロパティ名で指定 ConfigurationSource された明示的な構成
  • プロパティエイリアスによる明示的な構成は、 で指定された順序で行われます ConfigurationProperty<T>
  • 共有セクションのプロパティ名による明示的な構成 (が共有されている場合 ConfigurationProperty<T> )
  • 共有セクションのプロパティ エイリアスによる明示的な構成 (が共有されている場合 ConfigurationProperty<T> )
  • システム プロパティ (設定されている場合)
  • 環境変数 (設定されている場合)
T get(String name, T defaultValue)

この型の対応するparseメソッドを使用して、指定されたプリミティブTに変換されたシステム プロパティまたは環境変数の値を取得します。
T get(String name, Function<String,T> converter)

システム プロパティまたは環境変数の値を取得し、 で変換します converter。
Configuration clone()

非推奨

と ConfigurationSource を使用してConfigurationBuilder構成を作成します。

この Configuration オブジェクトを複製します。
boolean contains(ConfigurationProperty<?> property)

構成に プロパティが含まれているかどうかを確認します。
boolean contains(String name)

システム プロパティまたは環境変数が定義されているかどうかを判断します。
String get(String name)

システム プロパティまたは環境変数の値を取得します。
static Configuration getGlobalConfiguration()

すべてのクライアント ライブラリによって共有されるグローバル構成ストアを取得します。
Configuration put(String name, String value)

非推奨

構成を作成する前にすべてのプロパティを指定するには、 と ConfigurationSource を使用ConfigurationBuilderします。

指定された値を持つ構成を追加します。
String remove(String name)

非推奨

構成を作成する前にすべてのプロパティを指定するには、 と ConfigurationSource を使用ConfigurationBuilderします。

構成を削除します。

メソッドの継承元: java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

フィールドの詳細

NONE

public static final Configuration NONE

クライアント ライブラリの構築時にグローバル構成の使用をオプトアウトするために使用される No-op Configuration オブジェクト。

PROPERTY_AZURE_AUTHORITY_HOST

public static final String PROPERTY_AZURE_AUTHORITY_HOST

接続先の Azure Active Directory エンドポイント。

PROPERTY_AZURE_CLIENT_CERTIFICATE_PASSWORD

public static final String PROPERTY_AZURE_CLIENT_CERTIFICATE_PASSWORD

Azure でサービス プリンシパル認証を実行するときに使用される PFX/PEM 証明書のパスワード。

PROPERTY_AZURE_CLIENT_CERTIFICATE_PATH

public static final String PROPERTY_AZURE_CLIENT_CERTIFICATE_PATH

Azure でサービス プリンシパル認証を実行するときに使用する PFX/PEM 証明書ファイルのパス。

PROPERTY_AZURE_CLIENT_ID

public static final String PROPERTY_AZURE_CLIENT_ID

Azure でサービス プリンシパル認証を実行するときに使用するクライアント ID。

PROPERTY_AZURE_CLIENT_SECRET

public static final String PROPERTY_AZURE_CLIENT_SECRET

Azure でサービス プリンシパル認証を実行するときに使用するクライアント シークレット。

PROPERTY_AZURE_CLOUD

public static final String PROPERTY_AZURE_CLOUD

接続先の Azure クラウドの名前。

PROPERTY_AZURE_HTTP_CLIENT_IMPLEMENTATION

public static final String PROPERTY_AZURE_HTTP_CLIENT_IMPLEMENTATION

のインスタンスを HttpClientProvider 構築するために使用する実装の HttpClient名前を設定します。

名前は、同じ名前で異なるパッケージから複数のプロバイダーを明確にするために、完全なクラス名である必要があります (例com.azure.core.http.netty.NettyAsyncHttpClientProviderNettyAsyncHttpClientProvider: ではなく)。

値が設定されていないか、空の文字列である場合、ServiceLoader によって最初HttpClientProviderに解決された が のインスタンスHttpClientの作成に使用されます。 値が設定され、ServiceLoaderIllegalStateException によって解決された値HttpClientProviderと一致しない場合、 のHttpClientインスタンスを作成しようとしたときに がスローされます。

PROPERTY_AZURE_HTTP_LOG_DETAIL_LEVEL

public static final String PROPERTY_AZURE_HTTP_LOG_DETAIL_LEVEL

HTTP ログの詳細レベルを設定して、HTTP 要求/応答のログ記録を有効にします。

PROPERTY_AZURE_IDENTITY_DISABLE_CP1

public static final String PROPERTY_AZURE_IDENTITY_DISABLE_CP1

Azure Identity Token 資格情報で CP1 クライアント機能を無効にするフラグ。

PROPERTY_AZURE_LOG_LEVEL

public static final String PROPERTY_AZURE_LOG_LEVEL

ログ レベルを設定してログ記録を有効にします。

PROPERTY_AZURE_METRICS_DISABLED

public static final String PROPERTY_AZURE_METRICS_DISABLED

メトリックを無効にします。

PROPERTY_AZURE_METRICS_IMPLEMENTATION

public static final String PROPERTY_AZURE_METRICS_IMPLEMENTATION

のインスタンスを MeterProvider 構築するために使用する実装の Meter名前を設定します。

名前は、 ではなくOpenTelemetryMeterProvider、完全なクラス名である必要があります。 com.azure.core.tracing.opentelemetry.OpenTelemetryMeterProvider

値が設定されていないか、空の文字列である場合、ServiceLoader によって最初MeterProviderに解決された が のインスタンスMeterの作成に使用されます。 値が設定され、ServiceLoaderIllegalStateException によって解決された値MeterProviderと一致しない場合、 のMeterProviderインスタンスを作成しようとしたときに がスローされます。

PROPERTY_AZURE_PASSWORD

public static final String PROPERTY_AZURE_PASSWORD

Azure でユーザー名/パスワード認証を実行するときに使用するユーザー名。

PROPERTY_AZURE_POD_IDENTITY_TOKEN_URL

public static final String PROPERTY_AZURE_POD_IDENTITY_TOKEN_URL

Bridge To Kubernetes が開発環境で IMDS 呼び出しをリダイレクトするために使用する URL。

PROPERTY_AZURE_REGIONAL_AUTHORITY_NAME

public static final String PROPERTY_AZURE_REGIONAL_AUTHORITY_NAME

Azure AAD リージョン機関の名前。

PROPERTY_AZURE_REQUEST_CONNECT_TIMEOUT

public static final String PROPERTY_AZURE_REQUEST_CONNECT_TIMEOUT

リモート ホストに接続する要求の既定のタイムアウトをミリ秒単位で設定します。

構成された値が 0 以下の場合、タイムアウトは適用されません。

PROPERTY_AZURE_REQUEST_READ_TIMEOUT

public static final String PROPERTY_AZURE_REQUEST_READ_TIMEOUT

応答で読み取られた各バイト間で許可される既定のタイムアウト間隔をミリ秒単位で設定します。

構成された値が 0 以下の場合、タイムアウトは適用されません。

PROPERTY_AZURE_REQUEST_RESPONSE_TIMEOUT

public static final String PROPERTY_AZURE_REQUEST_RESPONSE_TIMEOUT

要求がリモート ホストから応答を受信するための既定のタイムアウトをミリ秒単位で設定します。

構成された値が 0 以下の場合、タイムアウトは適用されません。

PROPERTY_AZURE_REQUEST_RETRY_COUNT

public static final String PROPERTY_AZURE_REQUEST_RETRY_COUNT

要求が再試行の条件に合格した場合に失敗する前に、要求が再試行される既定の回数を設定します。

PROPERTY_AZURE_REQUEST_WRITE_TIMEOUT

public static final String PROPERTY_AZURE_REQUEST_WRITE_TIMEOUT

要求によって書き込まれた各バイト間で許可される既定のタイムアウト間隔をミリ秒単位で設定します。

構成された値が 0 以下の場合、タイムアウトは適用されません。

PROPERTY_AZURE_RESOURCE_GROUP

public static final String PROPERTY_AZURE_RESOURCE_GROUP

Azure リソース グループの名前。

PROPERTY_AZURE_SUBSCRIPTION_ID

public static final String PROPERTY_AZURE_SUBSCRIPTION_ID

Azure リソースに接続するときに使用するサブスクリプション ID。

PROPERTY_AZURE_TELEMETRY_DISABLED

public static final String PROPERTY_AZURE_TELEMETRY_DISABLED

テレメトリ収集を無効にします。

PROPERTY_AZURE_TENANT_ID

public static final String PROPERTY_AZURE_TENANT_ID

Azure リソースのテナント ID。

PROPERTY_AZURE_TRACING_DISABLED

public static final String PROPERTY_AZURE_TRACING_DISABLED

トレースを無効にします。

PROPERTY_AZURE_TRACING_IMPLEMENTATION

public static final String PROPERTY_AZURE_TRACING_IMPLEMENTATION

のインスタンスを TracerProvider 構築するために使用する実装の Tracer名前を設定します。

名前は、 ではなくOpenTelemetryTracerProvider、完全なクラス名である必要があります。 com.azure.core.tracing.opentelemetry.OpenTelemetryTracerProvider

値が設定されていないか、空の文字列である場合、ServiceLoader によって最初TracerProviderに解決された が のインスタンスTracerの作成に使用されます。 値が設定され、ServiceLoaderIllegalStateException によって解決された値TracerProviderと一致しない場合、 のTracerProviderインスタンスを作成しようとしたときに がスローされます。

PROPERTY_AZURE_USERNAME

public static final String PROPERTY_AZURE_USERNAME

Azure でユーザー名/パスワード認証を実行するときに使用するユーザー名。

PROPERTY_HTTPS_PROXY

public static final String PROPERTY_HTTPS_PROXY

HTTPS 接続のプロキシの URL。

PROPERTY_HTTP_PROXY

public static final String PROPERTY_HTTP_PROXY

HTTP 接続のプロキシの URL。

PROPERTY_IDENTITY_ENDPOINT

public static final String PROPERTY_IDENTITY_ENDPOINT

Azure Active Directory マネージド サービス ID (MSI) を使用するときに接続するエンドポイント。

PROPERTY_IDENTITY_HEADER

public static final String PROPERTY_IDENTITY_HEADER

マネージド サービス ID (MSI) を使用して Azure Active Directory に接続するときのヘッダー。

PROPERTY_MSI_ENDPOINT

public static final String PROPERTY_MSI_ENDPOINT

Azure Active Directory マネージド サービス ID (MSI) を使用するときに接続するエンドポイント。

PROPERTY_MSI_SECRET

public static final String PROPERTY_MSI_SECRET

マネージド サービス ID (MSI) を使用して Azure Active Directory に接続するときのシークレット。

PROPERTY_NO_PROXY

public static final String PROPERTY_NO_PROXY

プロキシ HTTP/HTTPS 接続を使用しないホストまたは CIDR のリスト。

コンストラクターの詳細

Configuration

@Deprecated
public Configuration()

非推奨

と ConfigurationSource を使用ConfigurationBuilderすると、構成を作成する前にすべてのプロパティを指定し、不変に保つことができます。

既知の Azure プロパティ定数を含む構成を構築します。

メソッドの詳細

get

public T get(ConfigurationProperty property)

使用可能なすべてのソースから次の順序でプロパティ値を取得します。

  • プロパティ名で指定 ConfigurationSource された明示的な構成
  • プロパティエイリアスによる明示的な構成は、 で指定された順序で行われます ConfigurationProperty<T>
  • 共有セクションのプロパティ名による明示的な構成 (が共有されている場合 ConfigurationProperty<T> )
  • 共有セクションのプロパティ エイリアスによる明示的な構成 (が共有されている場合 ConfigurationProperty<T> )
  • システム プロパティ (設定されている場合)
  • 環境変数 (設定されている場合)

プロパティ値は、指定した型に変換されます。 プロパティ値が指定されておらず、必須でない場合は、既定値が返されます。

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

パラメーター:

property - 取得します。

戻り値:

存在する場合は プロパティの値、それ以外の場合は プロパティの既定値。

get

public T get(String name, T defaultValue)

この型の対応するparseメソッドを使用して、指定されたプリミティブTに変換されたシステム プロパティまたは環境変数の値を取得します。 オーバーロードを使用して get(ConfigurationProperty<T> property) 、特定のソースから明示的な構成または環境構成を取得します。

このメソッドは、最初に環境から読み込まれた値を確認します。構成が見つかった場合は、その値が返されます。 それ以外の場合は、環境から値の読み込みが試行されます。

構成が見つからない場合は、 defaultValue が返されます。

次の種類がサポートされています。

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

パラメーター:

name - 構成の名前。
defaultValue - 構成が見つからない場合に返す値。

戻り値:

見つかった場合は変換された構成。それ以外の場合は既定値が返されます。

get

public T get(String name, Function converter)

システム プロパティまたは環境変数の値を取得し、 で変換します converter。

このメソッドは、最初に環境から読み込まれた値を確認します。構成が見つかった場合は、その値が返されます。 それ以外の場合は、環境から値の読み込みが試行されます。

構成が見つからない converter 場合、 は呼び出されません。null が返されます。

パラメーター:

name - 構成の名前。
converter - 構成 Tを にマップするために使用されるコンバーター。

戻り値:

見つかった場合は変換された構成。それ以外の場合は null。

clone

@Deprecated
public Configuration clone()

非推奨

と ConfigurationSource を使用してConfigurationBuilder構成を作成します。

この Configuration オブジェクトを複製します。

上書き:

Configuration.clone()

戻り値:

Configuration オブジェクトの複製。

contains

public boolean contains(ConfigurationProperty property)

構成に プロパティが含まれているかどうかを確認します。 プロパティをクライアント間で共有できる場合は、これを Configuration 確認し、共有セクションにフォールバックします。 プロパティにエイリアス、システム プロパティ、または環境変数が定義されている場合は、それらをチェックします。

値は検証されません。

パラメーター:

property - 取得します。

戻り値:

プロパティが使用可能な場合は true、それ以外の場合は false。

contains

public boolean contains(String name)

システム プロパティまたは環境変数が定義されているかどうかを判断します。

オーバーロードを使用して contains(ConfigurationProperty<?> property) 、特定のソースから明示的な構成または環境構成を取得します。

これは、以前に Configuration オブジェクトに読み込まれた値に対してのみチェックされます。これにより、値が含まれている環境は検査されません。

パラメーター:

name - 構成の名前。

戻り値:

構成が存在する場合は True、それ以外の場合は false。

get

public String get(String name)

システム プロパティまたは環境変数の値を取得します。 オーバーロードを使用して get(ConfigurationProperty<T> property) 、特定のソースから明示的な構成または環境構成を取得します。

このメソッドは、最初に環境から読み込まれた値を確認します。構成が見つかった場合は、その値が返されます。 それ以外の場合は、環境から値の読み込みが試行されます。

パラメーター:

name - 構成の名前。

戻り値:

見つかった場合は構成の値。それ以外の場合は null。

getGlobalConfiguration

public static Configuration getGlobalConfiguration()

すべてのクライアント ライブラリによって共有されるグローバル構成ストアを取得します。

戻り値:

グローバル構成ストア。

put

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

非推奨

構成を作成する前にすべてのプロパティを指定するには、 と ConfigurationSource を使用ConfigurationBuilderします。

指定された値を持つ構成を追加します。

これにより、以前の構成値が存在する場合は上書きされます。

パラメーター:

name - 構成の名前。
value - 構成の値。

戻り値:

更新された Configuration オブジェクト。

remove

@Deprecated
public String remove(String name)

非推奨

構成を作成する前にすべてのプロパティを指定するには、 と ConfigurationSource を使用ConfigurationBuilderします。

構成を削除します。

これにより、構成の値が以前に存在していた場合に返されます。

パラメーター:

name - 構成の名前。

戻り値:

以前に存在していた場合は構成、それ以外の場合は null。

適用対象