Edit

Share via

Set-AzureSqlDatabase

Module:
Azure Module

Sets properties for an Azure SQL Database.

Note

The cmdlets referenced in this documentation are for managing legacy Azure resources that use Azure Service Manager (ASM) APIs. This legacy PowerShell module isn't recommended when creating new resources since ASM is scheduled for retirement. For more information, see Azure Service Manager retirement.

The Az PowerShell module is the recommended PowerShell module for managing Azure Resource Manager (ARM) resources with PowerShell.

Syntax

ByNameWithConnectionContext 

Set-AzureSqlDatabase
    -ConnectionContext <IServerDataServiceContext>
    -DatabaseName <String>
    [-NewDatabaseName <String>]
    [-Edition <DatabaseEdition>]
    [-MaxSizeGB <Int32>]
    [-MaxSizeBytes <Int64>]
    [-ServiceObjective <ServiceObjective>]
    [-PassThru]
    [-Force]
    [-Sync]
    [-Profile <AzureSMProfile>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByObjectWithConnectionContext 

Set-AzureSqlDatabase
    -ConnectionContext <IServerDataServiceContext>
    -Database <Database>
    [-NewDatabaseName <String>]
    [-Edition <DatabaseEdition>]
    [-MaxSizeGB <Int32>]
    [-MaxSizeBytes <Int64>]
    [-ServiceObjective <ServiceObjective>]
    [-PassThru]
    [-Force]
    [-Sync]
    [-Profile <AzureSMProfile>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByNameWithServerName 

Set-AzureSqlDatabase
    -ServerName <String>
    -DatabaseName <String>
    [-NewDatabaseName <String>]
    [-Edition <DatabaseEdition>]
    [-MaxSizeGB <Int32>]
    [-MaxSizeBytes <Int64>]
    [-ServiceObjective <ServiceObjective>]
    [-PassThru]
    [-Force]
    [-Sync]
    [-Profile <AzureSMProfile>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByObjectWithServerName 

Set-AzureSqlDatabase
    -ServerName <String>
    -Database <Database>
    [-NewDatabaseName <String>]
    [-Edition <DatabaseEdition>]
    [-MaxSizeGB <Int32>]
    [-MaxSizeBytes <Int64>]
    [-ServiceObjective <ServiceObjective>]
    [-PassThru]
    [-Force]
    [-Sync]
    [-Profile <AzureSMProfile>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The Set-AzureSqlDatabase cmdlet sets properties for an Azure SQL Database. You can specify the database by name, or pass an Azure SQL Database object through the pipeline. You can specify the server by name, or pass an Azure SQL Database server connection context. Create a connection context by running the New-AzureSqlDatabaseServerContext cmdlet. If you specify the server by name, the cmdlet uses the current Azure subscription information to authenticate the request.

Examples

Example 1: Change the size of a database by using a connection context

PS C:\> $Database01 = Get-AzureSqlDatabase -ConnectionContext $Context -DatabaseName "Database01"
PS C:\> Set-AzureSqlDatabase -ConnectionContext $Context -Database $Database01 -MaxSizeGB 20

This example changes the size of the database named Database01 to 20 GB, in the Azure SQL Database server connection context $Context.

Example 2: Change the size of a database by using a server name

PS C:\> $Database01 = Get-AzureSqlDatabase -ServerName "lpqd0zbr8y" -DatabaseName "Database01"
PS C:\> Set-AzureSqlDatabase -ServerName "lpqd0zbr8y" -Database $Database01 -MaxSizeGB 20

This example changes the size of the database named Database01 to 20 GB in the server named lpqd0zbr8y.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:False
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

-ConnectionContext

Specifies the connection context of a server.

Parameter properties

Type:IServerDataServiceContext
Default value:None
Supports wildcards:False
DontShow:False
Aliases:Context

Parameter sets

ByNameWithConnectionContext
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False
ByObjectWithConnectionContext
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-Database

Specifies an object that represents the Azure SQL Database that this cmdlet modifies.

Parameter properties

Type:Database
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByObjectWithConnectionContext
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False
ByObjectWithServerName
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-DatabaseName

Specifies the name of the database that this cmdlet modifies.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByNameWithConnectionContext
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByNameWithServerName
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Edition

Specifies the new edition for the Azure SQL Database. Valid values are:

  • None
  • Web
  • Business
  • Basic
  • Standard
  • Premium

Parameter properties

Type:DatabaseEdition
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

-Force

Allows the action to complete without prompting you for confirmation.

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

-MaxSizeBytes

Specifies the new maximum size for the database in bytes. You can specify either this parameter or the MaxSizeGB parameter. See the MaxSizeGB parameter for acceptable values based on edition.

Parameter properties

Type:Int64
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

-MaxSizeGB

Specifies the new maximum size for the database in gigabytes. You can specify either this parameter or the MaxSizeBytes parameter. The acceptable values differ based on edition.

Basic Edition values: 1 or 2

Standard Edition values: 1, 2, 5, 10, 20, 30, 40, 50, 100, 150, 200, or 250

Premium Edition values: 1, 2, 5, 10, 20, 30, 40, 50, 100, 150, 200, 250, 300, 400, or 500

Web Edition values: 1 or 5

Business Edition values: 10, 20, 30, 40, 50, 100, or 150

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

-NewDatabaseName

Specifies the new name of the database.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:NewName

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PassThru

Returns the updated Azure SQL Database.

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

-Profile

Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.

Parameter properties

Type:AzureSMProfile
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

-ServerName

Specifies the name of the server that contains the database that this cmdlet modifies.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByNameWithServerName
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False
ByObjectWithServerName
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-ServiceObjective

Specifies an object representing the new service objective (performance level) for this database. Valid values are:

  • Basic: dd6d99bb-f193-4ec1-86f2-43d3bccbc49c
  • Standard (S0): f1173c43-91bd-4aaa-973c-54e79e15235b
  • Standard (S1): 1b1ebd4d-d903-4baa-97f9-4ea675f5e928
  • Standard (S2): 455330e1-00cd-488b-b5fa-177c226f28b7
  • *Standard (S3): 789681b8-ca10-4eb0-bdf2-e0b050601b40
  • Premium (P1): 7203483a-c4fb-4304-9e9f-17c71c904f5d
  • Premium (P2): a7d1b92d-c987-4375-b54d-2b1d0e0f5bb0
  • Premium (P3): a7c4c615-cfb1-464b-b252-925be0a19446

*Standard (S3) is part of the Latest SQL Database Update V12 (preview).

Parameter properties

Type:ServiceObjective
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

-Sync

The Set-AzureSqlDatabase cmdlet sets properties for an Azure SQL Database. You can specify the database by name, or pass an Azure SQL Database object through the pipeline. You can specify the server by name, or pass an Azure SQL Database server connection context. Create a connection context by running the New-AzureSqlDatabaseServerContext cmdlet. If you specify the server by name, the cmdlet uses the current Azure subscription information to authenticate the request.

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

-WhatIf

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

Parameter properties

Type:SwitchParameter
Default value:False
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

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

Microsoft.WindowsAzure.Commands.SqlDatabase.Services.Server.Database

Outputs

Microsoft.WindowsAzure.Commands.SqlDatabase.Services.Server.Database