1. Packages
  2. Azure Native
  3. API Docs
  4. eventgrid
  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.29.0 published on Friday, Feb 16, 2024 by Pulumi

azure-native.eventgrid.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.29.0 published on Friday, Feb 16, 2024 by Pulumi

    Get a specific private endpoint connection under a topic, domain, or partner namespace. Azure REST API version: 2022-06-15.

    Other available API versions: 2023-06-01-preview, 2023-12-15-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>
    def get_private_endpoint_connection(parent_name: Optional[str] = None,
                                        parent_type: 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(parent_name: Optional[pulumi.Input[str]] = None,
                                        parent_type: 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]
    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)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure-native:eventgrid:getPrivateEndpointConnection
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ParentName string
    The name of the parent resource (namely, either, the topic name, domain name, or partner namespace name).
    ParentType string
    The type of the parent resource. This can be either 'topics', 'domains', or 'partnerNamespaces'.
    PrivateEndpointConnectionName string
    The name of the private endpoint connection connection.
    ResourceGroupName string
    The name of the resource group within the user's subscription.
    ParentName string
    The name of the parent resource (namely, either, the topic name, domain name, or partner namespace name).
    ParentType string
    The type of the parent resource. This can be either 'topics', 'domains', or 'partnerNamespaces'.
    PrivateEndpointConnectionName string
    The name of the private endpoint connection connection.
    ResourceGroupName string
    The name of the resource group within the user's subscription.
    parentName String
    The name of the parent resource (namely, either, the topic name, domain name, or partner namespace name).
    parentType String
    The type of the parent resource. This can be either 'topics', 'domains', or 'partnerNamespaces'.
    privateEndpointConnectionName String
    The name of the private endpoint connection connection.
    resourceGroupName String
    The name of the resource group within the user's subscription.
    parentName string
    The name of the parent resource (namely, either, the topic name, domain name, or partner namespace name).
    parentType string
    The type of the parent resource. This can be either 'topics', 'domains', or 'partnerNamespaces'.
    privateEndpointConnectionName string
    The name of the private endpoint connection connection.
    resourceGroupName string
    The name of the resource group within the user's subscription.
    parent_name str
    The name of the parent resource (namely, either, the topic name, domain name, or partner namespace name).
    parent_type str
    The type of the parent resource. This can be either 'topics', 'domains', or 'partnerNamespaces'.
    private_endpoint_connection_name str
    The name of the private endpoint connection connection.
    resource_group_name str
    The name of the resource group within the user's subscription.
    parentName String
    The name of the parent resource (namely, either, the topic name, domain name, or partner namespace name).
    parentType String
    The type of the parent resource. This can be either 'topics', 'domains', or 'partnerNamespaces'.
    privateEndpointConnectionName String
    The name of the private endpoint connection connection.
    resourceGroupName String
    The name of the resource group within the user's subscription.

    getPrivateEndpointConnection Result

    The following output properties are available:

    Id string
    Fully qualified identifier of the resource.
    Name string
    Name of the resource.
    Type string
    Type of the resource.
    GroupIds List<string>
    GroupIds from the private link service resource.
    PrivateEndpoint Pulumi.AzureNative.EventGrid.Outputs.PrivateEndpointResponse
    The Private Endpoint resource for this Connection.
    PrivateLinkServiceConnectionState Pulumi.AzureNative.EventGrid.Outputs.ConnectionStateResponse
    Details about the state of the connection.
    ProvisioningState string
    Provisioning state of the Private Endpoint Connection.
    Id string
    Fully qualified identifier of the resource.
    Name string
    Name of the resource.
    Type string
    Type of the resource.
    GroupIds []string
    GroupIds from the private link service resource.
    PrivateEndpoint PrivateEndpointResponse
    The Private Endpoint resource for this Connection.
    PrivateLinkServiceConnectionState ConnectionStateResponse
    Details about the state of the connection.
    ProvisioningState string
    Provisioning state of the Private Endpoint Connection.
    id String
    Fully qualified identifier of the resource.
    name String
    Name of the resource.
    type String
    Type of the resource.
    groupIds List<String>
    GroupIds from the private link service resource.
    privateEndpoint PrivateEndpointResponse
    The Private Endpoint resource for this Connection.
    privateLinkServiceConnectionState ConnectionStateResponse
    Details about the state of the connection.
    provisioningState String
    Provisioning state of the Private Endpoint Connection.
    id string
    Fully qualified identifier of the resource.
    name string
    Name of the resource.
    type string
    Type of the resource.
    groupIds string[]
    GroupIds from the private link service resource.
    privateEndpoint PrivateEndpointResponse
    The Private Endpoint resource for this Connection.
    privateLinkServiceConnectionState ConnectionStateResponse
    Details about the state of the connection.
    provisioningState string
    Provisioning state of the Private Endpoint Connection.
    id str
    Fully qualified identifier of the resource.
    name str
    Name of the resource.
    type str
    Type of the resource.
    group_ids Sequence[str]
    GroupIds from the private link service resource.
    private_endpoint PrivateEndpointResponse
    The Private Endpoint resource for this Connection.
    private_link_service_connection_state ConnectionStateResponse
    Details about the state of the connection.
    provisioning_state str
    Provisioning state of the Private Endpoint Connection.
    id String
    Fully qualified identifier of the resource.
    name String
    Name of the resource.
    type String
    Type of the resource.
    groupIds List<String>
    GroupIds from the private link service resource.
    privateEndpoint Property Map
    The Private Endpoint resource for this Connection.
    privateLinkServiceConnectionState Property Map
    Details about the state of the connection.
    provisioningState String
    Provisioning state of the Private Endpoint Connection.

    Supporting Types

    ConnectionStateResponse

    ActionsRequired string
    Actions required (if any).
    Description string
    Description of the connection state.
    Status string
    Status of the connection.
    ActionsRequired string
    Actions required (if any).
    Description string
    Description of the connection state.
    Status string
    Status of the connection.
    actionsRequired String
    Actions required (if any).
    description String
    Description of the connection state.
    status String
    Status of the connection.
    actionsRequired string
    Actions required (if any).
    description string
    Description of the connection state.
    status string
    Status of the connection.
    actions_required str
    Actions required (if any).
    description str
    Description of the connection state.
    status str
    Status of the connection.
    actionsRequired String
    Actions required (if any).
    description String
    Description of the connection state.
    status String
    Status of the connection.

    PrivateEndpointResponse

    Id string
    The ARM identifier for Private Endpoint.
    Id string
    The ARM identifier for Private Endpoint.
    id String
    The ARM identifier for Private Endpoint.
    id string
    The ARM identifier for Private Endpoint.
    id str
    The ARM identifier for Private Endpoint.
    id String
    The ARM identifier for Private Endpoint.

    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.29.0 published on Friday, Feb 16, 2024 by Pulumi