Workspaces - Set Firewall Rules

Servicio:: Core

Versión de la API:: v1

Establece las reglas de firewall de IP para el área de trabajo. Esta API permite a los administradores del área de trabajo establecer reglas de firewall de IP que controle qué direcciones IP se permitirán para conectarse al área de trabajo. Esta funcionalidad actualmente está en su versión preliminar.

Note

Esta API forma parte de una versión preliminar y solo se proporciona con fines de evaluación y desarrollo. Puede cambiar en función de los comentarios y no se recomienda para su uso en producción.

Note

Las reglas de firewall solo se aplican si la directiva de comunicación de red del área de trabajo tiene inbound.publicAccessRules.defaultAction establecido en Denegar. Si no se bloquea el acceso público en el área de trabajo, no se restringirán las llamadas API a esta área de trabajo.

Note

Esta API usa el método PUT y sobrescribirá todas las reglas de firewall de IP para el área de trabajo. Ejecute siempre Get first (Obtener primero) y proporcione todas las reglas de firewall de IP en el cuerpo de la solicitud.

Permisos

El autor de la llamada debe tener rol de administrador área de trabajo.

Ámbitos delegados necesarios

Workspace.ReadWrite.All

Identidades admitidas de Microsoft Entra

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

identidad	Apoyo
Usuario	Sí
Entidad de servicio e Identidades administradas	Sí

Interface

PUT https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/networking/communicationPolicy/inbound/firewall

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
workspaceId	path	True	string (uuid)	Identificador único del área de trabajo que se va a actualizar.

Cuerpo de la solicitud

Nombre	Tipo	Description
rules	FirewallRule[]	Lista de reglas que definen las direcciones IP permitidas para el acceso entrante. Cada regla puede incluir un nombre y una sola dirección IP, un intervalo de direcciones IP o una dirección IP CIDR. Se puede especificar un máximo de 256 reglas por área de trabajo.

Respuestas

Nombre Tipo Description

200 OK

Nombre	Tipo	Description
200 OK		La solicitud se completó correctamente y no tiene contenido en el cuerpo de la respuesta. Encabezados: ETag`string` : la nueva ETag de la configuración del firewall después de la actualización. Use este valor en el encabezado de `If-Match` una llamada PUT posterior para aplicar el control de simultaneidad optimista.
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.

La solicitud se completó correctamente y no tiene contenido en el cuerpo de la respuesta.

Encabezados:

ETagstring : la nueva ETag de la configuración del firewall después de la actualización. Use este valor en el encabezado de If-Match una llamada PUT posterior para aplicar el control de simultaneidad optimista.

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

Example for setting workspace firewall rules

Solicitud de ejemplo

HTTP

PUT https://api.fabric.microsoft.com/v1/workspaces/47482db6-4583-4672-86dd-999d0f8f4d7a/networking/communicationPolicy/inbound/firewall

{
  "rules": [
    {
      "displayName": "SingleIPAddressRule",
      "value": "12.34.56.78"
    },
    {
      "displayName": "IPAddressRangeRule",
      "value": "12.34.56.78-12.34.56.89"
    },
    {
      "displayName": "CidrIPAddressRule",
      "value": "12.34.56.0/24"
    }
  ]
}

Respuesta de muestra

status code:: 204

ETag: 0f8fad5b-d9cb-469f-a165-70867728950e

Definiciones

Nombre	Description
ErrorRelatedResource	Objeto de detalles del recurso relacionado con el error.
ErrorResponse	Respuesta de error.
ErrorResponseDetails	Detalles de la respuesta de error.
FirewallRule	Define una regla de firewall, identificada por su nombre y que contiene una sola dirección IP, un intervalo de direcciones IP o una dirección IP CIDR como su valor.
InboundFirewallConfiguration	Este objeto define el conjunto completo de reglas de firewall para administrar la protección de acceso entrante como parte de la directiva de comunicación de red de un área de trabajo. Garantiza que solo se permiten direcciones IP autorizadas explícitamente para la comunicación entrante. Cuando se envía a través de la API PUT, este objeto crea o reemplaza completamente la configuración del firewall de IP existente para el área de trabajo. Estas reglas solo se aplican cuando la directiva de comunicación de red del área de trabajo tiene inbound.publicAccessRules.defaultAction establecido en Denegar.

ErrorRelatedResource

Objeto

Objeto de detalles del recurso relacionado con el error.

Nombre	Tipo	Description
resourceId	string	ID de recurso que está involucrado 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 comprensible para humanos 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 comprensible para humanos del error.
relatedResource	ErrorRelatedResource	Detalles del recurso relacionado con el error.

FirewallRule

Objeto

Define una regla de firewall, identificada por su nombre y que contiene una sola dirección IP, un intervalo de direcciones IP o una dirección IP CIDR como su valor.

Nombre	Tipo	Description
displayName	string	Especifica el nombre de la regla. Los nombres para mostrar pueden tener hasta 128 caracteres de longitud y deben ser únicos por área de trabajo.
value	string	Especifica el valor de la regla, especificado como una sola dirección IP, un intervalo de direcciones IP o una dirección IP CIDR.

InboundFirewallConfiguration

Objeto

Este objeto define el conjunto completo de reglas de firewall para administrar la protección de acceso entrante como parte de la directiva de comunicación de red de un área de trabajo. Garantiza que solo se permiten direcciones IP autorizadas explícitamente para la comunicación entrante. Cuando se envía a través de la API PUT, este objeto crea o reemplaza completamente la configuración del firewall de IP existente para el área de trabajo. Estas reglas solo se aplican cuando la directiva de comunicación de red del área de trabajo tiene inbound.publicAccessRules.defaultAction establecido en Denegar.

Nombre	Tipo	Description
rules	FirewallRule[]	Lista de reglas que definen las direcciones IP permitidas para el acceso entrante. Cada regla puede incluir un nombre y una sola dirección IP, un intervalo de direcciones IP o una dirección IP CIDR. Se puede especificar un máximo de 256 reglas por área de trabajo.