onPremisesAgent 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 agent. On-premises agents installed by a tenant administrator can be configured to access/handle requests to a particular published resource.

Methods

Method Return Type Description
List onPremisesAgent collection Get an onPremisesAgents object collection.
Get onPremisesAgent Read the properties and relationships of an onPremisesAgent object.
Assign to agent group None Assign an onPremisesAgent to an onPremisesAgentGroup.
Remove from agent group None Remove an onPremisesAgent from an onPremisesAgentGroup.

Properties

Property Type Description
externalIp String The external IP address as detected by the service for the agent machine. Read-only
id String The object id of the onPremisesAgent. Read-only.
machineName String The name of the machine that the agent is running on. Read-only
status agentStatus Possible values are: active, inactive.
supportedPublishingTypes String collection Possible values are: applicationProxy, exchangeOnline, authentication, provisioning, adAdministration.

Relationships

Relationship Type Description
agentGroups onPremisesAgentGroup collection List of onPremisesAgentGroups that an onPremisesAgent is assigned to. Read-only. Nullable.

JSON representation

The following JSON representation shows the resource type.

{
  "externalIp": "String",
  "id": "String (identifier)",
  "machineName": "String",
  "status": "string",
  "supportedPublishingTypes": ["string"]
}