microsoftTunnelServer resource type

  • Article

Namespace: microsoft.graph

Important: Microsoft Graph APIs under the /beta version are subject to change; production use is not supported.

Note: The Microsoft Graph API for Intune requires an active Intune license for the tenant.

Entity that represents a single Microsoft Tunnel server

Methods

Method Return Type Description
List microsoftTunnelServers microsoftTunnelServer collection List properties and relationships of the microsoftTunnelServer objects.
Get microsoftTunnelServer microsoftTunnelServer Read properties and relationships of the microsoftTunnelServer object.
Create microsoftTunnelServer microsoftTunnelServer Create a new microsoftTunnelServer object.
Delete microsoftTunnelServer None Deletes a microsoftTunnelServer.
Update microsoftTunnelServer microsoftTunnelServer Update the properties of a microsoftTunnelServer object.
getHealthMetrics action keyLongValuePair collection
getHealthMetricTimeSeries action metricTimeSeriesDataPoint collection
createServerLogCollectionRequest action microsoftTunnelServerLogCollectionResponse
generateServerLogCollectionRequest action microsoftTunnelServerLogCollectionResponse

Properties

Property Type Description
id String The unique identifier for the managed server. This ID is assigned at registration time. Supports: $filter, $select, $top, $skip, $orderby. $search is not supported. Read-only.
displayName String The display name of the server. It is the same as the host name during registration and can be changed later. Supports: $filter, $select, $top, $skip, $orderby. $search is not supported. Max allowed length is 200 chars.
tunnelServerHealthStatus microsoftTunnelServerHealthStatus Indicates the server's health Status as of the last evaluation time. Health is evaluated every 60 seconds, and the possible values are: unknown, healthy, unhealthy, warning, offline, upgradeInProgress, upgradeFailed. Supports: $filter, $select, $top, $skip, $orderby. $search is not supported. Read-only. Possible values are: unknown, healthy, unhealthy, warning, offline, upgradeInProgress, upgradeFailed, unknownFutureValue.
lastCheckinDateTime DateTimeOffset Indicates when the server last checked in. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z'. Supports: $filter, $select, $top, $skip, $orderby. $search is not supported Read-only.
agentImageDigest String The digest of the current agent image running on this server. Supports: $filter, $select, $top, $skip, $orderby. $search is not supported. Read-only.
serverImageDigest String The digest of the current server image running on this server. Supports: $filter, $select, $top, $skip, $orderby. $search is not supported. Read-only.
deploymentMode microsoftTunnelDeploymentMode Microsoft Tunnel server deployment mode. The value is set when the server is registered. Possible values are standaloneRootful, standaloneRootless, podRootful, podRootless. Default value: standaloneRootful. Supports: $filter, $select, $top, $skip, $orderby. $search is not supported. Read-only. Possible values are: standaloneRootful, standaloneRootless, podRootful, podRootless, unknownFutureValue.

Relationships

None

JSON Representation

Here is a JSON representation of the resource.

{
  "@odata.type": "#microsoft.graph.microsoftTunnelServer",
  "id": "String (identifier)",
  "displayName": "String",
  "tunnelServerHealthStatus": "String",
  "lastCheckinDateTime": "String (timestamp)",
  "agentImageDigest": "String",
  "serverImageDigest": "String",
  "deploymentMode": "String"
}