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

Get Private Endpoint Connection. This call is made by Backup Admin.

Uses Azure REST API version 2024-10-01.

Other available API versions: 2023-02-01, 2023-04-01, 2023-06-01, 2023-08-01, 2024-01-01, 2024-02-01, 2024-04-01, 2024-04-30-preview, 2024-07-30-preview, 2024-11-01-preview, 2025-01-01, 2025-02-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native recoveryservices [ApiVersion]. See the version guide for details.

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:recoveryservices: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 where the recovery services vault is present.
VaultName
This property is required.
Changes to this property will trigger replacement.
string
The name of the recovery services vault.
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 where the recovery services vault is present.
VaultName
This property is required.
Changes to this property will trigger replacement.
string
The name of the recovery services vault.
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 where the recovery services vault is present.
vaultName
This property is required.
Changes to this property will trigger replacement.
String
The name of the recovery services vault.
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 where the recovery services vault is present.
vaultName
This property is required.
Changes to this property will trigger replacement.
string
The name of the recovery services vault.
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 where the recovery services vault is present.
vault_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the recovery services vault.
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 where the recovery services vault is present.
vaultName
This property is required.
Changes to this property will trigger replacement.
String
The name of the recovery services vault.

getPrivateEndpointConnection Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
Id string
Resource Id represents the complete path to the resource.
Name string
Resource name associated with the resource.
Properties Pulumi.AzureNative.RecoveryServices.Outputs.PrivateEndpointConnectionResponse
PrivateEndpointConnectionResource properties
Type string
Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...
ETag string
Optional ETag.
Location string
Resource location.
Tags Dictionary<string, string>
Resource tags.
AzureApiVersion string
The Azure API version of the resource.
Id string
Resource Id represents the complete path to the resource.
Name string
Resource name associated with the resource.
Properties PrivateEndpointConnectionResponse
PrivateEndpointConnectionResource properties
Type string
Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...
ETag string
Optional ETag.
Location string
Resource location.
Tags map[string]string
Resource tags.
azureApiVersion String
The Azure API version of the resource.
id String
Resource Id represents the complete path to the resource.
name String
Resource name associated with the resource.
properties PrivateEndpointConnectionResponse
PrivateEndpointConnectionResource properties
type String
Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...
eTag String
Optional ETag.
location String
Resource location.
tags Map<String,String>
Resource tags.
azureApiVersion string
The Azure API version of the resource.
id string
Resource Id represents the complete path to the resource.
name string
Resource name associated with the resource.
properties PrivateEndpointConnectionResponse
PrivateEndpointConnectionResource properties
type string
Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...
eTag string
Optional ETag.
location string
Resource location.
tags {[key: string]: string}
Resource tags.
azure_api_version str
The Azure API version of the resource.
id str
Resource Id represents the complete path to the resource.
name str
Resource name associated with the resource.
properties PrivateEndpointConnectionResponse
PrivateEndpointConnectionResource properties
type str
Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...
e_tag str
Optional ETag.
location str
Resource location.
tags Mapping[str, str]
Resource tags.
azureApiVersion String
The Azure API version of the resource.
id String
Resource Id represents the complete path to the resource.
name String
Resource name associated with the resource.
properties Property Map
PrivateEndpointConnectionResource properties
type String
Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...
eTag String
Optional ETag.
location String
Resource location.
tags Map<String>
Resource tags.

Supporting Types

PrivateEndpointConnectionResponse

GroupIds List<string>
Group Ids for the Private Endpoint
PrivateEndpoint Pulumi.AzureNative.RecoveryServices.Inputs.PrivateEndpointResponse
Gets or sets private endpoint associated with the private endpoint connection
PrivateLinkServiceConnectionState Pulumi.AzureNative.RecoveryServices.Inputs.PrivateLinkServiceConnectionStateResponse
Gets or sets private link service connection state
ProvisioningState string
Gets or sets provisioning state of the private endpoint connection
GroupIds []string
Group Ids for the Private Endpoint
PrivateEndpoint PrivateEndpointResponse
Gets or sets private endpoint associated with the private endpoint connection
PrivateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse
Gets or sets private link service connection state
ProvisioningState string
Gets or sets provisioning state of the private endpoint connection
groupIds List<String>
Group Ids for the Private Endpoint
privateEndpoint PrivateEndpointResponse
Gets or sets private endpoint associated with the private endpoint connection
privateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse
Gets or sets private link service connection state
provisioningState String
Gets or sets provisioning state of the private endpoint connection
groupIds string[]
Group Ids for the Private Endpoint
privateEndpoint PrivateEndpointResponse
Gets or sets private endpoint associated with the private endpoint connection
privateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse
Gets or sets private link service connection state
provisioningState string
Gets or sets provisioning state of the private endpoint connection
group_ids Sequence[str]
Group Ids for the Private Endpoint
private_endpoint PrivateEndpointResponse
Gets or sets private endpoint associated with the private endpoint connection
private_link_service_connection_state PrivateLinkServiceConnectionStateResponse
Gets or sets private link service connection state
provisioning_state str
Gets or sets provisioning state of the private endpoint connection
groupIds List<String>
Group Ids for the Private Endpoint
privateEndpoint Property Map
Gets or sets private endpoint associated with the private endpoint connection
privateLinkServiceConnectionState Property Map
Gets or sets private link service connection state
provisioningState String
Gets or sets provisioning state of the private endpoint connection

PrivateEndpointResponse

Id This property is required. string
Gets or sets id.
Id This property is required. string
Gets or sets id.
id This property is required. String
Gets or sets id.
id This property is required. string
Gets or sets id.
id This property is required. str
Gets or sets id.
id This property is required. String
Gets or sets 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

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