@datafire/azure_keyvault

v5.0.0

Published

3 years ago

DataFire integration for KeyVaultClient

Downloads

0High
0Medium
0Low

datafire

@datafire/azure_keyvault

Client library for KeyVaultClient

Installation and Usage

npm install --save @datafire/azure_keyvault

let azure_keyvault = require('@datafire/azure_keyvault').create();

.then(data => {
  console.log(data);
});

Description

The key vault client performs cryptographic key operations and vault operations against the Key Vault service.

Actions

GetCertificates

The GetCertificates operation returns the set of certificates resources in the specified key vault. This operation requires the certificates/list permission.

azure_keyvault.GetCertificates({
  "api-version": ""
}, context)

Input

input object
- maxresults integer: Maximum number of results to return in a page. If not specified the service will return up to 25 results.
- includePending boolean: Specifies whether to include certificates which are not completely provisioned.
- api-version required string: Client API version.

Output

output CertificateListResult

DeleteCertificateContacts

Deletes the certificate contacts for a specified key vault certificate. This operation requires the certificates/managecontacts permission.

azure_keyvault.DeleteCertificateContacts({
  "api-version": ""
}, context)

Input

input object
- api-version required string: Client API version.

Output

output Contacts

GetCertificateContacts

The GetCertificateContacts operation returns the set of certificate contact resources in the specified key vault. This operation requires the certificates/managecontacts permission.

azure_keyvault.GetCertificateContacts({
  "api-version": ""
}, context)

Input

input object
- api-version required string: Client API version.

Output

output Contacts

SetCertificateContacts

Sets the certificate contacts for the specified key vault. This operation requires the certificates/managecontacts permission.

azure_keyvault.SetCertificateContacts({
  "contacts": null,
  "api-version": ""
}, context)

Input

input object
- contacts required Contacts
- api-version required string: Client API version.

Output

output Contacts

GetCertificateIssuers

The GetCertificateIssuers operation returns the set of certificate issuer resources in the specified key vault. This operation requires the certificates/manageissuers/getissuers permission.

azure_keyvault.GetCertificateIssuers({
  "api-version": ""
}, context)

Input

input object
- maxresults integer: Maximum number of results to return in a page. If not specified the service will return up to 25 results.
- api-version required string: Client API version.

Output

output CertificateIssuerListResult

DeleteCertificateIssuer

The DeleteCertificateIssuer operation permanently removes the specified certificate issuer from the vault. This operation requires the certificates/manageissuers/deleteissuers permission.

azure_keyvault.DeleteCertificateIssuer({
  "issuer-name": "",
  "api-version": ""
}, context)

Input

input object
- issuer-name required string: The name of the issuer.
- api-version required string: Client API version.

Output

output IssuerBundle

GetCertificateIssuer

The GetCertificateIssuer operation returns the specified certificate issuer resources in the specified key vault. This operation requires the certificates/manageissuers/getissuers permission.

azure_keyvault.GetCertificateIssuer({
  "issuer-name": "",
  "api-version": ""
}, context)

Input

input object
- issuer-name required string: The name of the issuer.
- api-version required string: Client API version.

Output

output IssuerBundle

UpdateCertificateIssuer

The UpdateCertificateIssuer operation performs an update on the specified certificate issuer entity. This operation requires the certificates/setissuers permission.

azure_keyvault.UpdateCertificateIssuer({
  "issuer-name": "",
  "parameter": null,
  "api-version": ""
}, context)

Input

input object
- issuer-name required string: The name of the issuer.
- parameter required CertificateIssuerUpdateParameters
- api-version required string: Client API version.

Output

output IssuerBundle

SetCertificateIssuer

The SetCertificateIssuer operation adds or updates the specified certificate issuer. This operation requires the certificates/setissuers permission.

azure_keyvault.SetCertificateIssuer({
  "issuer-name": "",
  "parameter": null,
  "api-version": ""
}, context)

Input

input object
- issuer-name required string: The name of the issuer.
- parameter required CertificateIssuerSetParameters
- api-version required string: Client API version.

Output

output IssuerBundle

RestoreCertificate

Restores a backed up certificate, and all its versions, to a vault. This operation requires the certificates/restore permission.

azure_keyvault.RestoreCertificate({
  "parameters": null,
  "api-version": ""
}, context)

Input

input object
- parameters required CertificateRestoreParameters
- api-version required string: Client API version.

Output

output CertificateBundle

DeleteCertificate

Deletes all versions of a certificate object along with its associated policy. Delete certificate cannot be used to remove individual versions of a certificate object. This operation requires the certificates/delete permission.

azure_keyvault.DeleteCertificate({
  "certificate-name": "",
  "api-version": ""
}, context)

Input

input object
- certificate-name required string: The name of the certificate.
- api-version required string: Client API version.

Output

output DeletedCertificateBundle

BackupCertificate

Requests that a backup of the specified certificate be downloaded to the client. All versions of the certificate will be downloaded. This operation requires the certificates/backup permission.

azure_keyvault.BackupCertificate({
  "certificate-name": "",
  "api-version": ""
}, context)

Input

input object
- certificate-name required string: The name of the certificate.
- api-version required string: Client API version.

Output

output BackupCertificateResult

CreateCertificate

If this is the first version, the certificate resource is created. This operation requires the certificates/create permission.

azure_keyvault.CreateCertificate({
  "certificate-name": "",
  "parameters": null,
  "api-version": ""
}, context)

Input

input object
- certificate-name required string: The name of the certificate.
- parameters required CertificateCreateParameters
- api-version required string: Client API version.

Output

output CertificateOperation

ImportCertificate

Imports an existing valid certificate, containing a private key, into Azure Key Vault. The certificate to be imported can be in either PFX or PEM format. If the certificate is in PEM format the PEM file must contain the key as well as x509 certificates. This operation requires the certificates/import permission.

azure_keyvault.ImportCertificate({
  "certificate-name": "",
  "parameters": null,
  "api-version": ""
}, context)

Input

input object
- certificate-name required string: The name of the certificate.
- parameters required CertificateImportParameters
- api-version required string: Client API version.

Output

output CertificateBundle

DeleteCertificateOperation

Deletes the creation operation for a specified certificate that is in the process of being created. The certificate is no longer created. This operation requires the certificates/update permission.

azure_keyvault.DeleteCertificateOperation({
  "certificate-name": "",
  "api-version": ""
}, context)

Input

input object
- certificate-name required string: The name of the certificate.
- api-version required string: Client API version.

Output

output CertificateOperation

GetCertificateOperation

Gets the creation operation associated with a specified certificate. This operation requires the certificates/get permission.

azure_keyvault.GetCertificateOperation({
  "certificate-name": "",
  "api-version": ""
}, context)

Input

input object
- certificate-name required string: The name of the certificate.
- api-version required string: Client API version.

Output

output CertificateOperation

UpdateCertificateOperation

Updates a certificate creation operation that is already in progress. This operation requires the certificates/update permission.

azure_keyvault.UpdateCertificateOperation({
  "certificate-name": "",
  "certificateOperation": null,
  "api-version": ""
}, context)

Input

input object
- certificate-name required string: The name of the certificate.
- certificateOperation required CertificateOperationUpdateParameter
- api-version required string: Client API version.

Output

output CertificateOperation

MergeCertificate

The MergeCertificate operation performs the merging of a certificate or certificate chain with a key pair currently available in the service. This operation requires the certificates/create permission.

azure_keyvault.MergeCertificate({
  "certificate-name": "",
  "parameters": null,
  "api-version": ""
}, context)

Input

input object
- certificate-name required string: The name of the certificate.
- parameters required CertificateMergeParameters
- api-version required string: Client API version.

Output

output CertificateBundle

GetCertificatePolicy

The GetCertificatePolicy operation returns the specified certificate policy resources in the specified key vault. This operation requires the certificates/get permission.

azure_keyvault.GetCertificatePolicy({
  "certificate-name": "",
  "api-version": ""
}, context)

Input

input object
- certificate-name required string: The name of the certificate in a given key vault.
- api-version required string: Client API version.

Output

output CertificatePolicy

UpdateCertificatePolicy

Set specified members in the certificate policy. Leave others as null. This operation requires the certificates/update permission.

azure_keyvault.UpdateCertificatePolicy({
  "certificate-name": "",
  "certificatePolicy": null,
  "api-version": ""
}, context)

Input

input object
- certificate-name required string: The name of the certificate in the given vault.
- certificatePolicy required CertificatePolicy
- api-version required string: Client API version.

Output

output CertificatePolicy

GetCertificateVersions

The GetCertificateVersions operation returns the versions of a certificate in the specified key vault. This operation requires the certificates/list permission.

azure_keyvault.GetCertificateVersions({
  "certificate-name": "",
  "api-version": ""
}, context)

Input

input object
- certificate-name required string: The name of the certificate.
- maxresults integer: Maximum number of results to return in a page. If not specified the service will return up to 25 results.
- api-version required string: Client API version.

Output

output CertificateListResult

GetCertificate

Gets information about a specific certificate. This operation requires the certificates/get permission.

azure_keyvault.GetCertificate({
  "certificate-name": "",
  "certificate-version": "",
  "api-version": ""
}, context)

Input

input object
- certificate-name required string: The name of the certificate in the given vault.
- certificate-version required string: The version of the certificate.
- api-version required string: Client API version.

Output

output CertificateBundle

UpdateCertificate

The UpdateCertificate operation applies the specified update on the given certificate; the only elements updated are the certificate's attributes. This operation requires the certificates/update permission.

azure_keyvault.UpdateCertificate({
  "certificate-name": "",
  "certificate-version": "",
  "parameters": null,
  "api-version": ""
}, context)

Input

input object
- certificate-name required string: The name of the certificate in the given key vault.
- certificate-version required string: The version of the certificate.
- parameters required CertificateUpdateParameters
- api-version required string: Client API version.

Output

output CertificateBundle

GetDeletedCertificates

The GetDeletedCertificates operation retrieves the certificates in the current vault which are in a deleted state and ready for recovery or purging. This operation includes deletion-specific information. This operation requires the certificates/get/list permission. This operation can only be enabled on soft-delete enabled vaults.

azure_keyvault.GetDeletedCertificates({
  "api-version": ""
}, context)

Input

input object
- maxresults integer: Maximum number of results to return in a page. If not specified the service will return up to 25 results.
- includePending boolean: Specifies whether to include certificates which are not completely provisioned.
- api-version required string: Client API version.

Output

output DeletedCertificateListResult

PurgeDeletedCertificate

The PurgeDeletedCertificate operation performs an irreversible deletion of the specified certificate, without possibility for recovery. The operation is not available if the recovery level does not specify 'Purgeable'. This operation requires the certificate/purge permission.

azure_keyvault.PurgeDeletedCertificate({
  "certificate-name": "",
  "api-version": ""
}, context)

Input

input object
- certificate-name required string: The name of the certificate
- api-version required string: Client API version.

Output

Output schema unknown

GetDeletedCertificate

The GetDeletedCertificate operation retrieves the deleted certificate information plus its attributes, such as retention interval, scheduled permanent deletion and the current deletion recovery level. This operation requires the certificates/get permission.

azure_keyvault.GetDeletedCertificate({
  "certificate-name": "",
  "api-version": ""
}, context)

Input

input object
- certificate-name required string: The name of the certificate
- api-version required string: Client API version.

Output

output DeletedCertificateBundle

RecoverDeletedCertificate

The RecoverDeletedCertificate operation performs the reversal of the Delete operation. The operation is applicable in vaults enabled for soft-delete, and must be issued during the retention interval (available in the deleted certificate's attributes). This operation requires the certificates/recover permission.

azure_keyvault.RecoverDeletedCertificate({
  "certificate-name": "",
  "api-version": ""
}, context)

Input

input object
- certificate-name required string: The name of the deleted certificate
- api-version required string: Client API version.

Output

output CertificateBundle

GetDeletedKeys

Retrieves a list of the keys in the Key Vault as JSON Web Key structures that contain the public part of a deleted key. This operation includes deletion-specific information. The Get Deleted Keys operation is applicable for vaults enabled for soft-delete. While the operation can be invoked on any vault, it will return an error if invoked on a non soft-delete enabled vault. This operation requires the keys/list permission.

azure_keyvault.GetDeletedKeys({
  "api-version": ""
}, context)

Input

input object
- maxresults integer: Maximum number of results to return in a page. If not specified the service will return up to 25 results.
- api-version required string: Client API version.

Output

output DeletedKeyListResult

PurgeDeletedKey

The Purge Deleted Key operation is applicable for soft-delete enabled vaults. While the operation can be invoked on any vault, it will return an error if invoked on a non soft-delete enabled vault. This operation requires the keys/purge permission.

azure_keyvault.PurgeDeletedKey({
  "key-name": "",
  "api-version": ""
}, context)

Input

input object
- key-name required string: The name of the key
- api-version required string: Client API version.

Output

Output schema unknown

GetDeletedKey

The Get Deleted Key operation is applicable for soft-delete enabled vaults. While the operation can be invoked on any vault, it will return an error if invoked on a non soft-delete enabled vault. This operation requires the keys/get permission.

azure_keyvault.GetDeletedKey({
  "key-name": "",
  "api-version": ""
}, context)

Input

input object
- key-name required string: The name of the key.
- api-version required string: Client API version.

Output

output DeletedKeyBundle

RecoverDeletedKey

The Recover Deleted Key operation is applicable for deleted keys in soft-delete enabled vaults. It recovers the deleted key back to its latest version under /keys. An attempt to recover an non-deleted key will return an error. Consider this the inverse of the delete operation on soft-delete enabled vaults. This operation requires the keys/recover permission.

azure_keyvault.RecoverDeletedKey({
  "key-name": "",
  "api-version": ""
}, context)

Input

input object
- key-name required string: The name of the deleted key.
- api-version required string: Client API version.

Output

output KeyBundle

GetDeletedSecrets

The Get Deleted Secrets operation returns the secrets that have been deleted for a vault enabled for soft-delete. This operation requires the secrets/list permission.

azure_keyvault.GetDeletedSecrets({
  "api-version": ""
}, context)

Input

input object
- maxresults integer: Maximum number of results to return in a page. If not specified the service will return up to 25 results.
- api-version required string: Client API version.

Output

output DeletedSecretListResult

PurgeDeletedSecret

The purge deleted secret operation removes the secret permanently, without the possibility of recovery. This operation can only be enabled on a soft-delete enabled vault. This operation requires the secrets/purge permission.

azure_keyvault.PurgeDeletedSecret({
  "secret-name": "",
  "api-version": ""
}, context)

Input

input object
- secret-name required string: The name of the secret.
- api-version required string: Client API version.

Output

Output schema unknown

GetDeletedSecret

The Get Deleted Secret operation returns the specified deleted secret along with its attributes. This operation requires the secrets/get permission.

azure_keyvault.GetDeletedSecret({
  "secret-name": "",
  "api-version": ""
}, context)

Input

input object
- secret-name required string: The name of the secret.
- api-version required string: Client API version.

Output

output DeletedSecretBundle

RecoverDeletedSecret

Recovers the deleted secret in the specified vault. This operation can only be performed on a soft-delete enabled vault. This operation requires the secrets/recover permission.

azure_keyvault.RecoverDeletedSecret({
  "secret-name": "",
  "api-version": ""
}, context)

Input

input object
- secret-name required string: The name of the deleted secret.
- api-version required string: Client API version.

Output

output SecretBundle

GetDeletedStorageAccounts

The Get Deleted Storage Accounts operation returns the storage accounts that have been deleted for a vault enabled for soft-delete. This operation requires the storage/list permission.

azure_keyvault.GetDeletedStorageAccounts({
  "api-version": ""
}, context)

Input

input object
- maxresults integer: Maximum number of results to return in a page. If not specified the service will return up to 25 results.
- api-version required string: Client API version.

Output

output DeletedStorageListResult

PurgeDeletedStorageAccount

The purge deleted storage account operation removes the secret permanently, without the possibility of recovery. This operation can only be performed on a soft-delete enabled vault. This operation requires the storage/purge permission.

azure_keyvault.PurgeDeletedStorageAccount({
  "storage-account-name": "",
  "api-version": ""
}, context)

Input

input object
- storage-account-name required string: The name of the storage account.
- api-version required string: Client API version.

Output

Output schema unknown

GetDeletedStorageAccount

The Get Deleted Storage Account operation returns the specified deleted storage account along with its attributes. This operation requires the storage/get permission.

azure_keyvault.GetDeletedStorageAccount({
  "storage-account-name": "",
  "api-version": ""
}, context)

Input

input object
- storage-account-name required string: The name of the storage account.
- api-version required string: Client API version.

Output

output DeletedStorageBundle

RecoverDeletedStorageAccount

Recovers the deleted storage account in the specified vault. This operation can only be performed on a soft-delete enabled vault. This operation requires the storage/recover permission.

azure_keyvault.RecoverDeletedStorageAccount({
  "storage-account-name": "",
  "api-version": ""
}, context)

Input

input object
- storage-account-name required string: The name of the storage account.
- api-version required string: Client API version.

Output

output StorageBundle

GetDeletedSasDefinitions

The Get Deleted Sas Definitions operation returns the SAS definitions that have been deleted for a vault enabled for soft-delete. This operation requires the storage/listsas permission.

azure_keyvault.GetDeletedSasDefinitions({
  "storage-account-name": "",
  "api-version": ""
}, context)

Input

input object
- storage-account-name required string: The name of the storage account.
- maxresults integer: Maximum number of results to return in a page. If not specified the service will return up to 25 results.
- api-version required string: Client API version.

Output

output DeletedSasDefinitionListResult

GetDeletedSasDefinition

The Get Deleted SAS Definition operation returns the specified deleted SAS definition along with its attributes. This operation requires the storage/getsas permission.

azure_keyvault.GetDeletedSasDefinition({
  "storage-account-name": "",
  "sas-definition-name": "",
  "api-version": ""
}, context)

Input

input object
- storage-account-name required string: The name of the storage account.
- sas-definition-name required string: The name of the SAS definition.
- api-version required string: Client API version.

Output

output DeletedSasDefinitionBundle

RecoverDeletedSasDefinition

Recovers the deleted SAS definition for the specified storage account. This operation can only be performed on a soft-delete enabled vault. This operation requires the storage/recover permission.

azure_keyvault.RecoverDeletedSasDefinition({
  "storage-account-name": "",
  "sas-definition-name": "",
  "api-version": ""
}, context)

Input

input object
- storage-account-name required string: The name of the storage account.
- sas-definition-name required string: The name of the SAS definition.
- api-version required string: Client API version.

Output

output SasDefinitionBundle

GetKeys

Retrieves a list of the keys in the Key Vault as JSON Web Key structures that contain the public part of a stored key. The LIST operation is applicable to all key types, however only the base key identifier, attributes, and tags are provided in the response. Individual versions of a key are not listed in the response. This operation requires the keys/list permission.

azure_keyvault.GetKeys({
  "api-version": ""
}, context)

Input

input object
- maxresults integer: Maximum number of results to return in a page. If not specified the service will return up to 25 results.
- api-version required string: Client API version.

Output

output KeyListResult

RestoreKey

Imports a previously backed up key into Azure Key Vault, restoring the key, its key identifier, attributes and access control policies. The RESTORE operation may be used to import a previously backed up key. Individual versions of a key cannot be restored. The key is restored in its entirety with the same key name as it had when it was backed up. If the key name is not available in the target Key Vault, the RESTORE operation will be rejected. While the key name is retained during restore, the final key identifier will change if the key is restored to a different vault. Restore will restore all versions and preserve version identifiers. The RESTORE operation is subject to security constraints: The target Key Vault must be owned by the same Microsoft Azure Subscription as the source Key Vault The user must have RESTORE permission in the target Key Vault. This operation requires the keys/restore permission.

azure_keyvault.RestoreKey({
  "parameters": null,
  "api-version": ""
}, context)

Input

input object
- parameters required KeyRestoreParameters
- api-version required string: Client API version.

Output

output KeyBundle

DeleteKey

The delete key operation cannot be used to remove individual versions of a key. This operation removes the cryptographic material associated with the key, which means the key is not usable for Sign/Verify, Wrap/Unwrap or Encrypt/Decrypt operations. This operation requires the keys/delete permission.

azure_keyvault.DeleteKey({
  "key-name": "",
  "api-version": ""
}, context)

Input

input object
- key-name required string: The name of the key to delete.
- api-version required string: Client API version.

Output

output DeletedKeyBundle

ImportKey

The import key operation may be used to import any key type into an Azure Key Vault. If the named key already exists, Azure Key Vault creates a new version of the key. This operation requires the keys/import permission.

azure_keyvault.ImportKey({
  "key-name": "",
  "parameters": null,
  "api-version": ""
}, context)

Input

input object
- key-name required string: Name for the imported key.
- parameters required KeyImportParameters
- api-version required string: Client API version.

Output

output KeyBundle

BackupKey

The Key Backup operation exports a key from Azure Key Vault in a protected form. Note that this operation does NOT return key material in a form that can be used outside the Azure Key Vault system, the returned key material is either protected to a Azure Key Vault HSM or to Azure Key Vault itself. The intent of this operation is to allow a client to GENERATE a key in one Azure Key Vault instance, BACKUP the key, and then RESTORE it into another Azure Key Vault instance. The BACKUP operation may be used to export, in protected form, any key type from Azure Key Vault. Individual versions of a key cannot be backed up. BACKUP / RESTORE can be performed within geographical boundaries only; meaning that a BACKUP from one geographical area cannot be restored to another geographical area. For example, a backup from the US geographical area cannot be restored in an EU geographical area. This operation requires the key/backup permission.

azure_keyvault.BackupKey({
  "key-name": "",
  "api-version": ""
}, context)

Input

input object
- key-name required string: The name of the key.
- api-version required string: Client API version.

Output

output BackupKeyResult

CreateKey

The create key operation can be used to create any key type in Azure Key Vault. If the named key already exists, Azure Key Vault creates a new version of the key. It requires the keys/create permission.

azure_keyvault.CreateKey({
  "key-name": "",
  "parameters": null,
  "api-version": ""
}, context)

Input

input object
- key-name required string: The name for the new key. The system will generate the version name for the new key.
- parameters required KeyCreateParameters
- api-version required string: Client API version.

Output

output KeyBundle

GetKeyVersions

The full key identifier, attributes, and tags are provided in the response. This operation requires the keys/list permission.

azure_keyvault.GetKeyVersions({
  "key-name": "",
  "api-version": ""
}, context)

Input

input object
- key-name required string: The name of the key.
- maxresults integer: Maximum number of results to return in a page. If not specified the service will return up to 25 results.
- api-version required string: Client API version.

Output

output KeyListResult

GetKey

The get key operation is applicable to all key types. If the requested key is symmetric, then no key material is released in the response. This operation requires the keys/get permission.

azure_keyvault.GetKey({
  "key-name": "",
  "key-version": "",
  "api-version": ""
}, context)

Input

input object
- key-name required string: The name of the key to get.
- key-version required string: Adding the version parameter retrieves a specific version of a key.
- api-version required string: Client API version.

Output

output KeyBundle

UpdateKey

In order to perform this operation, the key must already exist in the Key Vault. Note: The cryptographic material of a key itself cannot be changed. This operation requires the keys/update permission.

azure_keyvault.UpdateKey({
  "key-name": "",
  "key-version": "",
  "parameters": null,
  "api-version": ""
}, context)

Input

input object
- key-name required string: The name of key to update.
- key-version required string: The version of the key to update.
- parameters required KeyUpdateParameters
- api-version required string: Client API version.

Output

output KeyBundle

decrypt

The DECRYPT operation decrypts a well-formed block of ciphertext using the target encryption key and specified algorithm. This operation is the reverse of the ENCRYPT operation; only a single block of data may be decrypted, the size of this block is dependent on the target key and the algorithm to be used. The DECRYPT operation applies to asymmetric and symmetric keys stored in Azure Key Vault since it uses the private portion of the key. This operation requires the keys/decrypt permission.

azure_keyvault.decrypt({
  "key-name": "",
  "key-version": "",
  "parameters": null,
  "api-version": ""
}, context)

Input

input object
- key-name required string: The name of the key.
- key-version required string: The version of the key.
- parameters required KeyOperationsParameters
- api-version required string: Client API version.

Output

output KeyOperationResult

encrypt

The ENCRYPT operation encrypts an arbitrary sequence of bytes using an encryption key that is stored in Azure Key Vault. Note that the ENCRYPT operation only supports a single block of data, the size of which is dependent on the target key and the encryption algorithm to be used. The ENCRYPT operation is only strictly necessary for symmetric keys stored in Azure Key Vault since protection with an asymmetric key can be performed using public portion of the key. This operation is supported for asymmetric keys as a convenience for callers that have a key-reference but do not have access to the public key material. This operation requires the keys/encrypt permission.

azure_keyvault.encrypt({
  "key-name": "",
  "key-version": "",
  "parameters": null,
  "api-version": ""
}, context)

Input

input object
- key-name required string: The name of the key.
- key-version required string: The version of the key.
- parameters required KeyOperationsParameters
- api-version required string: Client API version.

Output

output KeyOperationResult

sign

The SIGN operation is applicable to asymmetric and symmetric keys stored in Azure Key Vault since this operation uses the private portion of the key. This operation requires the keys/sign permission.

azure_keyvault.sign({
  "key-name": "",
  "key-version": "",
  "parameters": null,
  "api-version": ""
}, context)

Input

input object
- key-name required string: The name of the key.
- key-version required string: The version of the key.
- parameters required KeySignParameters
- api-version required string: Client API version.

Output

output KeyOperationResult

unwrapKey

The UNWRAP operation supports decryption of a symmetric key using the target key encryption key. This operation is the reverse of the WRAP operation. The UNWRAP operation applies to asymmetric and symmetric keys stored in Azure Key Vault since it uses the private portion of the key. This operation requires the keys/unwrapKey permission.

azure_keyvault.unwrapKey({
  "key-name": "",
  "key-version": "",
  "parameters": null,
  "api-version": ""
}, context)

Input

input object
- key-name required string: The name of the key.
- key-version required string: The version of the key.
- parameters required KeyOperationsParameters
- api-version required string: Client API version.

Output

output KeyOperationResult

verify

The VERIFY operation is applicable to symmetric keys stored in Azure Key Vault. VERIFY is not strictly necessary for asymmetric keys stored in Azure Key Vault since signature verification can be performed using the public portion of the key but this operation is supported as a convenience for callers that only have a key-reference and not the public portion of the key. This operation requires the keys/verify permission.

azure_keyvault.verify({
  "key-name": "",
  "key-version": "",
  "parameters": null,
  "api-version": ""
}, context)

Input

input object
- key-name required string: The name of the key.
- key-version required string: The version of the key.
- parameters required KeyVerifyParameters
- api-version required string: Client API version.

Output

output KeyVerifyResult

wrapKey

The WRAP operation supports encryption of a symmetric key using a key encryption key that has previously been stored in an Azure Key Vault. The WRAP operation is only strictly necessary for symmetric keys stored in Azure Key Vault since protection with an asymmetric key can be performed using the public portion of the key. This operation is supported for asymmetric keys as a convenience for callers that have a key-reference but do not have access to the public key material. This operation requires the keys/wrapKey permission.

azure_keyvault.wrapKey({
  "key-name": "",
  "key-version": "",
  "parameters": null,
  "api-version": ""
}, context)

Input

input object
- key-name required string: The name of the key.
- key-version required string: The version of the key.
- parameters required KeyOperationsParameters
- api-version required string: Client API version.

Output

output KeyOperationResult

GetSecrets

The Get Secrets operation is applicable to the entire vault. However, only the base secret identifier and its attributes are provided in the response. Individual secret versions are not listed in the response. This operation requires the secrets/list permission.

azure_keyvault.GetSecrets({
  "api-version": ""
}, context)

Input

input object
- maxresults integer: Maximum number of results to return in a page. If not specified, the service will return up to 25 results.
- api-version required string: Client API version.

Output

output SecretListResult

RestoreSecret

Restores a backed up secret, and all its versions, to a vault. This operation requires the secrets/restore permission.

azure_keyvault.RestoreSecret({
  "parameters": null,
  "api-version": ""
}, context)

Input

input object
- parameters required SecretRestoreParameters
- api-version required string: Client API version.

Output

output SecretBundle

DeleteSecret

The DELETE operation applies to any secret stored in Azure Key Vault. DELETE cannot be applied to an individual version of a secret. This operation requires the secrets/delete permission.

azure_keyvault.DeleteSecret({
  "secret-name": "",
  "api-version": ""
}, context)

Input

input object
- secret-name required string: The name of the secret.
- api-version required string: Client API version.

Output

output DeletedSecretBundle

SetSecret

The SET operation adds a secret to the Azure Key Vault. If the named secret already exists, Azure Key Vault creates a new version of that secret. This operation requires the secrets/set permission.

azure_keyvault.SetSecret({
  "secret-name": "",
  "parameters": null,
  "api-version": ""
}, context)

Input

input object
- secret-name required string: The name of the secret.
- parameters required SecretSetParameters
- api-version required string: Client API version.

Output

output SecretBundle

BackupSecret

Requests that a backup of the specified secret be downloaded to the client. All versions of the secret will be downloaded. This operation requires the secrets/backup permission.

azure_keyvault.BackupSecret({
  "secret-name": "",
  "api-version": ""
}, context)

Input

input object
- secret-name required string: The name of the secret.
- api-version required string: Client API version.

Output

output BackupSecretResult

GetSecretVersions

The full secret identifier and attributes are provided in the response. No values are returned for the secrets. This operations requires the secrets/list permission.

azure_keyvault.GetSecretVersions({
  "secret-name": "",
  "api-version": ""
}, context)

Input

input object
- secret-name required string: The name of the secret.
- maxresults integer: Maximum number of results to return in a page. If not specified, the service will return up to 25 results.
- api-version required string: Client API version.

Output

output SecretListResult

GetSecret

The GET operation is applicable to any secret stored in Azure Key Vault. This operation requires the secrets/get permission.

azure_keyvault.GetSecret({
  "secret-name": "",
  "secret-version": "",
  "api-version": ""
}, context)

Input

input object
- secret-name required string: The name of the secret.
- secret-version required string: The version of the secret.
- api-version required string: Client API version.

Output

output SecretBundle

UpdateSecret

The UPDATE operation changes specified attributes of an existing stored secret. Attributes that are not specified in the request are left unchanged. The value of a secret itself cannot be changed. This operation requires the secrets/set permission.

azure_keyvault.UpdateSecret({
  "secret-name": "",
  "secret-version": "",
  "parameters": null,
  "api-version": ""
}, context)

Input

input object
- secret-name required string: The name of the secret.
- secret-version required string: The version of the secret.
- parameters required SecretUpdateParameters
- api-version required string: Client API version.

Output

output SecretBundle

GetStorageAccounts

List storage accounts managed by the specified key vault. This operation requires the storage/list permission.

azure_keyvault.GetStorageAccounts({
  "api-version": ""
}, context)

Input

input object
- maxresults integer: Maximum number of results to return in a page. If not specified the service will return up to 25 results.
- api-version required string: Client API version.

Output

output StorageListResult

RestoreStorageAccount

Restores a backed up storage account to a vault. This operation requires the storage/restore permission.

azure_keyvault.RestoreStorageAccount({
  "parameters": null,
  "api-version": ""
}, context)

Input

input object
- parameters required StorageRestoreParameters
- api-version required string: Client API version.

Output

output StorageBundle

DeleteStorageAccount

Deletes a storage account. This operation requires the storage/delete permission.

azure_keyvault.DeleteStorageAccount({
  "storage-account-name": "",
  "api-version": ""
}, context)

Input

input object
- storage-account-name required string: The name of the storage account.
- api-version required string: Client API version.

Output

output DeletedStorageBundle

GetStorageAccount

Gets information about a specified storage account. This operation requires the storage/get permission.

azure_keyvault.GetStorageAccount({
  "storage-account-name": "",
  "api-version": ""
}, context)

Input

input object
- storage-account-name required string: The name of the storage account.
- api-version required string: Client API version.

Output

output StorageBundle

UpdateStorageAccount

Updates the specified attributes associated with the given storage account. This operation requires the storage/set/update permission.

azure_keyvault.UpdateStorageAccount({
  "storage-account-name": "",
  "parameters": null,
  "api-version": ""
}, context)

Input

input object
- storage-account-name required string: The name of the storage account.
- parameters required StorageAccountUpdateParameters
- api-version required string: Client API version.

Output

output StorageBundle

SetStorageAccount

Creates or updates a new storage account. This operation requires the storage/set permission.

azure_keyvault.SetStorageAccount({
  "storage-account-name": "",
  "parameters": null,
  "api-version": ""
}, context)

Input

input object
- storage-account-name required string: The name of the storage account.
- parameters required StorageAccountCreateParameters
- api-version required string: Client API version.

Output

output StorageBundle

BackupStorageAccount

Requests that a backup of the specified storage account be downloaded to the client. This operation requires the storage/backup permission.

azure_keyvault.BackupStorageAccount({
  "storage-account-name": "",
  "api-version": ""
}, context)

Input

input object
- storage-account-name required string: The name of the storage account.
- api-version required string: Client API version.

Output

output BackupStorageResult

RegenerateStorageAccountKey

Regenerates the specified key value for the given storage account. This operation requires the storage/regeneratekey permission.

azure_keyvault.RegenerateStorageAccountKey({
  "storage-account-name": "",
  "parameters": null,
  "api-version": ""
}, context)

Input

input object
- storage-account-name required string: The name of the storage account.
- parameters required StorageAccountRegenerteKeyParameters
- api-version required string: Client API version.

Output

output StorageBundle

GetSasDefinitions

List storage SAS definitions for the given storage account. This operation requires the storage/listsas permission.

azure_keyvault.GetSasDefinitions({
  "storage-account-name": "",
  "api-version": ""
}, context)

Input

input object
- storage-account-name required string: The name of the storage account.
- maxresults integer: Maximum number of results to return in a page. If not specified the service will return up to 25 results.
- api-version required string: Client API version.

Output

output SasDefinitionListResult

DeleteSasDefinition

Deletes a SAS definition from a specified storage account. This operation requires the storage/deletesas permission.

azure_keyvault.DeleteSasDefinition({
  "storage-account-name": "",
  "sas-definition-name": "",
  "api-version": ""
}, context)

Input

input object
- storage-account-name required string: The name of the storage account.
- sas-definition-name required string: The name of the SAS definition.
- api-version required string: Client API version.

Output

output DeletedSasDefinitionBundle

GetSasDefinition

Gets information about a SAS definition for the specified storage account. This operation requires the storage/getsas permission.

azure_keyvault.GetSasDefinition({
  "storage-account-name": "",
  "sas-definition-name": "",
  "api-version": ""
}, context)

Input

input object
- storage-account-name required string: The name of the storage account.
- sas-definition-name required string: The name of the SAS definition.
- api-version required string: Client API version.

Output

output SasDefinitionBundle

UpdateSasDefinition

Updates the specified attributes associated with the given SAS definition. This operation requires the storage/setsas permission.

azure_keyvault.UpdateSasDefinition({
  "storage-account-name": "",
  "sas-definition-name": "",
  "parameters": null,
  "api-version": ""
}, context)

Input

input object
- storage-account-name required string: The name of the storage account.
- sas-definition-name required string: The name of the SAS definition.
- parameters required SasDefinitionUpdateParameters
- api-version required string: Client API version.

Output

output SasDefinitionBundle

SetSasDefinition

Creates or updates a new SAS definition for the specified storage account. This operation requires the storage/setsas permission.

azure_keyvault.SetSasDefinition({
  "storage-account-name": "",
  "sas-definition-name": "",
  "parameters": null,
  "api-version": ""
}, context)

Input

input object
- storage-account-name required string: The name of the storage account.
- sas-definition-name required string: The name of the SAS definition.
- parameters required SasDefinitionCreateParameters
- api-version required string: Client API version.

Output

output SasDefinitionBundle

Definitions

Action

Action object: The action that will be executed.
- action_type string (values: EmailContacts, AutoRenew): The type of the action.

AdministratorDetails

AdministratorDetails object: Details of the organization administrator of the certificate issuer.
- email string: Email address.
- first_name string: First name.
- last_name string: Last name.
- phone string: Phone number.

Attributes

Attributes object: The object attributes managed by the KeyVault service.
- created integer: Creation time in UTC.
- enabled boolean: Determines whether the object is enabled.
- exp integer: Expiry date in UTC.
- nbf integer: Not before date in UTC.
- updated integer: Last updated time in UTC.

BackupCertificateResult

BackupCertificateResult object: The backup certificate result, containing the backup blob.
- value string: The backup blob containing the backed up certificate.

BackupKeyResult

BackupKeyResult object: The backup key result, containing the backup blob.
- value string: The backup blob containing the backed up key.

BackupSecretResult

BackupSecretResult object: The backup secret result, containing the backup blob.
- value string: The backup blob containing the backed up secret.

BackupStorageResult

BackupStorageResult object: The backup storage result, containing the backup blob.
- value string: The backup blob containing the backed up storage account.

CertificateAttributes

CertificateAttributes object: The certificate management attributes.
- recoveryLevel string (values: Purgeable, Recoverable+Purgeable, Recoverable, Recoverable+ProtectedSubscription): Reflects the deletion recovery level currently in effect for certificates in the current vault. If it contains 'Purgeable', the certificate can be permanently deleted by a privileged user; otherwise, only the system can purge the certificate, at the end of the retention interval.
- created integer: Creation time in UTC.
- enabled boolean: Determines whether the object is enabled.
- exp integer: Expiry date in UTC.
- nbf integer: Not before date in UTC.
- updated integer: Last updated time in UTC.

CertificateBundle

CertificateBundle object: A certificate bundle consists of a certificate (X509) plus its attributes.
- attributes CertificateAttributes
- cer string: CER contents of x509 certificate.
- contentType string: The content type of the secret.
- id string: The certificate id.
- kid string: The key id.
- policy CertificatePolicy
- sid string: The secret id.
- tags object: Application specific metadata in the form of key-value pairs
- x5t string: Thumbprint of the certificate.

CertificateCreateParameters

CertificateCreateParameters object: The certificate create parameters.
- attributes CertificateAttributes
- policy CertificatePolicy
- tags object: Application specific metadata in the form of key-value pairs.

CertificateImportParameters

CertificateImportParameters object: The certificate import parameters.
- attributes CertificateAttributes
- policy CertificatePolicy
- pwd string: If the private key in base64EncodedCertificate is encrypted, the password used for encryption.
- tags object: Application specific metadata in the form of key-value pairs.
- value required string: Base64 encoded representation of the certificate object to import. This certificate needs to contain the private key.

CertificateIssuerItem

CertificateIssuerItem object: The certificate issuer item containing certificate issuer metadata.
- id string: Certificate Identifier.
- provider string: The issuer provider.

CertificateIssuerListResult

CertificateIssuerListResult object: The certificate issuer list result.
- nextLink string: The URL to get the next set of certificate issuers.
- value array: A response message containing a list of certificate issuers in the key vault along with a link to the next page of certificate issuers.
  - items CertificateIssuerItem

CertificateIssuerSetParameters

CertificateIssuerSetParameters object: The certificate issuer set parameters.
- attributes IssuerAttributes
- credentials IssuerCredentials
- org_details OrganizationDetails
- provider required string: The issuer provider.

CertificateIssuerUpdateParameters

CertificateIssuerUpdateParameters object: The certificate issuer update parameters.
- attributes IssuerAttributes
- credentials IssuerCredentials
- org_details OrganizationDetails
- provider string: The issuer provider.

CertificateItem

CertificateItem object: The certificate item containing certificate metadata.
- attributes CertificateAttributes
- id string: Certificate identifier.
- tags object: Application specific metadata in the form of key-value pairs.
- x5t string: Thumbprint of the certificate.

CertificateListResult

CertificateListResult object: The certificate list result.
- nextLink string: The URL to get the next set of certificates.
- value array: A response message containing a list of certificates in the key vault along with a link to the next page of certificates.
  - items CertificateItem

CertificateMergeParameters

CertificateMergeParameters object: The certificate merge parameters
- attributes CertificateAttributes
- tags object: Application specific metadata in the form of key-value pairs.
- x5c required array: The certificate or the certificate chain to merge.
  - items string

CertificateOperation

CertificateOperation object: A certificate operation is returned in case of asynchronous requests.
- cancellation_requested boolean: Indicates if cancellation was requested on the certificate operation.
- csr string: The certificate signing request (CSR) that is being used in the certificate operation.
- error Error
- id string: The certificate id.
- issuer IssuerParameters
- request_id string: Identifier for the certificate operation.
- status string: Status of the certificate operation.
- status_details string: The status details of the certificate operation.
- target string: Location which contains the result of the certificate operation.

CertificateOperationUpdateParameter

CertificateOperationUpdateParameter object: The certificate operation update parameters.
- cancellation_requested required boolean: Indicates if cancellation was requested on the certificate operation.

CertificatePolicy

CertificatePolicy object: Management policy for a certificate.
- attributes CertificateAttributes
- id string: The certificate id.
- issuer IssuerParameters
- key_props KeyProperties
- lifetime_actions array: Actions that will be performed by Key Vault over the lifetime of a certificate.
  - items LifetimeAction
- secret_props SecretProperties
- x509_props X509CertificateProperties

CertificateRestoreParameters

CertificateRestoreParameters object: The certificate restore parameters.
- value required string: The backup blob associated with a certificate bundle.

CertificateUpdateParameters

CertificateUpdateParameters object: The certificate update parameters.
- attributes CertificateAttributes
- policy CertificatePolicy
- tags object: Application specific metadata in the form of key-value pairs.

Contact

Contact object: The contact information for the vault certificates.
- email string: Email address.
- name string: Name.
- phone string: Phone number.

Contacts

Contacts object: The contacts for the vault certificates.
- contacts array: The contact list for the vault certificates.
  - items Contact
- id string: Identifier for the contacts collection.

DeletedCertificateBundle

DeletedCertificateBundle object: A Deleted Certificate consisting of its previous id, attributes and its tags, as well as information on when it will be purged.
- deletedDate integer: The time when the certificate was deleted, in UTC
- recoveryId string: The url of the recovery object, used to identify and recover the deleted certificate.
- scheduledPurgeDate integer: The time when the certificate is scheduled to be purged, in UTC
- attributes CertificateAttributes
- cer string: CER contents of x509 certificate.
- contentType string: The content type of the secret.
- id string: The certificate id.
- kid string: The key id.
- policy CertificatePolicy
- sid string: The secret id.
- tags object: Application specific metadata in the form of key-value pairs
- x5t string: Thumbprint of the certificate.

DeletedCertificateItem

DeletedCertificateItem object: The deleted certificate item containing metadata about the deleted certificate.
- deletedDate integer: The time when the certificate was deleted, in UTC
- recoveryId string: The url of the recovery object, used to identify and recover the deleted certificate.
- scheduledPurgeDate integer: The time when the certificate is scheduled to be purged, in UTC
- attributes CertificateAttributes
- id string: Certificate identifier.
- tags object: Application specific metadata in the form of key-value pairs.
- x5t string: Thumbprint of the certificate.

DeletedCertificateListResult

DeletedCertificateListResult object: A list of certificates that have been deleted in this vault.
- nextLink string: The URL to get the next set of deleted certificates.
- value array: A response message containing a list of deleted certificates in the vault along with a link to the next page of deleted certificates
  - items DeletedCertificateItem

DeletedKeyBundle

DeletedKeyBundle object: A DeletedKeyBundle consisting of a WebKey plus its Attributes and deletion info
- deletedDate integer: The time when the key was deleted, in UTC
- recoveryId string: The url of the recovery object, used to identify and recover the deleted key.
- scheduledPurgeDate integer: The time when the key is scheduled to be purged, in UTC
- attributes KeyAttributes
- key JsonWebKey
- managed boolean: True if the key's lifetime is managed by key vault. If this is a key backing a certificate, then managed will be true.
- tags object: Application specific metadata in the form of key-value pairs.

DeletedKeyItem

DeletedKeyItem object: The deleted key item containing the deleted key metadata and information about deletion.
- deletedDate integer: The time when the key was deleted, in UTC
- recoveryId string: The url of the recovery object, used to identify and recover the deleted key.
- scheduledPurgeDate integer: The time when the key is scheduled to be purged, in UTC
- attributes KeyAttributes
- kid string: Key identifier.
- managed boolean: True if the key's lifetime is managed by key vault. If this is a key backing a certificate, then managed will be true.
- tags object: Application specific metadata in the form of key-value pairs.

DeletedKeyListResult

DeletedKeyListResult object: A list of keys that have been deleted in this vault.
- nextLink string: The URL to get the next set of deleted keys.
- value array: A response message containing a list of deleted keys in the vault along with a link to the next page of deleted keys
  - items DeletedKeyItem

DeletedSasDefinitionBundle

DeletedSasDefinitionBundle object: A deleted SAS definition bundle consisting of its previous id, attributes and its tags, as well as information on when it will be purged.
- deletedDate integer: The time when the SAS definition was deleted, in UTC
- recoveryId string: The url of the recovery object, used to identify and recover the deleted SAS definition.
- scheduledPurgeDate integer: The time when the SAS definition is scheduled to be purged, in UTC
- attributes SasDefinitionAttributes
- id string: The SAS definition id.
- sasType string (values: account, service): The type of SAS token the SAS definition will create.
- sid string: Storage account SAS definition secret id.
- tags object: Application specific metadata in the form of key-value pairs
- templateUri string: The SAS definition token template signed with an arbitrary key. Tokens created according to the SAS definition will have the same properties as the template.
- validityPeriod string: The validity period of SAS tokens created according to the SAS definition.

DeletedSasDefinitionItem

DeletedSasDefinitionItem object: The deleted SAS definition item containing metadata about the deleted SAS definition.
- deletedDate integer: The time when the SAS definition was deleted, in UTC
- recoveryId string: The url of the recovery object, used to identify and recover the deleted SAS definition.
- scheduledPurgeDate integer: The time when the SAS definition is scheduled to be purged, in UTC
- attributes SasDefinitionAttributes
- id string: The storage SAS identifier.
- sid string: The storage account SAS definition secret id.
- tags object: Application specific metadata in the form of key-value pairs.

DeletedSasDefinitionListResult

DeletedSasDefinitionListResult object: The deleted SAS definition list result
- nextLink string: The URL to get the next set of deleted SAS definitions.
- value array: A response message containing a list of the deleted SAS definitions in the vault along with a link to the next page of deleted sas definitions
  - items DeletedSasDefinitionItem

DeletedSecretBundle

DeletedSecretBundle object: A Deleted Secret consisting of its previous id, attributes and its tags, as well as information on when it will be purged.
- deletedDate integer: The time when the secret was deleted, in UTC
- recoveryId string: The url of the recovery object, used to identify and recover the deleted secret.
- scheduledPurgeDate integer: The time when the secret is scheduled to be purged, in UTC
- attributes SecretAttributes
- contentType string: The content type of the secret.
- id string: The secret id.
- kid string: If this is a secret bac

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

@datafire/azure_keyvault

Installation and Usage

Description

Actions

GetCertificates

Input

Output

DeleteCertificateContacts

Input

Output

GetCertificateContacts

Input

Output

SetCertificateContacts

Input

Output

GetCertificateIssuers

Input

Output

DeleteCertificateIssuer

Input

Output

GetCertificateIssuer

Input

Output

UpdateCertificateIssuer

Input

Output

SetCertificateIssuer

Input

Output

RestoreCertificate

Input

Output

DeleteCertificate

Input

Output

BackupCertificate

Input

Output

CreateCertificate

Input

Output

ImportCertificate

Input

Output

DeleteCertificateOperation

Input

Output

GetCertificateOperation

Input

Output

UpdateCertificateOperation

Input

Output

MergeCertificate

Input

Output

GetCertificatePolicy

Input

Output

UpdateCertificatePolicy

Input

Output

GetCertificateVersions

Input

Output

GetCertificate

Input

Output

UpdateCertificate

Input

Output

GetDeletedCertificates