@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 5.4 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* Gets information about 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, 2025-07-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 getRedisEnterprise(args: GetRedisEnterpriseArgs, opts?: pulumi.InvokeOptions): Promise<GetRedisEnterpriseResult>;
export interface GetRedisEnterpriseArgs {
/**
* 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 resource group. The name is case insensitive.
*/
resourceGroupName: string;
}
/**
* Describes the Redis Enterprise cluster
*/
export interface GetRedisEnterpriseResult {
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: string;
/**
* Encryption-at-rest configuration for the cluster.
*/
readonly encryption?: outputs.redisenterprise.ClusterPropertiesResponseEncryption;
/**
* Enabled by default. If highAvailability is disabled, the data set is not replicated. This affects the availability SLA, and increases the risk of data loss.
*/
readonly highAvailability?: string;
/**
* DNS name of the cluster endpoint
*/
readonly hostName: string;
/**
* Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
*/
readonly id: string;
/**
* The identity of the resource.
*/
readonly identity?: outputs.redisenterprise.ManagedServiceIdentityResponse;
/**
* Distinguishes the kind of cluster. Read-only.
*/
readonly kind: string;
/**
* The geo-location where the resource lives
*/
readonly location: string;
/**
* The minimum TLS version for the cluster to support, e.g. '1.2'. Newer versions can be added in the future. Note that TLS 1.0 and TLS 1.1 are now completely obsolete -- you cannot use them. They are mentioned only for the sake of consistency with old API versions.
*/
readonly minimumTlsVersion?: string;
/**
* The name of the resource
*/
readonly name: string;
/**
* List of private endpoint connections associated with the specified Redis Enterprise cluster
*/
readonly privateEndpointConnections: outputs.redisenterprise.PrivateEndpointConnectionResponse[];
/**
* Current provisioning status of the cluster
*/
readonly provisioningState: string;
/**
* Version of redis the cluster supports, e.g. '6'
*/
readonly redisVersion: string;
/**
* Explains the current redundancy strategy of the cluster, which affects the expected SLA.
*/
readonly redundancyMode: string;
/**
* Current resource status of the cluster
*/
readonly resourceState: string;
/**
* The SKU to create, which affects price, performance, and features.
*/
readonly sku: outputs.redisenterprise.SkuResponse;
/**
* Resource tags.
*/
readonly tags?: {
[key: string]: string;
};
/**
* The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
*/
readonly type: string;
/**
* The Availability Zones where this cluster will be deployed.
*/
readonly zones?: string[];
}
/**
* Gets information about 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, 2025-07-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 getRedisEnterpriseOutput(args: GetRedisEnterpriseOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetRedisEnterpriseResult>;
export interface GetRedisEnterpriseOutputArgs {
/**
* 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 resource group. The name is case insensitive.
*/
resourceGroupName: pulumi.Input<string>;
}