Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. streamanalytics
  5. PrivateEndpoint
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.streamanalytics.PrivateEndpoint

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Complete information about the private endpoint. Azure REST API version: 2020-03-01. Prior API version in Azure Native 1.x: 2020-03-01-preview.

Other available API versions: 2020-03-01-preview.

Example Usage

Create a private endpoint

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var privateEndpoint = new AzureNative.StreamAnalytics.PrivateEndpoint("privateEndpoint", new()
    {
        ClusterName = "testcluster",
        ManualPrivateLinkServiceConnections = new[]
        {
            new AzureNative.StreamAnalytics.Inputs.PrivateLinkServiceConnectionArgs
            {
                GroupIds = new[]
                {
                    "groupIdFromResource",
                },
                PrivateLinkServiceId = "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls",
            },
        },
        PrivateEndpointName = "testpe",
        ResourceGroupName = "sjrg",
    });

});
Copy
package main

import (
	streamanalytics "github.com/pulumi/pulumi-azure-native-sdk/streamanalytics/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := streamanalytics.NewPrivateEndpoint(ctx, "privateEndpoint", &streamanalytics.PrivateEndpointArgs{
			ClusterName: pulumi.String("testcluster"),
			ManualPrivateLinkServiceConnections: streamanalytics.PrivateLinkServiceConnectionArray{
				&streamanalytics.PrivateLinkServiceConnectionArgs{
					GroupIds: pulumi.StringArray{
						pulumi.String("groupIdFromResource"),
					},
					PrivateLinkServiceId: pulumi.String("/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls"),
				},
			},
			PrivateEndpointName: pulumi.String("testpe"),
			ResourceGroupName:   pulumi.String("sjrg"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.streamanalytics.PrivateEndpoint;
import com.pulumi.azurenative.streamanalytics.PrivateEndpointArgs;
import com.pulumi.azurenative.streamanalytics.inputs.PrivateLinkServiceConnectionArgs;
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 privateEndpoint = new PrivateEndpoint("privateEndpoint", PrivateEndpointArgs.builder()
            .clusterName("testcluster")
            .manualPrivateLinkServiceConnections(PrivateLinkServiceConnectionArgs.builder()
                .groupIds("groupIdFromResource")
                .privateLinkServiceId("/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls")
                .build())
            .privateEndpointName("testpe")
            .resourceGroupName("sjrg")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const privateEndpoint = new azure_native.streamanalytics.PrivateEndpoint("privateEndpoint", {
    clusterName: "testcluster",
    manualPrivateLinkServiceConnections: [{
        groupIds: ["groupIdFromResource"],
        privateLinkServiceId: "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls",
    }],
    privateEndpointName: "testpe",
    resourceGroupName: "sjrg",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

private_endpoint = azure_native.streamanalytics.PrivateEndpoint("privateEndpoint",
    cluster_name="testcluster",
    manual_private_link_service_connections=[{
        "group_ids": ["groupIdFromResource"],
        "private_link_service_id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls",
    }],
    private_endpoint_name="testpe",
    resource_group_name="sjrg")
Copy
resources:
  privateEndpoint:
    type: azure-native:streamanalytics:PrivateEndpoint
    properties:
      clusterName: testcluster
      manualPrivateLinkServiceConnections:
        - groupIds:
            - groupIdFromResource
          privateLinkServiceId: /subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls
      privateEndpointName: testpe
      resourceGroupName: sjrg
Copy

Create PrivateEndpoint Resource

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

Constructor syntax

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

@overload
def PrivateEndpoint(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    cluster_name: Optional[str] = None,
                    resource_group_name: Optional[str] = None,
                    manual_private_link_service_connections: Optional[Sequence[PrivateLinkServiceConnectionArgs]] = None,
                    private_endpoint_name: Optional[str] = None)
func NewPrivateEndpoint(ctx *Context, name string, args PrivateEndpointArgs, opts ...ResourceOption) (*PrivateEndpoint, error)
public PrivateEndpoint(string name, PrivateEndpointArgs args, CustomResourceOptions? opts = null)
public PrivateEndpoint(String name, PrivateEndpointArgs args)
public PrivateEndpoint(String name, PrivateEndpointArgs args, CustomResourceOptions options)

type: azure-native:streamanalytics:PrivateEndpoint
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. PrivateEndpointArgs
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. PrivateEndpointArgs
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. PrivateEndpointArgs
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. PrivateEndpointArgs
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. PrivateEndpointArgs
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 azure_nativePrivateEndpointResource = new AzureNative.Streamanalytics.PrivateEndpoint("azure-nativePrivateEndpointResource", new()
{
    ClusterName = "string",
    ResourceGroupName = "string",
    ManualPrivateLinkServiceConnections = new[]
    {
        
        {
            { "groupIds", new[]
            {
                "string",
            } },
            { "privateLinkServiceId", "string" },
        },
    },
    PrivateEndpointName = "string",
});
Copy
example, err := streamanalytics.NewPrivateEndpoint(ctx, "azure-nativePrivateEndpointResource", &streamanalytics.PrivateEndpointArgs{
	ClusterName:       "string",
	ResourceGroupName: "string",
	ManualPrivateLinkServiceConnections: []map[string]interface{}{
		map[string]interface{}{
			"groupIds": []string{
				"string",
			},
			"privateLinkServiceId": "string",
		},
	},
	PrivateEndpointName: "string",
})
Copy
var azure_nativePrivateEndpointResource = new PrivateEndpoint("azure-nativePrivateEndpointResource", PrivateEndpointArgs.builder()
    .clusterName("string")
    .resourceGroupName("string")
    .manualPrivateLinkServiceConnections(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .privateEndpointName("string")
    .build());
Copy
azure_native_private_endpoint_resource = azure_native.streamanalytics.PrivateEndpoint("azure-nativePrivateEndpointResource",
    cluster_name=string,
    resource_group_name=string,
    manual_private_link_service_connections=[{
        groupIds: [string],
        privateLinkServiceId: string,
    }],
    private_endpoint_name=string)
Copy
const azure_nativePrivateEndpointResource = new azure_native.streamanalytics.PrivateEndpoint("azure-nativePrivateEndpointResource", {
    clusterName: "string",
    resourceGroupName: "string",
    manualPrivateLinkServiceConnections: [{
        groupIds: ["string"],
        privateLinkServiceId: "string",
    }],
    privateEndpointName: "string",
});
Copy
type: azure-native:streamanalytics:PrivateEndpoint
properties:
    clusterName: string
    manualPrivateLinkServiceConnections:
        - groupIds:
            - string
          privateLinkServiceId: string
    privateEndpointName: string
    resourceGroupName: string
Copy

PrivateEndpoint 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 PrivateEndpoint resource accepts the following input properties:

ClusterName
This property is required.
Changes to this property will trigger replacement.
string
The name of the cluster.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ManualPrivateLinkServiceConnections List<Pulumi.AzureNative.StreamAnalytics.Inputs.PrivateLinkServiceConnection>
A list of connections to the remote resource. Immutable after it is set.
PrivateEndpointName Changes to this property will trigger replacement. string
The name of the private endpoint.
ClusterName
This property is required.
Changes to this property will trigger replacement.
string
The name of the cluster.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ManualPrivateLinkServiceConnections []PrivateLinkServiceConnectionArgs
A list of connections to the remote resource. Immutable after it is set.
PrivateEndpointName Changes to this property will trigger replacement. string
The name of the private endpoint.
clusterName
This property is required.
Changes to this property will trigger replacement.
String
The name of the cluster.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
manualPrivateLinkServiceConnections List<PrivateLinkServiceConnection>
A list of connections to the remote resource. Immutable after it is set.
privateEndpointName Changes to this property will trigger replacement. String
The name of the private endpoint.
clusterName
This property is required.
Changes to this property will trigger replacement.
string
The name of the cluster.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
manualPrivateLinkServiceConnections PrivateLinkServiceConnection[]
A list of connections to the remote resource. Immutable after it is set.
privateEndpointName Changes to this property will trigger replacement. string
The name of the private endpoint.
cluster_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the cluster.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
manual_private_link_service_connections Sequence[PrivateLinkServiceConnectionArgs]
A list of connections to the remote resource. Immutable after it is set.
private_endpoint_name Changes to this property will trigger replacement. str
The name of the private endpoint.
clusterName
This property is required.
Changes to this property will trigger replacement.
String
The name of the cluster.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
manualPrivateLinkServiceConnections List<Property Map>
A list of connections to the remote resource. Immutable after it is set.
privateEndpointName Changes to this property will trigger replacement. String
The name of the private endpoint.

Outputs

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

CreatedDate string
The date when this private endpoint was created.
Etag string
Unique opaque string (generally a GUID) that represents the metadata state of the resource (private endpoint) and changes whenever the resource is updated. Required on PUT (CreateOrUpdate) requests.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource
Type string
The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
CreatedDate string
The date when this private endpoint was created.
Etag string
Unique opaque string (generally a GUID) that represents the metadata state of the resource (private endpoint) and changes whenever the resource is updated. Required on PUT (CreateOrUpdate) requests.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource
Type string
The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
createdDate String
The date when this private endpoint was created.
etag String
Unique opaque string (generally a GUID) that represents the metadata state of the resource (private endpoint) and changes whenever the resource is updated. Required on PUT (CreateOrUpdate) requests.
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the resource
type String
The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
createdDate string
The date when this private endpoint was created.
etag string
Unique opaque string (generally a GUID) that represents the metadata state of the resource (private endpoint) and changes whenever the resource is updated. Required on PUT (CreateOrUpdate) requests.
id string
The provider-assigned unique ID for this managed resource.
name string
The name of the resource
type string
The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
created_date str
The date when this private endpoint was created.
etag str
Unique opaque string (generally a GUID) that represents the metadata state of the resource (private endpoint) and changes whenever the resource is updated. Required on PUT (CreateOrUpdate) requests.
id str
The provider-assigned unique ID for this managed resource.
name str
The name of the resource
type str
The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
createdDate String
The date when this private endpoint was created.
etag String
Unique opaque string (generally a GUID) that represents the metadata state of the resource (private endpoint) and changes whenever the resource is updated. Required on PUT (CreateOrUpdate) requests.
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the resource
type String
The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.

Supporting Types

PrivateLinkConnectionStateResponse
, PrivateLinkConnectionStateResponseArgs

ActionsRequired This property is required. string
A message indicating if changes on the service provider require any updates on the consumer.
Description This property is required. string
The reason for approval/rejection of the connection.
Status This property is required. string
Indicates whether the connection has been Approved/Rejected/Removed by the owner of the remote resource/service.
ActionsRequired This property is required. string
A message indicating if changes on the service provider require any updates on the consumer.
Description This property is required. string
The reason for approval/rejection of the connection.
Status This property is required. string
Indicates whether the connection has been Approved/Rejected/Removed by the owner of the remote resource/service.
actionsRequired This property is required. String
A message indicating if changes on the service provider require any updates on the consumer.
description This property is required. String
The reason for approval/rejection of the connection.
status This property is required. String
Indicates whether the connection has been Approved/Rejected/Removed by the owner of the remote resource/service.
actionsRequired This property is required. string
A message indicating if changes on the service provider require any updates on the consumer.
description This property is required. string
The reason for approval/rejection of the connection.
status This property is required. string
Indicates whether the connection has been Approved/Rejected/Removed by the owner of the remote resource/service.
actions_required This property is required. str
A message indicating if changes on the service provider require any updates on the consumer.
description This property is required. str
The reason for approval/rejection of the connection.
status This property is required. str
Indicates whether the connection has been Approved/Rejected/Removed by the owner of the remote resource/service.
actionsRequired This property is required. String
A message indicating if changes on the service provider require any updates on the consumer.
description This property is required. String
The reason for approval/rejection of the connection.
status This property is required. String
Indicates whether the connection has been Approved/Rejected/Removed by the owner of the remote resource/service.

PrivateLinkServiceConnection
, PrivateLinkServiceConnectionArgs

GroupIds List<string>
The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. Required on PUT (CreateOrUpdate) requests.
PrivateLinkServiceId string
The resource id of the private link service. Required on PUT (CreateOrUpdate) requests.
GroupIds []string
The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. Required on PUT (CreateOrUpdate) requests.
PrivateLinkServiceId string
The resource id of the private link service. Required on PUT (CreateOrUpdate) requests.
groupIds List<String>
The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. Required on PUT (CreateOrUpdate) requests.
privateLinkServiceId String
The resource id of the private link service. Required on PUT (CreateOrUpdate) requests.
groupIds string[]
The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. Required on PUT (CreateOrUpdate) requests.
privateLinkServiceId string
The resource id of the private link service. Required on PUT (CreateOrUpdate) requests.
group_ids Sequence[str]
The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. Required on PUT (CreateOrUpdate) requests.
private_link_service_id str
The resource id of the private link service. Required on PUT (CreateOrUpdate) requests.
groupIds List<String>
The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. Required on PUT (CreateOrUpdate) requests.
privateLinkServiceId String
The resource id of the private link service. Required on PUT (CreateOrUpdate) requests.

PrivateLinkServiceConnectionResponse
, PrivateLinkServiceConnectionResponseArgs

RequestMessage This property is required. string
A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars.
GroupIds List<string>
The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. Required on PUT (CreateOrUpdate) requests.
PrivateLinkServiceConnectionState Pulumi.AzureNative.StreamAnalytics.Inputs.PrivateLinkConnectionStateResponse
A collection of read-only information about the state of the connection to the private remote resource.
PrivateLinkServiceId string
The resource id of the private link service. Required on PUT (CreateOrUpdate) requests.
RequestMessage This property is required. string
A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars.
GroupIds []string
The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. Required on PUT (CreateOrUpdate) requests.
PrivateLinkServiceConnectionState PrivateLinkConnectionStateResponse
A collection of read-only information about the state of the connection to the private remote resource.
PrivateLinkServiceId string
The resource id of the private link service. Required on PUT (CreateOrUpdate) requests.
requestMessage This property is required. String
A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars.
groupIds List<String>
The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. Required on PUT (CreateOrUpdate) requests.
privateLinkServiceConnectionState PrivateLinkConnectionStateResponse
A collection of read-only information about the state of the connection to the private remote resource.
privateLinkServiceId String
The resource id of the private link service. Required on PUT (CreateOrUpdate) requests.
requestMessage This property is required. string
A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars.
groupIds string[]
The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. Required on PUT (CreateOrUpdate) requests.
privateLinkServiceConnectionState PrivateLinkConnectionStateResponse
A collection of read-only information about the state of the connection to the private remote resource.
privateLinkServiceId string
The resource id of the private link service. Required on PUT (CreateOrUpdate) requests.
request_message This property is required. str
A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars.
group_ids Sequence[str]
The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. Required on PUT (CreateOrUpdate) requests.
private_link_service_connection_state PrivateLinkConnectionStateResponse
A collection of read-only information about the state of the connection to the private remote resource.
private_link_service_id str
The resource id of the private link service. Required on PUT (CreateOrUpdate) requests.
requestMessage This property is required. String
A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars.
groupIds List<String>
The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. Required on PUT (CreateOrUpdate) requests.
privateLinkServiceConnectionState Property Map
A collection of read-only information about the state of the connection to the private remote resource.
privateLinkServiceId String
The resource id of the private link service. Required on PUT (CreateOrUpdate) requests.

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:streamanalytics:PrivateEndpoint An Example Private Endpoint /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StreamAnalytics/clusters/{clusterName}/privateEndpoints/{privateEndpointName}
Copy

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

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native