Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. containerservice
  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.3.0 published on Monday, Apr 28, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.containerservice.getPrivateEndpointConnection

Explore with Pulumi AI

azure-native logo
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.3.0 published on Monday, Apr 28, 2025 by Pulumi
pulumi/pulumi-azure-native

    To learn more about private clusters, see: https://docs.microsoft.com/azure/aks/private-clusters

    Uses Azure REST API version 2024-10-01.

    Other available API versions: 2020-06-01, 2020-07-01, 2020-09-01, 2020-11-01, 2020-12-01, 2021-02-01, 2021-03-01, 2021-05-01, 2021-07-01, 2021-08-01, 2021-09-01, 2021-10-01, 2021-11-01-preview, 2022-01-01, 2022-01-02-preview, 2022-02-01, 2022-02-02-preview, 2022-03-01, 2022-03-02-preview, 2022-04-01, 2022-04-02-preview, 2022-05-02-preview, 2022-06-01, 2022-06-02-preview, 2022-07-01, 2022-07-02-preview, 2022-08-02-preview, 2022-08-03-preview, 2022-09-01, 2022-09-02-preview, 2022-10-02-preview, 2022-11-01, 2022-11-02-preview, 2023-01-01, 2023-01-02-preview, 2023-02-01, 2023-02-02-preview, 2023-03-01, 2023-03-02-preview, 2023-04-01, 2023-04-02-preview, 2023-05-01, 2023-05-02-preview, 2023-06-01, 2023-06-02-preview, 2023-07-01, 2023-07-02-preview, 2023-08-01, 2023-08-02-preview, 2023-09-01, 2023-09-02-preview, 2023-10-01, 2023-10-02-preview, 2023-11-01, 2023-11-02-preview, 2024-01-01, 2024-01-02-preview, 2024-02-01, 2024-02-02-preview, 2024-03-02-preview, 2024-04-02-preview, 2024-05-01, 2024-05-02-preview, 2024-06-02-preview, 2024-07-01, 2024-07-02-preview, 2024-08-01, 2024-09-01, 2024-09-02-preview, 2024-10-02-preview, 2025-01-01, 2025-01-02-preview, 2025-02-01, 2025-02-02-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native containerservice [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(private_endpoint_connection_name: Optional[str] = None,
                                    resource_group_name: Optional[str] = None,
                                    resource_name: Optional[str] = None,
                                    opts: Optional[InvokeOptions] = None) -> GetPrivateEndpointConnectionResult
def get_private_endpoint_connection_output(private_endpoint_connection_name: Optional[pulumi.Input[str]] = None,
                                    resource_group_name: Optional[pulumi.Input[str]] = None,
                                    resource_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:containerservice:getPrivateEndpointConnection
  arguments:
    # arguments dictionary

    The following arguments are supported:

    PrivateEndpointConnectionName string
    The name of the private endpoint connection.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ResourceName string
    The name of the managed cluster resource.
    PrivateEndpointConnectionName string
    The name of the private endpoint connection.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ResourceName string
    The name of the managed cluster resource.
    privateEndpointConnectionName String
    The name of the private endpoint connection.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    resourceName String
    The name of the managed cluster resource.
    privateEndpointConnectionName string
    The name of the private endpoint connection.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    resourceName string
    The name of the managed cluster resource.
    private_endpoint_connection_name str
    The name of the private endpoint connection.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    resource_name str
    The name of the managed cluster resource.
    privateEndpointConnectionName String
    The name of the private endpoint connection.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    resourceName String
    The name of the managed cluster resource.

    getPrivateEndpointConnection Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    The ID of the private endpoint connection.
    Name string
    The name of the private endpoint connection.
    PrivateLinkServiceConnectionState Pulumi.AzureNative.ContainerService.Outputs.PrivateLinkServiceConnectionStateResponse
    A collection of information about the state of the connection between service consumer and provider.
    ProvisioningState string
    The current provisioning state.
    Type string
    The resource type.
    PrivateEndpoint Pulumi.AzureNative.ContainerService.Outputs.PrivateEndpointResponse
    The resource of private endpoint.
    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    The ID of the private endpoint connection.
    Name string
    The name of the private endpoint connection.
    PrivateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse
    A collection of information about the state of the connection between service consumer and provider.
    ProvisioningState string
    The current provisioning state.
    Type string
    The resource type.
    PrivateEndpoint PrivateEndpointResponse
    The resource of private endpoint.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    The ID of the private endpoint connection.
    name String
    The name of the private endpoint connection.
    privateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse
    A collection of information about the state of the connection between service consumer and provider.
    provisioningState String
    The current provisioning state.
    type String
    The resource type.
    privateEndpoint PrivateEndpointResponse
    The resource of private endpoint.
    azureApiVersion string
    The Azure API version of the resource.
    id string
    The ID of the private endpoint connection.
    name string
    The name of the private endpoint connection.
    privateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse
    A collection of information about the state of the connection between service consumer and provider.
    provisioningState string
    The current provisioning state.
    type string
    The resource type.
    privateEndpoint PrivateEndpointResponse
    The resource of private endpoint.
    azure_api_version str
    The Azure API version of the resource.
    id str
    The ID of the private endpoint connection.
    name str
    The name of the private endpoint connection.
    private_link_service_connection_state PrivateLinkServiceConnectionStateResponse
    A collection of information about the state of the connection between service consumer and provider.
    provisioning_state str
    The current provisioning state.
    type str
    The resource type.
    private_endpoint PrivateEndpointResponse
    The resource of private endpoint.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    The ID of the private endpoint connection.
    name String
    The name of the private endpoint connection.
    privateLinkServiceConnectionState Property Map
    A collection of information about the state of the connection between service consumer and provider.
    provisioningState String
    The current provisioning state.
    type String
    The resource type.
    privateEndpoint Property Map
    The resource of private endpoint.

    Supporting Types

    PrivateEndpointResponse

    Id string
    The resource ID of the private endpoint
    Id string
    The resource ID of the private endpoint
    id String
    The resource ID of the private endpoint
    id string
    The resource ID of the private endpoint
    id str
    The resource ID of the private endpoint
    id String
    The resource ID of the private endpoint

    PrivateLinkServiceConnectionStateResponse

    Description string
    The private link service connection description.
    Status string
    The private link service connection status.
    Description string
    The private link service connection description.
    Status string
    The private link service connection status.
    description String
    The private link service connection description.
    status String
    The private link service connection status.
    description string
    The private link service connection description.
    status string
    The private link service connection status.
    description str
    The private link service connection description.
    status str
    The private link service connection status.
    description String
    The private link service connection description.
    status String
    The private link service connection status.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    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.3.0 published on Monday, Apr 28, 2025 by Pulumi
    pulumi/pulumi-azure-native