Docs
PackagesWe recommend using Azure Native.
azure.keyvault.getEncryptedValue
Explore with Pulumi AI
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>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]func GetEncryptedValue(ctx *Context, args *GetEncryptedValueArgs, opts ...InvokeOption) (*GetEncryptedValueResult, error)
func GetEncryptedValueOutput(ctx *Context, args *GetEncryptedValueOutputArgs, opts ...InvokeOption) GetEncryptedValueResultOutput> 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)
}public static CompletableFuture<GetEncryptedValueResult> getEncryptedValue(GetEncryptedValueArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: azure:keyvault/getEncryptedValue:getEncryptedValue
arguments:
# arguments dictionaryThe following arguments are supported:
- Algorithm string
The Algorithm which should be used to Decrypt/Encrypt this Value. Possible values are
RSA1_5,RSA-OAEPandRSA-OAEP-256.- Key
Vault stringKey Id The ID of the Key Vault Key which should be used to Decrypt/Encrypt this Value.
- Encrypted
Data string The Base64 URL Encoded Encrypted Data which should be decrypted into
plain_text_value.- Plain
Text stringValue The plain-text value which should be Encrypted into
encrypted_data.Note: One of either
encrypted_dataorplain_text_valuemust be specified and is used to populate the encrypted/decrypted value for the other field.
- Algorithm string
The Algorithm which should be used to Decrypt/Encrypt this Value. Possible values are
RSA1_5,RSA-OAEPandRSA-OAEP-256.- Key
Vault stringKey Id The ID of the Key Vault Key which should be used to Decrypt/Encrypt this Value.
- Encrypted
Data string The Base64 URL Encoded Encrypted Data which should be decrypted into
plain_text_value.- Plain
Text stringValue The plain-text value which should be Encrypted into
encrypted_data.Note: One of either
encrypted_dataorplain_text_valuemust be specified and is used to populate the encrypted/decrypted value for the other field.
- algorithm String
The Algorithm which should be used to Decrypt/Encrypt this Value. Possible values are
RSA1_5,RSA-OAEPandRSA-OAEP-256.- key
Vault StringKey Id The ID of the Key Vault Key which should be used to Decrypt/Encrypt this Value.
- encrypted
Data String The Base64 URL Encoded Encrypted Data which should be decrypted into
plain_text_value.- plain
Text StringValue The plain-text value which should be Encrypted into
encrypted_data.Note: One of either
encrypted_dataorplain_text_valuemust be specified and is used to populate the encrypted/decrypted value for the other field.
- algorithm string
The Algorithm which should be used to Decrypt/Encrypt this Value. Possible values are
RSA1_5,RSA-OAEPandRSA-OAEP-256.- key
Vault stringKey Id The ID of the Key Vault Key which should be used to Decrypt/Encrypt this Value.
- encrypted
Data string The Base64 URL Encoded Encrypted Data which should be decrypted into
plain_text_value.- plain
Text stringValue The plain-text value which should be Encrypted into
encrypted_data.Note: One of either
encrypted_dataorplain_text_valuemust be specified and is used to populate the encrypted/decrypted value for the other field.
- algorithm str
The Algorithm which should be used to Decrypt/Encrypt this Value. Possible values are
RSA1_5,RSA-OAEPandRSA-OAEP-256.- key_
vault_ strkey_ id 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_ strvalue The plain-text value which should be Encrypted into
encrypted_data.Note: One of either
encrypted_dataorplain_text_valuemust be specified and is used to populate the encrypted/decrypted value for the other field.
- algorithm String
The Algorithm which should be used to Decrypt/Encrypt this Value. Possible values are
RSA1_5,RSA-OAEPandRSA-OAEP-256.- key
Vault StringKey Id The ID of the Key Vault Key which should be used to Decrypt/Encrypt this Value.
- encrypted
Data String The Base64 URL Encoded Encrypted Data which should be decrypted into
plain_text_value.- plain
Text StringValue The plain-text value which should be Encrypted into
encrypted_data.Note: One of either
encrypted_dataorplain_text_valuemust 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
- Decoded
Plain stringText Value The Base64URL decoded string of
plain_text_value. Because the API would remove padding characters ofplain_text_valuewhen encrypting, this attribute is useful to get the original value.- Id string
The provider-assigned unique ID for this managed resource.
- Key
Vault stringKey Id - Encrypted
Data string - Plain
Text stringValue
- Algorithm string
- Decoded
Plain stringText Value The Base64URL decoded string of
plain_text_value. Because the API would remove padding characters ofplain_text_valuewhen encrypting, this attribute is useful to get the original value.- Id string
The provider-assigned unique ID for this managed resource.
- Key
Vault stringKey Id - Encrypted
Data string - Plain
Text stringValue
- algorithm String
- decoded
Plain StringText Value The Base64URL decoded string of
plain_text_value. Because the API would remove padding characters ofplain_text_valuewhen encrypting, this attribute is useful to get the original value.- id String
The provider-assigned unique ID for this managed resource.
- key
Vault StringKey Id - encrypted
Data String - plain
Text StringValue
- algorithm string
- decoded
Plain stringText Value The Base64URL decoded string of
plain_text_value. Because the API would remove padding characters ofplain_text_valuewhen encrypting, this attribute is useful to get the original value.- id string
The provider-assigned unique ID for this managed resource.
- key
Vault stringKey Id - encrypted
Data string - plain
Text stringValue
- algorithm str
- decoded_
plain_ strtext_ value The Base64URL decoded string of
plain_text_value. Because the API would remove padding characters ofplain_text_valuewhen encrypting, this attribute is useful to get the original value.- id str
The provider-assigned unique ID for this managed resource.
- key_
vault_ strkey_ id - encrypted_
data str - plain_
text_ strvalue
- algorithm String
- decoded
Plain StringText Value The Base64URL decoded string of
plain_text_value. Because the API would remove padding characters ofplain_text_valuewhen encrypting, this attribute is useful to get the original value.- id String
The provider-assigned unique ID for this managed resource.
- key
Vault StringKey Id - encrypted
Data String - plain
Text StringValue
Package Details
- Repository
- Azure Classic pulumi/pulumi-azure
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
azurermTerraform Provider.