Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. redis
  5. listRedisKeys
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.redis.listRedisKeys

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

Retrieve a Redis cache’s access keys. This operation requires write permission to the cache resource.

Uses Azure REST API version 2024-11-01.

Other available API versions: 2015-08-01, 2016-04-01, 2017-02-01, 2017-10-01, 2018-03-01, 2019-07-01, 2020-06-01, 2020-12-01, 2021-06-01, 2022-05-01, 2022-06-01, 2023-04-01, 2023-05-01-preview, 2023-08-01, 2024-03-01, 2024-04-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native redis [ApiVersion]. See the version guide for details.

Using listRedisKeys

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 listRedisKeys(args: ListRedisKeysArgs, opts?: InvokeOptions): Promise<ListRedisKeysResult>
function listRedisKeysOutput(args: ListRedisKeysOutputArgs, opts?: InvokeOptions): Output<ListRedisKeysResult>
Copy
def list_redis_keys(name: Optional[str] = None,
                    resource_group_name: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> ListRedisKeysResult
def list_redis_keys_output(name: Optional[pulumi.Input[str]] = None,
                    resource_group_name: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[ListRedisKeysResult]
Copy
func ListRedisKeys(ctx *Context, args *ListRedisKeysArgs, opts ...InvokeOption) (*ListRedisKeysResult, error)
func ListRedisKeysOutput(ctx *Context, args *ListRedisKeysOutputArgs, opts ...InvokeOption) ListRedisKeysResultOutput
Copy

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

public static class ListRedisKeys 
{
    public static Task<ListRedisKeysResult> InvokeAsync(ListRedisKeysArgs args, InvokeOptions? opts = null)
    public static Output<ListRedisKeysResult> Invoke(ListRedisKeysInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<ListRedisKeysResult> listRedisKeys(ListRedisKeysArgs args, InvokeOptions options)
public static Output<ListRedisKeysResult> listRedisKeys(ListRedisKeysArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:redis:listRedisKeys
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Name
This property is required.
Changes to this property will trigger replacement.
string
The name of the Redis cache.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
Name
This property is required.
Changes to this property will trigger replacement.
string
The name of the Redis cache.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
name
This property is required.
Changes to this property will trigger replacement.
String
The name of the Redis cache.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
name
This property is required.
Changes to this property will trigger replacement.
string
The name of the Redis cache.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
name
This property is required.
Changes to this property will trigger replacement.
str
The name of the Redis cache.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
name
This property is required.
Changes to this property will trigger replacement.
String
The name of the Redis cache.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.

listRedisKeys Result

The following output properties are available:

PrimaryKey string
The current primary key that clients can use to authenticate with Redis cache.
SecondaryKey string
The current secondary key that clients can use to authenticate with Redis cache.
PrimaryKey string
The current primary key that clients can use to authenticate with Redis cache.
SecondaryKey string
The current secondary key that clients can use to authenticate with Redis cache.
primaryKey String
The current primary key that clients can use to authenticate with Redis cache.
secondaryKey String
The current secondary key that clients can use to authenticate with Redis cache.
primaryKey string
The current primary key that clients can use to authenticate with Redis cache.
secondaryKey string
The current secondary key that clients can use to authenticate with Redis cache.
primary_key str
The current primary key that clients can use to authenticate with Redis cache.
secondary_key str
The current secondary key that clients can use to authenticate with Redis cache.
primaryKey String
The current primary key that clients can use to authenticate with Redis cache.
secondaryKey String
The current secondary key that clients can use to authenticate with Redis cache.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native