Workspaces - Set Firewall Rules

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

Define as regras do firewall IP para o espaço de trabalho. Esta API permite aos administradores de espaços de trabalho definir regras de firewall IP que controlam quais os endereços IP que devem ser autorizados a ligar-se ao espaço de trabalho. Esta funcionalidade está atualmente em pré-visualização.

Note

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.

Note

As regras de firewall só são aplicadas se a política de comunicação de rede do espaço de trabalho tiver inbound.publicAccessRules.defaultAction definida como Denegar. Se o acesso público não estiver bloqueado no workspace, as chamadas de API para este workspace não serão restringidas.

Note

Esta API utiliza o método PUT e vai sobrescrever todas as regras do firewall IP para o espaço de trabalho. Execute sempre Get first e forneça todas as regras do firewall IP no corpo do pedido.

Permissões

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

Escopos delegados necessários

Workspace.ReadWrite.All

Identidades suportadas pelo Entra da Microsoft

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

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

Interface

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

Parâmetros do URI

Name Em Obrigatório Tipo Descrição
workspaceId
 path True

string (uuid)

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

Corpo do Pedido

Name Tipo Descrição
rules

FirewallRule[]

Uma lista de regras que definem endereços IP permitidos para acesso de entrada. Cada regra pode incluir um nome e um único endereço IP, um intervalo de endereços IP ou um endereço IP CIDR. Pode ser especificado um máximo de 256 regras por espaço de trabalho.

Respostas

Name Tipo Descrição
200 OK

Pedido concluído com sucesso e não tem conteúdo no corpo da resposta.

Cabeçalhos:

ETagstring - O novo ETag da configuração do firewall após a atualização. Use este valor no cabeçalho de If-Match uma chamada PUT subsequente para aplicar controlo otimista de concorrência.
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

Example for setting workspace firewall rules

Pedido de amostra

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

{
  "rules": [
    {
      "displayName": "SingleIPAddressRule",
      "value": "12.34.56.78"
    },
    {
      "displayName": "IPAddressRangeRule",
      "value": "12.34.56.78-12.34.56.89"
    },
    {
      "displayName": "CidrIPAddressRule",
      "value": "12.34.56.0/24"
    }
  ]
}

Resposta da amostra

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

Definições

Name Descrição
ErrorRelatedResource

Os detalhes do objeto de recurso relacionado ao erro.
ErrorResponse

A resposta de erro.
ErrorResponseDetails

Os detalhes do erro na resposta.
FirewallRule

Define uma regra de firewall, identificada pelo seu nome e contendo um único endereço IP, um intervalo de endereços IP ou um endereço IP CIDR como seu valor.
InboundFirewallConfiguration

Este objeto define o conjunto completo de regras de firewall para gerir a proteção de acesso de entrada como parte da política de comunicação em rede de um espaço de trabalho. Garante que apenas endereços IP explicitamente autorizados são permitidos para comunicações de entrada. Quando submetido através da API PUT, este objeto cria ou substitui totalmente a configuração existente do firewall IP para o espaço de trabalho. Estas regras são aplicadas apenas quando a política de comunicação de rede do espaço de trabalho tem inbound.publicAccessRules.defaultAction definida como Denegar.

ErrorRelatedResource

Object

Os detalhes do objeto de recurso relacionado ao erro.

Name Tipo Descrição
resourceId

string

O ID do recurso envolvido no erro.
resourceType

string

O tipo de recurso envolvido no erro.

ErrorResponse

Object

A resposta de erro.

Name Tipo Descrição
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

Detalhes do recurso relacionado ao erro.
requestId

string (uuid)

ID da solicitação associada ao erro.

ErrorResponseDetails

Object

Os detalhes do erro na resposta.

Name Tipo Descrição
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

Detalhes do recurso relacionado ao erro.

FirewallRule

Object

Define uma regra de firewall, identificada pelo seu nome e contendo um único endereço IP, um intervalo de endereços IP ou um endereço IP CIDR como seu valor.

Name Tipo Descrição
displayName

string

Especifica o nome da regra. Os nomes de exibição podem ter até 128 caracteres de comprimento e são obrigatórios a ser únicos por cada espaço de trabalho.
value

string

Especifica o valor da regra, especificada como um único endereço IP, um intervalo de endereços IP ou um endereço IP CIDR.

InboundFirewallConfiguration

Object

Este objeto define o conjunto completo de regras de firewall para gerir a proteção de acesso de entrada como parte da política de comunicação em rede de um espaço de trabalho. Garante que apenas endereços IP explicitamente autorizados são permitidos para comunicações de entrada. Quando submetido através da API PUT, este objeto cria ou substitui totalmente a configuração existente do firewall IP para o espaço de trabalho. Estas regras são aplicadas apenas quando a política de comunicação de rede do espaço de trabalho tem inbound.publicAccessRules.defaultAction definida como Denegar.

Name Tipo Descrição
rules

FirewallRule[]

Uma lista de regras que definem endereços IP permitidos para acesso de entrada. Cada regra pode incluir um nome e um único endereço IP, um intervalo de endereços IP ou um endereço IP CIDR. Pode ser especificado um máximo de 256 regras por espaço de trabalho.