KeyVaultClient クラス
- java.
lang. Object - com.
microsoft. azure. keyvault. KeyVaultClient
- com.
public class KeyVaultClient
KeyVaultClient クラスの新しいインスタンスを初期化します。
コンストラクターの概要
| コンストラクター | 説明 |
|---|---|
| KeyVaultClient(RestClient restClient) |
KeyVaultClient クライアントのインスタンスを初期化します。 |
| KeyVaultClient(ServiceClientCredentials credentials) |
KeyVaultClient クライアントのインスタンスを初期化します。 |
メソッドの概要
コンストラクターの詳細
KeyVaultClient
public KeyVaultClient(RestClient restClient)
KeyVaultClient クライアントのインスタンスを初期化します。
パラメーター:
KeyVaultClient
public KeyVaultClient(ServiceClientCredentials credentials)
KeyVaultClient クライアントのインスタンスを初期化します。
パラメーター:
メソッドの詳細
acceptLanguage
public String acceptLanguage()
応答の優先言語を取得または設定します。
戻り値:
apiVersion
public String apiVersion()
クライアント API のバージョンを取得します。
戻り値:
backupKey
public BackupKeyResult backupKey(String vaultBaseUrl, String keyName)
指定したキーのバックアップをクライアントにダウンロードするように要求します。
パラメーター:
戻り値:
backupKeyAsync
public ServiceFuture
指定したキーのバックアップをクライアントにダウンロードするように要求します。
パラメーター:
戻り値:
createCertificate
public CertificateOperation createCertificate(CreateCertificateRequest createCertificateRequest)
新しい証明書バージョンを作成します。 これが最初のバージョンの場合は、証明書リソースが作成されます。
パラメーター:
戻り値:
createCertificateAsync
public ServiceFuture
新しい証明書バージョンを作成します。 これが最初のバージョンの場合は、証明書リソースが作成されます。
パラメーター:
戻り値:
createKey
public KeyBundle createKey(CreateKeyRequest createKeyRequest)
新しいキーを作成し、格納し、キー パラメーターと属性をクライアントに返します。 キーの作成操作を使用して、Azure Key Vaultで任意のキーの種類を作成できます。 名前付きのキーが既に存在する場合は、Azure Key Vault によりキーの新しいバージョンが作成されます。 承認: キー/作成アクセス許可が必要です。
パラメーター:
戻り値:
createKeyAsync
public ServiceFuture
新しいキーを作成し、格納し、キー パラメーターと属性をクライアントに返します。 キーの作成操作を使用して、Azure Key Vaultで任意のキーの種類を作成できます。 名前付きのキーが既に存在する場合は、Azure Key Vault によりキーの新しいバージョンが作成されます。 承認: キー/作成アクセス許可が必要です。
パラメーター:
戻り値:
decrypt
public KeyOperationResult decrypt(String keyIdentifier, JsonWebKeyEncryptionAlgorithm algorithm, byte[] value)
暗号化されたデータの 1 つのブロックを復号化します。
パラメーター:
戻り値:
decryptAsync
public ServiceFuture
暗号化されたデータの 1 つのブロックを復号化します。
パラメーター:
戻り値:
deleteCertificate
public CertificateBundle deleteCertificate(String vaultBaseUrl, String certificateName)
指定したコンテナーから証明書を削除します。
パラメーター:
戻り値:
deleteCertificateAsync
public ServiceFuture
指定したコンテナーから証明書を削除します。
パラメーター:
戻り値:
deleteCertificateContacts
public Contacts deleteCertificateContacts(String vaultBaseUrl)
指定したコンテナーの証明書の連絡先を削除します。
パラメーター:
戻り値:
deleteCertificateContactsAsync
public ServiceFuture
指定したコンテナーの証明書の連絡先を削除します。
パラメーター:
戻り値:
deleteCertificateIssuer
public IssuerBundle deleteCertificateIssuer(String vaultBaseUrl, String issuerName)
指定した証明書発行者を削除します。
パラメーター:
戻り値:
deleteCertificateIssuerAsync
public ServiceFuture
指定した証明書発行者を削除します。
パラメーター:
戻り値:
deleteCertificateOperation
public CertificateOperation deleteCertificateOperation(String vaultBaseUrl, String certificateName)
指定した証明書の操作を削除します。
パラメーター:
戻り値:
deleteCertificateOperationAsync
public ServiceFuture
指定した証明書の操作を削除します。
パラメーター:
戻り値:
deleteKey
public KeyBundle deleteKey(String vaultBaseUrl, String keyName)
Azure Key Vault のストレージから任意の種類のキーを削除します。 キーの削除操作を使用して、キーの個々のバージョンを削除することはできません。 この操作ではキーに関連付けられている暗号化マテリアルを削除します。つまり、署名/検証、ラップ/ラップ解除または暗号化/暗号化解除の各操作でキーを使用できなくなります。 承認: キー/削除アクセス許可が必要です。
パラメーター:
戻り値:
deleteKeyAsync
public ServiceFuture
Azure Key Vault のストレージから任意の種類のキーを削除します。 キーの削除操作を使用して、キーの個々のバージョンを削除することはできません。 この操作ではキーに関連付けられている暗号化マテリアルを削除します。つまり、署名/検証、ラップ/ラップ解除または暗号化/暗号化解除の各操作でキーを使用できなくなります。 承認: キー/削除アクセス許可が必要です。
パラメーター:
戻り値:
deleteSecret
public SecretBundle deleteSecret(String vaultBaseUrl, String secretName)
指定したコンテナーからシークレットを削除します。
パラメーター:
戻り値:
deleteSecretAsync
public ServiceFuture
指定したコンテナーからシークレットを削除します。
パラメーター:
戻り値:
encrypt
public KeyOperationResult encrypt(String keyIdentifier, JsonWebKeyEncryptionAlgorithm algorithm, byte[] value)
キー コンテナーに格納されている暗号化キーを使用して、任意のバイト シーケンスを暗号化します。
パラメーター:
戻り値:
encryptAsync
public ServiceFuture
キー コンテナーに格納されている暗号化キーを使用して、任意のバイト シーケンスを暗号化します。
パラメーター:
戻り値:
generateClientRequestId
public boolean generateClientRequestId()
Gets True に設定すると、一意の x-ms-client-request-id 値が生成され、各要求に含まれます。 既定値は true です。
戻り値:
getAzureClient
public AzureClient getAzureClient()
実行時間の AzureClient 長い操作に使用される を取得します。
戻り値:
getCertificate
public CertificateBundle getCertificate(String certificateIdentifier)
指定した証明書に関する情報を取得します。
パラメーター:
戻り値:
getCertificate
public CertificateBundle getCertificate(String vaultBaseUrl, String certificateName)
指定した証明書に関する情報を取得します。
パラメーター:
戻り値:
getCertificate
public CertificateBundle getCertificate(String vaultBaseUrl, String certificateName, String certificateVersion)
指定した証明書に関する情報を取得します。
パラメーター:
戻り値:
getCertificateAsync
public ServiceFuture
指定した証明書に関する情報を取得します。
パラメーター:
戻り値:
getCertificateAsync
public ServiceFuture
指定した証明書に関する情報を取得します。
パラメーター:
戻り値:
getCertificateAsync
public ServiceFuture
指定した証明書に関する情報を取得します。
パラメーター:
戻り値:
getCertificateContacts
public Contacts getCertificateContacts(String vaultBaseUrl)
指定したコンテナーの証明書の連絡先を取得します。
パラメーター:
戻り値:
getCertificateContactsAsync
public ServiceFuture
指定したコンテナーの証明書の連絡先を取得します。
パラメーター:
戻り値:
getCertificateIssuer
public IssuerBundle getCertificateIssuer(String vaultBaseUrl, String issuerName)
指定した証明書発行者を取得します。
パラメーター:
戻り値:
getCertificateIssuerAsync
public ServiceFuture
指定した証明書発行者を取得します。
パラメーター:
戻り値:
getCertificateOperation
public CertificateOperation getCertificateOperation(String vaultBaseUrl, String certificateName)
指定した証明書に関連付けられている操作を取得します。
パラメーター:
戻り値:
getCertificateOperationAsync
public ServiceFuture
指定した証明書に関連付けられている操作を取得します。
パラメーター:
戻り値:
getCertificatePolicy
public CertificatePolicy getCertificatePolicy(String vaultBaseUrl, String certificateName)
証明書のポリシーを取得します。
パラメーター:
戻り値:
getCertificatePolicyAsync
public ServiceFuture
証明書のポリシーを取得します。
パラメーター:
戻り値:
getKey
public KeyBundle getKey(String keyIdentifier)
格納されているキーの公開部分を取得します。 キーの取得操作は、すべてのキーの種類に適用できます。 要求されたキーが対称の場合、応答でキーマテリアルは解放されません。 承認: キー/取得アクセス許可が必要です。
パラメーター:
戻り値:
getKey
public KeyBundle getKey(String vaultBaseUrl, String keyName)
格納されているキーの公開部分を取得します。 キーの取得操作は、すべてのキーの種類に適用できます。 要求されたキーが対称の場合、応答でキーマテリアルは解放されません。 承認: キー/取得アクセス許可が必要です。
パラメーター:
戻り値:
getKey
public KeyBundle getKey(String vaultBaseUrl, String keyName, String keyVersion)
格納されているキーの公開部分を取得します。 キーの取得操作は、すべてのキーの種類に適用できます。 要求されたキーが対称の場合、応答でキーマテリアルは解放されません。 承認: キー/取得アクセス許可が必要です。
パラメーター:
戻り値:
getKeyAsync
public ServiceFuture
格納されているキーの公開部分を取得します。 キーの取得操作は、すべてのキーの種類に適用できます。 要求されたキーが対称の場合、応答でキーマテリアルは解放されません。 承認: キー/取得アクセス許可が必要です。
パラメーター:
戻り値:
getKeyAsync
public ServiceFuture
格納されているキーの公開部分を取得します。 キーの取得操作は、すべてのキーの種類に適用できます。 要求されたキーが対称の場合、応答でキーマテリアルは解放されません。 承認: キー/取得アクセス許可が必要です。
パラメーター:
戻り値:
getKeyAsync
public ServiceFuture
格納されているキーの公開部分を取得します。 キーの取得操作は、すべてのキーの種類に適用できます。 要求されたキーが対称の場合、応答でキーマテリアルは解放されません。 承認: キー/取得アクセス許可が必要です。
パラメーター:
戻り値:
getPendingCertificateSigningRequest
public String getPendingCertificateSigningRequest(String vaultBaseUrl, String certificateName)
保留中の証明書署名要求応答を取得します。
パラメーター:
戻り値:
getPendingCertificateSigningRequestAsync
public ServiceFuture
保留中の証明書署名要求応答を取得します。
パラメーター:
戻り値:
getSecret
public SecretBundle getSecret(String secretIdentifier)
指定されたキー コンテナーから指定されたシークレットを取得します。
パラメーター:
戻り値:
getSecret
public SecretBundle getSecret(String vaultBaseUrl, String secretName)
指定されたキー コンテナーから指定されたシークレットを取得します。
パラメーター:
戻り値:
getSecret
public SecretBundle getSecret(String vaultBaseUrl, String secretName, String secretVersion)
指定されたキー コンテナーから指定されたシークレットを取得します。
パラメーター:
戻り値:
getSecretAsync
public ServiceFuture
指定されたキー コンテナーから指定されたシークレットを取得します。
パラメーター:
戻り値:
getSecretAsync
public ServiceFuture
指定されたキー コンテナーから指定されたシークレットを取得します。
パラメーター:
戻り値:
getSecretAsync
public ServiceFuture
指定されたキー コンテナーから指定されたシークレットを取得します。
パラメーター:
戻り値:
httpClient
public OkHttpClient httpClient()
戻り値:
importCertificate
public CertificateBundle importCertificate(ImportCertificateRequest importCertificateRequest)
指定したコンテナーに証明書をインポートします。
パラメーター:
戻り値:
importCertificateAsync
public ServiceFuture
指定したコンテナーに証明書をインポートします。
パラメーター:
戻り値:
importKey
public KeyBundle importKey(ImportKeyRequest importKeyRequest)
外部で作成されたキーをインポートし、格納し、キーのパラメーターと属性をクライアントに返します。 キーのインポート操作は、任意の種類のキーを Azure Key Vaultにインポートするために使用できます。 名前付きのキーが既に存在する場合は、Azure Key Vault によりキーの新しいバージョンが作成されます。 承認: キー/インポートアクセス許可が必要です。
パラメーター:
戻り値:
importKeyAsync
public ServiceFuture
外部で作成されたキーをインポートし、格納し、キーのパラメーターと属性をクライアントに返します。 キーのインポート操作は、任意の種類のキーを Azure Key Vaultにインポートするために使用できます。 名前付きのキーが既に存在する場合は、Azure Key Vault によりキーの新しいバージョンが作成されます。 承認: キー/インポートアクセス許可が必要です。
パラメーター:
戻り値:
listCertificateIssuers
public PagedList
指定したコンテナーの証明書発行者を一覧表示します。
パラメーター:
戻り値:
listCertificateIssuers
public PagedList
指定したコンテナーの証明書発行者を一覧表示します。
パラメーター:
戻り値:
listCertificateIssuersAsync
public ServiceFuture
指定したコンテナーの証明書発行者を一覧表示します。
パラメーター:
戻り値:
listCertificateIssuersAsync
public ServiceFuture
指定したコンテナーの証明書発行者を一覧表示します。
パラメーター:
戻り値:
listCertificates
public PagedList
指定したコンテナー内の証明書を一覧表示します。
パラメーター:
戻り値:
listCertificates
public PagedList
指定したコンテナー内の証明書を一覧表示します。
パラメーター:
戻り値:
listCertificatesAsync
public ServiceFuture
指定したコンテナー内の証明書を一覧表示します。
パラメーター:
戻り値:
listCertificatesAsync
public ServiceFuture
指定したコンテナー内の証明書を一覧表示します。
パラメーター:
戻り値:
listCertificateVersions
public PagedList
証明書のバージョンを一覧表示します。
パラメーター:
戻り値:
listCertificateVersions
public PagedList
証明書のバージョンを一覧表示します。
パラメーター:
戻り値:
listCertificateVersionsAsync
public ServiceFuture
証明書のバージョンを一覧表示します。
パラメーター:
戻り値:
listCertificateVersionsAsync
public ServiceFuture
証明書のバージョンを一覧表示します。
パラメーター:
戻り値:
listKeys
public PagedList
指定したコンテナー内のキーを一覧表示します。
パラメーター:
戻り値:
listKeys
public PagedList
指定したコンテナー内のキーを一覧表示します。
パラメーター:
戻り値:
listKeysAsync
public ServiceFuture
指定したコンテナー内のキーを一覧表示します。
パラメーター:
戻り値:
listKeysAsync
public ServiceFuture
指定したコンテナー内のキーを一覧表示します。
パラメーター:
戻り値:
listKeyVersions
public PagedList
同じキー名を持つ個々のキー バージョンの一覧を取得します。 応答には完全なキー識別子、属性、タグが提供されます。 承認: キー/リストのアクセス許可が必要です。
パラメーター:
戻り値:
listKeyVersions
public PagedList
同じキー名を持つ個々のキー バージョンの一覧を取得します。 応答には完全なキー識別子、属性、タグが提供されます。 承認: キー/リストのアクセス許可が必要です。
パラメーター:
戻り値:
listKeyVersionsAsync
public ServiceFuture
同じキー名を持つ個々のキー バージョンの一覧を取得します。 応答には完全なキー識別子、属性、タグが提供されます。 承認: キー/リストのアクセス許可が必要です。
パラメーター:
戻り値:
listKeyVersionsAsync
public ServiceFuture
同じキー名を持つ個々のキー バージョンの一覧を取得します。 応答には完全なキー識別子、属性、タグが提供されます。 承認: キー/リストのアクセス許可が必要です。
パラメーター:
戻り値:
listSecrets
public PagedList
指定したコンテナー内のシークレットを一覧表示します。
パラメーター:
戻り値:
listSecrets
public PagedList
指定したコンテナー内のシークレットを一覧表示します。
パラメーター:
戻り値:
listSecretsAsync
public ServiceFuture
指定したコンテナー内のシークレットを一覧表示します。
パラメーター:
戻り値:
listSecretsAsync
public ServiceFuture
指定したコンテナー内のシークレットを一覧表示します。
パラメーター:
戻り値:
listSecretVersions
public PagedList
指定したシークレットのバージョンを一覧表示します。
パラメーター:
戻り値:
listSecretVersions
public PagedList
指定したシークレットのバージョンを一覧表示します。
パラメーター:
戻り値:
listSecretVersionsAsync
public ServiceFuture
指定したシークレットのバージョンを一覧表示します。
パラメーター:
戻り値:
listSecretVersionsAsync
public ServiceFuture
指定したシークレットのバージョンを一覧表示します。
パラメーター:
戻り値:
longRunningOperationRetryTimeout
public int longRunningOperationRetryTimeout()
実行時間の長い操作の再試行タイムアウトを秒単位で取得または設定します。 既定値は 30 です。
戻り値:
mergeCertificate
public CertificateBundle mergeCertificate(MergeCertificateRequest mergeCertificateRequest)
証明書または証明書チェーンを、サーバー上に存在するキー ペアとマージします。
パラメーター:
戻り値:
mergeCertificateAsync
public ServiceFuture
証明書または証明書チェーンを、サーバー上に存在するキー ペアとマージします。
パラメーター:
戻り値:
restClient
public RestClient restClient()
戻り値:
restoreKey
public KeyBundle restoreKey(String vaultBaseUrl, byte[] keyBundleBackup)
のバックアップ キーをコンテナーに復元します。
パラメーター:
戻り値:
restoreKeyAsync
public ServiceFuture
のバックアップ キーをコンテナーに復元します。
パラメーター:
戻り値:
retrofit
public Retrofit retrofit()
戻り値:
serializerAdapter
public SerializerAdapter serializerAdapter()
戻り値:
setCertificateContacts
public Contacts setCertificateContacts(String vaultBaseUrl, Contacts contacts)
指定したコンテナーの証明書の連絡先を設定します。
パラメーター:
戻り値:
setCertificateContactsAsync
public ServiceFuture
指定したコンテナーの証明書の連絡先を設定します。
パラメーター:
戻り値:
setCertificateIssuer
public IssuerBundle setCertificateIssuer(SetCertificateIssuerRequest setCertificateIssuerRequest)
指定したコンテナーの証明書の連絡先を設定します。
パラメーター:
戻り値:
setCertificateIssuerAsync
public ServiceFuture
指定したコンテナーの証明書の連絡先を設定します。
パラメーター:
戻り値:
setSecret
public SecretBundle setSecret(SetSecretRequest setSecretRequest)
指定したコンテナーにシークレットを設定します。
パラメーター:
戻り値:
setSecretAsync
public ServiceFuture
指定したコンテナーにシークレットを設定します。
パラメーター:
戻り値:
sign
public KeyOperationResult sign(String keyIdentifier, JsonWebKeySignatureAlgorithm algorithm, byte[] value)
指定したキーを使用してダイジェストから署名を作成します。
パラメーター:
戻り値:
signAsync
public ServiceFuture
指定したキーを使用してダイジェストから署名を作成します。
パラメーター:
戻り値:
unwrapKey
public KeyOperationResult unwrapKey(String keyIdentifier, JsonWebKeyEncryptionAlgorithm algorithm, byte[] value)
キーの折り返しに最初に使用されたコンテナー内の指定したキーを使用して、対称キーのラップを解除します。
パラメーター:
戻り値:
unwrapKeyAsync
public ServiceFuture
キーの折り返しに最初に使用されたコンテナー内の指定したキーを使用して、対称キーのラップを解除します。
パラメーター:
戻り値:
updateCertificate
public CertificateBundle updateCertificate(UpdateCertificateRequest updateCertificateRequest)
指定した証明書に関連付けられている属性を更新します。
パラメーター:
戻り値:
updateCertificateAsync
public ServiceFuture
指定した証明書に関連付けられている属性を更新します。
パラメーター:
戻り値:
updateCertificateIssuer
public IssuerBundle updateCertificateIssuer(UpdateCertificateIssuerRequest updateCertificateIssuerRequest)
指定した証明書発行者を更新します。
パラメーター:
戻り値:
updateCertificateIssuerAsync
public ServiceFuture
指定した証明書発行者を更新します。
パラメーター:
戻り値:
スロー:
updateCertificateOperation
public CertificateOperation updateCertificateOperation(UpdateCertificateOperationRequest updateCertificateOperationRequest)
証明書操作を更新します。
パラメーター:
戻り値:
updateCertificateOperationAsync
public ServiceFuture
証明書操作を更新します。
パラメーター:
戻り値:
updateCertificatePolicy
public CertificatePolicy updateCertificatePolicy(UpdateCertificatePolicyRequest updateCertificatePolicyRequest)
証明書のポリシーを更新します。 certificatePolicy で、更新する必要がある適切なメンバーを設定します。 他のユーザーは null のままにします。
パラメーター:
戻り値:
updateCertificatePolicyAsync
public ServiceFuture
証明書のポリシーを更新します。 certificatePolicy で、更新する必要がある適切なメンバーを設定します。 他のユーザーは null のままにします。
パラメーター:
戻り値:
updateKey
public KeyBundle updateKey(UpdateKeyRequest updateKeyRequest)
更新キー操作は、格納されているキーの指定された属性を変更し、Azure Key Vaultに格納されている任意のキーの種類とキーのバージョンに適用できます。 キー自体の暗号化マテリアルは変更できません。 この操作を実行するには、キーが Key Vault に既に存在している必要があります。 承認: キー/更新アクセス許可が必要です。
パラメーター:
戻り値:
updateKeyAsync
public ServiceFuture
更新キー操作は、格納されているキーの指定された属性を変更し、Azure Key Vaultに格納されている任意のキーの種類とキーのバージョンに適用できます。 キー自体の暗号化マテリアルは変更できません。 この操作を実行するには、キーが Key Vault に既に存在している必要があります。 承認: キー/更新アクセス許可が必要です。
パラメーター:
戻り値:
updateSecret
public SecretBundle updateSecret(UpdateSecretRequest updateSecretRequest)
特定のキー コンテナー内の指定したシークレットに関連付けられている属性を更新します。
パラメーター:
戻り値:
updateSecretAsync
public ServiceFuture
特定のキー コンテナー内の指定したシークレットに関連付けられている属性を更新します。
パラメーター:
戻り値:
userAgent
public String userAgent()
クライアントの User-Agent ヘッダーを取得します。
戻り値:
verify
public KeyVerifyResult verify(String keyIdentifier, JsonWebKeySignatureAlgorithm algorithm, byte[] digest, byte[] signature)
指定したキーを使用して署名を検証します。
パラメーター:
戻り値:
verifyAsync
public ServiceFuture
指定したキーを使用して署名を検証します。
パラメーター:
戻り値:
withAcceptLanguage
public void withAcceptLanguage(String acceptLanguage)
応答の優先言語を取得または設定します。
パラメーター:
withGenerateClientRequestId
public void withGenerateClientRequestId(boolean generateClientRequestId)
True に設定すると、一意の x-ms-client-request-id 値が生成され、各要求に含められます。 既定値は true です。
パラメーター:
withLongRunningOperationRetryTimeout
public void withLongRunningOperationRetryTimeout(int longRunningOperationRetryTimeout)
実行時間の長い操作の再試行タイムアウトを秒単位で取得または設定します。 既定値は 30 です。
パラメーター:
wrapKey
public KeyOperationResult wrapKey(String keyIdentifier, JsonWebKeyEncryptionAlgorithm algorithm, byte[] value)
指定したキーを使用して対称キーをラップします。
パラメーター:
戻り値:
wrapKeyAsync
public ServiceFuture
指定したキーを使用して対称キーをラップします。
パラメーター:
戻り値:
適用対象
Azure SDK for Java