onPremisesAgentGroup resource type

Namespace: microsoft.graph

Important

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.

Represents on-premises agents group. Agent groups enable a tenant admin to assign specific agents to serve specific published on-premises resources.

Methods

Method	Return Type	Description
List onPremisesAgentGroups	onPremisesAgentGroups collection	Get an onPremisesAgentGroup objects collection.
Get onPremisesAgentGroup	onPremisesAgentGroup	Read the properties and relationships of an onPremisesAgentGroup object.
Create onPremisesAgentGroup	onPremisesAgentGroup	Create a new onPremisesAgentGroup.
Update onPremisesAgentGroup	onPremisesAgentGroup	Update an onPremisesAgentGroup object.
Delete onPremisesAgentGroup	None	Delete an onPremisesAgentGroup object.

Properties

Property	Type	Description
displayName	String	Display name of the onPremisesAgentGroup.
id	String	The object ID of the onPremisesAgentGroup. Read-only.
isDefault	Boolean	Indicates if the onPremisesAgentGroup is the default agent group. Only a single agent group can be the default onPremisesAgentGroup and is set by the system.
publishingType	String	Possible values are: applicationProxy, exchangeOnline, authentication, provisioning, adAdministration.

Relationships

Relationship	Type	Description
agents	onPremisesAgent collection	List of onPremisesAgent that are assigned to an onPremisesAgentGroup. Read-only. Nullable.
publishedResources	publishedResource collection	List of publishedResource that are assigned to an onPremisesAgentGroup. Read-only. Nullable.

JSON representation

The following is a JSON representation of the resource.

{
  "displayName": "String",
  "id": "String (identifier)",
  "isDefault": true,
  "publishingType": "string"
}