Workspaces - Set Network Communication Policy

Servizio:
Core
Versione API:
v1

Imposta i criteri di comunicazione di rete per l'area di lavoro specificata.
Questa API usa il metodo PUT e sovrascrive tutte le impostazioni. Se nel corpo della richiesta vengono forniti solo criteri parziali, le impostazioni rimanenti vengono impostate sui valori predefiniti. Chiamare sempre prima l'operazione Get Network Communication Policy (Ottieni criteri di comunicazione di rete) e fornire il criterio completo nel corpo della richiesta.

Note

Se defaultAction viene omesso dal corpo della richiesta, l'impostazione predefinita è , che potrebbe aprire involontariamente Allowl'accesso alla rete in ingresso e in uscita. Specificare defaultAction sempre in modo esplicito in ogni corpo della richiesta PUT.

Permissions

Il chiamante deve avere ruolo amministratore'area di lavoro.

Ambiti delegati obbligatori

Workspace.ReadWrite.All

Microsoft Entra identità supportate

Questa API supporta le identità di Microsoft elencate in questa sezione.

Identità Support
User Yes
Principale del servizio e Identità gestite Yes

Interfaccia

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
workspaceId
 path True

string (uuid)

ID dell'area di lavoro.

Intestazione della richiesta

Nome Necessario Tipo Descrizione
If-Match

string

Valore ETag. L'ETag deve essere specificato tra virgolette. Se specificato, la chiamata avrà esito positivo solo se l'ETag della risorsa corrisponde all'ETag specificato.

Corpo della richiesta

Nome Tipo Descrizione
inbound

InboundRules

Proprietà delle comunicazioni di rete in ingresso per un'area di lavoro.
outbound

OutboundRules

Proprietà delle comunicazioni di rete in uscita per un'area di lavoro.

Risposte

Nome Tipo Descrizione
200 OK

Richiesta completata correttamente.

Intestazioni

ETag: string
429 Too Many Requests

ErrorResponse

È stato superato il limite di velocità del servizio. Il server restituisce un'intestazione Retry-After che indica, in secondi, per quanto tempo il client deve attendere prima di inviare richieste aggiuntive.

Intestazioni

Retry-After: integer
Other Status Codes

ErrorResponse

Codici di errore comuni:

  • UnknownError: si è verificato un errore.

Esempio

Set workspace networking communication policy example

Esempio di richiesta

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

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

Risposta di esempio

Codice di stato:
200 
ETag: 0f8fad5b-d9cb-469f-a165-70867728950e

Definizioni

Nome Descrizione
ErrorRelatedResource

Oggetto dettagli risorsa correlato all'errore.
ErrorResponse

Risposta di errore.
ErrorResponseDetails

Dettagli della risposta di errore.
InboundRules

Criteri per tutte le comunicazioni in ingresso a un'area di lavoro.
NetworkAccessRule

Criterio predefinito per l'accesso all'area di lavoro dalle reti pubbliche. Se omesso da un corpo della richiesta PUT, per impostazione predefinita questo campo è Allow, che potrebbe aprire involontariamente l'accesso alla rete. Specificare sempre in modo esplicito questo campo in ogni corpo della richiesta PUT.
NetworkRules

I criteri che definiscono l'accesso a/da un'area di lavoro a/da reti pubbliche.
OutboundRules

Criteri per tutte le comunicazioni in uscita da un'area di lavoro.
WorkspaceNetworkingCommunicationPolicy

Criteri di comunicazione di rete per un'area di lavoro.

ErrorRelatedResource

Oggetto

Oggetto dettagli risorsa correlato all'errore.

Nome Tipo Descrizione
resourceId

string

ID risorsa coinvolto nell'errore.
resourceType

string

Tipo della risorsa coinvolta nell'errore.

ErrorResponse

Oggetto

Risposta di errore.

Nome Tipo Descrizione
errorCode

string

Identificatore specifico che fornisce informazioni su una condizione di errore, consentendo la comunicazione standardizzata tra il servizio e i relativi utenti.
isRetriable

boolean

Se true, la richiesta può essere ritentata. Usare l'intestazione della Retry-After risposta per determinare il ritardo, se disponibile.
message

string

Rappresentazione leggibile dell'errore.
moreDetails

ErrorResponseDetails[]

Elenco di dettagli aggiuntivi sull'errore.
relatedResource

ErrorRelatedResource

Dettagli della risorsa correlati all'errore.
requestId

string (uuid)

ID della richiesta associata all'errore.

ErrorResponseDetails

Oggetto

Dettagli della risposta di errore.

Nome Tipo Descrizione
errorCode

string

Identificatore specifico che fornisce informazioni su una condizione di errore, consentendo la comunicazione standardizzata tra il servizio e i relativi utenti.
message

string

Rappresentazione leggibile dell'errore.
relatedResource

ErrorRelatedResource

Dettagli della risorsa correlati all'errore.

InboundRules

Oggetto

Criteri per tutte le comunicazioni in ingresso a un'area di lavoro.

Nome Tipo Descrizione
publicAccessRules

NetworkRules

Criteri per le comunicazioni in ingresso a un'area di lavoro da reti pubbliche.

NetworkAccessRule

Enumerazione

Criterio predefinito per l'accesso all'area di lavoro dalle reti pubbliche. Se omesso da un corpo della richiesta PUT, per impostazione predefinita questo campo è Allow, che potrebbe aprire involontariamente l'accesso alla rete. Specificare sempre in modo esplicito questo campo in ogni corpo della richiesta PUT.

Valore Descrizione
Allow

Consenti tutte le connessioni.
Deny

Nega tutte le connessioni.

NetworkRules

Oggetto

I criteri che definiscono l'accesso a/da un'area di lavoro a/da reti pubbliche.

Nome Tipo Descrizione
defaultAction

NetworkAccessRule

Criterio predefinito per l'accesso all'area di lavoro dalle reti pubbliche. Se omesso da un corpo della richiesta PUT, per impostazione predefinita questo campo è Allow, che potrebbe aprire involontariamente l'accesso alla rete. Specificare sempre in modo esplicito questo campo in ogni corpo della richiesta PUT.

OutboundRules

Oggetto

Criteri per tutte le comunicazioni in uscita da un'area di lavoro.

Nome Tipo Descrizione
publicAccessRules

NetworkRules

Criteri per le comunicazioni in uscita verso reti pubbliche da un'area di lavoro.

WorkspaceNetworkingCommunicationPolicy

Oggetto

Criteri di comunicazione di rete per un'area di lavoro.

Nome Tipo Descrizione
inbound

InboundRules

Proprietà delle comunicazioni di rete in ingresso per un'area di lavoro.
outbound

OutboundRules

Proprietà delle comunicazioni di rete in uscita per un'area di lavoro.