connector 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.

Connectors are lightweight agents that sit on-premises and facilitate the outbound connection to the Azure AD Application Proxy service. Each connector is part of a connectorGroup.

Methods

Method Return Type Description
List connectors connector collection Retrieve a list of connector objects.
Get connector connector Read properties and relationships of connector object.
List memberOf connectorGroup collection List the connectorGroup object collection the connector is a member of.
Add connector to connectorGroup connectorGroup Add a connector to a connectorGroup.

Properties

Property Type Description
externalIp String The external IP address as detected by the the connector server. Read-only.
id String Unique identifier of the connector. Read-only.
machineName String The machine name the connector is installed and running on.
status connectorStatus Indicates the status of the connector. Possible values are: active, inactive. Read-only.

Relationships

Relationship Type Description
memberOf connectorGroup collection The connectorGroup that the connector is a member of. Read-only.

JSON representation

The following is a JSON representation of the resource.

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