Interface VaultApi
@Consumes("application/json")
public interface VaultApi
-
Nested Class Summary
Nested Classes -
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionbackupSecret
(URI vaultBaseUrl, String secretName) createCertificate
(URI vaultBaseUrl, String certificateName, Certificate.CertificateAttributes attributes, Certificate.CertificatePolicy policy, Map<String, String> tags) createKey
(URI vaultBaseUrl, String keyName, Key.KeyAttributes attributes, String curveName, List<String> keyOps, int keySize, String keyType, Map<String, String> tags) createOrUpdateVault
(String vaultName, String location, VaultProperties properties, Map<String, String> tags) deleteCertificate
(URI vaultBaseUrl, String certificateName) deleteCertificateContacts
(URI vaultBaseUrl) deleteCertificateIssuer
(URI vaultBaseUrl, String issuerName) deleteCertificateOperation
(URI vaultBaseUrl, String certificateName) deleteSecret
(URI vaultBaseUrl, String secretName) boolean
deleteVault
(String vaultName) getCertificate
(URI vaultBaseUrl, String certificateName, String certificateVersion) getCertificateContacts
(URI vaultBaseUrl) getCertificateIssuer
(URI vaultBaseUrl, String issuerName) getCertificateIssuers
(URI vaultBaseUrl) getCertificateOperation
(URI vaultBaseUrl, String certificateName) getCertificatePolicy
(URI vaultBaseUrl, String certificateName) getCertificates
(URI vaultBaseUrl) getCertificateVersions
(URI vaultBaseUrl, String certificateName) getDeletedCertificate
(URI vaultBaseUrl, String certificateName) getDeletedCertificates
(URI vaultBaseUrl) getDeletedKey
(URI vaultBaseUrl, String keyName) getDeletedSecret
(URI vaultBaseUrl, String secretName) getDeletedVault
(String location, String vaultName) getKeyVersions
(URI vaultBaseUrl, String keyName) getSecretVersions
(URI vaultBaseUrl, String secretName) importCertificate
(URI vaultBaseUrl, String certificateName, Certificate.CertificateAttributes attributes, Certificate.CertificatePolicy policy, String password, Map<String, String> tags, String value) importKey
(URI vaultBaseUrl, String keyName, boolean hsm, Key.KeyAttributes attributes, Key.JsonWebKey key, Map<String, String> tags) listDeletedKeys
(URI vaultBaseUrl) listDeletedSecrets
(URI vaultBaseUrl) listSecrets
(URI keyVaultUri) mergeCertificate
(URI vaultBaseUrl, String certificateName, Certificate.CertificateAttributes attributes, Map<String, String> tags, List<String> value) boolean
purgeDeletedCertificate
(URI vaultBaseUrl, String certificateName) boolean
purgeDeletedKey
(URI vaultBaseUrl, String keyName) boolean
purgeDeletedSecret
(URI vaultBaseUrl, String secretName) boolean
purgeVault
(String location, String vaultName) recoverDeletedCertificate
(URI vaultBaseUrl, String certificateName) recoverDeletedKey
(URI vaultBaseUrl, String keyName) recoverDeletedSecret
(URI vaultBaseUrl, String secretName) restoreKey
(URI vaultBaseUrl, String keyInfo) restoreSecret
(URI vaultBaseUrl, String secretInfo) setCertificateContacts
(URI vaultBaseUrl, List<Certificate.Contact> contacts) setCertificateIssuer
(URI vaultBaseUrl, String issuerName, Certificate.IssuerAttributes attributes, Certificate.IssuerCredentials credentials, Certificate.OrganizationDetails orgDetails, String provider) setSecret
(URI keyVaultUri, String secretName, Secret.SecretAttributes attributes, String contentType, Map<String, String> tags, String value) updateCertificate
(URI vaultBaseUrl, String certificateName, String certificateVersion, Certificate.CertificateAttributes attributes, Certificate.CertificatePolicy policy, Map<String, String> tags) updateCertificateIssuer
(URI vaultBaseUrl, String issuerName, Certificate.IssuerAttributes attributes, Certificate.IssuerCredentials credentials, Certificate.OrganizationDetails orgDetails, String provider) updateCertificateOperation
(URI vaultBaseUrl, String certificateName, boolean cancellationRequested) updateCertificatePolicy
(URI vaultBaseUrl, String certificateName, Certificate.CertificateAttributes attributes, Certificate.IssuerParameters issuer, Certificate.KeyProperties keyProps, List<Certificate.LifetimeAction> lifetimeActions, Certificate.SecretProperties secretProps, Certificate.X509CertificateProperties x509Props) updateKey
(URI vaultBaseUrl, String keyName, String keyVersion, Key.KeyAttributes attributes, List<String> keyOps, Map<String, String> tags) updateSecret
(URI vaultBaseUrl, String secretName, String secretVersion, Secret.SecretAttributes attributes, String contentType, Map<String, String> tags) boolean
verify
(URI vaultBaseUrl, String keyName, String keyVersion, String algorithm, String digest, String value)
-
Field Details
-
VAULT_API_STANDARD_ENDPOINT
- See Also:
-
VAULT_API_CHINA_ENDPOINT
- See Also:
-
-
Method Details
-
listVaults
-
createOrUpdateVault
-
getVault
-
deleteVault
@Named("vault:delete") @Path("/resourcegroups/{resourcegroup}/providers/Microsoft.KeyVault/vaults/{vaultName}") @DELETE boolean deleteVault(@PathParam("vaultName") String vaultName) -
listDeletedVaults
@Named("vault:list_deleted_vaults") @Path("/providers/Microsoft.KeyVault/deletedVaults") @GET List<Vault.DeletedVault> listDeletedVaults() -
getDeletedVault
@Named("vault:get_deleted") @GET @Path("/providers/Microsoft.KeyVault/locations/{location}/deletedVaults/{vaultName}") Vault.DeletedVault getDeletedVault(@PathParam("location") String location, @PathParam("vaultName") String vaultName) -
purgeVault
-
listKeys
-
createKey
@Named("key:create") @POST @Path("/keys/{keyName}/create") Key.KeyBundle createKey(URI vaultBaseUrl, @PathParam("keyName") String keyName, @Nullable Key.KeyAttributes attributes, @Nullable String curveName, @Nullable List<String> keyOps, int keySize, String keyType, @Nullable Map<String, String> tags) -
importKey
@Named("key:import") @PUT @Path("/keys/{keyName}") Key.KeyBundle importKey(URI vaultBaseUrl, @PathParam("keyName") String keyName, boolean hsm, @Nullable Key.KeyAttributes attributes, @Nullable Key.JsonWebKey key, @Nullable Map<String, String> tags) -
getKey
@Named("key:get") @GET @Path("/keys/{keyName}") Key.KeyBundle getKey(URI vaultBaseUrl, @PathParam("keyName") String keyName) -
deleteKey
@Named("key:delete") @DELETE @Path("/keys/{keyName}") Key.DeletedKeyBundle deleteKey(URI vaultBaseUrl, @PathParam("keyName") String keyName) -
getKeyVersions
-
updateKey
-
backupKey
-
restoreKey
@Named("key:restore") @POST @Path("/keys/restore") Key.KeyBundle restoreKey(URI vaultBaseUrl, String keyInfo) -
listDeletedKeys
@Named("key:list_deleted") @GET @Path("/deletedkeys") List<Key.DeletedKeyBundle> listDeletedKeys(URI vaultBaseUrl) -
getDeletedKey
@Named("key:get_deleted") @GET @Path("/deletedkeys/{keyName}") Key.DeletedKeyBundle getDeletedKey(URI vaultBaseUrl, @PathParam("keyName") String keyName) -
recoverDeletedKey
@Named("key:recover_deleted") @POST @Path("/deletedkeys/{keyName}/recover") Key.KeyBundle recoverDeletedKey(URI vaultBaseUrl, @PathParam("keyName") String keyName) -
purgeDeletedKey
-
encrypt
-
decrypt
-
sign
-
verify
-
wrap
-
unwrap
-
listSecrets
-
setSecret
-
getSecret
@Named("secret:get") @GET @Path("/secrets/{secretName}{secretVersion}") Secret.SecretBundle getSecret(URI vaultBaseUrl, @PathParam("secretName") String secretName, @Nullable @PathParam("secretVersion") String secretVersion) -
deleteSecret
@Named("secret:delete") @DELETE @Path("/secrets/{secretName}") Secret.DeletedSecretBundle deleteSecret(URI vaultBaseUrl, @PathParam("secretName") String secretName) -
getSecretVersions
-
updateSecret
@Named("secret:update") @Path("/secrets/{secretName}{secretVersion}") Secret.SecretBundle updateSecret(URI vaultBaseUrl, @PathParam("secretName") String secretName, @Nullable @PathParam("secretVersion") String secretVersion, @Nullable Secret.SecretAttributes attributes, @Nullable String contentType, @Nullable Map<String, String> tags) -
backupSecret
-
restoreSecret
@Named("secret:restore") @POST @Path("/secrets/restore") Secret.SecretBundle restoreSecret(URI vaultBaseUrl, String secretInfo) -
listDeletedSecrets
@Named("secret:list_deleted") @GET @Path("/deletedsecrets") List<Secret.DeletedSecretBundle> listDeletedSecrets(URI vaultBaseUrl) -
getDeletedSecret
@Named("secret:get_deleted") @GET @Path("/deletedsecrets/{secretName}") Secret.DeletedSecretBundle getDeletedSecret(URI vaultBaseUrl, @PathParam("secretName") String secretName) -
recoverDeletedSecret
@Named("secret:recover_deleted") @POST @Path("/deletedsecrets/{secretName}/recover") Secret.SecretBundle recoverDeletedSecret(URI vaultBaseUrl, @PathParam("secretName") String secretName) -
purgeDeletedSecret
-
createCertificate
@Named("certificate:create") @POST @Path("/certificates/{certificateName}/create") Certificate.CertificateOperation createCertificate(URI vaultBaseUrl, @PathParam("certificateName") String certificateName, @Nullable Certificate.CertificateAttributes attributes, @Nullable Certificate.CertificatePolicy policy, @Nullable Map<String, String> tags) -
getCertificate
@Named("certificate:get") @GET @Path("/certificates/{certificateName}{certificateVersion}") Certificate.CertificateBundle getCertificate(URI vaultBaseUrl, @PathParam("certificateName") String certificateName, @Nullable @PathParam("certificateVersion") String certificateVersion) -
deleteCertificate
@Named("certificate:delete") @DELETE @Path("/certificates/{certificateName}") Certificate.DeletedCertificateBundle deleteCertificate(URI vaultBaseUrl, @PathParam("certificateName") String certificateName) -
getCertificates
@Named("certificate:list") @GET @Path("/certificates") List<Certificate> getCertificates(URI vaultBaseUrl) -
getDeletedCertificates
@Named("certificate:list_deleted") @GET @Path("/deletedcertificates") List<Certificate.DeletedCertificate> getDeletedCertificates(URI vaultBaseUrl) -
getDeletedCertificate
@Named("certificate:get_deleted") @GET @Path("/deletedcertificates/{certificateName}") Certificate.DeletedCertificateBundle getDeletedCertificate(URI vaultBaseUrl, @PathParam("certificateName") String certificateName) -
recoverDeletedCertificate
@Named("certificate:recover_deleted") @POST @Path("/deletedcertificates/{certificateName}/recover") Certificate.CertificateBundle recoverDeletedCertificate(URI vaultBaseUrl, @PathParam("certificateName") String certificateName) -
purgeDeletedCertificate
-
getCertificateVersions
@Named("certificate:get_versions") @GET @Path("/certificates/{certificateName}/versions") List<Certificate> getCertificateVersions(URI vaultBaseUrl, @PathParam("certificateName") String certificateName) -
updateCertificate
@Named("certificate:update") @Path("/certificates/{certificateName}{certificateVersion}") Certificate.CertificateBundle updateCertificate(URI vaultBaseUrl, @PathParam("certificateName") String certificateName, @Nullable @PathParam("certificateVersion") String certificateVersion, @Nullable Certificate.CertificateAttributes attributes, @Nullable Certificate.CertificatePolicy policy, @Nullable Map<String, String> tags) -
importCertificate
@Named("certificate:import") @POST @Path("/certificates/{certificateName}/import") Certificate.CertificateBundle importCertificate(URI vaultBaseUrl, @PathParam("certificateName") String certificateName, @Nullable Certificate.CertificateAttributes attributes, @Nullable Certificate.CertificatePolicy policy, @Nullable String password, @Nullable Map<String, String> tags, String value) -
mergeCertificate
@Named("certificate:merge") @POST @Path("/certificates/{certificateName}/pending/merge") Certificate.CertificateBundle mergeCertificate(URI vaultBaseUrl, @PathParam("certificateName") String certificateName, @Nullable Certificate.CertificateAttributes attributes, @Nullable Map<String, String> tags, List<String> value) -
getCertificateOperation
@Named("certificate:get_operation") @GET @Path("/certificates/{certificateName}/pending") Certificate.CertificateOperation getCertificateOperation(URI vaultBaseUrl, @PathParam("certificateName") String certificateName) -
updateCertificateOperation
@Named("certificate:update_operation") @Path("/certificates/{certificateName}/pending") Certificate.CertificateOperation updateCertificateOperation(URI vaultBaseUrl, @PathParam("certificateName") String certificateName, boolean cancellationRequested) -
deleteCertificateOperation
@Named("certificate:delete_operation") @DELETE @Path("/certificates/{certificateName}/pending") Certificate.CertificateOperation deleteCertificateOperation(URI vaultBaseUrl, @PathParam("certificateName") String certificateName) -
setCertificateIssuer
@Named("certificate:set_issuer") @PUT @Path("/certificates/issuers/{issuerName}") Certificate.IssuerBundle setCertificateIssuer(URI vaultBaseUrl, @PathParam("issuerName") String issuerName, @Nullable Certificate.IssuerAttributes attributes, @Nullable Certificate.IssuerCredentials credentials, @Nullable Certificate.OrganizationDetails orgDetails, String provider) -
getCertificateIssuers
@Named("certificate:get_issuers") @GET @Path("/certificates/issuers") List<Certificate.CertificateIssuer> getCertificateIssuers(URI vaultBaseUrl) -
getCertificateIssuer
@Named("certificate:get_issuer") @GET @Path("/certificates/issuers/{issuerName}") Certificate.IssuerBundle getCertificateIssuer(URI vaultBaseUrl, @PathParam("issuerName") String issuerName) -
updateCertificateIssuer
@Named("certificate:update_issuer") @Path("/certificates/issuers/{issuerName}") Certificate.IssuerBundle updateCertificateIssuer(URI vaultBaseUrl, @PathParam("issuerName") String issuerName, @Nullable Certificate.IssuerAttributes attributes, @Nullable Certificate.IssuerCredentials credentials, @Nullable Certificate.OrganizationDetails orgDetails, String provider) -
deleteCertificateIssuer
@Named("certificate:delete_issuer") @DELETE @Path("/certificates/issuers/{issuerName}") Certificate.IssuerBundle deleteCertificateIssuer(URI vaultBaseUrl, @PathParam("issuerName") String issuerName) -
getCertificateContacts
@Named("certificate:get_contacts") @GET @Path("/certificates/contacts") Certificate.Contacts getCertificateContacts(URI vaultBaseUrl) -
setCertificateContacts
@Named("certificate:set_contacts") @PUT @Path("/certificates/contacts") Certificate.Contacts setCertificateContacts(URI vaultBaseUrl, List<Certificate.Contact> contacts) -
deleteCertificateContacts
@Named("certificate:delete_contacts") @DELETE @Path("/certificates/contacts") Certificate.Contacts deleteCertificateContacts(URI vaultBaseUrl) -
getCertificatePolicy
@Named("certificate:get_policy") @GET @Path("/certificates/{certificateName}/policy") Certificate.CertificatePolicy getCertificatePolicy(URI vaultBaseUrl, @PathParam("certificateName") String certificateName) -
updateCertificatePolicy
@Named("certificate:update_policy") @Path("/certificates/{certificateName}/policy") Certificate.CertificatePolicy updateCertificatePolicy(URI vaultBaseUrl, @PathParam("certificateName") String certificateName, @Nullable Certificate.CertificateAttributes attributes, @Nullable Certificate.IssuerParameters issuer, @Nullable Certificate.KeyProperties keyProps, @Nullable List<Certificate.LifetimeAction> lifetimeActions, @Nullable Certificate.SecretProperties secretProps, @Nullable Certificate.X509CertificateProperties x509Props)
-