Workbook text parameters

Text box parameters provide a simple way to collect text input from workbook users. They're used when it isn't practical to use a dropdown list to collect the input, for example, with an arbitrary threshold or generic filters. By using a workbook, you can get the default value of the text box from a query. This functionality allows for interesting scenarios like setting the default threshold based on the p95 of the metric.

A common use of text boxes is as internal variables used by other workbook controls. You use a query for default values and make the input control invisible in read mode. For example, you might want a threshold to come from a formula, not a user, and then use the threshold in subsequent queries.

Create a text parameter

1. Start with an empty workbook in edit mode.

2. Select Add parameters > Add Parameter.

3. In the new parameter pane that opens, enter:

   1. Parameter name: SlowRequestThreshold
   2. Parameter type: Text
   3. Required: checked
   4. Get data from: None

4. Select Save to create the parameter.

   

This screenshot shows how the workbook looks in read mode:

Parameter field style

The text parameter supports the following field styles:

• Standard: A single line text field.

  

• Password: A single line password field. The password value is only hidden in the UI when you type. The value is fully accessible as a parameter value when referred. It's stored unencrypted when the workbook is saved.

  

• Multiline: A multiline text field with support of rich IntelliSense and syntax colorization for the following languages:

  • Text
  • Markdown
  • JSON
  • SQL
  • TypeScript
  • KQL
  • TOML

  You can also specify the height for the multiline editor.

  

Reference a text parameter

1. Select Add query to add a query control, and then select an Application Insights resource.

2. In the KQL box, add this snippet:

   requests
   | summarize AllRequests = count(), SlowRequests = countif(duration >= {SlowRequestThreshold}) by name
   | extend SlowRequestPercent = 100.0 * SlowRequests / AllRequests
   | order by SlowRequests desc
   

3. By using the text parameter with a value of 500 coupled with the query control, you effectively run the following query:

   requests
   | summarize AllRequests = count(), SlowRequests = countif(duration >= 500) by name
   | extend SlowRequestPercent = 100.0 * SlowRequests / AllRequests
   | order by SlowRequests desc
   

4. Run the query to see the results.

   

Set the default values using queries

1. Start with an empty workbook in edit mode.

2. Select Add parameters > Add Parameter.

3. In the new parameter pane that opens, enter:

   1. Parameter name: SlowRequestThreshold
   2. Parameter type: Text
   3. Required: checked
   4. Get data from: Query

4. In the KQL box, add this snippet:

   requests
   | summarize round(percentile(duration, 95), 2)
   

   This query sets the default value of the text box to the 95th percentile duration for all requests in the app.

5. Run the query to see the results.

6. Select Save to create the parameter.

   

Add validations

For standard and password text parameters, you can add validation rules that are applied to the text field. Add a valid regex with an error message. If the message is set, it's shown as an error when the field is invalid.

If the match is selected, the field is valid if the value matches the regex. If the match isn't selected, the field is valid if it doesn't match the regex.

Format JSON data

If JSON is selected as the language for the multiline text field, the field will have a button that formats the JSON data of the field. You can also use the shortcut Ctrl + \ to format the JSON data.

If data is coming from a query, you can select the option to pre-format the JSON data that's returned by the query.

Next steps

Get started with Azure Workbooks