Create onPremisesAgentGroup

Namespace: microsoft.graph


APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Create a new onPremisesAgentGroup object.


One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Permission type Permissions (from least to most privileged)
Delegated (work or school account) Directory.ReadWrite.All
Delegated (personal Microsoft account) Not supported.
Application Not supported.

HTTP request

POST ~/onPremisesPublishingProfiles/{publishingType}/agentGroups/{id}/agents

Request headers

Name Description
Authorization Bearer {token}

Request body

In the request body, supply a JSON representation of an onPremisesAgentGroup object.

    "displayName": "New Group"


If successful, this method returns a 201 Created response code and an onPremisesAgentGroup object in the response body.



The following is an example of the request.


In the request body, supply a JSON representation of onPremisesAgentGroup object.

    "displayName": "New Group"


The following is an example of the response.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 201 Created
Content-type: application/json

    "id": "4655ed41-1619-4848-92bb-0576d3038682",
    "displayName": "New Group",
    "publishingType": "provisioning",
    "isDefault": false