Azure Classic

Pulumi Official
Package maintained by Pulumi
v5.8.0 published on Friday, May 27, 2022 by Pulumi

EnterpriseDatabase

Manages a Redis Enterprise Database.

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new Azure.Core.ResourceGroupArgs
        {
            Location = "West Europe",
        });
        var exampleEnterpriseCluster = new Azure.Redis.EnterpriseCluster("exampleEnterpriseCluster", new Azure.Redis.EnterpriseClusterArgs
        {
            ResourceGroupName = exampleResourceGroup.Name,
            Location = exampleResourceGroup.Location,
            SkuName = "Enterprise_E20-4",
        });
        var example1 = new Azure.Redis.EnterpriseCluster("example1", new Azure.Redis.EnterpriseClusterArgs
        {
            ResourceGroupName = exampleResourceGroup.Name,
            Location = exampleResourceGroup.Location,
            SkuName = "Enterprise_E20-4",
        });
        var exampleEnterpriseDatabase = new Azure.Redis.EnterpriseDatabase("exampleEnterpriseDatabase", new Azure.Redis.EnterpriseDatabaseArgs
        {
            ResourceGroupName = exampleResourceGroup.Name,
            ClusterId = exampleEnterpriseCluster.Id,
            ClientProtocol = "Encrypted",
            ClusteringPolicy = "EnterpriseCluster",
            EvictionPolicy = "NoEviction",
            Port = 10000,
            LinkedDatabaseIds = 
            {
                exampleEnterpriseCluster.Id.Apply(id => $"{id}/databases/default"),
                example1.Id.Apply(id => $"{id}/databases/default"),
            },
            LinkedDatabaseGroupNickname = "tftestGeoGroup",
        });
    }

}
package main

import (
	"fmt"

	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/redis"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleEnterpriseCluster, err := redis.NewEnterpriseCluster(ctx, "exampleEnterpriseCluster", &redis.EnterpriseClusterArgs{
			ResourceGroupName: exampleResourceGroup.Name,
			Location:          exampleResourceGroup.Location,
			SkuName:           pulumi.String("Enterprise_E20-4"),
		})
		if err != nil {
			return err
		}
		example1, err := redis.NewEnterpriseCluster(ctx, "example1", &redis.EnterpriseClusterArgs{
			ResourceGroupName: exampleResourceGroup.Name,
			Location:          exampleResourceGroup.Location,
			SkuName:           pulumi.String("Enterprise_E20-4"),
		})
		if err != nil {
			return err
		}
		_, err = redis.NewEnterpriseDatabase(ctx, "exampleEnterpriseDatabase", &redis.EnterpriseDatabaseArgs{
			ResourceGroupName: exampleResourceGroup.Name,
			ClusterId:         exampleEnterpriseCluster.ID(),
			ClientProtocol:    pulumi.String("Encrypted"),
			ClusteringPolicy:  pulumi.String("EnterpriseCluster"),
			EvictionPolicy:    pulumi.String("NoEviction"),
			Port:              pulumi.Int(10000),
			LinkedDatabaseIds: pulumi.StringArray{
				exampleEnterpriseCluster.ID().ApplyT(func(id string) (string, error) {
					return fmt.Sprintf("%v%v", id, "/databases/default"), nil
				}).(pulumi.StringOutput),
				example1.ID().ApplyT(func(id string) (string, error) {
					return fmt.Sprintf("%v%v", id, "/databases/default"), nil
				}).(pulumi.StringOutput),
			},
			LinkedDatabaseGroupNickname: pulumi.String("tftestGeoGroup"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()        
            .location("West Europe")
            .build());

        var exampleEnterpriseCluster = new EnterpriseCluster("exampleEnterpriseCluster", EnterpriseClusterArgs.builder()        
            .resourceGroupName(exampleResourceGroup.name())
            .location(exampleResourceGroup.location())
            .skuName("Enterprise_E20-4")
            .build());

        var example1 = new EnterpriseCluster("example1", EnterpriseClusterArgs.builder()        
            .resourceGroupName(exampleResourceGroup.name())
            .location(exampleResourceGroup.location())
            .skuName("Enterprise_E20-4")
            .build());

        var exampleEnterpriseDatabase = new EnterpriseDatabase("exampleEnterpriseDatabase", EnterpriseDatabaseArgs.builder()        
            .resourceGroupName(exampleResourceGroup.name())
            .clusterId(exampleEnterpriseCluster.id())
            .clientProtocol("Encrypted")
            .clusteringPolicy("EnterpriseCluster")
            .evictionPolicy("NoEviction")
            .port(10000)
            .linkedDatabaseIds(            
                exampleEnterpriseCluster.id().apply(id -> String.format("%s/databases/default", id)),
                example1.id().apply(id -> String.format("%s/databases/default", id)))
            .linkedDatabaseGroupNickname("tftestGeoGroup")
            .build());

    }
}
import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_enterprise_cluster = azure.redis.EnterpriseCluster("exampleEnterpriseCluster",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    sku_name="Enterprise_E20-4")
example1 = azure.redis.EnterpriseCluster("example1",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    sku_name="Enterprise_E20-4")
example_enterprise_database = azure.redis.EnterpriseDatabase("exampleEnterpriseDatabase",
    resource_group_name=example_resource_group.name,
    cluster_id=example_enterprise_cluster.id,
    client_protocol="Encrypted",
    clustering_policy="EnterpriseCluster",
    eviction_policy="NoEviction",
    port=10000,
    linked_database_ids=[
        example_enterprise_cluster.id.apply(lambda id: f"{id}/databases/default"),
        example1.id.apply(lambda id: f"{id}/databases/default"),
    ],
    linked_database_group_nickname="tftestGeoGroup")
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleEnterpriseCluster = new azure.redis.EnterpriseCluster("exampleEnterpriseCluster", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    skuName: "Enterprise_E20-4",
});
const example1 = new azure.redis.EnterpriseCluster("example1", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    skuName: "Enterprise_E20-4",
});
const exampleEnterpriseDatabase = new azure.redis.EnterpriseDatabase("exampleEnterpriseDatabase", {
    resourceGroupName: exampleResourceGroup.name,
    clusterId: exampleEnterpriseCluster.id,
    clientProtocol: "Encrypted",
    clusteringPolicy: "EnterpriseCluster",
    evictionPolicy: "NoEviction",
    port: 10000,
    linkedDatabaseIds: [
        pulumi.interpolate`${exampleEnterpriseCluster.id}/databases/default`,
        pulumi.interpolate`${example1.id}/databases/default`,
    ],
    linkedDatabaseGroupNickname: "tftestGeoGroup",
});
resources:
  exampleResourceGroup:
    type: azure:core:ResourceGroup
    properties:
      location: West Europe
  exampleEnterpriseCluster:
    type: azure:redis:EnterpriseCluster
    properties:
      resourceGroupName: ${exampleResourceGroup.name}
      location: ${exampleResourceGroup.location}
      skuName: Enterprise_E20-4
  example1:
    type: azure:redis:EnterpriseCluster
    properties:
      resourceGroupName: ${exampleResourceGroup.name}
      location: ${exampleResourceGroup.location}
      skuName: Enterprise_E20-4
  exampleEnterpriseDatabase:
    type: azure:redis:EnterpriseDatabase
    properties:
      resourceGroupName: ${exampleResourceGroup.name}
      clusterId: ${exampleEnterpriseCluster.id}
      clientProtocol: Encrypted
      clusteringPolicy: EnterpriseCluster
      evictionPolicy: NoEviction
      port: 10000
      linkedDatabaseIds:
        - ${exampleEnterpriseCluster.id}/databases/default
        - ${example1.id}/databases/default
      linkedDatabaseGroupNickname: tftestGeoGroup

Create a EnterpriseDatabase Resource

new EnterpriseDatabase(name: string, args: EnterpriseDatabaseArgs, opts?: CustomResourceOptions);
@overload
def EnterpriseDatabase(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       client_protocol: Optional[str] = None,
                       cluster_id: Optional[str] = None,
                       clustering_policy: Optional[str] = None,
                       eviction_policy: Optional[str] = None,
                       linked_database_group_nickname: Optional[str] = None,
                       linked_database_ids: Optional[Sequence[str]] = None,
                       modules: Optional[Sequence[EnterpriseDatabaseModuleArgs]] = None,
                       name: Optional[str] = None,
                       port: Optional[int] = None,
                       resource_group_name: Optional[str] = None)
@overload
def EnterpriseDatabase(resource_name: str,
                       args: EnterpriseDatabaseArgs,
                       opts: Optional[ResourceOptions] = None)
func NewEnterpriseDatabase(ctx *Context, name string, args EnterpriseDatabaseArgs, opts ...ResourceOption) (*EnterpriseDatabase, error)
public EnterpriseDatabase(string name, EnterpriseDatabaseArgs args, CustomResourceOptions? opts = null)
public EnterpriseDatabase(String name, EnterpriseDatabaseArgs args)
public EnterpriseDatabase(String name, EnterpriseDatabaseArgs args, CustomResourceOptions options)
type: azure:redis:EnterpriseDatabase
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args EnterpriseDatabaseArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args EnterpriseDatabaseArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args EnterpriseDatabaseArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args EnterpriseDatabaseArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args EnterpriseDatabaseArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

EnterpriseDatabase Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The EnterpriseDatabase resource accepts the following input properties:

ClusterId string

The resource id of the Redis Enterprise Cluster to deploy this Redis Enterprise Database. Changing this forces a new Redis Enterprise Database to be created.

ClientProtocol string

Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted. Possible values are Encrypted and Plaintext. Defaults to Encrypted. Changing this forces a new Redis Enterprise Database to be created.

ClusteringPolicy string

Clustering policy - default is OSSCluster. Specified at create time. Possible values are EnterpriseCluster and OSSCluster. Defaults to OSSCluster. Changing this forces a new Redis Enterprise Database to be created.

EvictionPolicy string

Redis eviction policy - default is VolatileLRU. Possible values are AllKeysLFU, AllKeysLRU, AllKeysRandom, VolatileLRU, VolatileLFU, VolatileTTL, VolatileRandom and NoEviction. Changing this forces a new Redis Enterprise Database to be created.

LinkedDatabaseGroupNickname string

Nickname of the group of linked databases. Changing this force a new Redis Enterprise Geo Database to be created.

LinkedDatabaseIds List<string>

A list of database resources to link with this database with a maximum of 5.

Modules List<EnterpriseDatabaseModuleArgs>

A module block as defined below.

Name string

The name which should be used for this Redis Enterprise Database. Currently the acceptable value for this argument is default. Defaults to default. Changing this forces a new Redis Enterprise Database to be created.

Port int

TCP port of the database endpoint. Specified at create time. Defaults to an available port. Changing this forces a new Redis Enterprise Database to be created.

ResourceGroupName string

The name of the Resource Group where the Redis Enterprise Database should exist. Changing this forces a new Redis Enterprise Database to be created.

Deprecated:

This field is no longer used and will be removed in the next major version of the Azure Provider

ClusterId string

The resource id of the Redis Enterprise Cluster to deploy this Redis Enterprise Database. Changing this forces a new Redis Enterprise Database to be created.

ClientProtocol string

Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted. Possible values are Encrypted and Plaintext. Defaults to Encrypted. Changing this forces a new Redis Enterprise Database to be created.

ClusteringPolicy string

Clustering policy - default is OSSCluster. Specified at create time. Possible values are EnterpriseCluster and OSSCluster. Defaults to OSSCluster. Changing this forces a new Redis Enterprise Database to be created.

EvictionPolicy string

Redis eviction policy - default is VolatileLRU. Possible values are AllKeysLFU, AllKeysLRU, AllKeysRandom, VolatileLRU, VolatileLFU, VolatileTTL, VolatileRandom and NoEviction. Changing this forces a new Redis Enterprise Database to be created.

LinkedDatabaseGroupNickname string

Nickname of the group of linked databases. Changing this force a new Redis Enterprise Geo Database to be created.

LinkedDatabaseIds []string

A list of database resources to link with this database with a maximum of 5.

Modules []EnterpriseDatabaseModuleArgs

A module block as defined below.

Name string

The name which should be used for this Redis Enterprise Database. Currently the acceptable value for this argument is default. Defaults to default. Changing this forces a new Redis Enterprise Database to be created.

Port int

TCP port of the database endpoint. Specified at create time. Defaults to an available port. Changing this forces a new Redis Enterprise Database to be created.

ResourceGroupName string

The name of the Resource Group where the Redis Enterprise Database should exist. Changing this forces a new Redis Enterprise Database to be created.

Deprecated:

This field is no longer used and will be removed in the next major version of the Azure Provider

clusterId String

The resource id of the Redis Enterprise Cluster to deploy this Redis Enterprise Database. Changing this forces a new Redis Enterprise Database to be created.

clientProtocol String

Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted. Possible values are Encrypted and Plaintext. Defaults to Encrypted. Changing this forces a new Redis Enterprise Database to be created.

clusteringPolicy String

Clustering policy - default is OSSCluster. Specified at create time. Possible values are EnterpriseCluster and OSSCluster. Defaults to OSSCluster. Changing this forces a new Redis Enterprise Database to be created.

evictionPolicy String

Redis eviction policy - default is VolatileLRU. Possible values are AllKeysLFU, AllKeysLRU, AllKeysRandom, VolatileLRU, VolatileLFU, VolatileTTL, VolatileRandom and NoEviction. Changing this forces a new Redis Enterprise Database to be created.

linkedDatabaseGroupNickname String

Nickname of the group of linked databases. Changing this force a new Redis Enterprise Geo Database to be created.

linkedDatabaseIds List<String>

A list of database resources to link with this database with a maximum of 5.

modules List<EnterpriseDatabaseModuleArgs>

A module block as defined below.

name String

The name which should be used for this Redis Enterprise Database. Currently the acceptable value for this argument is default. Defaults to default. Changing this forces a new Redis Enterprise Database to be created.

port Integer

TCP port of the database endpoint. Specified at create time. Defaults to an available port. Changing this forces a new Redis Enterprise Database to be created.

resourceGroupName String

The name of the Resource Group where the Redis Enterprise Database should exist. Changing this forces a new Redis Enterprise Database to be created.

Deprecated:

This field is no longer used and will be removed in the next major version of the Azure Provider

clusterId string

The resource id of the Redis Enterprise Cluster to deploy this Redis Enterprise Database. Changing this forces a new Redis Enterprise Database to be created.

clientProtocol string

Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted. Possible values are Encrypted and Plaintext. Defaults to Encrypted. Changing this forces a new Redis Enterprise Database to be created.

clusteringPolicy string

Clustering policy - default is OSSCluster. Specified at create time. Possible values are EnterpriseCluster and OSSCluster. Defaults to OSSCluster. Changing this forces a new Redis Enterprise Database to be created.

evictionPolicy string

Redis eviction policy - default is VolatileLRU. Possible values are AllKeysLFU, AllKeysLRU, AllKeysRandom, VolatileLRU, VolatileLFU, VolatileTTL, VolatileRandom and NoEviction. Changing this forces a new Redis Enterprise Database to be created.

linkedDatabaseGroupNickname string

Nickname of the group of linked databases. Changing this force a new Redis Enterprise Geo Database to be created.

linkedDatabaseIds string[]

A list of database resources to link with this database with a maximum of 5.

modules EnterpriseDatabaseModuleArgs[]

A module block as defined below.

name string

The name which should be used for this Redis Enterprise Database. Currently the acceptable value for this argument is default. Defaults to default. Changing this forces a new Redis Enterprise Database to be created.

port number

TCP port of the database endpoint. Specified at create time. Defaults to an available port. Changing this forces a new Redis Enterprise Database to be created.

resourceGroupName string

The name of the Resource Group where the Redis Enterprise Database should exist. Changing this forces a new Redis Enterprise Database to be created.

Deprecated:

This field is no longer used and will be removed in the next major version of the Azure Provider

cluster_id str

The resource id of the Redis Enterprise Cluster to deploy this Redis Enterprise Database. Changing this forces a new Redis Enterprise Database to be created.

client_protocol str

Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted. Possible values are Encrypted and Plaintext. Defaults to Encrypted. Changing this forces a new Redis Enterprise Database to be created.

clustering_policy str

Clustering policy - default is OSSCluster. Specified at create time. Possible values are EnterpriseCluster and OSSCluster. Defaults to OSSCluster. Changing this forces a new Redis Enterprise Database to be created.

eviction_policy str

Redis eviction policy - default is VolatileLRU. Possible values are AllKeysLFU, AllKeysLRU, AllKeysRandom, VolatileLRU, VolatileLFU, VolatileTTL, VolatileRandom and NoEviction. Changing this forces a new Redis Enterprise Database to be created.

linked_database_group_nickname str

Nickname of the group of linked databases. Changing this force a new Redis Enterprise Geo Database to be created.

linked_database_ids Sequence[str]

A list of database resources to link with this database with a maximum of 5.

modules Sequence[EnterpriseDatabaseModuleArgs]

A module block as defined below.

name str

The name which should be used for this Redis Enterprise Database. Currently the acceptable value for this argument is default. Defaults to default. Changing this forces a new Redis Enterprise Database to be created.

port int

TCP port of the database endpoint. Specified at create time. Defaults to an available port. Changing this forces a new Redis Enterprise Database to be created.

resource_group_name str

The name of the Resource Group where the Redis Enterprise Database should exist. Changing this forces a new Redis Enterprise Database to be created.

Deprecated:

This field is no longer used and will be removed in the next major version of the Azure Provider

clusterId String

The resource id of the Redis Enterprise Cluster to deploy this Redis Enterprise Database. Changing this forces a new Redis Enterprise Database to be created.

clientProtocol String

Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted. Possible values are Encrypted and Plaintext. Defaults to Encrypted. Changing this forces a new Redis Enterprise Database to be created.

clusteringPolicy String

Clustering policy - default is OSSCluster. Specified at create time. Possible values are EnterpriseCluster and OSSCluster. Defaults to OSSCluster. Changing this forces a new Redis Enterprise Database to be created.

evictionPolicy String

Redis eviction policy - default is VolatileLRU. Possible values are AllKeysLFU, AllKeysLRU, AllKeysRandom, VolatileLRU, VolatileLFU, VolatileTTL, VolatileRandom and NoEviction. Changing this forces a new Redis Enterprise Database to be created.

linkedDatabaseGroupNickname String

Nickname of the group of linked databases. Changing this force a new Redis Enterprise Geo Database to be created.

linkedDatabaseIds List<String>

A list of database resources to link with this database with a maximum of 5.

modules List<Property Map>

A module block as defined below.

name String

The name which should be used for this Redis Enterprise Database. Currently the acceptable value for this argument is default. Defaults to default. Changing this forces a new Redis Enterprise Database to be created.

port Number

TCP port of the database endpoint. Specified at create time. Defaults to an available port. Changing this forces a new Redis Enterprise Database to be created.

resourceGroupName String

The name of the Resource Group where the Redis Enterprise Database should exist. Changing this forces a new Redis Enterprise Database to be created.

Deprecated:

This field is no longer used and will be removed in the next major version of the Azure Provider

Outputs

All input properties are implicitly available as output properties. Additionally, the EnterpriseDatabase resource produces the following output properties:

Id string

The provider-assigned unique ID for this managed resource.

PrimaryAccessKey string

The Primary Access Key for the Redis Enterprise Database Instance.

SecondaryAccessKey string

The Secondary Access Key for the Redis Enterprise Database Instance.

Id string

The provider-assigned unique ID for this managed resource.

PrimaryAccessKey string

The Primary Access Key for the Redis Enterprise Database Instance.

SecondaryAccessKey string

The Secondary Access Key for the Redis Enterprise Database Instance.

id String

The provider-assigned unique ID for this managed resource.

primaryAccessKey String

The Primary Access Key for the Redis Enterprise Database Instance.

secondaryAccessKey String

The Secondary Access Key for the Redis Enterprise Database Instance.

id string

The provider-assigned unique ID for this managed resource.

primaryAccessKey string

The Primary Access Key for the Redis Enterprise Database Instance.

secondaryAccessKey string

The Secondary Access Key for the Redis Enterprise Database Instance.

id str

The provider-assigned unique ID for this managed resource.

primary_access_key str

The Primary Access Key for the Redis Enterprise Database Instance.

secondary_access_key str

The Secondary Access Key for the Redis Enterprise Database Instance.

id String

The provider-assigned unique ID for this managed resource.

primaryAccessKey String

The Primary Access Key for the Redis Enterprise Database Instance.

secondaryAccessKey String

The Secondary Access Key for the Redis Enterprise Database Instance.

Look up an Existing EnterpriseDatabase Resource

Get an existing EnterpriseDatabase resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: EnterpriseDatabaseState, opts?: CustomResourceOptions): EnterpriseDatabase
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        client_protocol: Optional[str] = None,
        cluster_id: Optional[str] = None,
        clustering_policy: Optional[str] = None,
        eviction_policy: Optional[str] = None,
        linked_database_group_nickname: Optional[str] = None,
        linked_database_ids: Optional[Sequence[str]] = None,
        modules: Optional[Sequence[EnterpriseDatabaseModuleArgs]] = None,
        name: Optional[str] = None,
        port: Optional[int] = None,
        primary_access_key: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        secondary_access_key: Optional[str] = None) -> EnterpriseDatabase
func GetEnterpriseDatabase(ctx *Context, name string, id IDInput, state *EnterpriseDatabaseState, opts ...ResourceOption) (*EnterpriseDatabase, error)
public static EnterpriseDatabase Get(string name, Input<string> id, EnterpriseDatabaseState? state, CustomResourceOptions? opts = null)
public static EnterpriseDatabase get(String name, Output<String> id, EnterpriseDatabaseState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
ClientProtocol string

Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted. Possible values are Encrypted and Plaintext. Defaults to Encrypted. Changing this forces a new Redis Enterprise Database to be created.

ClusterId string

The resource id of the Redis Enterprise Cluster to deploy this Redis Enterprise Database. Changing this forces a new Redis Enterprise Database to be created.

ClusteringPolicy string

Clustering policy - default is OSSCluster. Specified at create time. Possible values are EnterpriseCluster and OSSCluster. Defaults to OSSCluster. Changing this forces a new Redis Enterprise Database to be created.

EvictionPolicy string

Redis eviction policy - default is VolatileLRU. Possible values are AllKeysLFU, AllKeysLRU, AllKeysRandom, VolatileLRU, VolatileLFU, VolatileTTL, VolatileRandom and NoEviction. Changing this forces a new Redis Enterprise Database to be created.

LinkedDatabaseGroupNickname string

Nickname of the group of linked databases. Changing this force a new Redis Enterprise Geo Database to be created.

LinkedDatabaseIds List<string>

A list of database resources to link with this database with a maximum of 5.

Modules List<EnterpriseDatabaseModuleArgs>

A module block as defined below.

Name string

The name which should be used for this Redis Enterprise Database. Currently the acceptable value for this argument is default. Defaults to default. Changing this forces a new Redis Enterprise Database to be created.

Port int

TCP port of the database endpoint. Specified at create time. Defaults to an available port. Changing this forces a new Redis Enterprise Database to be created.

PrimaryAccessKey string

The Primary Access Key for the Redis Enterprise Database Instance.

ResourceGroupName string

The name of the Resource Group where the Redis Enterprise Database should exist. Changing this forces a new Redis Enterprise Database to be created.

Deprecated:

This field is no longer used and will be removed in the next major version of the Azure Provider

SecondaryAccessKey string

The Secondary Access Key for the Redis Enterprise Database Instance.

ClientProtocol string

Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted. Possible values are Encrypted and Plaintext. Defaults to Encrypted. Changing this forces a new Redis Enterprise Database to be created.

ClusterId string

The resource id of the Redis Enterprise Cluster to deploy this Redis Enterprise Database. Changing this forces a new Redis Enterprise Database to be created.

ClusteringPolicy string

Clustering policy - default is OSSCluster. Specified at create time. Possible values are EnterpriseCluster and OSSCluster. Defaults to OSSCluster. Changing this forces a new Redis Enterprise Database to be created.

EvictionPolicy string

Redis eviction policy - default is VolatileLRU. Possible values are AllKeysLFU, AllKeysLRU, AllKeysRandom, VolatileLRU, VolatileLFU, VolatileTTL, VolatileRandom and NoEviction. Changing this forces a new Redis Enterprise Database to be created.

LinkedDatabaseGroupNickname string

Nickname of the group of linked databases. Changing this force a new Redis Enterprise Geo Database to be created.

LinkedDatabaseIds []string

A list of database resources to link with this database with a maximum of 5.

Modules []EnterpriseDatabaseModuleArgs

A module block as defined below.

Name string

The name which should be used for this Redis Enterprise Database. Currently the acceptable value for this argument is default. Defaults to default. Changing this forces a new Redis Enterprise Database to be created.

Port int

TCP port of the database endpoint. Specified at create time. Defaults to an available port. Changing this forces a new Redis Enterprise Database to be created.

PrimaryAccessKey string

The Primary Access Key for the Redis Enterprise Database Instance.

ResourceGroupName string

The name of the Resource Group where the Redis Enterprise Database should exist. Changing this forces a new Redis Enterprise Database to be created.

Deprecated:

This field is no longer used and will be removed in the next major version of the Azure Provider

SecondaryAccessKey string

The Secondary Access Key for the Redis Enterprise Database Instance.

clientProtocol String

Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted. Possible values are Encrypted and Plaintext. Defaults to Encrypted. Changing this forces a new Redis Enterprise Database to be created.

clusterId String

The resource id of the Redis Enterprise Cluster to deploy this Redis Enterprise Database. Changing this forces a new Redis Enterprise Database to be created.

clusteringPolicy String

Clustering policy - default is OSSCluster. Specified at create time. Possible values are EnterpriseCluster and OSSCluster. Defaults to OSSCluster. Changing this forces a new Redis Enterprise Database to be created.

evictionPolicy String

Redis eviction policy - default is VolatileLRU. Possible values are AllKeysLFU, AllKeysLRU, AllKeysRandom, VolatileLRU, VolatileLFU, VolatileTTL, VolatileRandom and NoEviction. Changing this forces a new Redis Enterprise Database to be created.

linkedDatabaseGroupNickname String

Nickname of the group of linked databases. Changing this force a new Redis Enterprise Geo Database to be created.

linkedDatabaseIds List<String>

A list of database resources to link with this database with a maximum of 5.

modules List<EnterpriseDatabaseModuleArgs>

A module block as defined below.

name String

The name which should be used for this Redis Enterprise Database. Currently the acceptable value for this argument is default. Defaults to default. Changing this forces a new Redis Enterprise Database to be created.

port Integer

TCP port of the database endpoint. Specified at create time. Defaults to an available port. Changing this forces a new Redis Enterprise Database to be created.

primaryAccessKey String

The Primary Access Key for the Redis Enterprise Database Instance.

resourceGroupName String

The name of the Resource Group where the Redis Enterprise Database should exist. Changing this forces a new Redis Enterprise Database to be created.

Deprecated:

This field is no longer used and will be removed in the next major version of the Azure Provider

secondaryAccessKey String

The Secondary Access Key for the Redis Enterprise Database Instance.

clientProtocol string

Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted. Possible values are Encrypted and Plaintext. Defaults to Encrypted. Changing this forces a new Redis Enterprise Database to be created.

clusterId string

The resource id of the Redis Enterprise Cluster to deploy this Redis Enterprise Database. Changing this forces a new Redis Enterprise Database to be created.

clusteringPolicy string

Clustering policy - default is OSSCluster. Specified at create time. Possible values are EnterpriseCluster and OSSCluster. Defaults to OSSCluster. Changing this forces a new Redis Enterprise Database to be created.

evictionPolicy string

Redis eviction policy - default is VolatileLRU. Possible values are AllKeysLFU, AllKeysLRU, AllKeysRandom, VolatileLRU, VolatileLFU, VolatileTTL, VolatileRandom and NoEviction. Changing this forces a new Redis Enterprise Database to be created.

linkedDatabaseGroupNickname string

Nickname of the group of linked databases. Changing this force a new Redis Enterprise Geo Database to be created.

linkedDatabaseIds string[]

A list of database resources to link with this database with a maximum of 5.

modules EnterpriseDatabaseModuleArgs[]

A module block as defined below.

name string

The name which should be used for this Redis Enterprise Database. Currently the acceptable value for this argument is default. Defaults to default. Changing this forces a new Redis Enterprise Database to be created.

port number

TCP port of the database endpoint. Specified at create time. Defaults to an available port. Changing this forces a new Redis Enterprise Database to be created.

primaryAccessKey string

The Primary Access Key for the Redis Enterprise Database Instance.

resourceGroupName string

The name of the Resource Group where the Redis Enterprise Database should exist. Changing this forces a new Redis Enterprise Database to be created.

Deprecated:

This field is no longer used and will be removed in the next major version of the Azure Provider

secondaryAccessKey string

The Secondary Access Key for the Redis Enterprise Database Instance.

client_protocol str

Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted. Possible values are Encrypted and Plaintext. Defaults to Encrypted. Changing this forces a new Redis Enterprise Database to be created.

cluster_id str

The resource id of the Redis Enterprise Cluster to deploy this Redis Enterprise Database. Changing this forces a new Redis Enterprise Database to be created.

clustering_policy str

Clustering policy - default is OSSCluster. Specified at create time. Possible values are EnterpriseCluster and OSSCluster. Defaults to OSSCluster. Changing this forces a new Redis Enterprise Database to be created.

eviction_policy str

Redis eviction policy - default is VolatileLRU. Possible values are AllKeysLFU, AllKeysLRU, AllKeysRandom, VolatileLRU, VolatileLFU, VolatileTTL, VolatileRandom and NoEviction. Changing this forces a new Redis Enterprise Database to be created.

linked_database_group_nickname str

Nickname of the group of linked databases. Changing this force a new Redis Enterprise Geo Database to be created.

linked_database_ids Sequence[str]

A list of database resources to link with this database with a maximum of 5.

modules Sequence[EnterpriseDatabaseModuleArgs]

A module block as defined below.

name str

The name which should be used for this Redis Enterprise Database. Currently the acceptable value for this argument is default. Defaults to default. Changing this forces a new Redis Enterprise Database to be created.

port int

TCP port of the database endpoint. Specified at create time. Defaults to an available port. Changing this forces a new Redis Enterprise Database to be created.

primary_access_key str

The Primary Access Key for the Redis Enterprise Database Instance.

resource_group_name str

The name of the Resource Group where the Redis Enterprise Database should exist. Changing this forces a new Redis Enterprise Database to be created.

Deprecated:

This field is no longer used and will be removed in the next major version of the Azure Provider

secondary_access_key str

The Secondary Access Key for the Redis Enterprise Database Instance.

clientProtocol String

Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted. Possible values are Encrypted and Plaintext. Defaults to Encrypted. Changing this forces a new Redis Enterprise Database to be created.

clusterId String

The resource id of the Redis Enterprise Cluster to deploy this Redis Enterprise Database. Changing this forces a new Redis Enterprise Database to be created.

clusteringPolicy String

Clustering policy - default is OSSCluster. Specified at create time. Possible values are EnterpriseCluster and OSSCluster. Defaults to OSSCluster. Changing this forces a new Redis Enterprise Database to be created.

evictionPolicy String

Redis eviction policy - default is VolatileLRU. Possible values are AllKeysLFU, AllKeysLRU, AllKeysRandom, VolatileLRU, VolatileLFU, VolatileTTL, VolatileRandom and NoEviction. Changing this forces a new Redis Enterprise Database to be created.

linkedDatabaseGroupNickname String

Nickname of the group of linked databases. Changing this force a new Redis Enterprise Geo Database to be created.

linkedDatabaseIds List<String>

A list of database resources to link with this database with a maximum of 5.

modules List<Property Map>

A module block as defined below.

name String

The name which should be used for this Redis Enterprise Database. Currently the acceptable value for this argument is default. Defaults to default. Changing this forces a new Redis Enterprise Database to be created.

port Number

TCP port of the database endpoint. Specified at create time. Defaults to an available port. Changing this forces a new Redis Enterprise Database to be created.

primaryAccessKey String

The Primary Access Key for the Redis Enterprise Database Instance.

resourceGroupName String

The name of the Resource Group where the Redis Enterprise Database should exist. Changing this forces a new Redis Enterprise Database to be created.

Deprecated:

This field is no longer used and will be removed in the next major version of the Azure Provider

secondaryAccessKey String

The Secondary Access Key for the Redis Enterprise Database Instance.

Supporting Types

EnterpriseDatabaseModule

Name string

The name which should be used for this module. Possible values are RediSearch, RedisBloom and RedisTimeSeries. Changing this forces a new Redis Enterprise Database to be created.

Args string

Configuration options for the module (e.g. ERROR_RATE 0.00 INITIAL_SIZE 400).

Version string
Name string

The name which should be used for this module. Possible values are RediSearch, RedisBloom and RedisTimeSeries. Changing this forces a new Redis Enterprise Database to be created.

Args string

Configuration options for the module (e.g. ERROR_RATE 0.00 INITIAL_SIZE 400).

Version string
name String

The name which should be used for this module. Possible values are RediSearch, RedisBloom and RedisTimeSeries. Changing this forces a new Redis Enterprise Database to be created.

args String

Configuration options for the module (e.g. ERROR_RATE 0.00 INITIAL_SIZE 400).

version String
name string

The name which should be used for this module. Possible values are RediSearch, RedisBloom and RedisTimeSeries. Changing this forces a new Redis Enterprise Database to be created.

args string

Configuration options for the module (e.g. ERROR_RATE 0.00 INITIAL_SIZE 400).

version string
name str

The name which should be used for this module. Possible values are RediSearch, RedisBloom and RedisTimeSeries. Changing this forces a new Redis Enterprise Database to be created.

args str

Configuration options for the module (e.g. ERROR_RATE 0.00 INITIAL_SIZE 400).

version str
name String

The name which should be used for this module. Possible values are RediSearch, RedisBloom and RedisTimeSeries. Changing this forces a new Redis Enterprise Database to be created.

args String

Configuration options for the module (e.g. ERROR_RATE 0.00 INITIAL_SIZE 400).

version String

Import

Redis Enterprise Databases can be imported using the resource id, e.g.

 $ pulumi import azure:redis/enterpriseDatabase:EnterpriseDatabase example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.Cache/redisEnterprise/cluster1/databases/database1

Package Details

Repository
https://github.com/pulumi/pulumi-azure
License
Apache-2.0
Notes

This Pulumi package is based on the azurerm Terraform Provider.