Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. aadiam
  5. getPrivateEndpointConnection
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.aadiam.getPrivateEndpointConnection

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Gets the specified private endpoint connection associated with the given policy.

Uses Azure REST API version 2020-03-01.

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>
Copy
def get_private_endpoint_connection(policy_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(policy_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]
Copy
func LookupPrivateEndpointConnection(ctx *Context, args *LookupPrivateEndpointConnectionArgs, opts ...InvokeOption) (*LookupPrivateEndpointConnectionResult, error)
func LookupPrivateEndpointConnectionOutput(ctx *Context, args *LookupPrivateEndpointConnectionOutputArgs, opts ...InvokeOption) LookupPrivateEndpointConnectionResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetPrivateEndpointConnectionResult> getPrivateEndpointConnection(GetPrivateEndpointConnectionArgs args, InvokeOptions options)
public static Output<GetPrivateEndpointConnectionResult> getPrivateEndpointConnection(GetPrivateEndpointConnectionArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:aadiam:getPrivateEndpointConnection
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

PolicyName
This property is required.
Changes to this property will trigger replacement.
string
The name of the private link policy in Azure AD.
PrivateEndpointConnectionName
This property is required.
Changes to this property will trigger replacement.
string
The PrivateEndpointConnection name.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of an Azure resource group.
PolicyName
This property is required.
Changes to this property will trigger replacement.
string
The name of the private link policy in Azure AD.
PrivateEndpointConnectionName
This property is required.
Changes to this property will trigger replacement.
string
The PrivateEndpointConnection name.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of an Azure resource group.
policyName
This property is required.
Changes to this property will trigger replacement.
String
The name of the private link policy in Azure AD.
privateEndpointConnectionName
This property is required.
Changes to this property will trigger replacement.
String
The PrivateEndpointConnection name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of an Azure resource group.
policyName
This property is required.
Changes to this property will trigger replacement.
string
The name of the private link policy in Azure AD.
privateEndpointConnectionName
This property is required.
Changes to this property will trigger replacement.
string
The PrivateEndpointConnection name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of an Azure resource group.
policy_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the private link policy in Azure AD.
private_endpoint_connection_name
This property is required.
Changes to this property will trigger replacement.
str
The PrivateEndpointConnection name.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
Name of an Azure resource group.
policyName
This property is required.
Changes to this property will trigger replacement.
String
The name of the private link policy in Azure AD.
privateEndpointConnectionName
This property is required.
Changes to this property will trigger replacement.
String
The PrivateEndpointConnection name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of an Azure resource group.

getPrivateEndpointConnection Result

The following output properties are available:

Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name string
The name of the resource
ProvisioningState string
Provisioning state of the private endpoint connection.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
PrivateEndpoint Pulumi.AzureNative.AadIam.Outputs.PrivateEndpointResponse
Properties of the private endpoint object.
PrivateLinkServiceConnectionState Pulumi.AzureNative.AadIam.Outputs.PrivateLinkServiceConnectionStateResponse
Approval state of the private link connection.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name string
The name of the resource
ProvisioningState string
Provisioning state of the private endpoint connection.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
PrivateEndpoint PrivateEndpointResponse
Properties of the private endpoint object.
PrivateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse
Approval state of the private link connection.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name String
The name of the resource
provisioningState String
Provisioning state of the private endpoint connection.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
privateEndpoint PrivateEndpointResponse
Properties of the private endpoint object.
privateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse
Approval state of the private link connection.
id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name string
The name of the resource
provisioningState string
Provisioning state of the private endpoint connection.
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
privateEndpoint PrivateEndpointResponse
Properties of the private endpoint object.
privateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse
Approval state of the private link connection.
id str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name str
The name of the resource
provisioning_state str
Provisioning state of the private endpoint connection.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
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 resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name String
The name of the resource
provisioningState String
Provisioning state of the private endpoint connection.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
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 given policy 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 given policy 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 given policy 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 given policy 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 given policy 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 given policy owner.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native