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

azure-native-v2.containerregistry.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.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Get the specified private endpoint connection associated with the container registry. Azure REST API version: 2022-12-01.

Other available API versions: 2023-01-01-preview, 2023-06-01-preview, 2023-07-01, 2023-08-01-preview, 2023-11-01-preview, 2024-11-01-preview.

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,
                                    registry_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,
                                    registry_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:containerregistry: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.
RegistryName
This property is required.
Changes to this property will trigger replacement.
string
The name of the container registry.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
PrivateEndpointConnectionName
This property is required.
Changes to this property will trigger replacement.
string
The name of the private endpoint connection.
RegistryName
This property is required.
Changes to this property will trigger replacement.
string
The name of the container registry.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
privateEndpointConnectionName
This property is required.
Changes to this property will trigger replacement.
String
The name of the private endpoint connection.
registryName
This property is required.
Changes to this property will trigger replacement.
String
The name of the container registry.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
privateEndpointConnectionName
This property is required.
Changes to this property will trigger replacement.
string
The name of the private endpoint connection.
registryName
This property is required.
Changes to this property will trigger replacement.
string
The name of the container registry.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
private_endpoint_connection_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the private endpoint connection.
registry_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the container registry.
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.
privateEndpointConnectionName
This property is required.
Changes to this property will trigger replacement.
String
The name of the private endpoint connection.
registryName
This property is required.
Changes to this property will trigger replacement.
String
The name of the container registry.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.

getPrivateEndpointConnection Result

The following output properties are available:

Id string
The resource ID.
Name string
The name of the resource.
ProvisioningState string
The provisioning state of private endpoint connection resource.
SystemData Pulumi.AzureNative.ContainerRegistry.Outputs.SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
Type string
The type of the resource.
PrivateEndpoint Pulumi.AzureNative.ContainerRegistry.Outputs.PrivateEndpointResponse
The resource of private endpoint.
PrivateLinkServiceConnectionState Pulumi.AzureNative.ContainerRegistry.Outputs.PrivateLinkServiceConnectionStateResponse
A collection of information about the state of the connection between service consumer and provider.
Id string
The resource ID.
Name string
The name of the resource.
ProvisioningState string
The provisioning state of private endpoint connection resource.
SystemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
Type string
The type of the resource.
PrivateEndpoint PrivateEndpointResponse
The resource of private endpoint.
PrivateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse
A collection of information about the state of the connection between service consumer and provider.
id String
The resource ID.
name String
The name of the resource.
provisioningState String
The provisioning state of private endpoint connection resource.
systemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type String
The type of the resource.
privateEndpoint PrivateEndpointResponse
The resource of private endpoint.
privateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse
A collection of information about the state of the connection between service consumer and provider.
id string
The resource ID.
name string
The name of the resource.
provisioningState string
The provisioning state of private endpoint connection resource.
systemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type string
The type of the resource.
privateEndpoint PrivateEndpointResponse
The resource of private endpoint.
privateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse
A collection of information about the state of the connection between service consumer and provider.
id str
The resource ID.
name str
The name of the resource.
provisioning_state str
The provisioning state of private endpoint connection resource.
system_data SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type str
The type of the resource.
private_endpoint PrivateEndpointResponse
The resource of private endpoint.
private_link_service_connection_state PrivateLinkServiceConnectionStateResponse
A collection of information about the state of the connection between service consumer and provider.
id String
The resource ID.
name String
The name of the resource.
provisioningState String
The provisioning state of private endpoint connection resource.
systemData Property Map
Metadata pertaining to creation and last modification of the resource.
type String
The type of the resource.
privateEndpoint Property Map
The resource of private endpoint.
privateLinkServiceConnectionState Property Map
A collection of information about the state of the connection between service consumer and provider.

Supporting Types

PrivateEndpointResponse

Id string
This is private endpoint resource created with Microsoft.Network resource provider.
Id string
This is private endpoint resource created with Microsoft.Network resource provider.
id String
This is private endpoint resource created with Microsoft.Network resource provider.
id string
This is private endpoint resource created with Microsoft.Network resource provider.
id str
This is private endpoint resource created with Microsoft.Network resource provider.
id String
This is private endpoint resource created with Microsoft.Network resource provider.

PrivateLinkServiceConnectionStateResponse

ActionsRequired string
A message indicating if changes on the service provider require any updates on the consumer.
Description string
The description for connection status. For example if connection is rejected it can indicate reason for rejection.
Status string
The private link service connection status.
ActionsRequired string
A message indicating if changes on the service provider require any updates on the consumer.
Description string
The description for connection status. For example if connection is rejected it can indicate reason for rejection.
Status string
The private link service connection status.
actionsRequired String
A message indicating if changes on the service provider require any updates on the consumer.
description String
The description for connection status. For example if connection is rejected it can indicate reason for rejection.
status String
The private link service connection status.
actionsRequired string
A message indicating if changes on the service provider require any updates on the consumer.
description string
The description for connection status. For example if connection is rejected it can indicate reason for rejection.
status string
The private link service connection status.
actions_required str
A message indicating if changes on the service provider require any updates on the consumer.
description str
The description for connection status. For example if connection is rejected it can indicate reason for rejection.
status str
The private link service connection status.
actionsRequired String
A message indicating if changes on the service provider require any updates on the consumer.
description String
The description for connection status. For example if connection is rejected it can indicate reason for rejection.
status String
The private link service connection 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 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 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 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 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 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 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-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.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native