Azure Native v2 v2.90.0, Mar 27 25

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.

Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

azure-native-v2.keyvault.getPrivateEndpointConnection

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.

Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

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.

TypeScript
Python
Go
C#
Java
YAML

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,
                                    vault_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,
                                    vault_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:keyvault:getPrivateEndpointConnection
  arguments:
    # arguments dictionary

The following arguments are supported:

PrivateEndpointConnectionName string: Name of the private endpoint connection associated with the key vault.
ResourceGroupName string: Name of the resource group that contains the key vault.
VaultName string: The name of the key vault.

PrivateEndpointConnectionName string: Name of the private endpoint connection associated with the key vault.
ResourceGroupName string: Name of the resource group that contains the key vault.
VaultName string: The name of the key vault.

privateEndpointConnectionName String: Name of the private endpoint connection associated with the key vault.
resourceGroupName String: Name of the resource group that contains the key vault.
vaultName String: The name of the key vault.

privateEndpointConnectionName string: Name of the private endpoint connection associated with the key vault.
resourceGroupName string: Name of the resource group that contains the key vault.
vaultName string: The name of the key vault.

private_endpoint_connection_name str: Name of the private endpoint connection associated with the key vault.
resource_group_name str: Name of the resource group that contains the key vault.
vault_name str: The name of the key vault.

privateEndpointConnectionName String: Name of the private endpoint connection associated with the key vault.
resourceGroupName String: Name of the resource group that contains the key vault.
vaultName String: The name of the key vault.

getPrivateEndpointConnection Result

The following output properties are available:

Id string: Fully qualified identifier of the key vault resource.
Location string: Azure location of the key vault resource.
Name string: Name of the key vault resource.
ProvisioningState string: Provisioning state of the private endpoint connection.
Tags Dictionary<string, string>: Tags assigned to the key vault resource.
Type string: Resource type of the key vault resource.
Etag string: Modified whenever there is a change in the state of private endpoint connection.
PrivateEndpoint Pulumi.AzureNative.KeyVault.Outputs.PrivateEndpointResponse: Properties of the private endpoint object.
PrivateLinkServiceConnectionState Pulumi.AzureNative.KeyVault.Outputs.PrivateLinkServiceConnectionStateResponse: Approval state of the private link connection.

Id string: Fully qualified identifier of the key vault resource.
Location string: Azure location of the key vault resource.
Name string: Name of the key vault resource.
ProvisioningState string: Provisioning state of the private endpoint connection.
Tags map[string]string: Tags assigned to the key vault resource.
Type string: Resource type of the key vault resource.
Etag string: Modified whenever there is a change in the state of private endpoint connection.
PrivateEndpoint PrivateEndpointResponse: Properties of the private endpoint object.
PrivateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse: Approval state of the private link connection.

id String: Fully qualified identifier of the key vault resource.
location String: Azure location of the key vault resource.
name String: Name of the key vault resource.
provisioningState String: Provisioning state of the private endpoint connection.
tags Map<String,String>: Tags assigned to the key vault resource.
type String: Resource type of the key vault resource.
etag String: Modified whenever there is a change in the state of private endpoint connection.
privateEndpoint PrivateEndpointResponse: Properties of the private endpoint object.
privateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse: Approval state of the private link connection.

id string: Fully qualified identifier of the key vault resource.
location string: Azure location of the key vault resource.
name string: Name of the key vault resource.
provisioningState string: Provisioning state of the private endpoint connection.
tags {[key: string]: string}: Tags assigned to the key vault resource.
type string: Resource type of the key vault resource.
etag string: Modified whenever there is a change in the state of private endpoint connection.
privateEndpoint PrivateEndpointResponse: Properties of the private endpoint object.
privateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse: Approval state of the private link connection.

id str: Fully qualified identifier of the key vault resource.
location str: Azure location of the key vault resource.
name str: Name of the key vault resource.
provisioning_state str: Provisioning state of the private endpoint connection.
tags Mapping[str, str]: Tags assigned to the key vault resource.
type str: Resource type of the key vault resource.
etag str: Modified whenever there is a change in the state of private endpoint connection.
private_endpoint PrivateEndpointResponse: Properties of the private endpoint object.
private_link_service_connection_state PrivateLinkServiceConnectionStateResponse: Approval state of the private link connection.

id String: Fully qualified identifier of the key vault resource.
location String: Azure location of the key vault resource.
name String: Name of the key vault resource.
provisioningState String: Provisioning state of the private endpoint connection.
tags Map<String>: Tags assigned to the key vault resource.
type String: Resource type of the key vault resource.
etag String: Modified whenever there is a change in the state of private endpoint connection.
privateEndpoint Property Map: Properties of the private endpoint object.
privateLinkServiceConnectionState Property Map: Approval state of the private link connection.

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

ActionsRequired 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 key vault owner.

ActionsRequired 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 key vault owner.

actionsRequired 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 key vault owner.

actionsRequired 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 key vault owner.

actions_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 key vault owner.

actionsRequired 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 key vault owner.

Package Details

Repository: azure-native-v2 pulumi/pulumi-azure-native
License: Apache-2.0

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.

Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

pulumi/pulumi-azure-native

azure-native-v2.keyvault.getPrivateEndpointConnection

On this page

On this page

Using getPrivateEndpointConnection

getPrivateEndpointConnection Result

Supporting Types

PrivateEndpointResponse

PrivateLinkServiceConnectionStateResponse

Package Details

On this page

On this page