getEndpointConnection

Use this data source to access the connection status information about an existing Private Endpoint Connection.

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var example = Output.Create(Azure.PrivateLink.GetEndpointConnection.InvokeAsync(new Azure.PrivateLink.GetEndpointConnectionArgs
        {
            Name = "example-private-endpoint",
            ResourceGroupName = "example-rg",
        }));
        this.PrivateEndpointStatus = example.Apply(example => example.PrivateServiceConnections[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.GetEndpointConnection(ctx, &privatelink.GetEndpointConnectionArgs{
			Name:              "example-private-endpoint",
			ResourceGroupName: "example-rg",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("privateEndpointStatus", example.PrivateServiceConnections[0].Status)
		return nil
	})
}
import pulumi
import pulumi_azure as azure

example = azure.privatelink.get_endpoint_connection(name="example-private-endpoint",
    resource_group_name="example-rg")
pulumi.export("privateEndpointStatus", example.private_service_connections[0].status)
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = azure.privatelink.getEndpointConnection({
    name: "example-private-endpoint",
    resourceGroupName: "example-rg",
});
export const privateEndpointStatus = example.then(example => example.privateServiceConnections[0].status);

Using getEndpointConnection

function getEndpointConnection(args: GetEndpointConnectionArgs, opts?: InvokeOptions): Promise<GetEndpointConnectionResult>
def get_endpoint_connection(name: Optional[str] = None,
                            resource_group_name: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetEndpointConnectionResult
func GetEndpointConnection(ctx *Context, args *GetEndpointConnectionArgs, opts ...InvokeOption) (*GetEndpointConnectionResult, error)

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

public static class GetEndpointConnection {
    public static Task<GetEndpointConnectionResult> InvokeAsync(GetEndpointConnectionArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

Name string
Specifies the Name of the private endpoint.
ResourceGroupName string
Specifies the Name of the Resource Group within which the private endpoint exists.
Name string
Specifies the Name of the private endpoint.
ResourceGroupName string
Specifies the Name of the Resource Group within which the private endpoint exists.
name string
Specifies the Name of the private endpoint.
resourceGroupName string
Specifies the Name of the Resource Group within which the private endpoint exists.
name str
Specifies the Name of the private endpoint.
resource_group_name str
Specifies the Name of the Resource Group within which the private endpoint exists.

getEndpointConnection Result

The following output properties are available:

Id string
The provider-assigned unique ID for this managed resource.
Location string
The supported Azure location where the resource exists.
Name string
The name of the private endpoint.
PrivateServiceConnections List<GetEndpointConnectionPrivateServiceConnection>
ResourceGroupName string
Id string
The provider-assigned unique ID for this managed resource.
Location string
The supported Azure location where the resource exists.
Name string
The name of the private endpoint.
PrivateServiceConnections []GetEndpointConnectionPrivateServiceConnection
ResourceGroupName string
id string
The provider-assigned unique ID for this managed resource.
location string
The supported Azure location where the resource exists.
name string
The name of the private endpoint.
privateServiceConnections GetEndpointConnectionPrivateServiceConnection[]
resourceGroupName string
id str
The provider-assigned unique ID for this managed resource.
location str
The supported Azure location where the resource exists.
name str
The name of the private endpoint.
private_service_connections Sequence[GetEndpointConnectionPrivateServiceConnection]
resource_group_name str

Supporting Types

GetEndpointConnectionPrivateServiceConnection

Name string
Specifies the Name of the private endpoint.
PrivateIpAddress string
The private IP address associated with the private endpoint, note that you will have a private IP address assigned to the private endpoint even if the connection request was Rejected.
RequestResponse string

Possible values are as follows:

ValueMeaning
Auto-ApprovedThe remote resource owner has added you to the Auto-Approved RBAC permission list for the remote resource, all private endpoint connection requests will be automatically Approved.
Deleted stateThe resource owner has Rejected the private endpoint connection request and has removed your private endpoint request from the remote resource.
request/response messageIf you submitted a manual private endpoint connection request, while in the Pending status the request_response will display the same text from your request_message in the private_service_connection block above. If the private endpoint connection request was Rejected by the owner of the remote resource, the text for the rejection will be displayed as the request_response text, if the private endpoint connection request was Approved by the owner of the remote resource, the text for the approval will be displayed as the request_response text
Status string
The current status of the private endpoint request, possible values will be Pending, Approved, Rejected, or Disconnected.
Name string
Specifies the Name of the private endpoint.
PrivateIpAddress string
The private IP address associated with the private endpoint, note that you will have a private IP address assigned to the private endpoint even if the connection request was Rejected.
RequestResponse string

Possible values are as follows:

ValueMeaning
Auto-ApprovedThe remote resource owner has added you to the Auto-Approved RBAC permission list for the remote resource, all private endpoint connection requests will be automatically Approved.
Deleted stateThe resource owner has Rejected the private endpoint connection request and has removed your private endpoint request from the remote resource.
request/response messageIf you submitted a manual private endpoint connection request, while in the Pending status the request_response will display the same text from your request_message in the private_service_connection block above. If the private endpoint connection request was Rejected by the owner of the remote resource, the text for the rejection will be displayed as the request_response text, if the private endpoint connection request was Approved by the owner of the remote resource, the text for the approval will be displayed as the request_response text
Status string
The current status of the private endpoint request, possible values will be Pending, Approved, Rejected, or Disconnected.
name string
Specifies the Name of the private endpoint.
privateIpAddress string
The private IP address associated with the private endpoint, note that you will have a private IP address assigned to the private endpoint even if the connection request was Rejected.
requestResponse string

Possible values are as follows:

ValueMeaning
Auto-ApprovedThe remote resource owner has added you to the Auto-Approved RBAC permission list for the remote resource, all private endpoint connection requests will be automatically Approved.
Deleted stateThe resource owner has Rejected the private endpoint connection request and has removed your private endpoint request from the remote resource.
request/response messageIf you submitted a manual private endpoint connection request, while in the Pending status the request_response will display the same text from your request_message in the private_service_connection block above. If the private endpoint connection request was Rejected by the owner of the remote resource, the text for the rejection will be displayed as the request_response text, if the private endpoint connection request was Approved by the owner of the remote resource, the text for the approval will be displayed as the request_response text
status string
The current status of the private endpoint request, possible values will be Pending, Approved, Rejected, or Disconnected.
name str
Specifies the Name of the private endpoint.
private_ip_address str
The private IP address associated with the private endpoint, note that you will have a private IP address assigned to the private endpoint even if the connection request was Rejected.
request_response str

Possible values are as follows:

ValueMeaning
Auto-ApprovedThe remote resource owner has added you to the Auto-Approved RBAC permission list for the remote resource, all private endpoint connection requests will be automatically Approved.
Deleted stateThe resource owner has Rejected the private endpoint connection request and has removed your private endpoint request from the remote resource.
request/response messageIf you submitted a manual private endpoint connection request, while in the Pending status the request_response will display the same text from your request_message in the private_service_connection block above. If the private endpoint connection request was Rejected by the owner of the remote resource, the text for the rejection will be displayed as the request_response text, if the private endpoint connection request was Approved by the owner of the remote resource, the text for the approval will be displayed as the request_response text
status str
The current status of the private endpoint request, possible values will be Pending, Approved, Rejected, or Disconnected.

Package Details

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