Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. appconfiguration
  5. getPrivateEndpointConnection
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.82.0 published on Friday, Jan 10, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.appconfiguration.getPrivateEndpointConnection

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.82.0 published on Friday, Jan 10, 2025 by Pulumi
pulumi/pulumi-azure-native

Gets the specified private endpoint connection associated with the configuration store. Azure REST API version: 2023-03-01.

Other available API versions: 2023-08-01-preview, 2023-09-01-preview, 2024-05-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(config_store_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(config_store_name: Optional[pulumi.Input[str]] = None,
                                    private_endpoint_connection_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:appconfiguration:getPrivateEndpointConnection
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ConfigStoreName
This property is required.
Changes to this property will trigger replacement.
string
The name of the configuration store.
PrivateEndpointConnectionName
This property is required.
Changes to this property will trigger replacement.
string
Private endpoint connection name
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group to which the container registry belongs.
ConfigStoreName
This property is required.
Changes to this property will trigger replacement.
string
The name of the configuration store.
PrivateEndpointConnectionName
This property is required.
Changes to this property will trigger replacement.
string
Private endpoint connection name
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group to which the container registry belongs.
configStoreName
This property is required.
Changes to this property will trigger replacement.
String
The name of the configuration store.
privateEndpointConnectionName
This property is required.
Changes to this property will trigger replacement.
String
Private endpoint connection name
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group to which the container registry belongs.
configStoreName
This property is required.
Changes to this property will trigger replacement.
string
The name of the configuration store.
privateEndpointConnectionName
This property is required.
Changes to this property will trigger replacement.
string
Private endpoint connection name
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group to which the container registry belongs.
config_store_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the configuration store.
private_endpoint_connection_name
This property is required.
Changes to this property will trigger replacement.
str
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 to which the container registry belongs.
configStoreName
This property is required.
Changes to this property will trigger replacement.
String
The name of the configuration store.
privateEndpointConnectionName
This property is required.
Changes to this property will trigger replacement.
String
Private endpoint connection name
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group to which the container registry belongs.

getPrivateEndpointConnection Result

The following output properties are available:

Id string
The resource ID.
Name string
The name of the resource.
PrivateLinkServiceConnectionState Pulumi.AzureNative.AppConfiguration.Outputs.PrivateLinkServiceConnectionStateResponse
A collection of information about the state of the connection between service consumer and provider.
ProvisioningState string
The provisioning status of the private endpoint connection.
Type string
The type of the resource.
PrivateEndpoint Pulumi.AzureNative.AppConfiguration.Outputs.PrivateEndpointResponse
The resource of private endpoint.
Id string
The resource ID.
Name string
The name of the resource.
PrivateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse
A collection of information about the state of the connection between service consumer and provider.
ProvisioningState string
The provisioning status of the private endpoint connection.
Type string
The type of the resource.
PrivateEndpoint PrivateEndpointResponse
The resource of private endpoint.
id String
The resource ID.
name String
The name of the resource.
privateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse
A collection of information about the state of the connection between service consumer and provider.
provisioningState String
The provisioning status of the private endpoint connection.
type String
The type of the resource.
privateEndpoint PrivateEndpointResponse
The resource of private endpoint.
id string
The resource ID.
name string
The name of the resource.
privateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse
A collection of information about the state of the connection between service consumer and provider.
provisioningState string
The provisioning status of the private endpoint connection.
type string
The type of the resource.
privateEndpoint PrivateEndpointResponse
The resource of private endpoint.
id str
The resource ID.
name str
The name of the resource.
private_link_service_connection_state PrivateLinkServiceConnectionStateResponse
A collection of information about the state of the connection between service consumer and provider.
provisioning_state str
The provisioning status of the private endpoint connection.
type str
The type of the resource.
private_endpoint PrivateEndpointResponse
The resource of private endpoint.
id String
The resource ID.
name String
The name of the resource.
privateLinkServiceConnectionState Property Map
A collection of information about the state of the connection between service consumer and provider.
provisioningState String
The provisioning status of the private endpoint connection.
type String
The type of the resource.
privateEndpoint Property Map
The resource of private endpoint.

Supporting Types

PrivateEndpointResponse

Id string
The resource Id for private endpoint
Id string
The resource Id for private endpoint
id String
The resource Id for private endpoint
id string
The resource Id for private endpoint
id str
The resource Id for private endpoint
id String
The resource Id for private endpoint

PrivateLinkServiceConnectionStateResponse

ActionsRequired This property is required. string
Any action that is required beyond basic workflow (approve/ reject/ disconnect)
Description string
The private link service connection description.
Status string
The private link service connection status.
ActionsRequired This property is required. string
Any action that is required beyond basic workflow (approve/ reject/ disconnect)
Description string
The private link service connection description.
Status string
The private link service connection status.
actionsRequired This property is required. String
Any action that is required beyond basic workflow (approve/ reject/ disconnect)
description String
The private link service connection description.
status String
The private link service connection status.
actionsRequired This property is required. string
Any action that is required beyond basic workflow (approve/ reject/ disconnect)
description string
The private link service connection description.
status string
The private link service connection status.
actions_required This property is required. str
Any action that is required beyond basic workflow (approve/ reject/ disconnect)
description str
The private link service connection description.
status str
The private link service connection status.
actionsRequired This property is required. String
Any action that is required beyond basic workflow (approve/ reject/ disconnect)
description String
The private link service connection description.
status String
The private link service connection status.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.82.0 published on Friday, Jan 10, 2025 by Pulumi
pulumi/pulumi-azure-native