1. Packages
  2. Packages
  3. Aiven Provider
  4. API Docs
  5. getAzurePrivatelink
Viewing docs for Aiven v5.6.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
aiven logo
Viewing docs for Aiven v5.6.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

    The Azure Privatelink resource allows the creation and management of Aiven Azure Privatelink for a services.

    Example Usage

    using System.Collections.Generic;
    using Pulumi;
    using Aiven = Pulumi.Aiven;
    
    return await Deployment.RunAsync(() => 
    {
        var foo = Aiven.GetAzurePrivatelink.Invoke(new()
        {
            Project = data.Aiven_project.Foo.Project,
            ServiceName = aiven_kafka.Bar.Service_name,
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aiven/sdk/v5/go/aiven"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := aiven.LookupAzurePrivatelink(ctx, &aiven.LookupAzurePrivatelinkArgs{
    			Project:     data.Aiven_project.Foo.Project,
    			ServiceName: aiven_kafka.Bar.Service_name,
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    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.List;
    import java.util.ArrayList;
    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 foo = AivenFunctions.getAzurePrivatelink(GetAzurePrivatelinkArgs.builder()
                .project(data.aiven_project().foo().project())
                .serviceName(aiven_kafka.bar().service_name())
                .build());
    
        }
    }
    
    import * as pulumi from "@pulumi/pulumi";
    import * as aiven from "@pulumi/aiven";
    
    const foo = aiven.getAzurePrivatelink({
        project: data.aiven_project.foo.project,
        serviceName: aiven_kafka.bar.service_name,
    });
    
    import pulumi
    import pulumi_aiven as aiven
    
    foo = aiven.get_azure_privatelink(project=data["aiven_project"]["foo"]["project"],
        service_name=aiven_kafka["bar"]["service_name"])
    
    variables:
      foo:
        fn::invoke:
          Function: aiven:getAzurePrivatelink
          Arguments:
            project: ${data.aiven_project.foo.project}
            serviceName: ${aiven_kafka.bar.service_name}
    

    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?: InvokeOptions): Output<GetAzurePrivatelinkResult>
    def get_azure_privatelink(project: Optional[str] = None,
                              service_name: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetAzurePrivatelinkResult
    def get_azure_privatelink_output(project: Optional[pulumi.Input[str]] = None,
                              service_name: Optional[pulumi.Input[str]] = None,
                              opts: Optional[InvokeOptions] = 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 CompletableFuture<GetAzurePrivatelinkResult> getAzurePrivatelink(GetAzurePrivatelinkArgs args, InvokeOptions options)
    public static Output<GetAzurePrivatelinkResult> getAzurePrivatelink(GetAzurePrivatelinkArgs args, InvokeOptions options)
    
    fn::invoke:
      function: aiven:index/getAzurePrivatelink:getAzurePrivatelink
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Project string
    Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
    ServiceName string
    Specifies the name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
    Project string
    Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
    ServiceName string
    Specifies the name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
    project String
    Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
    serviceName String
    Specifies the name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
    project string
    Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
    serviceName string
    Specifies the name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
    project str
    Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
    service_name str
    Specifies the name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
    project String
    Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
    serviceName String
    Specifies the name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.

    getAzurePrivatelink Result

    The following output properties are available:

    AzureServiceAlias string
    Azure Privatelink service alias
    AzureServiceId string
    Azure Privatelink service ID
    Id string
    The provider-assigned unique ID for this managed resource.
    Message string
    Printable result of the Azure Privatelink request
    Project string
    Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
    ServiceName string
    Specifies the name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
    State string
    Privatelink resource state
    UserSubscriptionIds List<string>
    A List of allowed Subscription IDs Maximum Length: 16.
    AzureServiceAlias string
    Azure Privatelink service alias
    AzureServiceId string
    Azure Privatelink service ID
    Id string
    The provider-assigned unique ID for this managed resource.
    Message string
    Printable result of the Azure Privatelink request
    Project string
    Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
    ServiceName string
    Specifies the name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
    State string
    Privatelink resource state
    UserSubscriptionIds []string
    A List of allowed Subscription IDs Maximum Length: 16.
    azureServiceAlias String
    Azure Privatelink service alias
    azureServiceId String
    Azure Privatelink service ID
    id String
    The provider-assigned unique ID for this managed resource.
    message String
    Printable result of the Azure Privatelink request
    project String
    Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
    serviceName String
    Specifies the name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
    state String
    Privatelink resource state
    userSubscriptionIds List<String>
    A List of allowed Subscription IDs Maximum Length: 16.
    azureServiceAlias string
    Azure Privatelink service alias
    azureServiceId string
    Azure Privatelink service ID
    id string
    The provider-assigned unique ID for this managed resource.
    message string
    Printable result of the Azure Privatelink request
    project string
    Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
    serviceName string
    Specifies the name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
    state string
    Privatelink resource state
    userSubscriptionIds string[]
    A List of allowed Subscription IDs Maximum Length: 16.
    azure_service_alias str
    Azure Privatelink service alias
    azure_service_id str
    Azure Privatelink service ID
    id str
    The provider-assigned unique ID for this managed resource.
    message str
    Printable result of the Azure Privatelink request
    project str
    Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
    service_name str
    Specifies the name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
    state str
    Privatelink resource state
    user_subscription_ids Sequence[str]
    A List of allowed Subscription IDs Maximum Length: 16.
    azureServiceAlias String
    Azure Privatelink service alias
    azureServiceId String
    Azure Privatelink service ID
    id String
    The provider-assigned unique ID for this managed resource.
    message String
    Printable result of the Azure Privatelink request
    project String
    Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
    serviceName String
    Specifies the name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
    state String
    Privatelink resource state
    userSubscriptionIds List<String>
    A List of allowed Subscription IDs Maximum Length: 16.

    Package Details

    Repository
    Aiven pulumi/pulumi-aiven
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aiven Terraform Provider.
    aiven logo
    Viewing docs for Aiven v5.6.0 (Older version)
    published on Monday, Mar 9, 2026 by Pulumi
      Try Pulumi Cloud free. Your team will thank you.