Set‑SqlDscAgentOperator - dsccommunity/SqlServerDsc GitHub Wiki
Updates properties of a SQL Agent Operator.
Set-SqlDscAgentOperator -ServerObject <Server> -Name <String> [-EmailAddress <String>] [-CategoryName <String>]
[-NetSendAddress <String>] [-PagerAddress <String>] [-PagerDays <WeekDays>] [-SaturdayPagerEndTime <TimeSpan>]
[-SaturdayPagerStartTime <TimeSpan>] [-SundayPagerEndTime <TimeSpan>] [-SundayPagerStartTime <TimeSpan>]
[-WeekdayPagerEndTime <TimeSpan>] [-WeekdayPagerStartTime <TimeSpan>] [-Force]
[-WhatIf] [-Confirm] [<CommonParameters>]
Set-SqlDscAgentOperator -OperatorObject <Operator> [-EmailAddress <String>] [-CategoryName <String>]
[-NetSendAddress <String>] [-PagerAddress <String>] [-PagerDays <WeekDays>] [-SaturdayPagerEndTime <TimeSpan>]
[-SaturdayPagerStartTime <TimeSpan>] [-SundayPagerEndTime <TimeSpan>] [-SundayPagerStartTime <TimeSpan>]
[-WeekdayPagerEndTime <TimeSpan>] [-WeekdayPagerStartTime <TimeSpan>] [-Force]
[-WhatIf] [-Confirm] [<CommonParameters>]
This command updates properties of an existing SQL Agent Operator on a SQL Server Database Engine instance.
$serverObject = Connect-SqlDscDatabaseEngine -InstanceName 'MyInstance'
Set-SqlDscAgentOperator -ServerObject $serverObject -Name 'MyOperator' -EmailAddress '[email protected]'
Updates the email address of the SQL Agent Operator named 'MyOperator'.
$serverObject = Connect-SqlDscDatabaseEngine -InstanceName 'MyInstance'
$serverObject | Set-SqlDscAgentOperator -Name 'MyOperator' -EmailAddress '[email protected]'
Updates the email address of the SQL Agent Operator using pipeline input.
$operatorObject = Get-SqlDscAgentOperator -ServerObject $serverObject -Name 'MyOperator'
$operatorObject | Set-SqlDscAgentOperator -EmailAddress '[email protected]'
Updates the email address of the SQL Agent Operator using operator object pipeline input.
Specifies the category name for the SQL Agent Operator.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the email address for the SQL Agent Operator.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies that the operator should be updated without any confirmation.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the name of the SQL Agent Operator to update.
Type: String
Parameter Sets: ByName
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the net send address for the SQL Agent Operator.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the SQL Agent Operator object to update.
Type: Operator
Parameter Sets: ByObject
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: FalseSpecifies the pager address for the SQL Agent Operator.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the days when pager notifications are active for the SQL Agent Operator.
Type: WeekDays
Parameter Sets: (All)
Aliases:
Accepted values: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, WeekDays, Saturday, WeekEnds, EveryDay
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the Saturday pager end time for the SQL Agent Operator.
Type: TimeSpan
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the Saturday pager start time for the SQL Agent Operator.
Type: TimeSpan
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies current server connection object.
Type: Server
Parameter Sets: ByName
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: FalseSpecifies the Sunday pager end time for the SQL Agent Operator.
Type: TimeSpan
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the Sunday pager start time for the SQL Agent Operator.
Type: TimeSpan
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the weekday pager end time for the SQL Agent Operator.
Type: TimeSpan
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the weekday pager start time for the SQL Agent Operator.
Type: TimeSpan
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalsePrompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseShows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.