Get-DbaDbServiceBrokerQueue

Synopsis

Gets database service broker queues

Description

Gets database Sservice broker queue

Syntax

Get-DbaDbServiceBrokerQueue
    [[-SqlInstance] <DbaInstanceParameter[]>]
    [[-SqlCredential] <PSCredential>]
    [[-Database] <Object[]>]
    [[-ExcludeDatabase] <Object[]>]
    [-ExcludeSystemQueue]
    [-EnableException]
    [<CommonParameters>]

Examples

Example: 1

PS C:\> Get-DbaDbServiceBrokerQueue -SqlInstance sql2016

Gets all database service broker queues

Example: 2

PS C:\> Get-DbaDbServiceBrokerQueue -SqlInstance Server1 -Database db1

Gets the service broker queues for the db1 database

Example: 3

PS C:\> Get-DbaDbServiceBrokerQueue -SqlInstance Server1 -ExcludeDatabase db1

Gets the service broker queues for all databases except db1

Example: 4

PS C:\> Get-DbaDbServiceBrokerQueue -SqlInstance Server1 -ExcludeSystemQueue

Gets the service broker queues for all databases that are not system objects

Optional Parameters

-SqlInstance

The target SQL Server instance or instances

-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.

-Database

Specifies which databases to retrieve Service Broker queues from. Accepts wildcards for pattern matching.
Use this when you need to focus on specific databases instead of scanning all databases on the instance.

-ExcludeDatabase

Specifies databases to exclude from the Service Broker queue retrieval. Accepts wildcards for pattern matching.
Useful when you want to scan most databases but skip specific ones like test or development databases.

-ExcludeSystemQueue

Excludes system-created Service Broker queues from the results, showing only user-created queues.
Use this to focus on application-specific queues and filter out SQL Server’s internal messaging queues.

-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.