getServiceEndpointConnections

Use this data source to access endpoint connection information about an existing Private Link Service.

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var example = Output.Create(Azure.PrivateLink.GetServiceEndpointConnections.InvokeAsync(new Azure.PrivateLink.GetServiceEndpointConnectionsArgs
        {
            ServiceId = azurerm_private_link_service.Example.Id,
            ResourceGroupName = azurerm_resource_group.Example.Name,
        }));
        this.PrivateEndpointStatus = example.Apply(example => example.PrivateEndpointConnections[0].Status);
    }

    [Output("privateEndpointStatus")]
    public Output<string> PrivateEndpointStatus { get; set; }
}
package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v4/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:         azurerm_private_link_service.Example.Id,
			ResourceGroupName: azurerm_resource_group.Example.Name,
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("privateEndpointStatus", example.PrivateEndpointConnections[0].Status)
		return nil
	})
}
import pulumi
import pulumi_azure as azure

example = azure.privatelink.get_service_endpoint_connections(service_id=azurerm_private_link_service["example"]["id"],
    resource_group_name=azurerm_resource_group["example"]["name"])
pulumi.export("privateEndpointStatus", example.private_endpoint_connections[0].status)
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

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

Using getServiceEndpointConnections

function getServiceEndpointConnections(args: GetServiceEndpointConnectionsArgs, opts?: InvokeOptions): Promise<GetServiceEndpointConnectionsResult>
def get_service_endpoint_connections(resource_group_name: Optional[str] = None,
                                     service_id: Optional[str] = None,
                                     opts: Optional[InvokeOptions] = None) -> GetServiceEndpointConnectionsResult
func GetServiceEndpointConnections(ctx *Context, args *GetServiceEndpointConnectionsArgs, opts ...InvokeOption) (*GetServiceEndpointConnectionsResult, error)

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

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

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.
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.

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 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.

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.
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.

Package Details

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