Gateways - Create Gateway

Serviço:

Core

Versão da API:

v1

Cria um gateway.

Escopos delegados necessários

Gateway.ReadWrite.All

Identidades suportadas pelo Microsoft Entra

Esta API suporta as identidades do Microsoft listadas nesta secção.

Identidade	Suporte
Utilizador	Sim
da entidade de serviço e identidades gerenciadas	Sim

Interfaz

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

Corpo do Pedido

CreateVirtualNetworkGatewayRequest

Name	Necessário	Tipo	Description
capacityId	True	string (uuid)	A ID do objeto da capacidade de licença do Fabric.
displayName	True	string	O nome para exibição do gateway de rede virtual. O comprimento máximo é de 200 caracteres.
inactivityMinutesBeforeSleep	True	integer	Os minutos de inatividade antes que o gateway de rede virtual entre em suspensão automática. Deve ser um dos seguintes valores: 30, 60, 90, 120, 150, 240, 360, 480, 720, 1440.
numberOfMemberGateways	True	integer	O número de gateways membros. Um número entre 1 e 7.
type	True	string: VirtualNetwork	O tipo do gateway.
virtualNetworkAzureResource	True	VirtualNetworkAzureResource	O recurso de rede virtual do Azure.

Respostas

Name	Tipo	Description
201 Created	Gateway: OnPremisesGateway OnPremisesGatewayPersonal VirtualNetworkGateway	Criado. A operação foi bem sucedida.
Other Status Codes	ErrorResponse	Códigos de erro comuns: DuplicateGatewayName - O nome do gateway já está em uso. InvalidCapacityState - O estado da capacidade é inválido. InvalidCapacitySKU - O SKU da capacidade é inválido. PowerPlatformVirtualNetworkSubnetNotConfiguredForDelegation - A rede virtual da Power Platform não está configurada para delegação.

Exemplos

Virtual network gateway example

Pedido de amostra

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
}

Resposta da amostra

Código de estado:

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
}

Definições

Name	Description
CreateVirtualNetworkGatewayRequest
ErrorRelatedResource	O objeto de detalhes do recurso relacionado ao erro.
ErrorResponse	A resposta de erro.
ErrorResponseDetails	Os detalhes da resposta de erro.
GatewayType	O tipo do gateway. Tipos de gateway adicionais podem ser adicionados ao longo do tempo.
LoadBalancingSetting	A configuração de balanceamento de carga do cluster de gateway. Configurações adicionais de balanceamento de carga podem ser adicionadas ao longo do tempo.
OnPremisesGateway
OnPremisesGatewayPersonal
PublicKey	A chave pública do gateway local.
VirtualNetworkAzureResource	As propriedades de um recurso do Azure de Rede Virtual
VirtualNetworkGateway

CreateVirtualNetworkGatewayRequest

Object

Name	Tipo	Description
capacityId	string (uuid)	A ID do objeto da capacidade de licença do Fabric.
displayName	string	O nome para exibição do gateway de rede virtual. O comprimento máximo é de 200 caracteres.
inactivityMinutesBeforeSleep	integer	Os minutos de inatividade antes que o gateway de rede virtual entre em suspensão automática. Deve ser um dos seguintes valores: 30, 60, 90, 120, 150, 240, 360, 480, 720, 1440.
numberOfMemberGateways	integer	O número de gateways membros. Um número entre 1 e 7.
type	string: VirtualNetwork	O tipo do gateway.
virtualNetworkAzureResource	VirtualNetworkAzureResource	O recurso de rede virtual do Azure.

ErrorRelatedResource

Object

O objeto de detalhes do recurso relacionado ao erro.

Name	Tipo	Description
resourceId	string	A ID do recurso envolvida no erro.
resourceType	string	O tipo de recurso envolvido no erro.

ErrorResponse

Object

A resposta de erro.

Name	Tipo	Description
errorCode	string	Um identificador específico que fornece informações sobre uma condição de erro, permitindo uma comunicação padronizada entre nosso serviço e seus usuários.
message	string	Uma representação legível por humanos do erro.
moreDetails	ErrorResponseDetails[]	Lista de detalhes de erro adicionais.
relatedResource	ErrorRelatedResource	Os detalhes do recurso relacionados ao erro.
requestId	string	ID da solicitação associada ao erro.

ErrorResponseDetails

Object

Os detalhes da resposta de erro.

Name	Tipo	Description
errorCode	string	Um identificador específico que fornece informações sobre uma condição de erro, permitindo uma comunicação padronizada entre nosso serviço e seus usuários.
message	string	Uma representação legível por humanos do erro.
relatedResource	ErrorRelatedResource	Os detalhes do recurso relacionados ao erro.

GatewayType

Enumeração

O tipo do gateway. Tipos de gateway adicionais podem ser adicionados ao longo do tempo.

Valor	Description
OnPremises	O gateway local.
OnPremisesPersonal	O gateway local (modo pessoal).
VirtualNetwork	O gateway de rede virtual.

LoadBalancingSetting

Enumeração

A configuração de balanceamento de carga do cluster de gateway. Configurações adicionais de balanceamento de carga podem ser adicionadas ao longo do tempo.

Valor	Description
DistributeEvenly	As solicitações serão distribuídas uniformemente entre todos os membros habilitados do cluster de gateway.
Failover	As solicitações serão enviadas para o primeiro membro do cluster de gateway disponível.

OnPremisesGateway

Object

Name	Tipo	Description
allowCloudConnectionRefresh	boolean	Se as conexões de nuvem devem ser atualizadas por meio desse gateway local. Verdadeiro - Permitir, Falso - Não permitir.
allowCustomConnectors	boolean	Se deve permitir que conectores personalizados sejam usados com esse gateway local. Verdadeiro - Permitir, Falso - Não permitir.
displayName	string	O nome para exibição do gateway local.
id	string (uuid)	A ID do objeto do gateway.
loadBalancingSetting	LoadBalancingSetting	A configuração de balanceamento de carga do gateway local.
numberOfMemberGateways	integer	O número de membros do gateway no gateway local.
publicKey	PublicKey	A chave pública do membro principal do gateway. Usado para criptografar as credenciais para criar e atualizar conexões.
type	string: OnPremises	O tipo do gateway.
version	string	A versão do membro do gateway primário instalado.

OnPremisesGatewayPersonal

Object

Name	Tipo	Description
id	string (uuid)	A ID do objeto do gateway.
publicKey	PublicKey	A chave pública do gateway. Usado para criptografar as credenciais para criar e atualizar conexões.
type	string: OnPremisesPersonal	O tipo do gateway.
version	string	A versão do gateway.

PublicKey

Object

A chave pública do gateway local.

Name	Tipo	Description
exponent	string	O expoente da chave pública.
modulus	string	O módulo da chave pública.

VirtualNetworkAzureResource

Object

As propriedades de um recurso do Azure de Rede Virtual

Name	Tipo	Description
resourceGroupName	string	O nome do grupo de recursos
subnetName	string	O nome da sub-rede
subscriptionId	string (uuid)	O ID da subscrição
virtualNetworkName	string	O nome da rede virtual

VirtualNetworkGateway

Object

Name	Tipo	Description
capacityId	string (uuid)	A ID do objeto da capacidade de licença do Fabric.
displayName	string	O nome para exibição do gateway de rede virtual.
id	string (uuid)	A ID do objeto do gateway.
inactivityMinutesBeforeSleep	integer	Os minutos de inatividade antes que o gateway de rede virtual entre em suspensão automática.
numberOfMemberGateways	integer	O número de gateways membros.
type	string: VirtualNetwork	O tipo do gateway.
virtualNetworkAzureResource	VirtualNetworkAzureResource	O recurso de rede virtual do Azure.