This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
azure-native.hdinsight.getPrivateEndpointConnection
Explore with Pulumi AI
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
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>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:hdinsight:getPrivateEndpointConnection
  arguments:
    # arguments dictionaryThe following arguments are supported:
- ClusterName string
- The name of the cluster.
- PrivateEndpoint stringConnection Name 
- The name of the private endpoint connection.
- ResourceGroup stringName 
- The name of the resource group.
- ClusterName string
- The name of the cluster.
- PrivateEndpoint stringConnection Name 
- The name of the private endpoint connection.
- ResourceGroup stringName 
- The name of the resource group.
- clusterName String
- The name of the cluster.
- privateEndpoint StringConnection Name 
- The name of the private endpoint connection.
- resourceGroup StringName 
- The name of the resource group.
- clusterName string
- The name of the cluster.
- privateEndpoint stringConnection Name 
- The name of the private endpoint connection.
- resourceGroup stringName 
- The name of the resource group.
- cluster_name str
- The name of the cluster.
- private_endpoint_ strconnection_ name 
- The name of the private endpoint connection.
- resource_group_ strname 
- The name of the resource group.
- clusterName String
- The name of the cluster.
- privateEndpoint StringConnection Name 
- The name of the private endpoint connection.
- resourceGroup StringName 
- 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.Azure Native. HDInsight. Outputs. Private Endpoint Response 
- The private endpoint of the private endpoint connection
- PrivateLink Pulumi.Service Connection State Azure Native. HDInsight. Outputs. Private Link Service Connection State Response 
- The private link service connection state.
- ProvisioningState string
- The provisioning state, which only appears in the response.
- SystemData Pulumi.Azure Native. HDInsight. Outputs. System Data Response 
- 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 PrivateEndpoint Response 
- The private endpoint of the private endpoint connection
- PrivateLink PrivateService Connection State Link Service Connection State Response 
- The private link service connection state.
- ProvisioningState string
- The provisioning state, which only appears in the response.
- SystemData SystemData Response 
- 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 PrivateEndpoint Response 
- The private endpoint of the private endpoint connection
- privateLink PrivateService Connection State Link Service Connection State Response 
- The private link service connection state.
- provisioningState String
- The provisioning state, which only appears in the response.
- systemData SystemData Response 
- 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 PrivateEndpoint Response 
- The private endpoint of the private endpoint connection
- privateLink PrivateService Connection State Link Service Connection State Response 
- The private link service connection state.
- provisioningState string
- The provisioning state, which only appears in the response.
- systemData SystemData Response 
- 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 PrivateEndpoint Response 
- The private endpoint of the private endpoint connection
- private_link_ Privateservice_ connection_ state Link Service Connection State Response 
- The private link service connection state.
- provisioning_state str
- The provisioning state, which only appears in the response.
- system_data SystemData Response 
- 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
- privateLink Property MapService Connection State 
- 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 string
- The concrete private link service connection.
- ActionsRequired string
- Whether there is further actions.
- Description string
- The optional description of the status.
- Status string
- The concrete private link service connection.
- ActionsRequired string
- Whether there is further actions.
- Description string
- The optional description of the status.
- status String
- The concrete private link service connection.
- actionsRequired String
- Whether there is further actions.
- description String
- The optional description of the status.
- status string
- The concrete private link service connection.
- actionsRequired string
- Whether there is further actions.
- description string
- The optional description of the status.
- status str
- The concrete private link service connection.
- actions_required str
- Whether there is further actions.
- description str
- The optional description of the status.
- status 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.
- CreatedBy stringType 
- The type of identity that created the resource.
- LastModified stringAt 
- The timestamp of resource last modification (UTC)
- LastModified stringBy 
- The identity that last modified the resource.
- LastModified stringBy Type 
- 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.
- CreatedBy stringType 
- The type of identity that created the resource.
- LastModified stringAt 
- The timestamp of resource last modification (UTC)
- LastModified stringBy 
- The identity that last modified the resource.
- LastModified stringBy Type 
- 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.
- createdBy StringType 
- The type of identity that created the resource.
- lastModified StringAt 
- The timestamp of resource last modification (UTC)
- lastModified StringBy 
- The identity that last modified the resource.
- lastModified StringBy Type 
- 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.
- createdBy stringType 
- The type of identity that created the resource.
- lastModified stringAt 
- The timestamp of resource last modification (UTC)
- lastModified stringBy 
- The identity that last modified the resource.
- lastModified stringBy Type 
- 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_ strtype 
- The type of identity that created the resource.
- last_modified_ strat 
- The timestamp of resource last modification (UTC)
- last_modified_ strby 
- The identity that last modified the resource.
- last_modified_ strby_ type 
- 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.
- createdBy StringType 
- The type of identity that created the resource.
- lastModified StringAt 
- The timestamp of resource last modification (UTC)
- lastModified StringBy 
- The identity that last modified the resource.
- lastModified StringBy Type 
- The type of identity that last modified the resource.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi