Edit

Update-AzSynapseKustoPool

  • Reference
Module:
Az.Synapse

Update a Kusto Kusto Pool.

Syntax

Update-AzSynapseKustoPool
      -Name <String>
      -ResourceGroupName <String>
      -WorkspaceName <String>
      [-SubscriptionId <String>]
      [-IfMatch <String>]
      [-EnablePurge]
      [-EnableStreamingIngest]
      [-OptimizedAutoscaleIsEnabled]
      [-OptimizedAutoscaleMaximum <Int32>]
      [-OptimizedAutoscaleMinimum <Int32>]
      [-OptimizedAutoscaleVersion <Int32>]
      [-SkuCapacity <Int32>]
      [-SkuName <SkuName>]
      [-SkuSize <SkuSize>]
      [-Tag <Hashtable>]
      [-WorkspaceUid <String>]
      [-DefaultProfile <PSObject>]
      [-AsJob]
      [-NoWait]
      [-Confirm]
      [-WhatIf]
      [<CommonParameters>]
Update-AzSynapseKustoPool
      -InputObject <ISynapseIdentity>
      [-IfMatch <String>]
      [-EnablePurge]
      [-EnableStreamingIngest]
      [-OptimizedAutoscaleIsEnabled]
      [-OptimizedAutoscaleMaximum <Int32>]
      [-OptimizedAutoscaleMinimum <Int32>]
      [-OptimizedAutoscaleVersion <Int32>]
      [-SkuCapacity <Int32>]
      [-SkuName <SkuName>]
      [-SkuSize <SkuSize>]
      [-Tag <Hashtable>]
      [-WorkspaceUid <String>]
      [-DefaultProfile <PSObject>]
      [-AsJob]
      [-NoWait]
      [-Confirm]
      [-WhatIf]
      [<CommonParameters>]

Description

Update a Kusto Kusto Pool.

Examples

Example 1: Update an existing cluster by name

Update-AzSynapseKustoPool -ResourceGroupName testrg -WorkspaceName testws -Name testnewkustopool -SkuName "Storage optimized" -SkuSize Medium

Location  Name                    Type                                    Etag
--------  ----                    ----                                    ----
East US 2 testws/testnewkustopool Microsoft.Synapse/workspaces/kustoPools

The above command updates the sku of the Kusto pool "testnewkustopool" found in the workspace "testws".

Parameters

-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 credentials, account, tenant, and subscription used for communication with Azure.

Type:PSObject
Aliases:AzureRMContext, AzureCredential
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

-IfMatch

The ETag of the Kusto Pool. Omit this value to always overwrite the current Kusto Pool. 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

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

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

-Name

The name of the Kusto pool.

Type:String
Aliases:KustoPoolName
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

-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

-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:SkuName
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SkuSize

SKU size.

Type:SkuSize
Position:Named
Default value:None
Required:False
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

-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

-WorkspaceName

The name of the workspace

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

-WorkspaceUid

The workspace unique identifier.

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

Inputs

ISynapseIdentity

Outputs

IKustoPool

Notes

ALIASES

COMPLEX PARAMETER PROPERTIES

To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.

INPUTOBJECT <ISynapseIdentity>: Identity Parameter

  • [AttachedDatabaseConfigurationName <String>]: The name of the attached database configuration.
  • [DataConnectionName <String>]: The name of the data connection.
  • [DatabaseName <String>]: The name of the database in the Kusto pool.
  • [Id <String>]: Resource identity path
  • [KustoPoolName <String>]: The name of the Kusto pool.
  • [Location <String>]: The name of Azure region.
  • [PrincipalAssignmentName <String>]: The name of the Kusto principalAssignment.
  • [ResourceGroupName <String>]: The name of the resource group. The name is case insensitive.
  • [SubscriptionId <String>]: The ID of the target subscription.
  • [WorkspaceName <String>]: The name of the workspace