Get-DbaAgDatabase

Want to see the source code for this command? Check out Get-DbaAgDatabase on GitHub.
Want to see the Bill Of Health for this command? Check out Get-DbaAgDatabase.

Synopsis

Gets availability group databases from one or more SQL Server instances.

Description

Gets availability group databases from one or more SQL Server instances.

Default view provides most common set of properties for information on the database in an availability group.

Information returned on the database will be specific to that replica, whether it is primary or a secondary.

Syntax

Get-DbaAgDatabase
    [[-SqlInstance] <DbaInstanceParameter[]>]
    [[-SqlCredential] <PSCredential>]
    [[-AvailabilityGroup] <String[]>]
    [[-Database] <String[]>]
    [[-InputObject] <AvailabilityGroup[]>]
    [-EnableException]
    [<CommonParameters>]

Examples

Example: 1

PS C:\> Get-DbaAgDatabase -SqlInstance sql2017a

Returns all the databases in each availability group found on sql2017a

Example: 2

PS C:\> Get-DbaAgDatabase -SqlInstance sql2017a -AvailabilityGroup AG101

Returns all the databases in the availability group AG101 on sql2017a

Example: 3

PS C:\> Get-DbaAvailabilityGroup -SqlInstance sqlcluster -AvailabilityGroup SharePoint -Database Sharepoint_Config | Get-DbaAgDatabase

Returns the database Sharepoint_Config found in the availability group SharePoint on server sqlcluster

Optional Parameters

-SqlInstance

The target SQL Server instance or instances. Server version must be SQL Server version 2012 or higher.

-SqlCredential

Login to the target instance using alternative credentials. Accepts PowerShell credentials (Get-Credential). Windows Authentication, SQL Server Authentication, Active Directory - Password, and Active Directory - Integrated are all supported. For MFA support, please use Connect-DbaInstance.

-AvailabilityGroup

Specify the availability groups to query.

-Database

Specify the database or databases to return. This list is auto-populated from the server for tab completion. Multiple databases can be specified. If none are specified all databases will be processed.

-InputObject

Enables piped input from Get-DbaAvailabilityGroup.

-EnableException

By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message. This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables advanced scripting. Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own try/catch.