Azure Key Vault Connector 1.1 リファレンス - Mule 4

Azure Key Vault 用 Anypoint Connector (Azure Key Vault Connector) を使用すると、シークレット、キー、または証明書を取得し、コンテンツを暗号化または復号化できます。

設定

Azure Key Vault Connector のデフォルト設定。

名前 説明 デフォルト値 必須

Name (名前)

String (文字列)

この設定の名前。コネクタはこの名前の設定を参照します。

x

Connection (接続)

この設定の接続種別。

x

Name (名前)

String (文字列)

この設定の参照に使用される ID。

x

Expiration Policy (有効期限ポリシー)

動的設定インスタンスがアイドル状態を続けられる最小時間を設定します。この時間が経過すると、Mule Runtime で期限切れに相当するとみなされます。

接続 - 接続種別

認証にクライアント ID、クライアントシークレット、および暗号化クライアントキャッシュを使用します。コネクタ設定では、​client_id​ や ​client_secret​ などのプロパティをハードコーディングできません。

Name (名前) 説明 デフォルト値 必須

Client Id (クライアント ID)

String (文字列)

クライアント ID。

x

Tenant Id (テナント ID)

String (文字列)

テナント ID。

x

Client Secret (クライアントシークレット)

String (文字列)

クライアントシークレット。

x

Vault Name (Vault 名)

String (文字列)

Vault 名。

x

Use Azure Default Credential (Azure のデフォルトログイン情報を使用)

Boolean (ブール)

環境変数から取得した認証パラメーターを使用します。

false

Uri Override (URI 上書き)

String (文字列)

Key Vault の URI 上書き。この項目が設定されていると、接続設定で [Vault Name (Vault 名)] 項目の値が考慮されなくなります。Key Vault が Azure Commercial Cloud にない場合、この項目を設定します。

Cryptography Client Cache (暗号化クライアントキャッシュ)

キーに基づいて暗号化クライアントが作成されます。キーが変更されない (新しいバージョンが作成されない) 場合、クライアントはキャッシュされ、​Encrypt Message​ および ​Decrypt Message​ 操作にかかる時間が短くなります。 メッセージを暗号化または復号化するときに、キーを内部で取得する必要があります。毎回キーを取得すると、操作の実行に時間がかかります。キーを取得する時間を短縮するには、​[Cryptography Client Cache (暗号化クライアントキャッシュ)]​ を有効にします。

Reconnection (再接続)

コネクタ操作で外部サーバーへの接続に失敗した場合に使用する再接続戦略を設定します。

Pooling Profile (プーリングプロファイル)

接続プールの特性。

操作

Decrypt Message

<azure-key-vault:decrypt-message>

メッセージを復号化します。

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Algorithm (アルゴリズム)

Enumeration (列挙)。次のいずれかになります。

  • RSA_OAEP​

  • RSA_OAEP_256​

  • RSA1_5

アルゴリズム種別。

x

キー名

String (文字列)

キー名。

x

Key Version (キーバージョン)

String (文字列)

キーバージョン。

Message (メッセージ)

Any (任意)

復号化するメッセージ。

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

x

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は ​[Target Variable (対象変数)]​ 項目に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

暗号化結果

関連する設定

スロー

  • AZURE-KEY-VAULT:CONNECTIVITY

  • AZURE-KEY-VAULT:DECRYPT_ERROR

  • AZURE-KEY-VAULT:ENCRYPT_ERROR

  • AZURE-KEY-VAULT:INVALID_CREDENTIALS

  • AZURE-KEY-VAULT:INVALID_VAULT

  • AZURE-KEY-VAULT:RESOURCE_NOT_FOUND

  • AZURE-KEY-VAULT:RETRY_EXHAUSTED

Encrypt Message

<azure-key-vault:encrypt-message>

メッセージを暗号化する。

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Algorithm (アルゴリズム)

Enumeration (列挙)。次のいずれかになります。

  • RSA_OAEP​

  • RSA_OAEP_256​

  • RSA1_5

アルゴリズム種別。

x

キー名

String (文字列)

キー名。

x

Key Version (キーバージョン)

String (文字列)

キーバージョン。

Message (メッセージ)

Any (任意)

暗号化するメッセージ。

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

x

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は ​[Target Variable (対象変数)]​ 項目に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

暗号化結果

関連する設定

スロー

  • AZURE-KEY-VAULT:CONNECTIVITY

  • AZURE-KEY-VAULT:DECRYPT_ERROR

  • AZURE-KEY-VAULT:ENCRYPT_ERROR

  • AZURE-KEY-VAULT:INVALID_CREDENTIALS

  • AZURE-KEY-VAULT:INVALID_VAULT

  • AZURE-KEY-VAULT:RESOURCE_NOT_FOUND

  • AZURE-KEY-VAULT:RETRY_EXHAUSTED

Get Certificate

<azure-key-vault:get-certificate>

証明書を取得します。

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Certificate Name (証明書名)

String (文字列)

証明書名。

x

Certificate Version (証明書バージョン)

String (文字列)

証明書バージョン。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

x

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は ​[Target Variable (対象変数)]​ 項目に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

関連する設定

スロー

  • AZURE-KEY-VAULT:CONNECTIVITY

  • AZURE-KEY-VAULT:DECRYPT_ERROR

  • AZURE-KEY-VAULT:ENCRYPT_ERROR

  • AZURE-KEY-VAULT:INVALID_CREDENTIALS

  • AZURE-KEY-VAULT:INVALID_VAULT

  • AZURE-KEY-VAULT:RESOURCE_NOT_FOUND

  • AZURE-KEY-VAULT:RETRY_EXHAUSTED

Get Secret

<azure-key-vault:get-secret>

シークレットを取得します。

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Secret Name (シークレット名)

String (文字列)

シークレット名。

x

Secret Version (シークレットバージョン)

String (文字列)

シークレットバージョン。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

x

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は ​[Target Variable (対象変数)]​ 項目に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

関連する設定

スロー

  • AZURE-KEY-VAULT:CONNECTIVITY

  • AZURE-KEY-VAULT:DECRYPT_ERROR

  • AZURE-KEY-VAULT:ENCRYPT_ERROR

  • AZURE-KEY-VAULT:INVALID_CREDENTIALS

  • AZURE-KEY-VAULT:INVALID_VAULT

  • AZURE-KEY-VAULT:RESOURCE_NOT_FOUND

  • AZURE-KEY-VAULT:RETRY_EXHAUSTED

オブジェクト種別

キャッシュ暗号化ハイクライアント設定

キャッシュ暗号化クライアント設定を定義します。

キーに基づいて暗号化クライアントが作成されます。キーが変更されない (新しいバージョンが作成されない) 場合、クライアントはキャッシュされ、​Encrypt Message​ および ​Decrypt Message​ 操作にかかる時間が短くなります。

メッセージを暗号化または復号化するときに、キーを内部で取得する必要があります。毎回キーを取得すると、操作の実行に時間がかかります。キーを取得する時間を短縮するには、​[Cryptography Client Cache (暗号化クライアントキャッシュ)]​ を有効にします。

項目 説明 デフォルト値 必須

Cached Crypto Client Ttl (キャッシュ暗号化クライアント TTL)

String (文字列)

キャッシュ暗号化クライアント存続期間 (TTL) 値。

10

Unit (単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

[Cached Crypto Client Ttl (キャッシュ暗号化クライアント TTL)]​ 項目の時間単位。

MINUTES

暗号化結果

暗号化結果種別を設定します。

項目 説明 デフォルト値 必須

Data (データ)

Binary (バイナリ)

データ。

Encryption Algorithm (暗号化アルゴリズム)

Enumeration (列挙)。次のいずれかになります。

  • RSA_OAEP​

  • RSA_OAEP_256​

  • RSA1_5

暗号化アルゴリズム種別。

Key (キー)

String (文字列)

Key (キー)。

Expiration Policy (有効期限ポリシー)

有効期限ポリシー戦略を設定します。

項目 説明 デフォルト値 必須

Max Idle Time (最大アイドル時間)

Number (数値)

動的設定インスタンスがアイドル状態を続けられる最大時間を設定します。この時間が経過すると、Mule Runtime で期限切れに相当するとみなされます。

Time Unit (時間単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

[Max Idle Time (最大アイドル時間)]​ 項目の時間単位。

プーリングプロファイル

プーリングプロファイル種別を設定します。

項目 説明 デフォルト値 必須

Max Active (最大アクティブ)

Number (数値)

一度にセッションから借りることができる Mule コンポーネントの数を制御します。負の値に設定した場合、同時にアクティブにできるコンポーネントの数に制限はありません。​[Max Active (最大アクティブ)]​ を超えた場合、プールは枯渇します。

Max Idle (最大アイドル)

Number (数値)

プール内で同時にアイドル状態のままにできる Mule コンポーネントの最大数。負の値に設定した場合、同時にアイドルにできる Mule コンポーネントの数に制限はありません。

Max Wait (最大待機)

Number (数値)

プールが枯渇し、​[Exhausted Action (枯渇アクション)]​ が ​WHEN_EXHAUSTED_WAIT​ に設定されている場合に、プールされたコンポーネントが使用可能になるまで待機する時間 (ミリ秒) を指定します。

Min Eviction Millis (最小除去時間)

Number (数値)

オブジェクトが除去対象となるまでにオブジェクトをプール内でアイドル状態のままにできる最小時間を決定します。正の値以外の場合、アイドル時間のみが原因でプールからエビクトされるオブジェクトはありません。

Eviction Check Interval Millis (除去確認間隔)

Number (数値)

オブジェクトエビクターの実行間隔 (ミリ秒) を指定します。正の値以外の場合、オブジェクトエビクターは実行されません。

Exhausted Action (枯渇アクション)

Enumeration (列挙)。次のいずれかになります。

  • WHEN_EXHAUSTED_GROW​

  • WHEN_EXHAUSTED_WAIT​

  • WHEN_EXHAUSTED_FAIL

Mule コンポーネントプールが枯渇した場合のプールの動作を指定します。

  • WHEN_EXHAUSTED_FAIL

    NoSuchElementException​ をスローする。

  • WHEN_EXHAUSTED_WAIT

    新規またはアイドルオブジェクトが利用可能になるまで、Object.wait(long) を呼び出してブロックする。

  • WHEN_EXHAUSTED_GROW

    新しい Mule インスタンスを作成して返す。​[Max Active (最大アクティブ)]​ は基本的に意味がなくなる。​[Max Wait (最大待機)]​ が正の値の場合、​WHEN_EXHAUSTED_GROW​ がブロックする最大時間はそのミリ秒数になります。その後、​NoSuchElementException​ がスローされます。​[Max Wait (最大待機)]​ が負の値の場合、​WHEN_EXHAUSTED_GROW​ は永久にブロックします。

Initialisation Policy (初期化ポリシー)

Enumeration (列挙)。次のいずれかになります。

  • INITIALISE_NONE​

  • INITIALISE_ONE​

  • INITIALISE_ALL

プール内のコンポーネントの初期化方法を決定します。

  • INITIALISE_NONE

    起動時にコンポーネントをプールに読み込みません。

  • INITIALISE_ONE

    起動時に初期コンポーネントをプールに読み込みます。

  • INITIALISE_ALL

    起動時にすべてのコンポーネントをプールに読み込みます。

Disabled (無効)

Boolean (ブール)

プーリングを無効にするかどうかを指定します。

Reconnect (再接続)

標準再接続戦略を設定し、再接続の頻度と、コネクタソースまたは操作で実行できる再接続の試行回数を指定します。

項目 説明 デフォルト値 必須

Frequency (頻度)

Number (数値)

再接続を試行する頻度 (ミリ秒)。

Blocking (ブロック)

Boolean (ブール)

false​ の場合、再接続戦略が個別の非ブロックスレッドで実行されます。

Count (数)

Number (数値)

Mule アプリケーションで実行できる再接続の試行回数。

Reconnect Forever (繰り返し再接続)

Mule アプリケーションが実行されている間はコネクタソースや操作によって指定された頻度で再接続が試行される Forever 再接続戦略を設定します。

項目 説明 デフォルト値 必須

Frequency (頻度)

Number (数値)

再接続を試行する頻度 (ミリ秒)。

Blocking (ブロック)

Boolean (ブール)

false​ の場合、再接続戦略が個別の非ブロックスレッドで実行されます。

Reconnection (再接続)

操作の再接続戦略を設定します。

項目 説明 デフォルト値 必須

Fails Deployment (デプロイに失敗)

Boolean (ブール)

コネクタ操作で外部サーバーへの接続に失敗した場合に使用する再接続戦略を設定します。

Reconnection Strategy (再接続戦略)

使用する再接続戦略。

Vault Certificate (Vault 証明書)

Vault 証明書種別を設定します。

項目 説明 デフォルト値 必須

Certificate (証明書)

Binary (バイナリ)

証明書。

Certificate Content Type (証明書コンテンツタイプ)

String (文字列)

証明書コンテンツタイプ。

Certificate Key Type (証明書キー種別)

String (文字列)

証明書キー種別。

Certificate Secret (証明書シークレット)

証明書シークレット。

Certificate Type (証明書種別)

String (文字列)

証明書種別。

Created on (作成日)

DateTime (日時)

Vault 証明書が作成された日付。

Enabled (有効)

Boolean (ブール)

Vault 証明書が有効かどうかを指定します。

Expires On (有効期限)

DateTime (日時)

Vault 証明書の有効期限を指定します。

Key Id (キー ID)

String (文字列)

Key ID (キー ID)。

Name (名前)

String (文字列)

名前。

Not Before (以降)

DateTime (日時)

Vault 証明書がその日時以降である必要があることを指定します。

Recovery Level (回復レベル)

String (文字列)

回復レベル。

Secret Id (シークレット ID)

String (文字列)

シークレット ID。

Updated On (更新日)

DateTime (日時)

Vault 証明書が更新される日時を指定します。

Version (バージョン)

String (文字列)

Vault 証明書のバージョン。

Vault Secret (Vault シークレット)

Vault シークレット種別を設定します。

項目 説明 デフォルト値 必須

Content Type (コンテンツタイプ)

String (文字列)

コンテンツタイプ。

Created on (作成日)

DateTime (日時)

Vault シークレットが作成された日付。

Enabled (有効)

Boolean (ブール)

Vault シークレットが有効かどうかを指定します。

Expires On (有効期限)

DateTime (日時)

Vault シークレットの有効期限を指定します。

Id

String (文字列)

ID。

Name (名前)

String (文字列)

名前。

Not Before (以降)

DateTime

Vault シークレットがその日時以降である必要があることを指定します。

Recovery Level (回復レベル)

String (文字列)

回復レベル。

Updated On (更新日)

DateTime (日時)

Vault シークレットが更新される日時を指定します。

Value (値)

String (文字列)

値。

Version (バージョン)

String (文字列)

Vault シークレットのバージョン。