Edit

Share via

New-AzKustoCluster

  • Reference
Module:
Az.Kusto

Create or update a Kusto cluster.

Syntax

New-AzKustoCluster
   -Name <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String>]
   [-IfMatch <String>]
   [-IfNoneMatch <String>]
   -Location <String>
   -SkuName <AzureSkuName>
   -SkuTier <AzureSkuTier>
   [-AcceptedAudience <IAcceptedAudiences[]>]
   [-AllowedFqdnList <String[]>]
   [-AllowedIPRangeList <String[]>]
   [-EnableAutoStop]
   [-EnableDiskEncryption]
   [-EnableDoubleEncryption]
   [-EnablePurge]
   [-EnableStreamingIngest]
   [-EngineType <EngineType>]
   [-IdentityType <IdentityType>]
   [-IdentityUserAssignedIdentity <Hashtable>]
   [-KeyVaultPropertyKeyName <String>]
   [-KeyVaultPropertyKeyVaultUri <String>]
   [-KeyVaultPropertyKeyVersion <String>]
   [-KeyVaultPropertyUserIdentity <String>]
   [-LanguageExtensionValue <ILanguageExtension[]>]
   [-OptimizedAutoscaleIsEnabled]
   [-OptimizedAutoscaleMaximum <Int32>]
   [-OptimizedAutoscaleMinimum <Int32>]
   [-OptimizedAutoscaleVersion <Int32>]
   [-PublicIPType <PublicIPType>]
   [-PublicNetworkAccess <PublicNetworkAccess>]
   [-RestrictOutboundNetworkAccess <ClusterNetworkAccessFlag>]
   [-SkuCapacity <Int32>]
   [-Tag <Hashtable>]
   [-TrustedExternalTenant <ITrustedExternalTenant[]>]
   [-VirtualClusterGraduationProperty <String>]
   [-VirtualNetworkConfigurationDataManagementPublicIPId <String>]
   [-VirtualNetworkConfigurationEnginePublicIPId <String>]
   [-VirtualNetworkConfigurationState <VnetState>]
   [-VirtualNetworkConfigurationSubnetId <String>]
   [-Zone <String[]>]
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Create or update a Kusto cluster.

Examples

Example 1: Create a new Kusto cluster

New-AzKustoCluster -ResourceGroupName testrg -Name testnewkustocluster -Location 'East US' -SkuName Standard_D11_v2 -SkuTier Standard -EnableDoubleEncryption -EngineType 'V2'

Location Name                Type                     Zone
-------- ----                ----                     ----
East US  testnewkustocluster Microsoft.Kusto/Clusters

The above command creates a new Kusto cluster named "testnewkustocluster" in the resource group "testrg".

Parameters

-AcceptedAudience

The cluster's accepted audiences. To construct, see NOTES section for ACCEPTEDAUDIENCE properties and create a hash table.

Type:IAcceptedAudiences[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-AllowedFqdnList

List of allowed FQDNs(Fully Qualified Domain Name) for egress from Cluster.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-AllowedIPRangeList

The list of ips in the format of CIDR allowed to connect to the cluster.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-AsJob

Run the command as a job

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

Type:PSObject
Aliases:AzureRMContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-EnableAutoStop

A boolean value that indicates if the cluster could be automatically stopped (due to lack of data or no activity for many days).

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-EnableDiskEncryption

A boolean value that indicates if the cluster's disks are encrypted.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-EnableDoubleEncryption

A boolean value that indicates if double encryption is enabled.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-EnablePurge

A boolean value that indicates if the purge operations are enabled.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-EnableStreamingIngest

A boolean value that indicates if the streaming ingest is enabled.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-EngineType

The engine type

Type:EngineType
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-IdentityType

The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove all identities.

Type:IdentityType
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-IdentityUserAssignedIdentity

The list of user identities associated with the Kusto cluster. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

Type:Hashtable
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-IfMatch

The ETag of the cluster. Omit this value to always overwrite the current cluster. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-IfNoneMatch

Set to '*' to allow a new cluster to be created, but to prevent updating an existing cluster. Other values will result in a 412 Pre-condition Failed response.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-KeyVaultPropertyKeyName

The name of the key vault key.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-KeyVaultPropertyKeyVaultUri

The Uri of the key vault.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-KeyVaultPropertyKeyVersion

The version of the key vault key.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-KeyVaultPropertyUserIdentity

The user assigned identity (ARM resource id) that has access to the key.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-LanguageExtensionValue

The list of language extensions. To construct, see NOTES section for LANGUAGEEXTENSIONVALUE properties and create a hash table.

Type:ILanguageExtension[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Location

The geo-location where the resource lives

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Name

The name of the Kusto cluster.

Type:String
Aliases:ClusterName
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-NoWait

Run the command asynchronously

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-OptimizedAutoscaleIsEnabled

A boolean value that indicate if the optimized autoscale feature is enabled or not.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-OptimizedAutoscaleMaximum

Maximum allowed instances count.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-OptimizedAutoscaleMinimum

Minimum allowed instances count.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-OptimizedAutoscaleVersion

The version of the template defined, for instance 1.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-PublicIPType

Indicates what public IP type to create - IPv4 (default), or DualStack (both IPv4 and IPv6)

Type:PublicIPType
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-PublicNetworkAccess

Public network access to the cluster is enabled by default. When disabled, only private endpoint connection to the cluster is allowed

Type:PublicNetworkAccess
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ResourceGroupName

The name of the resource group. The name is case insensitive.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-RestrictOutboundNetworkAccess

Whether or not to restrict outbound network access. Value is optional but if passed in, must be 'Enabled' or 'Disabled'

Type:ClusterNetworkAccessFlag
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SkuCapacity

The number of instances of the cluster.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SkuName

SKU name.

Type:AzureSkuName
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-SkuTier

SKU tier.

Type:AzureSkuTier
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-SubscriptionId

The ID of the target subscription.

Type:String
Position:Named
Default value:(Get-AzContext).Subscription.Id
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Tag

Resource tags.

Type:Hashtable
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-TrustedExternalTenant

The cluster's external tenants. To construct, see NOTES section for TRUSTEDEXTERNALTENANT properties and create a hash table.

Type:ITrustedExternalTenant[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-VirtualClusterGraduationProperty

Virtual Cluster graduation properties

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-VirtualNetworkConfigurationDataManagementPublicIPId

Data management's service public IP address resource id.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-VirtualNetworkConfigurationEnginePublicIPId

Engine service's public IP address resource id.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-VirtualNetworkConfigurationState

When enabled, the cluster is deployed into the configured subnet, when disabled it will be removed from the subnet.

Type:VnetState
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-VirtualNetworkConfigurationSubnetId

The subnet resource id.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Zone

The availability zones of the cluster.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Outputs

ICluster