Gateways - Create Gateway

Référence

Service:: Core

Version d'API:: v1

Note

Cette API est en préversion.

Crée une passerelle.

Étendues déléguées requises

Gateway.ReadWrite.All

Identités prises en charge par Microsoft Entra

Cette API prend en charge les identités Microsoft répertoriées dans cette section.

Identité	Soutien
Utilisateur	Oui
principal de service et identités managées	Oui

Interface

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

Corps de la demande

CreateVirtualNetworkGatewayRequest

Nom	Obligatoire	Type	Description
capacityId	True	string uuid	ID d’objet de la capacité de licence Fabric.
displayName	True	string	Nom complet de la passerelle de réseau virtuel. La longueur maximale est de 200 caractères.
inactivityMinutesBeforeSleep	True	integer	Minutes d’inactivité avant la mise en veille automatique de la passerelle de réseau virtuel. Doit être l’une des valeurs suivantes : 30, 60, 90, 120, 150, 240, 360, 480, 720, 1440.
numberOfMemberGateways	True	integer	Nombre de passerelles membres. Nombre compris entre 1 et 7.
type	True	string: VirtualNetwork	Type de la passerelle.
virtualNetworkAzureResource	True	VirtualNetworkAzureResource	Ressource de réseau virtuel Azure.

Réponses

Nom	Type	Description
201 Created	Gateway: OnPremisesGateway OnPremisesGatewayPersonal VirtualNetworkGateway	Créé. L’opération a réussi.
Other Status Codes	ErrorResponse	Codes d’erreur courants : DuplicateGatewayName : le nom de la passerelle est déjà utilisé. InvalidCapacityState : l’état de la capacité n’est pas valide. InvalidCapacitySKU : la référence SKU de la capacité n’est pas valide. PowerPlatformVirtualNetworkSubnetNotConfiguredForDelegation : le réseau virtuel Power Platform n’est pas configuré pour la délégation.

Nom

Type

Description

201 Created

Gateway:

OnPremisesGateway
OnPremisesGatewayPersonal
VirtualNetworkGateway

Créé. L’opération a réussi.

Other Status Codes

ErrorResponse

Codes d’erreur courants :

DuplicateGatewayName : le nom de la passerelle est déjà utilisé.
InvalidCapacityState : l’état de la capacité n’est pas valide.
InvalidCapacitySKU : la référence SKU de la capacité n’est pas valide.
PowerPlatformVirtualNetworkSubnetNotConfiguredForDelegation : le réseau virtuel Power Platform n’est pas configuré pour la délégation.

Exemples

Virtual network gateway example

Exemple de requête

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
}

Exemple de réponse

Code d’état:: 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
}

Définitions

Nom	Description
CreateVirtualNetworkGatewayRequest
ErrorRelatedResource	Objet de détails de ressource associé à l’erreur.
ErrorResponse	Réponse d’erreur.
ErrorResponseDetails	Détails de la réponse d’erreur.
GatewayType	Type de la passerelle. Des types de passerelle supplémentaires peuvent être ajoutés au fil du temps.
LoadBalancingSetting	Paramètre d’équilibrage de charge du cluster de passerelle. Des paramètres d’équilibrage de charge supplémentaires peuvent être ajoutés au fil du temps.
OnPremisesGateway
OnPremisesGatewayPersonal
PublicKey	Clé publique de la passerelle locale.
VirtualNetworkAzureResource	Propriétés d’une ressource Azure de réseau virtuel
VirtualNetworkGateway

CreateVirtualNetworkGatewayRequest

Object

Nom	Type	Description
capacityId	string uuid	ID d’objet de la capacité de licence Fabric.
displayName	string	Nom complet de la passerelle de réseau virtuel. La longueur maximale est de 200 caractères.
inactivityMinutesBeforeSleep	integer	Minutes d’inactivité avant la mise en veille automatique de la passerelle de réseau virtuel. Doit être l’une des valeurs suivantes : 30, 60, 90, 120, 150, 240, 360, 480, 720, 1440.
numberOfMemberGateways	integer	Nombre de passerelles membres. Nombre compris entre 1 et 7.
type	string: VirtualNetwork	Type de la passerelle.
virtualNetworkAzureResource	VirtualNetworkAzureResource	Ressource de réseau virtuel Azure.

ErrorRelatedResource

Object

Objet de détails de ressource associé à l’erreur.

Nom	Type	Description
resourceId	string	ID de ressource impliqué dans l’erreur.
resourceType	string	Type de la ressource impliquée dans l’erreur.

ErrorResponse

Object

Réponse d’erreur.

Nom	Type	Description
errorCode	string	Identificateur spécifique qui fournit des informations sur une condition d’erreur, ce qui permet une communication standardisée entre notre service et ses utilisateurs.
message	string	Représentation lisible humaine de l’erreur.
moreDetails	ErrorResponseDetails[]	Liste des détails d’erreur supplémentaires.
relatedResource	ErrorRelatedResource	Détails de la ressource associée à l’erreur.
requestId	string	ID de la demande associée à l’erreur.

ErrorResponseDetails

Object

Détails de la réponse d’erreur.

Nom	Type	Description
errorCode	string	Identificateur spécifique qui fournit des informations sur une condition d’erreur, ce qui permet une communication standardisée entre notre service et ses utilisateurs.
message	string	Représentation lisible humaine de l’erreur.
relatedResource	ErrorRelatedResource	Détails de la ressource associée à l’erreur.

GatewayType

Énumération

Type de la passerelle. Des types de passerelle supplémentaires peuvent être ajoutés au fil du temps.

Valeur	Description
OnPremises	Passerelle locale.
OnPremisesPersonal	Passerelle locale (mode personnel).
VirtualNetwork	Passerelle de réseau virtuel.

LoadBalancingSetting

Énumération

Paramètre d’équilibrage de charge du cluster de passerelle. Des paramètres d’équilibrage de charge supplémentaires peuvent être ajoutés au fil du temps.

Valeur	Description
DistributeEvenly	Les demandes seront distribuées uniformément entre tous les membres du cluster de passerelle activés.
Failover	Les demandes seront envoyées au premier membre de cluster de passerelle disponible.

OnPremisesGateway

Object

Nom	Type	Description
allowCloudConnectionRefresh	boolean	Indique s’il faut autoriser l’actualisation des connexions cloud via cette passerelle locale. True - Autoriser, False - Ne pas autoriser.
allowCustomConnectors	boolean	Indique s’il faut autoriser l’utilisation de connecteurs personnalisés avec cette passerelle locale. True - Autoriser, False - Ne pas autoriser.
displayName	string	Nom complet de la passerelle locale.
id	string uuid	ID d’objet de la passerelle.
loadBalancingSetting	LoadBalancingSetting	Paramètre d’équilibrage de charge de la passerelle locale.
numberOfMemberGateways	integer	Nombre de membres de passerelle dans la passerelle locale.
publicKey	PublicKey	Clé publique du membre de passerelle primaire. Utilisé pour chiffrer les informations d’identification pour la création et la mise à jour des connexions.
type	string: OnPremises	Type de la passerelle.
version	string	Version du membre de passerelle principal installé.

OnPremisesGatewayPersonal

Object

Nom	Type	Description
id	string uuid	ID d’objet de la passerelle.
publicKey	PublicKey	Clé publique de la passerelle. Utilisé pour chiffrer les informations d’identification pour la création et la mise à jour des connexions.
type	string: OnPremisesPersonal	Type de la passerelle.
version	string	Version de la passerelle.

PublicKey

Object

Clé publique de la passerelle locale.

Nom	Type	Description
exponent	string	Exposant de la clé publique.
modulus	string	Module de la clé publique.

VirtualNetworkAzureResource

Object

Propriétés d’une ressource Azure de réseau virtuel

Nom	Type	Description
resourceGroupName	string	Nom du groupe de ressources
subnetName	string	Nom du sous-réseau
subscriptionId	string uuid	ID d’abonnement
virtualNetworkName	string	Nom du réseau virtuel

VirtualNetworkGateway

Object

Nom	Type	Description
capacityId	string uuid	ID d’objet de la capacité de licence Fabric.
displayName	string	Nom complet de la passerelle de réseau virtuel.
id	string uuid	ID d’objet de la passerelle.
inactivityMinutesBeforeSleep	integer	Minutes d’inactivité avant la mise en veille automatique de la passerelle de réseau virtuel.
numberOfMemberGateways	integer	Nombre de passerelles membres.
type	string: VirtualNetwork	Type de la passerelle.
virtualNetworkAzureResource	VirtualNetworkAzureResource	Ressource de réseau virtuel Azure.

Partager via

Gateways - Create Gateway

Étendues déléguées requises

Identités prises en charge par Microsoft Entra

Interface

Corps de la demande

CreateVirtualNetworkGatewayRequest

Réponses

Exemples

Virtual network gateway example

Exemple de requête

Exemple de réponse

Définitions

CreateVirtualNetworkGatewayRequest

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

GatewayType

LoadBalancingSetting

OnPremisesGateway

OnPremisesGatewayPersonal

PublicKey

VirtualNetworkAzureResource

VirtualNetworkGateway

Ressources supplémentaires