Azure v6.21.0, Mar 7 25

We recommend using Azure Native.

Azure v6.21.0 published on Friday, Mar 7, 2025 by Pulumi

azure.privatelink.getServiceEndpointConnections

Explore with Pulumi AI

We recommend using Azure Native.

Azure v6.21.0 published on Friday, Mar 7, 2025 by Pulumi

pulumi/pulumi-azure

Example Usage

TypeScript
Python
Go
C#
Java
YAML

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = azure.privatelink.getServiceEndpointConnections({
    serviceId: exampleAzurermPrivateLinkService.id,
    resourceGroupName: exampleAzurermResourceGroup.name,
});
export const privateEndpointStatus = example.then(example => example.privateEndpointConnections?.[0]?.status);

import pulumi
import pulumi_azure as azure

example = azure.privatelink.get_service_endpoint_connections(service_id=example_azurerm_private_link_service["id"],
    resource_group_name=example_azurerm_resource_group["name"])
pulumi.export("privateEndpointStatus", example.private_endpoint_connections[0].status)

package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/privatelink"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := privatelink.GetServiceEndpointConnections(ctx, &privatelink.GetServiceEndpointConnectionsArgs{
			ServiceId:         exampleAzurermPrivateLinkService.Id,
			ResourceGroupName: exampleAzurermResourceGroup.Name,
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("privateEndpointStatus", example.PrivateEndpointConnections[0].Status)
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var example = Azure.PrivateLink.GetServiceEndpointConnections.Invoke(new()
    {
        ServiceId = exampleAzurermPrivateLinkService.Id,
        ResourceGroupName = exampleAzurermResourceGroup.Name,
    });

    return new Dictionary<string, object?>
    {
        ["privateEndpointStatus"] = example.Apply(getServiceEndpointConnectionsResult => getServiceEndpointConnectionsResult.PrivateEndpointConnections[0]?.Status),
    };
});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.privatelink.PrivatelinkFunctions;
import com.pulumi.azure.privatelink.inputs.GetServiceEndpointConnectionsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var example = PrivatelinkFunctions.getServiceEndpointConnections(GetServiceEndpointConnectionsArgs.builder()
            .serviceId(exampleAzurermPrivateLinkService.id())
            .resourceGroupName(exampleAzurermResourceGroup.name())
            .build());

        ctx.export("privateEndpointStatus", example.applyValue(getServiceEndpointConnectionsResult -> getServiceEndpointConnectionsResult.privateEndpointConnections()[0].status()));
    }
}

variables:
  example:
    fn::invoke:
      function: azure:privatelink:getServiceEndpointConnections
      arguments:
        serviceId: ${exampleAzurermPrivateLinkService.id}
        resourceGroupName: ${exampleAzurermResourceGroup.name}
outputs:
  privateEndpointStatus: ${example.privateEndpointConnections[0].status}

Using getServiceEndpointConnections

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 getServiceEndpointConnections(args: GetServiceEndpointConnectionsArgs, opts?: InvokeOptions): Promise<GetServiceEndpointConnectionsResult>
function getServiceEndpointConnectionsOutput(args: GetServiceEndpointConnectionsOutputArgs, opts?: InvokeOptions): Output<GetServiceEndpointConnectionsResult>

def get_service_endpoint_connections(resource_group_name: Optional[str] = None,
                                     service_id: Optional[str] = None,
                                     opts: Optional[InvokeOptions] = None) -> GetServiceEndpointConnectionsResult
def get_service_endpoint_connections_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                                     service_id: Optional[pulumi.Input[str]] = None,
                                     opts: Optional[InvokeOptions] = None) -> Output[GetServiceEndpointConnectionsResult]

func GetServiceEndpointConnections(ctx *Context, args *GetServiceEndpointConnectionsArgs, opts ...InvokeOption) (*GetServiceEndpointConnectionsResult, error)
func GetServiceEndpointConnectionsOutput(ctx *Context, args *GetServiceEndpointConnectionsOutputArgs, opts ...InvokeOption) GetServiceEndpointConnectionsResultOutput

> Note: This function is named GetServiceEndpointConnections in the Go SDK.

public static class GetServiceEndpointConnections 
{
    public static Task<GetServiceEndpointConnectionsResult> InvokeAsync(GetServiceEndpointConnectionsArgs args, InvokeOptions? opts = null)
    public static Output<GetServiceEndpointConnectionsResult> Invoke(GetServiceEndpointConnectionsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetServiceEndpointConnectionsResult> getServiceEndpointConnections(GetServiceEndpointConnectionsArgs args, InvokeOptions options)
public static Output<GetServiceEndpointConnectionsResult> getServiceEndpointConnections(GetServiceEndpointConnectionsArgs args, InvokeOptions options)

fn::invoke:
  function: azure:privatelink/getServiceEndpointConnections:getServiceEndpointConnections
  arguments:
    # arguments dictionary

The following arguments are supported:

ResourceGroupName string: The name of the resource group in which the private link service resides.
ServiceId string: The resource ID of the private link service.

ResourceGroupName string: The name of the resource group in which the private link service resides.
ServiceId string: The resource ID of the private link service.

resourceGroupName String: The name of the resource group in which the private link service resides.
serviceId String: The resource ID of the private link service.

resourceGroupName string: The name of the resource group in which the private link service resides.
serviceId string: The resource ID of the private link service.

resource_group_name str: The name of the resource group in which the private link service resides.
service_id str: The resource ID of the private link service.

resourceGroupName String: The name of the resource group in which the private link service resides.
serviceId String: The resource ID of the private link service.

getServiceEndpointConnections Result

The following output properties are available:

Id string: The provider-assigned unique ID for this managed resource.
Location string
PrivateEndpointConnections List<GetServiceEndpointConnectionsPrivateEndpointConnection>
ResourceGroupName string
ServiceId string
ServiceName string: The name of the private link service.

Id string: The provider-assigned unique ID for this managed resource.
Location string
PrivateEndpointConnections []GetServiceEndpointConnectionsPrivateEndpointConnection
ResourceGroupName string
ServiceId string
ServiceName string: The name of the private link service.

id String: The provider-assigned unique ID for this managed resource.
location String
privateEndpointConnections List<GetServiceEndpointConnectionsPrivateEndpointConnection>
resourceGroupName String
serviceId String
serviceName String: The name of the private link service.

id string: The provider-assigned unique ID for this managed resource.
location string
privateEndpointConnections GetServiceEndpointConnectionsPrivateEndpointConnection[]
resourceGroupName string
serviceId string
serviceName string: The name of the private link service.

id str: The provider-assigned unique ID for this managed resource.
location str
private_endpoint_connections Sequence[GetServiceEndpointConnectionsPrivateEndpointConnection]
resource_group_name str
service_id str
service_name str: The name of the private link service.

id String: The provider-assigned unique ID for this managed resource.
location String
privateEndpointConnections List<Property Map>
resourceGroupName String
serviceId String
serviceName String: The name of the private link service.

Supporting Types

GetServiceEndpointConnectionsPrivateEndpointConnection

ActionRequired string: A message indicating if changes on the service provider require any updates or not.
ConnectionId string: The resource id of the private link service connection between the private link service and the private link endpoint.
ConnectionName string: The name of the connection between the private link service and the private link endpoint.
Description string: The request for approval message or the reason for rejection message.
PrivateEndpointId string: The resource id of the private link endpoint.
PrivateEndpointName string: The name of the private link endpoint.
Status string: Indicates the state of the connection between the private link service and the private link endpoint, possible values are Pending, Approved or Rejected.

ActionRequired string: A message indicating if changes on the service provider require any updates or not.
ConnectionId string: The resource id of the private link service connection between the private link service and the private link endpoint.
ConnectionName string: The name of the connection between the private link service and the private link endpoint.
Description string: The request for approval message or the reason for rejection message.
PrivateEndpointId string: The resource id of the private link endpoint.
PrivateEndpointName string: The name of the private link endpoint.
Status string: Indicates the state of the connection between the private link service and the private link endpoint, possible values are Pending, Approved or Rejected.

actionRequired String: A message indicating if changes on the service provider require any updates or not.
connectionId String: The resource id of the private link service connection between the private link service and the private link endpoint.
connectionName String: The name of the connection between the private link service and the private link endpoint.
description String: The request for approval message or the reason for rejection message.
privateEndpointId String: The resource id of the private link endpoint.
privateEndpointName String: The name of the private link endpoint.
status String: Indicates the state of the connection between the private link service and the private link endpoint, possible values are Pending, Approved or Rejected.

actionRequired string: A message indicating if changes on the service provider require any updates or not.
connectionId string: The resource id of the private link service connection between the private link service and the private link endpoint.
connectionName string: The name of the connection between the private link service and the private link endpoint.
description string: The request for approval message or the reason for rejection message.
privateEndpointId string: The resource id of the private link endpoint.
privateEndpointName string: The name of the private link endpoint.
status string: Indicates the state of the connection between the private link service and the private link endpoint, possible values are Pending, Approved or Rejected.

action_required str: A message indicating if changes on the service provider require any updates or not.
connection_id str: The resource id of the private link service connection between the private link service and the private link endpoint.
connection_name str: The name of the connection between the private link service and the private link endpoint.
description str: The request for approval message or the reason for rejection message.
private_endpoint_id str: The resource id of the private link endpoint.
private_endpoint_name str: The name of the private link endpoint.
status str: Indicates the state of the connection between the private link service and the private link endpoint, possible values are Pending, Approved or Rejected.

actionRequired String: A message indicating if changes on the service provider require any updates or not.
connectionId String: The resource id of the private link service connection between the private link service and the private link endpoint.
connectionName String: The name of the connection between the private link service and the private link endpoint.
description String: The request for approval message or the reason for rejection message.
privateEndpointId String: The resource id of the private link endpoint.
privateEndpointName String: The name of the private link endpoint.
status String: Indicates the state of the connection between the private link service and the private link endpoint, possible values are Pending, Approved or Rejected.

Package Details

Repository: Azure Classic pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.

We recommend using Azure Native.

Azure v6.21.0 published on Friday, Mar 7, 2025 by Pulumi

pulumi/pulumi-azure

azure.privatelink.getServiceEndpointConnections

On this page

On this page

Example Usage

Using getServiceEndpointConnections

getServiceEndpointConnections Result

Supporting Types

GetServiceEndpointConnectionsPrivateEndpointConnection

Package Details

On this page

On this page