Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. datareplication
  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.datareplication.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

Gets the private endpoint connection details.

Uses Azure REST API version 2024-09-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,
                                    resource_group_name: Optional[str] = None,
                                    vault_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,
                                    vault_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:datareplication:getPrivateEndpointConnection
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

PrivateEndpointConnectionName
This property is required.
Changes to this property will trigger replacement.
string
The private endpoint connection name.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
VaultName
This property is required.
Changes to this property will trigger replacement.
string
The vault name.
PrivateEndpointConnectionName
This property is required.
Changes to this property will trigger replacement.
string
The private endpoint connection name.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
VaultName
This property is required.
Changes to this property will trigger replacement.
string
The vault name.
privateEndpointConnectionName
This property is required.
Changes to this property will trigger replacement.
String
The private endpoint connection name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
vaultName
This property is required.
Changes to this property will trigger replacement.
String
The vault name.
privateEndpointConnectionName
This property is required.
Changes to this property will trigger replacement.
string
The private endpoint connection name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
vaultName
This property is required.
Changes to this property will trigger replacement.
string
The vault name.
private_endpoint_connection_name
This property is required.
Changes to this property will trigger replacement.
str
The private endpoint connection name.
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.
vault_name
This property is required.
Changes to this property will trigger replacement.
str
The vault name.
privateEndpointConnectionName
This property is required.
Changes to this property will trigger replacement.
String
The private endpoint connection name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
vaultName
This property is required.
Changes to this property will trigger replacement.
String
The vault name.

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.DataReplication.Outputs.PrivateEndpointConnectionResponsePropertiesResponse
The resource-specific properties for this resource.
SystemData Pulumi.AzureNative.DataReplication.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 PrivateEndpointConnectionResponsePropertiesResponse
The resource-specific properties for this resource.
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 PrivateEndpointConnectionResponsePropertiesResponse
The resource-specific properties for this resource.
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 PrivateEndpointConnectionResponsePropertiesResponse
The resource-specific properties for this resource.
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 PrivateEndpointConnectionResponsePropertiesResponse
The resource-specific properties for this resource.
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
The resource-specific properties for this resource.
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

PrivateEndpointConnectionResponsePropertiesResponse

ProvisioningState This property is required. string
Gets or sets provisioning state of the private endpoint connection.
PrivateEndpoint Pulumi.AzureNative.DataReplication.Inputs.PrivateEndpointResponse
Represent private Endpoint network resource that is linked to the Private Endpoint connection.
PrivateLinkServiceConnectionState Pulumi.AzureNative.DataReplication.Inputs.PrivateLinkServiceConnectionStateResponse
Represents Private link service connection state.
ProvisioningState This property is required. string
Gets or sets provisioning state of the private endpoint connection.
PrivateEndpoint PrivateEndpointResponse
Represent private Endpoint network resource that is linked to the Private Endpoint connection.
PrivateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse
Represents Private link service connection state.
provisioningState This property is required. String
Gets or sets provisioning state of the private endpoint connection.
privateEndpoint PrivateEndpointResponse
Represent private Endpoint network resource that is linked to the Private Endpoint connection.
privateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse
Represents Private link service connection state.
provisioningState This property is required. string
Gets or sets provisioning state of the private endpoint connection.
privateEndpoint PrivateEndpointResponse
Represent private Endpoint network resource that is linked to the Private Endpoint connection.
privateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse
Represents Private link service connection state.
provisioning_state This property is required. str
Gets or sets provisioning state of the private endpoint connection.
private_endpoint PrivateEndpointResponse
Represent private Endpoint network resource that is linked to the Private Endpoint connection.
private_link_service_connection_state PrivateLinkServiceConnectionStateResponse
Represents Private link service connection state.
provisioningState This property is required. String
Gets or sets provisioning state of the private endpoint connection.
privateEndpoint Property Map
Represent private Endpoint network resource that is linked to the Private Endpoint connection.
privateLinkServiceConnectionState Property Map
Represents Private link service connection state.

PrivateEndpointResponse

Id string
Gets or sets the id.
Id string
Gets or sets the id.
id String
Gets or sets the id.
id string
Gets or sets the id.
id str
Gets or sets the id.
id String
Gets or sets the id.

PrivateLinkServiceConnectionStateResponse

ActionsRequired string
Gets or sets actions required.
Description string
Gets or sets description.
Status string
Gets or sets the status.
ActionsRequired string
Gets or sets actions required.
Description string
Gets or sets description.
Status string
Gets or sets the status.
actionsRequired String
Gets or sets actions required.
description String
Gets or sets description.
status String
Gets or sets the status.
actionsRequired string
Gets or sets actions required.
description string
Gets or sets description.
status string
Gets or sets the status.
actions_required str
Gets or sets actions required.
description str
Gets or sets description.
status str
Gets or sets the status.
actionsRequired String
Gets or sets actions required.
description String
Gets or sets description.
status String
Gets or sets the 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 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