Skip to content

Get‑SqlDscAgentAlert

dscbot edited this page Dec 5, 2025 · 2 revisions

SYNOPSIS

Returns SQL Agent Alert information.

SYNTAX

All (Default)

Get-SqlDscAgentAlert -ServerObject <Server> [<CommonParameters>]

ByName

Get-SqlDscAgentAlert -ServerObject <Server> -Name <String> 
 [<CommonParameters>]

DESCRIPTION

Returns SQL Agent Alert information from a SQL Server Database Engine instance.

EXAMPLES

EXAMPLE 1

$serverObject = Connect-SqlDscDatabaseEngine
Get-SqlDscAgentAlert -ServerObject $serverObject

Returns all SQL Agent Alerts from the server.

EXAMPLE 2

$serverObject = Connect-SqlDscDatabaseEngine
Get-SqlDscAgentAlert -ServerObject $serverObject -Name 'MyAlert'

Returns the SQL Agent Alert named 'MyAlert'.

EXAMPLE 3

$serverObject = Connect-SqlDscDatabaseEngine
$serverObject | Get-SqlDscAgentAlert -Name 'MyAlert'

Returns the SQL Agent Alert named 'MyAlert' using pipeline input.

PARAMETERS

-Name

Specifies the name of the SQL Agent Alert to retrieve. If not specified, all alerts are returned.

Type: String
Parameter Sets: ByName
Aliases:

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

-ServerObject

Specifies current server connection object.

Type: Server
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
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

SQL Server Database Engine instance object.

OUTPUTS

Microsoft.SqlServer.Management.Smo.Agent.Alert

When using the ByName parameter set, returns a single SQL Agent Alert object.

Microsoft.SqlServer.Management.Smo.Agent.Alert[]

When using the All parameter set, returns an array of SQL Agent Alert objects.

None.

Returns nothing when no alerts are found for the specified criteria.

NOTES

RELATED LINKS

Home

Commands

Resources

Usage

Clone this wiki locally