1. Packages
  2. Aiven Provider
  3. API Docs
  4. AzurePrivatelink
Aiven v6.37.0 published on Thursday, Apr 10, 2025 by Pulumi

aiven.AzurePrivatelink

Explore with Pulumi AI

Creates and manages an Azure Private Link for selected Aiven services in a VPC.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aiven from "@pulumi/aiven";

const main = new aiven.AzurePrivatelink("main", {
    project: exampleProject.project,
    serviceName: exampleKafka.serviceName,
    userSubscriptionIds: ["00000000-0000-0000-0000-000000000000"],
});
Copy
import pulumi
import pulumi_aiven as aiven

main = aiven.AzurePrivatelink("main",
    project=example_project["project"],
    service_name=example_kafka["serviceName"],
    user_subscription_ids=["00000000-0000-0000-0000-000000000000"])
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.NewAzurePrivatelink(ctx, "main", &aiven.AzurePrivatelinkArgs{
			Project:     pulumi.Any(exampleProject.Project),
			ServiceName: pulumi.Any(exampleKafka.ServiceName),
			UserSubscriptionIds: pulumi.StringArray{
				pulumi.String("00000000-0000-0000-0000-000000000000"),
			},
		})
		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 = new Aiven.AzurePrivatelink("main", new()
    {
        Project = exampleProject.Project,
        ServiceName = exampleKafka.ServiceName,
        UserSubscriptionIds = new[]
        {
            "00000000-0000-0000-0000-000000000000",
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aiven.AzurePrivatelink;
import com.pulumi.aiven.AzurePrivatelinkArgs;
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) {
        var main = new AzurePrivatelink("main", AzurePrivatelinkArgs.builder()
            .project(exampleProject.project())
            .serviceName(exampleKafka.serviceName())
            .userSubscriptionIds("00000000-0000-0000-0000-000000000000")
            .build());

    }
}
Copy
resources:
  main:
    type: aiven:AzurePrivatelink
    properties:
      project: ${exampleProject.project}
      serviceName: ${exampleKafka.serviceName}
      userSubscriptionIds:
        - 00000000-0000-0000-0000-000000000000
Copy

Create AzurePrivatelink Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new AzurePrivatelink(name: string, args: AzurePrivatelinkArgs, opts?: CustomResourceOptions);
@overload
def AzurePrivatelink(resource_name: str,
                     args: AzurePrivatelinkArgs,
                     opts: Optional[ResourceOptions] = None)

@overload
def AzurePrivatelink(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     project: Optional[str] = None,
                     service_name: Optional[str] = None,
                     user_subscription_ids: Optional[Sequence[str]] = None)
func NewAzurePrivatelink(ctx *Context, name string, args AzurePrivatelinkArgs, opts ...ResourceOption) (*AzurePrivatelink, error)
public AzurePrivatelink(string name, AzurePrivatelinkArgs args, CustomResourceOptions? opts = null)
public AzurePrivatelink(String name, AzurePrivatelinkArgs args)
public AzurePrivatelink(String name, AzurePrivatelinkArgs args, CustomResourceOptions options)
type: aiven:AzurePrivatelink
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. AzurePrivatelinkArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. AzurePrivatelinkArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. AzurePrivatelinkArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. AzurePrivatelinkArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. AzurePrivatelinkArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var azurePrivatelinkResource = new Aiven.AzurePrivatelink("azurePrivatelinkResource", new()
{
    Project = "string",
    ServiceName = "string",
    UserSubscriptionIds = new[]
    {
        "string",
    },
});
Copy
example, err := aiven.NewAzurePrivatelink(ctx, "azurePrivatelinkResource", &aiven.AzurePrivatelinkArgs{
	Project:     pulumi.String("string"),
	ServiceName: pulumi.String("string"),
	UserSubscriptionIds: pulumi.StringArray{
		pulumi.String("string"),
	},
})
Copy
var azurePrivatelinkResource = new AzurePrivatelink("azurePrivatelinkResource", AzurePrivatelinkArgs.builder()
    .project("string")
    .serviceName("string")
    .userSubscriptionIds("string")
    .build());
Copy
azure_privatelink_resource = aiven.AzurePrivatelink("azurePrivatelinkResource",
    project="string",
    service_name="string",
    user_subscription_ids=["string"])
Copy
const azurePrivatelinkResource = new aiven.AzurePrivatelink("azurePrivatelinkResource", {
    project: "string",
    serviceName: "string",
    userSubscriptionIds: ["string"],
});
Copy
type: aiven:AzurePrivatelink
properties:
    project: string
    serviceName: string
    userSubscriptionIds:
        - string
Copy

AzurePrivatelink Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The AzurePrivatelink resource accepts the following input properties:

Project
This property is required.
Changes to this property will trigger replacement.
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.
Changes to this property will trigger replacement.
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.
UserSubscriptionIds This property is required. List<string>
A list of allowed subscription IDs. Maximum length: 16.
Project
This property is required.
Changes to this property will trigger replacement.
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.
Changes to this property will trigger replacement.
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.
UserSubscriptionIds This property is required. []string
A list of allowed subscription IDs. Maximum length: 16.
project
This property is required.
Changes to this property will trigger replacement.
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.
Changes to this property will trigger replacement.
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.
userSubscriptionIds This property is required. List<String>
A list of allowed subscription IDs. Maximum length: 16.
project
This property is required.
Changes to this property will trigger replacement.
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.
Changes to this property will trigger replacement.
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.
userSubscriptionIds This property is required. string[]
A list of allowed subscription IDs. Maximum length: 16.
project
This property is required.
Changes to this property will trigger replacement.
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.
Changes to this property will trigger replacement.
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.
user_subscription_ids This property is required. Sequence[str]
A list of allowed subscription IDs. Maximum length: 16.
project
This property is required.
Changes to this property will trigger replacement.
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.
Changes to this property will trigger replacement.
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.
userSubscriptionIds This property is required. List<String>
A list of allowed subscription IDs. Maximum length: 16.

Outputs

All input properties are implicitly available as output properties. Additionally, the AzurePrivatelink resource produces the following output properties:

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.
State string
The state of the Private Link resource.
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.
State string
The state of the Private Link resource.
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.
state String
The state of the Private Link resource.
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.
state string
The state of the Private Link resource.
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.
state str
The state of the Private Link resource.
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.
state String
The state of the Private Link resource.

Look up Existing AzurePrivatelink Resource

Get an existing AzurePrivatelink resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: AzurePrivatelinkState, opts?: CustomResourceOptions): AzurePrivatelink
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        azure_service_alias: Optional[str] = None,
        azure_service_id: Optional[str] = None,
        message: Optional[str] = None,
        project: Optional[str] = None,
        service_name: Optional[str] = None,
        state: Optional[str] = None,
        user_subscription_ids: Optional[Sequence[str]] = None) -> AzurePrivatelink
func GetAzurePrivatelink(ctx *Context, name string, id IDInput, state *AzurePrivatelinkState, opts ...ResourceOption) (*AzurePrivatelink, error)
public static AzurePrivatelink Get(string name, Input<string> id, AzurePrivatelinkState? state, CustomResourceOptions? opts = null)
public static AzurePrivatelink get(String name, Output<String> id, AzurePrivatelinkState state, CustomResourceOptions options)
resources:  _:    type: aiven:AzurePrivatelink    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
AzureServiceAlias string
The Azure Private Link service alias.
AzureServiceId string
The Azure Private Link service ID.
Message string
Printable result of the Azure Private Link request.
Project Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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.
Message string
Printable result of the Azure Private Link request.
Project Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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.
message String
Printable result of the Azure Private Link request.
project Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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.
message string
Printable result of the Azure Private Link request.
project Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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.
message str
Printable result of the Azure Private Link request.
project Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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.
message String
Printable result of the Azure Private Link request.
project Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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.

Import

$ pulumi import aiven:index/azurePrivatelink:AzurePrivatelink main PROJECT/SERVICE_NAME
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Aiven pulumi/pulumi-aiven
License
Apache-2.0
Notes
This Pulumi package is based on the aiven Terraform Provider.