We recommend using Azure Native.
azure.privatelink.getEndpointConnection
Explore with Pulumi AI
Use this data source to access the connection status information about an existing Private Endpoint Connection.
Example Usage
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() =>
{
var example = Azure.PrivateLink.GetEndpointConnection.Invoke(new()
{
Name = "example-private-endpoint",
ResourceGroupName = "example-rg",
});
return new Dictionary<string, object?>
{
["privateEndpointStatus"] = example.Apply(getEndpointConnectionResult => getEndpointConnectionResult.PrivateServiceConnections[0]?.Status),
};
});
package main
import (
"github.com/pulumi/pulumi-azure/sdk/v5/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
})
}
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.GetEndpointConnectionArgs;
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.getEndpointConnection(GetEndpointConnectionArgs.builder()
.name("example-private-endpoint")
.resourceGroupName("example-rg")
.build());
ctx.export("privateEndpointStatus", example.applyValue(getEndpointConnectionResult -> getEndpointConnectionResult.privateServiceConnections()[0].status()));
}
}
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);
variables:
example:
fn::invoke:
Function: azure:privatelink:getEndpointConnection
Arguments:
name: example-private-endpoint
resourceGroupName: example-rg
outputs:
privateEndpointStatus: ${example.privateServiceConnections[0].status}
Using getEndpointConnection
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 getEndpointConnection(args: GetEndpointConnectionArgs, opts?: InvokeOptions): Promise<GetEndpointConnectionResult>
function getEndpointConnectionOutput(args: GetEndpointConnectionOutputArgs, opts?: InvokeOptions): Output<GetEndpointConnectionResult>
def get_endpoint_connection(name: Optional[str] = None,
resource_group_name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetEndpointConnectionResult
def get_endpoint_connection_output(name: Optional[pulumi.Input[str]] = None,
resource_group_name: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetEndpointConnectionResult]
func GetEndpointConnection(ctx *Context, args *GetEndpointConnectionArgs, opts ...InvokeOption) (*GetEndpointConnectionResult, error)
func GetEndpointConnectionOutput(ctx *Context, args *GetEndpointConnectionOutputArgs, opts ...InvokeOption) GetEndpointConnectionResultOutput
> Note: This function is named GetEndpointConnection
in the Go SDK.
public static class GetEndpointConnection
{
public static Task<GetEndpointConnectionResult> InvokeAsync(GetEndpointConnectionArgs args, InvokeOptions? opts = null)
public static Output<GetEndpointConnectionResult> Invoke(GetEndpointConnectionInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetEndpointConnectionResult> getEndpointConnection(GetEndpointConnectionArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: azure:privatelink/getEndpointConnection:getEndpointConnection
arguments:
# arguments dictionary
The following arguments are supported:
- Name string
Specifies the Name of the private endpoint.
- Resource
Group stringName Specifies the Name of the Resource Group within which the private endpoint exists.
- Name string
Specifies the Name of the private endpoint.
- Resource
Group stringName Specifies the Name of the Resource Group within which the private endpoint exists.
- name String
Specifies the Name of the private endpoint.
- resource
Group StringName Specifies the Name of the Resource Group within which the private endpoint exists.
- name string
Specifies the Name of the private endpoint.
- resource
Group stringName Specifies the Name of the Resource Group within which the private endpoint exists.
- name str
Specifies the Name of the private endpoint.
- resource_
group_ strname Specifies the Name of the Resource Group within which the private endpoint exists.
- name String
Specifies the Name of the private endpoint.
- resource
Group StringName 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.
- Network
Interfaces List<GetEndpoint Connection Network Interface> - Private
Service List<GetConnections Endpoint Connection Private Service Connection> - Resource
Group stringName
- 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.
- Network
Interfaces []GetEndpoint Connection Network Interface - Private
Service []GetConnections Endpoint Connection Private Service Connection - Resource
Group stringName
- 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.
- network
Interfaces List<GetEndpoint Connection Network Interface> - private
Service List<GetConnections Endpoint Connection Private Service Connection> - resource
Group StringName
- 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.
- network
Interfaces GetEndpoint Connection Network Interface[] - private
Service GetConnections Endpoint Connection Private Service Connection[] - resource
Group stringName
- 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.
- network_
interfaces Sequence[GetEndpoint Connection Network Interface] - private_
service_ Sequence[Getconnections Endpoint Connection Private Service Connection] - resource_
group_ strname
- 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.
- network
Interfaces List<Property Map> - private
Service List<Property Map>Connections - resource
Group StringName
Supporting Types
GetEndpointConnectionNetworkInterface
GetEndpointConnectionPrivateServiceConnection
- Name string
Specifies the Name of the private endpoint.
- Private
Ip stringAddress 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 string Possible values are as follows: Value | Meaning -- | --
Auto-Approved
| The remote resource owner has added you to theAuto-Approved
RBAC permission list for the remote resource, all private endpoint connection requests will be automaticallyApproved
.Deleted state
| The resource owner hasRejected
the private endpoint connection request and has removed your private endpoint request from the remote resource.request/response message
| If you submitted a manual private endpoint connection request, while in thePending
status therequest_response
will display the same text from yourrequest_message
in theprivate_service_connection
block above. If the private endpoint connection request wasRejected
by the owner of the remote resource, the text for the rejection will be displayed as therequest_response
text, if the private endpoint connection request wasApproved
by the owner of the remote resource, the text for the approval will be displayed as therequest_response
text- Status string
The current status of the private endpoint request, possible values will be
Pending
,Approved
,Rejected
, orDisconnected
.
- Name string
Specifies the Name of the private endpoint.
- Private
Ip stringAddress 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 string Possible values are as follows: Value | Meaning -- | --
Auto-Approved
| The remote resource owner has added you to theAuto-Approved
RBAC permission list for the remote resource, all private endpoint connection requests will be automaticallyApproved
.Deleted state
| The resource owner hasRejected
the private endpoint connection request and has removed your private endpoint request from the remote resource.request/response message
| If you submitted a manual private endpoint connection request, while in thePending
status therequest_response
will display the same text from yourrequest_message
in theprivate_service_connection
block above. If the private endpoint connection request wasRejected
by the owner of the remote resource, the text for the rejection will be displayed as therequest_response
text, if the private endpoint connection request wasApproved
by the owner of the remote resource, the text for the approval will be displayed as therequest_response
text- Status string
The current status of the private endpoint request, possible values will be
Pending
,Approved
,Rejected
, orDisconnected
.
- name String
Specifies the Name of the private endpoint.
- private
Ip StringAddress 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 String Possible values are as follows: Value | Meaning -- | --
Auto-Approved
| The remote resource owner has added you to theAuto-Approved
RBAC permission list for the remote resource, all private endpoint connection requests will be automaticallyApproved
.Deleted state
| The resource owner hasRejected
the private endpoint connection request and has removed your private endpoint request from the remote resource.request/response message
| If you submitted a manual private endpoint connection request, while in thePending
status therequest_response
will display the same text from yourrequest_message
in theprivate_service_connection
block above. If the private endpoint connection request wasRejected
by the owner of the remote resource, the text for the rejection will be displayed as therequest_response
text, if the private endpoint connection request wasApproved
by the owner of the remote resource, the text for the approval will be displayed as therequest_response
text- status String
The current status of the private endpoint request, possible values will be
Pending
,Approved
,Rejected
, orDisconnected
.
- name string
Specifies the Name of the private endpoint.
- private
Ip stringAddress 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 string Possible values are as follows: Value | Meaning -- | --
Auto-Approved
| The remote resource owner has added you to theAuto-Approved
RBAC permission list for the remote resource, all private endpoint connection requests will be automaticallyApproved
.Deleted state
| The resource owner hasRejected
the private endpoint connection request and has removed your private endpoint request from the remote resource.request/response message
| If you submitted a manual private endpoint connection request, while in thePending
status therequest_response
will display the same text from yourrequest_message
in theprivate_service_connection
block above. If the private endpoint connection request wasRejected
by the owner of the remote resource, the text for the rejection will be displayed as therequest_response
text, if the private endpoint connection request wasApproved
by the owner of the remote resource, the text for the approval will be displayed as therequest_response
text- status string
The current status of the private endpoint request, possible values will be
Pending
,Approved
,Rejected
, orDisconnected
.
- name str
Specifies the Name of the private endpoint.
- private_
ip_ straddress 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: Value | Meaning -- | --
Auto-Approved
| The remote resource owner has added you to theAuto-Approved
RBAC permission list for the remote resource, all private endpoint connection requests will be automaticallyApproved
.Deleted state
| The resource owner hasRejected
the private endpoint connection request and has removed your private endpoint request from the remote resource.request/response message
| If you submitted a manual private endpoint connection request, while in thePending
status therequest_response
will display the same text from yourrequest_message
in theprivate_service_connection
block above. If the private endpoint connection request wasRejected
by the owner of the remote resource, the text for the rejection will be displayed as therequest_response
text, if the private endpoint connection request wasApproved
by the owner of the remote resource, the text for the approval will be displayed as therequest_response
text- status str
The current status of the private endpoint request, possible values will be
Pending
,Approved
,Rejected
, orDisconnected
.
- name String
Specifies the Name of the private endpoint.
- private
Ip StringAddress 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 String Possible values are as follows: Value | Meaning -- | --
Auto-Approved
| The remote resource owner has added you to theAuto-Approved
RBAC permission list for the remote resource, all private endpoint connection requests will be automaticallyApproved
.Deleted state
| The resource owner hasRejected
the private endpoint connection request and has removed your private endpoint request from the remote resource.request/response message
| If you submitted a manual private endpoint connection request, while in thePending
status therequest_response
will display the same text from yourrequest_message
in theprivate_service_connection
block above. If the private endpoint connection request wasRejected
by the owner of the remote resource, the text for the rejection will be displayed as therequest_response
text, if the private endpoint connection request wasApproved
by the owner of the remote resource, the text for the approval will be displayed as therequest_response
text- status String
The current status of the private endpoint request, possible values will be
Pending
,Approved
,Rejected
, orDisconnected
.
Package Details
- Repository
- Azure Classic pulumi/pulumi-azure
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
azurerm
Terraform Provider.