Workspaces - Get Outbound Cloud Connection Rules

Serviço:: Core

Versão da API:: v1

Retorna as regras de conexão de nuvem para o workspace habilitado com o OAP (Outbound Access Protection). Essa API foi projetada para ajudar os administradores do workspace a exibir as políticas efetivas de comunicação de rede de saída impostas para conexões de nuvem. As regras de conexão de nuvem de proteção de acesso de saída só serão retornadas e aplicadas se a política de comunicação de rede do workspace tiver outbound.publicAccessRules.defaultAction sido definida como Negar. Se o OAP não estiver habilitado no workspace, a API falhará, pois as conexões de saída não estão sendo restritas. Esse recurso está atualmente em versão prévia.

Observação

Essa API faz parte de uma versão prévia e é fornecida apenas para fins de avaliação e desenvolvimento. Ele pode mudar com base nos comentários e não é recomendado para uso em produção.

Permissions

O chamador deve ter função de workspace do visualizador ou superior.

Escopos delegados necessários

Workspace.Read.All ou Workspace.ReadWrite.All

Identidades com suporte do Microsoft Entra

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

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
workspaceId	path	True	string (uuid)	Identificador exclusivo do workspace cujas regras de saída estão sendo consultadas.

Respostas

Nome	Tipo	Description
200 OK	WorkspaceOutboundConnections	Solicitação concluída com êxito. Cabeçalhos ETag: string
Other Status Codes	ErrorResponse	Códigos de erro comuns: UnknownError – Ocorreu um erro.

Nome

Tipo

Description

200 OK

WorkspaceOutboundConnections

Solicitação concluída com êxito.

Cabeçalhos

ETag: string

Other Status Codes

ErrorResponse

Códigos de erro comuns:

UnknownError – Ocorreu um erro.

Exemplos

Get workspace outbound access protection cloud connection rule for example

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:: 200

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

{
  "defaultAction": "Deny",
  "rules": [
    {
      "connectionType": "SQL",
      "defaultAction": "Deny",
      "allowedEndpoints": [
        {
          "hostNamePattern": "*.microsoft.com"
        }
      ]
    },
    {
      "connectionType": "LakeHouse",
      "defaultAction": "Deny",
      "allowedWorkspaces": [
        {
          "workspaceId": "91c5ae74-e82d-4dd3-bfeb-6b1814030123"
        }
      ]
    },
    {
      "connectionType": "Web",
      "defaultAction": "Allow"
    }
  ]
}

Definições

Nome	Description
ConnectionAccessActionType	Define o comportamento do controle de acesso para conexões 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 da conexão sobre o acesso de saída, ajudando a impor políticas de comunicação de rede seguras e previsíveis. Tipos adicionais de ação de acesso à conexão podem ser adicionados ao longo do tempo.
ConnectionRuleEndpointMetadata	Representa uma única regra de exceção no nível do ponto de extremidade que permite a comunicação de saída para um domínio ou host externo específico. Esse objeto é usado dentro da matriz allowedEndpoints de uma regra de conexão para autorizar explicitamente o acesso de saída a pontos de extremidade confiáveis para um determinado connectionType. Isso é aplicável somente aos tipos de conexão que dão suporte à filtragem baseada em ponto de extremidade (por exemplo, SQL, MySQL, Web etc.).
ConnectionRuleWorkspaceMetadata	Representa uma regra de exceção no nível do workspace que permite a comunicação de saída com um workspace específico para um determinado connectionType. Esse objeto é usado na matriz allowedWorkspaces de uma regra de conexão para autorizar explicitamente o acesso entre workspaces. Isso é aplicável somente aos tipos de conexão que dão suporte à filtragem baseada em workspace, como Lakehouse, Warehouse, FabricSql e PowerPlatformDataflows.
ErrorRelatedResource	O objeto de detalhes do recurso relacionado ao erro.
ErrorResponse	A resposta de erro.
ErrorResponseDetails	Os detalhes da resposta de erro.
OutboundConnectionRule	Define uma regra de acesso de saída para uma conexão de nuvem específica.
WorkspaceOutboundConnections	Representa o conjunto completo de regras de conexão de nuvem de proteção de acesso de saída configuradas para um workspace como parte de sua política de comunicação de rede. Esse objeto define as regras de conexão que regem quais pontos de extremidade externos e workspaces são permitidos ou negados para comunicação de saída

ConnectionAccessActionType

Enumeração

Define o comportamento do controle de acesso para conexões 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 da conexão sobre o acesso de saída, ajudando a impor políticas de comunicação de rede seguras e previsíveis. Tipos adicionais de ação de acesso à conexão podem ser adicionados ao longo do tempo.

Valor	Description
Allow	Permite conexões de saída. Quando usado como uma ação padrão, todas as conexões de nuvem são permitidas.
Deny	Bloqueia conexões de saída. Quando usado como uma ação padrão, todas as conexões de nuvem são negadas, a menos que explicitamente permitidas.

ConnectionRuleEndpointMetadata

Objeto

Representa uma única regra de exceção no nível do ponto de extremidade que permite a comunicação de saída para um domínio ou host externo específico. Esse objeto é usado dentro da matriz allowedEndpoints de uma regra de conexão para autorizar explicitamente o acesso de saída a pontos de extremidade confiáveis para um determinado connectionType. Isso é aplicável somente aos tipos de conexão que dão suporte à filtragem baseada em ponto de extremidade (por exemplo, SQL, MySQL, Web etc.).

Nome	Tipo	Description
hostNamePattern	string	Um padrão com suporte curinga que define o ponto de extremidade externo permitido. Os exemplos incluem *.microsoft.com, api.contoso.com ou data.partner.org.

ConnectionRuleWorkspaceMetadata

Objeto

Representa uma regra de exceção no nível do workspace que permite a comunicação de saída com um workspace específico para um determinado connectionType. Esse objeto é usado na matriz allowedWorkspaces de uma regra de conexão para autorizar explicitamente o acesso entre workspaces. Isso é aplicável somente aos tipos de conexão que dão suporte à filtragem baseada em workspace, como Lakehouse, Warehouse, FabricSql e PowerPlatformDataflows.

Nome	Tipo	Description
workspaceId	string (uuid)	O GUID (identificador exclusivo) do workspace de destino que tem permissão para ser conectado do workspace atual.

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

OutboundConnectionRule

Objeto

Define uma regra de acesso de saída para uma conexão de nuvem específica.

Nome	Tipo	Description
allowedEndpoints	ConnectionRuleEndpointMetadata[]	Define uma lista de pontos de extremidade externos explicitamente permitidos para o connectionType. Cada entrada na matriz representa um padrão de nome de host permitido para comunicação de saída do workspace. Esse campo é aplicável somente a tipos de conexão que dão suporte à filtragem baseada em ponto de extremidade (por exemplo, SQL, MySQL, Web etc.). Se defaultAction for definido como "Negar" para o tipo de conexão, somente os pontos de extremidade listados aqui serão permitidos; todos os outros serão bloqueados.
allowedWorkspaces	ConnectionRuleWorkspaceMetadata[]	Especifica uma lista de IDs de workspace que são explicitamente permitidas para comunicação de saída para o connectionType de malha fornecido. Esse campo é aplicável somente a tipos de conexão de malha que dão suporte à filtragem baseada em workspace, limitada a Lakehouse, Warehouse, FabricSql e PowerPlatformDataflows. Quando defaultAction é definido como "Negar" para um tipo de conexão, somente os workspaces listados em allowedWorkspaces serão permitidos para acesso de saída; todos os outros serão bloqueados.
connectionType	string	Especifica o tipo de conexão de nuvem ao qual a regra se aplica. O comportamento e a aplicabilidade de outras propriedades de regra (como allowedEndpoints ou allowedWorkspaces) podem variar dependendo dos recursos do tipo de conexão.
defaultAction	ConnectionAccessActionType	Define o comportamento de acesso de saída padrão para o connectionType. Esse campo determina se as conexões desse tipo são permitidas ou bloqueadas por padrão, a menos que sejam mais refinadas por allowedEndpoints ou allowedWorkspaces. Se definido como "Permitir": todas as conexões desse tipo serão permitidas, a menos que seja explicitamente negada por uma regra mais específica. Esse campo fornece controle refinado sobre cada tipo de conexão e complementa o comportamento de fallback global definido por defaultAction.

WorkspaceOutboundConnections

Objeto

Representa o conjunto completo de regras de conexão de nuvem de proteção de acesso de saída configuradas para um workspace como parte de sua política de comunicação de rede. Esse objeto define as regras de conexão que regem quais pontos de extremidade externos e workspaces são permitidos ou negados para comunicação de saída

Nome	Tipo	Description
defaultAction	ConnectionAccessActionType	Define o comportamento padrão para todos os tipos de conexão de nuvem que não estão explicitamente listados na matriz de regras. Se definido como "Permitir", todos os tipos de conexão não especificados serão permitidos por padrão. Se definido como "Negar", todos os tipos de conexão não especificados serão bloqueados por padrão, a menos que seja explicitamente permitido. Essa configuração atua como uma política de fallback global e é essencial para impor uma postura padrão segura em ambientes em que apenas conexões conhecidas e confiáveis devem ser permitidas.
rules	OutboundConnectionRule[]	Uma lista de regras que definem o comportamento de acesso de saída para tipos de conexão de nuvem específicos. Cada regra pode incluir restrições baseadas em ponto de extremidade ou de workspace, dependendo dos tipos de conexão com suporte.

Compartilhar via

Workspaces - Get Outbound Cloud Connection Rules

Permissions

Escopos delegados necessários

Identidades com suporte do Microsoft Entra

Interfase

Parâmetros de URI

Respostas

Exemplos

Get workspace outbound access protection cloud connection rule for example

Solicitação de exemplo

Resposta de exemplo

Definições

ConnectionAccessActionType

ConnectionRuleEndpointMetadata

ConnectionRuleWorkspaceMetadata

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

OutboundConnectionRule

WorkspaceOutboundConnections