Gateways - Update Gateway

Servicio:: Core

Versión de la API:: v1

Actualiza la puerta de enlace por identificador.

Permisos

El autor de la llamada debe tener permiso de administrador para la puerta de enlace.

Ámbitos delegados necesarios

Gateway.ReadWrite.All

Identidades admitidas de Microsoft Entra

Esta API admite las identidades de Microsoft enumeradas en esta sección.

Identidad	Apoyo
Usuario	Sí
de entidad de servicio y identidades administradas	Sí

Interfaz

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
gatewayId	path	True	string (uuid)	Identificador de la puerta de enlace.

Cuerpo de la solicitud

El cuerpo de la solicitud puede ser uno de los siguientes:

Nombre	Description
UpdateOnPremisesGatewayRequest
UpdateVirtualNetworkGatewayRequest

UpdateOnPremisesGatewayRequest

Nombre	Requerido	Tipo	Description
type	True	string: OnPremises	Tipo de la puerta de enlace.
allowCloudConnectionRefresh		boolean	Indica si se deben permitir que las conexiones en la nube se actualicen a través de esta puerta de enlace local. True: Permitir, False: no permitir.
allowCustomConnectors		boolean	Si se permiten usar conectores personalizados con esta puerta de enlace local. True: Permitir, False: no permitir.
displayName		string	Nombre de la puerta de enlace. La longitud máxima es de 200 caracteres.
loadBalancingSetting		LoadBalancingSetting	Configuración de equilibrio de carga de la puerta de enlace local.

UpdateVirtualNetworkGatewayRequest

Nombre	Requerido	Tipo	Description
type	True	string: VirtualNetwork	Tipo de la puerta de enlace.
capacityId		string (uuid)	Identificador de objeto de la capacidad de licencia de Fabric.
displayName		string	Nombre de la puerta de enlace. La longitud máxima es de 200 caracteres.
inactivityMinutesBeforeSleep		integer	Minutos de inactividad antes de que la puerta de enlace de red virtual entre en suspensión automática. Debe ser uno de los siguientes valores: 30, 60, 90, 120, 150, 240, 360, 480, 720, 1440.
numberOfMemberGateways		integer	Número de puertas de enlace miembro. Número comprendido entre 1 y 9.

Respuestas

Nombre Tipo Description

200 OK

Nombre	Tipo	Description
200 OK	Gateway: OnPremisesGateway OnPremisesGatewayPersonal VirtualNetworkGateway	De acuerdo. La operación se realizó correctamente.
429 Too Many Requests	ErrorResponse	Se superó el límite de frecuencia de servicio. El servidor devuelve un `Retry-After` encabezado que indica, en segundos, cuánto tiempo debe esperar el cliente antes de enviar solicitudes adicionales. Encabezados Retry-After: integer
Other Status Codes	ErrorResponse	Códigos de error comunes: UnknownError: se produjo un error.

Gateway:

OnPremisesGateway
OnPremisesGatewayPersonal
VirtualNetworkGateway

De acuerdo. La operación se realizó correctamente.

429 Too Many Requests

ErrorResponse

Se superó el límite de frecuencia de servicio. El servidor devuelve un Retry-After encabezado que indica, en segundos, cuánto tiempo debe esperar el cliente antes de enviar solicitudes adicionales.

Encabezados

Retry-After: integer

Other Status Codes

ErrorResponse

Códigos de error comunes:

UnknownError: se produjo un error.

Ejemplos

On-premises gateway example

Virtual network gateway example

On-premises gateway example

Solicitud de ejemplo

HTTP

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

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

Respuesta de muestra

status code:: 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

Solicitud de ejemplo

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
}

Respuesta de muestra

status code:: 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
}

Definiciones

Nombre	Description
ErrorRelatedResource	Objeto de detalles del recurso relacionado con el error.
ErrorResponse	Respuesta de error.
ErrorResponseDetails	Detalles de la respuesta de error.
GatewayType	Tipo de la puerta de enlace. Se pueden agregar tipos de puerta de enlace adicionales a lo largo del tiempo.
LoadBalancingSetting	Configuración de equilibrio de carga del clúster de puerta de enlace. Se puede agregar una configuración adicional de equilibrio de carga a lo largo del tiempo.
OnPremisesGateway
OnPremisesGatewayPersonal
PublicKey	Clave pública de la puerta de enlace local.
UpdateOnPremisesGatewayRequest
UpdateVirtualNetworkGatewayRequest
VirtualNetworkAzureResource	Las propiedades de un recurso de Azure de Virtual Network
VirtualNetworkGateway

ErrorRelatedResource

Objeto

Objeto de detalles del recurso relacionado con el error.

Nombre	Tipo	Description
resourceId	string	Identificador de recurso implicado en el error.
resourceType	string	Tipo del recurso implicado en el error.

ErrorResponse

Objeto

Respuesta de error.

Nombre	Tipo	Description
errorCode	string	Identificador específico que proporciona información sobre una condición de error, lo que permite una comunicación estandarizada entre nuestro servicio y sus usuarios.
isRetriable	boolean	Cuando es true, se puede reintentar la solicitud. Use el `Retry-After` encabezado de respuesta para determinar el retraso, si está disponible.
message	string	Representación legible del error.
moreDetails	ErrorResponseDetails[]	Lista de detalles de error adicionales.
relatedResource	ErrorRelatedResource	Detalles del recurso relacionado con el error.
requestId	string (uuid)	Identificador de la solicitud asociada al error.

ErrorResponseDetails

Objeto

Detalles de la respuesta de error.

Nombre	Tipo	Description
errorCode	string	Identificador específico que proporciona información sobre una condición de error, lo que permite una comunicación estandarizada entre nuestro servicio y sus usuarios.
message	string	Representación legible del error.
relatedResource	ErrorRelatedResource	Detalles del recurso relacionado con el error.

GatewayType

Enumeración

Tipo de la puerta de enlace. Se pueden agregar tipos de puerta de enlace adicionales a lo largo del tiempo.

Valor	Description
OnPremises	Puerta de enlace local.
OnPremisesPersonal	Puerta de enlace local (modo personal).
VirtualNetwork	Puerta de enlace de red virtual.

LoadBalancingSetting

Enumeración

Configuración de equilibrio de carga del clúster de puerta de enlace. Se puede agregar una configuración adicional de equilibrio de carga a lo largo del tiempo.

Valor	Description
Failover	Las solicitudes se enviarán al primer miembro del clúster de puerta de enlace disponible.
DistributeEvenly	Las solicitudes se distribuirán uniformemente entre todos los miembros del clúster de puerta de enlace habilitados.

OnPremisesGateway

Objeto

Nombre	Tipo	Description
allowCloudConnectionRefresh	boolean	Indica si se deben permitir que las conexiones en la nube se actualicen a través de esta puerta de enlace local. True: Permitir, False: no permitir.
allowCustomConnectors	boolean	Si se permiten usar conectores personalizados con esta puerta de enlace local. True: Permitir, False: no permitir.
displayName	string	Nombre para mostrar de la puerta de enlace local.
id	string (uuid)	Identificador de objeto de la puerta de enlace.
loadBalancingSetting	LoadBalancingSetting	Configuración de equilibrio de carga de la puerta de enlace local.
numberOfMemberGateways	integer	Número de miembros de puerta de enlace en la puerta de enlace local.
publicKey	PublicKey	Clave pública del miembro de puerta de enlace principal. Se usa para cifrar las credenciales para crear y actualizar conexiones.
type	string: OnPremises	Tipo de la puerta de enlace.
version	string	Versión del miembro de puerta de enlace principal instalada.

OnPremisesGatewayPersonal

Objeto

Nombre	Tipo	Description
id	string (uuid)	Identificador de objeto de la puerta de enlace.
publicKey	PublicKey	Clave pública de la puerta de enlace. Se usa para cifrar las credenciales para crear y actualizar conexiones.
type	string: OnPremisesPersonal	Tipo de la puerta de enlace.
version	string	Versión de la puerta de enlace.

PublicKey

Objeto

Clave pública de la puerta de enlace local.

Nombre	Tipo	Description
exponent	string	Exponente de la clave pública.
modulus	string	Módulo de la clave pública.

UpdateOnPremisesGatewayRequest

Objeto

Nombre	Tipo	Description
allowCloudConnectionRefresh	boolean	Indica si se deben permitir que las conexiones en la nube se actualicen a través de esta puerta de enlace local. True: Permitir, False: no permitir.
allowCustomConnectors	boolean	Si se permiten usar conectores personalizados con esta puerta de enlace local. True: Permitir, False: no permitir.
displayName	string	Nombre de la puerta de enlace. La longitud máxima es de 200 caracteres.
loadBalancingSetting	LoadBalancingSetting	Configuración de equilibrio de carga de la puerta de enlace local.
type	string: OnPremises	Tipo de la puerta de enlace.

UpdateVirtualNetworkGatewayRequest

Objeto

Nombre	Tipo	Description
capacityId	string (uuid)	Identificador de objeto de la capacidad de licencia de Fabric.
displayName	string	Nombre de la puerta de enlace. La longitud máxima es de 200 caracteres.
inactivityMinutesBeforeSleep	integer	Minutos de inactividad antes de que la puerta de enlace de red virtual entre en suspensión automática. Debe ser uno de los siguientes valores: 30, 60, 90, 120, 150, 240, 360, 480, 720, 1440.
numberOfMemberGateways	integer	Número de puertas de enlace miembro. Número comprendido entre 1 y 9.
type	string: VirtualNetwork	Tipo de la puerta de enlace.

VirtualNetworkAzureResource

Objeto

Las propiedades de un recurso de Azure de Virtual Network

Nombre	Tipo	Description
resourceGroupName	string	Nombre del grupo de recursos
subnetName	string	Nombre de la subred
subscriptionId	string (uuid)	Identificador de suscripción
virtualNetworkName	string	Nombre de la red virtual

VirtualNetworkGateway

Objeto

Nombre	Tipo	Description
capacityId	string (uuid)	Identificador de objeto de la capacidad de licencia de Fabric.
displayName	string	Nombre para mostrar de la puerta de enlace de red virtual.
id	string (uuid)	Identificador de objeto de la puerta de enlace.
inactivityMinutesBeforeSleep	integer	Minutos de inactividad antes de que la puerta de enlace de red virtual entre en suspensión automática.
numberOfMemberGateways	integer	Número de puertas de enlace miembro.
type	string: VirtualNetwork	Tipo de la puerta de enlace.
virtualNetworkAzureResource	VirtualNetworkAzureResource	Recurso de red virtual de Azure.