Set-AzSqlElasticPool
Modifies properties of an elastic database pool in Azure SQL Database.
Syntax
Set-AzSqlElasticPool
[-ElasticPoolName] <String>
[-Edition <String>]
[-Dtu <Int32>]
[-StorageMB <Int32>]
[-DatabaseDtuMin <Int32>]
[-DatabaseDtuMax <Int32>]
[-Tags <Hashtable>]
[-ZoneRedundant]
[-LicenseType <String>]
[-MaintenanceConfigurationId <String>]
[-HighAvailabilityReplicaCount <Int32>]
[-PreferredEnclaveType <String>]
[-AsJob]
[-ServerName] <String>
[-ResourceGroupName] <String>
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Set-AzSqlElasticPool
[-ElasticPoolName] <String>
[-Edition <String>]
[-StorageMB <Int32>]
[-VCore <Int32>]
[-ComputeGeneration <String>]
[-DatabaseVCoreMin <Double>]
[-DatabaseVCoreMax <Double>]
[-Tags <Hashtable>]
[-ZoneRedundant]
[-LicenseType <String>]
[-MaintenanceConfigurationId <String>]
[-HighAvailabilityReplicaCount <Int32>]
[-PreferredEnclaveType <String>]
[-AsJob]
[-ServerName] <String>
[-ResourceGroupName] <String>
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
The Set-AzSqlElasticPool cmdlet sets properties for an elastic pool in Azure SQL Database. This cmdlet can modify the eDTUs per pool (Dtu), storage max size per pool (StorageMB), maximum eDTUs per database (DatabaseDtuMax), and minimum eDTUs per database (DatabaseDtuMin). Several parameters (-Dtu, -DatabaseDtuMin, and -DatabaseDtuMax) require the value being set is from the list of valid values for that parameter. For example, -DatabaseDtuMax for a Standard 100 eDTU pool can only be set to 10, 20, 50, or 100. For details about which values are valid, see the table for your specific size pool in elastic pools.
Examples
Example 1: Modify properties for an elastic pool
Set-AzSqlElasticPool -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -ElasticPoolName "ElasticPool01" -Dtu 1000 -DatabaseDtuMax 100 -DatabaseDtuMin 20
ResourceId : /subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/resourcegroup01/providers/Microsoft.Sql/servers/Server01/elasticPools/ElasticPool01
ResourceGroupName : ResourceGroup01
ServerName : Server01
ElasticPoolName : ElasticPool01
Location : Central US
CreationDate : 8/26/2015 10:00:17 PM
State : Ready
Edition : Standard
Dtu : 200
DatabaseDtuMax : 100
DatabaseDtuMin : 20
StorageMB : 204800
Tags :This command modifies properties for an elastic pool named elasticpool01. The command sets the number of DTUs for the elastic pool to 1000 and sets the minimum and maximum DTUs.
Example 2: Modify the storage max size of an elastic pool
Set-AzSqlElasticPool -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -ElasticPoolName "ElasticPool01" -StorageMB 2097152
ResourceId : /subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/resourcegroup01/providers/Microsoft.Sql/servers/Server01/elasticPools/ElasticPool01
ResourceGroupName : ResourceGroup01
ServerName : Server01
ElasticPoolName : ElasticPool01
Location : Central US
CreationDate : 8/26/2015 10:00:17 PM
State : Ready
Edition : Premium
Dtu : 200
DatabaseDtuMax : 100
DatabaseDtuMin : 20
StorageMB : 2097152
Tags :This command modifies properties for an elastic pool named elasticpool01. The command sets the max storage for an elastic pool to 2 TB.
Example 3
Modifies properties of an elastic database pool in Azure SQL Database. (autogenerated)
Set-AzSqlElasticPool -Dtu 1000 -Edition 'GeneralPurpose' -ElasticPoolName 'ElasticPool01' -ResourceGroupName 'ResourceGroup01' -ServerName 'Server01'Example 4: Modify the preferred enclave type of an elastic pool to VBS
Set-AzSqlElasticPool -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -ElasticPoolName "ElasticPool01" -PreferredEnclaveType "VBS"
ResourceId : /subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/resourcegroup01/providers/Microsoft.Sql/servers/Server01/elasticPools/ElasticPool01
ResourceGroupName : ResourceGroup01
ServerName : Server01
ElasticPoolName : ElasticPool01
Location : Central US
CreationDate : 8/26/2015 10:00:17 PM
State : Ready
Edition : Premium
Dtu : 200
DatabaseDtuMax : 100
DatabaseDtuMin : 20
StorageMB : 2097152
PreferredEnclaveType : VBS
Tags :This command updates an elastic pool to configure VBS enclave on it
Parameters
-AsJob
Run cmdlet in the background
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ComputeGeneration
The compute generation to assign.
| Type: | String |
| Aliases: | Family |
| 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: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DatabaseDtuMax
Specifies the maximum number of DTUs that any single database in the pool can consume. For details about which values are valid, see the table for your specific size pool in elastic pools. The default values for different editions are as follows:
- Basic. 5 DTUs
- Standard. 100 DTUs
- Premium. 125 DTUs
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DatabaseDtuMin
Specifies the minimum number of DTUs that the elastic pool guarantees to all the databases in the pool. For details about which values are valid, see the table for your specific size pool in elastic pools. The default value is zero (0).
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DatabaseVCoreMax
The maximum VCore number any SqlAzure Database can consume in the pool.
| Type: | Double |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DatabaseVCoreMin
The minimum VCore number any SqlAzure Database can consume in the pool.
| Type: | Double |
| 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: | IAzureContextContainer |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Dtu
Specifies the total number of shared DTUs for the elastic pool. For details about which values are valid, see the table for your specific size pool in elastic pools. The default values for different editions are as follows:
- Basic. 100 DTUs
- Standard. 100 DTUs
- Premium. 125 DTUs
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Edition
Specifies the edition of the Azure SQL Database for the elastic pool. You cannot change the edition. The acceptable values for this parameter are:
- None
- Basic
- Standard
- Premium
- DataWarehouse
- Free
- Stretch
- GeneralPurpose
- BusinessCritical
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ElasticPoolName
Specifies the name of the elastic pool.
| Type: | String |
| Aliases: | Name |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-HighAvailabilityReplicaCount
The total number of high availability replicas associated with the elastic pool.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-LicenseType
The license type for the Azure Sql database.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-MaintenanceConfigurationId
The Maintenance configuration id for the SQL Elastic Pool.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PreferredEnclaveType
The preferred enclave type for the Azure SQL Elastic Pool. Possible values are Default and VBS.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ResourceGroupName
Specifies the name of the resource group to which the elastic pool is assigned.
| Type: | String |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ServerName
Specifies the name of the server that hosts the elastic pool.
| Type: | String |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-StorageMB
Specifies the storage limit, in megabytes, for the elastic pool. For more information, see the New-AzSqlElasticPool cmdlet.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Tags
Specifies a dictionary of Key-value pairs that this cmdlet associates with the elastic pool in the
form of a hash table. For example:
@{key0="value0";"key 1"=$null;key2="value2"}
| Type: | Hashtable |
| Aliases: | Tag |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-VCore
The total shared number of Vcore for the Sql Azure Elastic Pool.
| Type: | Int32 |
| 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: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ZoneRedundant
The zone redundancy to associate with the Azure Sql Elastic Pool
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
Outputs
Related Links
Azure PowerShell
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for