Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. sql
  5. getPrivateEndpointConnection
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.sql.getPrivateEndpointConnection

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

Gets a private endpoint connection.

Uses Azure REST API version 2023-08-01.

Other available API versions: 2018-06-01-preview, 2020-02-02-preview, 2020-08-01-preview, 2020-11-01-preview, 2021-02-01-preview, 2021-05-01-preview, 2021-08-01-preview, 2021-11-01, 2021-11-01-preview, 2022-02-01-preview, 2022-05-01-preview, 2022-08-01-preview, 2022-11-01-preview, 2023-02-01-preview, 2023-05-01-preview, 2023-08-01-preview, 2024-05-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native sql [ApiVersion]. See the version guide for details.

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(private_endpoint_connection_name: Optional[str] = None,
                                    resource_group_name: Optional[str] = None,
                                    server_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,
                                    server_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:sql:getPrivateEndpointConnection
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

PrivateEndpointConnectionName
This property is required.
Changes to this property will trigger replacement.
string
The name of the private endpoint connection.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
ServerName
This property is required.
Changes to this property will trigger replacement.
string
The name of the server.
PrivateEndpointConnectionName
This property is required.
Changes to this property will trigger replacement.
string
The name of the private endpoint connection.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
ServerName
This property is required.
Changes to this property will trigger replacement.
string
The name of the server.
privateEndpointConnectionName
This property is required.
Changes to this property will trigger replacement.
String
The name of the private endpoint connection.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serverName
This property is required.
Changes to this property will trigger replacement.
String
The name of the server.
privateEndpointConnectionName
This property is required.
Changes to this property will trigger replacement.
string
The name of the private endpoint connection.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serverName
This property is required.
Changes to this property will trigger replacement.
string
The name of the server.
private_endpoint_connection_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the private endpoint connection.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the server.
privateEndpointConnectionName
This property is required.
Changes to this property will trigger replacement.
String
The name of the private endpoint connection.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serverName
This property is required.
Changes to this property will trigger replacement.
String
The name of the server.

getPrivateEndpointConnection Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
GroupIds List<string>
Group IDs.
Id string
Resource ID.
Name string
Resource name.
ProvisioningState string
State of the private endpoint connection.
Type string
Resource type.
PrivateEndpoint Pulumi.AzureNative.Sql.Outputs.PrivateEndpointPropertyResponse
Private endpoint which the connection belongs to.
PrivateLinkServiceConnectionState Pulumi.AzureNative.Sql.Outputs.PrivateLinkServiceConnectionStatePropertyResponse
Connection state of the private endpoint connection.
AzureApiVersion string
The Azure API version of the resource.
GroupIds []string
Group IDs.
Id string
Resource ID.
Name string
Resource name.
ProvisioningState string
State of the private endpoint connection.
Type string
Resource type.
PrivateEndpoint PrivateEndpointPropertyResponse
Private endpoint which the connection belongs to.
PrivateLinkServiceConnectionState PrivateLinkServiceConnectionStatePropertyResponse
Connection state of the private endpoint connection.
azureApiVersion String
The Azure API version of the resource.
groupIds List<String>
Group IDs.
id String
Resource ID.
name String
Resource name.
provisioningState String
State of the private endpoint connection.
type String
Resource type.
privateEndpoint PrivateEndpointPropertyResponse
Private endpoint which the connection belongs to.
privateLinkServiceConnectionState PrivateLinkServiceConnectionStatePropertyResponse
Connection state of the private endpoint connection.
azureApiVersion string
The Azure API version of the resource.
groupIds string[]
Group IDs.
id string
Resource ID.
name string
Resource name.
provisioningState string
State of the private endpoint connection.
type string
Resource type.
privateEndpoint PrivateEndpointPropertyResponse
Private endpoint which the connection belongs to.
privateLinkServiceConnectionState PrivateLinkServiceConnectionStatePropertyResponse
Connection state of the private endpoint connection.
azure_api_version str
The Azure API version of the resource.
group_ids Sequence[str]
Group IDs.
id str
Resource ID.
name str
Resource name.
provisioning_state str
State of the private endpoint connection.
type str
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.
azureApiVersion String
The Azure API version of the resource.
groupIds List<String>
Group IDs.
id String
Resource ID.
name String
Resource name.
provisioningState String
State of the private endpoint connection.
type String
Resource type.
privateEndpoint Property Map
Private endpoint which the connection belongs to.
privateLinkServiceConnectionState Property Map
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 string
Resource id of the private endpoint.
id str
Resource id of the private endpoint.
id String
Resource id of the private endpoint.

PrivateLinkServiceConnectionStatePropertyResponse

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

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 v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native