Compartir a través de

Workspaces - Get Outbound Gateway Rules

Servicio:
Core
Versión de la API:
v1

Devuelve las reglas de puerta de enlace del área de trabajo habilitadas con La protección de acceso saliente (OAP). Esta API está diseñada para ayudar a los administradores del área de trabajo a ver las directivas de comunicación de red salientes eficaces que se aplican a las puertas de enlace de datos locales y de red virtual. Las reglas de puerta de enlace de protección de acceso saliente solo se devuelven y se aplican si la directiva de comunicación de red del área de trabajo tiene outbound.publicAccessRules.defaultAction establecido en Denegar. Si OAP no está habilitado en el área de trabajo, la API produce un error porque no se restringen las conexiones salientes. Esta funcionalidad actualmente está en su versión preliminar.

Nota:

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.

Permissions

El autor de la llamada debe tener rol de área de trabajo o superior del visor.

Ámbitos delegados necesarios

Workspace.Read.All o Workspace.ReadWrite.All

Identidades admitidas de Microsoft Entra

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

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

Interfaz

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/networking/communicationPolicy/outbound/gateways

Parámetros de identificador URI

Nombre En Requerido Tipo Description
workspaceId
 path True

string (uuid)

Identificador único del área de trabajo cuyas reglas de salida se consultan.

Respuestas

Nombre Tipo Description
200 OK

WorkspaceOutboundGateways

Solicitud completada correctamente.

Encabezados

ETag: string
Other Status Codes

ErrorResponse

Códigos de error comunes:

  • UnknownError: se produjo un error.

Ejemplos

Get workspace outbound access protection gateway rule for example

Solicitud de ejemplo

GET https://api.fabric.microsoft.com/v1/workspaces/47482db6-4583-4672-86dd-999d0f8f4d7a/networking/communicationPolicy/outbound/gateways

Respuesta de muestra

status code:
200 
ETag: 0f8fad5b-d9cb-469f-a165-70867728950e
{
  "defaultAction": "Deny",
  "allowedGateways": [
    {
      "id": "91c5ae74-e82d-4dd3-bfeb-6b1814030123"
    }
  ]
}

Definiciones

Nombre Description
ErrorRelatedResource

Objeto de detalles del recurso relacionado con el error.
ErrorResponse

Respuesta de error.
ErrorResponseDetails

Detalles de la respuesta de error.
GatewayAccessActionType

Define el comportamiento del control de acceso para las puertas de enlace salientes. Esta enumeración se usa para el campo defaultAction para especificar si se debe permitir o denegar la comunicación saliente de forma predeterminada. Este tipo permite el control global y específico de la puerta de enlace sobre el acceso saliente, lo que ayuda a aplicar directivas de comunicación de red seguras y predecibles. Se pueden agregar tipos de acción de acceso de puerta de enlace adicionales a lo largo del tiempo.
GatewayAccessRuleMetadata

Representa una puerta de enlace que se permite para la comunicación saliente. Este objeto se usa dentro de allowedGateways para autorizar explícitamente el acceso saliente.
WorkspaceOutboundGateways

Representa el conjunto completo de reglas de protección de acceso de salida de puerta de enlace configuradas para un área de trabajo como parte de su directiva de comunicación de red. Este objeto define las reglas de puerta de enlace que rigen la comunicación saliente.

ErrorRelatedResource

Object

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

Object

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.
moreDetails

ErrorResponseDetails[]

Lista de detalles de error adicionales.
relatedResource

ErrorRelatedResource

Detalles del recurso relacionado con el error.
requestId

string

Identificador de la solicitud asociada al error.

ErrorResponseDetails

Object

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.

GatewayAccessActionType

Enumeración

Define el comportamiento del control de acceso para las puertas de enlace salientes. Esta enumeración se usa para el campo defaultAction para especificar si se debe permitir o denegar la comunicación saliente de forma predeterminada. Este tipo permite el control global y específico de la puerta de enlace sobre el acceso saliente, lo que ayuda a aplicar directivas de comunicación de red seguras y predecibles. Se pueden agregar tipos de acción de acceso de puerta de enlace adicionales a lo largo del tiempo.

Valor Description
Allow

Permite puertas de enlace salientes. Cuando se usa como acción predeterminada, se permiten todas las puertas de enlace.
Deny

Bloquea las puertas de enlace salientes. Cuando se usa como acción predeterminada, se deniegan todas las puertas de enlace a menos que se permita explícitamente.

GatewayAccessRuleMetadata

Object

Representa una puerta de enlace que se permite para la comunicación saliente. Este objeto se usa dentro de allowedGateways para autorizar explícitamente el acceso saliente.

Nombre Tipo Description
id

string (uuid)

Id. de puerta de enlace que se va a permitir.

WorkspaceOutboundGateways

Object

Representa el conjunto completo de reglas de protección de acceso de salida de puerta de enlace configuradas para un área de trabajo como parte de su directiva de comunicación de red. Este objeto define las reglas de puerta de enlace que rigen la comunicación saliente.

Nombre Tipo Description
allowedGateways

GatewayAccessRuleMetadata[]

Lista de reglas que definen el comportamiento de acceso saliente para las puertas de enlace.
defaultAction

GatewayAccessActionType

Define el comportamiento predeterminado para todas las puertas de enlace que no aparecen explícitamente en la matriz de listas permitidas. Si se establece en "Permitir", todas las puertas de enlace no especificadas se permiten de forma predeterminada. Si se establece en "Denegar", se bloquean todas las puertas de enlace no especificadas.