.alter-merge entity_group command

Applies to: ✅ Azure Data Explorer

Alters and merges an existing entity group with the provided list of entities and stores it inside the database metadata. For more information, see Entity groups.

Permissions

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

Syntax

.alter-merge entity_group EntityGroupName (EntityReference [, ...])

Learn more about syntax conventions.

Parameters

Name Type Required Description
EntityGroupName string ✔️ The name of the entity group.
EntityReference string ✔️ An entity included in the entity group.

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.

Examples

The following example edits the MyEntityGroup entity group and adds the entity cluster('c2').database('d2') to the entity group.

First run the following command to create a new entity group with entity cluster('c1').database('d1'):

.create entity_group MyEntityGroup (cluster('c1').database('d1'))

Output

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

Then run the following command to edit the existing entity group MyEntityGroup and add the entity cluster('c2').database('d2'):

.alter-merge entity_group MyEntityGroup (cluster('c2').database('d2'))

Output

Name Entities
MyEntityGroup ["cluster('c1').database('d1')","cluster('c2').database('d2')"]

Related content