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

Uses Azure REST API version 2023-05-15-preview.

Other available API versions: 2020-01-13-preview, 2024-10-23. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native automation [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(automation_account_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(automation_account_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:automation:getPrivateEndpointConnection
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

AutomationAccountName
This property is required.
Changes to this property will trigger replacement.
string
The name of the automation account.
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
Name of an Azure Resource group.
AutomationAccountName
This property is required.
Changes to this property will trigger replacement.
string
The name of the automation account.
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
Name of an Azure Resource group.
automationAccountName
This property is required.
Changes to this property will trigger replacement.
String
The name of the automation account.
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
Name of an Azure Resource group.
automationAccountName
This property is required.
Changes to this property will trigger replacement.
string
The name of the automation account.
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
Name of an Azure Resource group.
automation_account_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the automation account.
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
Name of an Azure Resource group.
automationAccountName
This property is required.
Changes to this property will trigger replacement.
String
The name of the automation account.
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
Name of an Azure Resource group.

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
SystemData Pulumi.AzureNative.Automation.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"
GroupIds List<string>
Gets the groupIds.
PrivateEndpoint Pulumi.AzureNative.Automation.Outputs.PrivateEndpointPropertyResponse
Private endpoint which the connection belongs to.
PrivateLinkServiceConnectionState Pulumi.AzureNative.Automation.Outputs.PrivateLinkServiceConnectionStatePropertyResponse
Connection State of the Private Endpoint Connection.
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
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"
GroupIds []string
Gets the groupIds.
PrivateEndpoint PrivateEndpointPropertyResponse
Private endpoint which the connection belongs to.
PrivateLinkServiceConnectionState PrivateLinkServiceConnectionStatePropertyResponse
Connection State of the Private Endpoint Connection.
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
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"
groupIds List<String>
Gets the groupIds.
privateEndpoint PrivateEndpointPropertyResponse
Private endpoint which the connection belongs to.
privateLinkServiceConnectionState PrivateLinkServiceConnectionStatePropertyResponse
Connection State of the Private Endpoint Connection.
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
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"
groupIds string[]
Gets the groupIds.
privateEndpoint PrivateEndpointPropertyResponse
Private endpoint which the connection belongs to.
privateLinkServiceConnectionState PrivateLinkServiceConnectionStatePropertyResponse
Connection State of the Private Endpoint Connection.
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
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"
group_ids Sequence[str]
Gets the groupIds.
private_endpoint PrivateEndpointPropertyResponse
Private endpoint which the connection belongs to.
private_link_service_connection_state PrivateLinkServiceConnectionStatePropertyResponse
Connection State of the Private Endpoint Connection.
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
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"
groupIds List<String>
Gets the groupIds.
privateEndpoint Property Map
Private endpoint which the connection belongs to.
privateLinkServiceConnectionState Property Map
Connection State of the Private Endpoint Connection.

Supporting Types

PrivateEndpointPropertyResponse

Id string
Resource id of the private endpoint.
Id string
Resource id of the private endpoint.
id String
Resource id of the private endpoint.
id string
Resource id of the private endpoint.
id str
Resource id of the private endpoint.
id String
Resource id of the private endpoint.

PrivateLinkServiceConnectionStatePropertyResponse

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.

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