Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. hdinsight
  5. getPrivateEndpointConnection
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.hdinsight.getPrivateEndpointConnection

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Gets the specific private endpoint connection. Azure REST API version: 2021-06-01.

Other available API versions: 2023-04-15-preview, 2023-08-15-preview, 2024-08-01-preview.

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>
Copy
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]
Copy
func LookupPrivateEndpointConnection(ctx *Context, args *LookupPrivateEndpointConnectionArgs, opts ...InvokeOption) (*LookupPrivateEndpointConnectionResult, error)
func LookupPrivateEndpointConnectionOutput(ctx *Context, args *LookupPrivateEndpointConnectionOutputArgs, opts ...InvokeOption) LookupPrivateEndpointConnectionResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetPrivateEndpointConnectionResult> getPrivateEndpointConnection(GetPrivateEndpointConnectionArgs args, InvokeOptions options)
public static Output<GetPrivateEndpointConnectionResult> getPrivateEndpointConnection(GetPrivateEndpointConnectionArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:hdinsight:getPrivateEndpointConnection
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ClusterName
This property is required.
Changes to this property will trigger replacement.
string
The name of the cluster.
PrivateEndpointConnectionName
This property is required.
Changes to this property will trigger replacement.
string
The name of the private endpoint connection.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
ClusterName
This property is required.
Changes to this property will trigger replacement.
string
The name of the cluster.
PrivateEndpointConnectionName
This property is required.
Changes to this property will trigger replacement.
string
The name of the private endpoint connection.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
clusterName
This property is required.
Changes to this property will trigger replacement.
String
The name of the cluster.
privateEndpointConnectionName
This property is required.
Changes to this property will trigger replacement.
String
The name of the private endpoint connection.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
clusterName
This property is required.
Changes to this property will trigger replacement.
string
The name of the cluster.
privateEndpointConnectionName
This property is required.
Changes to this property will trigger replacement.
string
The name of the private endpoint connection.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
cluster_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the cluster.
private_endpoint_connection_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the private endpoint connection.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group.
clusterName
This property is required.
Changes to this property will trigger replacement.
String
The name of the cluster.
privateEndpointConnectionName
This property is required.
Changes to this property will trigger replacement.
String
The name of the private endpoint connection.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.

getPrivateEndpointConnection Result

The following output properties are available:

Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
LinkIdentifier string
The link identifier.
Name string
The name of the resource
PrivateEndpoint Pulumi.AzureNative.HDInsight.Outputs.PrivateEndpointResponse
The private endpoint of the private endpoint connection
PrivateLinkServiceConnectionState Pulumi.AzureNative.HDInsight.Outputs.PrivateLinkServiceConnectionStateResponse
The private link service connection state.
ProvisioningState string
The provisioning state, which only appears in the response.
SystemData Pulumi.AzureNative.HDInsight.Outputs.SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
LinkIdentifier string
The link identifier.
Name string
The name of the resource
PrivateEndpoint PrivateEndpointResponse
The private endpoint of the private endpoint connection
PrivateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse
The private link service connection state.
ProvisioningState string
The provisioning state, which only appears in the response.
SystemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
linkIdentifier String
The link identifier.
name String
The name of the resource
privateEndpoint PrivateEndpointResponse
The private endpoint of the private endpoint connection
privateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse
The private link service connection state.
provisioningState String
The provisioning state, which only appears in the response.
systemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
linkIdentifier string
The link identifier.
name string
The name of the resource
privateEndpoint PrivateEndpointResponse
The private endpoint of the private endpoint connection
privateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse
The private link service connection state.
provisioningState string
The provisioning state, which only appears in the response.
systemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
id str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
link_identifier str
The link identifier.
name str
The name of the resource
private_endpoint PrivateEndpointResponse
The private endpoint of the private endpoint connection
private_link_service_connection_state PrivateLinkServiceConnectionStateResponse
The private link service connection state.
provisioning_state str
The provisioning state, which only appears in the response.
system_data SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
linkIdentifier String
The link identifier.
name String
The name of the resource
privateEndpoint Property Map
The private endpoint of the private endpoint connection
privateLinkServiceConnectionState Property Map
The private link service connection state.
provisioningState String
The provisioning state, which only appears in the response.
systemData Property Map
Metadata pertaining to creation and last modification of the resource.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Supporting Types

PrivateEndpointResponse

Id string
The private endpoint id.
Id string
The private endpoint id.
id String
The private endpoint id.
id string
The private endpoint id.
id str
The private endpoint id.
id String
The private endpoint id.

PrivateLinkServiceConnectionStateResponse

Status This property is required. string
The concrete private link service connection.
ActionsRequired string
Whether there is further actions.
Description string
The optional description of the status.
Status This property is required. string
The concrete private link service connection.
ActionsRequired string
Whether there is further actions.
Description string
The optional description of the status.
status This property is required. String
The concrete private link service connection.
actionsRequired String
Whether there is further actions.
description String
The optional description of the status.
status This property is required. string
The concrete private link service connection.
actionsRequired string
Whether there is further actions.
description string
The optional description of the status.
status This property is required. str
The concrete private link service connection.
actions_required str
Whether there is further actions.
description str
The optional description of the status.
status This property is required. String
The concrete private link service connection.
actionsRequired String
Whether there is further actions.
description String
The optional description of the status.

SystemDataResponse

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource last modification (UTC)
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource last modification (UTC)
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native