Citrix Virtual Apps and Desktops SDK

Add-MonitorNotificationPolicyTargets

Add targets to the existing policy specified and returns the updated policy

Syntax

Add-MonitorNotificationPolicyTargets
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->
Add-MonitorNotificationPolicyTargets
   -InputObject <MonitorNotificationPolicy>
   [-Scope <String>]
   [-TargetKind <TargetKind>]
   -TargetIds <String[]>
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->
Add-MonitorNotificationPolicyTargets
   -Uid <Int64>
   [-Scope <String>]
   [-TargetKind <TargetKind>]
   -TargetIds <String[]>
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

Add targets to the existing policy specified and returns the updated policy

Examples

EXAMPLE 1

Add targets to the policy matching the id 100

$targetIds = @()
$targetIds += "766cde70-3c69-4481-a658-4e11247ac70c"

Add-MonitorNotificationPolicyTargets -Uid 100 -Scope "My Test Targets" -TargetKind Site -TargetIds $targetIds
<!--NeedCopy-->

Parameters

-InputObject

Specifies the policy object to which the targets to be added

Type: MonitorNotificationPolicy
Position: Named
Default value: None
Required: True
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-TargetIds

Object reference to the array of target ids.

Site GUID - for target type Site,

DesktopGroup UUID - for DesktopGroup, RdsWorker target types,

User SID - for User target type

Type: String[]
Position: Named
Default value: None
Required: True
Accept pipeline input: False
Accept wildcard characters: False

-Uid

Specifies the unique identifier of the policy to which the targets to be added

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

-Scope

Description of the collection of target ids

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

-TargetKind

String representation of the target type enum.

Possible values are

Site

DesktopGroup

RdsWorker

User

Type: TargetKind
Accepted values: Unknown, Site, DesktopGroup, RdsWorker, User
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-LoggingId

Specifies the identifier of the high-level operation this cmdlet call forms a part of. Citrix Studio and Director typically create high-level operations. PowerShell scripts can also wrap a series of cmdlet calls in a high-level operation by way of the Start-LogHighLevelOperation and Stop-LogHighLevelOperation cmdlets.

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

CitrixCommonParameters

This cmdlet supports the common Citrix parameters: -AdminAddress, -AdminClientIP, -BearerToken, -TraceParent, -TraceState and -VirtualSiteId. For more information, see about_CitrixCommonParameters.

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

None

You can’t pipe objects to this cmdlet.

Outputs

MonitorNotificationPolicy

Returns the policy object

Add-MonitorNotificationPolicyTargets