Gateways - Create Gateway

Servizio:: Core

Versione API:: v1

Crea un gateway.

Ambiti delegati obbligatori

Gateway.ReadWrite.All

Identità supportate da Microsoft Entra

Questa API supporta le identità di Microsoft elencate in questa sezione.

Identità	Appoggiare
Utente	Sì
'entità servizio e identità gestite	Sì

Interfaccia

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

Corpo della richiesta

CreateVirtualNetworkGatewayRequest

Nome	Necessario	Tipo	Descrizione
capacityId	True	string (uuid)	ID oggetto della capacità della licenza fabric.
displayName	True	string	Nome visualizzato del gateway di rete virtuale. La lunghezza massima è di 200 caratteri.
inactivityMinutesBeforeSleep	True	integer	I minuti di inattività prima che il gateway di rete virtuale entri in sospensione automatica. Deve essere uno dei valori seguenti: 30, 60, 90, 120, 150, 240, 360, 480, 720, 1440.
numberOfMemberGateways	True	integer	Numero di gateway membro. Numero compreso tra 1 e 7.
type	True	string: VirtualNetwork	Tipo del gateway.
virtualNetworkAzureResource	True	VirtualNetworkAzureResource	Risorsa di rete virtuale di Azure.

Risposte

Nome	Tipo	Descrizione
201 Created	Gateway: OnPremisesGateway OnPremisesGatewayPersonal VirtualNetworkGateway	Creato. Operazione riuscita.
Other Status Codes	ErrorResponse	Codici di errore comuni: DuplicateGatewayName: il nome del gateway è già in uso. InvalidCapacityState: lo stato della capacità non è valido. InvalidCapacitySKU: lo SKU della capacità non è valido. PowerPlatformVirtualNetworkSubnetNotConfiguredForDelegation: la rete virtuale Power Platform non è configurata per la delega.

Nome

Tipo

Descrizione

201 Created

Gateway:

OnPremisesGateway
OnPremisesGatewayPersonal
VirtualNetworkGateway

Creato. Operazione riuscita.

Other Status Codes

ErrorResponse

Codici di errore comuni:

DuplicateGatewayName: il nome del gateway è già in uso.
InvalidCapacityState: lo stato della capacità non è valido.
InvalidCapacitySKU: lo SKU della capacità non è valido.
PowerPlatformVirtualNetworkSubnetNotConfiguredForDelegation: la rete virtuale Power Platform non è configurata per la delega.

Esempio

Virtual network gateway example

Esempio di richiesta

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
}

Risposta di esempio

Codice di stato:: 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
}

Definizioni

Nome	Descrizione
CreateVirtualNetworkGatewayRequest
ErrorRelatedResource	Oggetto dettagli risorsa correlato all'errore.
ErrorResponse	Risposta di errore.
ErrorResponseDetails	Dettagli della risposta di errore.
GatewayType	Tipo del gateway. È possibile aggiungere altri tipi di gateway nel tempo.
LoadBalancingSetting	Impostazione di bilanciamento del carico del cluster gateway. È possibile aggiungere altre impostazioni di bilanciamento del carico nel tempo.
OnPremisesGateway
OnPremisesGatewayPersonal
PublicKey	Chiave pubblica del gateway locale.
VirtualNetworkAzureResource	Proprietà di una risorsa di Azure di rete virtuale
VirtualNetworkGateway

CreateVirtualNetworkGatewayRequest

Object

Nome	Tipo	Descrizione
capacityId	string (uuid)	ID oggetto della capacità della licenza fabric.
displayName	string	Nome visualizzato del gateway di rete virtuale. La lunghezza massima è di 200 caratteri.
inactivityMinutesBeforeSleep	integer	I minuti di inattività prima che il gateway di rete virtuale entri in sospensione automatica. Deve essere uno dei valori seguenti: 30, 60, 90, 120, 150, 240, 360, 480, 720, 1440.
numberOfMemberGateways	integer	Numero di gateway membro. Numero compreso tra 1 e 7.
type	string: VirtualNetwork	Tipo del gateway.
virtualNetworkAzureResource	VirtualNetworkAzureResource	Risorsa di rete virtuale di Azure.

ErrorRelatedResource

Object

Oggetto dettagli risorsa correlato all'errore.

Nome	Tipo	Descrizione
resourceId	string	ID risorsa coinvolto nell'errore.
resourceType	string	Tipo della risorsa coinvolta nell'errore.

ErrorResponse

Object

Risposta di errore.

Nome	Tipo	Descrizione
errorCode	string	Identificatore specifico che fornisce informazioni su una condizione di errore, consentendo la comunicazione standardizzata tra il servizio e i relativi utenti.
message	string	Rappresentazione leggibile dell'errore.
moreDetails	ErrorResponseDetails[]	Elenco di dettagli aggiuntivi sull'errore.
relatedResource	ErrorRelatedResource	Dettagli della risorsa correlati all'errore.
requestId	string	ID della richiesta associata all'errore.

ErrorResponseDetails

Object

Dettagli della risposta di errore.

Nome	Tipo	Descrizione
errorCode	string	Identificatore specifico che fornisce informazioni su una condizione di errore, consentendo la comunicazione standardizzata tra il servizio e i relativi utenti.
message	string	Rappresentazione leggibile dell'errore.
relatedResource	ErrorRelatedResource	Dettagli della risorsa correlati all'errore.

GatewayType

Enumerazione

Tipo del gateway. È possibile aggiungere altri tipi di gateway nel tempo.

Valore	Descrizione
OnPremises	Gateway locale.
OnPremisesPersonal	Gateway locale (modalità personale).
VirtualNetwork	Gateway di rete virtuale.

LoadBalancingSetting

Enumerazione

Impostazione di bilanciamento del carico del cluster gateway. È possibile aggiungere altre impostazioni di bilanciamento del carico nel tempo.

Valore	Descrizione
Failover	Le richieste verranno inviate al primo membro del cluster gateway disponibile.
DistributeEvenly	Le richieste verranno distribuite uniformemente tra tutti i membri del cluster gateway abilitati.

OnPremisesGateway

Object

Nome	Tipo	Descrizione
allowCloudConnectionRefresh	boolean	Indica se consentire l'aggiornamento delle connessioni cloud tramite questo gateway locale. True - Consenti, False - Non consentire.
allowCustomConnectors	boolean	Indica se consentire l'uso di connettori personalizzati con questo gateway locale. True - Consenti, False - Non consentire.
displayName	string	Nome visualizzato del gateway locale.
id	string (uuid)	ID oggetto del gateway.
loadBalancingSetting	LoadBalancingSetting	Impostazione di bilanciamento del carico del gateway locale.
numberOfMemberGateways	integer	Numero di membri del gateway nel gateway locale.
publicKey	PublicKey	Chiave pubblica del membro del gateway primario. Usato per crittografare le credenziali per la creazione e l'aggiornamento delle connessioni.
type	string: OnPremises	Tipo del gateway.
version	string	Versione del membro del gateway primario installato.

OnPremisesGatewayPersonal

Object

Nome	Tipo	Descrizione
id	string (uuid)	ID oggetto del gateway.
publicKey	PublicKey	Chiave pubblica del gateway. Usato per crittografare le credenziali per la creazione e l'aggiornamento delle connessioni.
type	string: OnPremisesPersonal	Tipo del gateway.
version	string	Versione del gateway.

PublicKey

Object

Chiave pubblica del gateway locale.

Nome	Tipo	Descrizione
exponent	string	Esponente della chiave pubblica.
modulus	string	Modulo della chiave pubblica.

VirtualNetworkAzureResource

Object

Proprietà di una risorsa di Azure di rete virtuale

Nome	Tipo	Descrizione
resourceGroupName	string	Nome del gruppo di risorse
subnetName	string	Nome della subnet
subscriptionId	string (uuid)	ID sottoscrizione
virtualNetworkName	string	Nome della rete virtuale

VirtualNetworkGateway

Object

Nome	Tipo	Descrizione
capacityId	string (uuid)	ID oggetto della capacità della licenza fabric.
displayName	string	Nome visualizzato del gateway di rete virtuale.
id	string (uuid)	ID oggetto del gateway.
inactivityMinutesBeforeSleep	integer	I minuti di inattività prima che il gateway di rete virtuale entri in sospensione automatica.
numberOfMemberGateways	integer	Numero di gateway membro.
type	string: VirtualNetwork	Tipo del gateway.
virtualNetworkAzureResource	VirtualNetworkAzureResource	Risorsa di rete virtuale di Azure.

Condividi tramite

Gateways - Create Gateway

Ambiti delegati obbligatori

Identità supportate da Microsoft Entra

Interfaccia

Corpo della richiesta

CreateVirtualNetworkGatewayRequest

Risposte

Esempio

Virtual network gateway example

Esempio di richiesta

Risposta di esempio

Definizioni

CreateVirtualNetworkGatewayRequest

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

GatewayType

LoadBalancingSetting

OnPremisesGateway

OnPremisesGatewayPersonal

PublicKey

VirtualNetworkAzureResource

VirtualNetworkGateway