Connectors Reference
Azure Key Vault is a service to securely store and access secrets.
|
Status: Production |
Tier: Premium |
Version: 1.0 |
|
Name |
Summary |
|
List keys |
|
|
List key versions |
|
|
Get key metadata |
|
|
Get key version metadata |
|
|
EncryptData (string keyName, KeyEncryptInput operationInput) |
Encrypt data with key |
|
EncryptDataWithVersion (string keyName, string keyVersion, KeyEncryptInput operationInput) |
Encrypt data with key version |
|
DecryptData (string keyName, KeyDecryptInput operationInput) |
Decrypt data with key |
|
DecryptDataWithVersion (string keyName, string keyVersion, KeyDecryptInput operationInput) |
Decrypt data with key version |
|
List secrets |
|
|
List secret versions |
|
|
Get secret metadata |
|
|
GetSecretVersionMetadata (string secretName, string secretVersion) |
Get secret version metadata |
|
Get secret |
|
|
Get secret version |
|
Name |
Summary |
|
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: List keys
Description: List keys.
Syntax:
AzureKeyVault.ListKeys ()
Returns:
Description: Collection of keys
Summary: List key versions
Description: List versions of a key.
Syntax:
AzureKeyVault.ListKeyVersions (string keyName)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
keyName |
string (Name of the key) |
Name of the key. |
True |
Returns:
Description: Collection of keys
Summary: Get key metadata
Description: Gets metadata of a key.
Syntax:
AzureKeyVault.GetKeyMetadata (string keyName)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
keyName |
string (Name of the key) |
Name of the key. |
True |
Returns:
Type:KeyMetadata
Description: Metadata of a key
Summary: Get key version metadata
Description: Gets metadata of a version of a key.
Syntax:
AzureKeyVault.GetKeyVersionMetadata (string keyName, string keyVersion)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
keyName |
string (Name of the key) |
Name of the key. |
True |
|
|
keyVersion |
string (Version of the key) |
Version of the key. |
True |
Returns:
Type:KeyMetadata
Description: Metadata of a key
Summary: Encrypt data with key
Description: Encrypt data using the latest version of a key.
Syntax:
AzureKeyVault.EncryptData (string keyName, KeyEncryptInput operationInput)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
keyName |
string (Name of the key) |
Name of the key. |
True |
|
|
operationInput |
|
Input for encryption operation |
True |
Returns:
Type:KeyEncryptOutput
Description: Result of encryption operation
Summary: Encrypt data with key version
Description: Encrypt data using a specific version of a key.
Syntax:
AzureKeyVault.EncryptDataWithVersion (string keyName, string keyVersion, KeyEncryptInput operationInput)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
keyName |
string (Name of the key) |
Name of the key. |
True |
|
|
keyVersion |
string (Version of the key) |
Version of the key. |
True |
|
|
operationInput |
|
Input for encryption operation |
True |
Returns:
Type:KeyEncryptOutput
Description: Result of encryption operation
Summary: Decrypt data with key
Description: Decrypt data using the latest version of a key. Output of this operation is typically classified as secret and can be visible in the run history.
Syntax:
AzureKeyVault.DecryptData (string keyName, KeyDecryptInput operationInput)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
keyName |
string (Name of the key) |
Name of the key. |
True |
|
|
operationInput |
|
Input for decryption operation |
True |
Returns:
Type:KeyDecryptOutput
Description: Result of decryption operation
Summary: Decrypt data with key version
Description: Decrypt data using a specific version of a key. Output of this operation is typically classified as secret and can be visible in the run history.
Syntax:
AzureKeyVault.DecryptDataWithVersion (string keyName, string keyVersion, KeyDecryptInput operationInput)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
keyName |
string (Name of the key) |
Name of the key. |
True |
|
|
keyVersion |
string (Version of the key) |
Version of the key. |
True |
|
|
operationInput |
|
Input for decryption operation |
True |
Returns:
Type:KeyDecryptOutput
Description: Result of decryption operation
Summary: List secrets
Description: List secrets.
Syntax:
AzureKeyVault.ListSecrets ()
Returns:
Description: Collection of secrets
Summary: List secret versions
Description: List versions of a secret.
Syntax:
AzureKeyVault.ListSecretVersions (string secretName)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
secretName |
string (Name of the secret) |
Name of the secret. |
True |
Returns:
Description: Collection of secrets
Summary: Get secret metadata
Description: Gets metadata of a secret.
Syntax:
AzureKeyVault.GetSecretMetadata (string secretName)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
secretName |
string (Name of the secret) |
Name of the secret. |
True |
Returns:
Type:SecretMetadata
Description: Metadata of a secret
Summary: Get secret version metadata
Description: Gets metadata of a version of a secret.
Syntax:
AzureKeyVault.GetSecretVersionMetadata (string secretName, string secretVersion)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
secretName |
string (Name of the secret) |
Name of the secret. |
True |
|
|
secretVersion |
string (Version of the secret) |
Version of the secret. |
True |
Returns:
Type:SecretMetadata
Description: Metadata of a secret
Summary: Get secret
Description: Gets a secret. Output of this operation is typically classified as secret and can be visible in the run history.
Syntax:
AzureKeyVault.GetSecret (string secretName)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
secretName |
string (Name of the secret) |
Name of the secret. |
True |
Returns:
Type:Secret
Description: The secret
Summary: Get secret version
Description: Gets a version of a secret. Output of this operation is typically classified as secret and can be visible in the run history.
Syntax:
AzureKeyVault.GetSecretVersion (string secretName, string secretVersion)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
secretName |
string (Name of the secret) |
Name of the secret. |
True |
|
|
secretVersion |
string (Version of the secret) |
Version of the secret. |
True |
Returns:
Type:Secret
Description: The secret
Summary:
Description: Input for decryption operation
Properties:
|
Name |
Type |
Summary |
|
algorithm |
string Algorithm |
Algorithm to use for decrypting the data Values: [RSA-OAEP-256, RSA-OAEP, RSA1_5] |
|
encryptedData |
string Encrypted data |
Data to decrypt |
Summary:
Description: Result of decryption operation
Properties:
|
Name |
Type |
Summary |
|
rawData |
string
|
Raw data |
Summary:
Description: Input for encryption operation
Properties:
|
Name |
Type |
Summary |
|
algorithm |
string Algorithm |
Algorithm to use for encrypting the data Values: [RSA-OAEP-256, RSA-OAEP, RSA1_5] |
|
rawData |
string Raw data |
Data to encrypt |
Summary:
Description: Result of encryption operation
Properties:
|
Name |
Type |
Summary |
|
encryptedData |
string
|
Encrypted data |
Summary:
Description: Metadata of a key
Properties:
|
Name |
Type |
Summary |
|
name |
string
|
Name of the key |
|
version |
string
|
Version of the key |
|
isEnabled |
boolean
|
A flag indicating whether the key is enabled |
|
createdTime |
string(date-time)
|
Time when the key was created |
|
lastUpdatedTime |
string(date-time)
|
Time when the key was last updated |
|
validityStartTime |
string(date-time)
|
Time when the key validity starts. |
|
validityEndTime |
string(date-time)
|
Time when the key validity ends. |
|
allowedOperations |
array of (string)
|
Operations allowed using the key |
|
keyType |
string
|
Type of the key |
Summary:
Description: Collection of keys
Properties:
|
Name |
Type |
Summary |
|
value |
array of (KeyMetadata)
|
The keys |
|
continuationToken |
string
|
Continuation token |
Summary:
Description: The secret
Properties:
|
Name |
Type |
Summary |
|
value |
string
|
Value of the secret |
|
name |
string
|
Name of the secret |
|
version |
string
|
Version of the secret |
|
contentType |
string
|
Content type of the secret |
|
isEnabled |
boolean
|
A flag indicating whether the secret is enabled |
|
createdTime |
string(date-time)
|
Time when the secret was created |
|
lastUpdatedTime |
string(date-time)
|
Time when the secret was last updated |
|
validityStartTime |
string(date-time)
|
Time when the secret validity starts. |
|
validityEndTime |
string(date-time)
|
Time when the secret validity ends. |
Summary:
Description: Metadata of a secret
Properties:
|
Name |
Type |
Summary |
|
name |
string
|
Name of the secret |
|
version |
string
|
Version of the secret |
|
contentType |
string
|
Content type of the secret |
|
isEnabled |
boolean
|
A flag indicating whether the secret is enabled |
|
createdTime |
string(date-time)
|
Time when the secret was created |
|
lastUpdatedTime |
string(date-time)
|
Time when the secret was last updated |
|
validityStartTime |
string(date-time)
|
Time when the secret validity starts. |
|
validityEndTime |
string(date-time)
|
Time when the secret validity ends. |
Summary:
Description: Collection of secrets
Properties:
|
Name |
Type |
Summary |
|
value |
array of (SecretMetadata)
|
The secrets |
|
continuationToken |
string
|
Continuation token |