New-AzDataBoxEdgeTrigger

Reference

Module:: Az.DataBoxEdge

Configures a trigger on the device.

Syntax

New-AzDataBoxEdgeTrigger
   [-ResourceGroupName] <String>
   [-DeviceName] <String>
   [-Name] <String>
   -RoleName <String>
   [-FileEvent]
   -ShareName <String>
   [-AsJob]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

New-AzDataBoxEdgeTrigger
   [-ResourceGroupName] <String>
   [-DeviceName] <String>
   [-Name] <String>
   -RoleName <String>
   [-PeriodicTimerEvent]
   [-AsJob]
   [-DefaultProfile <IAzureContextContainer>]
   -Schedule <String>
   -StartTime <DateTime>
   -Topic <String>
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

New-AzDataBoxEdgeTrigger
   [-FileEvent]
   -ShareId <String>
   [-AsJob]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

New-AzDataBoxEdgeTrigger
   [-PeriodicTimerEvent]
   [-AsJob]
   [-DefaultProfile <IAzureContextContainer>]
   -Schedule <String>
   -StartTime <DateTime>
   -Topic <String>
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The New-AzDataBoxEdgeTrigger cmdlet configures a trigger on the Data Box Edge device.

Examples

Example 1

New-AzDataBoxEdgeTrigger -ResourceGroupName resourceGroupName -DeviceName deviceName -PeriodicTimerEvent -Name periodic-trigger -RoleName IOTRole -Schedule "00:00" -StartTime "2019-10-28 12:00:00" -Topic sample-topic

Name                  Kind               
----                  ----               
periodic-trigger      PeriodicTimerEvent

Parameters

-AsJob

Run cmdlet in the background

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Type:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DeviceName

Device Name

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

-FileEvent

Pass this switch parameter to configure FileEvent Trigger

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

-Name

Resource Name

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

-PeriodicTimerEvent

Pass this switch parameter to configure PeriodicTimerEvent Trigger

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

-ResourceGroupName

Resource Group Name

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

-RoleName

Compute role against which events will be raised.

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

-Schedule

Periodic frequency at which timer event needs to be raised. Specify a schedule in either days (between 1 and 365) , hours (between 1 and 23), or minutes (between 1 and 59).

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

-ShareId

File share ID to be passed in FileEvent Trigger

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

-ShareName

File share ID to be passed in FileEvent Trigger

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

-StartTime

The time of the day that results in a valid trigger. Schedule is computed with reference to the time specified up to seconds. If timezone is not specified the time will considered to be in device timezone. The value will always be returned as UTC time.

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

-Topic

Topic where periodic events are published to IoT device.

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

None

Outputs

PSDataBoxEdgeTrigger

Share via