Azure Native

Pulumi Official
Package maintained by Pulumi
v1.64.1 published on Wednesday, May 18, 2022 by Pulumi

getRedisEnterprise

Describes the RedisEnterprise cluster API Version: 2021-03-01.

Using getRedisEnterprise

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 getRedisEnterprise(args: GetRedisEnterpriseArgs, opts?: InvokeOptions): Promise<GetRedisEnterpriseResult>
function getRedisEnterpriseOutput(args: GetRedisEnterpriseOutputArgs, opts?: InvokeOptions): Output<GetRedisEnterpriseResult>
def get_redis_enterprise(cluster_name: Optional[str] = None,
                         resource_group_name: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetRedisEnterpriseResult
def get_redis_enterprise_output(cluster_name: Optional[pulumi.Input[str]] = None,
                         resource_group_name: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetRedisEnterpriseResult]
func LookupRedisEnterprise(ctx *Context, args *LookupRedisEnterpriseArgs, opts ...InvokeOption) (*LookupRedisEnterpriseResult, error)
func LookupRedisEnterpriseOutput(ctx *Context, args *LookupRedisEnterpriseOutputArgs, opts ...InvokeOption) LookupRedisEnterpriseResultOutput

> Note: This function is named LookupRedisEnterprise in the Go SDK.

public static class GetRedisEnterprise 
{
    public static Task<GetRedisEnterpriseResult> InvokeAsync(GetRedisEnterpriseArgs args, InvokeOptions? opts = null)
    public static Output<GetRedisEnterpriseResult> Invoke(GetRedisEnterpriseInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetRedisEnterpriseResult> getRedisEnterprise(GetRedisEnterpriseArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: azure-native:cache:getRedisEnterprise
  Arguments:
    # Arguments dictionary

The following arguments are supported:

ClusterName string

The name of the RedisEnterprise cluster.

ResourceGroupName string

The name of the resource group. The name is case insensitive.

ClusterName string

The name of the RedisEnterprise cluster.

ResourceGroupName string

The name of the resource group. The name is case insensitive.

clusterName String

The name of the RedisEnterprise cluster.

resourceGroupName String

The name of the resource group. The name is case insensitive.

clusterName string

The name of the RedisEnterprise cluster.

resourceGroupName string

The name of the resource group. The name is case insensitive.

cluster_name str

The name of the RedisEnterprise cluster.

resource_group_name str

The name of the resource group. The name is case insensitive.

clusterName String

The name of the RedisEnterprise cluster.

resourceGroupName String

The name of the resource group. The name is case insensitive.

getRedisEnterprise Result

The following output properties are available:

HostName string

DNS name of the cluster endpoint

Id string

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

Location string

The geo-location where the resource lives

Name string

The name of the resource

PrivateEndpointConnections List<Pulumi.AzureNative.Cache.Outputs.PrivateEndpointConnectionResponse>

List of private endpoint connections associated with the specified RedisEnterprise cluster

ProvisioningState string

Current provisioning status of the cluster

RedisVersion string

Version of redis the cluster supports, e.g. '6'

ResourceState string

Current resource status of the cluster

Sku Pulumi.AzureNative.Cache.Outputs.EnterpriseSkuResponse

The SKU to create, which affects price, performance, and features.

Type string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

MinimumTlsVersion string

The minimum TLS version for the cluster to support, e.g. '1.2'

Tags Dictionary<string, string>

Resource tags.

Zones List<string>

The Availability Zones where this cluster will be deployed.

HostName string

DNS name of the cluster endpoint

Id string

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

Location string

The geo-location where the resource lives

Name string

The name of the resource

PrivateEndpointConnections []PrivateEndpointConnectionResponse

List of private endpoint connections associated with the specified RedisEnterprise cluster

ProvisioningState string

Current provisioning status of the cluster

RedisVersion string

Version of redis the cluster supports, e.g. '6'

ResourceState string

Current resource status of the cluster

Sku EnterpriseSkuResponse

The SKU to create, which affects price, performance, and features.

Type string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

MinimumTlsVersion string

The minimum TLS version for the cluster to support, e.g. '1.2'

Tags map[string]string

Resource tags.

Zones []string

The Availability Zones where this cluster will be deployed.

hostName String

DNS name of the cluster endpoint

id String

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

location String

The geo-location where the resource lives

name String

The name of the resource

privateEndpointConnections ListEndpointConnectionResponse>

List of private endpoint connections associated with the specified RedisEnterprise cluster

provisioningState String

Current provisioning status of the cluster

redisVersion String

Version of redis the cluster supports, e.g. '6'

resourceState String

Current resource status of the cluster

sku EnterpriseSkuResponse

The SKU to create, which affects price, performance, and features.

type String

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

minimumTlsVersion String

The minimum TLS version for the cluster to support, e.g. '1.2'

tags Map

Resource tags.

zones List

The Availability Zones where this cluster will be deployed.

hostName string

DNS name of the cluster endpoint

id string

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

location string

The geo-location where the resource lives

name string

The name of the resource

privateEndpointConnections PrivateEndpointConnectionResponse[]

List of private endpoint connections associated with the specified RedisEnterprise cluster

provisioningState string

Current provisioning status of the cluster

redisVersion string

Version of redis the cluster supports, e.g. '6'

resourceState string

Current resource status of the cluster

sku EnterpriseSkuResponse

The SKU to create, which affects price, performance, and features.

type string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

minimumTlsVersion string

The minimum TLS version for the cluster to support, e.g. '1.2'

tags {[key: string]: string}

Resource tags.

zones string[]

The Availability Zones where this cluster will be deployed.

host_name str

DNS name of the cluster endpoint

id str

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

location str

The geo-location where the resource lives

name str

The name of the resource

private_endpoint_connections Sequence[PrivateEndpointConnectionResponse]

List of private endpoint connections associated with the specified RedisEnterprise cluster

provisioning_state str

Current provisioning status of the cluster

redis_version str

Version of redis the cluster supports, e.g. '6'

resource_state str

Current resource status of the cluster

sku EnterpriseSkuResponse

The SKU to create, which affects price, performance, and features.

type str

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

minimum_tls_version str

The minimum TLS version for the cluster to support, e.g. '1.2'

tags Mapping[str, str]

Resource tags.

zones Sequence[str]

The Availability Zones where this cluster will be deployed.

hostName String

DNS name of the cluster endpoint

id String

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

location String

The geo-location where the resource lives

name String

The name of the resource

privateEndpointConnections List

List of private endpoint connections associated with the specified RedisEnterprise cluster

provisioningState String

Current provisioning status of the cluster

redisVersion String

Version of redis the cluster supports, e.g. '6'

resourceState String

Current resource status of the cluster

sku Property Map

The SKU to create, which affects price, performance, and features.

type String

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

minimumTlsVersion String

The minimum TLS version for the cluster to support, e.g. '1.2'

tags Map

Resource tags.

zones List

The Availability Zones where this cluster will be deployed.

Supporting Types

EnterpriseSkuResponse

Name string

The type of RedisEnterprise cluster to deploy. Possible values: (Enterprise_E10, EnterpriseFlash_F300 etc.)

Capacity int

The size of the RedisEnterprise cluster. Defaults to 2 or 3 depending on SKU. Valid values are (2, 4, 6, ...) for Enterprise SKUs and (3, 9, 15, ...) for Flash SKUs.

Name string

The type of RedisEnterprise cluster to deploy. Possible values: (Enterprise_E10, EnterpriseFlash_F300 etc.)

Capacity int

The size of the RedisEnterprise cluster. Defaults to 2 or 3 depending on SKU. Valid values are (2, 4, 6, ...) for Enterprise SKUs and (3, 9, 15, ...) for Flash SKUs.

name String

The type of RedisEnterprise cluster to deploy. Possible values: (Enterprise_E10, EnterpriseFlash_F300 etc.)

capacity Integer

The size of the RedisEnterprise cluster. Defaults to 2 or 3 depending on SKU. Valid values are (2, 4, 6, ...) for Enterprise SKUs and (3, 9, 15, ...) for Flash SKUs.

name string

The type of RedisEnterprise cluster to deploy. Possible values: (Enterprise_E10, EnterpriseFlash_F300 etc.)

capacity number

The size of the RedisEnterprise cluster. Defaults to 2 or 3 depending on SKU. Valid values are (2, 4, 6, ...) for Enterprise SKUs and (3, 9, 15, ...) for Flash SKUs.

name str

The type of RedisEnterprise cluster to deploy. Possible values: (Enterprise_E10, EnterpriseFlash_F300 etc.)

capacity int

The size of the RedisEnterprise cluster. Defaults to 2 or 3 depending on SKU. Valid values are (2, 4, 6, ...) for Enterprise SKUs and (3, 9, 15, ...) for Flash SKUs.

name String

The type of RedisEnterprise cluster to deploy. Possible values: (Enterprise_E10, EnterpriseFlash_F300 etc.)

capacity Number

The size of the RedisEnterprise cluster. Defaults to 2 or 3 depending on SKU. Valid values are (2, 4, 6, ...) for Enterprise SKUs and (3, 9, 15, ...) for Flash SKUs.

PrivateEndpointConnectionResponse

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

PrivateLinkServiceConnectionState Pulumi.AzureNative.Cache.Inputs.PrivateLinkServiceConnectionStateResponse

A collection of information about the state of the connection between service consumer and provider.

ProvisioningState string

The provisioning state of the private endpoint connection resource.

Type string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

PrivateEndpoint Pulumi.AzureNative.Cache.Inputs.PrivateEndpointResponse

The resource of private end point.

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

PrivateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse

A collection of information about the state of the connection between service consumer and provider.

ProvisioningState string

The provisioning state of the private endpoint connection resource.

Type string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

PrivateEndpoint PrivateEndpointResponse

The resource of private end point.

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

privateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse

A collection of information about the state of the connection between service consumer and provider.

provisioningState String

The provisioning state of the private endpoint connection resource.

type String

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

privateEndpoint PrivateEndpointResponse

The resource of private end point.

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

privateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse

A collection of information about the state of the connection between service consumer and provider.

provisioningState string

The provisioning state of the private endpoint connection resource.

type string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

privateEndpoint PrivateEndpointResponse

The resource of private end point.

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

private_link_service_connection_state PrivateLinkServiceConnectionStateResponse

A collection of information about the state of the connection between service consumer and provider.

provisioning_state str

The provisioning state of the private endpoint connection resource.

type str

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

private_endpoint PrivateEndpointResponse

The resource of private end point.

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

privateLinkServiceConnectionState Property Map

A collection of information about the state of the connection between service consumer and provider.

provisioningState String

The provisioning state of the private endpoint connection resource.

type String

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

privateEndpoint Property Map

The resource of private end point.

PrivateEndpointResponse

Id string

The ARM identifier for Private Endpoint

Id string

The ARM identifier for Private Endpoint

id String

The ARM identifier for Private Endpoint

id string

The ARM identifier for Private Endpoint

id str

The ARM identifier for Private Endpoint

id String

The ARM identifier for Private Endpoint

PrivateLinkServiceConnectionStateResponse

ActionsRequired string

A message indicating if changes on the service provider require any updates on the consumer.

Description string

The reason for approval/rejection of the connection.

Status string

Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.

ActionsRequired string

A message indicating if changes on the service provider require any updates on the consumer.

Description string

The reason for approval/rejection of the connection.

Status string

Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.

actionsRequired String

A message indicating if changes on the service provider require any updates on the consumer.

description String

The reason for approval/rejection of the connection.

status String

Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.

actionsRequired string

A message indicating if changes on the service provider require any updates on the consumer.

description string

The reason for approval/rejection of the connection.

status string

Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.

actions_required str

A message indicating if changes on the service provider require any updates on the consumer.

description str

The reason for approval/rejection of the connection.

status str

Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.

actionsRequired String

A message indicating if changes on the service provider require any updates on the consumer.

description String

The reason for approval/rejection of the connection.

status String

Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.

Package Details

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