Gateways - Create Gateway

Tjänst:: Core

API-versionen:: v1

Skapar en gateway.

Obligatoriska delegerade omfång

Gateway.ReadWrite.All

Identiteter som stöds av Microsoft Entra

Det här API:et stöder Microsoft identiteter som anges i det här avsnittet.

Identitet	Stöd
Användare	Ja
Tjänstens huvudnamn och hanterade identiteter	Ja

Gränssnitt

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

Begäranarorgan

CreateVirtualNetworkGatewayRequest

Namn	Krävs	Typ	Beskrivning
capacityId	True	string (uuid)	Objekt-ID:t för fabric-licenskapaciteten.
displayName	True	string	Visningsnamnet för den virtuella nätverksgatewayen. Maximal längd är 200 tecken.
inactivityMinutesBeforeSleep	True	integer	Minuter av inaktivitet innan den virtuella nätverksgatewayen försätts i automatisk viloläge. Måste vara något av följande värden: 30, 60, 90, 120, 150, 240, 360, 480, 720, 1440.
numberOfMemberGateways	True	integer	Antalet medlemsgatewayer. Ett tal mellan 1 och 7.
type	True	string: VirtualNetwork	Typ av gateway.
virtualNetworkAzureResource	True	VirtualNetworkAzureResource	Den virtuella Azure-nätverksresursen.

Svaren

Namn Typ Beskrivning

201 Created

Namn	Typ	Beskrivning
201 Created	Gateway: OnPremisesGateway OnPremisesGatewayPersonal VirtualNetworkGateway	Skapad. Åtgärden lyckades.
429 Too Many Requests	ErrorResponse	Gränsen för tjänstfrekvens överskreds. Servern returnerar ett `Retry-After` huvud som anger i sekunder hur länge klienten måste vänta innan ytterligare begäranden skickas. Headers Retry-After: integer
Other Status Codes	ErrorResponse	Vanliga felkoder: DuplicateGatewayName – gatewaynamnet används redan. InvalidCapacityState – Kapacitetens tillstånd är ogiltigt. InvalidCapacitySKU – Kapacitetens SKU är ogiltig. PowerPlatformVirtualNetworkSubnetNotConfiguredForDelegation – Det virtuella Power Platform-nätverket har inte konfigurerats för delegering.

Gateway:

OnPremisesGateway
OnPremisesGatewayPersonal
VirtualNetworkGateway

Skapad. Åtgärden lyckades.

429 Too Many Requests

ErrorResponse

Gränsen för tjänstfrekvens överskreds. Servern returnerar ett Retry-After huvud som anger i sekunder hur länge klienten måste vänta innan ytterligare begäranden skickas.

Headers

Retry-After: integer

Other Status Codes

ErrorResponse

Vanliga felkoder:

DuplicateGatewayName – gatewaynamnet används redan.
InvalidCapacityState – Kapacitetens tillstånd är ogiltigt.
InvalidCapacitySKU – Kapacitetens SKU är ogiltig.
PowerPlatformVirtualNetworkSubnetNotConfiguredForDelegation – Det virtuella Power Platform-nätverket har inte konfigurerats för delegering.

Exempel

Virtual network gateway example

Exempelförfrågan

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
}

Exempelsvar

Statuskod:: 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
}

Definitioner

Namn	Beskrivning
CreateVirtualNetworkGatewayRequest
ErrorRelatedResource	Det felrelaterade resursinformationsobjektet.
ErrorResponse	Felsvaret.
ErrorResponseDetails	Information om felsvar.
GatewayType	Typ av gateway. Ytterligare gatewaytyper kan läggas till över tid.
LoadBalancingSetting	Inställningen för belastningsutjämning för gatewayklustret. Ytterligare inställningar för belastningsutjämning kan läggas till över tid.
OnPremisesGateway
OnPremisesGatewayPersonal
PublicKey	Den offentliga nyckeln för den lokala gatewayen.
VirtualNetworkAzureResource	Egenskaperna för en Azure-resurs för virtuellt nätverk
VirtualNetworkGateway

CreateVirtualNetworkGatewayRequest

Objekt

Namn	Typ	Beskrivning
capacityId	string (uuid)	Objekt-ID:t för fabric-licenskapaciteten.
displayName	string	Visningsnamnet för den virtuella nätverksgatewayen. Maximal längd är 200 tecken.
inactivityMinutesBeforeSleep	integer	Minuter av inaktivitet innan den virtuella nätverksgatewayen försätts i automatisk viloläge. Måste vara något av följande värden: 30, 60, 90, 120, 150, 240, 360, 480, 720, 1440.
numberOfMemberGateways	integer	Antalet medlemsgatewayer. Ett tal mellan 1 och 7.
type	string: VirtualNetwork	Typ av gateway.
virtualNetworkAzureResource	VirtualNetworkAzureResource	Den virtuella Azure-nätverksresursen.

ErrorRelatedResource

Objekt

Det felrelaterade resursinformationsobjektet.

Namn	Typ	Beskrivning
resourceId	string	Det resurs-ID som ingår i felet.
resourceType	string	Typen av resurs som är inblandad i felet.

ErrorResponse

Objekt

Felsvaret.

Namn	Typ	Beskrivning
errorCode	string	En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare.
message	string	En mänsklig läsbar representation av felet.
moreDetails	ErrorResponseDetails[]	Lista över ytterligare felinformation.
relatedResource	ErrorRelatedResource	Felrelaterad resursinformation.
requestId	string (uuid)	ID för den begäran som är associerad med felet.

ErrorResponseDetails

Objekt

Information om felsvar.

Namn	Typ	Beskrivning
errorCode	string	En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare.
message	string	En mänsklig läsbar representation av felet.
relatedResource	ErrorRelatedResource	Felrelaterad resursinformation.

GatewayType

Uppräkning

Typ av gateway. Ytterligare gatewaytyper kan läggas till över tid.

Värde	Beskrivning
OnPremises	Den lokala gatewayen.
OnPremisesPersonal	Den lokala gatewayen (personligt läge).
VirtualNetwork	Den virtuella nätverksgatewayen.

LoadBalancingSetting

Uppräkning

Inställningen för belastningsutjämning för gatewayklustret. Ytterligare inställningar för belastningsutjämning kan läggas till över tid.

Värde	Beskrivning
Failover	Begäranden skickas till den första tillgängliga gatewayklustermedlemmen.
DistributeEvenly	Begäranden fördelas jämnt mellan alla aktiverade gatewayklustermedlemmar.

OnPremisesGateway

Objekt

Namn	Typ	Beskrivning
allowCloudConnectionRefresh	boolean	Om du vill tillåta att molnanslutningar uppdateras via den här lokala gatewayen. Sant – Tillåt, Falskt – Tillåt inte.
allowCustomConnectors	boolean	Om du vill tillåta att anpassade anslutningsappar används med den här lokala gatewayen. Sant – Tillåt, Falskt – Tillåt inte.
displayName	string	Visningsnamnet för den lokala gatewayen.
id	string (uuid)	Gatewayens objekt-ID.
loadBalancingSetting	LoadBalancingSetting	Inställningen för belastningsutjämning för den lokala gatewayen.
numberOfMemberGateways	integer	Antalet gatewaymedlemmar i den lokala gatewayen.
publicKey	PublicKey	Den offentliga nyckeln för den primära gatewaymedlemmen. Används för att kryptera autentiseringsuppgifterna för att skapa och uppdatera anslutningar.
type	string: OnPremises	Typ av gateway.
version	string	Versionen av den installerade primära gatewaymedlemmen.

OnPremisesGatewayPersonal

Objekt

Namn	Typ	Beskrivning
id	string (uuid)	Gatewayens objekt-ID.
publicKey	PublicKey	Gatewayens offentliga nyckel. Används för att kryptera autentiseringsuppgifterna för att skapa och uppdatera anslutningar.
type	string: OnPremisesPersonal	Typ av gateway.
version	string	Versionen av gatewayen.

PublicKey

Objekt

Den offentliga nyckeln för den lokala gatewayen.

Namn	Typ	Beskrivning
exponent	string	Exponenten för den offentliga nyckeln.
modulus	string	Modulus för den offentliga nyckeln.

VirtualNetworkAzureResource

Objekt

Egenskaperna för en Azure-resurs för virtuellt nätverk

Namn	Typ	Beskrivning
resourceGroupName	string	Namnet på resursgruppen
subnetName	string	Namnet på undernätet
subscriptionId	string (uuid)	Prenumerations-ID
virtualNetworkName	string	Namnet på det virtuella nätverket

VirtualNetworkGateway

Objekt

Namn	Typ	Beskrivning
capacityId	string (uuid)	Objekt-ID:t för fabric-licenskapaciteten.
displayName	string	Visningsnamnet för den virtuella nätverksgatewayen.
id	string (uuid)	Gatewayens objekt-ID.
inactivityMinutesBeforeSleep	integer	Minuter av inaktivitet innan den virtuella nätverksgatewayen försätts i automatisk viloläge.
numberOfMemberGateways	integer	Antalet medlemsgatewayer.
type	string: VirtualNetwork	Typ av gateway.
virtualNetworkAzureResource	VirtualNetworkAzureResource	Den virtuella Azure-nätverksresursen.

Dela via

Gateways - Create Gateway

Obligatoriska delegerade omfång

Identiteter som stöds av Microsoft Entra

Gränssnitt

Begäranarorgan

CreateVirtualNetworkGatewayRequest

Svaren

Exempel

Virtual network gateway example

Exempelförfrågan

Exempelsvar

Definitioner

CreateVirtualNetworkGatewayRequest

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

GatewayType

LoadBalancingSetting

OnPremisesGateway

OnPremisesGatewayPersonal

PublicKey

VirtualNetworkAzureResource

VirtualNetworkGateway