azure-native.redisenterprise.getPrivateEndpointConnection
Explore with Pulumi AI
Gets the specified private endpoint connection associated with the RedisEnterprise cluster.
Uses Azure REST API version 2024-03-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-06-01-preview, 2024-09-01-preview, 2024-10-01, 2025-04-01, 2025-05-01-preview. 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 for details.
Using getPrivateEndpointConnection
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 getPrivateEndpointConnection(args: GetPrivateEndpointConnectionArgs, opts?: InvokeOptions): Promise<GetPrivateEndpointConnectionResult>
function getPrivateEndpointConnectionOutput(args: GetPrivateEndpointConnectionOutputArgs, opts?: InvokeOptions): Output<GetPrivateEndpointConnectionResult>def get_private_endpoint_connection(cluster_name: Optional[str] = None,
                                    private_endpoint_connection_name: Optional[str] = None,
                                    resource_group_name: Optional[str] = None,
                                    opts: Optional[InvokeOptions] = None) -> GetPrivateEndpointConnectionResult
def get_private_endpoint_connection_output(cluster_name: Optional[pulumi.Input[str]] = None,
                                    private_endpoint_connection_name: Optional[pulumi.Input[str]] = None,
                                    resource_group_name: Optional[pulumi.Input[str]] = None,
                                    opts: Optional[InvokeOptions] = None) -> Output[GetPrivateEndpointConnectionResult]func LookupPrivateEndpointConnection(ctx *Context, args *LookupPrivateEndpointConnectionArgs, opts ...InvokeOption) (*LookupPrivateEndpointConnectionResult, error)
func LookupPrivateEndpointConnectionOutput(ctx *Context, args *LookupPrivateEndpointConnectionOutputArgs, opts ...InvokeOption) LookupPrivateEndpointConnectionResultOutput> Note: This function is named LookupPrivateEndpointConnection in the Go SDK.
public static class GetPrivateEndpointConnection 
{
    public static Task<GetPrivateEndpointConnectionResult> InvokeAsync(GetPrivateEndpointConnectionArgs args, InvokeOptions? opts = null)
    public static Output<GetPrivateEndpointConnectionResult> Invoke(GetPrivateEndpointConnectionInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetPrivateEndpointConnectionResult> getPrivateEndpointConnection(GetPrivateEndpointConnectionArgs args, InvokeOptions options)
public static Output<GetPrivateEndpointConnectionResult> getPrivateEndpointConnection(GetPrivateEndpointConnectionArgs args, InvokeOptions options)
fn::invoke:
  function: azure-native:redisenterprise:getPrivateEndpointConnection
  arguments:
    # arguments dictionaryThe following arguments are supported:
- Cluster
Name string - The name of the Redis Enterprise cluster.
 - Private
Endpoint stringConnection Name  - The name of the private endpoint connection associated with the Azure resource
 - Resource
Group stringName  - The name of the resource group. The name is case insensitive.
 
- Cluster
Name string - The name of the Redis Enterprise cluster.
 - Private
Endpoint stringConnection Name  - The name of the private endpoint connection associated with the Azure resource
 - Resource
Group stringName  - The name of the resource group. The name is case insensitive.
 
- cluster
Name String - The name of the Redis Enterprise cluster.
 - private
Endpoint StringConnection Name  - The name of the private endpoint connection associated with the Azure resource
 - resource
Group StringName  - The name of the resource group. The name is case insensitive.
 
- cluster
Name string - The name of the Redis Enterprise cluster.
 - private
Endpoint stringConnection Name  - The name of the private endpoint connection associated with the Azure resource
 - resource
Group stringName  - The name of the resource group. The name is case insensitive.
 
- cluster_
name str - The name of the Redis Enterprise cluster.
 - private_
endpoint_ strconnection_ name  - The name of the private endpoint connection associated with the Azure resource
 - resource_
group_ strname  - The name of the resource group. The name is case insensitive.
 
- cluster
Name String - The name of the Redis Enterprise cluster.
 - private
Endpoint StringConnection Name  - The name of the private endpoint connection associated with the Azure resource
 - resource
Group StringName  - The name of the resource group. The name is case insensitive.
 
getPrivateEndpointConnection Result
The following output properties are available:
- Azure
Api stringVersion  - The Azure API version of the resource.
 - 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
 - Private
Link Pulumi.Service Connection State Azure Native. Redis Enterprise. Outputs. Private Link Service Connection State Response  - A collection of information about the state of the connection between service consumer and provider.
 - Provisioning
State 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"
 - Private
Endpoint Pulumi.Azure Native. Redis Enterprise. Outputs. Private Endpoint Response  - The resource of private end point.
 
- Azure
Api stringVersion  - The Azure API version of the resource.
 - 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
 - Private
Link PrivateService Connection State Link Service Connection State Response  - A collection of information about the state of the connection between service consumer and provider.
 - Provisioning
State 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"
 - Private
Endpoint PrivateEndpoint Response  - The resource of private end point.
 
- azure
Api StringVersion  - The Azure API version of the resource.
 - 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
 - private
Link PrivateService Connection State Link Service Connection State Response  - A collection of information about the state of the connection between service consumer and provider.
 - provisioning
State 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"
 - private
Endpoint PrivateEndpoint Response  - The resource of private end point.
 
- azure
Api stringVersion  - The Azure API version of the resource.
 - 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
 - private
Link PrivateService Connection State Link Service Connection State Response  - A collection of information about the state of the connection between service consumer and provider.
 - provisioning
State 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"
 - private
Endpoint PrivateEndpoint Response  - The resource of private end point.
 
- azure_
api_ strversion  - The Azure API version of the resource.
 - 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_ Privateservice_ connection_ state Link Service Connection State Response  - 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 PrivateEndpoint Response  - The resource of private end point.
 
- azure
Api StringVersion  - The Azure API version of the resource.
 - 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
 - private
Link Property MapService Connection State  - A collection of information about the state of the connection between service consumer and provider.
 - provisioning
State 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"
 - private
Endpoint Property Map - The resource of private end point.
 
Supporting Types
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     
- Actions
Required 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 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 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 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.
 
- actions
Required 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
 - Azure Native pulumi/pulumi-azure-native
 - License
 - Apache-2.0