Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. hybridcompute
  5. getPrivateEndpointConnection
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.hybridcompute.getPrivateEndpointConnection

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Gets a private endpoint connection. Azure REST API version: 2022-12-27.

Other available API versions: 2020-08-15-preview, 2023-06-20-preview, 2023-10-03-preview, 2024-03-31-preview, 2024-05-20-preview, 2024-07-10, 2024-07-31-preview, 2024-09-10-preview, 2024-11-10-preview.

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,
                                    scope_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,
                                    scope_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:hybridcompute: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. The name is case insensitive.
ScopeName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Azure Arc PrivateLinkScope resource.
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. The name is case insensitive.
ScopeName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Azure Arc PrivateLinkScope resource.
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. The name is case insensitive.
scopeName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Azure Arc PrivateLinkScope resource.
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. The name is case insensitive.
scopeName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Azure Arc PrivateLinkScope resource.
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. The name is case insensitive.
scope_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the Azure Arc PrivateLinkScope resource.
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. The name is case insensitive.
scopeName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Azure Arc PrivateLinkScope resource.

getPrivateEndpointConnection Result

The following output properties are available:

Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name string
The name of the resource
Properties Pulumi.AzureNative.HybridCompute.Outputs.PrivateEndpointConnectionPropertiesResponse
Resource properties.
SystemData Pulumi.AzureNative.HybridCompute.Outputs.SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name string
The name of the resource
Properties PrivateEndpointConnectionPropertiesResponse
Resource properties.
SystemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name String
The name of the resource
properties PrivateEndpointConnectionPropertiesResponse
Resource properties.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name string
The name of the resource
properties PrivateEndpointConnectionPropertiesResponse
Resource properties.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
id str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name str
The name of the resource
properties PrivateEndpointConnectionPropertiesResponse
Resource properties.
system_data SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name String
The name of the resource
properties Property Map
Resource properties.
systemData Property Map
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Supporting Types

PrivateEndpointConnectionPropertiesResponse

GroupIds This property is required. List<string>
List of group IDs.
ProvisioningState This property is required. string
State of the private endpoint connection.
PrivateEndpoint Pulumi.AzureNative.HybridCompute.Inputs.PrivateEndpointPropertyResponse
Private endpoint which the connection belongs to.
PrivateLinkServiceConnectionState Pulumi.AzureNative.HybridCompute.Inputs.PrivateLinkServiceConnectionStatePropertyResponse
Connection state of the private endpoint connection.
GroupIds This property is required. []string
List of group IDs.
ProvisioningState This property is required. string
State of the private endpoint connection.
PrivateEndpoint PrivateEndpointPropertyResponse
Private endpoint which the connection belongs to.
PrivateLinkServiceConnectionState PrivateLinkServiceConnectionStatePropertyResponse
Connection state of the private endpoint connection.
groupIds This property is required. List<String>
List of group IDs.
provisioningState This property is required. String
State of the private endpoint connection.
privateEndpoint PrivateEndpointPropertyResponse
Private endpoint which the connection belongs to.
privateLinkServiceConnectionState PrivateLinkServiceConnectionStatePropertyResponse
Connection state of the private endpoint connection.
groupIds This property is required. string[]
List of group IDs.
provisioningState This property is required. string
State of the private endpoint connection.
privateEndpoint PrivateEndpointPropertyResponse
Private endpoint which the connection belongs to.
privateLinkServiceConnectionState PrivateLinkServiceConnectionStatePropertyResponse
Connection state of the private endpoint connection.
group_ids This property is required. Sequence[str]
List of group IDs.
provisioning_state This property is required. str
State of the private endpoint connection.
private_endpoint PrivateEndpointPropertyResponse
Private endpoint which the connection belongs to.
private_link_service_connection_state PrivateLinkServiceConnectionStatePropertyResponse
Connection state of the private endpoint connection.
groupIds This property is required. List<String>
List of group IDs.
provisioningState This property is required. String
State of the private endpoint connection.
privateEndpoint Property Map
Private endpoint which the connection belongs to.
privateLinkServiceConnectionState Property Map
Connection state of the private endpoint connection.

PrivateEndpointPropertyResponse

Id string
Resource id of the private endpoint.
Id string
Resource id of the private endpoint.
id String
Resource id of the private endpoint.
id string
Resource id of the private endpoint.
id str
Resource id of the private endpoint.
id String
Resource id of the private endpoint.

PrivateLinkServiceConnectionStatePropertyResponse

ActionsRequired This property is required. string
The actions required for private link service connection.
Description This property is required. string
The private link service connection description.
Status This property is required. string
The private link service connection status.
ActionsRequired This property is required. string
The actions required for private link service connection.
Description This property is required. string
The private link service connection description.
Status This property is required. string
The private link service connection status.
actionsRequired This property is required. String
The actions required for private link service connection.
description This property is required. String
The private link service connection description.
status This property is required. String
The private link service connection status.
actionsRequired This property is required. string
The actions required for private link service connection.
description This property is required. string
The private link service connection description.
status This property is required. string
The private link service connection status.
actions_required This property is required. str
The actions required for private link service connection.
description This property is required. str
The private link service connection description.
status This property is required. str
The private link service connection status.
actionsRequired This property is required. String
The actions required for private link service connection.
description This property is required. String
The private link service connection description.
status This property is required. String
The private link service connection status.

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-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native