← All packages

Azure Native

Pulumi Official

Package maintained by Pulumi

v1.67.0 published on Tuesday, Jul 12, 2022 by Pulumi

Source code

getPrivateEndpointConnection

Private endpoint connection resource. 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>

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]

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:relay:getPrivateEndpointConnection
  Arguments:
    # Arguments dictionary

The following arguments are supported:

NamespaceName string: The namespace name
PrivateEndpointConnectionName string: The PrivateEndpointConnection name.
ResourceGroupName string: Name of the Resource group within the Azure subscription.

NamespaceName string: The namespace name
PrivateEndpointConnectionName string: The PrivateEndpointConnection name.
ResourceGroupName string: Name of the Resource group within the Azure subscription.

namespaceName String: The namespace name
privateEndpointConnectionName String: The PrivateEndpointConnection name.
resourceGroupName String: Name of the Resource group within the Azure subscription.

namespaceName string: The namespace name
privateEndpointConnectionName string: The PrivateEndpointConnection name.
resourceGroupName string: Name of the Resource group within the Azure subscription.

namespace_name str: The namespace name
private_endpoint_connection_name str: The PrivateEndpointConnection name.
resource_group_name str: Name of the Resource group within the Azure subscription.

namespaceName String: The namespace name
privateEndpointConnectionName String: The PrivateEndpointConnection name.
resourceGroupName String: Name of the Resource group within the Azure subscription.

getPrivateEndpointConnection Result

The following output properties are available:

Id string: Resource ID.
Location string: Resource location.
Name string: Resource name.
ProvisioningState string: Provisioning state of the private endpoint connection.
Type string: Resource type.
PrivateEndpoint Pulumi.AzureNative.Relay.Outputs.PrivateEndpointResponse: Properties of the private endpoint object.
PrivateLinkServiceConnectionState Pulumi.AzureNative.Relay.Outputs.PrivateLinkServiceConnectionStateResponse: Approval state of the private link connection.
Tags Dictionary<string, string>: Resource tags.

Id string: Resource ID.
Location string: Resource location.
Name string: Resource name.
ProvisioningState string: Provisioning state of the private endpoint connection.
Type string: Resource type.
PrivateEndpoint PrivateEndpointResponse: Properties of the private endpoint object.
PrivateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse: Approval state of the private link connection.
Tags map[string]string: Resource tags.

id String: Resource ID.
location String: Resource location.
name String: Resource name.
provisioningState String: Provisioning state of the private endpoint connection.
type String: Resource type.
privateEndpoint PrivateEndpointResponse: Properties of the private endpoint object.
privateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse: Approval state of the private link connection.
tags Map<String,String>: Resource tags.

id string: Resource ID.
location string: Resource location.
name string: Resource name.
provisioningState string: Provisioning state of the private endpoint connection.
type string: Resource type.
privateEndpoint PrivateEndpointResponse: Properties of the private endpoint object.
privateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse: Approval state of the private link connection.
tags {[key: string]: string}: Resource tags.

id str: Resource ID.
location str: Resource location.
name str: Resource name.
provisioning_state str: Provisioning state of the private endpoint connection.
type str: Resource type.
private_endpoint PrivateEndpointResponse: Properties of the private endpoint object.
private_link_service_connection_state PrivateLinkServiceConnectionStateResponse: Approval state of the private link connection.
tags Mapping[str, str]: Resource tags.

id String: Resource ID.
location String: Resource location.
name String: Resource name.
provisioningState String: Provisioning state of the private endpoint connection.
type String: Resource type.
privateEndpoint Property Map: Properties of the private endpoint object.
privateLinkServiceConnectionState Property Map: Approval state of the private link connection.
tags Map<String>: Resource tags.

Supporting Types

PrivateEndpointResponse

Id string: Full identifier of the private endpoint resource.

Id string: Full identifier of the private endpoint resource.

id String: Full identifier of the private endpoint resource.

id string: Full identifier of the private endpoint resource.

id str: Full identifier of the private endpoint resource.

id String: Full identifier of the private endpoint resource.

PrivateLinkServiceConnectionStateResponse

ActionRequired string: A message indicating if changes on the service provider require any updates on the consumer.
Description string: The reason for approval or rejection.
Status string: Indicates whether the connection has been approved, rejected or removed by the Relay Namespace owner.

ActionRequired string: A message indicating if changes on the service provider require any updates on the consumer.
Description string: The reason for approval or rejection.
Status string: Indicates whether the connection has been approved, rejected or removed by the Relay Namespace owner.

actionRequired String: A message indicating if changes on the service provider require any updates on the consumer.
description String: The reason for approval or rejection.
status String: Indicates whether the connection has been approved, rejected or removed by the Relay Namespace owner.

actionRequired string: A message indicating if changes on the service provider require any updates on the consumer.
description string: The reason for approval or rejection.
status string: Indicates whether the connection has been approved, rejected or removed by the Relay Namespace owner.

action_required str: A message indicating if changes on the service provider require any updates on the consumer.
description str: The reason for approval or rejection.
status str: Indicates whether the connection has been approved, rejected or removed by the Relay Namespace owner.

actionRequired String: A message indicating if changes on the service provider require any updates on the consumer.
description String: The reason for approval or rejection.
status String: Indicates whether the connection has been approved, rejected or removed by the Relay Namespace owner.

Package Details

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