Partilhar via

Workspaces - Get Outbound Cloud Connection Rules

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

Retorna as regras de conexão na nuvem para o espaço de trabalho habilitado com a Proteção de Acesso de Saída (OAP). Essa API foi projetada para ajudar os administradores do espaço de trabalho a exibir as políticas eficazes de comunicação de rede de saída que são impostas para conexões de nuvem. As regras de conexão na nuvem de proteção de acesso de saída só são retornadas e aplicadas se a política de comunicação de rede do espaço de trabalho tiver outbound.publicAccessRules.defaultAction definido como Negar. Se o OAP não estiver habilitado no espaço de trabalho, a API falhará porque as conexões de saída não estão sendo restritas. Esta funcionalidade está atualmente em pré-visualização.

Observação

Esta API faz parte de uma versão de pré-visualização e é fornecida apenas para fins de avaliação e desenvolvimento. Ele pode mudar com base no feedback e não é recomendado para uso em produção.

Permissions

O chamador deve ter visualizador ou superior função de espaço de trabalho.

Escopos delegados necessários

Workspace.Read.All ou Workspace.ReadWrite.All

Identidades suportadas pelo Entra da Microsoft

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

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

Interfaz

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

Parâmetros do URI

Name Em Necessário Tipo Description
workspaceId
 path True

string (uuid)

Identificador exclusivo do espaço de trabalho cujas regras de saída estão sendo consultadas.

Respostas

Name Tipo Description
200 OK

WorkspaceOutboundConnections

Pedido concluído com sucesso.

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

Pedido de amostra

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

Resposta da amostra

Código de estado:
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

Name Description
ConnectionAccessActionType

Define o comportamento de controle de acesso para conexões 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 da conexão 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 à 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. Este 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 apenas a tipos de conexão que suportam filtragem baseada em endpoint (por exemplo, SQL, MySQL, Web, etc.).
ConnectionRuleWorkspaceMetadata

Representa uma regra de exceção no nível do espaço de trabalho que permite a comunicação de saída para um espaço de trabalho específico para um determinado connectionType. Este objeto é usado dentro da matriz allowedWorkspaces de uma regra de conexão para autorizar explicitamente o acesso entre espaços de trabalho. Isso é aplicável apenas a tipos de conexão que oferecem suporte à filtragem baseada em espaço de trabalho, 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 espaço de trabalho como parte de sua política de comunicação de rede. Este objeto define as regras de conexão que regem quais pontos de extremidade externos e espaços de trabalho são permitidos ou negados para comunicação de saída

ConnectionAccessActionType

Enumeração

Define o comportamento de controle de acesso para conexões 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 da conexão 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 à 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 permitido.

ConnectionRuleEndpointMetadata

Object

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. Este 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 apenas a tipos de conexão que suportam filtragem baseada em endpoint (por exemplo, SQL, MySQL, Web, etc.).

Name Tipo Description
hostNamePattern

string

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

ConnectionRuleWorkspaceMetadata

Object

Representa uma regra de exceção no nível do espaço de trabalho que permite a comunicação de saída para um espaço de trabalho específico para um determinado connectionType. Este objeto é usado dentro da matriz allowedWorkspaces de uma regra de conexão para autorizar explicitamente o acesso entre espaços de trabalho. Isso é aplicável apenas a tipos de conexão que oferecem suporte à filtragem baseada em espaço de trabalho, como Lakehouse, Warehouse, FabricSQL e PowerPlatformDataflows.

Name Tipo Description
workspaceId

string (uuid)

O identificador exclusivo (GUID) do espaço de trabalho de destino que pode ser conectado a partir do espaço de trabalho atual.

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

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.

OutboundConnectionRule

Object

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

Name 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 que é permitido para comunicação de saída do espaço de trabalho. Este campo é aplicável apenas a tipos de conexão que suportam filtragem baseada em endpoint (por exemplo, SQL, MySQL, Web, etc.). Se defaultAction estiver 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 espaço de trabalho que são explicitamente permitidas para comunicação de saída para determinado connectionType de malha. Este campo é aplicável apenas a tipos de conexão de malha que suportam filtragem baseada em espaço de trabalho, limitada a Lakehouse, Warehouse, FabricSQL e PowerPlatformDataflows. Quando defaultAction é definido como "Negar" para um tipo de conexão, somente os espaços de trabalho listados em allowedWorkspaces terão permissão 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. Este campo determina se conexões desse tipo são permitidas ou bloqueadas por padrão, a menos que sejam refinadas por allowedEndpoints ou allowedWorkspaces. Se definido como "Permitir": Todas as conexões desse tipo são permitidas, a menos que explicitamente negadas por uma regra mais específica. Este campo fornece controle refinado sobre cada tipo de conexão e complementa o comportamento de fallback global definido por defaultAction.

WorkspaceOutboundConnections

Object

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

Name 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 são permitidos por padrão. Se definido como "Negar", todos os tipos de conexão não especificados são bloqueados por padrão, a menos que explicitamente permitido. Essa configuração atua como uma política de fallback global e é fundamental para impor uma postura padrão segura em ambientes onde 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 específicos de conexão de nuvem. Cada regra pode incluir restrições baseadas em ponto de extremidade ou espaço de trabalho, dependendo dos tipos de conexão suportados.