Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. keyvault
  5. getEncryptedValue

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

azure.keyvault.getEncryptedValue

Explore with Pulumi AI

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

Encrypts or Decrypts a value using a Key Vault Key.

Using getEncryptedValue

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getEncryptedValue(args: GetEncryptedValueArgs, opts?: InvokeOptions): Promise<GetEncryptedValueResult>
function getEncryptedValueOutput(args: GetEncryptedValueOutputArgs, opts?: InvokeOptions): Output<GetEncryptedValueResult>
Copy
def get_encrypted_value(algorithm: Optional[str] = None,
                        encrypted_data: Optional[str] = None,
                        key_vault_key_id: Optional[str] = None,
                        plain_text_value: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetEncryptedValueResult
def get_encrypted_value_output(algorithm: Optional[pulumi.Input[str]] = None,
                        encrypted_data: Optional[pulumi.Input[str]] = None,
                        key_vault_key_id: Optional[pulumi.Input[str]] = None,
                        plain_text_value: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetEncryptedValueResult]
Copy
func GetEncryptedValue(ctx *Context, args *GetEncryptedValueArgs, opts ...InvokeOption) (*GetEncryptedValueResult, error)
func GetEncryptedValueOutput(ctx *Context, args *GetEncryptedValueOutputArgs, opts ...InvokeOption) GetEncryptedValueResultOutput
Copy

> Note: This function is named GetEncryptedValue in the Go SDK.

public static class GetEncryptedValue 
{
    public static Task<GetEncryptedValueResult> InvokeAsync(GetEncryptedValueArgs args, InvokeOptions? opts = null)
    public static Output<GetEncryptedValueResult> Invoke(GetEncryptedValueInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetEncryptedValueResult> getEncryptedValue(GetEncryptedValueArgs args, InvokeOptions options)
public static Output<GetEncryptedValueResult> getEncryptedValue(GetEncryptedValueArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure:keyvault/getEncryptedValue:getEncryptedValue
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Algorithm This property is required. string
The Algorithm which should be used to Decrypt/Encrypt this Value. Possible values are RSA1_5, RSA-OAEP and RSA-OAEP-256.
KeyVaultKeyId This property is required. string
The ID of the Key Vault Key which should be used to Decrypt/Encrypt this Value.
EncryptedData string
The Base64 URL Encoded Encrypted Data which should be decrypted into plain_text_value.
PlainTextValue string

The plain-text value which should be Encrypted into encrypted_data.

Note: One of either encrypted_data or plain_text_value must be specified and is used to populate the encrypted/decrypted value for the other field.

Algorithm This property is required. string
The Algorithm which should be used to Decrypt/Encrypt this Value. Possible values are RSA1_5, RSA-OAEP and RSA-OAEP-256.
KeyVaultKeyId This property is required. string
The ID of the Key Vault Key which should be used to Decrypt/Encrypt this Value.
EncryptedData string
The Base64 URL Encoded Encrypted Data which should be decrypted into plain_text_value.
PlainTextValue string

The plain-text value which should be Encrypted into encrypted_data.

Note: One of either encrypted_data or plain_text_value must be specified and is used to populate the encrypted/decrypted value for the other field.

algorithm This property is required. String
The Algorithm which should be used to Decrypt/Encrypt this Value. Possible values are RSA1_5, RSA-OAEP and RSA-OAEP-256.
keyVaultKeyId This property is required. String
The ID of the Key Vault Key which should be used to Decrypt/Encrypt this Value.
encryptedData String
The Base64 URL Encoded Encrypted Data which should be decrypted into plain_text_value.
plainTextValue String

The plain-text value which should be Encrypted into encrypted_data.

Note: One of either encrypted_data or plain_text_value must be specified and is used to populate the encrypted/decrypted value for the other field.

algorithm This property is required. string
The Algorithm which should be used to Decrypt/Encrypt this Value. Possible values are RSA1_5, RSA-OAEP and RSA-OAEP-256.
keyVaultKeyId This property is required. string
The ID of the Key Vault Key which should be used to Decrypt/Encrypt this Value.
encryptedData string
The Base64 URL Encoded Encrypted Data which should be decrypted into plain_text_value.
plainTextValue string

The plain-text value which should be Encrypted into encrypted_data.

Note: One of either encrypted_data or plain_text_value must be specified and is used to populate the encrypted/decrypted value for the other field.

algorithm This property is required. str
The Algorithm which should be used to Decrypt/Encrypt this Value. Possible values are RSA1_5, RSA-OAEP and RSA-OAEP-256.
key_vault_key_id This property is required. str
The ID of the Key Vault Key which should be used to Decrypt/Encrypt this Value.
encrypted_data str
The Base64 URL Encoded Encrypted Data which should be decrypted into plain_text_value.
plain_text_value str

The plain-text value which should be Encrypted into encrypted_data.

Note: One of either encrypted_data or plain_text_value must be specified and is used to populate the encrypted/decrypted value for the other field.

algorithm This property is required. String
The Algorithm which should be used to Decrypt/Encrypt this Value. Possible values are RSA1_5, RSA-OAEP and RSA-OAEP-256.
keyVaultKeyId This property is required. String
The ID of the Key Vault Key which should be used to Decrypt/Encrypt this Value.
encryptedData String
The Base64 URL Encoded Encrypted Data which should be decrypted into plain_text_value.
plainTextValue String

The plain-text value which should be Encrypted into encrypted_data.

Note: One of either encrypted_data or plain_text_value must be specified and is used to populate the encrypted/decrypted value for the other field.

getEncryptedValue Result

The following output properties are available:

Algorithm string
DecodedPlainTextValue string
The Base64URL decoded string of plain_text_value. Because the API would remove padding characters of plain_text_value when encrypting, this attribute is useful to get the original value.
Id string
The provider-assigned unique ID for this managed resource.
KeyVaultKeyId string
EncryptedData string
PlainTextValue string
Algorithm string
DecodedPlainTextValue string
The Base64URL decoded string of plain_text_value. Because the API would remove padding characters of plain_text_value when encrypting, this attribute is useful to get the original value.
Id string
The provider-assigned unique ID for this managed resource.
KeyVaultKeyId string
EncryptedData string
PlainTextValue string
algorithm String
decodedPlainTextValue String
The Base64URL decoded string of plain_text_value. Because the API would remove padding characters of plain_text_value when encrypting, this attribute is useful to get the original value.
id String
The provider-assigned unique ID for this managed resource.
keyVaultKeyId String
encryptedData String
plainTextValue String
algorithm string
decodedPlainTextValue string
The Base64URL decoded string of plain_text_value. Because the API would remove padding characters of plain_text_value when encrypting, this attribute is useful to get the original value.
id string
The provider-assigned unique ID for this managed resource.
keyVaultKeyId string
encryptedData string
plainTextValue string
algorithm str
decoded_plain_text_value str
The Base64URL decoded string of plain_text_value. Because the API would remove padding characters of plain_text_value when encrypting, this attribute is useful to get the original value.
id str
The provider-assigned unique ID for this managed resource.
key_vault_key_id str
encrypted_data str
plain_text_value str
algorithm String
decodedPlainTextValue String
The Base64URL decoded string of plain_text_value. Because the API would remove padding characters of plain_text_value when encrypting, this attribute is useful to get the original value.
id String
The provider-assigned unique ID for this managed resource.
keyVaultKeyId String
encryptedData String
plainTextValue String

Package Details

Repository
Azure Classic pulumi/pulumi-azure
License
Apache-2.0
Notes
This Pulumi package is based on the azurerm Terraform Provider.

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure