Workspaces - Set Firewall Rules

Servizio:
Core
Versione API:
v1

Imposta le regole del firewall IP per l'area di lavoro. Questa API consente agli amministratori dell'area di lavoro di impostare regole del firewall IP che controllano quali indirizzi IP devono essere autorizzati a connettersi all'area di lavoro. Questa funzionalità è attualmente disponibile solo in anteprima.

Note

Questa API fa parte di una versione di anteprima e viene fornita solo a scopo di valutazione e sviluppo. Può cambiare in base al feedback e non è consigliato per l'uso in produzione.

Note

Le regole del firewall vengono applicate solo se i criteri di comunicazione di rete dell'area di lavoro hanno inbound.publicAccessRules.defaultAction impostato su Deny. Se l'accesso pubblico non è bloccato nell'area di lavoro, le chiamate API a questa area di lavoro non verranno limitate.

Note

Questa API usa il metodo PUT e sovrascriverà tutte le regole del firewall IP per l'area di lavoro. Eseguire sempre Get first e fornire tutte le regole del firewall IP nel corpo della richiesta.

Autorizzazioni

Il chiamante deve avere ruolo amministratore'area di lavoro.

Ambiti delegati obbligatori

SpazioDiLavoro.LetturaScrittura.Tutti

Identità supportate da Microsoft Entra

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

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

Interfaccia

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
workspaceId
 path True

string (uuid)

Identificatore univoco dell'area di lavoro da aggiornare.

Corpo della richiesta

Nome Tipo Descrizione
rules

FirewallRule[]

Elenco di regole che definiscono gli indirizzi IP consentiti per l'accesso in ingresso. Ogni regola può includere un nome e un singolo indirizzo IP, un intervallo di indirizzi IP o un indirizzo IP CIDR. È possibile specificare un massimo di 256 regole per area di lavoro.

Risposte

Nome Tipo Descrizione
200 OK

La richiesta è stata completata correttamente e non ha contenuto nel corpo della risposta.

Intestazioni:

Etagstring - Nuovo ETag della configurazione del firewall dopo l'aggiornamento. Usare questo valore nell'intestazione della If-Match chiamata PUT successiva per applicare il controllo della concorrenza ottimistica.
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

Example for setting workspace firewall rules

Esempio di richiesta

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"
    }
  ]
}

Risposta di esempio

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

Definizioni

Nome Descrizione
ErrorRelatedResource

Oggetto dei dettagli della risorsa relativo all'errore.
ErrorResponse

Risposta di errore.
ErrorResponseDetails

Dettagli della risposta di errore.
FirewallRule

Definisce una regola del firewall, identificata dal nome e contenente un singolo indirizzo IP, un intervallo di indirizzi IP o un indirizzo IP CIDR come valore.
InboundFirewallConfiguration

Questo oggetto definisce il set completo di regole del firewall per gestire la protezione dell'accesso in ingresso come parte dei criteri di comunicazione di rete di un'area di lavoro. Garantisce che solo gli indirizzi IP autorizzati in modo esplicito siano consentiti per le comunicazioni in ingresso. Quando viene inviato tramite l'API PUT, questo oggetto crea o sostituisce completamente la configurazione del firewall IP esistente per l'area di lavoro. Queste regole vengono applicate solo quando i criteri di comunicazione di rete dell'area di lavoro hanno inbound.publicAccessRules.defaultAction impostato su Deny.

ErrorRelatedResource

Oggetto

Oggetto dei dettagli della risorsa relativo 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.

FirewallRule

Oggetto

Definisce una regola del firewall, identificata dal nome e contenente un singolo indirizzo IP, un intervallo di indirizzi IP o un indirizzo IP CIDR come valore.

Nome Tipo Descrizione
displayName

string

Specifica il nome della regola. I nomi visualizzati possono avere una lunghezza massima di 128 caratteri e devono essere univoci per ogni area di lavoro.
value

string

Specifica il valore della regola, specificato come un singolo indirizzo IP, un intervallo di indirizzi IP o un indirizzo IP CIDR.

InboundFirewallConfiguration

Oggetto

Questo oggetto definisce il set completo di regole del firewall per gestire la protezione dell'accesso in ingresso come parte dei criteri di comunicazione di rete di un'area di lavoro. Garantisce che solo gli indirizzi IP autorizzati in modo esplicito siano consentiti per le comunicazioni in ingresso. Quando viene inviato tramite l'API PUT, questo oggetto crea o sostituisce completamente la configurazione del firewall IP esistente per l'area di lavoro. Queste regole vengono applicate solo quando i criteri di comunicazione di rete dell'area di lavoro hanno inbound.publicAccessRules.defaultAction impostato su Deny.

Nome Tipo Descrizione
rules

FirewallRule[]

Elenco di regole che definiscono gli indirizzi IP consentiti per l'accesso in ingresso. Ogni regola può includere un nome e un singolo indirizzo IP, un intervallo di indirizzi IP o un indirizzo IP CIDR. È possibile specificare un massimo di 256 regole per area di lavoro.