Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The dataBoxEdgeDevices/triggers resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.DataBoxEdge/dataBoxEdgeDevices/triggers resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.DataBoxEdge/dataBoxEdgeDevices/triggers@2023-12-01' = {
name: 'string'
kind: 'string'
// For remaining properties, see Microsoft.DataBoxEdge/dataBoxEdgeDevices/triggers objects
}
Microsoft.DataBoxEdge/dataBoxEdgeDevices/triggers objects
Set the kind property to specify the type of object.
For FileEvent, use:
{
kind: 'FileEvent'
properties: {
customContextTag: 'string'
sinkInfo: {
roleId: 'string'
}
sourceInfo: {
shareId: 'string'
}
}
}
For PeriodicTimerEvent, use:
{
kind: 'PeriodicTimerEvent'
properties: {
customContextTag: 'string'
sinkInfo: {
roleId: 'string'
}
sourceInfo: {
schedule: 'string'
startTime: 'string'
topic: 'string'
}
}
}
Property Values
Microsoft.DataBoxEdge/dataBoxEdgeDevices/triggers
| Name | Description | Value |
|---|---|---|
| kind | Set to 'FileEvent' for type FileEventTrigger. Set to 'PeriodicTimerEvent' for type PeriodicTimerEventTrigger. | 'FileEvent' 'PeriodicTimerEvent' (required) |
| name | The resource name | string (required) |
| parent | In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource. |
Symbolic name for resource of type: dataBoxEdgeDevices |
FileEventTrigger
| Name | Description | Value |
|---|---|---|
| kind | Trigger Kind. | 'FileEvent' (required) |
| properties | File trigger properties. | FileTriggerProperties (required) |
FileSourceInfo
| Name | Description | Value |
|---|---|---|
| shareId | File share ID. | string (required) |
FileTriggerProperties
| Name | Description | Value |
|---|---|---|
| customContextTag | A custom context tag typically used to correlate the trigger against its usage. For example, if a periodic timer trigger is intended for certain specific IoT modules in the device, the tag can be the name or the image URL of the module. | string Constraints: Max length = 192 |
| sinkInfo | Role sink info. | RoleSinkInfo (required) |
| sourceInfo | File event source details. | FileSourceInfo (required) |
PeriodicTimerEventTrigger
| Name | Description | Value |
|---|---|---|
| kind | Trigger Kind. | 'PeriodicTimerEvent' (required) |
| properties | Periodic timer trigger properties. | PeriodicTimerProperties (required) |
PeriodicTimerProperties
| Name | Description | Value |
|---|---|---|
| customContextTag | A custom context tag typically used to correlate the trigger against its usage. For example, if a periodic timer trigger is intended for certain specific IoT modules in the device, the tag can be the name or the image URL of the module. | string Constraints: Max length = 192 |
| sinkInfo | Role Sink information. | RoleSinkInfo (required) |
| sourceInfo | Periodic timer details. | PeriodicTimerSourceInfo (required) |
PeriodicTimerSourceInfo
| Name | Description | Value |
|---|---|---|
| schedule | Periodic frequency at which timer event needs to be raised. Supports daily, hourly, minutes, and seconds. | string (required) |
| startTime | The time of the day that results in a valid trigger. Schedule is computed with reference to the time specified upto seconds. If timezone is not specified the time will considered to be in device timezone. The value will always be returned as UTC time. | string (required) |
| topic | Topic where periodic events are published to IoT device. | string |
RoleSinkInfo
| Name | Description | Value |
|---|---|---|
| roleId | Compute role ID. | string (required) |
ARM template resource definition
The dataBoxEdgeDevices/triggers resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands For a list of changed properties in each API version, see change log.
Usage Examples
Resource format
To create a Microsoft.DataBoxEdge/dataBoxEdgeDevices/triggers resource, add the following JSON to your template.
{
"name": "string",
"kind": "string"
// For remaining properties, see Microsoft.DataBoxEdge/dataBoxEdgeDevices/triggers objects
}
Microsoft.DataBoxEdge/dataBoxEdgeDevices/triggers objects
Set the kind property to specify the type of object.
For FileEvent, use:
{
"kind": "FileEvent",
"properties": {
"customContextTag": "string",
"sinkInfo": {
"roleId": "string"
},
"sourceInfo": {
"shareId": "string"
}
}
}
For PeriodicTimerEvent, use:
{
"kind": "PeriodicTimerEvent",
"properties": {
"customContextTag": "string",
"sinkInfo": {
"roleId": "string"
},
"sourceInfo": {
"schedule": "string",
"startTime": "string",
"topic": "string"
}
}
}
Property Values
Microsoft.DataBoxEdge/dataBoxEdgeDevices/triggers
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2023-12-01' |
| kind | Set to 'FileEvent' for type FileEventTrigger. Set to 'PeriodicTimerEvent' for type PeriodicTimerEventTrigger. | 'FileEvent' 'PeriodicTimerEvent' (required) |
| name | The resource name | string (required) |
| type | The resource type | 'Microsoft.DataBoxEdge/dataBoxEdgeDevices/triggers' |
FileEventTrigger
| Name | Description | Value |
|---|---|---|
| kind | Trigger Kind. | 'FileEvent' (required) |
| properties | File trigger properties. | FileTriggerProperties (required) |
FileSourceInfo
| Name | Description | Value |
|---|---|---|
| shareId | File share ID. | string (required) |
FileTriggerProperties
| Name | Description | Value |
|---|---|---|
| customContextTag | A custom context tag typically used to correlate the trigger against its usage. For example, if a periodic timer trigger is intended for certain specific IoT modules in the device, the tag can be the name or the image URL of the module. | string Constraints: Max length = 192 |
| sinkInfo | Role sink info. | RoleSinkInfo (required) |
| sourceInfo | File event source details. | FileSourceInfo (required) |
PeriodicTimerEventTrigger
| Name | Description | Value |
|---|---|---|
| kind | Trigger Kind. | 'PeriodicTimerEvent' (required) |
| properties | Periodic timer trigger properties. | PeriodicTimerProperties (required) |
PeriodicTimerProperties
| Name | Description | Value |
|---|---|---|
| customContextTag | A custom context tag typically used to correlate the trigger against its usage. For example, if a periodic timer trigger is intended for certain specific IoT modules in the device, the tag can be the name or the image URL of the module. | string Constraints: Max length = 192 |
| sinkInfo | Role Sink information. | RoleSinkInfo (required) |
| sourceInfo | Periodic timer details. | PeriodicTimerSourceInfo (required) |
PeriodicTimerSourceInfo
| Name | Description | Value |
|---|---|---|
| schedule | Periodic frequency at which timer event needs to be raised. Supports daily, hourly, minutes, and seconds. | string (required) |
| startTime | The time of the day that results in a valid trigger. Schedule is computed with reference to the time specified upto seconds. If timezone is not specified the time will considered to be in device timezone. The value will always be returned as UTC time. | string (required) |
| topic | Topic where periodic events are published to IoT device. | string |
RoleSinkInfo
| Name | Description | Value |
|---|---|---|
| roleId | Compute role ID. | string (required) |
Terraform (AzAPI provider) resource definition
The dataBoxEdgeDevices/triggers resource type can be deployed with operations that target:
- Resource groups For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.DataBoxEdge/dataBoxEdgeDevices/triggers resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
name = "string"
kind = "string"
// For remaining properties, see Microsoft.DataBoxEdge/dataBoxEdgeDevices/triggers objects
}
Microsoft.DataBoxEdge/dataBoxEdgeDevices/triggers objects
Set the kind property to specify the type of object.
For FileEvent, use:
{
kind = "FileEvent"
properties = {
customContextTag = "string"
sinkInfo = {
roleId = "string"
}
sourceInfo = {
shareId = "string"
}
}
}
For PeriodicTimerEvent, use:
{
kind = "PeriodicTimerEvent"
properties = {
customContextTag = "string"
sinkInfo = {
roleId = "string"
}
sourceInfo = {
schedule = "string"
startTime = "string"
topic = "string"
}
}
}
Property Values
Microsoft.DataBoxEdge/dataBoxEdgeDevices/triggers
| Name | Description | Value |
|---|---|---|
| kind | Set to 'FileEvent' for type FileEventTrigger. Set to 'PeriodicTimerEvent' for type PeriodicTimerEventTrigger. | 'FileEvent' 'PeriodicTimerEvent' (required) |
| name | The resource name | string (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: dataBoxEdgeDevices |
| type | The resource type | "Microsoft.DataBoxEdge/dataBoxEdgeDevices/triggers@2023-12-01" |
FileEventTrigger
| Name | Description | Value |
|---|---|---|
| kind | Trigger Kind. | 'FileEvent' (required) |
| properties | File trigger properties. | FileTriggerProperties (required) |
FileSourceInfo
| Name | Description | Value |
|---|---|---|
| shareId | File share ID. | string (required) |
FileTriggerProperties
| Name | Description | Value |
|---|---|---|
| customContextTag | A custom context tag typically used to correlate the trigger against its usage. For example, if a periodic timer trigger is intended for certain specific IoT modules in the device, the tag can be the name or the image URL of the module. | string Constraints: Max length = 192 |
| sinkInfo | Role sink info. | RoleSinkInfo (required) |
| sourceInfo | File event source details. | FileSourceInfo (required) |
PeriodicTimerEventTrigger
| Name | Description | Value |
|---|---|---|
| kind | Trigger Kind. | 'PeriodicTimerEvent' (required) |
| properties | Periodic timer trigger properties. | PeriodicTimerProperties (required) |
PeriodicTimerProperties
| Name | Description | Value |
|---|---|---|
| customContextTag | A custom context tag typically used to correlate the trigger against its usage. For example, if a periodic timer trigger is intended for certain specific IoT modules in the device, the tag can be the name or the image URL of the module. | string Constraints: Max length = 192 |
| sinkInfo | Role Sink information. | RoleSinkInfo (required) |
| sourceInfo | Periodic timer details. | PeriodicTimerSourceInfo (required) |
PeriodicTimerSourceInfo
| Name | Description | Value |
|---|---|---|
| schedule | Periodic frequency at which timer event needs to be raised. Supports daily, hourly, minutes, and seconds. | string (required) |
| startTime | The time of the day that results in a valid trigger. Schedule is computed with reference to the time specified upto seconds. If timezone is not specified the time will considered to be in device timezone. The value will always be returned as UTC time. | string (required) |
| topic | Topic where periodic events are published to IoT device. | string |
RoleSinkInfo
| Name | Description | Value |
|---|---|---|
| roleId | Compute role ID. | string (required) |