Gateways - Create Gateway

参考

服务:: Core

API 版本:: v1

注意

此 API 以预览版提供。

创建网关。

所需的委派范围

Gateway.ReadWrite.All

Microsoft Entra 支持的标识

此 API 支持本节中列出的Microsoft 标识。

身份	支持
用户	是的
服务主体和托管标识	是的

接口

POST https://api.fabric.microsoft.com/v1/gateways

请求正文

CreateVirtualNetworkGatewayRequest

名称	必需	类型	说明
capacityId	True	string uuid	Fabric 许可证容量的对象 ID。
displayName	True	string	虚拟网络网关的显示名称。最大长度为 200 个字符。
inactivityMinutesBeforeSleep	True	integer	虚拟网络网关进入自动睡眠前的非活动分钟数。必须是以下值之一：30、60、90、120、150、240、360、480、720、1440。
numberOfMemberGateways	True	integer	成员网关数。介于 1 和 7 之间的数字。
type	True	string: VirtualNetwork	网关的类型。
virtualNetworkAzureResource	True	VirtualNetworkAzureResource	Azure 虚拟网络资源。

响应

名称	类型	说明
201 Created	Gateway: OnPremisesGateway OnPremisesGatewayPersonal VirtualNetworkGateway	创建。作成功。
Other Status Codes	ErrorResponse	常见错误代码： DuplicateGatewayName - 网关名称已在使用中。 InvalidCapacityState - 容量的状态无效。 InvalidCapacitySKU - 容量的 SKU 无效。 PowerPlatformVirtualNetworkSubnetNotConfiguredForDelegation - 未为委派配置 Power Platform 虚拟网络。

名称

类型

说明

201 Created

Gateway:

OnPremisesGateway
OnPremisesGatewayPersonal
VirtualNetworkGateway

创建。作成功。

Other Status Codes

ErrorResponse

常见错误代码：

DuplicateGatewayName - 网关名称已在使用中。
InvalidCapacityState - 容量的状态无效。
InvalidCapacitySKU - 容量的 SKU 无效。
PowerPlatformVirtualNetworkSubnetNotConfiguredForDelegation - 未为委派配置 Power Platform 虚拟网络。

示例

Virtual network gateway example

示例请求

HTTP

POST https://api.fabric.microsoft.com/v1/gateways

{
  "type": "VirtualNetwork",
  "displayName": "ContosoVirtualNetworkGateway",
  "capacityId": "ed26b6f3-7bc5-44b0-9565-a8942619ef4c",
  "virtualNetworkAzureResource": {
    "subscriptionId": "879b4ba0-ed17-4ff2-851e-4a2228e00b70",
    "resourceGroupName": "ContosoResourceGroup",
    "virtualNetworkName": "ContosoVirtualNetwork",
    "subnetName": "ContosoSubnet"
  },
  "inactivityMinutesBeforeSleep": 120,
  "numberOfMemberGateways": 3
}

示例响应

状态代码:: 200

{
  "id": "271c5c9a-0860-4927-b1da-ce49008d6565",
  "type": "VirtualNetwork",
  "displayName": "ContosoVirtualNetworkGateway",
  "capacityId": "ed26b6f3-7bc5-44b0-9565-a8942619ef4c",
  "virtualNetworkAzureResource": {
    "subscriptionId": "879b4ba0-ed17-4ff2-851e-4a2228e00b70",
    "resourceGroupName": "ContosoResourceGroup",
    "virtualNetworkName": "ContosoVirtualNetwork",
    "subnetName": "ContosoSubnet"
  },
  "inactivityMinutesBeforeSleep": 120,
  "numberOfMemberGateways": 3
}

定义

名称	说明
CreateVirtualNetworkGatewayRequest
ErrorRelatedResource	与错误相关的资源详细信息对象。
ErrorResponse	错误响应。
ErrorResponseDetails	错误响应详细信息。
GatewayType	网关的类型。可能会随着时间的推移添加其他网关类型。
LoadBalancingSetting	网关群集的负载均衡设置。可能会随着时间的推移添加其他负载均衡设置。
OnPremisesGateway
OnPremisesGatewayPersonal
PublicKey	本地网关的公钥。
VirtualNetworkAzureResource	虚拟网络 Azure 资源的属性
VirtualNetworkGateway

CreateVirtualNetworkGatewayRequest

Object

名称	类型	说明
capacityId	string uuid	Fabric 许可证容量的对象 ID。
displayName	string	虚拟网络网关的显示名称。最大长度为 200 个字符。
inactivityMinutesBeforeSleep	integer	虚拟网络网关进入自动睡眠前的非活动分钟数。必须是以下值之一：30、60、90、120、150、240、360、480、720、1440。
numberOfMemberGateways	integer	成员网关数。介于 1 和 7 之间的数字。
type	string: VirtualNetwork	网关的类型。
virtualNetworkAzureResource	VirtualNetworkAzureResource	Azure 虚拟网络资源。

ErrorRelatedResource

Object

与错误相关的资源详细信息对象。

名称	类型	说明
resourceId	string	错误中涉及的资源 ID。
resourceType	string	错误中涉及的资源的类型。

ErrorResponse

Object

错误响应。

名称	类型	说明
errorCode	string	提供有关错误条件的信息的特定标识符，允许服务与其用户之间的标准化通信。
message	string	错误的人工可读表示形式。
moreDetails	ErrorResponseDetails[]	其他错误详细信息的列表。
relatedResource	ErrorRelatedResource	与错误相关的资源详细信息。
requestId	string	与错误关联的请求的 ID。

ErrorResponseDetails

Object

错误响应详细信息。

名称	类型	说明
errorCode	string	提供有关错误条件的信息的特定标识符，允许服务与其用户之间的标准化通信。
message	string	错误的人工可读表示形式。
relatedResource	ErrorRelatedResource	与错误相关的资源详细信息。

GatewayType

Enumeration

网关的类型。可能会随着时间的推移添加其他网关类型。

值	说明
OnPremises	本地网关。
OnPremisesPersonal	本地网关（个人模式）。
VirtualNetwork	虚拟网络网关。

LoadBalancingSetting

Enumeration

网关群集的负载均衡设置。可能会随着时间的推移添加其他负载均衡设置。

值	说明
DistributeEvenly	请求将均匀分发到所有已启用的网关群集成员之间。
Failover	请求将发送到第一个可用的网关群集成员。

OnPremisesGateway

Object

名称	类型	说明
allowCloudConnectionRefresh	boolean	是否允许云连接通过此本地网关进行刷新。 True - 允许，False - 不允许。
allowCustomConnectors	boolean	是否允许自定义连接器用于此本地网关。 True - 允许，False - 不允许。
displayName	string	本地网关的显示名称。
id	string uuid	网关的对象 ID。
loadBalancingSetting	LoadBalancingSetting	本地网关的负载均衡设置。
numberOfMemberGateways	integer	本地网关中的网关成员数。
publicKey	PublicKey	主网关成员的公钥。用于加密用于创建和更新连接的凭据。
type	string: OnPremises	网关的类型。
version	string	已安装的主网关成员的版本。

OnPremisesGatewayPersonal

Object

名称	类型	说明
id	string uuid	网关的对象 ID。
publicKey	PublicKey	网关的公钥。用于加密用于创建和更新连接的凭据。
type	string: OnPremisesPersonal	网关的类型。
version	string	网关的版本。

PublicKey

Object

本地网关的公钥。

名称	类型	说明
exponent	string	公钥的指数。
modulus	string	公钥的模数。

VirtualNetworkAzureResource

Object

虚拟网络 Azure 资源的属性

名称	类型	说明
resourceGroupName	string	资源组的名称
subnetName	string	子网的名称
subscriptionId	string uuid	订阅 ID
virtualNetworkName	string	虚拟网络的名称

VirtualNetworkGateway

Object

名称	类型	说明
capacityId	string uuid	Fabric 许可证容量的对象 ID。
displayName	string	虚拟网络网关的显示名称。
id	string uuid	网关的对象 ID。
inactivityMinutesBeforeSleep	integer	虚拟网络网关进入自动睡眠前的非活动分钟数。
numberOfMemberGateways	integer	成员网关数。
type	string: VirtualNetwork	网关的类型。
virtualNetworkAzureResource	VirtualNetworkAzureResource	Azure 虚拟网络资源。

通过

Gateways - Create Gateway

所需的委派范围

Microsoft Entra 支持的标识

接口

请求正文

CreateVirtualNetworkGatewayRequest

响应

示例

Virtual network gateway example

示例请求

示例响应

定义

CreateVirtualNetworkGatewayRequest

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

GatewayType

LoadBalancingSetting

OnPremisesGateway

OnPremisesGatewayPersonal

PublicKey

VirtualNetworkAzureResource

VirtualNetworkGateway

其他资源