Gateways - Create Gateway

Palvelu:

Core

Ohjelmointirajapinnan versio:

v1

Luo yhdyskäytävän.

Vaaditut delegoidut vaikutusalueet

Gateway.ReadWrite.All

Microsoft Entran tukemat käyttäjätiedot

Tämä ohjelmointirajapinta tukee tässä osiossa lueteltuja Microsoft -käyttäjätietoja.

Identiteetti	Tuki
Käyttäjä	Kyllä
palvelun päänimen ja Hallittujen käyttäjätietojen	Kyllä

Rajapinta

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

Pyynnön leipäteksti

CreateVirtualNetworkGatewayRequest

Nimi	Pakollinen	Tyyppi	Description
capacityId	True	string (uuid)	Fabric-käyttöoikeuskapasiteetin objektitunnus.
displayName	True	string	Näennäisverkkoyhdyskäytävän näyttönimi. Enimmäispituus on 200 merkkiä.
inactivityMinutesBeforeSleep	True	integer	Toimettomuus minuutteina, ennen kuin näennäisverkkoyhdyskäytävä siirtyvät automaattisesti lepotilaan. On oltava jokin seuraavista arvoista: 30, 60, 90, 120, 150, 240, 360, 480, 720, 1440.
numberOfMemberGateways	True	integer	Jäsenyhdyskäytävien määrä. Luku väliltä 1–7.
type	True	string: VirtualNetwork	Yhdyskäytävän tyyppi.
virtualNetworkAzureResource	True	VirtualNetworkAzureResource	Azure-näennäisverkkoresurssi.

Vastaukset

Nimi	Tyyppi	Description
201 Created	Gateway: OnPremisesGateway OnPremisesGatewayPersonal VirtualNetworkGateway	Luotu. Toiminto onnistui.
429 Too Many Requests	ErrorResponse	Palveluhinnan raja ylitettiin. Palvelin palauttaa otsikon, joka Retry-After ilmaisee sekunteina, kuinka kauan asiakkaan on odotettava, ennen kuin lisäpyynnöt lähetetään. Otsikot Retry-After: integer
Other Status Codes	ErrorResponse	Yleiset virhekoodit: DuplicateGatewayName – Yhdyskäytävän nimi on jo käytössä. InvalidCapacityState – Kapasiteetin tila on virheellinen. InvalidCapacitySKU – Kapasiteetin SKU on virheellinen. PowerPlatformVirtualNetworkSubnetNotConfiguredForDelegation – Power Platform -näennäisverkkoa ei ole määritetty delegointia varten.

Esimerkit

Virtual network gateway example

Mallipyyntö

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
}

Mallivastaus

Tilakoodi:

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
}

Määritelmät

Nimi	Description
CreateVirtualNetworkGatewayRequest
ErrorRelatedResource	Virheeseen liittyvä resurssitieto-objekti.
ErrorResponse	Virhevastaus.
ErrorResponseDetails	Virheen vastauksen tiedot.
GatewayType	Yhdyskäytävän tyyppi. Muita yhdyskäytävätyyppejä voidaan lisätä ajan mittaan.
LoadBalancingSetting	Yhdyskäytäväklusterin kuormituksen tasauksen asetus. Lisää kuormituksen tasauksen asetuksia voidaan lisätä ajan mittaan.
OnPremisesGateway
OnPremisesGatewayPersonal
PublicKey	Paikallisen yhdyskäytävän julkinen avain.
VirtualNetworkAzureResource	Azure-näennäisverkkoresurssin ominaisuudet
VirtualNetworkGateway

CreateVirtualNetworkGatewayRequest

Kohde

Nimi	Tyyppi	Description
capacityId	string (uuid)	Fabric-käyttöoikeuskapasiteetin objektitunnus.
displayName	string	Näennäisverkkoyhdyskäytävän näyttönimi. Enimmäispituus on 200 merkkiä.
inactivityMinutesBeforeSleep	integer	Toimettomuus minuutteina, ennen kuin näennäisverkkoyhdyskäytävä siirtyvät automaattisesti lepotilaan. On oltava jokin seuraavista arvoista: 30, 60, 90, 120, 150, 240, 360, 480, 720, 1440.
numberOfMemberGateways	integer	Jäsenyhdyskäytävien määrä. Luku väliltä 1–7.
type	string: VirtualNetwork	Yhdyskäytävän tyyppi.
virtualNetworkAzureResource	VirtualNetworkAzureResource	Azure-näennäisverkkoresurssi.

ErrorRelatedResource

Kohde

Virheeseen liittyvä resurssitieto-objekti.

Nimi	Tyyppi	Description
resourceId	string	Virheestä liittyvä resurssitunnus.
resourceType	string	Virheestä liittyvän resurssin tyyppi.

ErrorResponse

Kohde

Virhevastaus.

Nimi	Tyyppi	Description
errorCode	string	Tietty tunniste, joka antaa tietoja virheehdosta ja mahdollistaa standardoidun tietoliikenteen palvelumme ja sen käyttäjien välillä.
message	string	Ihmisen luettavissa oleva esitys virheestä.
moreDetails	ErrorResponseDetails[]	Luettelo virheiden lisätiedoista.
relatedResource	ErrorRelatedResource	Virheisiin liittyvät resurssitiedot.
requestId	string (uuid)	Virheeseen liittyvän pyynnön tunnus.

ErrorResponseDetails

Kohde

Virheen vastauksen tiedot.

Nimi	Tyyppi	Description
errorCode	string	Tietty tunniste, joka antaa tietoja virheehdosta ja mahdollistaa standardoidun tietoliikenteen palvelumme ja sen käyttäjien välillä.
message	string	Ihmisen luettavissa oleva esitys virheestä.
relatedResource	ErrorRelatedResource	Virheisiin liittyvät resurssitiedot.

GatewayType

Luettelointi

Yhdyskäytävän tyyppi. Muita yhdyskäytävätyyppejä voidaan lisätä ajan mittaan.

Arvo	Description
OnPremises	Paikallinen yhdyskäytävä.
OnPremisesPersonal	Paikallinen yhdyskäytävä (henkilökohtainen tila).
VirtualNetwork	Näennäisverkkoyhdyskäytävä.

LoadBalancingSetting

Luettelointi

Yhdyskäytäväklusterin kuormituksen tasauksen asetus. Lisää kuormituksen tasauksen asetuksia voidaan lisätä ajan mittaan.

Arvo	Description
Failover	Pyynnöt lähetetään ensimmäiselle käytettävissä olevalle yhdyskäytäväklusterin jäsenille.
DistributeEvenly	Pyynnöt jaetaan tasaisesti kaikkien käytössä olevan yhdyskäytäväklusterin jäsenten kesken.

OnPremisesGateway

Kohde

Nimi	Tyyppi	Description
allowCloudConnectionRefresh	boolean	Sallitaanko pilviyhteyksien päivittäminen tämän paikallisen yhdyskäytävän kautta? True – Salli, Epätosi – Älä salli.
allowCustomConnectors	boolean	Sallitaanko mukautettujen liittimien käyttö tämän paikallisen yhdyskäytävän kanssa? True – Salli, Epätosi – Älä salli.
displayName	string	Paikallisen yhdyskäytävän näyttönimi.
id	string (uuid)	Yhdyskäytävän objektitunnus.
loadBalancingSetting	LoadBalancingSetting	Paikallisen yhdyskäytävän kuormituksen tasauksen asetus.
numberOfMemberGateways	integer	Paikallisen yhdyskäytävän yhdyskäytävän jäsenten määrä.
publicKey	PublicKey	Ensisijaisen yhdyskäytäväjäsenen julkinen avain. Käytetään yhteyksien luomisen ja päivittämisen tunnistetietojen salaamiseen.
type	string: OnPremises	Yhdyskäytävän tyyppi.
version	string	Asennetun ensisijaisen yhdyskäytävän jäsenen versio.

OnPremisesGatewayPersonal

Kohde

Nimi	Tyyppi	Description
id	string (uuid)	Yhdyskäytävän objektitunnus.
publicKey	PublicKey	Yhdyskäytävän julkinen avain. Käytetään yhteyksien luomisen ja päivittämisen tunnistetietojen salaamiseen.
type	string: OnPremisesPersonal	Yhdyskäytävän tyyppi.
version	string	Yhdyskäytävän versio.

PublicKey

Kohde

Paikallisen yhdyskäytävän julkinen avain.

Nimi	Tyyppi	Description
exponent	string	Julkisen avaimen eksponentti.
modulus	string	Julkisen avaimen modulus.

VirtualNetworkAzureResource

Kohde

Azure-näennäisverkkoresurssin ominaisuudet

Nimi	Tyyppi	Description
resourceGroupName	string	Resurssiryhmän nimi
subnetName	string	Aliverkon nimi
subscriptionId	string (uuid)	Tilaustunnus
virtualNetworkName	string	Näennäisverkon nimi

VirtualNetworkGateway

Kohde

Nimi	Tyyppi	Description
capacityId	string (uuid)	Fabric-käyttöoikeuskapasiteetin objektitunnus.
displayName	string	Näennäisverkkoyhdyskäytävän näyttönimi.
id	string (uuid)	Yhdyskäytävän objektitunnus.
inactivityMinutesBeforeSleep	integer	Toimettomuus minuutteina, ennen kuin näennäisverkkoyhdyskäytävä siirtyvät automaattisesti lepotilaan.
numberOfMemberGateways	integer	Jäsenyhdyskäytävien määrä.
type	string: VirtualNetwork	Yhdyskäytävän tyyppi.
virtualNetworkAzureResource	VirtualNetworkAzureResource	Azure-näennäisverkkoresurssi.