通过

创建 remoteNetwork

  • 项目

命名空间：microsoft.graph.networkaccess

重要

Microsoft Graph /beta 版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用，请使用 版本 选择器。

创建新的远程网络。

此 API 可用于以下国家级云部署。

全局服务 美国政府 L4 美国政府 L5 (DOD) 由世纪互联运营的中国
✅ ❌ ❌ ❌

权限

为此 API 选择标记为最低特权的权限。 只有在应用需要它时，才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息，请参阅权限类型。 要了解有关这些权限的详细信息，请参阅 权限参考。

权限类型 最低特权权限 更高特权权限
委派（工作或学校帐户） 不支持。 不支持。
委派（个人 Microsoft 帐户） 不支持。 不支持。
应用程序 不支持。 不支持。

重要

在具有工作或学校帐户的委托方案中，必须为登录用户分配受支持的Microsoft Entra角色或具有支持的角色权限的自定义角色。 此操作支持以下最低特权角色。

  • 全局安全访问管理员
  • 安全管理员

HTTP 请求

POST /networkAccess/connectivity/remoteNetworks

请求标头

名称 说明
Authorization 持有者 {token}。 必填。 详细了解 身份验证和授权。
Content-Type application/json. 必需。

请求正文

在请求正文中，提供 microsoft.graph.networkaccess.remoteNetwork 对象的 JSON 表示形式。

创建 远程网络时，可以指定以下属性。

属性 类型 说明
name String 远程网络的名称。 必填。
地区 String 指定离远程网络位置最近的区域。 必填。

响应

如果成功，此方法在 201 Created 响应正文中返回响应代码和 microsoft.graph.networkaccess.remoteNetwork 对象。

示例 1：创建仅具有名称和区域的远程网络

请求

以下示例显示了一个请求。

POST https://graph.microsoft.com/beta/networkAccess/connectivity/remoteNetworks
Content-Type: application/json

{
    "name": "Bellevue branch",
    "region": "canadaEast"
}

响应

以下示例显示了相应的响应。

注意：为了提高可读性，可能缩短了此处显示的响应对象。

HTTP/1.1 201 Created
Content-Type: application/json

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#networkAccess/connectivity/remoteNetworks/$entity",
    "id": "8a273997-b84d-422f-8dec-e1dd82a4035b",
    "name": "Bellevue branch",
    "region": "canadaEast",
    "version": "1.0.0",
    "lastModifiedDateTime": "2024-02-01T00:41:48Z"
}

示例 2：使用转发配置文件创建远程网络

若要获取组织的转发配置文件的 ID，请参阅此文 - 列出 forwardingProfiles。

请求

以下示例显示了一个请求。

POST https://graph.microsoft.com/beta/networkAccess/connectivity/remoteNetworks
Content-Type: application/json

{
    "name": "Bellevue branch w/ fwd profile",
    "region": "canadaEast",
    "forwardingProfiles": [
        {
            "id": "1adaf535-1e31-4e14-983f-2270408162bf"
        }
    ]
}

响应

以下示例显示了相应的响应。

注意：为了提高可读性，可能缩短了此处显示的响应对象。

HTTP/1.1 201 Created
Content-Type: application/json

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#networkAccess/connectivity/remoteNetworks/$entity",
    "id": "6542b28c-5ba7-4b50-9576-e63a6210e481",
    "name": "Bellevue branch w/ fwd profile",
    "region": "canadaEast",
    "version": "1.0.0",
    "lastModifiedDateTime": "2024-02-01T00:54:45Z"
}

若要获取组织的转发配置文件的 ID，请参阅此文 - 列出 forwardingProfiles。

请求

以下示例显示了一个请求。

POST https://graph.microsoft.com/beta/networkAccess/connectivity/remoteNetworks
Content-Type: application/json

{
    "name": "Bellevue branch w/ device link",
    "region": "canadaEast",
    "forwardingProfiles": [
        {
            "id": "1adaf535-1e31-4e14-983f-2270408162bf"
        }
    ],
    "deviceLinks": [
        {
            "name": "CPE1",
            "ipAddress": "52.13.21.25",
            "bandwidthCapacityInMbps": "mbps500",
            "deviceVendor": "barracudaNetworks",
            "bgpConfiguration": {
                "localIpAddress": "192.168.1.2",
                "peerIpAddress": "10.1.1.2",
                "asn": 65533
            },
            "redundancyConfiguration": {
                "zoneLocalIpAddress": null,
                "redundancyTier": "noRedundancy"
            },
            "tunnelConfiguration": {
                "@odata.type": "#microsoft.graph.networkaccess.tunnelConfigurationIKEv2Default",
                "preSharedKey": "test123"
            }
        }
    ]
}

响应

以下示例显示了相应的响应。

注意：为了提高可读性，可能缩短了此处显示的响应对象。

HTTP/1.1 201 Created
Content-Type: application/json

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#networkAccess/connectivity/remoteNetworks/$entity",
    "id": "5d2f5061-4876-4c1c-ba2d-5acc6a73742d",
    "name": "Bellevue branch w/ device link",
    "region": "canadaEast",
    "version": "1.0.0",
    "lastModifiedDateTime": "2024-02-01T01:02:25Z"
}