microsoftTunnelServer を更新する
名前空間: microsoft.graph
大事な: /beta バージョンの Microsoft Graph API は変更される可能性があります。運用環境での使用はサポートされていません。
注:Intune 用 Microsoft Graph API には、テナントの有効な Intune ライセンスが必要です。
microsoftTunnelServer オブジェクトのプロパティを更新します。
この API は、次の国内クラウド展開で使用できます。
グローバル サービス | 米国政府機関 L4 | 米国政府機関 L5 (DOD) | 21Vianet が運営する中国 |
---|---|---|---|
✅ | ✅ | ✅ | ✅ |
アクセス許可
この API を呼び出すには、次のいずれかのアクセス許可が必要です。 アクセス許可の選択方法などの詳細については、「アクセス許可」を参照してください。
アクセス許可の種類 | アクセス許可 (特権の小さいものから大きいものへ) |
---|---|
委任 (職場または学校のアカウント) | DeviceManagementConfiguration.ReadWrite.All |
委任 (個人用 Microsoft アカウント) | サポートされていません。 |
アプリケーション | DeviceManagementConfiguration.ReadWrite.All |
HTTP 要求
PATCH /deviceManagement/microsoftTunnelSites/{microsoftTunnelSiteId}/microsoftTunnelServers/{microsoftTunnelServerId}
要求ヘッダー
ヘッダー | 値 |
---|---|
Authorization | ベアラー {token}。 必須です。 認証と認可についての詳細をご覧ください。 |
承諾 | application/json |
要求本文
要求本文で、 microsoftTunnelServer オブジェクトの JSON 表現を指定します。
次の表は、 microsoftTunnelServer を作成するときに必要なプロパティを示しています。
プロパティ | 型 | 説明 |
---|---|---|
id | String | マネージド サーバーの一意識別子。 この ID は登録時に割り当てられます。 サポート: $filter、$select、$top、$skip、$orderby。 $searchはサポートされていません。 読み取り専用です。 |
displayName | String | サーバーの表示名。 登録時のホスト名と同じであり、後で変更できます。 サポート: $filter、$select、$top、$skip、$orderby。 $searchはサポートされていません。 最大許容長は 200 文字です。 |
tunnelServerHealthStatus | microsoftTunnelServerHealthStatus | 前回の評価時点でのサーバーの正常性状態を示します。 正常性は 60 秒ごとに評価され、使用可能な値は不明、正常、異常、警告、オフライン、upgradeInProgress、upgradeFailed です。 サポート: $filter、$select、$top、$skip、$orderby。 $searchはサポートされていません。 読み取り専用です。 可能な値は、unknown 、healthy 、unhealthy 、warning 、offline 、upgradeInProgress 、upgradeFailed 、unknownFutureValue です。 |
lastCheckinDateTime | DateTimeOffset | サーバーが最後にチェックインされたタイミングを示します。 Timestamp 型は、ISO 8601 形式を使用して日付と時刻の情報を表し、常に UTC 時間です。 たとえば、2014 年 1 月 1 日午前 0 時 (UTC) は、'2014-01-01T00:00:00Z'.のようになります。 サポート: $filter、$select、$top、$skip、$orderby。 $searchは読み取り専用ではサポートされていません。 |
agentImageDigest | String | このサーバーで実行されている現在のエージェント イメージのダイジェスト。 サポート: $filter、$select、$top、$skip、$orderby。 $searchはサポートされていません。 読み取り専用です。 |
serverImageDigest | String | このサーバーで実行されている現在のサーバー イメージのダイジェスト。 サポート: $filter、$select、$top、$skip、$orderby。 $searchはサポートされていません。 読み取り専用です。 |
deploymentMode | microsoftTunnelDeploymentMode | Microsoft Tunnel サーバー展開モード。 この値は、サーバーが登録されるときに設定されます。 指定できる値は、standaloneRootful、standaloneRootless、podRootful、podRootless です。 既定値: standaloneRootful。 サポート: $filter、$select、$top、$skip、$orderby。 $searchはサポートされていません。 読み取り専用です。 可能な値は、standaloneRootful 、standaloneRootless 、podRootful 、podRootless 、unknownFutureValue です。 |
応答
成功した場合、このメソッドは 200 OK
応答コードと、応答本文で更新された microsoftTunnelServer オブジェクトを返します。
例
要求
以下は、要求の例です。
PATCH https://graph.microsoft.com/beta/deviceManagement/microsoftTunnelSites/{microsoftTunnelSiteId}/microsoftTunnelServers/{microsoftTunnelServerId}
Content-type: application/json
Content-length: 355
{
"@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",
"deploymentMode": "standaloneRootless"
}
応答
以下は、応答の例です。 注: 簡潔にするために、ここに示す応答オブジェクトは切り詰められている場合があります。 実際の呼び出しではすべてのプロパティが返されます。
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 404
{
"@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",
"deploymentMode": "standaloneRootless"
}