flowground für Geschäftskunden
KeyVaultClient
Konnektor für

KeyVaultClient

The key vault client performs cryptographic key operations and vault operations against the Key Vault service.
Spezifikationen
  • Kategorie: Office
  • Anbieter: n/a
  • Genutzte API: -
  • Managed: -
  • Lizenz: Apache License 2.0
  • Programmiert mit: javascript
Preise

Sie benötigen zur produktiven Nutzung einen kostenpflichtigen Projektraum.

Preise & Editionen

Technical Specifications

startFlow

OnInit
./lib/triggers/startFlow.js
OnStartup
-
OnClose
-

Attributes

-

GetCertificates

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

OnInit
./lib/actions/GetCertificates.js
OnStartup
-
OnClose
-

Attributes

-

DeleteCertificateContacts

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

OnInit
./lib/actions/DeleteCertificateContacts.js
OnStartup
-
OnClose
-

Attributes

-

GetCertificateContacts

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

OnInit
./lib/actions/GetCertificateContacts.js
OnStartup
-
OnClose
-

Attributes

-

SetCertificateContacts

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

OnInit
./lib/actions/SetCertificateContacts.js
OnStartup
-
OnClose
-

Attributes

-

GetCertificateIssuers

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

OnInit
./lib/actions/GetCertificateIssuers.js
OnStartup
-
OnClose
-

Attributes

-

DeleteCertificateIssuer

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

OnInit
./lib/actions/DeleteCertificateIssuer.js
OnStartup
-
OnClose
-

Attributes

-

GetCertificateIssuer

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

OnInit
./lib/actions/GetCertificateIssuer.js
OnStartup
-
OnClose
-

Attributes

-

UpdateCertificateIssuer

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

OnInit
./lib/actions/UpdateCertificateIssuer.js
OnStartup
-
OnClose
-

Attributes

-

SetCertificateIssuer

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

OnInit
./lib/actions/SetCertificateIssuer.js
OnStartup
-
OnClose
-

Attributes

-

RestoreCertificate

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

OnInit
./lib/actions/RestoreCertificate.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/DeleteCertificate.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/BackupCertificate.js
OnStartup
-
OnClose
-

Attributes

-

CreateCertificate

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

OnInit
./lib/actions/CreateCertificate.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/ImportCertificate.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/DeleteCertificateOperation.js
OnStartup
-
OnClose
-

Attributes

-

GetCertificateOperation

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

OnInit
./lib/actions/GetCertificateOperation.js
OnStartup
-
OnClose
-

Attributes

-

UpdateCertificateOperation

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

OnInit
./lib/actions/UpdateCertificateOperation.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/MergeCertificate.js
OnStartup
-
OnClose
-

Attributes

-

GetCertificatePolicy

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

OnInit
./lib/actions/GetCertificatePolicy.js
OnStartup
-
OnClose
-

Attributes

-

UpdateCertificatePolicy

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

OnInit
./lib/actions/UpdateCertificatePolicy.js
OnStartup
-
OnClose
-

Attributes

-

GetCertificateVersions

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

OnInit
./lib/actions/GetCertificateVersions.js
OnStartup
-
OnClose
-

Attributes

-

GetCertificate

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

OnInit
./lib/actions/GetCertificate.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/UpdateCertificate.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/GetDeletedCertificates.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/PurgeDeletedCertificate.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/GetDeletedCertificate.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/RecoverDeletedCertificate.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/GetDeletedKeys.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/PurgeDeletedKey.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/GetDeletedKey.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/RecoverDeletedKey.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/GetDeletedSecrets.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/PurgeDeletedSecret.js
OnStartup
-
OnClose
-

Attributes

-

GetDeletedSecret

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

OnInit
./lib/actions/GetDeletedSecret.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/RecoverDeletedSecret.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/GetDeletedStorageAccounts.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/PurgeDeletedStorageAccount.js
OnStartup
-
OnClose
-

Attributes

-

GetDeletedStorageAccount

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

OnInit
./lib/actions/GetDeletedStorageAccount.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/RecoverDeletedStorageAccount.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/GetDeletedSasDefinitions.js
OnStartup
-
OnClose
-

Attributes

-

GetDeletedSasDefinition

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

OnInit
./lib/actions/GetDeletedSasDefinition.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/RecoverDeletedSasDefinition.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/GetKeys.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/RestoreKey.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/DeleteKey.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/ImportKey.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/BackupKey.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/CreateKey.js
OnStartup
-
OnClose
-

Attributes

-

GetKeyVersions

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

OnInit
./lib/actions/GetKeyVersions.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/GetKey.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/UpdateKey.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/decrypt.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/encrypt.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/sign.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/unwrapKey.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/verify.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/wrapKey.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/GetSecrets.js
OnStartup
-
OnClose
-

Attributes

-

RestoreSecret

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

OnInit
./lib/actions/RestoreSecret.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/DeleteSecret.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/SetSecret.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/BackupSecret.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/GetSecretVersions.js
OnStartup
-
OnClose
-

Attributes

-

GetSecret

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

OnInit
./lib/actions/GetSecret.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/UpdateSecret.js
OnStartup
-
OnClose
-

Attributes

-

GetStorageAccounts

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

OnInit
./lib/actions/GetStorageAccounts.js
OnStartup
-
OnClose
-

Attributes

-

RestoreStorageAccount

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

OnInit
./lib/actions/RestoreStorageAccount.js
OnStartup
-
OnClose
-

Attributes

-

DeleteStorageAccount

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

OnInit
./lib/actions/DeleteStorageAccount.js
OnStartup
-
OnClose
-

Attributes

-

GetStorageAccount

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

OnInit
./lib/actions/GetStorageAccount.js
OnStartup
-
OnClose
-

Attributes

-

UpdateStorageAccount

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

OnInit
./lib/actions/UpdateStorageAccount.js
OnStartup
-
OnClose
-

Attributes

-

SetStorageAccount

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

OnInit
./lib/actions/SetStorageAccount.js
OnStartup
-
OnClose
-

Attributes

-

BackupStorageAccount

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

OnInit
./lib/actions/BackupStorageAccount.js
OnStartup
-
OnClose
-

Attributes

-

RegenerateStorageAccountKey

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

OnInit
./lib/actions/RegenerateStorageAccountKey.js
OnStartup
-
OnClose
-

Attributes

-

GetSasDefinitions

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

OnInit
./lib/actions/GetSasDefinitions.js
OnStartup
-
OnClose
-

Attributes

-

DeleteSasDefinition

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

OnInit
./lib/actions/DeleteSasDefinition.js
OnStartup
-
OnClose
-

Attributes

-

GetSasDefinition

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

OnInit
./lib/actions/GetSasDefinition.js
OnStartup
-
OnClose
-

Attributes

-

UpdateSasDefinition

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

OnInit
./lib/actions/UpdateSasDefinition.js
OnStartup
-
OnClose
-

Attributes

-

SetSasDefinition

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

OnInit
./lib/actions/SetSasDefinition.js
OnStartup
-
OnClose
-

Attributes

-

Keine Daten für terms vorhanden

Keine Daten für environment vorhanden