Workspaces - Set Outbound Gateway Rules

Serviço:
Core
Versão da API:
v1

Define as regras de gateway para o espaço de trabalho habilitado com a Proteção de Acesso de Saída (OAP).
Esta API permite aos administradores de espaços de trabalho definir, substituir ou sobrepor o conjunto de políticas de comunicação de rede de saída que controlam quais os Gateways de Dados on-premis /Vnet que devem ser permitidos a partir do espaço de trabalho atual.

Observação

As regras de proteção de acesso de saída só são aplicadas se a política de comunicação de rede do espaço de trabalho tiver outbound.publicAccessRules.defaultAction sido definida para Deny. Se o OAP não estiver ativado no espaço de trabalho, a API falha porque as ligações de saída não são restritas.

Observação

Esta API utiliza o método PUT e sobrescreve todos os gateways de acesso de saída para o espaço de trabalho. Ligue sempre primeiro para a operação Get Gateway Rules e forneça a política completa no corpo do pedido.

Observação

Se defaultAction for omitido do corpo do pedido, passa a Allowser , o que pode permitir involuntariamente todas as ligações de gateway de saída. Especifique defaultAction sempre explicitamente em cada corpo de pedido PUT.

Permissions

O chamador deve ter a função de espaço de trabalho de administrador .

Escopos delegados necessários

Workspace.ReadWrite.All

Identidades suportadas pela Microsoft Entra

Esta API suporta as identidades do Microsoft listadas nesta secção.

Identidade Support
User Yes
Entidade de serviço e identidades geridas Yes

Interfaz

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

Parâmetros do URI

Name Em Necessário Tipo Description
workspaceId
 path True

string (uuid)

Identificador exclusivo do espaço de trabalho a ser atualizado.

Corpo do Pedido

Name Tipo Description
allowedGateways

GatewayAccessRuleMetadata[]

Uma lista de regras que definem o comportamento de acesso de saída para gateways.
defaultAction

GatewayAccessActionType

Define o comportamento padrão para todos os gateways que não estão explicitamente listados na matriz de lista permitida. Se definido como "Permitir", todos os gateways não especificados são permitidos por padrão. Se definido como "Negar", todos os gateways não especificados serão bloqueados. Se for omitido do corpo de um pedido PUT, este campo passa por defeito a Allow, o que pode permitir involuntariamente todas as ligações de gateway de saída. Especifique sempre explicitamente este campo em cada corpo de pedido PUT.

Respostas

Name Tipo Description
200 OK

Pedido concluído com sucesso.

Cabeçalhos

ETag: string
429 Too Many Requests

ErrorResponse

O limite de tarifa de serviço foi ultrapassado. O servidor devolve um Retry-After cabeçalho que indica, em segundos, quanto tempo o cliente deve esperar antes de enviar pedidos adicionais.

Cabeçalhos

Retry-After: integer
Other Status Codes

ErrorResponse

Códigos de erro comuns:

  • UnknownError - Ocorreu um erro.

Exemplos

Set workspace outbound access protection gateway rule for example

Pedido de amostra

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

{
  "defaultAction": "Deny",
  "allowedGateways": [
    {
      "id": "91c5ae74-e82d-4dd3-bfeb-6b1814030123"
    },
    {
      "id": "25bac802-080d-4f73-8a42-1b406eb1fceb"
    }
  ]
}

Resposta da amostra

Código de estado:
200 
ETag: 0f8fad5b-d9cb-469f-a165-70867728950e

Definições

Name Description
ErrorRelatedResource

O objeto de detalhes do recurso relacionado ao erro.
ErrorResponse

A resposta de erro.
ErrorResponseDetails

Os detalhes da resposta de erro.
GatewayAccessActionType

Define o comportamento de controle de acesso para gateways de saída. Este enum é usado para o campo defaultAction para especificar se a comunicação de saída deve ser permitida ou negada por padrão. Esse tipo permite o controle global e específico do gateway sobre o acesso de saída, ajudando a aplicar políticas de comunicação de rede seguras e previsíveis. Tipos de ação adicionais de acesso ao gateway podem ser adicionados ao longo do tempo.
GatewayAccessRuleMetadata

Representa um gateway permitido para comunicação de saída. Este objeto é usado dentro dos allowedGateways para autorizar explicitamente o acesso de saída.
WorkspaceOutboundGateways

Representa o conjunto completo de regras de proteção de acesso de saída de gateway configuradas para um espaço de trabalho como parte de sua política de comunicação de rede. Este objeto define as regras de gateway que regem a comunicação de saída

ErrorRelatedResource

Object

O objeto de detalhes do recurso relacionado ao erro.

Name Tipo Description
resourceId

string

A ID do recurso envolvida no erro.
resourceType

string

O tipo de recurso envolvido no erro.

ErrorResponse

Object

A resposta de erro.

Name Tipo Description
errorCode

string

Um identificador específico que fornece informações sobre uma condição de erro, permitindo uma comunicação padronizada entre nosso serviço e seus usuários.
isRetriable

boolean

Quando confirmado, o pedido pode ser retentado. Use o Retry-After cabeçalho de resposta para determinar o atraso, se disponível.
message

string

Uma representação legível por humanos do erro.
moreDetails

ErrorResponseDetails[]

Lista de detalhes de erro adicionais.
relatedResource

ErrorRelatedResource

Os detalhes do recurso relacionados ao erro.
requestId

string (uuid)

ID da solicitação associada ao erro.

ErrorResponseDetails

Object

Os detalhes da resposta de erro.

Name Tipo Description
errorCode

string

Um identificador específico que fornece informações sobre uma condição de erro, permitindo uma comunicação padronizada entre nosso serviço e seus usuários.
message

string

Uma representação legível por humanos do erro.
relatedResource

ErrorRelatedResource

Os detalhes do recurso relacionados ao erro.

GatewayAccessActionType

Enumeração

Define o comportamento de controle de acesso para gateways de saída. Este enum é usado para o campo defaultAction para especificar se a comunicação de saída deve ser permitida ou negada por padrão. Esse tipo permite o controle global e específico do gateway sobre o acesso de saída, ajudando a aplicar políticas de comunicação de rede seguras e previsíveis. Tipos de ação adicionais de acesso ao gateway podem ser adicionados ao longo do tempo.

Valor Description
Allow

Permite gateways de saída. Quando usado como uma ação padrão, todos os gateways são permitidos.
Deny

Bloqueia gateways de saída. Quando usado como uma ação padrão, todos os gateways são negados, a menos que explicitamente permitido.

GatewayAccessRuleMetadata

Object

Representa um gateway permitido para comunicação de saída. Este objeto é usado dentro dos allowedGateways para autorizar explicitamente o acesso de saída.

Name Tipo Description
id

string (uuid)

ID do gateway a ser permitido.

WorkspaceOutboundGateways

Object

Representa o conjunto completo de regras de proteção de acesso de saída de gateway configuradas para um espaço de trabalho como parte de sua política de comunicação de rede. Este objeto define as regras de gateway que regem a comunicação de saída

Name Tipo Description
allowedGateways

GatewayAccessRuleMetadata[]

Uma lista de regras que definem o comportamento de acesso de saída para gateways.
defaultAction

GatewayAccessActionType

Define o comportamento padrão para todos os gateways que não estão explicitamente listados na matriz de lista permitida. Se definido como "Permitir", todos os gateways não especificados são permitidos por padrão. Se definido como "Negar", todos os gateways não especificados serão bloqueados. Se for omitido do corpo de um pedido PUT, este campo passa por defeito a Allow, o que pode permitir involuntariamente todas as ligações de gateway de saída. Especifique sempre explicitamente este campo em cada corpo de pedido PUT.