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

azure-native.migrate.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.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

Get information related to a specific private endpoint connection in the project. Returns a json object of type ‘privateEndpointConnections’ as specified in the models section.

Uses Azure REST API version 2019-10-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?: InvokeOptions): Output<GetPrivateEndpointConnectionResult>
Copy
def get_private_endpoint_connection(private_endpoint_connection_name: Optional[str] = None,
                                    project_name: Optional[str] = None,
                                    resource_group_name: Optional[str] = None,
                                    opts: Optional[InvokeOptions] = None) -> GetPrivateEndpointConnectionResult
def get_private_endpoint_connection_output(private_endpoint_connection_name: Optional[pulumi.Input[str]] = None,
                                    project_name: Optional[pulumi.Input[str]] = None,
                                    resource_group_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:migrate:getPrivateEndpointConnection
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

PrivateEndpointConnectionName
This property is required.
Changes to this property will trigger replacement.
string
Unique name of a private endpoint connection within a project.
ProjectName
This property is required.
Changes to this property will trigger replacement.
string
Name of the Azure Migrate project.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the Azure Resource Group that project is part of.
PrivateEndpointConnectionName
This property is required.
Changes to this property will trigger replacement.
string
Unique name of a private endpoint connection within a project.
ProjectName
This property is required.
Changes to this property will trigger replacement.
string
Name of the Azure Migrate project.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the Azure Resource Group that project is part of.
privateEndpointConnectionName
This property is required.
Changes to this property will trigger replacement.
String
Unique name of a private endpoint connection within a project.
projectName
This property is required.
Changes to this property will trigger replacement.
String
Name of the Azure Migrate project.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of the Azure Resource Group that project is part of.
privateEndpointConnectionName
This property is required.
Changes to this property will trigger replacement.
string
Unique name of a private endpoint connection within a project.
projectName
This property is required.
Changes to this property will trigger replacement.
string
Name of the Azure Migrate project.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the Azure Resource Group that project is part of.
private_endpoint_connection_name
This property is required.
Changes to this property will trigger replacement.
str
Unique name of a private endpoint connection within a project.
project_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the Azure Migrate project.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the Azure Resource Group that project is part of.
privateEndpointConnectionName
This property is required.
Changes to this property will trigger replacement.
String
Unique name of a private endpoint connection within a project.
projectName
This property is required.
Changes to this property will trigger replacement.
String
Name of the Azure Migrate project.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of the Azure Resource Group that project is part of.

getPrivateEndpointConnection Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
Id string
Path reference to this private endpoint endpoint connection. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/privateEndpointConnections/{privateEndpointConnectionName}
Name string
Name of the private endpoint endpoint connection.
Properties Pulumi.AzureNative.Migrate.Outputs.PrivateEndpointConnectionPropertiesResponse
Properties of the private endpoint endpoint connection.
Type string
Type of the object = [Microsoft.Migrate/assessmentProjects/privateEndpointConnections].
ETag string
For optimistic concurrency control.
AzureApiVersion string
The Azure API version of the resource.
Id string
Path reference to this private endpoint endpoint connection. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/privateEndpointConnections/{privateEndpointConnectionName}
Name string
Name of the private endpoint endpoint connection.
Properties PrivateEndpointConnectionPropertiesResponse
Properties of the private endpoint endpoint connection.
Type string
Type of the object = [Microsoft.Migrate/assessmentProjects/privateEndpointConnections].
ETag string
For optimistic concurrency control.
azureApiVersion String
The Azure API version of the resource.
id String
Path reference to this private endpoint endpoint connection. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/privateEndpointConnections/{privateEndpointConnectionName}
name String
Name of the private endpoint endpoint connection.
properties PrivateEndpointConnectionPropertiesResponse
Properties of the private endpoint endpoint connection.
type String
Type of the object = [Microsoft.Migrate/assessmentProjects/privateEndpointConnections].
eTag String
For optimistic concurrency control.
azureApiVersion string
The Azure API version of the resource.
id string
Path reference to this private endpoint endpoint connection. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/privateEndpointConnections/{privateEndpointConnectionName}
name string
Name of the private endpoint endpoint connection.
properties PrivateEndpointConnectionPropertiesResponse
Properties of the private endpoint endpoint connection.
type string
Type of the object = [Microsoft.Migrate/assessmentProjects/privateEndpointConnections].
eTag string
For optimistic concurrency control.
azure_api_version str
The Azure API version of the resource.
id str
Path reference to this private endpoint endpoint connection. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/privateEndpointConnections/{privateEndpointConnectionName}
name str
Name of the private endpoint endpoint connection.
properties PrivateEndpointConnectionPropertiesResponse
Properties of the private endpoint endpoint connection.
type str
Type of the object = [Microsoft.Migrate/assessmentProjects/privateEndpointConnections].
e_tag str
For optimistic concurrency control.
azureApiVersion String
The Azure API version of the resource.
id String
Path reference to this private endpoint endpoint connection. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/privateEndpointConnections/{privateEndpointConnectionName}
name String
Name of the private endpoint endpoint connection.
properties Property Map
Properties of the private endpoint endpoint connection.
type String
Type of the object = [Microsoft.Migrate/assessmentProjects/privateEndpointConnections].
eTag String
For optimistic concurrency control.

Supporting Types

PrivateEndpointConnectionPropertiesResponse

PrivateEndpoint This property is required. Pulumi.AzureNative.Migrate.Inputs.ResourceIdResponse
ARM id for the private endpoint resource corresponding to the connection.
ProvisioningState This property is required. string
Indicates whether there is an ongoing operation on the private endpoint.
PrivateLinkServiceConnectionState Pulumi.AzureNative.Migrate.Inputs.PrivateLinkServiceConnectionStateResponse
State of the private endpoint connection.
PrivateEndpoint This property is required. ResourceIdResponse
ARM id for the private endpoint resource corresponding to the connection.
ProvisioningState This property is required. string
Indicates whether there is an ongoing operation on the private endpoint.
PrivateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse
State of the private endpoint connection.
privateEndpoint This property is required. ResourceIdResponse
ARM id for the private endpoint resource corresponding to the connection.
provisioningState This property is required. String
Indicates whether there is an ongoing operation on the private endpoint.
privateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse
State of the private endpoint connection.
privateEndpoint This property is required. ResourceIdResponse
ARM id for the private endpoint resource corresponding to the connection.
provisioningState This property is required. string
Indicates whether there is an ongoing operation on the private endpoint.
privateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse
State of the private endpoint connection.
private_endpoint This property is required. ResourceIdResponse
ARM id for the private endpoint resource corresponding to the connection.
provisioning_state This property is required. str
Indicates whether there is an ongoing operation on the private endpoint.
private_link_service_connection_state PrivateLinkServiceConnectionStateResponse
State of the private endpoint connection.
privateEndpoint This property is required. Property Map
ARM id for the private endpoint resource corresponding to the connection.
provisioningState This property is required. String
Indicates whether there is an ongoing operation on the private endpoint.
privateLinkServiceConnectionState Property Map
State of the private endpoint connection.

PrivateLinkServiceConnectionStateResponse

ActionsRequired string
Actions required on the private endpoint connection.
Description string
Description of the private endpoint connection.
Status string
Connection status of the private endpoint connection.
ActionsRequired string
Actions required on the private endpoint connection.
Description string
Description of the private endpoint connection.
Status string
Connection status of the private endpoint connection.
actionsRequired String
Actions required on the private endpoint connection.
description String
Description of the private endpoint connection.
status String
Connection status of the private endpoint connection.
actionsRequired string
Actions required on the private endpoint connection.
description string
Description of the private endpoint connection.
status string
Connection status of the private endpoint connection.
actions_required str
Actions required on the private endpoint connection.
description str
Description of the private endpoint connection.
status str
Connection status of the private endpoint connection.
actionsRequired String
Actions required on the private endpoint connection.
description String
Description of the private endpoint connection.
status String
Connection status of the private endpoint connection.

ResourceIdResponse

Id This property is required. string
Id This property is required. string
id This property is required. String
id This property is required. string
id This property is required. str
id This property is required. String

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.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native