1. Registry
  2. Packages
  3. Aiven Provider
  4. API Docs
  5. getAzurePrivatelink
Viewing docs for Aiven v6.62.0
published on Thursday, Oct 22, 2026 by Pulumi
aiven logo aiven logo
Viewing docs for Aiven v6.62.0
published on Thursday, Oct 22, 2026 by Pulumi

    Gets information about an Azure Private Link connection for an Aiven service.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aiven from "@pulumi/aiven";
    
    const example = aiven.getAzurePrivatelink({
        project: "my-project",
        serviceName: "foo",
    });
    
    import pulumi
    import pulumi_aiven as aiven
    
    example = aiven.get_azure_privatelink(project="my-project",
        service_name="foo")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aiven/sdk/v6/go/aiven"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := aiven.GetAzurePrivatelink(ctx, &aiven.LookupAzurePrivatelinkArgs{
    			Project:     "my-project",
    			ServiceName: "foo",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aiven = Pulumi.Aiven;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Aiven.GetAzurePrivatelink.Invoke(new()
        {
            Project = "my-project",
            ServiceName = "foo",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aiven.AivenFunctions;
    import com.pulumi.aiven.inputs.GetAzurePrivatelinkArgs;
    import java.util.ArrayList;
    import java.util.Arrays;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var example = AivenFunctions.getAzurePrivatelink(GetAzurePrivatelinkArgs.builder()
                .project("my-project")
                .serviceName("foo")
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          function: aiven:getAzurePrivatelink
          arguments:
            project: my-project
            serviceName: foo
    
    terraform {
      required_providers {
        aiven = {
          source = "pulumi/aiven"
        }
      }
    }
    
    data "aiven_azure_privatelink" "example" {
      project      = "my-project"
      service_name = "foo"
    }
    

    Using getAzurePrivatelink

    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 getAzurePrivatelink(args: GetAzurePrivatelinkArgs, opts?: InvokeOptions): Promise<GetAzurePrivatelinkResult>
    function getAzurePrivatelinkOutput(args: GetAzurePrivatelinkOutputArgs, opts?: InvokeOutputOptions): Output<GetAzurePrivatelinkResult>
    def get_azure_privatelink(project: Optional[str] = None,
                              service_name: Optional[str] = None,
                              timeouts: Optional[GetAzurePrivatelinkTimeouts] = None,
                              opts: Optional[InvokeOptions] = None) -> GetAzurePrivatelinkResult
    def get_azure_privatelink_output(project: pulumi.Input[Optional[str]] = None,
                              service_name: pulumi.Input[Optional[str]] = None,
                              timeouts: pulumi.Input[Optional[GetAzurePrivatelinkTimeoutsArgs]] = None,
                              opts: Optional[InvokeOutputOptions] = None) -> Output[GetAzurePrivatelinkResult]
    func LookupAzurePrivatelink(ctx *Context, args *LookupAzurePrivatelinkArgs, opts ...InvokeOption) (*LookupAzurePrivatelinkResult, error)
    func LookupAzurePrivatelinkOutput(ctx *Context, args *LookupAzurePrivatelinkOutputArgs, opts ...InvokeOption) LookupAzurePrivatelinkResultOutput

    > Note: This function is named LookupAzurePrivatelink in the Go SDK.

    public static class GetAzurePrivatelink 
    {
        public static Task<GetAzurePrivatelinkResult> InvokeAsync(GetAzurePrivatelinkArgs args, InvokeOptions? opts = null)
        public static Output<GetAzurePrivatelinkResult> Invoke(GetAzurePrivatelinkInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetAzurePrivatelinkResult> Invoke(GetAzurePrivatelinkInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetAzurePrivatelinkResult> getAzurePrivatelink(GetAzurePrivatelinkArgs args, InvokeOptions options)
    public static Output<GetAzurePrivatelinkResult> getAzurePrivatelink(GetAzurePrivatelinkArgs args, InvokeOptions options)
    public static Output<GetAzurePrivatelinkResult> getAzurePrivatelink(GetAzurePrivatelinkArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: aiven:index/getAzurePrivatelink:getAzurePrivatelink
      arguments:
        # arguments dictionary
    data "aiven_get_azure_privatelink" "name" {
        # arguments
    }

    The following arguments are supported:

    Project string
    Project name.
    ServiceName string
    Service name.
    Timeouts GetAzurePrivatelinkTimeouts
    Project string
    Project name.
    ServiceName string
    Service name.
    Timeouts GetAzurePrivatelinkTimeouts
    project string
    Project name.
    service_name string
    Service name.
    timeouts object
    project String
    Project name.
    serviceName String
    Service name.
    timeouts GetAzurePrivatelinkTimeouts
    project string
    Project name.
    serviceName string
    Service name.
    timeouts GetAzurePrivatelinkTimeouts
    project String
    Project name.
    serviceName String
    Service name.
    timeouts Property Map

    getAzurePrivatelink Result

    The following output properties are available:

    AzureServiceAlias string
    Azure Privatelink service alias.
    AzureServiceId string
    Azure Privatelink service ID.
    Id string
    Resource ID composed as: project/service_name.
    Message string
    Legacy response message retained for backward compatibility. Deprecated: This attribute is retained only for compatibility with state created by older provider versions and is no longer populated.

    Deprecated: This attribute is retained only for compatibility with state created by older provider versions and is no longer populated.

    Project string
    Project name.
    ServiceName string
    Service name.
    State string
    Privatelink resource state. The possible values are active, creating and deleting.
    UserSubscriptionIds List<string>
    IDs of Azure subscriptions allowed to connect to the service.
    Timeouts GetAzurePrivatelinkTimeouts
    AzureServiceAlias string
    Azure Privatelink service alias.
    AzureServiceId string
    Azure Privatelink service ID.
    Id string
    Resource ID composed as: project/service_name.
    Message string
    Legacy response message retained for backward compatibility. Deprecated: This attribute is retained only for compatibility with state created by older provider versions and is no longer populated.

    Deprecated: This attribute is retained only for compatibility with state created by older provider versions and is no longer populated.

    Project string
    Project name.
    ServiceName string
    Service name.
    State string
    Privatelink resource state. The possible values are active, creating and deleting.
    UserSubscriptionIds []string
    IDs of Azure subscriptions allowed to connect to the service.
    Timeouts GetAzurePrivatelinkTimeouts
    azure_service_alias string
    Azure Privatelink service alias.
    azure_service_id string
    Azure Privatelink service ID.
    id string
    Resource ID composed as: project/service_name.
    message string
    Legacy response message retained for backward compatibility. Deprecated: This attribute is retained only for compatibility with state created by older provider versions and is no longer populated.

    Deprecated: This attribute is retained only for compatibility with state created by older provider versions and is no longer populated.

    project string
    Project name.
    service_name string
    Service name.
    state string
    Privatelink resource state. The possible values are active, creating and deleting.
    user_subscription_ids list(string)
    IDs of Azure subscriptions allowed to connect to the service.
    timeouts object
    azureServiceAlias String
    Azure Privatelink service alias.
    azureServiceId String
    Azure Privatelink service ID.
    id String
    Resource ID composed as: project/service_name.
    message String
    Legacy response message retained for backward compatibility. Deprecated: This attribute is retained only for compatibility with state created by older provider versions and is no longer populated.

    Deprecated: This attribute is retained only for compatibility with state created by older provider versions and is no longer populated.

    project String
    Project name.
    serviceName String
    Service name.
    state String
    Privatelink resource state. The possible values are active, creating and deleting.
    userSubscriptionIds List<String>
    IDs of Azure subscriptions allowed to connect to the service.
    timeouts GetAzurePrivatelinkTimeouts
    azureServiceAlias string
    Azure Privatelink service alias.
    azureServiceId string
    Azure Privatelink service ID.
    id string
    Resource ID composed as: project/service_name.
    message string
    Legacy response message retained for backward compatibility. Deprecated: This attribute is retained only for compatibility with state created by older provider versions and is no longer populated.

    Deprecated: This attribute is retained only for compatibility with state created by older provider versions and is no longer populated.

    project string
    Project name.
    serviceName string
    Service name.
    state string
    Privatelink resource state. The possible values are active, creating and deleting.
    userSubscriptionIds string[]
    IDs of Azure subscriptions allowed to connect to the service.
    timeouts GetAzurePrivatelinkTimeouts
    azure_service_alias str
    Azure Privatelink service alias.
    azure_service_id str
    Azure Privatelink service ID.
    id str
    Resource ID composed as: project/service_name.
    message str
    Legacy response message retained for backward compatibility. Deprecated: This attribute is retained only for compatibility with state created by older provider versions and is no longer populated.

    Deprecated: This attribute is retained only for compatibility with state created by older provider versions and is no longer populated.

    project str
    Project name.
    service_name str
    Service name.
    state str
    Privatelink resource state. The possible values are active, creating and deleting.
    user_subscription_ids Sequence[str]
    IDs of Azure subscriptions allowed to connect to the service.
    timeouts GetAzurePrivatelinkTimeouts
    azureServiceAlias String
    Azure Privatelink service alias.
    azureServiceId String
    Azure Privatelink service ID.
    id String
    Resource ID composed as: project/service_name.
    message String
    Legacy response message retained for backward compatibility. Deprecated: This attribute is retained only for compatibility with state created by older provider versions and is no longer populated.

    Deprecated: This attribute is retained only for compatibility with state created by older provider versions and is no longer populated.

    project String
    Project name.
    serviceName String
    Service name.
    state String
    Privatelink resource state. The possible values are active, creating and deleting.
    userSubscriptionIds List<String>
    IDs of Azure subscriptions allowed to connect to the service.
    timeouts Property Map

    Supporting Types

    GetAzurePrivatelinkTimeouts

    Read string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Read string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    read string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    read String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    read string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    read str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    read String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).

    Package Details

    Repository
    Aiven pulumi/pulumi-aiven
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aiven Terraform Provider.
    aiven logo aiven logo
    Viewing docs for Aiven v6.62.0
    published on Thursday, Oct 22, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial