We recommend using Azure Native.
azure.kusto.ClusterManagedPrivateEndpoint
Explore with Pulumi AI
Manages a Managed Private Endpoint for a Kusto Cluster.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const current = azure.core.getClientConfig({});
const example = new azure.core.ResourceGroup("example", {
name: "example-resources",
location: "West Europe",
});
const exampleCluster = new azure.kusto.Cluster("example", {
name: "examplekc",
location: example.location,
resourceGroupName: example.name,
sku: {
name: "Dev(No SLA)_Standard_D11_v2",
capacity: 1,
},
});
const exampleAccount = new azure.storage.Account("example", {
name: "examplesa",
resourceGroupName: example.name,
location: example.location,
accountTier: "Standard",
accountReplicationType: "LRS",
});
const exampleClusterManagedPrivateEndpoint = new azure.kusto.ClusterManagedPrivateEndpoint("example", {
name: "examplempe",
resourceGroupName: example.name,
clusterName: exampleCluster.name,
privateLinkResourceId: exampleAccount.id,
privateLinkResourceRegion: exampleAccount.location,
groupId: "blob",
requestMessage: "Please Approve",
});
import pulumi
import pulumi_azure as azure
current = azure.core.get_client_config()
example = azure.core.ResourceGroup("example",
name="example-resources",
location="West Europe")
example_cluster = azure.kusto.Cluster("example",
name="examplekc",
location=example.location,
resource_group_name=example.name,
sku={
"name": "Dev(No SLA)_Standard_D11_v2",
"capacity": 1,
})
example_account = azure.storage.Account("example",
name="examplesa",
resource_group_name=example.name,
location=example.location,
account_tier="Standard",
account_replication_type="LRS")
example_cluster_managed_private_endpoint = azure.kusto.ClusterManagedPrivateEndpoint("example",
name="examplempe",
resource_group_name=example.name,
cluster_name=example_cluster.name,
private_link_resource_id=example_account.id,
private_link_resource_region=example_account.location,
group_id="blob",
request_message="Please Approve")
package main
import (
"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/kusto"
"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/storage"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := core.GetClientConfig(ctx, map[string]interface{}{}, nil)
if err != nil {
return err
}
example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
Name: pulumi.String("example-resources"),
Location: pulumi.String("West Europe"),
})
if err != nil {
return err
}
exampleCluster, err := kusto.NewCluster(ctx, "example", &kusto.ClusterArgs{
Name: pulumi.String("examplekc"),
Location: example.Location,
ResourceGroupName: example.Name,
Sku: &kusto.ClusterSkuArgs{
Name: pulumi.String("Dev(No SLA)_Standard_D11_v2"),
Capacity: pulumi.Int(1),
},
})
if err != nil {
return err
}
exampleAccount, err := storage.NewAccount(ctx, "example", &storage.AccountArgs{
Name: pulumi.String("examplesa"),
ResourceGroupName: example.Name,
Location: example.Location,
AccountTier: pulumi.String("Standard"),
AccountReplicationType: pulumi.String("LRS"),
})
if err != nil {
return err
}
_, err = kusto.NewClusterManagedPrivateEndpoint(ctx, "example", &kusto.ClusterManagedPrivateEndpointArgs{
Name: pulumi.String("examplempe"),
ResourceGroupName: example.Name,
ClusterName: exampleCluster.Name,
PrivateLinkResourceId: exampleAccount.ID(),
PrivateLinkResourceRegion: exampleAccount.Location,
GroupId: pulumi.String("blob"),
RequestMessage: pulumi.String("Please Approve"),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() =>
{
var current = Azure.Core.GetClientConfig.Invoke();
var example = new Azure.Core.ResourceGroup("example", new()
{
Name = "example-resources",
Location = "West Europe",
});
var exampleCluster = new Azure.Kusto.Cluster("example", new()
{
Name = "examplekc",
Location = example.Location,
ResourceGroupName = example.Name,
Sku = new Azure.Kusto.Inputs.ClusterSkuArgs
{
Name = "Dev(No SLA)_Standard_D11_v2",
Capacity = 1,
},
});
var exampleAccount = new Azure.Storage.Account("example", new()
{
Name = "examplesa",
ResourceGroupName = example.Name,
Location = example.Location,
AccountTier = "Standard",
AccountReplicationType = "LRS",
});
var exampleClusterManagedPrivateEndpoint = new Azure.Kusto.ClusterManagedPrivateEndpoint("example", new()
{
Name = "examplempe",
ResourceGroupName = example.Name,
ClusterName = exampleCluster.Name,
PrivateLinkResourceId = exampleAccount.Id,
PrivateLinkResourceRegion = exampleAccount.Location,
GroupId = "blob",
RequestMessage = "Please Approve",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.CoreFunctions;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.kusto.Cluster;
import com.pulumi.azure.kusto.ClusterArgs;
import com.pulumi.azure.kusto.inputs.ClusterSkuArgs;
import com.pulumi.azure.storage.Account;
import com.pulumi.azure.storage.AccountArgs;
import com.pulumi.azure.kusto.ClusterManagedPrivateEndpoint;
import com.pulumi.azure.kusto.ClusterManagedPrivateEndpointArgs;
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 current = CoreFunctions.getClientConfig();
var example = new ResourceGroup("example", ResourceGroupArgs.builder()
.name("example-resources")
.location("West Europe")
.build());
var exampleCluster = new Cluster("exampleCluster", ClusterArgs.builder()
.name("examplekc")
.location(example.location())
.resourceGroupName(example.name())
.sku(ClusterSkuArgs.builder()
.name("Dev(No SLA)_Standard_D11_v2")
.capacity(1)
.build())
.build());
var exampleAccount = new Account("exampleAccount", AccountArgs.builder()
.name("examplesa")
.resourceGroupName(example.name())
.location(example.location())
.accountTier("Standard")
.accountReplicationType("LRS")
.build());
var exampleClusterManagedPrivateEndpoint = new ClusterManagedPrivateEndpoint("exampleClusterManagedPrivateEndpoint", ClusterManagedPrivateEndpointArgs.builder()
.name("examplempe")
.resourceGroupName(example.name())
.clusterName(exampleCluster.name())
.privateLinkResourceId(exampleAccount.id())
.privateLinkResourceRegion(exampleAccount.location())
.groupId("blob")
.requestMessage("Please Approve")
.build());
}
}
resources:
example:
type: azure:core:ResourceGroup
properties:
name: example-resources
location: West Europe
exampleCluster:
type: azure:kusto:Cluster
name: example
properties:
name: examplekc
location: ${example.location}
resourceGroupName: ${example.name}
sku:
name: Dev(No SLA)_Standard_D11_v2
capacity: 1
exampleAccount:
type: azure:storage:Account
name: example
properties:
name: examplesa
resourceGroupName: ${example.name}
location: ${example.location}
accountTier: Standard
accountReplicationType: LRS
exampleClusterManagedPrivateEndpoint:
type: azure:kusto:ClusterManagedPrivateEndpoint
name: example
properties:
name: examplempe
resourceGroupName: ${example.name}
clusterName: ${exampleCluster.name}
privateLinkResourceId: ${exampleAccount.id}
privateLinkResourceRegion: ${exampleAccount.location}
groupId: blob
requestMessage: Please Approve
variables:
current:
fn::invoke:
Function: azure:core:getClientConfig
Arguments: {}
Create ClusterManagedPrivateEndpoint Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ClusterManagedPrivateEndpoint(name: string, args: ClusterManagedPrivateEndpointArgs, opts?: CustomResourceOptions);
@overload
def ClusterManagedPrivateEndpoint(resource_name: str,
args: ClusterManagedPrivateEndpointArgs,
opts: Optional[ResourceOptions] = None)
@overload
def ClusterManagedPrivateEndpoint(resource_name: str,
opts: Optional[ResourceOptions] = None,
cluster_name: Optional[str] = None,
group_id: Optional[str] = None,
private_link_resource_id: Optional[str] = None,
resource_group_name: Optional[str] = None,
name: Optional[str] = None,
private_link_resource_region: Optional[str] = None,
request_message: Optional[str] = None)
func NewClusterManagedPrivateEndpoint(ctx *Context, name string, args ClusterManagedPrivateEndpointArgs, opts ...ResourceOption) (*ClusterManagedPrivateEndpoint, error)
public ClusterManagedPrivateEndpoint(string name, ClusterManagedPrivateEndpointArgs args, CustomResourceOptions? opts = null)
public ClusterManagedPrivateEndpoint(String name, ClusterManagedPrivateEndpointArgs args)
public ClusterManagedPrivateEndpoint(String name, ClusterManagedPrivateEndpointArgs args, CustomResourceOptions options)
type: azure:kusto:ClusterManagedPrivateEndpoint
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 ClusterManagedPrivateEndpointArgs
- 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 ClusterManagedPrivateEndpointArgs
- 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 ClusterManagedPrivateEndpointArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ClusterManagedPrivateEndpointArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ClusterManagedPrivateEndpointArgs
- 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 clusterManagedPrivateEndpointResource = new Azure.Kusto.ClusterManagedPrivateEndpoint("clusterManagedPrivateEndpointResource", new()
{
ClusterName = "string",
GroupId = "string",
PrivateLinkResourceId = "string",
ResourceGroupName = "string",
Name = "string",
PrivateLinkResourceRegion = "string",
RequestMessage = "string",
});
example, err := kusto.NewClusterManagedPrivateEndpoint(ctx, "clusterManagedPrivateEndpointResource", &kusto.ClusterManagedPrivateEndpointArgs{
ClusterName: pulumi.String("string"),
GroupId: pulumi.String("string"),
PrivateLinkResourceId: pulumi.String("string"),
ResourceGroupName: pulumi.String("string"),
Name: pulumi.String("string"),
PrivateLinkResourceRegion: pulumi.String("string"),
RequestMessage: pulumi.String("string"),
})
var clusterManagedPrivateEndpointResource = new ClusterManagedPrivateEndpoint("clusterManagedPrivateEndpointResource", ClusterManagedPrivateEndpointArgs.builder()
.clusterName("string")
.groupId("string")
.privateLinkResourceId("string")
.resourceGroupName("string")
.name("string")
.privateLinkResourceRegion("string")
.requestMessage("string")
.build());
cluster_managed_private_endpoint_resource = azure.kusto.ClusterManagedPrivateEndpoint("clusterManagedPrivateEndpointResource",
cluster_name="string",
group_id="string",
private_link_resource_id="string",
resource_group_name="string",
name="string",
private_link_resource_region="string",
request_message="string")
const clusterManagedPrivateEndpointResource = new azure.kusto.ClusterManagedPrivateEndpoint("clusterManagedPrivateEndpointResource", {
clusterName: "string",
groupId: "string",
privateLinkResourceId: "string",
resourceGroupName: "string",
name: "string",
privateLinkResourceRegion: "string",
requestMessage: "string",
});
type: azure:kusto:ClusterManagedPrivateEndpoint
properties:
clusterName: string
groupId: string
name: string
privateLinkResourceId: string
privateLinkResourceRegion: string
requestMessage: string
resourceGroupName: string
ClusterManagedPrivateEndpoint 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 ClusterManagedPrivateEndpoint resource accepts the following input properties:
- Cluster
Name string - The name of the Kusto Cluster. Changing this forces a new resource to be created.
- Group
Id string - The group id in which the managed private endpoint is created. Changing this forces a new resource to be created.
- Private
Link stringResource Id - The ARM resource ID of the resource for which the managed private endpoint is created. Changing this forces a new resource to be created.
- Resource
Group stringName - Specifies the Resource Group where the Kusto Cluster should exist. Changing this forces a new resource to be created.
- Name string
- The name of the Managed Private Endpoints to create. Changing this forces a new resource to be created.
- Private
Link stringResource Region - The region of the resource to which the managed private endpoint is created. Changing this forces a new resource to be created.
- Request
Message string - The user request message.
- Cluster
Name string - The name of the Kusto Cluster. Changing this forces a new resource to be created.
- Group
Id string - The group id in which the managed private endpoint is created. Changing this forces a new resource to be created.
- Private
Link stringResource Id - The ARM resource ID of the resource for which the managed private endpoint is created. Changing this forces a new resource to be created.
- Resource
Group stringName - Specifies the Resource Group where the Kusto Cluster should exist. Changing this forces a new resource to be created.
- Name string
- The name of the Managed Private Endpoints to create. Changing this forces a new resource to be created.
- Private
Link stringResource Region - The region of the resource to which the managed private endpoint is created. Changing this forces a new resource to be created.
- Request
Message string - The user request message.
- cluster
Name String - The name of the Kusto Cluster. Changing this forces a new resource to be created.
- group
Id String - The group id in which the managed private endpoint is created. Changing this forces a new resource to be created.
- private
Link StringResource Id - The ARM resource ID of the resource for which the managed private endpoint is created. Changing this forces a new resource to be created.
- resource
Group StringName - Specifies the Resource Group where the Kusto Cluster should exist. Changing this forces a new resource to be created.
- name String
- The name of the Managed Private Endpoints to create. Changing this forces a new resource to be created.
- private
Link StringResource Region - The region of the resource to which the managed private endpoint is created. Changing this forces a new resource to be created.
- request
Message String - The user request message.
- cluster
Name string - The name of the Kusto Cluster. Changing this forces a new resource to be created.
- group
Id string - The group id in which the managed private endpoint is created. Changing this forces a new resource to be created.
- private
Link stringResource Id - The ARM resource ID of the resource for which the managed private endpoint is created. Changing this forces a new resource to be created.
- resource
Group stringName - Specifies the Resource Group where the Kusto Cluster should exist. Changing this forces a new resource to be created.
- name string
- The name of the Managed Private Endpoints to create. Changing this forces a new resource to be created.
- private
Link stringResource Region - The region of the resource to which the managed private endpoint is created. Changing this forces a new resource to be created.
- request
Message string - The user request message.
- cluster_
name str - The name of the Kusto Cluster. Changing this forces a new resource to be created.
- group_
id str - The group id in which the managed private endpoint is created. Changing this forces a new resource to be created.
- private_
link_ strresource_ id - The ARM resource ID of the resource for which the managed private endpoint is created. Changing this forces a new resource to be created.
- resource_
group_ strname - Specifies the Resource Group where the Kusto Cluster should exist. Changing this forces a new resource to be created.
- name str
- The name of the Managed Private Endpoints to create. Changing this forces a new resource to be created.
- private_
link_ strresource_ region - The region of the resource to which the managed private endpoint is created. Changing this forces a new resource to be created.
- request_
message str - The user request message.
- cluster
Name String - The name of the Kusto Cluster. Changing this forces a new resource to be created.
- group
Id String - The group id in which the managed private endpoint is created. Changing this forces a new resource to be created.
- private
Link StringResource Id - The ARM resource ID of the resource for which the managed private endpoint is created. Changing this forces a new resource to be created.
- resource
Group StringName - Specifies the Resource Group where the Kusto Cluster should exist. Changing this forces a new resource to be created.
- name String
- The name of the Managed Private Endpoints to create. Changing this forces a new resource to be created.
- private
Link StringResource Region - The region of the resource to which the managed private endpoint is created. Changing this forces a new resource to be created.
- request
Message String - The user request message.
Outputs
All input properties are implicitly available as output properties. Additionally, the ClusterManagedPrivateEndpoint resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing ClusterManagedPrivateEndpoint Resource
Get an existing ClusterManagedPrivateEndpoint 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?: ClusterManagedPrivateEndpointState, opts?: CustomResourceOptions): ClusterManagedPrivateEndpoint
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
cluster_name: Optional[str] = None,
group_id: Optional[str] = None,
name: Optional[str] = None,
private_link_resource_id: Optional[str] = None,
private_link_resource_region: Optional[str] = None,
request_message: Optional[str] = None,
resource_group_name: Optional[str] = None) -> ClusterManagedPrivateEndpoint
func GetClusterManagedPrivateEndpoint(ctx *Context, name string, id IDInput, state *ClusterManagedPrivateEndpointState, opts ...ResourceOption) (*ClusterManagedPrivateEndpoint, error)
public static ClusterManagedPrivateEndpoint Get(string name, Input<string> id, ClusterManagedPrivateEndpointState? state, CustomResourceOptions? opts = null)
public static ClusterManagedPrivateEndpoint get(String name, Output<String> id, ClusterManagedPrivateEndpointState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- 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.
- Cluster
Name string - The name of the Kusto Cluster. Changing this forces a new resource to be created.
- Group
Id string - The group id in which the managed private endpoint is created. Changing this forces a new resource to be created.
- Name string
- The name of the Managed Private Endpoints to create. Changing this forces a new resource to be created.
- Private
Link stringResource Id - The ARM resource ID of the resource for which the managed private endpoint is created. Changing this forces a new resource to be created.
- Private
Link stringResource Region - The region of the resource to which the managed private endpoint is created. Changing this forces a new resource to be created.
- Request
Message string - The user request message.
- Resource
Group stringName - Specifies the Resource Group where the Kusto Cluster should exist. Changing this forces a new resource to be created.
- Cluster
Name string - The name of the Kusto Cluster. Changing this forces a new resource to be created.
- Group
Id string - The group id in which the managed private endpoint is created. Changing this forces a new resource to be created.
- Name string
- The name of the Managed Private Endpoints to create. Changing this forces a new resource to be created.
- Private
Link stringResource Id - The ARM resource ID of the resource for which the managed private endpoint is created. Changing this forces a new resource to be created.
- Private
Link stringResource Region - The region of the resource to which the managed private endpoint is created. Changing this forces a new resource to be created.
- Request
Message string - The user request message.
- Resource
Group stringName - Specifies the Resource Group where the Kusto Cluster should exist. Changing this forces a new resource to be created.
- cluster
Name String - The name of the Kusto Cluster. Changing this forces a new resource to be created.
- group
Id String - The group id in which the managed private endpoint is created. Changing this forces a new resource to be created.
- name String
- The name of the Managed Private Endpoints to create. Changing this forces a new resource to be created.
- private
Link StringResource Id - The ARM resource ID of the resource for which the managed private endpoint is created. Changing this forces a new resource to be created.
- private
Link StringResource Region - The region of the resource to which the managed private endpoint is created. Changing this forces a new resource to be created.
- request
Message String - The user request message.
- resource
Group StringName - Specifies the Resource Group where the Kusto Cluster should exist. Changing this forces a new resource to be created.
- cluster
Name string - The name of the Kusto Cluster. Changing this forces a new resource to be created.
- group
Id string - The group id in which the managed private endpoint is created. Changing this forces a new resource to be created.
- name string
- The name of the Managed Private Endpoints to create. Changing this forces a new resource to be created.
- private
Link stringResource Id - The ARM resource ID of the resource for which the managed private endpoint is created. Changing this forces a new resource to be created.
- private
Link stringResource Region - The region of the resource to which the managed private endpoint is created. Changing this forces a new resource to be created.
- request
Message string - The user request message.
- resource
Group stringName - Specifies the Resource Group where the Kusto Cluster should exist. Changing this forces a new resource to be created.
- cluster_
name str - The name of the Kusto Cluster. Changing this forces a new resource to be created.
- group_
id str - The group id in which the managed private endpoint is created. Changing this forces a new resource to be created.
- name str
- The name of the Managed Private Endpoints to create. Changing this forces a new resource to be created.
- private_
link_ strresource_ id - The ARM resource ID of the resource for which the managed private endpoint is created. Changing this forces a new resource to be created.
- private_
link_ strresource_ region - The region of the resource to which the managed private endpoint is created. Changing this forces a new resource to be created.
- request_
message str - The user request message.
- resource_
group_ strname - Specifies the Resource Group where the Kusto Cluster should exist. Changing this forces a new resource to be created.
- cluster
Name String - The name of the Kusto Cluster. Changing this forces a new resource to be created.
- group
Id String - The group id in which the managed private endpoint is created. Changing this forces a new resource to be created.
- name String
- The name of the Managed Private Endpoints to create. Changing this forces a new resource to be created.
- private
Link StringResource Id - The ARM resource ID of the resource for which the managed private endpoint is created. Changing this forces a new resource to be created.
- private
Link StringResource Region - The region of the resource to which the managed private endpoint is created. Changing this forces a new resource to be created.
- request
Message String - The user request message.
- resource
Group StringName - Specifies the Resource Group where the Kusto Cluster should exist. Changing this forces a new resource to be created.
Import
Managed Private Endpoint for a Kusto Cluster can be imported using the resource id
, e.g.
$ pulumi import azure:kusto/clusterManagedPrivateEndpoint:ClusterManagedPrivateEndpoint example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.Kusto/clusters/cluster1/managedPrivateEndpoints/managedPrivateEndpoint1
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Classic pulumi/pulumi-azure
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
azurerm
Terraform Provider.