|
| 1 | +--- |
| 2 | +layout: "" |
| 3 | +page_title: dynatrace_business_events_oneagent_outgoing Resource - terraform-provider-dynatrace" |
| 4 | +subcategory: "Business Events" |
| 5 | +description: |- |
| 6 | + The resource `dynatrace_business_events_oneagent_outgoing` covers configuration for OneAgent business events based on outgoing HTTP requests |
| 7 | +--- |
| 8 | + |
| 9 | +# dynatrace_business_events_oneagent_outgoing (Resource) |
| 10 | + |
| 11 | +-> This resource requires the API token scopes **Read settings** (`settings.read`) and **Write settings** (`settings.write`) |
| 12 | + |
| 13 | +## Dynatrace Documentation |
| 14 | + |
| 15 | +- Business event capture - https://www.dynatrace.com/support/help/platform-modules/business-analytics/ba-events-capturing#report-business-event-oneagent |
| 16 | + |
| 17 | +- Settings API - https://www.dynatrace.com/support/help/dynatrace-api/environment-api/settings (schemaId: `builtin:bizevents.http.outgoingg`) |
| 18 | + |
| 19 | +## Export Example Usage |
| 20 | + |
| 21 | +- `terraform-provider-dynatrace -export dynatrace_business_events_oneagent_outgoing` downloads all existing OneAgent business events based on outgoing HTTP requests |
| 22 | + |
| 23 | +The full documentation of the export feature is available [here](https://dt-url.net/h203qmc). |
| 24 | + |
| 25 | +## Resource Example Usage |
| 26 | + |
| 27 | +```terraform |
| 28 | +resource "dynatrace_business_events_oneagent_outgoing" "#name#" { |
| 29 | + enabled = true |
| 30 | + rule_name = "#name#" |
| 31 | + scope = "environment" |
| 32 | + event { |
| 33 | + category { |
| 34 | + source = "Category 1" |
| 35 | + source_type = "constant.string" |
| 36 | + } |
| 37 | + data { |
| 38 | + event_data_field_complex { |
| 39 | + name = "Field 1" |
| 40 | + source { |
| 41 | + path = "Path 1" |
| 42 | + source_type = "request.body" |
| 43 | + } |
| 44 | + } |
| 45 | + } |
| 46 | + provider { |
| 47 | + source = "Provider 1" |
| 48 | + source_type = "constant.string" |
| 49 | + } |
| 50 | + type { |
| 51 | + source = "Type 1" |
| 52 | + source_type = "constant.string" |
| 53 | + } |
| 54 | + } |
| 55 | + triggers { |
| 56 | + trigger { |
| 57 | + type = "EQUALS" |
| 58 | + case_sensitive = false |
| 59 | + value = "Terraform" |
| 60 | + source { |
| 61 | + data_source = "request.path" |
| 62 | + } |
| 63 | + } |
| 64 | + } |
| 65 | +} |
| 66 | +``` |
| 67 | + |
| 68 | +<!-- schema generated by tfplugindocs --> |
| 69 | +## Schema |
| 70 | + |
| 71 | +### Required |
| 72 | + |
| 73 | +- `enabled` (Boolean) This setting is enabled (`true`) or disabled (`false`) |
| 74 | +- `event` (Block List, Min: 1, Max: 1) Event meta data (see [below for nested schema](#nestedblock--event)) |
| 75 | +- `rule_name` (String) Rule name |
| 76 | +- `triggers` (Block List, Min: 1, Max: 1) Define conditions to trigger business events from incoming web requests. Triggers are connected by AND logic per capture rule. If you set multiple trigger rules, all of them need to be fulfilled to capture a business event. (see [below for nested schema](#nestedblock--triggers)) |
| 77 | + |
| 78 | +### Optional |
| 79 | + |
| 80 | +- `insert_after` (String) Because this resource allows for ordering you may specify the ID of the resource instance that comes before this instance regarding order. If not specified when creating the setting will be added to the end of the list. If not specified during update the order will remain untouched |
| 81 | +- `scope` (String) The scope of this setting (HOST, HOST_GROUP). Omit this property if you want to cover the whole environment. |
| 82 | + |
| 83 | +### Read-Only |
| 84 | + |
| 85 | +- `id` (String) The ID of this resource. |
| 86 | + |
| 87 | +<a id="nestedblock--event"></a> |
| 88 | +### Nested Schema for `event` |
| 89 | + |
| 90 | +Required: |
| 91 | + |
| 92 | +- `category` (Block List, Min: 1, Max: 1) Event category (see [below for nested schema](#nestedblock--event--category)) |
| 93 | +- `provider` (Block List, Min: 1, Max: 1) Event provider (see [below for nested schema](#nestedblock--event--provider)) |
| 94 | +- `type` (Block List, Min: 1, Max: 1) Event type (see [below for nested schema](#nestedblock--event--type)) |
| 95 | + |
| 96 | +Optional: |
| 97 | + |
| 98 | +- `data` (Block List, Max: 1) Additional attributes for the business event. (see [below for nested schema](#nestedblock--event--data)) |
| 99 | + |
| 100 | +<a id="nestedblock--event--category"></a> |
| 101 | +### Nested Schema for `event.category` |
| 102 | + |
| 103 | +Required: |
| 104 | + |
| 105 | +- `source_type` (String) Possible Values: `Constant_string`, `Request_body`, `Request_headers`, `Request_method`, `Request_parameters`, `Request_path`, `Request_url`, `Response_body`, `Response_headers`, `Response_statusCode` |
| 106 | + |
| 107 | +Optional: |
| 108 | + |
| 109 | +- `path` (String) [See our documentation](https://dt-url.net/ei034bx) |
| 110 | +- `source` (String) Fixed value |
| 111 | + |
| 112 | + |
| 113 | +<a id="nestedblock--event--provider"></a> |
| 114 | +### Nested Schema for `event.provider` |
| 115 | + |
| 116 | +Required: |
| 117 | + |
| 118 | +- `source_type` (String) Possible Values: `Constant_string`, `Request_body`, `Request_headers`, `Request_method`, `Request_parameters`, `Request_path`, `Request_url`, `Response_body`, `Response_headers`, `Response_statusCode` |
| 119 | + |
| 120 | +Optional: |
| 121 | + |
| 122 | +- `path` (String) [See our documentation](https://dt-url.net/ei034bx) |
| 123 | +- `source` (String) Fixed value |
| 124 | + |
| 125 | + |
| 126 | +<a id="nestedblock--event--type"></a> |
| 127 | +### Nested Schema for `event.type` |
| 128 | + |
| 129 | +Required: |
| 130 | + |
| 131 | +- `source_type` (String) Possible Values: `Constant_string`, `Request_body`, `Request_headers`, `Request_method`, `Request_parameters`, `Request_path`, `Request_url`, `Response_body`, `Response_headers`, `Response_statusCode` |
| 132 | + |
| 133 | +Optional: |
| 134 | + |
| 135 | +- `path` (String) [See our documentation](https://dt-url.net/ei034bx) |
| 136 | +- `source` (String) Fixed value |
| 137 | + |
| 138 | + |
| 139 | +<a id="nestedblock--event--data"></a> |
| 140 | +### Nested Schema for `event.data` |
| 141 | + |
| 142 | +Required: |
| 143 | + |
| 144 | +- `event_data_field_complex` (Block Set, Min: 1) (see [below for nested schema](#nestedblock--event--data--event_data_field_complex)) |
| 145 | + |
| 146 | +<a id="nestedblock--event--data--event_data_field_complex"></a> |
| 147 | +### Nested Schema for `event.data.event_data_field_complex` |
| 148 | + |
| 149 | +Required: |
| 150 | + |
| 151 | +- `name` (String) Field name to be added to data. |
| 152 | +- `source` (Block List, Min: 1, Max: 1) no documentation available (see [below for nested schema](#nestedblock--event--data--event_data_field_complex--source)) |
| 153 | + |
| 154 | +<a id="nestedblock--event--data--event_data_field_complex--source"></a> |
| 155 | +### Nested Schema for `event.data.event_data_field_complex.source` |
| 156 | + |
| 157 | +Required: |
| 158 | + |
| 159 | +- `source_type` (String) Possible Values: `Constant_string`, `Request_body`, `Request_headers`, `Request_method`, `Request_parameters`, `Request_path`, `Request_url`, `Response_body`, `Response_headers`, `Response_statusCode` |
| 160 | + |
| 161 | +Optional: |
| 162 | + |
| 163 | +- `path` (String) [See our documentation](https://dt-url.net/ei034bx) |
| 164 | +- `source` (String) Fixed value |
| 165 | + |
| 166 | + |
| 167 | + |
| 168 | + |
| 169 | + |
| 170 | +<a id="nestedblock--triggers"></a> |
| 171 | +### Nested Schema for `triggers` |
| 172 | + |
| 173 | +Required: |
| 174 | + |
| 175 | +- `trigger` (Block Set, Min: 1) (see [below for nested schema](#nestedblock--triggers--trigger)) |
| 176 | + |
| 177 | +<a id="nestedblock--triggers--trigger"></a> |
| 178 | +### Nested Schema for `triggers.trigger` |
| 179 | + |
| 180 | +Required: |
| 181 | + |
| 182 | +- `source` (Block List, Min: 1, Max: 1) no documentation available (see [below for nested schema](#nestedblock--triggers--trigger--source)) |
| 183 | +- `type` (String) Possible Values: `CONTAINS`, `ENDS_WITH`, `EQUALS`, `EXISTS`, `N_CONTAINS`, `N_ENDS_WITH`, `N_EQUALS`, `N_EXISTS`, `N_STARTS_WITH`, `STARTS_WITH` |
| 184 | + |
| 185 | +Optional: |
| 186 | + |
| 187 | +- `case_sensitive` (Boolean) Case sensitive |
| 188 | +- `value` (String) no documentation available |
| 189 | + |
| 190 | +<a id="nestedblock--triggers--trigger--source"></a> |
| 191 | +### Nested Schema for `triggers.trigger.source` |
| 192 | + |
| 193 | +Required: |
| 194 | + |
| 195 | +- `data_source` (String) Possible Values: `Request_body`, `Request_headers`, `Request_method`, `Request_parameters`, `Request_path`, `Request_url`, `Response_body`, `Response_headers`, `Response_statusCode` |
| 196 | + |
| 197 | +Optional: |
| 198 | + |
| 199 | +- `path` (String) [See our documentation](https://dt-url.net/ei034bx) |
| 200 | + |
0 commit comments