Workspaces - Set Outbound Gateway Rules

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

Define as regras de gateway para o workspace habilitado com o OAP (Outbound Access Protection).
Essa API permite que os administradores do workspace definam, substituam ou substituam o conjunto de políticas de comunicação de rede de saída que controlam quais Gateways de Dados locais /Vnet devem ser permitidos do workspace atual.

Observação

As regras de proteção de acesso de saída só serão impostas se a política de comunicação de rede do workspace tiver outbound.publicAccessRules.defaultAction sido definida como Deny. Se o OAP não estiver habilitado no workspace, a API falhará porque as conexões de saída não serão restritas.

Observação

Essa API usa o método PUT e substitui todos os gateways de acesso de saída para o workspace. Sempre chame a operação Obter Regras de Gateway primeiro e forneça a política completa no corpo da solicitação.

Observação

Se defaultAction for omitido do corpo da solicitação, ele será o padrão para Allow, o que pode permitir involuntariamente todas as conexões de gateway de saída. Sempre especifique defaultAction explicitamente em cada corpo da solicitação PUT.

Permissions

O chamador deve ter função de administrador workspace.

Escopos delegados necessários

Workspace.ReadWrite.All

Microsoft Entra identidades com suporte

Esta API dá suporte às identidades do Microsoft listadas nesta seção.

Identidade Support
Utilizador Yes
Entidade de serviço e identidades gerenciadas Yes

Interfase

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
workspaceId
 path True

string (uuid)

Identificador exclusivo do workspace a ser atualizado.

Corpo da solicitação

Nome 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 serão permitidos por padrão. Se definido como "Negar", todos os gateways não especificados serão bloqueados. Se omitido de um corpo de solicitação PUT, esse campo será o padrão para Allow, o que pode permitir involuntariamente todas as conexões de gateway de saída. Sempre especifique explicitamente esse campo em cada corpo da solicitação PUT.

Respostas

Nome Tipo Description
200 OK

Solicitação concluída com êxito.

Cabeçalhos

ETag: string
429 Too Many Requests

ErrorResponse

O limite de taxa de serviço foi excedido. O servidor retorna um Retry-After cabeçalho indicando, em segundos, quanto tempo o cliente deve aguardar antes de enviar solicitações 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

Solicitação de exemplo

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 de exemplo

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

Definições

Nome 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 do controle de acesso para gateways de saída. Essa enumeração é usada 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 impor políticas de comunicação de rede seguras e previsíveis. Tipos de ação de acesso de gateway adicionais podem ser adicionados ao longo do tempo.
GatewayAccessRuleMetadata

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

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

ErrorRelatedResource

Objeto

O objeto de detalhes do recurso relacionado ao erro.

Nome Tipo Description
resourceId

string

A ID do recurso envolvida no erro.
resourceType

string

O tipo do recurso envolvido no erro.

ErrorResponse

Objeto

A resposta de erro.

Nome Tipo Description
errorCode

string

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

boolean

Quando true, a solicitação pode ser repetida. Use o Retry-After cabeçalho de resposta para determinar o atraso, se disponível.
message

string

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

ErrorResponseDetails[]

Lista de detalhes de erro adicionais.
relatedResource

ErrorRelatedResource

Os detalhes do recurso relacionado ao erro.
requestId

string (uuid)

ID da solicitação associada ao erro.

ErrorResponseDetails

Objeto

Os detalhes da resposta de erro.

Nome Tipo Description
errorCode

string

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

string

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

ErrorRelatedResource

Os detalhes do recurso relacionado ao erro.

GatewayAccessActionType

Enumeração

Define o comportamento do controle de acesso para gateways de saída. Essa enumeração é usada 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 impor políticas de comunicação de rede seguras e previsíveis. Tipos de ação de acesso de gateway adicionais 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 usados como uma ação padrão, todos os gateways são negados, a menos que explicitamente permitidos.

GatewayAccessRuleMetadata

Objeto

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

Nome Tipo Description
id

string (uuid)

A ID do gateway deve ser permitida.

WorkspaceOutboundGateways

Objeto

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

Nome 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 serão permitidos por padrão. Se definido como "Negar", todos os gateways não especificados serão bloqueados. Se omitido de um corpo de solicitação PUT, esse campo será o padrão para Allow, o que pode permitir involuntariamente todas as conexões de gateway de saída. Sempre especifique explicitamente esse campo em cada corpo da solicitação PUT.