Set-AzureSqlDatabase
[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]
Set-AzureSqlDatabase
Sets properties for the specified SQL database.
Syntax
Parameter Set: ByInputObject
Set-AzureSqlDatabase [-Context] <IServerDataServiceContext> [-Database] <Database> [-Edition <DatabaseEdition> ] [-Force] [-MaxSizeGB <Int32> ] [-NewName <String> ] [-PassThru] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: ByName
Set-AzureSqlDatabase [-Context] <IServerDataServiceContext> [-DatabaseName] <String> [-Edition <DatabaseEdition> ] [-Force] [-MaxSizeGB <Int32> ] [-NewName <String> ] [-PassThru] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Set-AzureSqlDatabase cmdlet sets properties for the specified SQL database. You can specify the database by name or pass a SQL database object through the pipeline.
Parameters
-Context<IServerDataServiceContext>
The connection context to the specified Windows Azure SQL Database Server.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Database<Database>
A database object representing the SQL database to modify.
Aliases |
none |
Required? |
true |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-DatabaseName<String>
The name of the SQL database to modify.
Aliases |
none |
Required? |
true |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Edition<DatabaseEdition>
If specified, the new edition for the SQL database. Acceptable values are Web and Business.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Force
Allows the action to complete without prompting you for confirmation.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-MaxSizeGB<Int32>
If specified, the new maximum size for the database in gigabytes. The acceptable values differ based on edition.
Web Edition values: 1 or 5
Business Edition values: 10, 20, 30, 40, 50, 100, or 150
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-NewName<String>
If specified, the new name of the SQL database.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-PassThru
Returns the input object.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Confirm
Prompts you for confirmation before executing the command.
Required? |
false |
Position? |
named |
Default Value |
|
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WhatIf
Describes what would happen if you executed the command without actually executing the command.
Required? |
false |
Position? |
named |
Default Value |
|
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
- Microsoft.SqlServer.Management.Client.DataServices.Server.Database
Outputs
The output type is the type of the objects that the cmdlet emits.
- Microsoft.SqlServer.Management.Client.DataServices.Server.Database
Examples
-------------------------- EXAMPLE 1 --------------------------
This example changes the current size of the database, "Database1", to 20 GB, on the Windows Azure SQL Database Server specified by the connection $ctx.
C:\PS>$database1 = Get-AzureSqlDatabase $ctx -DatabaseName "Database1"
C:\PS>Set-AzureSqlDatabase $ctx -Database $database1 -MaxSizeGB 20