azure-native.containerservice.getPrivateEndpointConnection
Explore with Pulumi AI
To learn more about private clusters, see: https://docs.microsoft.com/azure/aks/private-clusters Azure REST API version: 2023-04-01.
Other available API versions: 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.
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)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: azure-native:containerservice:getPrivateEndpointConnection
  arguments:
    # arguments dictionaryThe following arguments are supported:
- Private
Endpoint stringConnection Name  - The name of the private endpoint connection.
 - Resource
Group stringName  - The name of the resource group. The name is case insensitive.
 - Resource
Name string - The name of the managed cluster resource.
 
- Private
Endpoint stringConnection Name  - The name of the private endpoint connection.
 - Resource
Group stringName  - The name of the resource group. The name is case insensitive.
 - Resource
Name string - The name of the managed cluster resource.
 
- private
Endpoint StringConnection Name  - The name of the private endpoint connection.
 - resource
Group StringName  - The name of the resource group. The name is case insensitive.
 - resource
Name String - The name of the managed cluster resource.
 
- private
Endpoint stringConnection Name  - The name of the private endpoint connection.
 - resource
Group stringName  - The name of the resource group. The name is case insensitive.
 - resource
Name string - The name of the managed cluster resource.
 
- private_
endpoint_ strconnection_ name  - The name of the private endpoint connection.
 - resource_
group_ strname  - The name of the resource group. The name is case insensitive.
 - resource_
name str - The name of the managed cluster resource.
 
- private
Endpoint StringConnection Name  - The name of the private endpoint connection.
 - resource
Group StringName  - The name of the resource group. The name is case insensitive.
 - resource
Name String - The name of the managed cluster resource.
 
getPrivateEndpointConnection Result
The following output properties are available:
- Id string
 - The ID of the private endpoint connection.
 - Name string
 - The name of the private endpoint connection.
 - Private
Link Pulumi.Service Connection State Azure Native. Container Service. Outputs. Private Link Service Connection State Response  - A collection of information about the state of the connection between service consumer and provider.
 - Provisioning
State string - The current provisioning state.
 - Type string
 - The resource type.
 - Private
Endpoint Pulumi.Azure Native. Container Service. Outputs. Private Endpoint Response  - The resource of private endpoint.
 
- Id string
 - The ID of the private endpoint connection.
 - Name string
 - The name of the private endpoint connection.
 - Private
Link PrivateService Connection State Link Service Connection State Response  - A collection of information about the state of the connection between service consumer and provider.
 - Provisioning
State string - The current provisioning state.
 - Type string
 - The resource type.
 - Private
Endpoint PrivateEndpoint Response  - The resource of private endpoint.
 
- id String
 - The ID of the private endpoint connection.
 - name String
 - The name of the private endpoint connection.
 - private
Link PrivateService Connection State Link Service Connection State Response  - A collection of information about the state of the connection between service consumer and provider.
 - provisioning
State String - The current provisioning state.
 - type String
 - The resource type.
 - private
Endpoint PrivateEndpoint Response  - The resource of private endpoint.
 
- id string
 - The ID of the private endpoint connection.
 - name string
 - The name of the private endpoint connection.
 - private
Link PrivateService Connection State Link Service Connection State Response  - A collection of information about the state of the connection between service consumer and provider.
 - provisioning
State string - The current provisioning state.
 - type string
 - The resource type.
 - private
Endpoint PrivateEndpoint Response  - The resource of private endpoint.
 
- id str
 - The ID of the private endpoint connection.
 - name str
 - The name of the private endpoint connection.
 - private_
link_ Privateservice_ connection_ state Link Service Connection State Response  - 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 PrivateEndpoint Response  - The resource of private endpoint.
 
- id String
 - The ID of the private endpoint connection.
 - name String
 - The name of the private endpoint connection.
 - private
Link Property MapService Connection State  - A collection of information about the state of the connection between service consumer and provider.
 - provisioning
State String - The current provisioning state.
 - type String
 - The resource type.
 - private
Endpoint 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