KeyVaultClient 类

public KeyVaultClient(RestClient restClient)

初始化 KeyVaultClient 客户端的实例。

参数:

public KeyVaultClient(ServiceClientCredentials credentials)

初始化 KeyVaultClient 客户端的实例。

参数:

public String acceptLanguage()

获取或设置响应的首选语言。

返回:

public String apiVersion()

获取客户端 API 版本。

返回:

public BackupKeyResult backupKey(String vaultBaseUrl, String keyName)

请求将指定密钥的备份下载到客户端。

参数:

返回:

public ServiceFuture backupKeyAsync(String vaultBaseUrl, String keyName, final ServiceCallback serviceCallback)

请求将指定密钥的备份下载到客户端。

参数:

返回:

public CertificateOperation createCertificate(CreateCertificateRequest createCertificateRequest)

创建新的证书版本。 如果这是第一个版本，则会创建证书资源。

参数:

返回:

public ServiceFuture createCertificateAsync(CreateCertificateRequest createCertificateRequest, final ServiceCallback serviceCallback)

创建新的证书版本。 如果这是第一个版本，则会创建证书资源。

参数:

返回:

public KeyBundle createKey(CreateKeyRequest createKeyRequest)

创建一个新密钥，存储该密钥，然后向客户端返回密钥参数和属性。 创建密钥操作可用于在 Azure 密钥保管库中创建任何密钥类型。 如果命名的密钥已存在，Azure 密钥保管库将创建该密钥的新版本。 授权：需要密钥/创建权限。

参数:

返回:

public ServiceFuture createKeyAsync(CreateKeyRequest createKeyRequest, ServiceCallback serviceCallback)

创建一个新密钥，存储该密钥，然后向客户端返回密钥参数和属性。 创建密钥操作可用于在 Azure 密钥保管库中创建任何密钥类型。 如果命名的密钥已存在，Azure 密钥保管库将创建该密钥的新版本。 授权：需要密钥/创建权限。

参数:

返回:

public KeyOperationResult decrypt(String keyIdentifier, JsonWebKeyEncryptionAlgorithm algorithm, byte[] value)

解密单个加密数据块。

参数:

返回:

public ServiceFuture decryptAsync(String keyIdentifier, JsonWebKeyEncryptionAlgorithm algorithm, byte[] value, final ServiceCallback serviceCallback)

解密单个加密数据块。

参数:

返回:

public CertificateBundle deleteCertificate(String vaultBaseUrl, String certificateName)

从指定的保管库中删除证书。

参数:

返回:

public ServiceFuture deleteCertificateAsync(String vaultBaseUrl, String certificateName, final ServiceCallback serviceCallback)

从指定的保管库中删除证书。

参数:

返回:

public Contacts deleteCertificateContacts(String vaultBaseUrl)

删除指定保管库的证书联系人。

参数:

返回:

public ServiceFuture deleteCertificateContactsAsync(String vaultBaseUrl, final ServiceCallback serviceCallback)

删除指定保管库的证书联系人。

参数:

返回:

public IssuerBundle deleteCertificateIssuer(String vaultBaseUrl, String issuerName)

删除指定的证书颁发者。

参数:

返回:

public ServiceFuture deleteCertificateIssuerAsync(String vaultBaseUrl, String issuerName, final ServiceCallback serviceCallback)

删除指定的证书颁发者。

参数:

返回:

public CertificateOperation deleteCertificateOperation(String vaultBaseUrl, String certificateName)

删除指定证书的操作。

参数:

返回:

public ServiceFuture deleteCertificateOperationAsync(String vaultBaseUrl, String certificateName, final ServiceCallback serviceCallback)

删除指定证书的操作。

参数:

返回:

public KeyBundle deleteKey(String vaultBaseUrl, String keyName)

从 Azure 密钥保管库 中的存储中删除任何类型的密钥。 删除密钥操作不能用于删除单个版本的密钥。 此操作将删除与密钥关联的加密材料，也就是说，该密钥不可用于签名/验证、包装/解包或加密/解密操作。 授权：需要密钥/删除权限。

参数:

返回:

public ServiceFuture deleteKeyAsync(String vaultBaseUrl, String keyName, final ServiceCallback serviceCallback)

从 Azure 密钥保管库 中的存储中删除任何类型的密钥。 删除密钥操作不能用于删除单个版本的密钥。 此操作将删除与密钥关联的加密材料，也就是说，该密钥不可用于签名/验证、包装/解包或加密/解密操作。 授权：需要密钥/删除权限。

参数:

返回:

public SecretBundle deleteSecret(String vaultBaseUrl, String secretName)

从指定的保管库中删除机密。

参数:

返回:

public ServiceFuture deleteSecretAsync(String vaultBaseUrl, String secretName, final ServiceCallback serviceCallback)

从指定的保管库中删除机密。

参数:

返回:

public KeyOperationResult encrypt(String keyIdentifier, JsonWebKeyEncryptionAlgorithm algorithm, byte[] value)

使用存储在密钥保管库中的加密密钥加密任意字节序列。

参数:

返回:

public ServiceFuture encryptAsync(String keyIdentifier, JsonWebKeyEncryptionAlgorithm algorithm, byte[] value, final ServiceCallback serviceCallback)

使用存储在密钥保管库中的加密密钥加密任意字节序列。

参数:

返回:

public boolean generateClientRequestId()

获取当设置为 true 时，将生成唯一的 x-ms-client-request-id 值并将其包含在每个请求中。 默认为 true。

返回:

public AzureClient getAzureClient()

获取 AzureClient 用于长时间运行的操作的 。

返回:

public CertificateBundle getCertificate(String certificateIdentifier)

获取有关指定证书的信息。

参数:

返回:

public CertificateBundle getCertificate(String vaultBaseUrl, String certificateName)

获取有关指定证书的信息。

参数:

返回:

public CertificateBundle getCertificate(String vaultBaseUrl, String certificateName, String certificateVersion)

获取有关指定证书的信息。

参数:

返回:

public ServiceFuture getCertificateAsync(String certificateIdentifier, final ServiceCallback serviceCallback)

获取有关指定证书的信息。

参数:

返回:

public ServiceFuture getCertificateAsync(String vaultBaseUrl, String certificateName, final ServiceCallback serviceCallback)

获取有关指定证书的信息。

参数:

返回:

public ServiceFuture getCertificateAsync(String vaultBaseUrl, String certificateName, String certificateVersion, final ServiceCallback serviceCallback)

获取有关指定证书的信息。

参数:

返回:

public Contacts getCertificateContacts(String vaultBaseUrl)

获取指定保管库的证书联系人。

参数:

返回:

public ServiceFuture getCertificateContactsAsync(String vaultBaseUrl, final ServiceCallback serviceCallback)

获取指定保管库的证书联系人。

参数:

返回:

public IssuerBundle getCertificateIssuer(String vaultBaseUrl, String issuerName)

获取指定的证书颁发者。

参数:

返回:

public ServiceFuture getCertificateIssuerAsync(String vaultBaseUrl, String issuerName, final ServiceCallback serviceCallback)

获取指定的证书颁发者。

参数:

返回:

public CertificateOperation getCertificateOperation(String vaultBaseUrl, String certificateName)

获取与指定证书关联的操作。

参数:

返回:

public ServiceFuture getCertificateOperationAsync(String vaultBaseUrl, String certificateName, final ServiceCallback serviceCallback)

获取与指定证书关联的操作。

参数:

返回:

public CertificatePolicy getCertificatePolicy(String vaultBaseUrl, String certificateName)

获取证书的策略。

参数:

返回:

public ServiceFuture getCertificatePolicyAsync(String vaultBaseUrl, String certificateName, final ServiceCallback serviceCallback)

获取证书的策略。

参数:

返回:

public KeyBundle getKey(String keyIdentifier)

获取存储密钥的公共部分。 获取密钥操作适用于所有密钥类型。 如果请求的密钥是对称的，则响应中不会释放任何密钥材料。 授权：需要密钥/获取权限。

参数:

返回:

public KeyBundle getKey(String vaultBaseUrl, String keyName)

获取存储密钥的公共部分。 获取密钥操作适用于所有密钥类型。 如果请求的密钥是对称的，则响应中不会释放任何密钥材料。 授权：需要密钥/获取权限。

参数:

返回:

public KeyBundle getKey(String vaultBaseUrl, String keyName, String keyVersion)

获取存储密钥的公共部分。 获取密钥操作适用于所有密钥类型。 如果请求的密钥是对称的，则响应中不会释放任何密钥材料。 授权：需要密钥/获取权限。

参数:

返回:

public ServiceFuture getKeyAsync(String keyIdentifier, final ServiceCallback serviceCallback)

获取存储密钥的公共部分。 获取密钥操作适用于所有密钥类型。 如果请求的密钥是对称的，则响应中不会释放任何密钥材料。 授权：需要密钥/获取权限。

参数:

返回:

public ServiceFuture getKeyAsync(String vaultBaseUrl, String keyName, final ServiceCallback serviceCallback)

获取存储密钥的公共部分。 获取密钥操作适用于所有密钥类型。 如果请求的密钥是对称的，则响应中不会释放任何密钥材料。 授权：需要密钥/获取权限。

参数:

返回:

public ServiceFuture getKeyAsync(String vaultBaseUrl, String keyName, String keyVersion, final ServiceCallback serviceCallback)

获取存储密钥的公共部分。 获取密钥操作适用于所有密钥类型。 如果请求的密钥是对称的，则响应中不会释放任何密钥材料。 授权：需要密钥/获取权限。

参数:

返回:

public String getPendingCertificateSigningRequest(String vaultBaseUrl, String certificateName)

获取挂起的证书签名请求响应。

参数:

返回:

public ServiceFuture getPendingCertificateSigningRequestAsync(String vaultBaseUrl, String certificateName, final ServiceCallback serviceCallback)

获取挂起的证书签名请求响应。

参数:

返回:

public SecretBundle getSecret(String secretIdentifier)

从给定密钥保管库获取指定的机密。

参数:

返回:

public SecretBundle getSecret(String vaultBaseUrl, String secretName)

从给定密钥保管库获取指定的机密。

参数:

返回:

public SecretBundle getSecret(String vaultBaseUrl, String secretName, String secretVersion)

从给定密钥保管库获取指定的机密。

参数:

返回:

public ServiceFuture getSecretAsync(String secretIdentifier, final ServiceCallback serviceCallback)

从给定密钥保管库获取指定的机密。

参数:

返回:

public ServiceFuture getSecretAsync(String vaultBaseUrl, String secretName, final ServiceCallback serviceCallback)

从给定密钥保管库获取指定的机密。

参数:

返回:

public ServiceFuture getSecretAsync(String vaultBaseUrl, String secretName, String secretVersion, final ServiceCallback serviceCallback)

从给定密钥保管库获取指定的机密。

参数:

返回:

public OkHttpClient httpClient()

返回:

public CertificateBundle importCertificate(ImportCertificateRequest importCertificateRequest)

将证书导入指定的保管库。

参数:

返回:

public ServiceFuture importCertificateAsync(ImportCertificateRequest importCertificateRequest, final ServiceCallback serviceCallback)

将证书导入指定的保管库。

参数:

返回:

public KeyBundle importKey(ImportKeyRequest importKeyRequest)

导入外部创建的密钥，存储它，然后将密钥参数和属性返回给客户端。 导入密钥操作可用于将任何密钥类型导入 Azure 密钥保管库。 如果命名的密钥已存在，Azure 密钥保管库将创建该密钥的新版本。 授权：需要密钥/导入权限。

参数:

返回:

public ServiceFuture importKeyAsync(ImportKeyRequest importKeyRequest, final ServiceCallback serviceCallback)

导入外部创建的密钥，存储它，然后将密钥参数和属性返回给客户端。 导入密钥操作可用于将任何密钥类型导入 Azure 密钥保管库。 如果命名的密钥已存在，Azure 密钥保管库将创建该密钥的新版本。 授权：需要密钥/导入权限。

参数:

返回:

public PagedList listCertificateIssuers(final String vaultBaseUrl)

列出指定保管库的证书颁发者。

参数:

返回:

public PagedList listCertificateIssuers(final String vaultBaseUrl, final Integer maxresults)

列出指定保管库的证书颁发者。

参数:

返回:

public ServiceFuture> listCertificateIssuersAsync(final String vaultBaseUrl, final Integer maxresults, final ListOperationCallback serviceCallback)

列出指定保管库的证书颁发者。

参数:

返回:

public ServiceFuture> listCertificateIssuersAsync(final String vaultBaseUrl, final ListOperationCallback serviceCallback)

列出指定保管库的证书颁发者。

参数:

返回:

public PagedList listCertificates(final String vaultBaseUrl)

列出指定保管库中的证书。

参数:

返回:

public PagedList listCertificates(final String vaultBaseUrl, final Integer maxresults)

列出指定保管库中的证书。

参数:

返回:

public ServiceFuture> listCertificatesAsync(final String vaultBaseUrl, final Integer maxresults, final ListOperationCallback serviceCallback)

列出指定保管库中的证书。

参数:

返回:

public ServiceFuture> listCertificatesAsync(final String vaultBaseUrl, final ListOperationCallback serviceCallback)

列出指定保管库中的证书。

参数:

返回:

public PagedList listCertificateVersions(final String vaultBaseUrl, final String certificateName)

列出证书的版本。

参数:

返回:

public PagedList listCertificateVersions(final String vaultBaseUrl, final String certificateName, final Integer maxresults)

列出证书的版本。

参数:

返回:

public ServiceFuture> listCertificateVersionsAsync(final String vaultBaseUrl, final String certificateName, final Integer maxresults, final ListOperationCallback serviceCallback)

列出证书的版本。

参数:

返回:

public ServiceFuture> listCertificateVersionsAsync(final String vaultBaseUrl, final String certificateName, final ListOperationCallback serviceCallback)

列出证书的版本。

参数:

返回:

public PagedList listKeys(final String vaultBaseUrl)

列出指定保管库中的密钥。

参数:

返回:

public PagedList listKeys(final String vaultBaseUrl, final Integer maxresults)

列出指定保管库中的密钥。

参数:

返回:

public ServiceFuture> listKeysAsync(final String vaultBaseUrl, final Integer maxresults, final ListOperationCallback serviceCallback)

列出指定保管库中的密钥。

参数:

返回:

public ServiceFuture> listKeysAsync(final String vaultBaseUrl, final ListOperationCallback serviceCallback)

列出指定保管库中的密钥。

参数:

返回:

public PagedList listKeyVersions(final String vaultBaseUrl, final String keyName)

检索具有相同密钥名称的各个密钥版本的列表。 响应中提供了完整密钥标识符、属性和标记。 授权：需要密钥/列表权限。

参数:

返回:

public PagedList listKeyVersions(final String vaultBaseUrl, final String keyName, final Integer maxresults)

检索具有相同密钥名称的各个密钥版本的列表。 响应中提供了完整密钥标识符、属性和标记。 授权：需要密钥/列表权限。

参数:

返回:

public ServiceFuture> listKeyVersionsAsync(final String vaultBaseUrl, final String keyName, final Integer maxresults, final ListOperationCallback serviceCallback)

检索具有相同密钥名称的各个密钥版本的列表。 响应中提供了完整密钥标识符、属性和标记。 授权：需要密钥/列表权限。

参数:

返回:

public ServiceFuture> listKeyVersionsAsync(final String vaultBaseUrl, final String keyName, final ListOperationCallback serviceCallback)

检索具有相同密钥名称的各个密钥版本的列表。 响应中提供了完整密钥标识符、属性和标记。 授权：需要密钥/列表权限。

参数:

返回:

public PagedList listSecrets(final String vaultBaseUrl)

列出指定保管库中的机密。

参数:

返回:

public PagedList listSecrets(final String vaultBaseUrl, final Integer maxresults)

列出指定保管库中的机密。

参数:

返回:

public ServiceFuture> listSecretsAsync(final String vaultBaseUrl, final Integer maxresults, final ListOperationCallback serviceCallback)

列出指定保管库中的机密。

参数:

返回:

public ServiceFuture> listSecretsAsync(final String vaultBaseUrl, final ListOperationCallback serviceCallback)

列出指定保管库中的机密。

参数:

返回:

public PagedList listSecretVersions(final String vaultBaseUrl, final String secretName)

列出指定机密的版本。

参数:

返回:

public PagedList listSecretVersions(final String vaultBaseUrl, final String secretName, final Integer maxresults)

列出指定机密的版本。

参数:

返回:

public ServiceFuture> listSecretVersionsAsync(final String vaultBaseUrl, final String secretName, final Integer maxresults, final ListOperationCallback serviceCallback)

列出指定机密的版本。

参数:

返回:

public ServiceFuture> listSecretVersionsAsync(final String vaultBaseUrl, final String secretName, final ListOperationCallback serviceCallback)

列出指定机密的版本。

参数:

返回:

public int longRunningOperationRetryTimeout()

获取或设置长时间运行操作的重试超时（以秒为单位）。 默认值为 30。

返回:

public CertificateBundle mergeCertificate(MergeCertificateRequest mergeCertificateRequest)

将证书或证书链与服务器上存在的密钥对合并。

参数:

返回:

public ServiceFuture mergeCertificateAsync(MergeCertificateRequest mergeCertificateRequest, final ServiceCallback serviceCallback)

将证书或证书链与服务器上存在的密钥对合并。

参数:

返回:

public RestClient restClient()

返回:

public KeyBundle restoreKey(String vaultBaseUrl, byte[] keyBundleBackup)

将 中的备份密钥还原到保管库。

参数:

返回:

public ServiceFuture restoreKeyAsync(String vaultBaseUrl, byte[] keyBundleBackup, final ServiceCallback serviceCallback)

将 中的备份密钥还原到保管库。

参数:

返回:

public Retrofit retrofit()

返回:

public SerializerAdapter serializerAdapter()

返回:

public Contacts setCertificateContacts(String vaultBaseUrl, Contacts contacts)

设置指定保管库的证书联系人。

参数:

返回:

public ServiceFuture setCertificateContactsAsync(String vaultBaseUrl, Contacts contacts, final ServiceCallback serviceCallback)

设置指定保管库的证书联系人。

参数:

返回:

public IssuerBundle setCertificateIssuer(SetCertificateIssuerRequest setCertificateIssuerRequest)

设置指定保管库的证书联系人。

参数:

返回:

public ServiceFuture setCertificateIssuerAsync(SetCertificateIssuerRequest setCertificateIssuerRequest, final ServiceCallback serviceCallback)

设置指定保管库的证书联系人。

参数:

返回:

public SecretBundle setSecret(SetSecretRequest setSecretRequest)

在指定的保管库中设置机密。

参数:

返回:

public ServiceFuture setSecretAsync(SetSecretRequest setSecretRequest, final ServiceCallback serviceCallback)

在指定的保管库中设置机密。

参数:

返回:

public KeyOperationResult sign(String keyIdentifier, JsonWebKeySignatureAlgorithm algorithm, byte[] value)

使用指定的键从摘要创建签名。

参数:

返回:

public ServiceFuture signAsync(String keyIdentifier, JsonWebKeySignatureAlgorithm algorithm, byte[] value, final ServiceCallback serviceCallback)

使用指定的键从摘要创建签名。

参数:

返回:

public KeyOperationResult unwrapKey(String keyIdentifier, JsonWebKeyEncryptionAlgorithm algorithm, byte[] value)

使用保管库中最初用于包装密钥的指定密钥来解包对称密钥。

参数:

返回:

public ServiceFuture unwrapKeyAsync(String keyIdentifier, JsonWebKeyEncryptionAlgorithm algorithm, byte[] value, final ServiceCallback serviceCallback)

使用保管库中最初用于包装密钥的指定密钥来解包对称密钥。

参数:

返回:

public CertificateBundle updateCertificate(UpdateCertificateRequest updateCertificateRequest)

汇报与指定证书关联的属性。

参数:

返回:

public ServiceFuture updateCertificateAsync(UpdateCertificateRequest updateCertificateRequest, final ServiceCallback serviceCallback)

汇报与指定证书关联的属性。

参数:

返回:

public IssuerBundle updateCertificateIssuer(UpdateCertificateIssuerRequest updateCertificateIssuerRequest)

汇报指定的证书颁发者。

参数:

返回:

public ServiceFuture updateCertificateIssuerAsync(UpdateCertificateIssuerRequest updateCertificateIssuerRequest, final ServiceCallback serviceCallback)

汇报指定的证书颁发者。

参数:

返回:

引发:

public CertificateOperation updateCertificateOperation(UpdateCertificateOperationRequest updateCertificateOperationRequest)

汇报证书操作。

参数:

返回:

public ServiceFuture updateCertificateOperationAsync(UpdateCertificateOperationRequest updateCertificateOperationRequest, final ServiceCallback serviceCallback)

汇报证书操作。

参数:

返回:

public CertificatePolicy updateCertificatePolicy(UpdateCertificatePolicyRequest updateCertificatePolicyRequest)

汇报证书的策略。 在 certificatePolicy 中设置必须更新的相应成员。 将其他人保留为 null。

参数:

返回:

public ServiceFuture updateCertificatePolicyAsync(UpdateCertificatePolicyRequest updateCertificatePolicyRequest, final ServiceCallback serviceCallback)

汇报证书的策略。 在 certificatePolicy 中设置必须更新的相应成员。 将其他人保留为 null。

参数:

返回:

public KeyBundle updateKey(UpdateKeyRequest updateKeyRequest)

更新密钥操作会更改存储密钥的指定属性，并可以应用于 Azure 密钥保管库中存储的任何密钥类型和密钥版本。 不能更改密钥本身的加密材料。 若要执行此操作，该密钥必须已存在于密钥保管库中。 授权：需要密钥/更新权限。

参数:

返回:

public ServiceFuture updateKeyAsync(UpdateKeyRequest updateKeyRequest, final ServiceCallback serviceCallback)

更新密钥操作会更改存储密钥的指定属性，并可以应用于 Azure 密钥保管库中存储的任何密钥类型和密钥版本。 不能更改密钥本身的加密材料。 若要执行此操作，该密钥必须已存在于密钥保管库中。 授权：需要密钥/更新权限。

参数:

返回:

public SecretBundle updateSecret(UpdateSecretRequest updateSecretRequest)

汇报与给定密钥保管库中的指定机密关联的属性。

参数:

返回:

public ServiceFuture updateSecretAsync(UpdateSecretRequest updateSecretRequest, final ServiceCallback serviceCallback)

汇报与给定密钥保管库中的指定机密关联的属性。

参数:

返回:

public String userAgent()

获取客户端的 User-Agent 标头。

返回:

public KeyVerifyResult verify(String keyIdentifier, JsonWebKeySignatureAlgorithm algorithm, byte[] digest, byte[] signature)

使用指定的密钥验证签名。

参数:

返回:

public ServiceFuture verifyAsync(String keyIdentifier, JsonWebKeySignatureAlgorithm algorithm, byte[] digest, byte[] signature, final ServiceCallback serviceCallback)

使用指定的密钥验证签名。

参数:

返回:

public void withAcceptLanguage(String acceptLanguage)

设置 获取或设置响应的首选语言。

参数:

public void withGenerateClientRequestId(boolean generateClientRequestId)

设置 当设置为 true 时，将生成唯一的 x-ms-client-request-id 值并将其包含在每个请求中。 默认为 true。

参数:

public void withLongRunningOperationRetryTimeout(int longRunningOperationRetryTimeout)

设置 获取或设置长时间运行操作的重试超时（以秒为单位）。 默认值为 30。

参数:

public KeyOperationResult wrapKey(String keyIdentifier, JsonWebKeyEncryptionAlgorithm algorithm, byte[] value)

使用指定的密钥包装对称密钥。

参数:

返回:

public ServiceFuture wrapKeyAsync(String keyIdentifier, JsonWebKeyEncryptionAlgorithm algorithm, byte[] value, final ServiceCallback serviceCallback)

使用指定的密钥包装对称密钥。

参数:

返回: