Get-DbaPbmCategorySubscription

Synopsis

Retrieves database subscriptions to Policy-Based Management categories that control automatic policy evaluation.

Description

Retrieves all database subscriptions to policy categories from SQL Server’s Policy-Based Management feature. These subscriptions determine which databases are subject to automatic policy evaluation for specific policy categories. When a database subscribes to a category (either voluntarily or through mandatory subscription), all policies in that category will be automatically evaluated against the database. This is essential for auditing policy compliance, troubleshooting evaluation failures, and understanding which databases are governed by which policy sets.

Syntax

Get-DbaPbmCategorySubscription
    [[-SqlInstance] <DbaInstanceParameter[]>]
    [[-SqlCredential] <PSCredential>]
    [[-InputObject] <PSObject[]>]
    [-EnableException]
    [<CommonParameters>]

Examples

Example: 1

PS C:\> Get-DbaPbmCategorySubscription -SqlInstance sql2016

Returns all policy category subscriptions from the sql2016 PBM server

Example: 2

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

Uses a credential $cred to connect and return all policy category subscriptions from the sql2016 PBM server

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

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

-InputObject

Accepts Policy-Based Management store objects from Get-DbaPbmStore for pipeline processing.
Use this when you need to query category subscriptions from an already retrieved PBM store object, improving performance when working with multiple PBM operations on the same instance.

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

Outputs

Microsoft.SqlServer.Management.Dmf.PolicyCategorySubscription

Returns one subscription object for each database or object subscribed to a policy category. These subscriptions define which objects are subject to automatic policy evaluation for specific policy categories.

Default display properties (via Select-DefaultView, excluding Properties, Urn, and Parent):

• ComputerName: The computer name of the SQL Server instance
• InstanceName: The SQL Server instance name
• SqlInstance: The full SQL Server instance name (computer\instance)
• PolicyCategory: The name of the policy category this subscription applies to
• Target: The target object (database or other SQL Server object) subscribed to this category
• TargetType: The type of the target object being subscribed
• ID: Unique identifier for the subscription
• State: Current state of the subscription object (Existing, Creating, Pending, etc.)
• IdentityKey: Identity key of the subscription object
• Metadata: Metadata information for the subscription
• KeyChain: Identity path of the subscription object

*Additional properties available via Select-Object :

• Properties: Properties collection for the subscription
• Urn: Uniform Resource Name (URN) for the subscription object
• Parent: Reference to the parent PolicyStore object