Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. purview
  5. getPrivateEndpointConnection
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.purview.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
pulumi/pulumi-azure-native

Get a private endpoint connection Azure REST API version: 2021-12-01.

Other available API versions: 2021-07-01, 2023-05-01-preview, 2024-04-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>
Copy
def get_private_endpoint_connection(account_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(account_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:purview:getPrivateEndpointConnection
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

AccountName
This property is required.
Changes to this property will trigger replacement.
string
The name of the account.
PrivateEndpointConnectionName
This property is required.
Changes to this property will trigger replacement.
string
Name of the private endpoint connection.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The resource group name.
AccountName
This property is required.
Changes to this property will trigger replacement.
string
The name of the account.
PrivateEndpointConnectionName
This property is required.
Changes to this property will trigger replacement.
string
Name of the private endpoint connection.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The resource group name.
accountName
This property is required.
Changes to this property will trigger replacement.
String
The name of the account.
privateEndpointConnectionName
This property is required.
Changes to this property will trigger replacement.
String
Name of the private endpoint connection.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The resource group name.
accountName
This property is required.
Changes to this property will trigger replacement.
string
The name of the account.
privateEndpointConnectionName
This property is required.
Changes to this property will trigger replacement.
string
Name of the private endpoint connection.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The resource group name.
account_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the account.
private_endpoint_connection_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the private endpoint connection.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The resource group name.
accountName
This property is required.
Changes to this property will trigger replacement.
String
The name of the account.
privateEndpointConnectionName
This property is required.
Changes to this property will trigger replacement.
String
Name of the private endpoint connection.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The resource group name.

getPrivateEndpointConnection Result

The following output properties are available:

Id string
Gets or sets the identifier.
Name string
Gets or sets the name.
ProvisioningState string
The provisioning state.
SystemData Pulumi.AzureNative.Purview.Outputs.ProxyResourceResponseSystemData
Metadata pertaining to creation and last modification of the resource.
Type string
Gets or sets the type.
PrivateEndpoint Pulumi.AzureNative.Purview.Outputs.PrivateEndpointResponse
The private endpoint information.
PrivateLinkServiceConnectionState Pulumi.AzureNative.Purview.Outputs.PrivateLinkServiceConnectionStateResponse
The private link service connection state.
Id string
Gets or sets the identifier.
Name string
Gets or sets the name.
ProvisioningState string
The provisioning state.
SystemData ProxyResourceResponseSystemData
Metadata pertaining to creation and last modification of the resource.
Type string
Gets or sets the type.
PrivateEndpoint PrivateEndpointResponse
The private endpoint information.
PrivateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse
The private link service connection state.
id String
Gets or sets the identifier.
name String
Gets or sets the name.
provisioningState String
The provisioning state.
systemData ProxyResourceResponseSystemData
Metadata pertaining to creation and last modification of the resource.
type String
Gets or sets the type.
privateEndpoint PrivateEndpointResponse
The private endpoint information.
privateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse
The private link service connection state.
id string
Gets or sets the identifier.
name string
Gets or sets the name.
provisioningState string
The provisioning state.
systemData ProxyResourceResponseSystemData
Metadata pertaining to creation and last modification of the resource.
type string
Gets or sets the type.
privateEndpoint PrivateEndpointResponse
The private endpoint information.
privateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse
The private link service connection state.
id str
Gets or sets the identifier.
name str
Gets or sets the name.
provisioning_state str
The provisioning state.
system_data ProxyResourceResponseSystemData
Metadata pertaining to creation and last modification of the resource.
type str
Gets or sets the type.
private_endpoint PrivateEndpointResponse
The private endpoint information.
private_link_service_connection_state PrivateLinkServiceConnectionStateResponse
The private link service connection state.
id String
Gets or sets the identifier.
name String
Gets or sets the name.
provisioningState String
The provisioning state.
systemData Property Map
Metadata pertaining to creation and last modification of the resource.
type String
Gets or sets the type.
privateEndpoint Property Map
The private endpoint information.
privateLinkServiceConnectionState Property Map
The private link service connection state.

Supporting Types

PrivateEndpointResponse

Id string
The private endpoint identifier.
Id string
The private endpoint identifier.
id String
The private endpoint identifier.
id string
The private endpoint identifier.
id str
The private endpoint identifier.
id String
The private endpoint identifier.

PrivateLinkServiceConnectionStateResponse

ActionsRequired string
The required actions.
Description string
The description.
Status string
The status.
ActionsRequired string
The required actions.
Description string
The description.
Status string
The status.
actionsRequired String
The required actions.
description String
The description.
status String
The status.
actionsRequired string
The required actions.
description string
The description.
status string
The status.
actions_required str
The required actions.
description str
The description.
status str
The status.
actionsRequired String
The required actions.
description String
The description.
status String
The status.

ProxyResourceResponseSystemData

CreatedAt This property is required. string
The timestamp of resource creation (UTC).
CreatedBy This property is required. string
The identity that created the resource.
CreatedByType This property is required. string
The type of identity that created the resource.
LastModifiedAt This property is required. string
The timestamp of the last modification the resource (UTC).
LastModifiedBy This property is required. string
The identity that last modified the resource.
LastModifiedByType This property is required. string
The type of identity that last modified the resource.
CreatedAt This property is required. string
The timestamp of resource creation (UTC).
CreatedBy This property is required. string
The identity that created the resource.
CreatedByType This property is required. string
The type of identity that created the resource.
LastModifiedAt This property is required. string
The timestamp of the last modification the resource (UTC).
LastModifiedBy This property is required. string
The identity that last modified the resource.
LastModifiedByType This property is required. string
The type of identity that last modified the resource.
createdAt This property is required. String
The timestamp of resource creation (UTC).
createdBy This property is required. String
The identity that created the resource.
createdByType This property is required. String
The type of identity that created the resource.
lastModifiedAt This property is required. String
The timestamp of the last modification the resource (UTC).
lastModifiedBy This property is required. String
The identity that last modified the resource.
lastModifiedByType This property is required. String
The type of identity that last modified the resource.
createdAt This property is required. string
The timestamp of resource creation (UTC).
createdBy This property is required. string
The identity that created the resource.
createdByType This property is required. string
The type of identity that created the resource.
lastModifiedAt This property is required. string
The timestamp of the last modification the resource (UTC).
lastModifiedBy This property is required. string
The identity that last modified the resource.
lastModifiedByType This property is required. string
The type of identity that last modified the resource.
created_at This property is required. str
The timestamp of resource creation (UTC).
created_by This property is required. str
The identity that created the resource.
created_by_type This property is required. str
The type of identity that created the resource.
last_modified_at This property is required. str
The timestamp of the last modification the resource (UTC).
last_modified_by This property is required. str
The identity that last modified the resource.
last_modified_by_type This property is required. str
The type of identity that last modified the resource.
createdAt This property is required. String
The timestamp of resource creation (UTC).
createdBy This property is required. String
The identity that created the resource.
createdByType This property is required. String
The type of identity that created the resource.
lastModifiedAt This property is required. String
The timestamp of the last modification the resource (UTC).
lastModifiedBy This property is required. String
The identity that last modified the resource.
lastModifiedByType This property is required. String
The type of identity that last modified the resource.

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