你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn 。
KeyVaultClient 类
java.lang.Object
com.microsoft.azure.keyvault.KeyVaultClient
public class KeyVaultClient
初始化 KeyVaultClient 类的新实例。
构造函数摘要
方法摘要
修饰符和类型
方法和描述
String
acceptLanguage()
获取或设置响应的首选语言。
String
apiVersion()
获取客户端 API 版本。
BackupKeyResult
backupKey(String vaultBaseUrl, String keyName)
请求将指定密钥的备份下载到客户端。
ServiceFuture<BackupKeyResult >
backupKeyAsync(String vaultBaseUrl, String keyName, final ServiceCallback<BackupKeyResult> serviceCallback)
请求将指定密钥的备份下载到客户端。
CertificateOperation
createCertificate(CreateCertificateRequest createCertificateRequest)
创建新的证书版本。 如果这是第一个版本,则会创建证书资源。
ServiceFuture<CertificateOperation >
createCertificateAsync(CreateCertificateRequest createCertificateRequest, final ServiceCallback<CertificateOperation> serviceCallback)
创建新的证书版本。 如果这是第一个版本,则会创建证书资源。
KeyBundle
createKey(CreateKeyRequest createKeyRequest)
创建一个新密钥,存储该密钥,然后向客户端返回密钥参数和属性。 创建密钥操作可用于在 Azure 密钥保管库中创建任何密钥类型。 如果命名的密钥已存在,Azure 密钥保管库将创建该密钥的新版本。 授权:需要密钥/创建权限。
ServiceFuture<KeyBundle >
createKeyAsync(CreateKeyRequest createKeyRequest, ServiceCallback<KeyBundle> serviceCallback)
创建一个新密钥,存储该密钥,然后向客户端返回密钥参数和属性。 创建密钥操作可用于在 Azure 密钥保管库中创建任何密钥类型。 如果命名的密钥已存在,Azure 密钥保管库将创建该密钥的新版本。 授权:需要密钥/创建权限。
KeyOperationResult
decrypt(String keyIdentifier, JsonWebKeyEncryptionAlgorithm algorithm, byte[] value)
解密单个加密数据块。
ServiceFuture<KeyOperationResult >
decryptAsync(String keyIdentifier, JsonWebKeyEncryptionAlgorithm algorithm, byte[] value, final ServiceCallback<KeyOperationResult> serviceCallback)
解密单个加密数据块。
CertificateBundle
deleteCertificate(String vaultBaseUrl, String certificateName)
从指定的保管库中删除证书。
ServiceFuture<CertificateBundle >
deleteCertificateAsync(String vaultBaseUrl, String certificateName, final ServiceCallback<CertificateBundle> serviceCallback)
从指定的保管库中删除证书。
Contacts
deleteCertificateContacts(String vaultBaseUrl)
删除指定保管库的证书联系人。
ServiceFuture<Contacts >
deleteCertificateContactsAsync(String vaultBaseUrl, final ServiceCallback<Contacts> serviceCallback)
删除指定保管库的证书联系人。
IssuerBundle
deleteCertificateIssuer(String vaultBaseUrl, String issuerName)
删除指定的证书颁发者。
ServiceFuture<IssuerBundle >
deleteCertificateIssuerAsync(String vaultBaseUrl, String issuerName, final ServiceCallback<IssuerBundle> serviceCallback)
删除指定的证书颁发者。
CertificateOperation
deleteCertificateOperation(String vaultBaseUrl, String certificateName)
删除指定证书的操作。
ServiceFuture<CertificateOperation >
deleteCertificateOperationAsync(String vaultBaseUrl, String certificateName, final ServiceCallback<CertificateOperation> serviceCallback)
删除指定证书的操作。
KeyBundle
deleteKey(String vaultBaseUrl, String keyName)
从 Azure 密钥保管库 中的存储中删除任何类型的密钥。 删除密钥操作不能用于删除单个版本的密钥。 此操作将删除与密钥关联的加密材料,也就是说,该密钥不可用于签名/验证、包装/解包或加密/解密操作。 授权:需要密钥/删除权限。
ServiceFuture<KeyBundle >
deleteKeyAsync(String vaultBaseUrl, String keyName, final ServiceCallback<KeyBundle> serviceCallback)
从 Azure 密钥保管库 中的存储中删除任何类型的密钥。 删除密钥操作不能用于删除单个版本的密钥。 此操作将删除与密钥关联的加密材料,也就是说,该密钥不可用于签名/验证、包装/解包或加密/解密操作。 授权:需要密钥/删除权限。
SecretBundle
deleteSecret(String vaultBaseUrl, String secretName)
从指定的保管库中删除机密。
ServiceFuture<SecretBundle >
deleteSecretAsync(String vaultBaseUrl, String secretName, final ServiceCallback<SecretBundle> serviceCallback)
从指定的保管库中删除机密。
KeyOperationResult
encrypt(String keyIdentifier, JsonWebKeyEncryptionAlgorithm algorithm, byte[] value)
使用存储在密钥保管库中的加密密钥加密任意字节序列。
ServiceFuture<KeyOperationResult >
encryptAsync(String keyIdentifier, JsonWebKeyEncryptionAlgorithm algorithm, byte[] value, final ServiceCallback<KeyOperationResult> serviceCallback)
使用存储在密钥保管库中的加密密钥加密任意字节序列。
boolean
generateClientRequestId()
获取当设置为 true 时,将生成唯一的 x-ms-client-request-id 值并将其包含在每个请求中。 默认为 true。
AzureClient
getAzureClient()
获取 AzureClient 用于长时间运行的操作的 。
CertificateBundle
getCertificate(String certificateIdentifier)
获取有关指定证书的信息。
CertificateBundle
getCertificate(String vaultBaseUrl, String certificateName)
获取有关指定证书的信息。
CertificateBundle
getCertificate(String vaultBaseUrl, String certificateName, String certificateVersion)
获取有关指定证书的信息。
ServiceFuture<CertificateBundle >
getCertificateAsync(String certificateIdentifier, final ServiceCallback<CertificateBundle> serviceCallback)
获取有关指定证书的信息。
ServiceFuture<CertificateBundle >
getCertificateAsync(String vaultBaseUrl, String certificateName, final ServiceCallback<CertificateBundle> serviceCallback)
获取有关指定证书的信息。
ServiceFuture<CertificateBundle >
getCertificateAsync(String vaultBaseUrl, String certificateName, String certificateVersion, final ServiceCallback<CertificateBundle> serviceCallback)
获取有关指定证书的信息。
Contacts
getCertificateContacts(String vaultBaseUrl)
获取指定保管库的证书联系人。
ServiceFuture<Contacts >
getCertificateContactsAsync(String vaultBaseUrl, final ServiceCallback<Contacts> serviceCallback)
获取指定保管库的证书联系人。
IssuerBundle
getCertificateIssuer(String vaultBaseUrl, String issuerName)
获取指定的证书颁发者。
ServiceFuture<IssuerBundle >
getCertificateIssuerAsync(String vaultBaseUrl, String issuerName, final ServiceCallback<IssuerBundle> serviceCallback)
获取指定的证书颁发者。
CertificateOperation
getCertificateOperation(String vaultBaseUrl, String certificateName)
获取与指定证书关联的操作。
ServiceFuture<CertificateOperation >
getCertificateOperationAsync(String vaultBaseUrl, String certificateName, final ServiceCallback<CertificateOperation> serviceCallback)
获取与指定证书关联的操作。
CertificatePolicy
getCertificatePolicy(String vaultBaseUrl, String certificateName)
获取证书的策略。
ServiceFuture<CertificatePolicy >
getCertificatePolicyAsync(String vaultBaseUrl, String certificateName, final ServiceCallback<CertificatePolicy> serviceCallback)
获取证书的策略。
KeyBundle
getKey(String keyIdentifier)
获取存储密钥的公共部分。 获取密钥操作适用于所有密钥类型。 如果请求的密钥是对称的,则响应中不会释放任何密钥材料。 授权:需要密钥/获取权限。
KeyBundle
getKey(String vaultBaseUrl, String keyName)
获取存储密钥的公共部分。 获取密钥操作适用于所有密钥类型。 如果请求的密钥是对称的,则响应中不会释放任何密钥材料。 授权:需要密钥/获取权限。
KeyBundle
getKey(String vaultBaseUrl, String keyName, String keyVersion)
获取存储密钥的公共部分。 获取密钥操作适用于所有密钥类型。 如果请求的密钥是对称的,则响应中不会释放任何密钥材料。 授权:需要密钥/获取权限。
ServiceFuture<KeyBundle >
getKeyAsync(String keyIdentifier, final ServiceCallback<KeyBundle> serviceCallback)
获取存储密钥的公共部分。 获取密钥操作适用于所有密钥类型。 如果请求的密钥是对称的,则响应中不会释放任何密钥材料。 授权:需要密钥/获取权限。
ServiceFuture<KeyBundle >
getKeyAsync(String vaultBaseUrl, String keyName, final ServiceCallback<KeyBundle> serviceCallback)
获取存储密钥的公共部分。 获取密钥操作适用于所有密钥类型。 如果请求的密钥是对称的,则响应中不会释放任何密钥材料。 授权:需要密钥/获取权限。
ServiceFuture<KeyBundle >
getKeyAsync(String vaultBaseUrl, String keyName, String keyVersion, final ServiceCallback<KeyBundle> serviceCallback)
获取存储密钥的公共部分。 获取密钥操作适用于所有密钥类型。 如果请求的密钥是对称的,则响应中不会释放任何密钥材料。 授权:需要密钥/获取权限。
String
getPendingCertificateSigningRequest(String vaultBaseUrl, String certificateName)
获取挂起的证书签名请求响应。
ServiceFuture<String>
getPendingCertificateSigningRequestAsync(String vaultBaseUrl, String certificateName, final ServiceCallback<String> serviceCallback)
获取挂起的证书签名请求响应。
SecretBundle
getSecret(String secretIdentifier)
从给定密钥保管库获取指定的机密。
SecretBundle
getSecret(String vaultBaseUrl, String secretName)
从给定密钥保管库获取指定的机密。
SecretBundle
getSecret(String vaultBaseUrl, String secretName, String secretVersion)
从给定密钥保管库获取指定的机密。
ServiceFuture<SecretBundle >
getSecretAsync(String secretIdentifier, final ServiceCallback<SecretBundle> serviceCallback)
从给定密钥保管库获取指定的机密。
ServiceFuture<SecretBundle >
getSecretAsync(String vaultBaseUrl, String secretName, final ServiceCallback<SecretBundle> serviceCallback)
从给定密钥保管库获取指定的机密。
ServiceFuture<SecretBundle >
getSecretAsync(String vaultBaseUrl, String secretName, String secretVersion, final ServiceCallback<SecretBundle> serviceCallback)
从给定密钥保管库获取指定的机密。
OkHttpClient
httpClient()
CertificateBundle
importCertificate(ImportCertificateRequest importCertificateRequest)
将证书导入指定的保管库。
ServiceFuture<CertificateBundle >
importCertificateAsync(ImportCertificateRequest importCertificateRequest, final ServiceCallback<CertificateBundle> serviceCallback)
将证书导入指定的保管库。
KeyBundle
importKey(ImportKeyRequest importKeyRequest)
导入外部创建的密钥,存储它,然后将密钥参数和属性返回给客户端。 导入密钥操作可用于将任何密钥类型导入 Azure 密钥保管库。 如果命名的密钥已存在,Azure 密钥保管库将创建该密钥的新版本。 授权:需要密钥/导入权限。
ServiceFuture<KeyBundle >
importKeyAsync(ImportKeyRequest importKeyRequest, final ServiceCallback<KeyBundle> serviceCallback)
导入外部创建的密钥,存储它,然后将密钥参数和属性返回给客户端。 导入密钥操作可用于将任何密钥类型导入 Azure 密钥保管库。 如果命名的密钥已存在,Azure 密钥保管库将创建该密钥的新版本。 授权:需要密钥/导入权限。
PagedList<CertificateIssuerItem >
listCertificateIssuers(final String vaultBaseUrl)
列出指定保管库的证书颁发者。
PagedList<CertificateIssuerItem >
listCertificateIssuers(final String vaultBaseUrl, final Integer maxresults)
列出指定保管库的证书颁发者。
ServiceFuture<List<CertificateIssuerItem >>
listCertificateIssuersAsync(final String vaultBaseUrl, final Integer maxresults, final ListOperationCallback<CertificateIssuerItem> serviceCallback)
列出指定保管库的证书颁发者。
ServiceFuture<List<CertificateIssuerItem >>
listCertificateIssuersAsync(final String vaultBaseUrl, final ListOperationCallback<CertificateIssuerItem> serviceCallback)
列出指定保管库的证书颁发者。
PagedList<CertificateItem >
listCertificates(final String vaultBaseUrl)
列出指定保管库中的证书。
PagedList<CertificateItem >
listCertificates(final String vaultBaseUrl, final Integer maxresults)
列出指定保管库中的证书。
ServiceFuture<List<CertificateItem >>
listCertificatesAsync(final String vaultBaseUrl, final Integer maxresults, final ListOperationCallback<CertificateItem> serviceCallback)
列出指定保管库中的证书。
ServiceFuture<List<CertificateItem >>
listCertificatesAsync(final String vaultBaseUrl, final ListOperationCallback<CertificateItem> serviceCallback)
列出指定保管库中的证书。
PagedList<CertificateItem >
listCertificateVersions(final String vaultBaseUrl, final String certificateName)
列出证书的版本。
PagedList<CertificateItem >
listCertificateVersions(final String vaultBaseUrl, final String certificateName, final Integer maxresults)
列出证书的版本。
ServiceFuture<List<CertificateItem >>
listCertificateVersionsAsync(final String vaultBaseUrl, final String certificateName, final Integer maxresults, final ListOperationCallback<CertificateItem> serviceCallback)
列出证书的版本。
ServiceFuture<List<CertificateItem >>
listCertificateVersionsAsync(final String vaultBaseUrl, final String certificateName, final ListOperationCallback<CertificateItem> serviceCallback)
列出证书的版本。
PagedList<KeyItem >
listKeys(final String vaultBaseUrl)
列出指定保管库中的密钥。
PagedList<KeyItem >
listKeys(final String vaultBaseUrl, final Integer maxresults)
列出指定保管库中的密钥。
ServiceFuture<List<KeyItem >>
listKeysAsync(final String vaultBaseUrl, final Integer maxresults, final ListOperationCallback<KeyItem> serviceCallback)
列出指定保管库中的密钥。
ServiceFuture<List<KeyItem >>
listKeysAsync(final String vaultBaseUrl, final ListOperationCallback<KeyItem> serviceCallback)
列出指定保管库中的密钥。
PagedList<KeyItem >
listKeyVersions(final String vaultBaseUrl, final String keyName)
检索具有相同密钥名称的各个密钥版本的列表。 响应中提供了完整密钥标识符、属性和标记。 授权:需要密钥/列表权限。
PagedList<KeyItem >
listKeyVersions(final String vaultBaseUrl, final String keyName, final Integer maxresults)
检索具有相同密钥名称的各个密钥版本的列表。 响应中提供了完整密钥标识符、属性和标记。 授权:需要密钥/列表权限。
ServiceFuture<List<KeyItem >>
listKeyVersionsAsync(final String vaultBaseUrl, final String keyName, final Integer maxresults, final ListOperationCallback<KeyItem> serviceCallback)
检索具有相同密钥名称的各个密钥版本的列表。 响应中提供了完整密钥标识符、属性和标记。 授权:需要密钥/列表权限。
ServiceFuture<List<KeyItem >>
listKeyVersionsAsync(final String vaultBaseUrl, final String keyName, final ListOperationCallback<KeyItem> serviceCallback)
检索具有相同密钥名称的各个密钥版本的列表。 响应中提供了完整密钥标识符、属性和标记。 授权:需要密钥/列表权限。
PagedList<SecretItem >
listSecrets(final String vaultBaseUrl)
列出指定保管库中的机密。
PagedList<SecretItem >
listSecrets(final String vaultBaseUrl, final Integer maxresults)
列出指定保管库中的机密。
ServiceFuture<List<SecretItem >>
listSecretsAsync(final String vaultBaseUrl, final Integer maxresults, final ListOperationCallback<SecretItem> serviceCallback)
列出指定保管库中的机密。
ServiceFuture<List<SecretItem >>
listSecretsAsync(final String vaultBaseUrl, final ListOperationCallback<SecretItem> serviceCallback)
列出指定保管库中的机密。
PagedList<SecretItem >
listSecretVersions(final String vaultBaseUrl, final String secretName)
列出指定机密的版本。
PagedList<SecretItem >
listSecretVersions(final String vaultBaseUrl, final String secretName, final Integer maxresults)
列出指定机密的版本。
ServiceFuture<List<SecretItem >>
listSecretVersionsAsync(final String vaultBaseUrl, final String secretName, final Integer maxresults, final ListOperationCallback<SecretItem> serviceCallback)
列出指定机密的版本。
ServiceFuture<List<SecretItem >>
listSecretVersionsAsync(final String vaultBaseUrl, final String secretName, final ListOperationCallback<SecretItem> serviceCallback)
列出指定机密的版本。
int
longRunningOperationRetryTimeout()
获取或设置长时间运行操作的重试超时(以秒为单位)。 默认值为 30。
CertificateBundle
mergeCertificate(MergeCertificateRequest mergeCertificateRequest)
将证书或证书链与服务器上存在的密钥对合并。
ServiceFuture<CertificateBundle >
mergeCertificateAsync(MergeCertificateRequest mergeCertificateRequest, final ServiceCallback<CertificateBundle> serviceCallback)
将证书或证书链与服务器上存在的密钥对合并。
RestClient
restClient()
KeyBundle
restoreKey(String vaultBaseUrl, byte[] keyBundleBackup)
将 中的备份密钥还原到保管库。
ServiceFuture<KeyBundle >
restoreKeyAsync(String vaultBaseUrl, byte[] keyBundleBackup, final ServiceCallback<KeyBundle> serviceCallback)
将 中的备份密钥还原到保管库。
Retrofit
retrofit()
SerializerAdapter<?>
serializerAdapter()
Contacts
setCertificateContacts(String vaultBaseUrl, Contacts contacts)
设置指定保管库的证书联系人。
ServiceFuture<Contacts >
setCertificateContactsAsync(String vaultBaseUrl, Contacts contacts, final ServiceCallback<Contacts> serviceCallback)
设置指定保管库的证书联系人。
IssuerBundle
setCertificateIssuer(SetCertificateIssuerRequest setCertificateIssuerRequest)
设置指定保管库的证书联系人。
ServiceFuture<IssuerBundle >
setCertificateIssuerAsync(SetCertificateIssuerRequest setCertificateIssuerRequest, final ServiceCallback<IssuerBundle> serviceCallback)
设置指定保管库的证书联系人。
SecretBundle
setSecret(SetSecretRequest setSecretRequest)
在指定的保管库中设置机密。
ServiceFuture<SecretBundle >
setSecretAsync(SetSecretRequest setSecretRequest, final ServiceCallback<SecretBundle> serviceCallback)
在指定的保管库中设置机密。
KeyOperationResult
sign(String keyIdentifier, JsonWebKeySignatureAlgorithm algorithm, byte[] value)
使用指定的键从摘要创建签名。
ServiceFuture<KeyOperationResult >
signAsync(String keyIdentifier, JsonWebKeySignatureAlgorithm algorithm, byte[] value, final ServiceCallback<KeyOperationResult> serviceCallback)
使用指定的键从摘要创建签名。
KeyOperationResult
unwrapKey(String keyIdentifier, JsonWebKeyEncryptionAlgorithm algorithm, byte[] value)
使用保管库中最初用于包装密钥的指定密钥来解包对称密钥。
ServiceFuture<KeyOperationResult >
unwrapKeyAsync(String keyIdentifier, JsonWebKeyEncryptionAlgorithm algorithm, byte[] value, final ServiceCallback<KeyOperationResult> serviceCallback)
使用保管库中最初用于包装密钥的指定密钥来解包对称密钥。
CertificateBundle
updateCertificate(UpdateCertificateRequest updateCertificateRequest)
汇报与指定证书关联的属性。
ServiceFuture<CertificateBundle >
updateCertificateAsync(UpdateCertificateRequest updateCertificateRequest, final ServiceCallback<CertificateBundle> serviceCallback)
汇报与指定证书关联的属性。
IssuerBundle
updateCertificateIssuer(UpdateCertificateIssuerRequest updateCertificateIssuerRequest)
汇报指定的证书颁发者。
ServiceFuture<IssuerBundle >
updateCertificateIssuerAsync(UpdateCertificateIssuerRequest updateCertificateIssuerRequest, final ServiceCallback<IssuerBundle> serviceCallback)
汇报指定的证书颁发者。
CertificateOperation
updateCertificateOperation(UpdateCertificateOperationRequest updateCertificateOperationRequest)
汇报证书操作。
ServiceFuture<CertificateOperation >
updateCertificateOperationAsync(UpdateCertificateOperationRequest updateCertificateOperationRequest, final ServiceCallback<CertificateOperation> serviceCallback)
汇报证书操作。
CertificatePolicy
updateCertificatePolicy(UpdateCertificatePolicyRequest updateCertificatePolicyRequest)
汇报证书的策略。 在 certificatePolicy 中设置必须更新的相应成员。 将其他人保留为 null。
ServiceFuture<CertificatePolicy >
updateCertificatePolicyAsync(UpdateCertificatePolicyRequest updateCertificatePolicyRequest, final ServiceCallback<CertificatePolicy> serviceCallback)
汇报证书的策略。 在 certificatePolicy 中设置必须更新的相应成员。 将其他人保留为 null。
KeyBundle
updateKey(UpdateKeyRequest updateKeyRequest)
更新密钥操作会更改存储密钥的指定属性,并可以应用于 Azure 密钥保管库中存储的任何密钥类型和密钥版本。 不能更改密钥本身的加密材料。 若要执行此操作,该密钥必须已存在于密钥保管库中。 授权:需要密钥/更新权限。
ServiceFuture<KeyBundle >
updateKeyAsync(UpdateKeyRequest updateKeyRequest, final ServiceCallback<KeyBundle> serviceCallback)
更新密钥操作会更改存储密钥的指定属性,并可以应用于 Azure 密钥保管库中存储的任何密钥类型和密钥版本。 不能更改密钥本身的加密材料。 若要执行此操作,该密钥必须已存在于密钥保管库中。 授权:需要密钥/更新权限。
SecretBundle
updateSecret(UpdateSecretRequest updateSecretRequest)
汇报与给定密钥保管库中的指定机密关联的属性。
ServiceFuture<SecretBundle >
updateSecretAsync(UpdateSecretRequest updateSecretRequest, final ServiceCallback<SecretBundle> serviceCallback)
汇报与给定密钥保管库中的指定机密关联的属性。
String
userAgent()
获取客户端的 User-Agent 标头。
KeyVerifyResult
verify(String keyIdentifier, JsonWebKeySignatureAlgorithm algorithm, byte[] digest, byte[] signature)
使用指定的密钥验证签名。
ServiceFuture<KeyVerifyResult >
verifyAsync(String keyIdentifier, JsonWebKeySignatureAlgorithm algorithm, byte[] digest, byte[] signature, final ServiceCallback<KeyVerifyResult> serviceCallback)
使用指定的密钥验证签名。
void
withAcceptLanguage(String acceptLanguage)
设置 获取或设置响应的首选语言。
void
withGenerateClientRequestId(boolean generateClientRequestId)
设置 当设置为 true 时,将生成唯一的 x-ms-client-request-id 值并将其包含在每个请求中。 默认为 true。
void
withLongRunningOperationRetryTimeout(int longRunningOperationRetryTimeout)
设置 获取或设置长时间运行操作的重试超时(以秒为单位)。 默认值为 30。
KeyOperationResult
wrapKey(String keyIdentifier, JsonWebKeyEncryptionAlgorithm algorithm, byte[] value)
使用指定的密钥包装对称密钥。
ServiceFuture<KeyOperationResult >
wrapKeyAsync(String keyIdentifier, JsonWebKeyEncryptionAlgorithm algorithm, byte[] value, final ServiceCallback<KeyOperationResult> serviceCallback)
使用指定的密钥包装对称密钥。
构造函数详细信息
KeyVaultClient
public KeyVaultClient(RestClient restClient)
初始化 KeyVaultClient 客户端的实例。
参数:
restClient
- 要连接到 Azure 的 REST 客户端。
KeyVaultClient
public KeyVaultClient(ServiceClientCredentials credentials)
初始化 KeyVaultClient 客户端的实例。
参数:
credentials
- Azure 的管理凭据
方法详细信息
acceptLanguage
public String acceptLanguage()
获取或设置响应的首选语言。
返回:
acceptLanguage 值。
apiVersion
public String apiVersion()
获取客户端 API 版本。
返回:
apiVersion 值。
backupKey
public BackupKeyResult backupKey(String vaultBaseUrl, String keyName)
请求将指定密钥的备份下载到客户端。
参数:
keyName
- 密钥的名称
返回:
如果成功,则为 BackupKeyResult。
backupKeyAsync
public ServiceFuture backupKeyAsync(String vaultBaseUrl, String keyName, final ServiceCallback serviceCallback)
请求将指定密钥的备份下载到客户端。
参数:
keyName
- 密钥的名称
serviceCallback
- 用于处理成功和失败响应的异步 ServiceCallback。
返回:
对象ServiceFuture
createCertificate
public CertificateOperation createCertificate(CreateCertificateRequest createCertificateRequest)
创建新的证书版本。 如果这是第一个版本,则会创建证书资源。
参数:
createCertificateRequest
- 用于创建证书请求的分组属性
返回:
如果成功,则为 CertificateOperation。
createCertificateAsync
public ServiceFuture createCertificateAsync(CreateCertificateRequest createCertificateRequest, final ServiceCallback serviceCallback)
创建新的证书版本。 如果这是第一个版本,则会创建证书资源。
参数:
createCertificateRequest
- 用于创建证书请求的分组属性
serviceCallback
- 用于处理成功和失败响应的异步 ServiceCallback。
返回:
对象ServiceFuture
createKey
public KeyBundle createKey(CreateKeyRequest createKeyRequest)
创建一个新密钥,存储该密钥,然后向客户端返回密钥参数和属性。 创建密钥操作可用于在 Azure 密钥保管库中创建任何密钥类型。 如果命名的密钥已存在,Azure 密钥保管库将创建该密钥的新版本。 授权:需要密钥/创建权限。
参数:
createKeyRequest
- 用于创建密钥请求的分组属性
返回:
如果成功,则为 KeyBundle。
createKeyAsync
public ServiceFuture createKeyAsync(CreateKeyRequest createKeyRequest, ServiceCallback serviceCallback)
创建一个新密钥,存储该密钥,然后向客户端返回密钥参数和属性。 创建密钥操作可用于在 Azure 密钥保管库中创建任何密钥类型。 如果命名的密钥已存在,Azure 密钥保管库将创建该密钥的新版本。 授权:需要密钥/创建权限。
参数:
createKeyRequest
- 用于创建密钥请求的分组属性
serviceCallback
- 用于处理成功和失败响应的异步 ServiceCallback。
返回:
对象ServiceFuture
decrypt
public KeyOperationResult decrypt(String keyIdentifier, JsonWebKeyEncryptionAlgorithm algorithm, byte[] value)
解密单个加密数据块。
参数:
keyIdentifier
- 完整的密钥标识符
algorithm
- 算法标识符
value
- 要解密的内容
返回:
如果成功,则为 KeyOperationResult。
decryptAsync
public ServiceFuture decryptAsync(String keyIdentifier, JsonWebKeyEncryptionAlgorithm algorithm, byte[] value, final ServiceCallback serviceCallback)
解密单个加密数据块。
参数:
keyIdentifier
- 完整的密钥标识符
algorithm
- 算法标识符
value
- 要解密的内容
serviceCallback
- 用于处理成功和失败响应的异步 ServiceCallback。
返回:
对象ServiceFuture
deleteCertificate
public CertificateBundle deleteCertificate(String vaultBaseUrl, String certificateName)
从指定的保管库中删除证书。
参数:
certificateName
- 给定保管库中证书的名称
返回:
如果成功,则为 CertificateBundle。
deleteCertificateAsync
public ServiceFuture deleteCertificateAsync(String vaultBaseUrl, String certificateName, final ServiceCallback serviceCallback)
从指定的保管库中删除证书。
参数:
certificateName
- 给定保管库中证书的名称
serviceCallback
- 用于处理成功和失败响应的异步 ServiceCallback。
返回:
对象ServiceFuture
deleteCertificateContacts
public Contacts deleteCertificateContacts(String vaultBaseUrl)
删除指定保管库的证书联系人。
参数:
返回:
如果成功,则为联系人。
deleteCertificateContactsAsync
public ServiceFuture deleteCertificateContactsAsync(String vaultBaseUrl, final ServiceCallback serviceCallback)
删除指定保管库的证书联系人。
参数:
serviceCallback
- 用于处理成功和失败响应的异步 ServiceCallback。
返回:
对象ServiceFuture
deleteCertificateIssuer
public IssuerBundle deleteCertificateIssuer(String vaultBaseUrl, String issuerName)
删除指定的证书颁发者。
参数:
issuerName
- 颁发者的名称。
返回:
如果成功,则为 IssuerBundle。
deleteCertificateIssuerAsync
public ServiceFuture deleteCertificateIssuerAsync(String vaultBaseUrl, String issuerName, final ServiceCallback serviceCallback)
删除指定的证书颁发者。
参数:
issuerName
- 颁发者的名称。
serviceCallback
- 用于处理成功和失败响应的异步 ServiceCallback。
返回:
对象ServiceFuture
deleteCertificateOperation
public CertificateOperation deleteCertificateOperation(String vaultBaseUrl, String certificateName)
删除指定证书的操作。
参数:
certificateName
- 证书的名称
返回:
如果成功,则为 CertificateOperation。
deleteCertificateOperationAsync
public ServiceFuture deleteCertificateOperationAsync(String vaultBaseUrl, String certificateName, final ServiceCallback serviceCallback)
删除指定证书的操作。
参数:
certificateName
- 证书的名称
serviceCallback
- 用于处理成功和失败响应的异步 ServiceCallback。
返回:
对象ServiceFuture
deleteKey
public KeyBundle deleteKey(String vaultBaseUrl, String keyName)
从 Azure 密钥保管库 中的存储中删除任何类型的密钥。 删除密钥操作不能用于删除单个版本的密钥。 此操作将删除与密钥关联的加密材料,也就是说,该密钥不可用于签名/验证、包装/解包或加密/解密操作。 授权:需要密钥/删除权限。
参数:
keyName
- 密钥的名称
返回:
如果成功,则为 KeyBundle。
deleteKeyAsync
public ServiceFuture deleteKeyAsync(String vaultBaseUrl, String keyName, final ServiceCallback serviceCallback)
从 Azure 密钥保管库 中的存储中删除任何类型的密钥。 删除密钥操作不能用于删除单个版本的密钥。 此操作将删除与密钥关联的加密材料,也就是说,该密钥不可用于签名/验证、包装/解包或加密/解密操作。 授权:需要密钥/删除权限。
参数:
keyName
- 密钥的名称
serviceCallback
- 用于处理成功和失败响应的异步 ServiceCallback。
返回:
对象ServiceFuture
deleteSecret
public SecretBundle deleteSecret(String vaultBaseUrl, String secretName)
从指定的保管库中删除机密。
参数:
secretName
- 给定保管库中机密的名称
返回:
如果成功,则为 SecretBundle。
deleteSecretAsync
public ServiceFuture deleteSecretAsync(String vaultBaseUrl, String secretName, final ServiceCallback serviceCallback)
从指定的保管库中删除机密。
参数:
secretName
- 给定保管库中机密的名称
serviceCallback
- 用于处理成功和失败响应的异步 ServiceCallback。
返回:
对象ServiceFuture
encrypt
public KeyOperationResult encrypt(String keyIdentifier, JsonWebKeyEncryptionAlgorithm algorithm, byte[] value)
使用存储在密钥保管库中的加密密钥加密任意字节序列。
参数:
keyIdentifier
- 完整的密钥标识符
algorithm
- 算法标识符
value
- 要加密的内容
返回:
如果成功,则为 KeyOperationResult。
encryptAsync
public ServiceFuture encryptAsync(String keyIdentifier, JsonWebKeyEncryptionAlgorithm algorithm, byte[] value, final ServiceCallback serviceCallback)
使用存储在密钥保管库中的加密密钥加密任意字节序列。
参数:
keyIdentifier
- 完整的密钥标识符
algorithm
- 算法标识符
value
- 要加密的内容
serviceCallback
- 用于处理成功和失败响应的异步 ServiceCallback。
返回:
对象ServiceFuture
generateClientRequestId
public boolean generateClientRequestId()
获取当设置为 true 时,将生成唯一的 x-ms-client-request-id 值并将其包含在每个请求中。 默认为 true。
返回:
generateClientRequestId 值。
getAzureClient
public AzureClient getAzureClient()
获取 AzureClient 用于长时间运行的操作的 。
返回:
azure 客户端;
getCertificate
public CertificateBundle getCertificate(String certificateIdentifier)
获取有关指定证书的信息。
参数:
certificateIdentifier
- 证书标识符
返回:
如果成功,则为 CertificateBundle。
getCertificate
public CertificateBundle getCertificate(String vaultBaseUrl, String certificateName)
获取有关指定证书的信息。
参数:
certificateName
- 给定保管库中证书的名称
返回:
如果成功,则为 CertificateBundle。
getCertificate
public CertificateBundle getCertificate(String vaultBaseUrl, String certificateName, String certificateVersion)
获取有关指定证书的信息。
参数:
certificateName
- 给定保管库中证书的名称
certificateVersion
- 证书的版本
返回:
如果成功,则为 CertificateBundle。
getCertificateAsync
public ServiceFuture getCertificateAsync(String certificateIdentifier, final ServiceCallback serviceCallback)
获取有关指定证书的信息。
参数:
certificateIdentifier
- 证书标识符
serviceCallback
- 用于处理成功和失败响应的异步 ServiceCallback。
返回:
对象ServiceFuture
getCertificateAsync
public ServiceFuture getCertificateAsync(String vaultBaseUrl, String certificateName, final ServiceCallback serviceCallback)
获取有关指定证书的信息。
参数:
certificateName
- 给定保管库中证书的名称
serviceCallback
- 用于处理成功和失败响应的异步 ServiceCallback。
返回:
对象ServiceFuture
getCertificateAsync
public ServiceFuture getCertificateAsync(String vaultBaseUrl, String certificateName, String certificateVersion, final ServiceCallback serviceCallback)
获取有关指定证书的信息。
参数:
certificateName
- 给定保管库中证书的名称
certificateVersion
- 证书的版本
serviceCallback
- 用于处理成功和失败响应的异步 ServiceCallback。
返回:
对象ServiceFuture
getCertificateContacts
public Contacts getCertificateContacts(String vaultBaseUrl)
获取指定保管库的证书联系人。
参数:
返回:
如果成功,则为联系人。
getCertificateContactsAsync
public ServiceFuture getCertificateContactsAsync(String vaultBaseUrl, final ServiceCallback serviceCallback)
获取指定保管库的证书联系人。
参数:
serviceCallback
- 用于处理成功和失败响应的异步 ServiceCallback。
返回:
对象ServiceFuture
getCertificateIssuer
public IssuerBundle getCertificateIssuer(String vaultBaseUrl, String issuerName)
获取指定的证书颁发者。
参数:
issuerName
- 颁发者的名称。
返回:
如果成功,则为 IssuerBundle。
getCertificateIssuerAsync
public ServiceFuture getCertificateIssuerAsync(String vaultBaseUrl, String issuerName, final ServiceCallback serviceCallback)
获取指定的证书颁发者。
参数:
issuerName
- 颁发者的名称。
serviceCallback
- 用于处理成功和失败响应的异步 ServiceCallback。
返回:
对象ServiceFuture
getCertificateOperation
public CertificateOperation getCertificateOperation(String vaultBaseUrl, String certificateName)
获取与指定证书关联的操作。
参数:
certificateName
- 证书的名称
返回:
如果成功,则为 CertificateOperation。
getCertificateOperationAsync
public ServiceFuture getCertificateOperationAsync(String vaultBaseUrl, String certificateName, final ServiceCallback serviceCallback)
获取与指定证书关联的操作。
参数:
certificateName
- 证书的名称
serviceCallback
- 用于处理成功和失败响应的异步 ServiceCallback。
返回:
对象ServiceFuture
getCertificatePolicy
public CertificatePolicy getCertificatePolicy(String vaultBaseUrl, String certificateName)
获取证书的策略。
参数:
certificateName
- 给定保管库中证书的名称。
返回:
如果成功,则为 CertificatePolicy。
getCertificatePolicyAsync
public ServiceFuture getCertificatePolicyAsync(String vaultBaseUrl, String certificateName, final ServiceCallback serviceCallback)
获取证书的策略。
参数:
certificateName
- 给定保管库中证书的名称。
serviceCallback
- 用于处理成功和失败响应的异步 ServiceCallback。
返回:
对象ServiceFuture
getKey
public KeyBundle getKey(String keyIdentifier)
获取存储密钥的公共部分。 获取密钥操作适用于所有密钥类型。 如果请求的密钥是对称的,则响应中不会释放任何密钥材料。 授权:需要密钥/获取权限。
参数:
keyIdentifier
- 完整的密钥标识符
返回:
如果成功,则为 KeyBundle。
getKey
public KeyBundle getKey(String vaultBaseUrl, String keyName)
获取存储密钥的公共部分。 获取密钥操作适用于所有密钥类型。 如果请求的密钥是对称的,则响应中不会释放任何密钥材料。 授权:需要密钥/获取权限。
参数:
keyName
- 密钥的名称
返回:
如果成功,则为 KeyBundle。
getKey
public KeyBundle getKey(String vaultBaseUrl, String keyName, String keyVersion)
获取存储密钥的公共部分。 获取密钥操作适用于所有密钥类型。 如果请求的密钥是对称的,则响应中不会释放任何密钥材料。 授权:需要密钥/获取权限。
参数:
keyName
- 密钥的名称
keyVersion
- 密钥的版本
返回:
如果成功,则为 KeyBundle。
getKeyAsync
public ServiceFuture getKeyAsync(String keyIdentifier, final ServiceCallback serviceCallback)
获取存储密钥的公共部分。 获取密钥操作适用于所有密钥类型。 如果请求的密钥是对称的,则响应中不会释放任何密钥材料。 授权:需要密钥/获取权限。
参数:
keyIdentifier
- 完整的密钥标识符
serviceCallback
- 用于处理成功和失败响应的异步 ServiceCallback。
返回:
对象ServiceFuture
getKeyAsync
public ServiceFuture getKeyAsync(String vaultBaseUrl, String keyName, final ServiceCallback serviceCallback)
获取存储密钥的公共部分。 获取密钥操作适用于所有密钥类型。 如果请求的密钥是对称的,则响应中不会释放任何密钥材料。 授权:需要密钥/获取权限。
参数:
keyName
- 密钥的名称
serviceCallback
- 用于处理成功和失败响应的异步 ServiceCallback。
返回:
对象ServiceFuture
getKeyAsync
public ServiceFuture getKeyAsync(String vaultBaseUrl, String keyName, String keyVersion, final ServiceCallback serviceCallback)
获取存储密钥的公共部分。 获取密钥操作适用于所有密钥类型。 如果请求的密钥是对称的,则响应中不会释放任何密钥材料。 授权:需要密钥/获取权限。
参数:
keyName
- 密钥的名称
keyVersion
- 密钥的版本
serviceCallback
- 用于处理成功和失败响应的异步 ServiceCallback。
返回:
对象ServiceFuture
getPendingCertificateSigningRequest
public String getPendingCertificateSigningRequest(String vaultBaseUrl, String certificateName)
获取挂起的证书签名请求响应。
参数:
certificateName
- 证书的名称
返回:
如果成功,则为字符串。
getPendingCertificateSigningRequestAsync
public ServiceFuture getPendingCertificateSigningRequestAsync(String vaultBaseUrl, String certificateName, final ServiceCallback serviceCallback)
获取挂起的证书签名请求响应。
参数:
certificateName
- 证书的名称
serviceCallback
- 用于处理成功和失败响应的异步 ServiceCallback。
返回:
对象ServiceFuture
getSecret
public SecretBundle getSecret(String secretIdentifier)
从给定密钥保管库获取指定的机密。
参数:
secretIdentifier
- 机密的 URL。
返回:
如果成功,则为 SecretBundle。
getSecret
public SecretBundle getSecret(String vaultBaseUrl, String secretName)
从给定密钥保管库获取指定的机密。
参数:
secretName
- 给定保管库中机密的名称
返回:
如果成功,则为 SecretBundle。
getSecret
public SecretBundle getSecret(String vaultBaseUrl, String secretName, String secretVersion)
从给定密钥保管库获取指定的机密。
参数:
secretName
- 给定保管库中机密的名称
secretVersion
- 机密的版本
返回:
如果成功,则为 SecretBundle。
getSecretAsync
public ServiceFuture getSecretAsync(String secretIdentifier, final ServiceCallback serviceCallback)
从给定密钥保管库获取指定的机密。
参数:
secretIdentifier
- 机密的 URL。
serviceCallback
- 用于处理成功和失败响应的异步 ServiceCallback。
返回:
对象ServiceFuture
getSecretAsync
public ServiceFuture getSecretAsync(String vaultBaseUrl, String secretName, final ServiceCallback serviceCallback)
从给定密钥保管库获取指定的机密。
参数:
secretName
- 给定保管库中机密的名称
serviceCallback
- 用于处理成功和失败响应的异步 ServiceCallback。
返回:
对象ServiceFuture
getSecretAsync
public ServiceFuture getSecretAsync(String vaultBaseUrl, String secretName, String secretVersion, final ServiceCallback serviceCallback)
从给定密钥保管库获取指定的机密。
参数:
secretName
- 给定保管库中机密的名称
secretVersion
- 机密的版本
serviceCallback
- 用于处理成功和失败响应的异步 ServiceCallback。
返回:
对象ServiceFuture
httpClient
public OkHttpClient httpClient()
返回:
HTTP 客户端。
importCertificate
public CertificateBundle importCertificate(ImportCertificateRequest importCertificateRequest)
将证书导入指定的保管库。
参数:
importCertificateRequest
- 用于导入证书请求的分组属性
返回:
如果成功,则为 CertificateBundle。
importCertificateAsync
public ServiceFuture importCertificateAsync(ImportCertificateRequest importCertificateRequest, final ServiceCallback serviceCallback)
将证书导入指定的保管库。
参数:
importCertificateRequest
- 用于导入证书请求的分组属性
serviceCallback
- 用于处理成功和失败响应的异步 ServiceCallback。
返回:
对象ServiceFuture
importKey
public KeyBundle importKey(ImportKeyRequest importKeyRequest)
导入外部创建的密钥,存储它,然后将密钥参数和属性返回给客户端。 导入密钥操作可用于将任何密钥类型导入 Azure 密钥保管库。 如果命名的密钥已存在,Azure 密钥保管库将创建该密钥的新版本。 授权:需要密钥/导入权限。
参数:
importKeyRequest
- 用于导入密钥请求的分组属性
返回:
如果成功,则为 KeyBundle。
importKeyAsync
public ServiceFuture importKeyAsync(ImportKeyRequest importKeyRequest, final ServiceCallback serviceCallback)
导入外部创建的密钥,存储它,然后将密钥参数和属性返回给客户端。 导入密钥操作可用于将任何密钥类型导入 Azure 密钥保管库。 如果命名的密钥已存在,Azure 密钥保管库将创建该密钥的新版本。 授权:需要密钥/导入权限。
参数:
importKeyRequest
- 用于导入密钥请求的分组属性
serviceCallback
- 用于处理成功和失败响应的异步 ServiceCallback。
返回:
对象ServiceFuture
listCertificateIssuers
public PagedList listCertificateIssuers(final String vaultBaseUrl)
列出指定保管库的证书颁发者。
参数:
返回:
如果成功,则为 PagedList<CertificateIssuerItem> 。
listCertificateIssuers
public PagedList listCertificateIssuers(final String vaultBaseUrl, final Integer maxresults)
列出指定保管库的证书颁发者。
参数:
maxresults
- 在一页中返回的最大结果数。 如果未指定,服务将返回最多 25 个结果。
返回:
如果成功,则为 PagedList<CertificateIssuerItem> 。
listCertificateIssuersAsync
public ServiceFuture> listCertificateIssuersAsync(final String vaultBaseUrl, final Integer maxresults, final ListOperationCallback serviceCallback)
列出指定保管库的证书颁发者。
参数:
maxresults
- 在一页中返回的最大结果数。 如果未指定,服务将返回最多 25 个结果。
serviceCallback
- 用于处理成功和失败响应的异步 ServiceCallback。
返回:
对象ServiceFuture
listCertificateIssuersAsync
public ServiceFuture> listCertificateIssuersAsync(final String vaultBaseUrl, final ListOperationCallback serviceCallback)
列出指定保管库的证书颁发者。
参数:
serviceCallback
- 用于处理成功和失败响应的异步 ServiceCallback。
返回:
对象ServiceFuture
listCertificates
public PagedList listCertificates(final String vaultBaseUrl)
列出指定保管库中的证书。
参数:
返回:
如果成功,则为 PagedList<CertificateItem> 。
listCertificates
public PagedList listCertificates(final String vaultBaseUrl, final Integer maxresults)
列出指定保管库中的证书。
参数:
maxresults
- 在一页中返回的最大结果数。 如果未指定,服务将返回最多 25 个结果。
返回:
如果成功,则为 PagedList<CertificateItem> 。
listCertificatesAsync
public ServiceFuture> listCertificatesAsync(final String vaultBaseUrl, final Integer maxresults, final ListOperationCallback serviceCallback)
列出指定保管库中的证书。
参数:
maxresults
- 在一页中返回的最大结果数。 如果未指定,服务将返回最多 25 个结果。
serviceCallback
- 用于处理成功和失败响应的异步 ServiceCallback。
返回:
对象ServiceFuture
listCertificatesAsync
public ServiceFuture> listCertificatesAsync(final String vaultBaseUrl, final ListOperationCallback serviceCallback)
列出指定保管库中的证书。
参数:
serviceCallback
- 用于处理成功和失败响应的异步 ServiceCallback。
返回:
对象ServiceFuture
listCertificateVersions
public PagedList listCertificateVersions(final String vaultBaseUrl, final String certificateName)
列出证书的版本。
参数:
certificateName
- 证书的名称
返回:
如果成功,则为 PagedList<CertificateItem> 。
listCertificateVersions
public PagedList listCertificateVersions(final String vaultBaseUrl, final String certificateName, final Integer maxresults)
列出证书的版本。
参数:
certificateName
- 证书的名称
maxresults
- 在一页中返回的最大结果数。 如果未指定,服务将返回最多 25 个结果。
返回:
如果成功,则为 PagedList<CertificateItem> 。
listCertificateVersionsAsync
public ServiceFuture> listCertificateVersionsAsync(final String vaultBaseUrl, final String certificateName, final Integer maxresults, final ListOperationCallback serviceCallback)
列出证书的版本。
参数:
certificateName
- 证书的名称
maxresults
- 在一页中返回的最大结果数。 如果未指定,服务将返回最多 25 个结果。
serviceCallback
- 用于处理成功和失败响应的异步 ServiceCallback。
返回:
对象ServiceFuture
listCertificateVersionsAsync
public ServiceFuture> listCertificateVersionsAsync(final String vaultBaseUrl, final String certificateName, final ListOperationCallback serviceCallback)
列出证书的版本。
参数:
certificateName
- 证书的名称
serviceCallback
- 用于处理成功和失败响应的异步 ServiceCallback。
返回:
对象ServiceFuture
listKeys
public PagedList listKeys(final String vaultBaseUrl)
列出指定保管库中的密钥。
参数:
返回:
如果成功,则为 PagedList<KeyItem> 。
listKeys
public PagedList listKeys(final String vaultBaseUrl, final Integer maxresults)
列出指定保管库中的密钥。
参数:
maxresults
- 在一页中返回的最大结果数。 如果未指定,服务将返回最多 25 个结果。
返回:
如果成功,则为 PagedList<KeyItem> 。
listKeysAsync
public ServiceFuture> listKeysAsync(final String vaultBaseUrl, final Integer maxresults, final ListOperationCallback serviceCallback)
列出指定保管库中的密钥。
参数:
maxresults
- 在一页中返回的最大结果数。 如果未指定,服务将返回最多 25 个结果。
serviceCallback
- 用于处理成功和失败响应的异步 ServiceCallback。
返回:
对象ServiceFuture
listKeysAsync
public ServiceFuture> listKeysAsync(final String vaultBaseUrl, final ListOperationCallback serviceCallback)
列出指定保管库中的密钥。
参数:
serviceCallback
- 用于处理成功和失败响应的异步 ServiceCallback。
返回:
对象ServiceFuture
listKeyVersions
public PagedList listKeyVersions(final String vaultBaseUrl, final String keyName)
检索具有相同密钥名称的各个密钥版本的列表。 响应中提供了完整密钥标识符、属性和标记。 授权:需要密钥/列表权限。
参数:
keyName
- 密钥的名称
返回:
如果成功,则为 PagedList<KeyItem> 。
listKeyVersions
public PagedList listKeyVersions(final String vaultBaseUrl, final String keyName, final Integer maxresults)
检索具有相同密钥名称的各个密钥版本的列表。 响应中提供了完整密钥标识符、属性和标记。 授权:需要密钥/列表权限。
参数:
keyName
- 密钥的名称
maxresults
- 在一页中返回的最大结果数。 如果未指定,服务将返回最多 25 个结果。
返回:
如果成功,则为 PagedList<KeyItem> 。
listKeyVersionsAsync
public ServiceFuture> listKeyVersionsAsync(final String vaultBaseUrl, final String keyName, final Integer maxresults, final ListOperationCallback serviceCallback)
检索具有相同密钥名称的各个密钥版本的列表。 响应中提供了完整密钥标识符、属性和标记。 授权:需要密钥/列表权限。
参数:
keyName
- 密钥的名称
maxresults
- 在一页中返回的最大结果数。 如果未指定,服务将返回最多 25 个结果。
serviceCallback
- 用于处理成功和失败响应的异步 ServiceCallback。
返回:
对象ServiceFuture
listKeyVersionsAsync
public ServiceFuture> listKeyVersionsAsync(final String vaultBaseUrl, final String keyName, final ListOperationCallback serviceCallback)
检索具有相同密钥名称的各个密钥版本的列表。 响应中提供了完整密钥标识符、属性和标记。 授权:需要密钥/列表权限。
参数:
keyName
- 密钥的名称
serviceCallback
- 用于处理成功和失败响应的异步 ServiceCallback。
返回:
对象ServiceFuture
listSecrets
public PagedList listSecrets(final String vaultBaseUrl)
列出指定保管库中的机密。
参数:
返回:
PagedList<SecretItem> (如果成功)。
listSecrets
public PagedList listSecrets(final String vaultBaseUrl, final Integer maxresults)
列出指定保管库中的机密。
参数:
maxresults
- 在一页中返回的最大结果数。 如果未指定,服务将返回最多 25 个结果。
返回:
PagedList<SecretItem> (如果成功)。
listSecretsAsync
public ServiceFuture> listSecretsAsync(final String vaultBaseUrl, final Integer maxresults, final ListOperationCallback serviceCallback)
列出指定保管库中的机密。
参数:
maxresults
- 在一页中返回的最大结果数。 如果未指定,服务将返回最多 25 个结果。
serviceCallback
- 用于处理成功和失败响应的异步 ServiceCallback。
返回:
对象ServiceFuture
listSecretsAsync
public ServiceFuture> listSecretsAsync(final String vaultBaseUrl, final ListOperationCallback serviceCallback)
列出指定保管库中的机密。
参数:
serviceCallback
- 用于处理成功和失败响应的异步 ServiceCallback。
返回:
对象ServiceFuture
listSecretVersions
public PagedList listSecretVersions(final String vaultBaseUrl, final String secretName)
列出指定机密的版本。
参数:
secretName
- 给定保管库中机密的名称
返回:
PagedList<SecretItem> (如果成功)。
listSecretVersions
public PagedList listSecretVersions(final String vaultBaseUrl, final String secretName, final Integer maxresults)
列出指定机密的版本。
参数:
secretName
- 给定保管库中机密的名称
maxresults
- 在一页中返回的最大结果数。 如果未指定,服务将返回最多 25 个结果。
返回:
PagedList<SecretItem> (如果成功)。
listSecretVersionsAsync
public ServiceFuture> listSecretVersionsAsync(final String vaultBaseUrl, final String secretName, final Integer maxresults, final ListOperationCallback serviceCallback)
列出指定机密的版本。
参数:
secretName
- 给定保管库中机密的名称
maxresults
- 在一页中返回的最大结果数。 如果未指定,服务将返回最多 25 个结果。
serviceCallback
- 用于处理成功和失败响应的异步 ServiceCallback。
返回:
对象ServiceFuture
listSecretVersionsAsync
public ServiceFuture> listSecretVersionsAsync(final String vaultBaseUrl, final String secretName, final ListOperationCallback serviceCallback)
列出指定机密的版本。
参数:
secretName
- 给定保管库中机密的名称
serviceCallback
- 用于处理成功和失败响应的异步 ServiceCallback。
返回:
对象ServiceFuture
longRunningOperationRetryTimeout
public int longRunningOperationRetryTimeout()
获取或设置长时间运行操作的重试超时(以秒为单位)。 默认值为 30。
返回:
longRunningOperationRetryTimeout 值。
mergeCertificate
public CertificateBundle mergeCertificate(MergeCertificateRequest mergeCertificateRequest)
将证书或证书链与服务器上存在的密钥对合并。
参数:
mergeCertificateRequest
- 用于合并证书请求的分组属性
返回:
如果成功,则为 CertificateBundle。
mergeCertificateAsync
public ServiceFuture mergeCertificateAsync(MergeCertificateRequest mergeCertificateRequest, final ServiceCallback serviceCallback)
将证书或证书链与服务器上存在的密钥对合并。
参数:
mergeCertificateRequest
- 用于合并证书请求的分组属性
serviceCallback
- 用于处理成功和失败响应的异步 ServiceCallback。
返回:
对象ServiceFuture
restClient
public RestClient restClient()
返回:
实例 RestClient 。
restoreKey
public KeyBundle restoreKey(String vaultBaseUrl, byte[] keyBundleBackup)
将 中的备份密钥还原到保管库。
参数:
keyBundleBackup
- 与密钥捆绑包关联的备份 Blob
返回:
如果成功,则为 KeyBundle。
restoreKeyAsync
public ServiceFuture restoreKeyAsync(String vaultBaseUrl, byte[] keyBundleBackup, final ServiceCallback serviceCallback)
将 中的备份密钥还原到保管库。
参数:
keyBundleBackup
- 与密钥捆绑包关联的备份 Blob
serviceCallback
- 用于处理成功和失败响应的异步 ServiceCallback。
返回:
对象ServiceFuture
retrofit
public Retrofit retrofit()
返回:
改造实例。
serializerAdapter
public SerializerAdapter serializerAdapter()
返回:
杰克逊 com.fasterxml.jackson.databind.ObjectMapper 的适配器。
setCertificateContacts
public Contacts setCertificateContacts(String vaultBaseUrl, Contacts contacts)
设置指定保管库的证书联系人。
参数:
contacts
- 保管库证书的联系人。
返回:
如果成功,则为联系人。
setCertificateContactsAsync
public ServiceFuture setCertificateContactsAsync(String vaultBaseUrl, Contacts contacts, final ServiceCallback serviceCallback)
设置指定保管库的证书联系人。
参数:
contacts
- 保管库证书的联系人。
serviceCallback
- 用于处理成功和失败响应的异步 ServiceCallback。
返回:
对象ServiceFuture
setCertificateIssuer
public IssuerBundle setCertificateIssuer(SetCertificateIssuerRequest setCertificateIssuerRequest)
设置指定保管库的证书联系人。
参数:
setCertificateIssuerRequest
- 用于设置证书颁发者请求的分组属性
返回:
如果成功,则为 IssuerBundle。
setCertificateIssuerAsync
public ServiceFuture setCertificateIssuerAsync(SetCertificateIssuerRequest setCertificateIssuerRequest, final ServiceCallback serviceCallback)
设置指定保管库的证书联系人。
参数:
setCertificateIssuerRequest
- 用于设置证书颁发者请求的分组属性
serviceCallback
- 用于处理成功和失败响应的异步 ServiceCallback。
返回:
对象ServiceFuture
setSecret
public SecretBundle setSecret(SetSecretRequest setSecretRequest)
在指定的保管库中设置机密。
参数:
setSecretRequest
- 用于设置机密请求的分组属性
返回:
如果成功,则为 SecretBundle。
setSecretAsync
public ServiceFuture setSecretAsync(SetSecretRequest setSecretRequest, final ServiceCallback serviceCallback)
在指定的保管库中设置机密。
参数:
setSecretRequest
- 用于设置机密请求的分组属性
serviceCallback
- 用于处理成功和失败响应的异步 ServiceCallback。
返回:
对象ServiceFuture
sign
public KeyOperationResult sign(String keyIdentifier, JsonWebKeySignatureAlgorithm algorithm, byte[] value)
使用指定的键从摘要创建签名。
参数:
keyIdentifier
- 完整的密钥标识符
algorithm
- 算法标识符
value
- 要签名的内容
返回:
如果成功,则为 KeyOperationResult。
signAsync
public ServiceFuture signAsync(String keyIdentifier, JsonWebKeySignatureAlgorithm algorithm, byte[] value, final ServiceCallback serviceCallback)
使用指定的键从摘要创建签名。
参数:
keyIdentifier
- 完整的密钥标识符
algorithm
- 算法标识符
value
- 要签名的内容
serviceCallback
- 用于处理成功和失败响应的异步 ServiceCallback。
返回:
对象ServiceFuture
unwrapKey
public KeyOperationResult unwrapKey(String keyIdentifier, JsonWebKeyEncryptionAlgorithm algorithm, byte[] value)
使用保管库中最初用于包装密钥的指定密钥来解包对称密钥。
参数:
keyIdentifier
- 完整的密钥标识符
algorithm
- 算法标识符
value
- 要取消包装的密钥
返回:
如果成功,则为 KeyOperationResult。
unwrapKeyAsync
public ServiceFuture unwrapKeyAsync(String keyIdentifier, JsonWebKeyEncryptionAlgorithm algorithm, byte[] value, final ServiceCallback serviceCallback)
使用保管库中最初用于包装密钥的指定密钥来解包对称密钥。
参数:
keyIdentifier
- 完整的密钥标识符
algorithm
- 算法标识符
value
- 要取消包装的密钥
serviceCallback
- 用于处理成功和失败响应的异步 ServiceCallback。
返回:
对象ServiceFuture
updateCertificate
public CertificateBundle updateCertificate(UpdateCertificateRequest updateCertificateRequest)
汇报与指定证书关联的属性。
参数:
updateCertificateRequest
- 用于更新证书请求的分组属性
返回:
如果成功,则为 CertificateBundle。
updateCertificateAsync
public ServiceFuture updateCertificateAsync(UpdateCertificateRequest updateCertificateRequest, final ServiceCallback serviceCallback)
汇报与指定证书关联的属性。
参数:
updateCertificateRequest
- 用于更新证书请求的分组属性
serviceCallback
- 用于处理成功和失败响应的异步 ServiceCallback。
返回:
对象ServiceFuture
updateCertificateIssuer
public IssuerBundle updateCertificateIssuer(UpdateCertificateIssuerRequest updateCertificateIssuerRequest)
汇报指定的证书颁发者。
参数:
updateCertificateIssuerRequest
- 用于更新证书颁发者请求的分组属性
返回:
如果成功,则为 IssuerBundle。
updateCertificateIssuerAsync
public ServiceFuture updateCertificateIssuerAsync(UpdateCertificateIssuerRequest updateCertificateIssuerRequest, final ServiceCallback serviceCallback)
汇报指定的证书颁发者。
参数:
updateCertificateIssuerRequest
- 用于更新证书颁发者请求的分组属性
serviceCallback
- 用于处理成功和失败响应的异步 ServiceCallback。
返回:
对象ServiceFuture
引发:
IllegalArgumentException
- 如果回调为 null,则引发
updateCertificateOperation
public CertificateOperation updateCertificateOperation(UpdateCertificateOperationRequest updateCertificateOperationRequest)
汇报证书操作。
参数:
updateCertificateOperationRequest
- 用于更新证书操作请求的分组属性
返回:
如果成功,则为 CertificateOperation。
updateCertificateOperationAsync
public ServiceFuture updateCertificateOperationAsync(UpdateCertificateOperationRequest updateCertificateOperationRequest, final ServiceCallback serviceCallback)
汇报证书操作。
参数:
updateCertificateOperationRequest
- 用于更新证书操作请求的分组属性
serviceCallback
- 用于处理成功和失败响应的异步 ServiceCallback。
返回:
对象ServiceFuture
updateCertificatePolicy
public CertificatePolicy updateCertificatePolicy(UpdateCertificatePolicyRequest updateCertificatePolicyRequest)
汇报证书的策略。 在 certificatePolicy 中设置必须更新的相应成员。 将其他人保留为 null。
参数:
updateCertificatePolicyRequest
- 用于更新证书策略请求的分组属性
返回:
如果成功,则为 CertificatePolicy。
updateCertificatePolicyAsync
public ServiceFuture updateCertificatePolicyAsync(UpdateCertificatePolicyRequest updateCertificatePolicyRequest, final ServiceCallback serviceCallback)
汇报证书的策略。 在 certificatePolicy 中设置必须更新的相应成员。 将其他人保留为 null。
参数:
updateCertificatePolicyRequest
- 用于更新证书策略请求的分组属性
serviceCallback
- 用于处理成功和失败响应的异步 ServiceCallback。
返回:
对象ServiceFuture
updateKey
public KeyBundle updateKey(UpdateKeyRequest updateKeyRequest)
更新密钥操作会更改存储密钥的指定属性,并可以应用于 Azure 密钥保管库中存储的任何密钥类型和密钥版本。 不能更改密钥本身的加密材料。 若要执行此操作,该密钥必须已存在于密钥保管库中。 授权:需要密钥/更新权限。
参数:
updateKeyRequest
- 用于更新密钥请求的分组属性
返回:
如果成功,则为 KeyBundle。
updateKeyAsync
public ServiceFuture updateKeyAsync(UpdateKeyRequest updateKeyRequest, final ServiceCallback serviceCallback)
更新密钥操作会更改存储密钥的指定属性,并可以应用于 Azure 密钥保管库中存储的任何密钥类型和密钥版本。 不能更改密钥本身的加密材料。 若要执行此操作,该密钥必须已存在于密钥保管库中。 授权:需要密钥/更新权限。
参数:
updateKeyRequest
- 用于更新密钥请求的分组属性
serviceCallback
- 用于处理成功和失败响应的异步 ServiceCallback。
返回:
对象ServiceFuture
updateSecret
public SecretBundle updateSecret(UpdateSecretRequest updateSecretRequest)
汇报与给定密钥保管库中的指定机密关联的属性。
参数:
updateSecretRequest
- 用于更新机密请求的分组属性
返回:
如果成功,则为 SecretBundle。
updateSecretAsync
public ServiceFuture updateSecretAsync(UpdateSecretRequest updateSecretRequest, final ServiceCallback serviceCallback)
汇报与给定密钥保管库中的指定机密关联的属性。
参数:
updateSecretRequest
- 用于更新机密请求的分组属性
serviceCallback
- 用于处理成功和失败响应的异步 ServiceCallback。
返回:
对象ServiceFuture
userAgent
public String userAgent()
获取客户端的 User-Agent 标头。
返回:
用户代理字符串。
verify
public KeyVerifyResult verify(String keyIdentifier, JsonWebKeySignatureAlgorithm algorithm, byte[] digest, byte[] signature)
使用指定的密钥验证签名。
参数:
keyIdentifier
- 完整的密钥标识符
algorithm
- 签名/验证算法。 有关可能的算法类型的详细信息,请参阅 JsonWebKeySignatureAlgorithm。
digest
- 用于签名的摘要
signature
- 要验证的签名
返回:
如果成功,则为 KeyVerifyResult。
verifyAsync
public ServiceFuture verifyAsync(String keyIdentifier, JsonWebKeySignatureAlgorithm algorithm, byte[] digest, byte[] signature, final ServiceCallback serviceCallback)
使用指定的密钥验证签名。
参数:
keyIdentifier
- 完整的密钥标识符
algorithm
- 签名/验证算法。 有关可能的算法类型的详细信息,请参阅 JsonWebKeySignatureAlgorithm。
digest
- 用于签名的摘要
signature
- 要验证的签名
serviceCallback
- 用于处理成功和失败响应的异步 ServiceCallback。
返回:
对象ServiceFuture
withAcceptLanguage
public void withAcceptLanguage(String acceptLanguage)
设置 获取或设置响应的首选语言。
参数:
acceptLanguage
- acceptLanguage 值。
withGenerateClientRequestId
public void withGenerateClientRequestId(boolean generateClientRequestId)
设置 当设置为 true 时,将生成唯一的 x-ms-client-request-id 值并将其包含在每个请求中。 默认为 true。
参数:
generateClientRequestId
- generateClientRequestId 值。
withLongRunningOperationRetryTimeout
public void withLongRunningOperationRetryTimeout(int longRunningOperationRetryTimeout)
设置 获取或设置长时间运行操作的重试超时(以秒为单位)。 默认值为 30。
参数:
longRunningOperationRetryTimeout
- longRunningOperationRetryTimeout 值。
wrapKey
public KeyOperationResult wrapKey(String keyIdentifier, JsonWebKeyEncryptionAlgorithm algorithm, byte[] value)
使用指定的密钥包装对称密钥。
参数:
keyIdentifier
- 完整的密钥标识符
algorithm
- 算法标识符
value
- 要包装的键
返回:
如果成功,则为 KeyOperationResult。
wrapKeyAsync
public ServiceFuture wrapKeyAsync(String keyIdentifier, JsonWebKeyEncryptionAlgorithm algorithm, byte[] value, final ServiceCallback serviceCallback)
使用指定的密钥包装对称密钥。
参数:
keyIdentifier
- 完整的密钥标识符
algorithm
- 算法标识符
value
- 要包装的键
serviceCallback
- 用于处理成功和失败响应的异步 ServiceCallback。
返回:
对象ServiceFuture
适用于