Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. digitaltwins
  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.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.digitaltwins.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.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

Get private endpoint connection properties for the given private endpoint.

Uses Azure REST API version 2023-01-31.

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,
                                    resource_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,
                                    resource_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:digitaltwins: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 DigitalTwinsInstance.
ResourceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the DigitalTwinsInstance.
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 DigitalTwinsInstance.
ResourceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the DigitalTwinsInstance.
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 DigitalTwinsInstance.
resourceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the DigitalTwinsInstance.
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 DigitalTwinsInstance.
resourceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the DigitalTwinsInstance.
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 DigitalTwinsInstance.
resource_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the DigitalTwinsInstance.
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 DigitalTwinsInstance.
resourceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the DigitalTwinsInstance.

getPrivateEndpointConnection Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
Id string
The resource identifier.
Name string
The resource name.
Properties Pulumi.AzureNative.DigitalTwins.Outputs.ConnectionPropertiesResponse
The connection properties.
SystemData Pulumi.AzureNative.DigitalTwins.Outputs.SystemDataResponse
Metadata pertaining to creation and last modification of the private endpoint connection.
Type string
The resource type.
AzureApiVersion string
The Azure API version of the resource.
Id string
The resource identifier.
Name string
The resource name.
Properties ConnectionPropertiesResponse
The connection properties.
SystemData SystemDataResponse
Metadata pertaining to creation and last modification of the private endpoint connection.
Type string
The resource type.
azureApiVersion String
The Azure API version of the resource.
id String
The resource identifier.
name String
The resource name.
properties ConnectionPropertiesResponse
The connection properties.
systemData SystemDataResponse
Metadata pertaining to creation and last modification of the private endpoint connection.
type String
The resource type.
azureApiVersion string
The Azure API version of the resource.
id string
The resource identifier.
name string
The resource name.
properties ConnectionPropertiesResponse
The connection properties.
systemData SystemDataResponse
Metadata pertaining to creation and last modification of the private endpoint connection.
type string
The resource type.
azure_api_version str
The Azure API version of the resource.
id str
The resource identifier.
name str
The resource name.
properties ConnectionPropertiesResponse
The connection properties.
system_data SystemDataResponse
Metadata pertaining to creation and last modification of the private endpoint connection.
type str
The resource type.
azureApiVersion String
The Azure API version of the resource.
id String
The resource identifier.
name String
The resource name.
properties Property Map
The connection properties.
systemData Property Map
Metadata pertaining to creation and last modification of the private endpoint connection.
type String
The resource type.

Supporting Types

ConnectionPropertiesResponse

ProvisioningState This property is required. string
The provisioning state.
GroupIds List<string>
The list of group ids for the private endpoint connection.
PrivateEndpoint Pulumi.AzureNative.DigitalTwins.Inputs.PrivateEndpointResponse
The private endpoint.
PrivateLinkServiceConnectionState Pulumi.AzureNative.DigitalTwins.Inputs.ConnectionPropertiesResponsePrivateLinkServiceConnectionState
The connection state.
ProvisioningState This property is required. string
The provisioning state.
GroupIds []string
The list of group ids for the private endpoint connection.
PrivateEndpoint PrivateEndpointResponse
The private endpoint.
PrivateLinkServiceConnectionState ConnectionPropertiesResponsePrivateLinkServiceConnectionState
The connection state.
provisioningState This property is required. String
The provisioning state.
groupIds List<String>
The list of group ids for the private endpoint connection.
privateEndpoint PrivateEndpointResponse
The private endpoint.
privateLinkServiceConnectionState ConnectionPropertiesResponsePrivateLinkServiceConnectionState
The connection state.
provisioningState This property is required. string
The provisioning state.
groupIds string[]
The list of group ids for the private endpoint connection.
privateEndpoint PrivateEndpointResponse
The private endpoint.
privateLinkServiceConnectionState ConnectionPropertiesResponsePrivateLinkServiceConnectionState
The connection state.
provisioning_state This property is required. str
The provisioning state.
group_ids Sequence[str]
The list of group ids for the private endpoint connection.
private_endpoint PrivateEndpointResponse
The private endpoint.
private_link_service_connection_state ConnectionPropertiesResponsePrivateLinkServiceConnectionState
The connection state.
provisioningState This property is required. String
The provisioning state.
groupIds List<String>
The list of group ids for the private endpoint connection.
privateEndpoint Property Map
The private endpoint.
privateLinkServiceConnectionState Property Map
The connection state.

ConnectionPropertiesResponsePrivateLinkServiceConnectionState

Description This property is required. string
The description for the current state of a private endpoint connection.
Status This property is required. string
The status of a private endpoint connection.
ActionsRequired string
Actions required for a private endpoint connection.
Description This property is required. string
The description for the current state of a private endpoint connection.
Status This property is required. string
The status of a private endpoint connection.
ActionsRequired string
Actions required for a private endpoint connection.
description This property is required. String
The description for the current state of a private endpoint connection.
status This property is required. String
The status of a private endpoint connection.
actionsRequired String
Actions required for a private endpoint connection.
description This property is required. string
The description for the current state of a private endpoint connection.
status This property is required. string
The status of a private endpoint connection.
actionsRequired string
Actions required for a private endpoint connection.
description This property is required. str
The description for the current state of a private endpoint connection.
status This property is required. str
The status of a private endpoint connection.
actions_required str
Actions required for a private endpoint connection.
description This property is required. String
The description for the current state of a private endpoint connection.
status This property is required. String
The status of a private endpoint connection.
actionsRequired String
Actions required for a private endpoint connection.

PrivateEndpointResponse

Id This property is required. string
The resource identifier.
Id This property is required. string
The resource identifier.
id This property is required. String
The resource identifier.
id This property is required. string
The resource identifier.
id This property is required. str
The resource identifier.
id This property is required. String
The resource identifier.

SystemDataResponse

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource last modification (UTC)
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource last modification (UTC)
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

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.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native