Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Azure Native
  4. API Docs
  5. datafactory
  6. getPrivateEndpointConnection
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Viewing docs for Azure Native v3.27.0
published on Sunday, Aug 30, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-azure-native

azure-native.datafactory.getPrivateEndpointConnection

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Viewing docs for Azure Native v3.27.0
published on Sunday, Aug 30, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-azure-native

    Gets a private endpoint connection

    Uses Azure REST API version 2018-06-01.

    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?: InvokeOutputOptions): Output<GetPrivateEndpointConnectionResult>
    def get_private_endpoint_connection(factory_name: Optional[str] = None,
                                    private_endpoint_connection_name: Optional[str] = None,
                                    resource_group_name: Optional[str] = None,
                                    opts: Optional[InvokeOptions] = None) -> GetPrivateEndpointConnectionResult
def get_private_endpoint_connection_output(factory_name: pulumi.Input[Optional[str]] = None,
                                    private_endpoint_connection_name: pulumi.Input[Optional[str]] = None,
                                    resource_group_name: pulumi.Input[Optional[str]] = None,
                                    opts: Optional[InvokeOutputOptions] = None) -> Output[GetPrivateEndpointConnectionResult]
    func LookupPrivateEndpointConnection(ctx *Context, args *LookupPrivateEndpointConnectionArgs, opts ...InvokeOption) (*LookupPrivateEndpointConnectionResult, error)
func LookupPrivateEndpointConnectionOutput(ctx *Context, args *LookupPrivateEndpointConnectionOutputArgs, opts ...InvokeOption) LookupPrivateEndpointConnectionResultOutput

    > 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)
    public static Output<GetPrivateEndpointConnectionResult> Invoke(GetPrivateEndpointConnectionInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetPrivateEndpointConnectionResult> getPrivateEndpointConnection(GetPrivateEndpointConnectionArgs args, InvokeOptions options)
public static Output<GetPrivateEndpointConnectionResult> getPrivateEndpointConnection(GetPrivateEndpointConnectionArgs args, InvokeOptions options)
public static Output<GetPrivateEndpointConnectionResult> getPrivateEndpointConnection(GetPrivateEndpointConnectionArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: azure-native:datafactory:getPrivateEndpointConnection
  arguments:
    # arguments dictionary
    data "azure-native_datafactory_get_private_endpoint_connection" "name" {
    # arguments
}

    The following arguments are supported:

    FactoryName string
    The factory name.
    PrivateEndpointConnectionName string
    The private endpoint connection name.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    FactoryName string
    The factory name.
    PrivateEndpointConnectionName string
    The private endpoint connection name.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    factory_name string
    The factory name.
    private_endpoint_connection_name string
    The private endpoint connection name.
    resource_group_name string
    The name of the resource group. The name is case insensitive.
    factoryName String
    The factory name.
    privateEndpointConnectionName String
    The private endpoint connection name.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    factoryName string
    The factory name.
    privateEndpointConnectionName string
    The private endpoint connection name.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    factory_name str
    The factory name.
    private_endpoint_connection_name str
    The private endpoint connection name.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    factoryName String
    The factory name.
    privateEndpointConnectionName String
    The private endpoint connection name.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.

    getPrivateEndpointConnection Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    Etag string
    "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.")
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Name string
    The name of the resource
    Properties Pulumi.AzureNative.DataFactory.Outputs.RemotePrivateEndpointConnectionResponse
    Core resource properties
    SystemData Pulumi.AzureNative.DataFactory.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"
    AzureApiVersion string
    The Azure API version of the resource.
    Etag string
    "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.")
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Name string
    The name of the resource
    Properties RemotePrivateEndpointConnectionResponse
    Core 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"
    azure_api_version string
    The Azure API version of the resource.
    etag string
    "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.")
    id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name string
    The name of the resource
    properties object
    Core resource properties
    system_data object
    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"
    azureApiVersion String
    The Azure API version of the resource.
    etag String
    "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.")
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name String
    The name of the resource
    properties RemotePrivateEndpointConnectionResponse
    Core 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"
    azureApiVersion string
    The Azure API version of the resource.
    etag string
    "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.")
    id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name string
    The name of the resource
    properties RemotePrivateEndpointConnectionResponse
    Core 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"
    azure_api_version str
    The Azure API version of the resource.
    etag str
    "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.")
    id str
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name str
    The name of the resource
    properties RemotePrivateEndpointConnectionResponse
    Core 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"
    azureApiVersion String
    The Azure API version of the resource.
    etag String
    "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.")
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name String
    The name of the resource
    properties Property Map
    Core 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

    ArmIdWrapperResponse

    Id string
    Id string
    id string
    id String
    id string
    id str
    id String

    PrivateLinkConnectionStateResponse

    ActionsRequired string
    ActionsRequired for a private link connection
    Description string
    Description of a private link connection
    Status string
    Status of a private link connection
    ActionsRequired string
    ActionsRequired for a private link connection
    Description string
    Description of a private link connection
    Status string
    Status of a private link connection
    actions_required string
    ActionsRequired for a private link connection
    description string
    Description of a private link connection
    status string
    Status of a private link connection
    actionsRequired String
    ActionsRequired for a private link connection
    description String
    Description of a private link connection
    status String
    Status of a private link connection
    actionsRequired string
    ActionsRequired for a private link connection
    description string
    Description of a private link connection
    status string
    Status of a private link connection
    actions_required str
    ActionsRequired for a private link connection
    description str
    Description of a private link connection
    status str
    Status of a private link connection
    actionsRequired String
    ActionsRequired for a private link connection
    description String
    Description of a private link connection
    status String
    Status of a private link connection

    RemotePrivateEndpointConnectionResponse

    ProvisioningState string
    PrivateEndpoint ArmIdWrapperResponse
    PrivateEndpoint of a remote private endpoint connection
    PrivateLinkServiceConnectionState PrivateLinkConnectionStateResponse
    The state of a private link connection
    provisioning_state string
    private_endpoint object
    PrivateEndpoint of a remote private endpoint connection
    private_link_service_connection_state object
    The state of a private link connection
    provisioningState String
    privateEndpoint ArmIdWrapperResponse
    PrivateEndpoint of a remote private endpoint connection
    privateLinkServiceConnectionState PrivateLinkConnectionStateResponse
    The state of a private link connection
    provisioningState string
    privateEndpoint ArmIdWrapperResponse
    PrivateEndpoint of a remote private endpoint connection
    privateLinkServiceConnectionState PrivateLinkConnectionStateResponse
    The state of a private link connection
    provisioning_state str
    private_endpoint ArmIdWrapperResponse
    PrivateEndpoint of a remote private endpoint connection
    private_link_service_connection_state PrivateLinkConnectionStateResponse
    The state of a private link connection
    provisioningState String
    privateEndpoint Property Map
    PrivateEndpoint of a remote private endpoint connection
    privateLinkServiceConnectionState Property Map
    The state of a private link connection

    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.
    created_at string
    The timestamp of resource creation (UTC).
    created_by string
    The identity that created the resource.
    created_by_type string
    The type of identity that created the resource.
    last_modified_at string
    The timestamp of resource last modification (UTC)
    last_modified_by string
    The identity that last modified the resource.
    last_modified_by_type 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
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
    Viewing docs for Azure Native v3.27.0
    published on Sunday, Aug 30, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-azure-native

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial