创建 forwardingProfile (已弃用)
命名空间:microsoft.graph.networkaccess
重要
Microsoft Graph /beta
版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用,请使用 版本 选择器。
重要
已弃用,即将停用。 请改用 remoteNetwork 资源类型 及其关联方法。
创建新分支并分配转发配置文件。
此 API 可用于以下国家级云部署。
全局服务 | 美国政府 L4 | 美国政府 L5 (DOD) | 由世纪互联运营的中国 |
---|---|---|---|
✅ | ❌ | ❌ | ❌ |
权限
为此 API 选择标记为最低特权的权限。 只有在应用需要它时,才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息,请参阅权限类型。 要了解有关这些权限的详细信息,请参阅 权限参考。
权限类型 | 最低特权权限 | 更高特权权限 |
---|---|---|
委派(工作或学校帐户) | NetworkAccessPolicy.ReadWrite.All | 不可用。 |
委派(个人 Microsoft 帐户) | 不支持。 | 不支持。 |
应用程序 | 不支持。 | 不支持。 |
HTTP 请求
POST /networkAccess/connectivity/branches/{branchSiteId}/forwardingProfiles
请求标头
名称 | 说明 |
---|---|
Authorization | 持有者 {token}。 必填。 详细了解 身份验证和授权。 |
Content-Type | application/json. 必需。 |
请求正文
在请求正文中,提供 microsoft.graph.networkaccess.forwardingProfile 对象的 JSON 表示形式。
创建 forwardingProfile 时,可以指定以下属性。
属性 | 类型 | 说明 |
---|---|---|
name | String | 分支的名称。 继承自 microsoft.graph.networkaccess.profile。 必需。 |
description | String | 说明。 继承自 microsoft.graph.networkaccess.profile。 可选。 |
state | microsoft.graph.networkaccess.status | 状态。 继承自 microsoft.graph.networkaccess.profile。 可能的值为: enabled 、 disabled 。 必填。 |
协会 | microsoft.graph.networkaccess.association 集合 | 转发配置文件集合表示一组多个转发配置文件。 必填。 |
响应
如果成功,此方法在 201 Created
响应正文中返回响应代码和 microsoft.graph.networkaccess.forwardingProfile 对象。
示例
请求
以下示例显示了一个请求。
POST https://graph.microsoft.com/beta/networkAccess/connectivity/branches/{branchSiteId}/
Content-Type: application/json
{
"name": "branch 1",
"region": "eastUS",
"deviceLinks":
[
{
"name": "device link 1",
"ipAddress": "24.123.22.168",
"deviceVendor": "intel",
"bandwidthCapacityInMbps": "mbps250",
"bgpConfiguration":
{
"localIpAddress": "1.128.24.22",
"peerIpAddress": "1.128.24.28",
"asn": 4,
},
"redundancyConfiguration":
{
"zoneLocalIpAddress": "1.128.23.20",
"redundancyTier": "zoneRedundancy",
},
"tunnelConfiguration":
{
"@odata.type": "microsoft.graph.networkAccess.tunnelConfigurationIKEv2Default",
"preSharedKey": "/path/to/kv"
}
}
],
"forwardingProfiles": [
{
"id": "8e30d8d6-3588-4d5f-a704-6bd843be5b8f"
}
]
}
响应
以下示例显示了相应的响应。
注意:为了提高可读性,可能缩短了此处显示的响应对象。
HTTP/1.1 201 Created
Content-Type: application/json
{
"@odata.context": "https://localhost:5001/networkaccess/connectivity/$metadata#branches/$entity",
"id": "c038928c-4100-4b8d-895d-f90ae38bafa1",
"name": "branch 1",
"region": "eastUS",
"connectivityState": "pending",
"version": "1.0.0",
"lastModifiedDateTime": "2021-01-05T00:00:00Z",
"deviceLinks": [
{
"id": "f29753d5-85b4-4cce-9194-10a287568973",
"name": "device link 1",
"ipAddress": "24.123.22.168",
"deviceVendor": "intel",
"bandwidthCapacityInMbps": "mbps250",
"bgpConfiguration":
{
"localIpAddress": "1.128.24.22",
"peerIpAddress": "1.128.24.28",
"asn": 4,
},
"redundancyConfiguration":
{
"zoneLocalIpAddress": "1.128.23.20",
"redundancyTier": "zoneRedundancy",
},
"tunnleConfiguration": {
"@odata.type": "#microsoft.graph.networkaccess.TunnleConfigurationIKEv2Deafult",
"preSharedKey": "/path/to/kv"
}
}
],
"forwardingProfiles": [
{
"id": "8e30d8d6-3588-4d5f-a704-6bd843be5b8f"
}
]
}