Workspaces - Set Network Communication Policy

Serviço:: Core

Versão da API:: v1

Define a política de comunicação de rede para o workspace especificado.
Essa API usa o método PUT e substitui todas as configurações. Se apenas uma política parcial for fornecida no corpo da solicitação, as configurações restantes serão definidas como os valores padrão. Sempre chame a operação Obter Política de Comunicação de Rede primeiro e forneça a política completa no corpo da solicitação.

Note

Se defaultAction for omitido do corpo da solicitação, ele será o padrão para Allow, o que pode abrir involuntariamente o acesso à rede de entrada e 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

Interface

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
workspaceId	path	True	string (uuid)	A ID do workspace.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
If-Match		string	Um valor ETag. A ETag deve ser especificada entre aspas. Se fornecida, a chamada será bem-sucedida somente se a ETag do recurso corresponder à ETag fornecida.

Corpo da solicitação

Nome	Tipo	Description
inbound	InboundRules	As propriedades de comunicação de rede de entrada para um workspace.
outbound	OutboundRules	As propriedades de comunicação de rede de saída para um workspace.

Respostas

Nome Tipo Description

200 OK

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.

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 networking communication policy example

Solicitação de exemplo

HTTP

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

{
  "inbound": {
    "publicAccessRules": {
      "defaultAction": "Allow"
    }
  },
  "outbound": {
    "publicAccessRules": {
      "defaultAction": "Deny"
    }
  }
}

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.
InboundRules	A política para todas as comunicações de entrada para um workspace.
NetworkAccessRule	A política padrão para acesso ao workspace de redes públicas. Se omitido de um corpo de solicitação PUT, esse campo será o padrão para , o que pode abrir sem querer o acesso à `Allow`rede. Sempre especifique explicitamente esse campo em cada corpo da solicitação PUT.
NetworkRules	A política que define o acesso de/para um workspace de/para redes públicas.
OutboundRules	A política para todas as comunicações de saída de um workspace.
WorkspaceNetworkingCommunicationPolicy	A política de comunicação de rede para um workspace.

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.

InboundRules

Objeto

A política para todas as comunicações de entrada para um workspace.

Nome	Tipo	Description
publicAccessRules	NetworkRules	A política de comunicações de entrada para um workspace de redes públicas.

NetworkAccessRule

Enumeração

A política padrão para acesso ao workspace de redes públicas. Se omitido de um corpo de solicitação PUT, esse campo será o padrão para , o que pode abrir sem querer o acesso à Allowrede. Sempre especifique explicitamente esse campo em cada corpo da solicitação PUT.

Valor	Description
Allow	Permitir todas as conexões.
Deny	Negar todas as conexões.

NetworkRules

Objeto

A política que define o acesso de/para um workspace de/para redes públicas.

Nome	Tipo	Description
defaultAction	NetworkAccessRule	A política padrão para acesso ao workspace de redes públicas. Se omitido de um corpo de solicitação PUT, esse campo será o padrão para , o que pode abrir sem querer o acesso à `Allow`rede. Sempre especifique explicitamente esse campo em cada corpo da solicitação PUT.

OutboundRules

Objeto

A política para todas as comunicações de saída de um workspace.

Nome	Tipo	Description
publicAccessRules	NetworkRules	A política de comunicações de saída para redes públicas de um workspace.

WorkspaceNetworkingCommunicationPolicy

Objeto

A política de comunicação de rede para um workspace.

Nome	Tipo	Description
inbound	InboundRules	As propriedades de comunicação de rede de entrada para um workspace.
outbound	OutboundRules	As propriedades de comunicação de rede de saída para um workspace.