Create microsoftTunnelServer
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.
Create a new microsoftTunnelServer object.
This API is available in the following national cloud deployments.
Global service | US Government L4 | US Government L5 (DOD) | China operated by 21Vianet |
---|---|---|---|
✅ | ✅ | ✅ | ❌ |
Permissions
One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.
Permission type | Permissions (from least to most privileged) |
---|---|
Delegated (work or school account) | DeviceManagementConfiguration.ReadWrite.All |
Delegated (personal Microsoft account) | Not supported. |
Application | DeviceManagementConfiguration.ReadWrite.All |
HTTP Request
POST /deviceManagement/microsoftTunnelSites/{microsoftTunnelSiteId}/microsoftTunnelServers
Request headers
Header | Value |
---|---|
Authorization | Bearer {token}. Required. Learn more about authentication and authorization. |
Accept | application/json |
Request body
In the request body, supply a JSON representation for the microsoftTunnelServer object.
The following table shows the properties that are required when you create the microsoftTunnelServer.
Property | Type | Description |
---|---|---|
id | String | The unique identifier for the managed server. This id is assigned at enrollment time. Supports: $delete. $Update, $insert, $skip, $top is not supported. Read-only. |
displayName | String | The display name for the server. This property is required when a server is created and cannot be cleared during updates. |
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. Possible values are: unknown , healthy , unhealthy , warning , offline , upgradeInProgress , upgradeFailed , unknownFutureValue . |
lastCheckinDateTime | DateTimeOffset | Indicates when the server last checked in |
agentImageDigest | String | The digest of the current agent image running on this server |
serverImageDigest | String | The digest of the current server image running on this server |
Response
If successful, this method returns a 201 Created
response code and a microsoftTunnelServer object in the response body.
Example
Request
Here is an example of the request.
POST https://graph.microsoft.com/beta/deviceManagement/microsoftTunnelSites/{microsoftTunnelSiteId}/microsoftTunnelServers
Content-type: application/json
Content-length: 312
{
"@odata.type": "#microsoft.graph.microsoftTunnelServer",
"displayName": "Display Name value",
"tunnelServerHealthStatus": "healthy",
"lastCheckinDateTime": "2017-01-01T00:02:46.0431416-08:00",
"agentImageDigest": "Agent Image Digest value",
"serverImageDigest": "Server Image Digest value"
}
Response
Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call.
HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 361
{
"@odata.type": "#microsoft.graph.microsoftTunnelServer",
"id": "b5cf0aee-0aee-b5cf-ee0a-cfb5ee0acfb5",
"displayName": "Display Name value",
"tunnelServerHealthStatus": "healthy",
"lastCheckinDateTime": "2017-01-01T00:02:46.0431416-08:00",
"agentImageDigest": "Agent Image Digest value",
"serverImageDigest": "Server Image Digest value"
}
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for