azure-native.cache.getDatabase (v1)

Azure Native v1.103.0 (1.x), Mar 9 26

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.

Viewing docs for Azure Native v1.103.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

Go to latest version

Schema (JSON)

pulumi/pulumi-azure-native

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.

Viewing docs for Azure Native v1.103.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

Go to latest version

Schema (JSON)

pulumi/pulumi-azure-native

Using getDatabase

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 getDatabase(args: GetDatabaseArgs, opts?: InvokeOptions): Promise<GetDatabaseResult>
function getDatabaseOutput(args: GetDatabaseOutputArgs, opts?: InvokeOptions): Output<GetDatabaseResult>

def get_database(cluster_name: Optional[str] = None,
                 database_name: Optional[str] = None,
                 resource_group_name: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetDatabaseResult
def get_database_output(cluster_name: Optional[pulumi.Input[str]] = None,
                 database_name: Optional[pulumi.Input[str]] = None,
                 resource_group_name: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetDatabaseResult]

func LookupDatabase(ctx *Context, args *LookupDatabaseArgs, opts ...InvokeOption) (*LookupDatabaseResult, error)
func LookupDatabaseOutput(ctx *Context, args *LookupDatabaseOutputArgs, opts ...InvokeOption) LookupDatabaseResultOutput

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

public static class GetDatabase 
{
    public static Task<GetDatabaseResult> InvokeAsync(GetDatabaseArgs args, InvokeOptions? opts = null)
    public static Output<GetDatabaseResult> Invoke(GetDatabaseInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetDatabaseResult> getDatabase(GetDatabaseArgs args, InvokeOptions options)
public static Output<GetDatabaseResult> getDatabase(GetDatabaseArgs args, InvokeOptions options)

fn::invoke:
  function: azure-native:cache:getDatabase
  arguments:
    # arguments dictionary

The following arguments are supported:

ClusterName string: The name of the RedisEnterprise cluster.
DatabaseName string: The name of the database.
ResourceGroupName string: The name of the resource group. The name is case insensitive.

ClusterName string: The name of the RedisEnterprise cluster.
DatabaseName string: The name of the database.
ResourceGroupName string: The name of the resource group. The name is case insensitive.

clusterName String: The name of the RedisEnterprise cluster.
databaseName String: The name of the database.
resourceGroupName String: The name of the resource group. The name is case insensitive.

clusterName string: The name of the RedisEnterprise cluster.
databaseName string: The name of the database.
resourceGroupName string: The name of the resource group. The name is case insensitive.

cluster_name str: The name of the RedisEnterprise cluster.
database_name str: The name of the database.
resource_group_name str: The name of the resource group. The name is case insensitive.

clusterName String: The name of the RedisEnterprise cluster.
databaseName String: The name of the database.
resourceGroupName String: The name of the resource group. The name is case insensitive.

getDatabase Result

The following output properties are available:

Id string: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name string: The name of the resource
ProvisioningState string: Current provisioning status of the database
ResourceState string: Current resource status of the database
Type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
ClientProtocol string: Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted.
ClusteringPolicy string: Clustering policy - default is OSSCluster. Specified at create time.
EvictionPolicy string: Redis eviction policy - default is VolatileLRU
Modules List<Pulumi.AzureNative.Cache.Outputs.ModuleResponse>: Optional set of redis modules to enable in this database - modules can only be added at creation time.
Persistence Pulumi.AzureNative.Cache.Outputs.PersistenceResponse: Persistence settings
Port int: TCP port of the database endpoint. Specified at create time. Defaults to an available port.

Id string: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name string: The name of the resource
ProvisioningState string: Current provisioning status of the database
ResourceState string: Current resource status of the database
Type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
ClientProtocol string: Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted.
ClusteringPolicy string: Clustering policy - default is OSSCluster. Specified at create time.
EvictionPolicy string: Redis eviction policy - default is VolatileLRU
Modules []ModuleResponse: Optional set of redis modules to enable in this database - modules can only be added at creation time.
Persistence PersistenceResponse: Persistence settings
Port int: TCP port of the database endpoint. Specified at create time. Defaults to an available port.

id String: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name String: The name of the resource
provisioningState String: Current provisioning status of the database
resourceState String: Current resource status of the database
type String: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
clientProtocol String: Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted.
clusteringPolicy String: Clustering policy - default is OSSCluster. Specified at create time.
evictionPolicy String: Redis eviction policy - default is VolatileLRU
modules List<ModuleResponse>: Optional set of redis modules to enable in this database - modules can only be added at creation time.
persistence PersistenceResponse: Persistence settings
port Integer: TCP port of the database endpoint. Specified at create time. Defaults to an available port.

id string: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name string: The name of the resource
provisioningState string: Current provisioning status of the database
resourceState string: Current resource status of the database
type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
clientProtocol string: Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted.
clusteringPolicy string: Clustering policy - default is OSSCluster. Specified at create time.
evictionPolicy string: Redis eviction policy - default is VolatileLRU
modules ModuleResponse[]: Optional set of redis modules to enable in this database - modules can only be added at creation time.
persistence PersistenceResponse: Persistence settings
port number: TCP port of the database endpoint. Specified at create time. Defaults to an available port.

id str: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name str: The name of the resource
provisioning_state str: Current provisioning status of the database
resource_state str: Current resource status of the database
type str: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
client_protocol str: Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted.
clustering_policy str: Clustering policy - default is OSSCluster. Specified at create time.
eviction_policy str: Redis eviction policy - default is VolatileLRU
modules Sequence[ModuleResponse]: Optional set of redis modules to enable in this database - modules can only be added at creation time.
persistence PersistenceResponse: Persistence settings
port int: TCP port of the database endpoint. Specified at create time. Defaults to an available port.

id String: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name String: The name of the resource
provisioningState String: Current provisioning status of the database
resourceState String: Current resource status of the database
type String: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
clientProtocol String: Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted.
clusteringPolicy String: Clustering policy - default is OSSCluster. Specified at create time.
evictionPolicy String: Redis eviction policy - default is VolatileLRU
modules List<Property Map>: Optional set of redis modules to enable in this database - modules can only be added at creation time.
persistence Property Map: Persistence settings
port Number: TCP port of the database endpoint. Specified at create time. Defaults to an available port.

Supporting Types

ModuleResponse

Name string: The name of the module, e.g. 'RedisBloom', 'RediSearch', 'RedisTimeSeries'
Version string: The version of the module, e.g. '1.0'.
Args string: Configuration options for the module, e.g. 'ERROR_RATE 0.00 INITIAL_SIZE 400'.

Name string: The name of the module, e.g. 'RedisBloom', 'RediSearch', 'RedisTimeSeries'
Version string: The version of the module, e.g. '1.0'.
Args string: Configuration options for the module, e.g. 'ERROR_RATE 0.00 INITIAL_SIZE 400'.

name String: The name of the module, e.g. 'RedisBloom', 'RediSearch', 'RedisTimeSeries'
version String: The version of the module, e.g. '1.0'.
args String: Configuration options for the module, e.g. 'ERROR_RATE 0.00 INITIAL_SIZE 400'.

name string: The name of the module, e.g. 'RedisBloom', 'RediSearch', 'RedisTimeSeries'
version string: The version of the module, e.g. '1.0'.
args string: Configuration options for the module, e.g. 'ERROR_RATE 0.00 INITIAL_SIZE 400'.

name str: The name of the module, e.g. 'RedisBloom', 'RediSearch', 'RedisTimeSeries'
version str: The version of the module, e.g. '1.0'.
args str: Configuration options for the module, e.g. 'ERROR_RATE 0.00 INITIAL_SIZE 400'.

name String: The name of the module, e.g. 'RedisBloom', 'RediSearch', 'RedisTimeSeries'
version String: The version of the module, e.g. '1.0'.
args String: Configuration options for the module, e.g. 'ERROR_RATE 0.00 INITIAL_SIZE 400'.

PersistenceResponse

AofEnabled bool: Sets whether AOF is enabled.
AofFrequency string: Sets the frequency at which data is written to disk.
RdbEnabled bool: Sets whether RDB is enabled.
RdbFrequency string: Sets the frequency at which a snapshot of the database is created.

AofEnabled bool: Sets whether AOF is enabled.
AofFrequency string: Sets the frequency at which data is written to disk.
RdbEnabled bool: Sets whether RDB is enabled.
RdbFrequency string: Sets the frequency at which a snapshot of the database is created.

aofEnabled Boolean: Sets whether AOF is enabled.
aofFrequency String: Sets the frequency at which data is written to disk.
rdbEnabled Boolean: Sets whether RDB is enabled.
rdbFrequency String: Sets the frequency at which a snapshot of the database is created.

aofEnabled boolean: Sets whether AOF is enabled.
aofFrequency string: Sets the frequency at which data is written to disk.
rdbEnabled boolean: Sets whether RDB is enabled.
rdbFrequency string: Sets the frequency at which a snapshot of the database is created.

aof_enabled bool: Sets whether AOF is enabled.
aof_frequency str: Sets the frequency at which data is written to disk.
rdb_enabled bool: Sets whether RDB is enabled.
rdb_frequency str: Sets the frequency at which a snapshot of the database is created.

aofEnabled Boolean: Sets whether AOF is enabled.
aofFrequency String: Sets the frequency at which data is written to disk.
rdbEnabled Boolean: Sets whether RDB is enabled.
rdbFrequency String: Sets the frequency at which a snapshot of the database is created.