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.73.0 published on Wednesday, Nov 20, 2024 by Pulumi
azure-native.cache.getDatabase
Explore with Pulumi AI
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.73.0 published on Wednesday, Nov 20, 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, 2024-03-01-preview, 2024-06-01-preview, 2024-09-01-preview, 2024-10-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:
- Cluster
Name string - The name of the RedisEnterprise cluster.
- Database
Name string - The name of the database.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Cluster
Name string - The name of the RedisEnterprise cluster.
- Database
Name string - The name of the database.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- cluster
Name String - The name of the RedisEnterprise cluster.
- database
Name String - The name of the database.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- cluster
Name string - The name of the RedisEnterprise cluster.
- database
Name string - The name of the database.
- resource
Group stringName - 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_ strname - The name of the resource group. The name is case insensitive.
- cluster
Name String - The name of the RedisEnterprise cluster.
- database
Name String - The name of the database.
- resource
Group StringName - 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
- Provisioning
State string - Current provisioning status of the database
- Resource
State string - Current resource status of the database
- System
Data Pulumi.Azure Native. Cache. Outputs. System Data Response - 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"
- Client
Protocol string - Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted.
- Clustering
Policy string - Clustering policy - default is OSSCluster. Specified at create time.
- Eviction
Policy string - Redis eviction policy - default is VolatileLRU
- Geo
Replication Pulumi.Azure Native. Cache. Outputs. Database Properties Response Geo Replication - Optional set of properties to configure geo replication for this database.
- Modules
List<Pulumi.
Azure Native. Cache. Outputs. Module Response> - Optional set of redis modules to enable in this database - modules can only be added at creation time.
- Persistence
Pulumi.
Azure Native. Cache. Outputs. Persistence Response - 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
- Provisioning
State string - Current provisioning status of the database
- Resource
State string - Current resource status of the database
- System
Data SystemData Response - 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"
- Client
Protocol string - Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted.
- Clustering
Policy string - Clustering policy - default is OSSCluster. Specified at create time.
- Eviction
Policy string - Redis eviction policy - default is VolatileLRU
- Geo
Replication DatabaseProperties Response Geo Replication - Optional set of properties to configure geo replication for this database.
- Modules
[]Module
Response - Optional set of redis modules to enable in this database - modules can only be added at creation time.
- Persistence
Persistence
Response - 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
- provisioning
State String - Current provisioning status of the database
- resource
State String - Current resource status of the database
- system
Data SystemData Response - 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"
- client
Protocol String - Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted.
- clustering
Policy String - Clustering policy - default is OSSCluster. Specified at create time.
- eviction
Policy String - Redis eviction policy - default is VolatileLRU
- geo
Replication DatabaseProperties Response Geo Replication - Optional set of properties to configure geo replication for this database.
- modules
List<Module
Response> - Optional set of redis modules to enable in this database - modules can only be added at creation time.
- persistence
Persistence
Response - 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
- provisioning
State string - Current provisioning status of the database
- resource
State string - Current resource status of the database
- system
Data SystemData Response - 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"
- client
Protocol string - Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted.
- clustering
Policy string - Clustering policy - default is OSSCluster. Specified at create time.
- eviction
Policy string - Redis eviction policy - default is VolatileLRU
- geo
Replication DatabaseProperties Response Geo Replication - Optional set of properties to configure geo replication for this database.
- modules
Module
Response[] - Optional set of redis modules to enable in this database - modules can only be added at creation time.
- persistence
Persistence
Response - 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 SystemData Response - 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 DatabaseProperties Response Geo Replication - Optional set of properties to configure geo replication for this database.
- modules
Sequence[Module
Response] - Optional set of redis modules to enable in this database - modules can only be added at creation time.
- persistence
Persistence
Response - 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
- provisioning
State String - Current provisioning status of the database
- resource
State String - Current resource status of the database
- system
Data 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"
- client
Protocol String - Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted.
- clustering
Policy String - Clustering policy - default is OSSCluster. Specified at create time.
- eviction
Policy String - Redis eviction policy - default is VolatileLRU
- geo
Replication 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
- Group
Nickname string - Name for the group of linked database resources
- Linked
Databases List<Pulumi.Azure Native. Cache. Inputs. Linked Database Response> - List of database resources to link with this database
- Group
Nickname string - Name for the group of linked database resources
- Linked
Databases []LinkedDatabase Response - List of database resources to link with this database
- group
Nickname String - Name for the group of linked database resources
- linked
Databases List<LinkedDatabase Response> - List of database resources to link with this database
- group
Nickname string - Name for the group of linked database resources
- linked
Databases LinkedDatabase Response[] - List of database resources to link with this database
- group_
nickname str - Name for the group of linked database resources
- linked_
databases Sequence[LinkedDatabase Response] - List of database resources to link with this database
- group
Nickname String - Name for the group of linked database resources
- linked
Databases List<Property Map> - List of database resources to link with this database
LinkedDatabaseResponse
ModuleResponse
PersistenceResponse
- Aof
Enabled bool - Sets whether AOF is enabled.
- Aof
Frequency string - Sets the frequency at which data is written to disk.
- Rdb
Enabled bool - Sets whether RDB is enabled.
- Rdb
Frequency string - Sets the frequency at which a snapshot of the database is created.
- Aof
Enabled bool - Sets whether AOF is enabled.
- Aof
Frequency string - Sets the frequency at which data is written to disk.
- Rdb
Enabled bool - Sets whether RDB is enabled.
- Rdb
Frequency string - Sets the frequency at which a snapshot of the database is created.
- aof
Enabled Boolean - Sets whether AOF is enabled.
- aof
Frequency String - Sets the frequency at which data is written to disk.
- rdb
Enabled Boolean - Sets whether RDB is enabled.
- rdb
Frequency String - Sets the frequency at which a snapshot of the database is created.
- aof
Enabled boolean - Sets whether AOF is enabled.
- aof
Frequency string - Sets the frequency at which data is written to disk.
- rdb
Enabled boolean - Sets whether RDB is enabled.
- rdb
Frequency 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.
- aof
Enabled Boolean - Sets whether AOF is enabled.
- aof
Frequency String - Sets the frequency at which data is written to disk.
- rdb
Enabled Boolean - Sets whether RDB is enabled.
- rdb
Frequency String - Sets the frequency at which a snapshot of the database is created.
SystemDataResponse
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
- created
At string - The timestamp of resource creation (UTC).
- created
By string - The identity that created the resource.
- created
By stringType - The type of identity that created the resource.
- last
Modified stringAt - The timestamp of resource last modification (UTC)
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified stringBy Type - 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_ strtype - The type of identity that created the resource.
- last_
modified_ strat - The timestamp of resource last modification (UTC)
- last_
modified_ strby - The identity that last modified the resource.
- last_
modified_ strby_ type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
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 v1 docs if using the v1 version of this package.
Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi