1. Packages
  2. Azure Native v1
  3. API Docs
  4. eventhub
  5. getPrivateEndpointConnection
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi

azure-native.eventhub.getPrivateEndpointConnection

Explore with Pulumi AI

These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi

Gets a description for the specified Private Endpoint Connection name. API Version: 2018-01-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(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:

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
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
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.
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
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
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.
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
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
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.
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
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
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.
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
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
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.
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
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
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.

Package Details

Repository
azure-native-v1 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi