Gateways - Create Gateway

Служба:: Core

Версия API:: v1

Создает шлюз.

Обязательные делегированные области

Gateway.ReadWrite.All

Поддерживаемые удостоверения Microsoft Entra

Этот API поддерживает удостоверения Microsoft , перечисленные в этом разделе.

Тождество	Поддержка
Пользователь	Да
субъекта-службы и управляемых удостоверений	Да

Интерфейс

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

Текст запроса

CreateVirtualNetworkGatewayRequest

Имя	Обязательно	Тип	Описание
capacityId	True	string (uuid)	Идентификатор объекта емкости лицензии Fabric.
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

Имя	Тип	Описание
201 Created	Gateway: OnPremisesGateway OnPremisesGatewayPersonal VirtualNetworkGateway	Созданный. Операция прошла успешно.
429 Too Many Requests	ErrorResponse	Превышено ограничение скорости обслуживания. Сервер возвращает заголовок, указывающий `Retry-After` в секундах, сколько времени клиент должен ждать перед отправкой дополнительных запросов. Заголовки Retry-After: integer
Other Status Codes	ErrorResponse	Распространенные коды ошибок: DuplicateGatewayName — имя шлюза уже используется. InvalidCapacityState — состояние емкости недопустимо. InvalidCapacitySKU — номер SKU емкости является недопустимым. PowerPlatformVirtualNetworkSubnetNotConfiguredForDelegation — виртуальная сеть Power Platform не настроена для делегирования.

Gateway:

OnPremisesGateway
OnPremisesGatewayPersonal
VirtualNetworkGateway

Созданный. Операция прошла успешно.

429 Too Many Requests

ErrorResponse

Превышено ограничение скорости обслуживания. Сервер возвращает заголовок, указывающий Retry-After в секундах, сколько времени клиент должен ждать перед отправкой дополнительных запросов.

Заголовки

Retry-After: integer

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

Объект

Имя	Тип	Описание
capacityId	string (uuid)	Идентификатор объекта емкости лицензии Fabric.
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

Объект

Объект сведений об ошибках, связанных с ресурсом.

Имя	Тип	Описание
resourceId	string	Идентификатор ресурса, участвующий в ошибке.
resourceType	string	Тип ресурса, который участвует в ошибке.

ErrorResponse

Объект

Ответ на ошибку.

Имя	Тип	Описание
errorCode	string	Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.
message	string	Удобочитаемое представление ошибки.
moreDetails	ErrorResponseDetails[]	Список дополнительных сведений об ошибке.
relatedResource	ErrorRelatedResource	Сведения об ошибках, связанных с ресурсом.
requestId	string (uuid)	Идентификатор запроса, связанного с ошибкой.

ErrorResponseDetails

Объект

Сведения об ответе на ошибку.

Имя	Тип	Описание
errorCode	string	Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.
message	string	Удобочитаемое представление ошибки.
relatedResource	ErrorRelatedResource	Сведения об ошибках, связанных с ресурсом.

GatewayType

Перечисление

Тип шлюза. С течением времени могут добавляться дополнительные типы шлюзов.

Значение	Описание
OnPremises	Локальный шлюз.
OnPremisesPersonal	Локальный шлюз (личный режим).
VirtualNetwork	Шлюз виртуальной сети.

LoadBalancingSetting

Перечисление

Параметр балансировки нагрузки кластера шлюза. С течением времени могут добавляться дополнительные параметры балансировки нагрузки.

Значение	Описание
Failover	Запросы будут отправлены первому доступному члену кластера шлюза.
DistributeEvenly	Запросы будут распределены равномерно между всеми членами кластера шлюза с поддержкой.

OnPremisesGateway

Объект

Имя	Тип	Описание
allowCloudConnectionRefresh	boolean	Следует ли разрешить облачным подключениям обновляться через этот локальный шлюз. True — разрешить, false — не разрешать.
allowCustomConnectors	boolean	Следует ли разрешать использовать пользовательские соединители с этим локальным шлюзом. True — разрешить, false — не разрешать.
displayName	string	Отображаемое имя локального шлюза.
id	string (uuid)	Идентификатор объекта шлюза.
loadBalancingSetting	LoadBalancingSetting	Параметр балансировки нагрузки локального шлюза.
numberOfMemberGateways	integer	Количество членов шлюза в локальном шлюзе.
publicKey	PublicKey	Открытый ключ члена первичного шлюза. Используется для шифрования учетных данных для создания и обновления подключений.
type	string: OnPremises	Тип шлюза.
version	string	Версия установленного члена основного шлюза.

OnPremisesGatewayPersonal

Объект

Имя	Тип	Описание
id	string (uuid)	Идентификатор объекта шлюза.
publicKey	PublicKey	Открытый ключ шлюза. Используется для шифрования учетных данных для создания и обновления подключений.
type	string: OnPremisesPersonal	Тип шлюза.
version	string	Версия шлюза.

PublicKey

Объект

Открытый ключ локального шлюза.

Имя	Тип	Описание
exponent	string	Экспонент открытого ключа.
modulus	string	Модуль открытого ключа.

VirtualNetworkAzureResource

Объект

Свойства ресурса Azure виртуальной сети

Имя	Тип	Описание
resourceGroupName	string	Имя группы ресурсов
subnetName	string	Имя подсети
subscriptionId	string (uuid)	Идентификатор подписки
virtualNetworkName	string	Имя виртуальной сети

VirtualNetworkGateway

Объект

Имя	Тип	Описание
capacityId	string (uuid)	Идентификатор объекта емкости лицензии Fabric.
displayName	string	Отображаемое имя шлюза виртуальной сети.
id	string (uuid)	Идентификатор объекта шлюза.
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