Get‑SqlDscAgentOperator - dsccommunity/SqlServerDsc GitHub Wiki

SYNOPSIS

Returns SQL Agent Operator information.

SYNTAX

All (Default)

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

ByName

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

DESCRIPTION

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

EXAMPLES

EXAMPLE 1

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

Returns all SQL Agent Operators from the server.

EXAMPLE 2

$serverObject = Connect-SqlDscDatabaseEngine
Get-SqlDscAgentOperator -ServerObject $serverObject -Name 'MyOperator'

Returns the SQL Agent Operator named 'MyOperator'.

EXAMPLE 3

$serverObject = Connect-SqlDscDatabaseEngine
$serverObject | Get-SqlDscAgentOperator -Name 'MyOperator'

Returns the SQL Agent Operator named 'MyOperator' using pipeline input.

PARAMETERS

-Name

Specifies the name of the SQL Agent Operator to retrieve. If not specified, all operators 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.Operator

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

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

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

None

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

NOTES

RELATED LINKS

⚠️ **GitHub.com Fallback** ⚠️