Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v1
  3. API Docs
  4. streamanalytics
  5. PrivateEndpoint
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

azure-native.streamanalytics.PrivateEndpoint

Explore with Pulumi AI

azure-native-v1 logo
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

    Complete information about the private endpoint. API Version: 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",
        PrivateEndpointName = "testpe",
        Properties = new AzureNative.StreamAnalytics.Inputs.PrivateEndpointPropertiesArgs
        {
            ManualPrivateLinkServiceConnections = new[]
            {
                new AzureNative.StreamAnalytics.Inputs.PrivateLinkServiceConnectionArgs
                {
                    GroupIds = new[]
                    {
                        "groupIdFromResource",
                    },
                    PrivateLinkServiceId = "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls",
                },
            },
        },
        ResourceGroupName = "sjrg",
    });

});

    package main

import (
	streamanalytics "github.com/pulumi/pulumi-azure-native-sdk/streamanalytics"
	"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"),
			PrivateEndpointName: pulumi.String("testpe"),
			Properties: streamanalytics.PrivateEndpointPropertiesResponse{
				ManualPrivateLinkServiceConnections: streamanalytics.PrivateLinkServiceConnectionArray{
					&streamanalytics.PrivateLinkServiceConnectionArgs{
						GroupIds: pulumi.StringArray{
							pulumi.String("groupIdFromResource"),
						},
						PrivateLinkServiceId: pulumi.String("/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls"),
					},
				},
			},
			ResourceGroupName: pulumi.String("sjrg"),
		})
		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.azurenative.streamanalytics.PrivateEndpoint;
import com.pulumi.azurenative.streamanalytics.PrivateEndpointArgs;
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")
            .privateEndpointName("testpe")
            .properties(Map.of("manualPrivateLinkServiceConnections", Map.ofEntries(
                Map.entry("groupIds", "groupIdFromResource"),
                Map.entry("privateLinkServiceId", "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls")
            )))
            .resourceGroupName("sjrg")
            .build());

    }
}

    import pulumi
import pulumi_azure_native as azure_native

private_endpoint = azure_native.streamanalytics.PrivateEndpoint("privateEndpoint",
    cluster_name="testcluster",
    private_endpoint_name="testpe",
    properties=azure_native.streamanalytics.PrivateEndpointPropertiesResponseArgs(
        manual_private_link_service_connections=[azure_native.streamanalytics.PrivateLinkServiceConnectionArgs(
            group_ids=["groupIdFromResource"],
            private_link_service_id="/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls",
        )],
    ),
    resource_group_name="sjrg")

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

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

    resources:
  privateEndpoint:
    type: azure-native:streamanalytics:PrivateEndpoint
    properties:
      clusterName: testcluster
      privateEndpointName: testpe
      properties:
        manualPrivateLinkServiceConnections:
          - groupIds:
              - groupIdFromResource
            privateLinkServiceId: /subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls
      resourceGroupName: sjrg

    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,
                    private_endpoint_name: Optional[str] = None,
                    properties: Optional[PrivateEndpointPropertiesArgs] = 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 string
    The unique name of the resource.
    args PrivateEndpointArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args 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 string
    The unique name of the resource.
    args PrivateEndpointArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PrivateEndpointArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args 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",
    PrivateEndpointName = "string",
    Properties = 
    {
        { "manualPrivateLinkServiceConnections", new[]
        {
            
            {
                { "groupIds", new[]
                {
                    "string",
                } },
                { "privateLinkServiceId", "string" },
            },
        } },
    },
});

    example, err := streamanalytics.NewPrivateEndpoint(ctx, "azure-nativePrivateEndpointResource", &streamanalytics.PrivateEndpointArgs{
	ClusterName:         "string",
	ResourceGroupName:   "string",
	PrivateEndpointName: "string",
	Properties: map[string]interface{}{
		"manualPrivateLinkServiceConnections": []map[string]interface{}{
			map[string]interface{}{
				"groupIds": []string{
					"string",
				},
				"privateLinkServiceId": "string",
			},
		},
	},
})

    var azure_nativePrivateEndpointResource = new PrivateEndpoint("azure-nativePrivateEndpointResource", PrivateEndpointArgs.builder()
    .clusterName("string")
    .resourceGroupName("string")
    .privateEndpointName("string")
    .properties(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .build());

    azure_native_private_endpoint_resource = azure_native.streamanalytics.PrivateEndpoint("azure-nativePrivateEndpointResource",
    cluster_name=string,
    resource_group_name=string,
    private_endpoint_name=string,
    properties={
        manualPrivateLinkServiceConnections: [{
            groupIds: [string],
            privateLinkServiceId: string,
        }],
    })

    const azure_nativePrivateEndpointResource = new azure_native.streamanalytics.PrivateEndpoint("azure-nativePrivateEndpointResource", {
    clusterName: "string",
    resourceGroupName: "string",
    privateEndpointName: "string",
    properties: {
        manualPrivateLinkServiceConnections: [{
            groupIds: ["string"],
            privateLinkServiceId: "string",
        }],
    },
});

    type: azure-native:streamanalytics:PrivateEndpoint
properties:
    clusterName: string
    privateEndpointName: string
    properties:
        manualPrivateLinkServiceConnections:
            - groupIds:
                - string
              privateLinkServiceId: string
    resourceGroupName: string

    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 string
    The name of the cluster.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    PrivateEndpointName string
    The name of the private endpoint.
    Properties Pulumi.AzureNative.StreamAnalytics.Inputs.PrivateEndpointProperties
    The properties associated with a private endpoint.
    ClusterName string
    The name of the cluster.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    PrivateEndpointName string
    The name of the private endpoint.
    Properties PrivateEndpointPropertiesArgs
    The properties associated with a private endpoint.
    clusterName String
    The name of the cluster.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    privateEndpointName String
    The name of the private endpoint.
    properties PrivateEndpointProperties
    The properties associated with a private endpoint.
    clusterName string
    The name of the cluster.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    privateEndpointName string
    The name of the private endpoint.
    properties PrivateEndpointProperties
    The properties associated with a private endpoint.
    cluster_name str
    The name of the cluster.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    private_endpoint_name str
    The name of the private endpoint.
    properties PrivateEndpointPropertiesArgs
    The properties associated with a private endpoint.
    clusterName String
    The name of the cluster.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    privateEndpointName String
    The name of the private endpoint.
    properties Property Map
    The properties associated with a private endpoint.

    Outputs

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

    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.
    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.
    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.
    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.
    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.
    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

    PrivateEndpointProperties, PrivateEndpointPropertiesArgs

    ManualPrivateLinkServiceConnections []PrivateLinkServiceConnection
    A list of connections to the remote resource. Immutable after it is set.
    manualPrivateLinkServiceConnections List<PrivateLinkServiceConnection>
    A list of connections to the remote resource. Immutable after it is set.
    manualPrivateLinkServiceConnections PrivateLinkServiceConnection[]
    A list of connections to the remote resource. Immutable after it is set.
    manual_private_link_service_connections Sequence[PrivateLinkServiceConnection]
    A list of connections to the remote resource. Immutable after it is set.
    manualPrivateLinkServiceConnections List<Property Map>
    A list of connections to the remote resource. Immutable after it is set.

    PrivateEndpointPropertiesResponse, PrivateEndpointPropertiesResponseArgs

    CreatedDate string
    The date when this private endpoint was created.
    ManualPrivateLinkServiceConnections List<Pulumi.AzureNative.StreamAnalytics.Inputs.PrivateLinkServiceConnectionResponse>
    A list of connections to the remote resource. Immutable after it is set.
    CreatedDate string
    The date when this private endpoint was created.
    ManualPrivateLinkServiceConnections []PrivateLinkServiceConnectionResponse
    A list of connections to the remote resource. Immutable after it is set.
    createdDate String
    The date when this private endpoint was created.
    manualPrivateLinkServiceConnections List<PrivateLinkServiceConnectionResponse>
    A list of connections to the remote resource. Immutable after it is set.
    createdDate string
    The date when this private endpoint was created.
    manualPrivateLinkServiceConnections PrivateLinkServiceConnectionResponse[]
    A list of connections to the remote resource. Immutable after it is set.
    created_date str
    The date when this private endpoint was created.
    manual_private_link_service_connections Sequence[PrivateLinkServiceConnectionResponse]
    A list of connections to the remote resource. Immutable after it is set.
    createdDate String
    The date when this private endpoint was created.
    manualPrivateLinkServiceConnections List<Property Map>
    A list of connections to the remote resource. Immutable after it is set.

    PrivateLinkConnectionStateResponse, PrivateLinkConnectionStateResponseArgs

    ActionsRequired string
    A message indicating if changes on the service provider require any updates on the consumer.
    Description string
    The reason for approval/rejection of the connection.
    Status string
    Indicates whether the connection has been Approved/Rejected/Removed by the owner of the remote resource/service.
    ActionsRequired string
    A message indicating if changes on the service provider require any updates on the consumer.
    Description string
    The reason for approval/rejection of the connection.
    Status string
    Indicates whether the connection has been Approved/Rejected/Removed by the owner of the remote resource/service.
    actionsRequired String
    A message indicating if changes on the service provider require any updates on the consumer.
    description String
    The reason for approval/rejection of the connection.
    status String
    Indicates whether the connection has been Approved/Rejected/Removed by the owner of the remote resource/service.
    actionsRequired string
    A message indicating if changes on the service provider require any updates on the consumer.
    description string
    The reason for approval/rejection of the connection.
    status string
    Indicates whether the connection has been Approved/Rejected/Removed by the owner of the remote resource/service.
    actions_required str
    A message indicating if changes on the service provider require any updates on the consumer.
    description str
    The reason for approval/rejection of the connection.
    status str
    Indicates whether the connection has been Approved/Rejected/Removed by the owner of the remote resource/service.
    actionsRequired String
    A message indicating if changes on the service provider require any updates on the consumer.
    description String
    The reason for approval/rejection of the connection.
    status 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 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 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 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 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 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 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/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/clusters/testcluster/privateEndpoints/AnExamplePrivateEndpoint

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

    Package Details

    Repository
    azure-native-v1 pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native-v1 logo
    These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
    Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
    pulumi/pulumi-azure-native