Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Aiven Provider
  3. API Docs
  4. getAzurePrivatelink
Aiven v6.36.0 published on Thursday, Mar 13, 2025 by Pulumi
pulumi/pulumi-aiven

aiven.getAzurePrivatelink

Explore with Pulumi AI

Aiven v6.36.0 published on Thursday, Mar 13, 2025 by Pulumi
pulumi/pulumi-aiven

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 main = aiven.getAzurePrivatelink({
    project: exampleProject.project,
    serviceName: exampleKafka.serviceName,
});
Copy
import pulumi
import pulumi_aiven as aiven

main = aiven.get_azure_privatelink(project=example_project["project"],
    service_name=example_kafka["serviceName"])
Copy
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.LookupAzurePrivatelink(ctx, &aiven.LookupAzurePrivatelinkArgs{
			Project:     exampleProject.Project,
			ServiceName: exampleKafka.ServiceName,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aiven = Pulumi.Aiven;

return await Deployment.RunAsync(() => 
{
    var main = Aiven.GetAzurePrivatelink.Invoke(new()
    {
        Project = exampleProject.Project,
        ServiceName = exampleKafka.ServiceName,
    });

});
Copy
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 main = AivenFunctions.getAzurePrivatelink(GetAzurePrivatelinkArgs.builder()
            .project(exampleProject.project())
            .serviceName(exampleKafka.serviceName())
            .build());

    }
}
Copy
variables:
  main:
    fn::invoke:
      function: aiven:getAzurePrivatelink
      arguments:
        project: ${exampleProject.project}
        serviceName: ${exampleKafka.serviceName}
Copy

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>
Copy
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]
Copy
func LookupAzurePrivatelink(ctx *Context, args *LookupAzurePrivatelinkArgs, opts ...InvokeOption) (*LookupAzurePrivatelinkResult, error)
func LookupAzurePrivatelinkOutput(ctx *Context, args *LookupAzurePrivatelinkOutputArgs, opts ...InvokeOption) LookupAzurePrivatelinkResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetAzurePrivatelinkResult> getAzurePrivatelink(GetAzurePrivatelinkArgs args, InvokeOptions options)
public static Output<GetAzurePrivatelinkResult> getAzurePrivatelink(GetAzurePrivatelinkArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aiven:index/getAzurePrivatelink:getAzurePrivatelink
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Project This property is required. string
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
ServiceName This property is required. string
The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
Project This property is required. string
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
ServiceName This property is required. string
The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
project This property is required. String
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
serviceName This property is required. String
The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
project This property is required. string
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
serviceName This property is required. string
The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
project This property is required. str
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
service_name This property is required. str
The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
project This property is required. String
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
serviceName This property is required. String
The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.

getAzurePrivatelink Result

The following output properties are available:

AzureServiceAlias string
The Azure Private Link service alias.
AzureServiceId string
The Azure Private Link service ID.
Id string
The provider-assigned unique ID for this managed resource.
Message string
Printable result of the Azure Private Link request.
Project string
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
ServiceName string
The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
State string
The state of the Private Link resource.
UserSubscriptionIds List<string>
A list of allowed subscription IDs. Maximum length: 16.
AzureServiceAlias string
The Azure Private Link service alias.
AzureServiceId string
The Azure Private Link service ID.
Id string
The provider-assigned unique ID for this managed resource.
Message string
Printable result of the Azure Private Link request.
Project string
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
ServiceName string
The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
State string
The state of the Private Link resource.
UserSubscriptionIds []string
A list of allowed subscription IDs. Maximum length: 16.
azureServiceAlias String
The Azure Private Link service alias.
azureServiceId String
The Azure Private Link service ID.
id String
The provider-assigned unique ID for this managed resource.
message String
Printable result of the Azure Private Link request.
project String
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
serviceName String
The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
state String
The state of the Private Link resource.
userSubscriptionIds List<String>
A list of allowed subscription IDs. Maximum length: 16.
azureServiceAlias string
The Azure Private Link service alias.
azureServiceId string
The Azure Private Link service ID.
id string
The provider-assigned unique ID for this managed resource.
message string
Printable result of the Azure Private Link request.
project string
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
serviceName string
The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
state string
The state of the Private Link resource.
userSubscriptionIds string[]
A list of allowed subscription IDs. Maximum length: 16.
azure_service_alias str
The Azure Private Link service alias.
azure_service_id str
The Azure Private Link service ID.
id str
The provider-assigned unique ID for this managed resource.
message str
Printable result of the Azure Private Link request.
project str
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
service_name str
The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
state str
The state of the Private Link resource.
user_subscription_ids Sequence[str]
A list of allowed subscription IDs. Maximum length: 16.
azureServiceAlias String
The Azure Private Link service alias.
azureServiceId String
The Azure Private Link service ID.
id String
The provider-assigned unique ID for this managed resource.
message String
Printable result of the Azure Private Link request.
project String
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
serviceName String
The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
state String
The state of the Private Link resource.
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 v6.36.0 published on Thursday, Mar 13, 2025 by Pulumi
pulumi/pulumi-aiven