New-UDEndpoint

SYNOPSIS

Creates a scheduled endpoint with a dashboard.

SYNTAX

Generic (Default)

New-UDEndpoint [-ArgumentList <Object[]>] [-Id <String>] [-Role <String[]>]
 [<CommonParameters>]

Endpoint

New-UDEndpoint -Endpoint <ScriptBlock> [-ArgumentList <Object[]>] [-Id <String>] [-Role <String[]>]
 [<CommonParameters>]

Scheduled

New-UDEndpoint -Endpoint <ScriptBlock> [-ArgumentList <Object[]>] [-Id <String>] -Schedule <EndpointSchedule>
 [-Role <String[]>] [<CommonParameters>]

JavaScript

New-UDEndpoint -JavaScript <String> [-ArgumentList <Object[]>] [-Id <String>] [-Role <String[]>]
 [<CommonParameters>]

DESCRIPTION

Creates a scheduled endpoint with a dashboard.

EXAMPLES

Example 1

$Schedule = New-UDEndpointSchedule 10 -Second
New-UDEndpoint -Schedule $Schedule -Endpoint {
    $Cache:Random = Get-Random
}
New-UDButton -Text "Get Random" -OnClick {
    Show-UDToast $Cache:Random
}

Scheduled Endpoints|Caches a random value every ten seconds

PARAMETERS

-ArgumentList

Not required.

Type: Object[]
Parameter Sets: (All)
Aliases:

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

-Endpoint

The endpoint to run on the schedule.

Type: ScriptBlock
Parameter Sets: Endpoint, Scheduled
Aliases:

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

-Id

The ID of the endpoint.

Type: String
Parameter Sets: (All)
Aliases:

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

-Role

Not used.

Type: String[]
Parameter Sets: (All)
Aliases:

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

-Schedule

The schedule to run for the endpoint. Use New-UDEndpointSchedule to create a schedule object.

Type: EndpointSchedule
Parameter Sets: Scheduled
Aliases:

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

-JavaScript

The JavaScript code to run on the endpoint.

Type: String
Parameter Sets: JavaScript
Aliases:

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

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -Verbose, -WarningAction, -WarningVariable, and -ProgressAction. For more information, see about_CommonParameters.

INPUTS

None

OUTPUTS

System.Object

NOTES

RELATED LINKS