Create connectorGroup

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 connectorGroup object.


Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

Permission type Least privileged permissions Higher privileged permissions
Delegated (work or school account) Directory.ReadWrite.All Not available.
Delegated (personal Microsoft account) Not supported. Not supported.
Application Directory.ReadWrite.All Not available.

HTTP request

POST /onPremisesPublishingProfiles/applicationProxy/connectorGroups

Optional request headers

Name Description
Authorization Bearer. Required.
Content-type application/json. Required.

Request body

In the request body, supply a JSON representation of a connectorGroup object. The following table lists the properties available for a connectorGroup. The name property is a required property.

Property Type Description
connectorGroupType string Indicates the type of hybrid agent. This property is preset by the system.
id string Unique identifier for this connectorGroup. Read-only.
isDefault boolean Indicates whether the connectorGroup is the default. Only a single connector group can be the default connectorGroup and this is preset by the system.
name string The name associated with the connectorGroup.
region string The region the connectorGroup is assigned to and will optimize traffic for. This region can only be set if no connectors or applications are assigned to the connectorGroup. The regions available include: North America, Europe, Australia, Asia, and India. Possible values are: nam, eur, aus, asia, ind.


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



The following example shows a request.

Content-type: application/json

  "name": "Connector Group Demo"



The following example shows the response.

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

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

  "id": "3e6f4c35-a04b-4d03-b98a-66fff89b72e6",
  "name": "Connector Group Demo",
  "connectorGroupType": "applicationProxy",
  "isDefault": true,
  "region": "nam"