Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The clusters/managedPrivateEndpoints resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Kusto/clusters/managedPrivateEndpoints resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Kusto/clusters/managedPrivateEndpoints@2022-02-01' = {
parent: resourceSymbolicName
name: 'string'
properties: {
groupId: 'string'
privateLinkResourceId: 'string'
privateLinkResourceRegion: 'string'
requestMessage: 'string'
}
}
Property Values
Microsoft.Kusto/clusters/managedPrivateEndpoints
| Name | Description | Value |
|---|---|---|
| name | The resource name | string (required) |
| parent | In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource. |
Symbolic name for resource of type: clusters |
| properties | A managed private endpoint. | ManagedPrivateEndpointProperties |
ManagedPrivateEndpointProperties
| Name | Description | Value |
|---|---|---|
| groupId | The groupId in which the managed private endpoint is created. | string (required) |
| privateLinkResourceId | The ARM resource ID of the resource for which the managed private endpoint is created. | string (required) |
| privateLinkResourceRegion | The region of the resource to which the managed private endpoint is created. | string |
| requestMessage | The user request message. | string |
ARM template resource definition
The clusters/managedPrivateEndpoints resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Kusto/clusters/managedPrivateEndpoints resource, add the following JSON to your template.
{
"type": "Microsoft.Kusto/clusters/managedPrivateEndpoints",
"apiVersion": "2022-02-01",
"name": "string",
"properties": {
"groupId": "string",
"privateLinkResourceId": "string",
"privateLinkResourceRegion": "string",
"requestMessage": "string"
}
}
Property Values
Microsoft.Kusto/clusters/managedPrivateEndpoints
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2022-02-01' |
| name | The resource name | string (required) |
| properties | A managed private endpoint. | ManagedPrivateEndpointProperties |
| type | The resource type | 'Microsoft.Kusto/clusters/managedPrivateEndpoints' |
ManagedPrivateEndpointProperties
| Name | Description | Value |
|---|---|---|
| groupId | The groupId in which the managed private endpoint is created. | string (required) |
| privateLinkResourceId | The ARM resource ID of the resource for which the managed private endpoint is created. | string (required) |
| privateLinkResourceRegion | The region of the resource to which the managed private endpoint is created. | string |
| requestMessage | The user request message. | string |
Usage Examples
Terraform (AzAPI provider) resource definition
The clusters/managedPrivateEndpoints resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Kusto/clusters/managedPrivateEndpoints resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Kusto/clusters/managedPrivateEndpoints@2022-02-01"
name = "string"
parent_id = "string"
body = {
properties = {
groupId = "string"
privateLinkResourceId = "string"
privateLinkResourceRegion = "string"
requestMessage = "string"
}
}
}
Property Values
Microsoft.Kusto/clusters/managedPrivateEndpoints
| Name | Description | Value |
|---|---|---|
| name | The resource name | string (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: clusters |
| properties | A managed private endpoint. | ManagedPrivateEndpointProperties |
| type | The resource type | "Microsoft.Kusto/clusters/managedPrivateEndpoints@2022-02-01" |
ManagedPrivateEndpointProperties
| Name | Description | Value |
|---|---|---|
| groupId | The groupId in which the managed private endpoint is created. | string (required) |
| privateLinkResourceId | The ARM resource ID of the resource for which the managed private endpoint is created. | string (required) |
| privateLinkResourceRegion | The region of the resource to which the managed private endpoint is created. | string |
| requestMessage | The user request message. | string |
Usage Examples
Terraform Samples
A basic example of deploying Managed Private Endpoint for a Kusto Cluster.
terraform {
required_providers {
azapi = {
source = "Azure/azapi"
}
}
}
provider "azapi" {
skip_provider_registration = false
}
variable "resource_name" {
type = string
default = "acctest0001"
}
variable "location" {
type = string
default = "westeurope"
}
resource "azapi_resource" "resourceGroup" {
type = "Microsoft.Resources/resourceGroups@2020-06-01"
name = var.resource_name
location = var.location
}
resource "azapi_resource" "storageAccount" {
type = "Microsoft.Storage/storageAccounts@2021-09-01"
parent_id = azapi_resource.resourceGroup.id
name = var.resource_name
location = var.location
body = {
kind = "StorageV2"
properties = {
accessTier = "Hot"
allowBlobPublicAccess = true
allowCrossTenantReplication = true
allowSharedKeyAccess = true
defaultToOAuthAuthentication = false
encryption = {
keySource = "Microsoft.Storage"
services = {
queue = {
keyType = "Service"
}
table = {
keyType = "Service"
}
}
}
isHnsEnabled = false
isNfsV3Enabled = false
isSftpEnabled = false
minimumTlsVersion = "TLS1_2"
networkAcls = {
defaultAction = "Allow"
}
publicNetworkAccess = "Enabled"
supportsHttpsTrafficOnly = true
}
sku = {
name = "Standard_LRS"
}
}
schema_validation_enabled = false
response_export_values = ["*"]
}
resource "azapi_resource" "cluster" {
type = "Microsoft.Kusto/clusters@2023-05-02"
parent_id = azapi_resource.resourceGroup.id
name = var.resource_name
location = var.location
body = {
properties = {
enableAutoStop = true
enableDiskEncryption = false
enableDoubleEncryption = false
enablePurge = false
enableStreamingIngest = false
engineType = "V2"
publicIPType = "IPv4"
publicNetworkAccess = "Enabled"
restrictOutboundNetworkAccess = "Disabled"
trustedExternalTenants = [
]
}
sku = {
capacity = 1
name = "Dev(No SLA)_Standard_D11_v2"
tier = "Basic"
}
}
schema_validation_enabled = false
response_export_values = ["*"]
}
resource "azapi_resource" "managedPrivateEndpoint" {
type = "Microsoft.Kusto/clusters/managedPrivateEndpoints@2023-05-02"
parent_id = azapi_resource.cluster.id
name = var.resource_name
body = {
properties = {
groupId = "blob"
privateLinkResourceId = azapi_resource.storageAccount.id
}
}
schema_validation_enabled = false
response_export_values = ["*"]
}