Skip to content

connectorgroup-post.md

Latest commit

 

History

History
137 lines (107 loc) · 5.09 KB

connectorgroup-post.md

File metadata and controls

137 lines (107 loc) · 5.09 KB
title Create connectorGroup
description Create a connectorGroup object.
ms.localizationpriority medium
author dhruvinrshah
ms.subservice entra-applications
doc_type apiPageType
ms.date 08/01/2024

Create connectorGroup

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

Create a connectorGroup object.

Permissions

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.

[!INCLUDE permissions-table]

HTTP request

POST /onPremisesPublishingProfiles/applicationProxy/connectorGroups

Optional request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.
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. The possible values are: nam, eur, aus, asia, ind.

Response

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

Example

Request

The following example shows a request.

HTTP

POST https://graph.microsoft.com/beta/onPremisesPublishingProfiles/applicationProxy/connectorGroups
Content-type: application/json

{
  "name": "Connector Group Demo"

}

C#

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Go

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Java

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

JavaScript

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PHP

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PowerShell

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Python

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Response

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"
}