azure-native.search.getPrivateEndpointConnection

Azure Native v3.16.0, Mar 20 26

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.16.0
published on Friday, Mar 20, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-azure-native

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.16.0
published on Friday, Mar 20, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-azure-native

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>

def get_private_endpoint_connection(private_endpoint_connection_name: Optional[str] = None,
                                    resource_group_name: Optional[str] = None,
                                    search_service_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,
                                    search_service_name: Optional[pulumi.Input[str]] = None,
                                    opts: Optional[InvokeOptions] = 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 CompletableFuture<GetPrivateEndpointConnectionResult> getPrivateEndpointConnection(GetPrivateEndpointConnectionArgs args, InvokeOptions options)
public static Output<GetPrivateEndpointConnectionResult> getPrivateEndpointConnection(GetPrivateEndpointConnectionArgs args, InvokeOptions options)

fn::invoke:
  function: azure-native:search:getPrivateEndpointConnection
  arguments:
    # arguments dictionary

The following arguments are supported:

PrivateEndpointConnectionName string: The name of the private endpoint connection to the Azure AI Search service with the specified resource group.
ResourceGroupName string: The name of the resource group. The name is case insensitive.
SearchServiceName string: The name of the Azure AI Search service associated with the specified resource group.

PrivateEndpointConnectionName string: The name of the private endpoint connection to the Azure AI Search service with the specified resource group.
ResourceGroupName string: The name of the resource group. The name is case insensitive.
SearchServiceName string: The name of the Azure AI Search service associated with the specified resource group.

privateEndpointConnectionName String: The name of the private endpoint connection to the Azure AI Search service with the specified resource group.
resourceGroupName String: The name of the resource group. The name is case insensitive.
searchServiceName String: The name of the Azure AI Search service associated with the specified resource group.

privateEndpointConnectionName string: The name of the private endpoint connection to the Azure AI Search service with the specified resource group.
resourceGroupName string: The name of the resource group. The name is case insensitive.
searchServiceName string: The name of the Azure AI Search service associated with the specified resource group.

private_endpoint_connection_name str: The name of the private endpoint connection to the Azure AI Search service with the specified resource group.
resource_group_name str: The name of the resource group. The name is case insensitive.
search_service_name str: The name of the Azure AI Search service associated with the specified resource group.

privateEndpointConnectionName String: The name of the private endpoint connection to the Azure AI Search service with the specified resource group.
resourceGroupName String: The name of the resource group. The name is case insensitive.
searchServiceName String: The name of the Azure AI Search service associated with the specified resource group.

getPrivateEndpointConnection Result

The following output properties are available:

AzureApiVersion string: The Azure API version of the resource.
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.Search.Outputs.PrivateEndpointConnectionPropertiesResponse: Describes the properties of an existing private endpoint connection to the Azure AI Search service.
SystemData Pulumi.AzureNative.Search.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.
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 PrivateEndpointConnectionPropertiesResponse: Describes the properties of an existing private endpoint connection to the Azure AI Search service.
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.
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 PrivateEndpointConnectionPropertiesResponse: Describes the properties of an existing private endpoint connection to the Azure AI Search service.
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.
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 PrivateEndpointConnectionPropertiesResponse: Describes the properties of an existing private endpoint connection to the Azure AI Search service.
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.
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 PrivateEndpointConnectionPropertiesResponse: Describes the properties of an existing private endpoint connection to the Azure AI Search service.
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.
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: Describes the properties of an existing private endpoint connection to the Azure AI Search service.
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

PrivateEndpointConnectionPropertiesPrivateEndpointResponse

Id string: The resource ID of the private endpoint resource from Microsoft.Network provider.

Id string: The resource ID of the private endpoint resource from Microsoft.Network provider.

id String: The resource ID of the private endpoint resource from Microsoft.Network provider.

id string: The resource ID of the private endpoint resource from Microsoft.Network provider.

id str: The resource ID of the private endpoint resource from Microsoft.Network provider.

id String: The resource ID of the private endpoint resource from Microsoft.Network provider.

PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionStateResponse

ActionsRequired string: A description of any extra actions that may be required.
Description string: The description for the private link service connection state.
Status string: Status of the the private link service connection. Valid values are Pending, Approved, Rejected, or Disconnected.

ActionsRequired string: A description of any extra actions that may be required.
Description string: The description for the private link service connection state.
Status string: Status of the the private link service connection. Valid values are Pending, Approved, Rejected, or Disconnected.

actionsRequired String: A description of any extra actions that may be required.
description String: The description for the private link service connection state.
status String: Status of the the private link service connection. Valid values are Pending, Approved, Rejected, or Disconnected.

actionsRequired string: A description of any extra actions that may be required.
description string: The description for the private link service connection state.
status string: Status of the the private link service connection. Valid values are Pending, Approved, Rejected, or Disconnected.

actions_required str: A description of any extra actions that may be required.
description str: The description for the private link service connection state.
status str: Status of the the private link service connection. Valid values are Pending, Approved, Rejected, or Disconnected.

actionsRequired String: A description of any extra actions that may be required.
description String: The description for the private link service connection state.
status String: Status of the the private link service connection. Valid values are Pending, Approved, Rejected, or Disconnected.

PrivateEndpointConnectionPropertiesResponse

GroupId string: The group ID of the Azure resource for which the private link service is for.
PrivateEndpoint Pulumi.AzureNative.Search.Inputs.PrivateEndpointConnectionPropertiesPrivateEndpointResponse: The private endpoint resource from Microsoft.Network provider.
PrivateLinkServiceConnectionState Pulumi.AzureNative.Search.Inputs.PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionStateResponse: Describes the current state of an existing Azure Private Link service connection to the private endpoint.
ProvisioningState string: The provisioning state of the private link service connection. Valid values are Updating, Deleting, Failed, Succeeded, Incomplete, or Canceled.

GroupId string: The group ID of the Azure resource for which the private link service is for.
PrivateEndpoint PrivateEndpointConnectionPropertiesPrivateEndpointResponse: The private endpoint resource from Microsoft.Network provider.
PrivateLinkServiceConnectionState PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionStateResponse: Describes the current state of an existing Azure Private Link service connection to the private endpoint.
ProvisioningState string: The provisioning state of the private link service connection. Valid values are Updating, Deleting, Failed, Succeeded, Incomplete, or Canceled.

groupId String: The group ID of the Azure resource for which the private link service is for.
privateEndpoint PrivateEndpointConnectionPropertiesPrivateEndpointResponse: The private endpoint resource from Microsoft.Network provider.
privateLinkServiceConnectionState PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionStateResponse: Describes the current state of an existing Azure Private Link service connection to the private endpoint.
provisioningState String: The provisioning state of the private link service connection. Valid values are Updating, Deleting, Failed, Succeeded, Incomplete, or Canceled.

groupId string: The group ID of the Azure resource for which the private link service is for.
privateEndpoint PrivateEndpointConnectionPropertiesPrivateEndpointResponse: The private endpoint resource from Microsoft.Network provider.
privateLinkServiceConnectionState PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionStateResponse: Describes the current state of an existing Azure Private Link service connection to the private endpoint.
provisioningState string: The provisioning state of the private link service connection. Valid values are Updating, Deleting, Failed, Succeeded, Incomplete, or Canceled.

group_id str: The group ID of the Azure resource for which the private link service is for.
private_endpoint PrivateEndpointConnectionPropertiesPrivateEndpointResponse: The private endpoint resource from Microsoft.Network provider.
private_link_service_connection_state PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionStateResponse: Describes the current state of an existing Azure Private Link service connection to the private endpoint.
provisioning_state str: The provisioning state of the private link service connection. Valid values are Updating, Deleting, Failed, Succeeded, Incomplete, or Canceled.

groupId String: The group ID of the Azure resource for which the private link service is for.
privateEndpoint Property Map: The private endpoint resource from Microsoft.Network provider.
privateLinkServiceConnectionState Property Map: Describes the current state of an existing Azure Private Link service connection to the private endpoint.
provisioningState String: The provisioning state of the private link service connection. Valid values are Updating, Deleting, Failed, Succeeded, Incomplete, or Canceled.

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.