Remove-AzureSqlDatabase
[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]
Remove-AzureSqlDatabase
Deletes the specified SQL database.
Syntax
Parameter Set: ByInputObject
Remove-AzureSqlDatabase [-Context] <IServerDataServiceContext> [-Database] <Database> [-Force] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: ByName
Remove-AzureSqlDatabase [-Context] <IServerDataServiceContext> [-DatabaseName] <String> [-Force] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Remove-AzureSqlDatabase cmdlet deletes a SQL Server database at the specified SQL Server connection context.
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 database to be removed.
Aliases |
InputObject |
Required? |
true |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-DatabaseName<String>
The name of the database to be removed.
Aliases |
none |
Required? |
true |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Force
Allows the action to complete without prompting the user for confirmation.
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.
Notes
- Because of the severity of the operation, this cmdlet prompts the user for confirmation by default. This can be overridden by using the -Force parameter.
Examples
-------------------------- EXAMPLE 1 --------------------------
This example removes the database "Database1" on the Windows Azure SQL Database Server specified by the connection $ctx.
C:\PS>Remove-AzureSqlDatabase $ctx -DatabaseName "Database1"
-------------------------- EXAMPLE 2 --------------------------
This example demonstrates the alternative method of passing the database object through the pipeline.
C:\PS>$database1 | Remove-AzureSqlDatabase $ctx