bag_has_key()

Learn how to use the bag_has_key() function to check if a dynamic property bag object contains a given key.

Checks whether a dynamic property bag object contains a given key.

Syntax

bag_has_key(bag,key)

Parameters

NameTypeRequiredDescription
bagdynamic✔️The property bag to search.
keystring✔️The key for which to search. Search for a nested key using the JSONPath notation. Array indexing isn’t supported.

Returns

True or false depending on if the key exists in the bag.

Examples

datatable(input: dynamic)
[
    dynamic({'key1' : 123, 'key2': 'abc'}),
    dynamic({'key1' : 123, 'key3': 'abc'}),
]
| extend result = bag_has_key(input, 'key2')

Output

inputresult
{
“key1”: 123,
“key2”: “abc”
}		true
{
“key1”: 123,
“key3”: “abc”
}		false

Search using a JSONPath key

datatable(input: dynamic)
[
    dynamic({'key1': 123, 'key2': {'prop1' : 'abc', 'prop2': 'xyz'}, 'key3': [100, 200]}),
]
| extend result = bag_has_key(input, '$.key2.prop1')

Output

inputresult
{
“key1”: 123,
“key2”: {
“prop1”: “abc”,
“prop2”: “xyz”
},
“key3”: [
100,
200
]
}		true