Set-AzureSqlDatabase

Reference

Module:: Azure

Sets properties for an Azure SQL Database.

Note

The cmdlets referenced in this documentation are for managing legacy Azure resources that use Service Management APIs. See the Az PowerShell module for cmdlets to manage Azure Resource Manager resources.

Syntax

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

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

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

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.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ConnectionContext

Specifies the connection context of a server.

Type:	IServerDataServiceContext
Aliases:	Context
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Database

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

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

-DatabaseName

Specifies the name of the database that this cmdlet modifies.

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

-Edition

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

None
Web
Business
Basic
Standard
Premium

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

-Force

Allows the action to complete without prompting you for confirmation.

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

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

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

-NewDatabaseName

Specifies the new name of the database.

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

-PassThru

Returns the updated Azure SQL Database.

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

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

-ServerName

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

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	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). For more information, see What's New in the Azure SQL Database V12 Previewhttps://azure.microsoft.com/documentation/articles/sql-database-preview-whats-new/.

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

-Sync

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

Inputs

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

Outputs