Gateways - List Gateways

Service:

Core

API-versie:

v1

Notitie

Deze API is in preview.

Retourneert een lijst met alle gateways waarvoor de gebruiker machtigingen heeft, waaronder on-premises, on-premises (persoonlijke modus) en virtuele netwerkgateways.

Machtigingen

De aanroeper moet machtigingen hebben voor de gateway.

Vereiste gedelegeerde bereiken

Gateway.Read.All of Gateway.ReadWrite.All

Door Microsoft Entra ondersteunde identiteiten

Deze API ondersteunt de Microsoft -identiteiten vermeld in deze sectie.

Identiteit	Steunen
Gebruiker	Ja
service-principal en beheerde identiteiten	Ja

Interface

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

Met optionele parameters:

GET https://api.fabric.microsoft.com/v1/gateways?continuationToken={continuationToken}

URI-parameters

Name	In	Vereist	Type	Description
continuationToken	query		string	Een token voor het ophalen van de volgende pagina met resultaten.

Antwoorden

Name	Type	Description
200 OK	ListGatewaysResponse	OK. De bewerking is geslaagd.
Other Status Codes	ErrorResponse	Veelvoorkomende foutcodes: UnknownError: er is een fout opgetreden.

Voorbeelden

Example

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

Statuscode:

200

{
  "value": [
    {
      "id": "8e41c4dd-a382-4937-9bf3-695ab881f7c2",
      "type": "OnPremises",
      "displayName": "ContosoOnPremisesGateway",
      "publicKey": {
        "exponent": "AQGB",
        "modulus": "od9b...90Jp1Q=="
      },
      "version": "3000.1.1",
      "numberOfMemberGateways": 2,
      "loadBalancingSetting": "DistributeEvenly",
      "allowCloudConnectionRefresh": true,
      "allowCustomConnectors": true
    },
    {
      "id": "ca8979ff-4238-4489-ad13-2e1bd69a8412",
      "type": "OnPremisesPersonal",
      "publicKey": {
        "exponent": "AQOV",
        "modulus": "pt9b...87Jp1Q=="
      },
      "version": "3000.1.1"
    },
    {
      "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": 1440,
      "numberOfMemberGateways": 3
    }
  ],
  "continuationToken": "LDEsMTAwMDAwLDA%3D",
  "continuationUri": "https://api.fabric.microsoft.com/v1/connections?continuationToken=LDEsMTAwMDAwLDA%3D"
}

Definities

Name	Description
ErrorRelatedResource	Het foutgerelateerde resourcedetailsobject.
ErrorResponse	Het foutbericht.
ErrorResponseDetails	De details van het foutbericht.
GatewayType	Het type gateway. Er kunnen in de loop van de tijd extra gatewaytypen worden toegevoegd.
ListGatewaysResponse
LoadBalancingSetting	De taakverdelingsinstelling van het gatewaycluster. Er kunnen na verloop van tijd extra taakverdelingsinstellingen worden toegevoegd.
OnPremisesGateway
OnPremisesGatewayPersonal
PublicKey	De openbare sleutel van de on-premises gateway.
VirtualNetworkAzureResource	De eigenschappen van een Azure-resource voor een virtueel netwerk
VirtualNetworkGateway

ErrorRelatedResource

Object

Het foutgerelateerde resourcedetailsobject.

Name	Type	Description
resourceId	string	De resource-id die betrokken is bij de fout.
resourceType	string	Het type resource dat betrokken is bij de fout.

ErrorResponse

Object

Het foutbericht.

Name	Type	Description
errorCode	string	Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
message	string	Een leesbare weergave van de fout.
moreDetails	ErrorResponseDetails[]	Lijst met aanvullende foutdetails.
relatedResource	ErrorRelatedResource	De foutgerelateerde resourcedetails.
requestId	string	Id van de aanvraag die is gekoppeld aan de fout.

ErrorResponseDetails

Object

De details van het foutbericht.

Name	Type	Description
errorCode	string	Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
message	string	Een leesbare weergave van de fout.
relatedResource	ErrorRelatedResource	De foutgerelateerde resourcedetails.

GatewayType

Inventarisatie

Het type gateway. Er kunnen in de loop van de tijd extra gatewaytypen worden toegevoegd.

Waarde	Description
OnPremises	De on-premises gateway.
OnPremisesPersonal	De on-premises gateway (persoonlijke modus).
VirtualNetwork	De gateway van het virtuele netwerk.

ListGatewaysResponse

Object

Name	Type	Description
continuationToken	string	Het token voor de volgende batch met resultatensets. Als er geen records meer zijn, wordt deze verwijderd uit het antwoord.
continuationUri	string	De URI van de volgende batch met resultatensets. Als er geen records meer zijn, wordt deze verwijderd uit het antwoord.
value	Gateway[]: OnPremisesGateway[] OnPremisesGatewayPersonal[] VirtualNetworkGateway[]	Een lijst met geretourneerde gateways.

LoadBalancingSetting

Inventarisatie

De taakverdelingsinstelling van het gatewaycluster. Er kunnen na verloop van tijd extra taakverdelingsinstellingen worden toegevoegd.

Waarde	Description
DistributeEvenly	Aanvragen worden gelijkmatig verdeeld over alle ingeschakelde gatewayclusterleden.
Failover	Aanvragen worden verzonden naar het eerste beschikbare gatewayclusterlid.

OnPremisesGateway

Object

Name	Type	Description
allowCloudConnectionRefresh	boolean	Of cloudverbindingen via deze on-premises gateway moeten worden vernieuwd. True - Toestaan, Onwaar - Niet toestaan.
allowCustomConnectors	boolean	Of aangepaste connectors mogen worden gebruikt met deze on-premises gateway. True - Toestaan, Onwaar - Niet toestaan.
displayName	string	De weergavenaam van de on-premises gateway.
id	string uuid	De object-id van de gateway.
loadBalancingSetting	LoadBalancingSetting	De taakverdelingsinstelling van de on-premises gateway.
numberOfMemberGateways	integer	Het aantal gatewayleden in de on-premises gateway.
publicKey	PublicKey	De openbare sleutel van het primaire gatewaylid. Wordt gebruikt voor het versleutelen van de referenties voor het maken en bijwerken van verbindingen.
type	string: OnPremises	Het type gateway.
version	string	De versie van het geïnstalleerde primaire gatewaylid.

OnPremisesGatewayPersonal

Object

Name	Type	Description
id	string uuid	De object-id van de gateway.
publicKey	PublicKey	De openbare sleutel van de gateway. Wordt gebruikt voor het versleutelen van de referenties voor het maken en bijwerken van verbindingen.
type	string: OnPremisesPersonal	Het type gateway.
version	string	De versie van de gateway.

PublicKey

Object

De openbare sleutel van de on-premises gateway.

Name	Type	Description
exponent	string	De exponent van de openbare sleutel.
modulus	string	De modulus van de openbare sleutel.

VirtualNetworkAzureResource

Object

De eigenschappen van een Azure-resource voor een virtueel netwerk

Name	Type	Description
resourceGroupName	string	De naam van de resourcegroep
subnetName	string	De naam van het subnet
subscriptionId	string uuid	De abonnements-id
virtualNetworkName	string	De naam van het virtuele netwerk

VirtualNetworkGateway

Object

Name	Type	Description
capacityId	string uuid	De object-id van de fabric-licentiecapaciteit.
displayName	string	De weergavenaam van de gateway van het virtuele netwerk.
id	string uuid	De object-id van de gateway.
inactivityMinutesBeforeSleep	integer	De minuten van inactiviteit voordat de gateway van het virtuele netwerk in de automatische slaapstand wordt gezet.
numberOfMemberGateways	integer	Het aantal lidgateways.
type	string: VirtualNetwork	Het type gateway.
virtualNetworkAzureResource	VirtualNetworkAzureResource	De virtuele Azure-netwerkresource.