Azure Native

v1.53.0 published on Monday, Jan 10, 2022 by Pulumi

getPrivateEndpointConnection

A private endpoint connection API Version: 2019-10-17-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,
                                    scope_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,
                                    scope_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)
}

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.
ScopeName string
The name of the Azure Monitor PrivateLinkScope resource.
PrivateEndpointConnectionName string
The name of the private endpoint connection.
ResourceGroupName string
The name of the resource group. The name is case insensitive.
ScopeName string
The name of the Azure Monitor PrivateLinkScope resource.
privateEndpointConnectionName string
The name of the private endpoint connection.
resourceGroupName string
The name of the resource group. The name is case insensitive.
scopeName string
The name of the Azure Monitor PrivateLinkScope 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.
scope_name str
The name of the Azure Monitor PrivateLinkScope resource.

getPrivateEndpointConnection Result

The following output properties are available:

Id string
Azure resource Id
Name string
Azure resource name
ProvisioningState string
State of the private endpoint connection.
Type string
Azure resource type
PrivateEndpoint Pulumi.AzureNative.Insights.Outputs.PrivateEndpointPropertyResponse
Private endpoint which the connection belongs to.
PrivateLinkServiceConnectionState Pulumi.AzureNative.Insights.Outputs.PrivateLinkServiceConnectionStatePropertyResponse
Connection state of the private endpoint connection.
Id string
Azure resource Id
Name string
Azure resource name
ProvisioningState string
State of the private endpoint connection.
Type string
Azure resource type
PrivateEndpoint PrivateEndpointPropertyResponse
Private endpoint which the connection belongs to.
PrivateLinkServiceConnectionState PrivateLinkServiceConnectionStatePropertyResponse
Connection state of the private endpoint connection.
id string
Azure resource Id
name string
Azure resource name
provisioningState string
State of the private endpoint connection.
type string
Azure resource type
privateEndpoint PrivateEndpointPropertyResponse
Private endpoint which the connection belongs to.
privateLinkServiceConnectionState PrivateLinkServiceConnectionStatePropertyResponse
Connection state of the private endpoint connection.
id str
Azure resource Id
name str
Azure resource name
provisioning_state str
State of the private endpoint connection.
type str
Azure resource type
private_endpoint PrivateEndpointPropertyResponse
Private endpoint which the connection belongs to.
private_link_service_connection_state PrivateLinkServiceConnectionStatePropertyResponse
Connection state of the private endpoint connection.

Supporting Types

PrivateEndpointPropertyResponse

Id string
Resource id of the private endpoint.
Id string
Resource id of the private endpoint.
id string
Resource id of the private endpoint.
id str
Resource id of the private endpoint.

PrivateLinkServiceConnectionStatePropertyResponse

ActionsRequired string
The actions required for private link service connection.
Description string
The private link service connection description.
Status string
The private link service connection status.
ActionsRequired string
The actions required for private link service connection.
Description string
The private link service connection description.
Status string
The private link service connection status.
actionsRequired string
The actions required for private link service connection.
description string
The private link service connection description.
status string
The private link service connection status.
actions_required str
The actions required for private link service connection.
description str
The private link service connection description.
status str
The private link service connection status.

Package Details

Repository
https://github.com/pulumi/pulumi-azure-native
License
Apache-2.0