Update-AzKustoCluster
Syntax
UpdateExpanded (Default)
Update-AzKustoCluster
-Name <String>
-ResourceGroupName <String>
[-SubscriptionId <String>]
[-IfMatch <String>]
[-AcceptedAudience <IAcceptedAudiences[]>]
[-AllowedFqdnList <String[]>]
[-AllowedIPRangeList <String[]>]
[-CalloutPolicy <ICalloutPolicy[]>]
[-EnableAutoStop]
[-EnableDiskEncryption]
[-EnableDoubleEncryption]
[-EnablePurge]
[-EnableStreamingIngest]
[-EngineType <EngineType>]
[-IdentityType <IdentityType>]
[-IdentityUserAssignedIdentity <Hashtable>]
[-KeyVaultPropertyKeyName <String>]
[-KeyVaultPropertyKeyVaultUri <String>]
[-KeyVaultPropertyKeyVersion <String>]
[-KeyVaultPropertyUserIdentity <String>]
[-LanguageExtensionValue <ILanguageExtension[]>]
[-Location <String>]
[-OptimizedAutoscaleIsEnabled]
[-OptimizedAutoscaleMaximum <Int32>]
[-OptimizedAutoscaleMinimum <Int32>]
[-OptimizedAutoscaleVersion <Int32>]
[-PublicIPType <PublicIPType>]
[-PublicNetworkAccess <PublicNetworkAccess>]
[-RestrictOutboundNetworkAccess <ClusterNetworkAccessFlag>]
[-SkuCapacity <Int32>]
[-SkuName <AzureSkuName>]
[-SkuTier <AzureSkuTier>]
[-Tag <Hashtable>]
[-TrustedExternalTenant <ITrustedExternalTenant[]>]
[-VirtualClusterGraduationProperty <String>]
[-VirtualNetworkConfigurationDataManagementPublicIPId <String>]
[-VirtualNetworkConfigurationEnginePublicIPId <String>]
[-VirtualNetworkConfigurationState <VnetState>]
[-VirtualNetworkConfigurationSubnetId <String>]
[-Zone <String[]>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
UpdateViaIdentityExpanded
Update-AzKustoCluster
-InputObject <IKustoIdentity>
[-IfMatch <String>]
[-AcceptedAudience <IAcceptedAudiences[]>]
[-AllowedFqdnList <String[]>]
[-AllowedIPRangeList <String[]>]
[-CalloutPolicy <ICalloutPolicy[]>]
[-EnableAutoStop]
[-EnableDiskEncryption]
[-EnableDoubleEncryption]
[-EnablePurge]
[-EnableStreamingIngest]
[-EngineType <EngineType>]
[-IdentityType <IdentityType>]
[-IdentityUserAssignedIdentity <Hashtable>]
[-KeyVaultPropertyKeyName <String>]
[-KeyVaultPropertyKeyVaultUri <String>]
[-KeyVaultPropertyKeyVersion <String>]
[-KeyVaultPropertyUserIdentity <String>]
[-LanguageExtensionValue <ILanguageExtension[]>]
[-Location <String>]
[-OptimizedAutoscaleIsEnabled]
[-OptimizedAutoscaleMaximum <Int32>]
[-OptimizedAutoscaleMinimum <Int32>]
[-OptimizedAutoscaleVersion <Int32>]
[-PublicIPType <PublicIPType>]
[-PublicNetworkAccess <PublicNetworkAccess>]
[-RestrictOutboundNetworkAccess <ClusterNetworkAccessFlag>]
[-SkuCapacity <Int32>]
[-SkuName <AzureSkuName>]
[-SkuTier <AzureSkuTier>]
[-Tag <Hashtable>]
[-TrustedExternalTenant <ITrustedExternalTenant[]>]
[-VirtualClusterGraduationProperty <String>]
[-VirtualNetworkConfigurationDataManagementPublicIPId <String>]
[-VirtualNetworkConfigurationEnginePublicIPId <String>]
[-VirtualNetworkConfigurationState <VnetState>]
[-VirtualNetworkConfigurationSubnetId <String>]
[-Zone <String[]>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Examples
Example 1: Update an existing cluster by name
Update-AzKustoCluster -ResourceGroupName testrg -Name testnewkustocluster -SkuName Standard_D12_v2 -SkuTier Standard -EngineType 'V2'
Location Name Type Zone
-------- ---- ---- ----
East US testnewkustocluster Microsoft.Kusto/Clusters
The above command updates the sku of the Kusto cluster "testnewkustocluster" found in the resource group "testrg".
Example 2: Update an existing cluster by name
Update-AzKustoCluster -ResourceGroupName testrg -Name testnewkustocluster -KeyVaultPropertyKeyName "TestKey" -KeyVaultPropertyKeyVaultUri "https://testpskeyvault.vault.azure.net" -KeyVaultPropertyKeyVersion "4bd66f0e0d7c403fac80305e0355d982"
Location Name Type Zone
-------- ---- ---- ----
East US testnewkustocluster Microsoft.Kusto/Clusters
The above command updates the cluster "testnewkustocluster" found in the resource group "testrg" with a customer managed key.
Parameters
-AcceptedAudience
The cluster's accepted audiences.
To construct, see NOTES section for ACCEPTEDAUDIENCE properties and create a hash table.
Parameter properties
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-AllowedFqdnList
List of allowed FQDNs(Fully Qualified Domain Name) for egress from Cluster.
Parameter properties
Type: String [ ]
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-AllowedIPRangeList
The list of ips in the format of CIDR allowed to connect to the cluster.
Parameter properties
Type: String [ ]
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-AsJob
Run the command as a job
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-CalloutPolicy
List of callout policies for egress from Cluster.
To construct, see NOTES section for CALLOUTPOLICY properties and create a hash table.
Parameter properties
Type: ICalloutPolicy [ ]
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: cf
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DefaultProfile
The DefaultProfile parameter is not functional.
Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.
Parameter properties
Type: PSObject
Default value: None Supports wildcards: False DontShow: False Aliases: AzureRMContext, AzureCredential
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: 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).
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-EnableDiskEncryption
A boolean value that indicates if the cluster's disks are encrypted.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-EnableDoubleEncryption
A boolean value that indicates if double encryption is enabled.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-EnablePurge
A boolean value that indicates if the purge operations are enabled.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-EnableStreamingIngest
A boolean value that indicates if the streaming ingest is enabled.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-EngineType
The engine type
Parameter properties
Type: EngineType
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: 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.
Parameter properties
Type: IdentityType
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: 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}'.
Parameter properties
Type: Hashtable
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: 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.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Identity Parameter
To construct, see NOTES section for INPUTOBJECT properties and create a hash table.
Type: IKustoIdentity
Default value: None Supports wildcards: False DontShow: False
UpdateViaIdentityExpanded
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-KeyVaultPropertyKeyName
The name of the key vault key.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-KeyVaultPropertyKeyVaultUri
The Uri of the key vault.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-KeyVaultPropertyKeyVersion
The version of the key vault key.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-KeyVaultPropertyUserIdentity
The user assigned identity (ARM resource id) that has access to the key.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-LanguageExtensionValue
The list of language extensions.
To construct, see NOTES section for LANGUAGEEXTENSIONVALUE properties and create a hash table.
Parameter properties
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Location
Resource location.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Name
The name of the Kusto cluster.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False Aliases: ClusterName
Parameter sets
UpdateExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-NoWait
Run the command asynchronously
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-OptimizedAutoscaleIsEnabled
A boolean value that indicate if the optimized autoscale feature is enabled or not.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-OptimizedAutoscaleMaximum
Maximum allowed instances count.
Parameter properties
Type: Int32
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-OptimizedAutoscaleMinimum
Minimum allowed instances count.
Parameter properties
Type: Int32
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-OptimizedAutoscaleVersion
The version of the template defined, for instance 1.
Parameter properties
Type: Int32
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-PublicIPType
Indicates what public IP type to create - IPv4 (default), or DualStack (both IPv4 and IPv6)
Parameter properties
Type: PublicIPType
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-PublicNetworkAccess
Public network access to the cluster is enabled by default.
When disabled, only private endpoint connection to the cluster is allowed
Parameter properties
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ResourceGroupName
The name of the resource group.
The name is case insensitive.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-RestrictOutboundNetworkAccess
Whether or not to restrict outbound network access.
Value is optional but if passed in, must be 'Enabled' or 'Disabled'
Parameter properties
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SkuCapacity
The number of instances of the cluster.
Parameter properties
Type: Int32
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SkuName
SKU name.
Parameter properties
Type: AzureSkuName
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SkuTier
SKU tier.
Parameter properties
Type: AzureSkuTier
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SubscriptionId
The ID of the target subscription.
Parameter properties
Type: String
Default value: (Get-AzContext).Subscription.Id Supports wildcards: False DontShow: False
Parameter sets
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Tag
Resource tags.
Parameter properties
Type: Hashtable
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-TrustedExternalTenant
The cluster's external tenants.
To construct, see NOTES section for TRUSTEDEXTERNALTENANT properties and create a hash table.
Parameter properties
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-VirtualClusterGraduationProperty
Virtual Cluster graduation properties
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-VirtualNetworkConfigurationDataManagementPublicIPId
Data management's service public IP address resource id.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-VirtualNetworkConfigurationEnginePublicIPId
Engine service's public IP address resource id.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-VirtualNetworkConfigurationState
When enabled, the cluster is deployed into the configured subnet, when disabled it will be removed from the subnet.
Parameter properties
Type: VnetState
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-VirtualNetworkConfigurationSubnetId
The subnet resource id.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-WhatIf
Shows what would happen if the cmdlet runs.
The cmdlet is not run.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: wi
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Zone
The availability zones of the cluster.
Parameter properties
Type: String [ ]
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable,
-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
about_CommonParameters .
Outputs
