# DeleteKey

Required Frends version: 5.5+

Required .NET version: 6.0

Compatible Agents: Crossplatform

Source code: <https://github.com/FrendsPlatform/Frends.Redis/tree/main/Frends.Redis.DeleteKey>

{% tabs %}
{% tab title="Parameter: Input" %}

| Name           | Description                                                                         |
| -------------- | ----------------------------------------------------------------------------------- |
| Key : `String` | <p>Key to delete</p><p><br>Default: <code>-</code><br>Example: <code>Foo</code></p> |
| {% endtab %}   |                                                                                     |

{% tab title="Parameter: Options" %}

| Name                             | Description                                                                                                                                                                                                       |
| -------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| ThrowErrorOnFailure : `Boolean`  | <p>True: Throw an exception.</p><p>False: Error will be added to the Result.Error.AdditionalInformation list instead of stopping the Task.</p><p><br>Default: <code>True</code><br>Example: <code>true</code></p> |
| ErrorMessageOnFailure : `String` | <p>Message what will be used when error occurs</p><p><br>Default: <code>-</code><br>Example: <code>Task failed during execution</code></p>                                                                        |
| {% endtab %}                     |                                                                                                                                                                                                                   |

{% tab title="Parameter: Connection" %}

| Name                                  | Description                                                                                                                                                                                                                                                                                                                                              |
| ------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| ConnectionMethod : `ConnectionMethod` | <p>Method to use to connect to Redis</p><p>Possible values:</p><ul><li><code>SimpleConnectionString</code>:</li></ul><p>Method to use to connect to Redis</p><ul><li><code>MicrosoftEntraId</code>:</li></ul><p>Method to use to connect to Redis</p><p><br>Default: <code>1</code><br>Example: <code>ConnectionMethod.SimpleConnectionString</code></p> |
| ConnectionString : `String`           | <p>Connection string to Redis.</p><p><br>Default: <code>-</code><br>Example: <code>127.0.0.1:6379</code></p>                                                                                                                                                                                                                                             |
| {% endtab %}                          |                                                                                                                                                                                                                                                                                                                                                          |

{% tab title="Result: Result" %}

| Name                | Description                                       |
| ------------------- | ------------------------------------------------- |
| Success : `Boolean` | <p>Success flag<br>Example: <code>true</code></p> |
| Error : `Error`     | Error info                                        |
| {% endtab %}        |                                                   |

{% tab title="Changelog" %}

## Changelog

### \[1.2.0] - 2026-03-03

#### Added

* Add support for Microsoft Entra ID

### \[1.1.0] - 2025-07-31

#### Changed

* Make default error message empty by default

### \[1.0.0] - 2025-05-13

#### Changed

* Initial implementation
  {% endtab %}
  {% endtabs %}