.show entity_group(s) command

Applies to: ✅ Azure Data Explorer

Lists all the entity groups in the selected database or lists the details of one specific stored entity group.

Permissions

You must have at least Database Admin permissions to run this command.

Syntax

.show entity_groups

.show entity_group EntityGroupName

Learn more about syntax conventions.

Parameters

Name Type Required Description
EntityGroupName string The name of the specific entity group you wish to view.

Returns

This command returns a table with the following columns:

Output parameter Type Description
Name string The name of the entity group.
Entities array An array which includes one or more entities. If the entity group doesn't exist, an error is returned.

Examples

The following examples show how to use the .show entity_group and .show entity_group commands.

Show entity groups

The following example returns all the entity groups in the selected database, eg1 and eg2, along with their entities.

.show entity_groups

Output

Name Entities
eg1 ["cluster('c1').database('d1')"]
eg2 ["cluster('c2').database('d2')"]

Show an entity group

The following example returns the entity group, eg1 along with its entity, cluster('c1').database('d1').

.show entity_group eg1

Output

Name Entities
eg1 ["cluster('c1').database('d1')"]