Get-DbaPbmStore

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

Synopsis

Retrieves the Policy-Based Management store object from SQL Server instances.

Description

Retrieves the Policy-Based Management (PBM) store object, which serves as the foundation for managing SQL Server policies, conditions, and categories. This store object is required for accessing and manipulating Policy-Based Management components programmatically. The function connects to the DMF (Declarative Management Framework) policy store and returns it with additional instance identification properties for easier scripting and automation.

Syntax

Get-DbaPbmStore
    [-SqlInstance] <DbaInstanceParameter[]>
    [[-SqlCredential] <PSCredential>]
    [-EnableException]
    [<CommonParameters>]

Examples

Example: 1

PS C:\> Get-DbaPbmStore -SqlInstance sql2016

Return the policy store from the sql2016 instance

Example: 2

PS C:\> Get-DbaPbmStore -SqlInstance sql2016 -SqlCredential $cred

Uses a credential $cred to connect and return the policy store from the sql2016 instance

Required Parameters

-SqlInstance

The target SQL Server instance or instances. This can be a collection and receive pipeline input to allow the function to be executed against multiple SQL Server instances.

Optional Parameters

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

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