1. Packages
  2. Azure Native
  3. API Docs
  4. cache
  5. getDatabase
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.36.0 published on Monday, Apr 8, 2024 by Pulumi

azure-native.cache.getDatabase

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.36.0 published on Monday, Apr 8, 2024 by Pulumi

    Gets information about a database in a RedisEnterprise cluster. Azure REST API version: 2023-03-01-preview.

    Other available API versions: 2023-07-01, 2023-08-01-preview, 2023-10-01-preview, 2023-11-01, 2024-02-01.

    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)
    // Output-based functions aren't available in Java yet
    
    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
    SystemData Pulumi.AzureNative.Cache.Outputs.SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    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
    GeoReplication Pulumi.AzureNative.Cache.Outputs.DatabasePropertiesResponseGeoReplication
    Optional set of properties to configure geo replication for this database.
    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
    SystemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    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
    GeoReplication DatabasePropertiesResponseGeoReplication
    Optional set of properties to configure geo replication for this database.
    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
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    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
    geoReplication DatabasePropertiesResponseGeoReplication
    Optional set of properties to configure geo replication for this database.
    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
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    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
    geoReplication DatabasePropertiesResponseGeoReplication
    Optional set of properties to configure geo replication for this database.
    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
    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    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
    geo_replication DatabasePropertiesResponseGeoReplication
    Optional set of properties to configure geo replication for this database.
    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
    systemData Property Map
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    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
    geoReplication Property Map
    Optional set of properties to configure geo replication for this database.
    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

    DatabasePropertiesResponseGeoReplication

    GroupNickname string
    Name for the group of linked database resources
    LinkedDatabases List<Pulumi.AzureNative.Cache.Inputs.LinkedDatabaseResponse>
    List of database resources to link with this database
    GroupNickname string
    Name for the group of linked database resources
    LinkedDatabases []LinkedDatabaseResponse
    List of database resources to link with this database
    groupNickname String
    Name for the group of linked database resources
    linkedDatabases List<LinkedDatabaseResponse>
    List of database resources to link with this database
    groupNickname string
    Name for the group of linked database resources
    linkedDatabases LinkedDatabaseResponse[]
    List of database resources to link with this database
    group_nickname str
    Name for the group of linked database resources
    linked_databases Sequence[LinkedDatabaseResponse]
    List of database resources to link with this database
    groupNickname String
    Name for the group of linked database resources
    linkedDatabases List<Property Map>
    List of database resources to link with this database

    LinkedDatabaseResponse

    State string
    State of the link between the database resources.
    Id string
    Resource ID of a database resource to link with this database.
    State string
    State of the link between the database resources.
    Id string
    Resource ID of a database resource to link with this database.
    state String
    State of the link between the database resources.
    id String
    Resource ID of a database resource to link with this database.
    state string
    State of the link between the database resources.
    id string
    Resource ID of a database resource to link with this database.
    state str
    State of the link between the database resources.
    id str
    Resource ID of a database resource to link with this database.
    state String
    State of the link between the database resources.
    id String
    Resource ID of a database resource to link with this database.

    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.01 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.01 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.01 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.01 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.01 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.01 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.

    SystemDataResponse

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    The type of identity that last modified the resource.
    created_at str
    The timestamp of resource creation (UTC).
    created_by str
    The identity that created the resource.
    created_by_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.36.0 published on Monday, Apr 8, 2024 by Pulumi