@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 5.5 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* Gets information about a database in a Redis Enterprise cluster.
*
* Uses Azure REST API version 2025-05-01-preview.
*
* Other available API versions: 2020-10-01-preview, 2021-02-01-preview, 2021-03-01, 2021-08-01, 2022-01-01, 2022-11-01-preview, 2023-03-01-preview, 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, 2025-04-01. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native redisenterprise [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare function getDatabase(args: GetDatabaseArgs, opts?: pulumi.InvokeOptions): Promise<GetDatabaseResult>;
export interface GetDatabaseArgs {
/**
* The name of the Redis Enterprise cluster. Name must be 1-60 characters long. Allowed characters(A-Z, a-z, 0-9) and hyphen(-). There can be no leading nor trailing nor consecutive hyphens
*/
clusterName: string;
/**
* The name of the Redis Enterprise database.
*/
databaseName: string;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: string;
}
/**
* Describes a database on the Redis Enterprise cluster
*/
export interface GetDatabaseResult {
/**
* This property can be Enabled/Disabled to allow or deny access with the current access keys. Can be updated even after database is created.
*/
readonly accessKeysAuthentication?: string;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: string;
/**
* Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted.
*/
readonly clientProtocol?: string;
/**
* Clustering policy - default is OSSCluster. This property can be updated only if the current value is NoCluster. If the value is OSSCluster or EnterpriseCluster, it cannot be updated without deleting the database.
*/
readonly clusteringPolicy?: string;
/**
* Option to defer upgrade when newest version is released - default is NotDeferred. Learn more: https://aka.ms/redisversionupgrade
*/
readonly deferUpgrade?: string;
/**
* Redis eviction policy - default is VolatileLRU
*/
readonly evictionPolicy?: string;
/**
* Optional set of properties to configure geo replication for this database.
*/
readonly geoReplication?: outputs.redisenterprise.DatabasePropertiesResponseGeoReplication;
/**
* Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
*/
readonly id: string;
/**
* Optional set of redis modules to enable in this database - modules can only be added at creation time.
*/
readonly modules?: outputs.redisenterprise.ModuleResponse[];
/**
* The name of the resource
*/
readonly name: string;
/**
* Persistence settings
*/
readonly persistence?: outputs.redisenterprise.PersistenceResponse;
/**
* TCP port of the database endpoint. Specified at create time. Defaults to an available port.
*/
readonly port?: number;
/**
* Current provisioning status of the database
*/
readonly provisioningState: string;
/**
* Version of Redis the database is running on, e.g. '6.0'
*/
readonly redisVersion: string;
/**
* Current resource status of the database
*/
readonly resourceState: string;
/**
* Azure Resource Manager metadata containing createdBy and modifiedBy information.
*/
readonly systemData: outputs.redisenterprise.SystemDataResponse;
/**
* The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
*/
readonly type: string;
}
/**
* Gets information about a database in a Redis Enterprise cluster.
*
* Uses Azure REST API version 2025-05-01-preview.
*
* Other available API versions: 2020-10-01-preview, 2021-02-01-preview, 2021-03-01, 2021-08-01, 2022-01-01, 2022-11-01-preview, 2023-03-01-preview, 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, 2025-04-01. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native redisenterprise [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare function getDatabaseOutput(args: GetDatabaseOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetDatabaseResult>;
export interface GetDatabaseOutputArgs {
/**
* The name of the Redis Enterprise cluster. Name must be 1-60 characters long. Allowed characters(A-Z, a-z, 0-9) and hyphen(-). There can be no leading nor trailing nor consecutive hyphens
*/
clusterName: pulumi.Input<string>;
/**
* The name of the Redis Enterprise database.
*/
databaseName: pulumi.Input<string>;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: pulumi.Input<string>;
}