Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. eventhub
  5. getPrivateEndpointConnection
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.eventhub.getPrivateEndpointConnection

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

Gets a description for the specified Private Endpoint Connection name.

Uses Azure REST API version 2024-01-01.

Other available API versions: 2018-01-01-preview, 2021-01-01-preview, 2021-06-01-preview, 2021-11-01, 2022-01-01-preview, 2022-10-01-preview, 2023-01-01-preview, 2024-05-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native eventhub [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>
Copy
def get_private_endpoint_connection(namespace_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(namespace_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:eventhub:getPrivateEndpointConnection
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

NamespaceName
This property is required.
Changes to this property will trigger replacement.
string
The Namespace name
PrivateEndpointConnectionName
This property is required.
Changes to this property will trigger replacement.
string
The PrivateEndpointConnection name
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the resource group within the azure subscription.
NamespaceName
This property is required.
Changes to this property will trigger replacement.
string
The Namespace name
PrivateEndpointConnectionName
This property is required.
Changes to this property will trigger replacement.
string
The PrivateEndpointConnection name
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the resource group within the azure subscription.
namespaceName
This property is required.
Changes to this property will trigger replacement.
String
The Namespace name
privateEndpointConnectionName
This property is required.
Changes to this property will trigger replacement.
String
The PrivateEndpointConnection name
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of the resource group within the azure subscription.
namespaceName
This property is required.
Changes to this property will trigger replacement.
string
The Namespace name
privateEndpointConnectionName
This property is required.
Changes to this property will trigger replacement.
string
The PrivateEndpointConnection name
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the resource group within the azure subscription.
namespace_name
This property is required.
Changes to this property will trigger replacement.
str
The Namespace name
private_endpoint_connection_name
This property is required.
Changes to this property will trigger replacement.
str
The PrivateEndpointConnection name
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the resource group within the azure subscription.
namespaceName
This property is required.
Changes to this property will trigger replacement.
String
The Namespace name
privateEndpointConnectionName
This property is required.
Changes to this property will trigger replacement.
String
The PrivateEndpointConnection name
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of the resource group within the azure subscription.

getPrivateEndpointConnection Result

The following output properties are available:

AzureApiVersion string
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}
Location string
The geo-location where the resource lives
Name string
The name of the resource
SystemData Pulumi.AzureNative.EventHub.Outputs.SystemDataResponse
The system meta data relating to this resource.
Type string
The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"
PrivateEndpoint Pulumi.AzureNative.EventHub.Outputs.PrivateEndpointResponse
The Private Endpoint resource for this Connection.
PrivateLinkServiceConnectionState Pulumi.AzureNative.EventHub.Outputs.ConnectionStateResponse
Details about the state of the connection.
ProvisioningState string
Provisioning state of the Private Endpoint Connection.
AzureApiVersion string
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}
Location string
The geo-location where the resource lives
Name string
The name of the resource
SystemData SystemDataResponse
The system meta data relating to this resource.
Type string
The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"
PrivateEndpoint PrivateEndpointResponse
The Private Endpoint resource for this Connection.
PrivateLinkServiceConnectionState ConnectionStateResponse
Details about the state of the connection.
ProvisioningState string
Provisioning state of the Private Endpoint Connection.
azureApiVersion String
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}
location String
The geo-location where the resource lives
name String
The name of the resource
systemData SystemDataResponse
The system meta data relating to this resource.
type String
The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"
privateEndpoint PrivateEndpointResponse
The Private Endpoint resource for this Connection.
privateLinkServiceConnectionState ConnectionStateResponse
Details about the state of the connection.
provisioningState String
Provisioning state of the Private Endpoint Connection.
azureApiVersion string
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}
location string
The geo-location where the resource lives
name string
The name of the resource
systemData SystemDataResponse
The system meta data relating to this resource.
type string
The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"
privateEndpoint PrivateEndpointResponse
The Private Endpoint resource for this Connection.
privateLinkServiceConnectionState ConnectionStateResponse
Details about the state of the connection.
provisioningState string
Provisioning state of the Private Endpoint Connection.
azure_api_version str
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}
location str
The geo-location where the resource lives
name str
The name of the resource
system_data SystemDataResponse
The system meta data relating to this resource.
type str
The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"
private_endpoint PrivateEndpointResponse
The Private Endpoint resource for this Connection.
private_link_service_connection_state ConnectionStateResponse
Details about the state of the connection.
provisioning_state str
Provisioning state of the Private Endpoint Connection.
azureApiVersion String
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}
location String
The geo-location where the resource lives
name String
The name of the resource
systemData Property Map
The system meta data relating to this resource.
type String
The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"
privateEndpoint Property Map
The Private Endpoint resource for this Connection.
privateLinkServiceConnectionState Property Map
Details about the state of the connection.
provisioningState String
Provisioning state of the Private Endpoint Connection.

Supporting Types

ConnectionStateResponse

Description string
Description of the connection state.
Status string
Status of the connection.
Description string
Description of the connection state.
Status string
Status of the connection.
description String
Description of the connection state.
status String
Status of the connection.
description string
Description of the connection state.
status string
Status of the connection.
description str
Description of the connection state.
status str
Status of the connection.
description String
Description of the connection state.
status String
Status of the connection.

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.

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 type of identity that last modified the resource.
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 type of identity that last modified the resource.
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 type of identity that last modified the resource.
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 type of identity that last modified the resource.
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 type of identity that last modified the resource.
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 type of identity that last modified the resource.
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 pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native