Sign in

Update an enrollment group

Update an enrollment group.

patch/enrollmentGroups/{enrollmentGroupId}

Path parameters

enrollmentGroupIdstring required

Unique ID of the enrollment group.

Query parameters

api-versionstring required

The version of the API being called.

Headers

If-Matchstring

Only perform the operation if the entity's etag matches one of the etags provided or * is provided.

Response

Success

idstring

Unique ID of the enrollment group.

displayNamestring required

Display name of the enrollment group.

enabledboolean

Whether the devices using the group are allowed to connect to IoT Central.

type'iot' | 'iotEdge' required

Type of devices that connect through the group.

etagstring

ETag used to prevent conflict in enrollment group updates.

idScopestring

ID scope for connecting to the IoT Central application.

Changes

Changed in 2 of the 8 revisions of this API.2