SqlAgentOperators.adoc

DSC Resource 'SqlAgentOperators'

SqlAgentOperators is used to add/remove SQL Agent Operators.

The resource can also update the operators email address.

Source	https://github.com/dsccommunity/CommonTasks/tree/main/source/DSCResources/SqlAgentOperators
DSC Resource	SqlServerDsc
Documentation	SqlServerDsc Wiki SqlAgentOperator

Requirements

• Target machine must be running Windows Server 2012 or later.

• Target machine must be running SQL Server Database Engine 2012 or later.

Table 1. Attributes of category 'SqlAgentOperators'

Parameter	Attribute	DataType	Description	Allowed Values
DefaultInstanceName		String	Default SQL InstanceName	Default: MSSQLSERVER
AgentOperators	Mandatory	Hashtable[]	List of SQL Agent Operators.

Table 2. Attributes of category 'SqlAgentOperators/AgentOperators'

Parameter	Attribute	DataType	Description	Allowed Values
Name	Key	String	The name of the SQL Server Agent operator.
ServerName	Key	String	The host name of the SQL Server to be configured. Default value is the current computer name.
InstanceName	Key	String	The name of the SQL Server instance to be configured.
EmailAddress		String	The email address to be used for the SQL Server Agent operator.
Ensure		String	Specifies if the SQL Server Agent operator should be present or absent.	Present (default) Absent

Example

SqlAgentOperators:
  DefaultInstanceName: MSSQLSERVER
  AgentOperators:
    - Name: 'DbaTeam'
      ServerName: 'TestServer'
      InstanceName: 'MSSQLServer'
      EmailAddress: '[email protected]'
    - Name: 'APPTeam'
      ServerName: 'TestServer'
      InstanceName: 'MSSQLServer'
      EmailAddress: '[email protected]'