Skip to content

Resume‑SqlDscDatabase

dscbot edited this page Dec 5, 2025 · 2 revisions

SYNOPSIS

Brings a SQL Server database back online.

SYNTAX

ServerObjectSet (Default)

Resume-SqlDscDatabase -ServerObject <Server> -Name <String> [-Refresh] [-Force] [-PassThru]
 [-WhatIf] [-Confirm] [<CommonParameters>]

DatabaseObjectSet

Resume-SqlDscDatabase -DatabaseObject <Database> [-Force] [-PassThru] 
 [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

This command brings a SQL Server database back online, making it available to users again after maintenance or downtime. The command uses the SMO Database.SetOnline() method to resume the database.

EXAMPLES

EXAMPLE 1

$serverObject = Connect-SqlDscDatabaseEngine -InstanceName 'MyInstance'
Resume-SqlDscDatabase -ServerObject $serverObject -Name 'MyDatabase'

Brings the database named MyDatabase back online.

EXAMPLE 2

$serverObject = Connect-SqlDscDatabaseEngine -InstanceName 'MyInstance'
$databaseObject = $serverObject | Get-SqlDscDatabase -Name 'MyDatabase'
Resume-SqlDscDatabase -DatabaseObject $databaseObject -Force

Brings the database online using a database object without prompting for confirmation.

EXAMPLE 3

$serverObject = Connect-SqlDscDatabaseEngine -InstanceName 'MyInstance'
Resume-SqlDscDatabase -ServerObject $serverObject -Name 'MyDatabase' -PassThru

Brings the database online and returns the updated database object.

EXAMPLE 4

$serverObject = Connect-SqlDscDatabaseEngine -InstanceName 'MyInstance'
$serverObject | Get-SqlDscDatabase -Name 'MyDatabase' | Resume-SqlDscDatabase -Force

Brings the database online using pipeline input without prompting for confirmation.

PARAMETERS

-DatabaseObject

Specifies the database object to bring online (from Get-SqlDscDatabase).

Type: Database
Parameter Sets: DatabaseObjectSet
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Force

Specifies that the database should be brought online without any confirmation.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Name

Specifies the name of the database to bring online.

Type: String
Parameter Sets: ServerObjectSet
Aliases:

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

-PassThru

Specifies that the database object should be returned after the operation.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Refresh

Specifies that the ServerObject's databases should be refreshed before trying to get the database object. This is helpful when databases could have been modified outside of the ServerObject, for example through T-SQL. But on instances with a large amount of databases it might be better to make sure the ServerObject is recent enough.

This parameter is only used when resuming a database using ServerObject and Name parameters.

Type: SwitchParameter
Parameter Sets: ServerObjectSet
Aliases:

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

-ServerObject

Specifies current server connection object.

Type: Server
Parameter Sets: ServerObjectSet
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

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

-WhatIf

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

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

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

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

Microsoft.SqlServer.Management.Smo.Server

The server object from Connect-SqlDscDatabaseEngine.

Microsoft.SqlServer.Management.Smo.Database

The database object to bring online (from Get-SqlDscDatabase).

OUTPUTS

None.

By default, no output is returned.

Microsoft.SqlServer.Management.Smo.Database

When PassThru is specified, the updated database object is returned.

NOTES

RELATED LINKS

Home

Commands

Resources

Usage

Clone this wiki locally