Gateways - Update Gateway

Referencia

Szolgáltatás:: Core

API-verzió:: v1

Jegyzet

Ez az API előzetes verzióban érhető el.

Frissíti az átjárót azonosító szerint.

Engedélyek

A hívónak rendszergazdai engedéllyel kell rendelkeznie az átjáróhoz.

Kötelező delegált hatókörök

Gateway.ReadWrite.All

Microsoft Entra által támogatott identitások

Ez az API támogatja az ebben a szakaszban felsorolt Microsoft identitásokat.

Azonosság	Támogat
Felhasználó	Igen
szolgáltatásnév és felügyelt identitások	Igen

Interfész

PATCH https://api.fabric.microsoft.com/v1/gateways/{gatewayId}

URI-paraméterek

Name	In	Kötelező	Típus	Description
gatewayId	path	True	string uuid	Az átjáró azonosítója.

Kérelem törzse

A kérelem törzse az alábbiak valamelyike lehet:

Name	Description
UpdateOnPremisesGatewayRequest
UpdateVirtualNetworkGatewayRequest

UpdateOnPremisesGatewayRequest

Name	Kötelező	Típus	Description
type	True	string: OnPremises	Az átjáró típusa.
allowCloudConnectionRefresh		boolean	Engedélyezi-e a felhőkapcsolatok frissítését ezen a helyszíni átjárón keresztül. Igaz – Engedélyezés, Hamis – Nem engedélyezett.
allowCustomConnectors		boolean	Engedélyezi-e az egyéni összekötők használatát ezzel a helyszíni átjáróval. Igaz – Engedélyezés, Hamis – Nem engedélyezett.
displayName		string	Az átjáró neve. A maximális hossz 200 karakter.
loadBalancingSetting		LoadBalancingSetting	A helyszíni átjáró terheléselosztási beállítása.

UpdateVirtualNetworkGatewayRequest

Name	Kötelező	Típus	Description
type	True	string: VirtualNetwork	Az átjáró típusa.
capacityId		string uuid	A Háló licenckapacitás objektumazonosítója.
displayName		string	Az átjáró neve. A maximális hossz 200 karakter.
inactivityMinutesBeforeSleep		integer	A virtuális hálózati átjáró automatikus alvó állapotba helyezése előtti inaktivitási percek. A következő értékek egyikének kell lennie: 30, 60, 90, 120, 150, 240, 360, 480, 720, 1440.
numberOfMemberGateways		integer	A tagátjárók száma. 1 és 7 közötti szám.

Válaszok

Name	Típus	Description
200 OK	Gateway: OnPremisesGateway OnPremisesGatewayPersonal VirtualNetworkGateway	OKÉ. A művelet sikeres volt.
Other Status Codes	ErrorResponse	Gyakori hibakódok: UnknownError – Hiba történt.

Name

Típus

Description

200 OK

Gateway:

OnPremisesGateway
OnPremisesGatewayPersonal
VirtualNetworkGateway

OKÉ. A művelet sikeres volt.

Other Status Codes

ErrorResponse

Gyakori hibakódok:

UnknownError – Hiba történt.

Példák

On-premises gateway example

Virtual network gateway example

On-premises gateway example

Mintakérelem

HTTP

PATCH https://api.fabric.microsoft.com/v1/gateways/3d1290e1-e3ed-4bd6-93bc-2bbd5b49a789

{
  "type": "OnPremises",
  "displayName": "ContosoGatewayCluster1",
  "loadBalancingSetting": "Failover",
  "allowCloudConnectionRefresh": false,
  "allowCustomConnectors": false
}

Mintaválasz

Állapotkód:: 200

{
  "id": "3d1290e1-e3ed-4bd6-93bc-2bbd5b49a789",
  "type": "OnPremises",
  "displayName": "ContosoGatewayCluster1",
  "publicKey": {
    "exponent": "AQGB",
    "modulus": "od9b...90Jp1Q=="
  },
  "version": "3000.1.2",
  "numberOfMemberGateways": 2,
  "loadBalancingSetting": "Failover",
  "allowCloudConnectionRefresh": false,
  "allowCustomConnectors": false
}

Virtual network gateway example

Mintakérelem

HTTP

PATCH https://api.fabric.microsoft.com/v1/gateways/7015263e-885f-455b-80f7-bbf862899176

{
  "type": "VirtualNetwork",
  "capacityId": "7cf7181f-9457-4178-b488-e7472b02faf4",
  "displayName": "ContosoVirtualNetworkGateway1",
  "inactivityMinutesBeforeSleep": 720,
  "numberOfMemberGateways": 5
}

Mintaválasz

Állapotkód:: 200

{
  "id": "7015263e-885f-455b-80f7-bbf862899176",
  "type": "VirtualNetwork",
  "displayName": "ContosoVirtualNetworkGateway1",
  "capacityId": "7cf7181f-9457-4178-b488-e7472b02faf4",
  "virtualNetworkAzureResource": {
    "subscriptionId": "879b4ba0-ed17-4ff2-851e-4a2228e00b70",
    "resourceGroupName": "ContosoResourceGroup",
    "virtualNetworkName": "ContosoVirtualNetwork",
    "subnetName": "ContosoSubnet"
  },
  "inactivityMinutesBeforeSleep": 720,
  "numberOfMemberGateways": 5
}

Definíciók

Name	Description
ErrorRelatedResource	A hibával kapcsolatos erőforrás-részletek objektum.
ErrorResponse	A hibaválasz.
ErrorResponseDetails	A hibaválasz részletei.
GatewayType	Az átjáró típusa. Idővel további átjárótípusok is hozzáadhatók.
LoadBalancingSetting	Az átjárófürt terheléselosztási beállítása. Idővel további terheléselosztási beállítások is hozzáadhatók.
OnPremisesGateway
OnPremisesGatewayPersonal
PublicKey	A helyszíni átjáró nyilvános kulcsa.
UpdateOnPremisesGatewayRequest
UpdateVirtualNetworkGatewayRequest
VirtualNetworkAzureResource	Egy Virtuális hálózati Azure-erőforrás tulajdonságai
VirtualNetworkGateway

ErrorRelatedResource

Objektum

A hibával kapcsolatos erőforrás-részletek objektum.

Name	Típus	Description
resourceId	string	A hibában érintett erőforrás-azonosító.
resourceType	string	A hibában érintett erőforrás típusa.

ErrorResponse

Objektum

A hibaválasz.

Name	Típus	Description
errorCode	string	Egy adott azonosító, amely információt nyújt egy hibafeltételről, amely lehetővé teszi a szolgáltatás és a felhasználók közötti szabványosított kommunikációt.
message	string	A hiba emberi olvasható ábrázolása.
moreDetails	ErrorResponseDetails[]	További hibaadatok listája.
relatedResource	ErrorRelatedResource	A hibával kapcsolatos erőforrásadatok.
requestId	string	A hibához társított kérés azonosítója.

ErrorResponseDetails

Objektum

A hibaválasz részletei.

Name	Típus	Description
errorCode	string	Egy adott azonosító, amely információt nyújt egy hibafeltételről, amely lehetővé teszi a szolgáltatás és a felhasználók közötti szabványosított kommunikációt.
message	string	A hiba emberi olvasható ábrázolása.
relatedResource	ErrorRelatedResource	A hibával kapcsolatos erőforrásadatok.

GatewayType

Enumerálás

Az átjáró típusa. Idővel további átjárótípusok is hozzáadhatók.

Érték	Description
OnPremises	A helyszíni átjáró.
OnPremisesPersonal	A helyszíni átjáró (személyes mód).
VirtualNetwork	A virtuális hálózati átjáró.

LoadBalancingSetting

Enumerálás

Az átjárófürt terheléselosztási beállítása. Idővel további terheléselosztási beállítások is hozzáadhatók.

Érték	Description
DistributeEvenly	A kérelmek egyenletesen lesznek elosztva az összes engedélyezett átjárófürt-tag között.
Failover	A rendszer a kérelmeket az első elérhető átjárófürttagnak küldi el.

OnPremisesGateway

Objektum

Name	Típus	Description
allowCloudConnectionRefresh	boolean	Engedélyezi-e a felhőkapcsolatok frissítését ezen a helyszíni átjárón keresztül. Igaz – Engedélyezés, Hamis – Nem engedélyezett.
allowCustomConnectors	boolean	Engedélyezi-e az egyéni összekötők használatát ezzel a helyszíni átjáróval. Igaz – Engedélyezés, Hamis – Nem engedélyezett.
displayName	string	A helyszíni átjáró megjelenítendő neve.
id	string uuid	Az átjáró objektumazonosítója.
loadBalancingSetting	LoadBalancingSetting	A helyszíni átjáró terheléselosztási beállítása.
numberOfMemberGateways	integer	A helyszíni átjáró átjárótagjainak száma.
publicKey	PublicKey	Az elsődleges átjárótag nyilvános kulcsa. A kapcsolatok létrehozásához és frissítéséhez használt hitelesítő adatok titkosítására szolgál.
type	string: OnPremises	Az átjáró típusa.
version	string	A telepített elsődleges átjárótag verziója.

OnPremisesGatewayPersonal

Objektum

Name	Típus	Description
id	string uuid	Az átjáró objektumazonosítója.
publicKey	PublicKey	Az átjáró nyilvános kulcsa. A kapcsolatok létrehozásához és frissítéséhez használt hitelesítő adatok titkosítására szolgál.
type	string: OnPremisesPersonal	Az átjáró típusa.
version	string	Az átjáró verziója.

PublicKey

Objektum

A helyszíni átjáró nyilvános kulcsa.

Name	Típus	Description
exponent	string	A nyilvános kulcs kitevője.
modulus	string	A nyilvános kulcs modulusa.

UpdateOnPremisesGatewayRequest

Objektum

Name	Típus	Description
allowCloudConnectionRefresh	boolean	Engedélyezi-e a felhőkapcsolatok frissítését ezen a helyszíni átjárón keresztül. Igaz – Engedélyezés, Hamis – Nem engedélyezett.
allowCustomConnectors	boolean	Engedélyezi-e az egyéni összekötők használatát ezzel a helyszíni átjáróval. Igaz – Engedélyezés, Hamis – Nem engedélyezett.
displayName	string	Az átjáró neve. A maximális hossz 200 karakter.
loadBalancingSetting	LoadBalancingSetting	A helyszíni átjáró terheléselosztási beállítása.
type	string: OnPremises	Az átjáró típusa.

UpdateVirtualNetworkGatewayRequest

Objektum

Name	Típus	Description
capacityId	string uuid	A Háló licenckapacitás objektumazonosítója.
displayName	string	Az átjáró neve. A maximális hossz 200 karakter.
inactivityMinutesBeforeSleep	integer	A virtuális hálózati átjáró automatikus alvó állapotba helyezése előtti inaktivitási percek. A következő értékek egyikének kell lennie: 30, 60, 90, 120, 150, 240, 360, 480, 720, 1440.
numberOfMemberGateways	integer	A tagátjárók száma. 1 és 7 közötti szám.
type	string: VirtualNetwork	Az átjáró típusa.

VirtualNetworkAzureResource

Objektum

Egy Virtuális hálózati Azure-erőforrás tulajdonságai

Name	Típus	Description
resourceGroupName	string	Az erőforráscsoport neve
subnetName	string	Az alhálózat neve
subscriptionId	string uuid	Az előfizetés azonosítója
virtualNetworkName	string	A virtuális hálózat neve

VirtualNetworkGateway

Objektum

Name	Típus	Description
capacityId	string uuid	A Háló licenckapacitás objektumazonosítója.
displayName	string	A virtuális hálózati átjáró megjelenítendő neve.
id	string uuid	Az átjáró objektumazonosítója.
inactivityMinutesBeforeSleep	integer	A virtuális hálózati átjáró automatikus alvó állapotba helyezése előtti inaktivitási percek.
numberOfMemberGateways	integer	A tagátjárók száma.
type	string: VirtualNetwork	Az átjáró típusa.
virtualNetworkAzureResource	VirtualNetworkAzureResource	Az Azure-beli virtuális hálózati erőforrás.

Megosztás a következőn keresztül:

Gateways - Update Gateway

Engedélyek

Kötelező delegált hatókörök

Microsoft Entra által támogatott identitások

Interfész

URI-paraméterek

Kérelem törzse

UpdateOnPremisesGatewayRequest

UpdateVirtualNetworkGatewayRequest

Válaszok

Példák

On-premises gateway example

Mintakérelem

Mintaválasz

Virtual network gateway example

Mintakérelem

Mintaválasz

Definíciók

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

GatewayType

LoadBalancingSetting

OnPremisesGateway

OnPremisesGatewayPersonal

PublicKey

UpdateOnPremisesGatewayRequest

UpdateVirtualNetworkGatewayRequest

VirtualNetworkAzureResource

VirtualNetworkGateway

További források