Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. offazure
  5. getPrivateEndpointConnection
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.offazure.getPrivateEndpointConnection

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
pulumi/pulumi-azure-native

    REST model used to encapsulate the user visible state of a PrivateEndpoint. Azure REST API version: 2020-07-07.

    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>
    def get_private_endpoint_connection(pe_connection_name: Optional[str] = None,
                                    resource_group_name: Optional[str] = None,
                                    site_name: Optional[str] = None,
                                    opts: Optional[InvokeOptions] = None) -> GetPrivateEndpointConnectionResult
def get_private_endpoint_connection_output(pe_connection_name: Optional[pulumi.Input[str]] = None,
                                    resource_group_name: Optional[pulumi.Input[str]] = None,
                                    site_name: Optional[pulumi.Input[str]] = None,
                                    opts: Optional[InvokeOptions] = None) -> Output[GetPrivateEndpointConnectionResult]
    func LookupPrivateEndpointConnection(ctx *Context, args *LookupPrivateEndpointConnectionArgs, opts ...InvokeOption) (*LookupPrivateEndpointConnectionResult, error)
func LookupPrivateEndpointConnectionOutput(ctx *Context, args *LookupPrivateEndpointConnectionOutputArgs, opts ...InvokeOption) LookupPrivateEndpointConnectionResultOutput

    > 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)
}
    public static CompletableFuture<GetPrivateEndpointConnectionResult> getPrivateEndpointConnection(GetPrivateEndpointConnectionArgs args, InvokeOptions options)
public static Output<GetPrivateEndpointConnectionResult> getPrivateEndpointConnection(GetPrivateEndpointConnectionArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:offazure:getPrivateEndpointConnection
  arguments:
    # arguments dictionary

    The following arguments are supported:

    PeConnectionName string
    Private link resource name.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    SiteName string
    Site name.
    PeConnectionName string
    Private link resource name.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    SiteName string
    Site name.
    peConnectionName String
    Private link resource name.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    siteName String
    Site name.
    peConnectionName string
    Private link resource name.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    siteName string
    Site name.
    pe_connection_name str
    Private link resource name.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    site_name str
    Site name.
    peConnectionName String
    Private link resource name.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    siteName String
    Site name.

    getPrivateEndpointConnection Result

    The following output properties are available:

    ETag string
    Gets the tag for optimistic concurrency control.
    Id string
    Relative URL to get this Sites.
    Name string
    Gets the name of the resource.
    Properties Pulumi.AzureNative.OffAzure.Outputs.PrivateEndpointConnectionPropertiesResponse
    Gets the properties of the object.
    SystemData Pulumi.AzureNative.OffAzure.Outputs.SystemDataResponse
    Metadata pertaining to creation and last modification of the resource.
    Type string
    Gets the resource type.
    ETag string
    Gets the tag for optimistic concurrency control.
    Id string
    Relative URL to get this Sites.
    Name string
    Gets the name of the resource.
    Properties PrivateEndpointConnectionPropertiesResponse
    Gets the properties of the object.
    SystemData SystemDataResponse
    Metadata pertaining to creation and last modification of the resource.
    Type string
    Gets the resource type.
    eTag String
    Gets the tag for optimistic concurrency control.
    id String
    Relative URL to get this Sites.
    name String
    Gets the name of the resource.
    properties PrivateEndpointConnectionPropertiesResponse
    Gets the properties of the object.
    systemData SystemDataResponse
    Metadata pertaining to creation and last modification of the resource.
    type String
    Gets the resource type.
    eTag string
    Gets the tag for optimistic concurrency control.
    id string
    Relative URL to get this Sites.
    name string
    Gets the name of the resource.
    properties PrivateEndpointConnectionPropertiesResponse
    Gets the properties of the object.
    systemData SystemDataResponse
    Metadata pertaining to creation and last modification of the resource.
    type string
    Gets the resource type.
    e_tag str
    Gets the tag for optimistic concurrency control.
    id str
    Relative URL to get this Sites.
    name str
    Gets the name of the resource.
    properties PrivateEndpointConnectionPropertiesResponse
    Gets the properties of the object.
    system_data SystemDataResponse
    Metadata pertaining to creation and last modification of the resource.
    type str
    Gets the resource type.
    eTag String
    Gets the tag for optimistic concurrency control.
    id String
    Relative URL to get this Sites.
    name String
    Gets the name of the resource.
    properties Property Map
    Gets the properties of the object.
    systemData Property Map
    Metadata pertaining to creation and last modification of the resource.
    type String
    Gets the resource type.

    Supporting Types

    PrivateEndpointConnectionPropertiesResponse

    PrivateLinkServiceConnectionStateResponse

    ActionsRequired string
    actions required
    Description string
    description string
    Status string
    state status
    ActionsRequired string
    actions required
    Description string
    description string
    Status string
    state status
    actionsRequired String
    actions required
    description String
    description string
    status String
    state status
    actionsRequired string
    actions required
    description string
    description string
    status string
    state status
    actions_required str
    actions required
    description str
    description string
    status str
    state status
    actionsRequired String
    actions required
    description String
    description string
    status String
    state status

    ResourceIdResponse

    Id string
    id name
    Id string
    id name
    id String
    id name
    id string
    id name
    id str
    id name
    id String
    id name

    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
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
    pulumi/pulumi-azure-native