Workspaces - Set Firewall Rules

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

Define as regras de firewall de IP para o workspace. Essa API permite que os administradores do workspace definam regras de firewall de IP que controlam quais endereços IP devem ter permissão para se conectar ao workspace. Este recurso está atualmente em versão prévia.

Note

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.

Note

As regras de firewall só serão impostas se a política de comunicação de rede do workspace tiver inbound.publicAccessRules.defaultAction definido como Deny. Se o acesso público não estiver bloqueado no workspace, as chamadas à API para esse workspace não serão restritas.

Note

Essa API usa o método PUT e substituirá todas as regras de firewall de IP para o workspace. Sempre execute Get primeiro e forneça todas as regras de firewall de IP no corpo da solicitação.

Permissões

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

Escopos delegados necessários

Workspace.ReadWrite.All

Identidades com suporte do Microsoft Entra

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

Identity Support
Usuário Sim
Entidade de serviço e identidades gerenciadas Sim

Interface

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

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
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. Um máximo de 256 regras pode ser especificado por workspace.

Respostas

Nome Tipo Description
200 OK

A solicitação foi concluída com êxito e não tem conteúdo no corpo da resposta.

Cabeçalhos:

Etagstring - A nova ETag da configuração de firewall após a atualização. Use esse valor no cabeçalho de If-Match uma chamada PUT subsequente para aplicar o controle de simultaneidade otimista.
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

Example for setting workspace firewall rules

Solicitação de exemplo

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

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

Definições

Nome Description
ErrorRelatedResource

O objeto relacionado ao erro nos detalhes do recurso.
ErrorResponse

A resposta de erro.
ErrorResponseDetails

Os detalhes da resposta de erro.
FirewallRule

Define uma regra de firewall, identificada por seu nome e que contém um único endereço IP, um intervalo de endereços IP ou um endereço IP CIDR como seu valor.
InboundFirewallConfiguration

Esse objeto define o conjunto completo de regras de firewall para gerenciar a proteção de acesso de entrada como parte da política de comunicação de rede de um workspace. Ele garante que somente endereços IP explicitamente autorizados sejam permitidos para comunicação de entrada. Quando enviado por meio da API PUT, esse objeto cria ou substitui totalmente a configuração de firewall de IP existente para o workspace. Essas regras são impostas somente quando a política de comunicação de rede do workspace tem inbound.publicAccessRules.defaultAction definido como Deny.

ErrorRelatedResource

Objeto

O objeto relacionado ao erro nos detalhes do recurso.

Nome Tipo Description
resourceId

string

O identificador do recurso envolvido 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.

FirewallRule

Objeto

Define uma regra de firewall, identificada por seu nome e que contém um único endereço IP, um intervalo de endereços IP ou um endereço IP CIDR como seu valor.

Nome Tipo Description
displayName

string

Especifica o nome da regra. Os nomes de exibição podem ter até 128 caracteres de comprimento e devem ser exclusivos por workspace.
value

string

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

InboundFirewallConfiguration

Objeto

Esse objeto define o conjunto completo de regras de firewall para gerenciar a proteção de acesso de entrada como parte da política de comunicação de rede de um workspace. Ele garante que somente endereços IP explicitamente autorizados sejam permitidos para comunicação de entrada. Quando enviado por meio da API PUT, esse objeto cria ou substitui totalmente a configuração de firewall de IP existente para o workspace. Essas regras são impostas somente quando a política de comunicação de rede do workspace tem inbound.publicAccessRules.defaultAction definido como Deny.

Nome Tipo Description
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. Um máximo de 256 regras pode ser especificado por workspace.