Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
Update-AzKustoCluster
- Module:
- Az.Kusto Module
Update a Kusto cluster.
Syntax
UpdateExpanded (Default)
Update-AzKustoCluster
-Name <String>
-ResourceGroupName <String>
[-SubscriptionId <String>]
[-IfMatch <String>]
[-IfNoneMatch <String>]
[-AcceptedAudience <IAcceptedAudiences[]>]
[-AllowedFqdnList <String[]>]
[-AllowedIPRangeList <String[]>]
[-CalloutPolicy <ICalloutPolicy[]>]
[-EnableAutoStop]
[-EnableDiskEncryption]
[-EnableDoubleEncryption]
[-EnablePurge]
[-EnableStreamingIngest]
[-EnableSystemAssignedIdentity <Boolean>]
[-EngineType <String>]
[-KeyVaultPropertyKeyName <String>]
[-KeyVaultPropertyKeyVaultUri <String>]
[-KeyVaultPropertyKeyVersion <String>]
[-KeyVaultPropertyUserIdentity <String>]
[-LanguageExtensionValue <ILanguageExtension[]>]
[-OptimizedAutoscaleIsEnabled]
[-OptimizedAutoscaleMaximum <Int32>]
[-OptimizedAutoscaleMinimum <Int32>]
[-OptimizedAutoscaleVersion <Int32>]
[-PublicIPType <String>]
[-PublicNetworkAccess <String>]
[-RestrictOutboundNetworkAccess <String>]
[-SkuCapacity <Int32>]
[-SkuName <String>]
[-SkuTier <String>]
[-Tag <Hashtable>]
[-TrustedExternalTenant <ITrustedExternalTenant[]>]
[-UserAssignedIdentity <String[]>]
[-VirtualNetworkConfigurationState <String>]
[-Zone <String[]>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
UpdateViaIdentityExpanded
Update-AzKustoCluster
-InputObject <IKustoIdentity>
[-IfMatch <String>]
[-IfNoneMatch <String>]
[-AcceptedAudience <IAcceptedAudiences[]>]
[-AllowedFqdnList <String[]>]
[-AllowedIPRangeList <String[]>]
[-CalloutPolicy <ICalloutPolicy[]>]
[-EnableAutoStop]
[-EnableDiskEncryption]
[-EnableDoubleEncryption]
[-EnablePurge]
[-EnableStreamingIngest]
[-EnableSystemAssignedIdentity <Boolean>]
[-EngineType <String>]
[-KeyVaultPropertyKeyName <String>]
[-KeyVaultPropertyKeyVaultUri <String>]
[-KeyVaultPropertyKeyVersion <String>]
[-KeyVaultPropertyUserIdentity <String>]
[-LanguageExtensionValue <ILanguageExtension[]>]
[-OptimizedAutoscaleIsEnabled]
[-OptimizedAutoscaleMaximum <Int32>]
[-OptimizedAutoscaleMinimum <Int32>]
[-OptimizedAutoscaleVersion <Int32>]
[-PublicIPType <String>]
[-PublicNetworkAccess <String>]
[-RestrictOutboundNetworkAccess <String>]
[-SkuCapacity <Int32>]
[-SkuName <String>]
[-SkuTier <String>]
[-Tag <Hashtable>]
[-TrustedExternalTenant <ITrustedExternalTenant[]>]
[-UserAssignedIdentity <String[]>]
[-VirtualNetworkConfigurationState <String>]
[-Zone <String[]>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Update a Kusto cluster.
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.
Parameter properties
| Type: | Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IAcceptedAudiences[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-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
-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
-AsJob
Run the command as a job
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-CalloutPolicy
List of callout policies for egress from Cluster.
Parameter properties
| Type: | Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.ICalloutPolicy[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-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
-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
-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
-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
-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
-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
-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
-EnableSystemAssignedIdentity
Determines whether to enable a system-assigned identity for the resource.
Parameter properties
| Type: | |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-EngineType
The engine type
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-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
-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.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-InputObject
Identity Parameter
Parameter properties
| Type: | IKustoIdentity |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-KeyVaultPropertyKeyName
The name of the key vault key.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-KeyVaultPropertyKeyVaultUri
The Uri of the key vault.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-KeyVaultPropertyKeyVersion
The version of the key vault key.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-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
-LanguageExtensionValue
The list of language extensions.
Parameter properties
| Type: | Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.ILanguageExtension[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Name
The name of the Kusto cluster.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | ClusterName |
Parameter sets
-NoWait
Run the command asynchronously
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-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
-OptimizedAutoscaleMaximum
Maximum allowed instances count.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-OptimizedAutoscaleMinimum
Minimum allowed instances count.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-OptimizedAutoscaleVersion
The version of the template defined, for instance 1.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-PublicIPType
Indicates what public IP type to create - IPv4 (default), or DualStack (both IPv4 and IPv6)
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-PublicNetworkAccess
Public network access to the cluster is enabled by default. When disabled, only private endpoint connection to the cluster is allowed
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-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
-RestrictOutboundNetworkAccess
Whether or not to restrict outbound network access. Value is optional but if passed in, must be 'Enabled' or 'Disabled'
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-SkuCapacity
The number of instances of the cluster.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-SkuName
SKU name.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-SkuTier
SKU tier.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-SubscriptionId
The ID of the target subscription.
Parameter properties
| Type: | String |
| Default value: | (Get-AzContext).Subscription.Id |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Tag
Resource tags.
Parameter properties
| Type: | Hashtable |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-TrustedExternalTenant
The cluster's external tenants.
Parameter properties
| Type: | Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.ITrustedExternalTenant[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-UserAssignedIdentity
The array of user assigned identities associated with the resource. The elements in array will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.'
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-VirtualNetworkConfigurationState
When enabled, the cluster is deployed into the configured subnet, when disabled it will be removed from the subnet.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-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
-Zone
The availability zones of the cluster.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
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.
Inputs
IKustoIdentity
Outputs
Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.ICluster
Azure PowerShell
Feedback
Was this page helpful?