Workspaces - Set Outbound Cloud Connection Rules

Servizio:: Core

Versione API:: v1

Imposta le regole di connessione cloud di protezione dall'accesso in uscita per l'area di lavoro.
Questa API consente agli amministratori dell'area di lavoro di impostare una raccolta di regole di comunicazione di rete in uscita che controllano quali tipi di connessione cloud e, ove applicabile, gli endpoint esterni o le aree di lavoro sono consentiti dall'area di lavoro.

Annotazioni

Le regole di protezione dell'accesso in uscita vengono applicate solo se i criteri di comunicazione di rete dell'area di lavoro sono outbound.publicAccessRules.defaultAction impostati su Deny. Se OAP non è abilitato nell'area di lavoro, l'API non riesce perché le connessioni in uscita non sono limitate.

Annotazioni

Questa API usa il metodo PUT e sovrascrive tutte le connessioni di accesso in uscita per l'area di lavoro. Chiamare sempre prima l'operazione Get Outbound Cloud Connection Rules (Ottieni regole di connessione cloud in uscita) e fornire il criterio completo nel corpo della richiesta.

Annotazioni

Se defaultAction viene omesso dal corpo della richiesta, l'impostazione predefinita è , che potrebbe consentire involontariamente Allowtutte le connessioni cloud 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

SpazioDiLavoro.LetturaScrittura.Tutti

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/outbound/connections

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
defaultAction	ConnectionAccessActionType	Definisce il comportamento predefinito per tutti i tipi di connessione cloud non elencati in modo esplicito nella matrice di regole. Se è impostato su "Consenti", tutti i tipi di connessione non specificati sono consentiti per impostazione predefinita. Se impostato su "Deny", tutti i tipi di connessione non specificati vengono bloccati per impostazione predefinita, a meno che non siano consentiti in modo esplicito. Questa impostazione funge da criterio di fallback globale ed è fondamentale per applicare un comportamento predefinito sicuro negli ambienti in cui devono essere consentite solo connessioni note e attendibili. Se omesso da un corpo della richiesta PUT, per impostazione predefinita questo campo è , che potrebbe consentire involontariamente `Allow`tutte le connessioni in uscita. Specificare sempre in modo esplicito questo campo in ogni corpo della richiesta PUT.
rules	OutboundConnectionRule[]	Elenco di regole che definiscono il comportamento di accesso in uscita per tipi di connessione cloud specifici. Ogni regola può includere restrizioni basate su endpoint o basate sull'area di lavoro a seconda dei tipi di connessione supportati.

Risposte

Nome Tipo Descrizione

200 OK

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.

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 outbound access protection cloud connection rule for example

Esempio di richiesta

HTTP

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

{
  "defaultAction": "Deny",
  "rules": [
    {
      "connectionType": "SQL",
      "defaultAction": "Deny",
      "allowedEndpoints": [
        {
          "hostnamePattern": "*.microsoft.com"
        }
      ]
    },
    {
      "connectionType": "LakeHouse",
      "defaultAction": "Deny",
      "allowedWorkspaces": [
        {
          "workspaceId": "91c5ae74-e82d-4dd3-bfeb-6b1814030123"
        }
      ]
    },
    {
      "connectionType": "Web",
      "defaultAction": "Allow"
    }
  ]
}

Risposta di esempio

Codice di stato:: 200

ETag: 0f8fad5b-d9cb-469f-a165-70867728950e

Definizioni

Nome	Descrizione
ConnectionAccessActionType	Definisce il comportamento di controllo di accesso per le connessioni in uscita. Questa enumerazione viene utilizzata per il campo defaultAction per specificare se la comunicazione in uscita deve essere consentita o negata per impostazione predefinita. Questo tipo consente sia il controllo globale che specifico della connessione sull'accesso in uscita, consentendo di applicare criteri di comunicazione di rete sicuri e prevedibili. È possibile aggiungere altri tipi di azione di accesso alla connessione nel tempo.
ConnectionRuleEndpointMetadata	Rappresenta una singola regola di eccezione a livello di endpoint che consente la comunicazione in uscita a un dominio o a un host esterno specifico. Questo oggetto viene usato all'interno della matrice allowedEndpoints di una regola di connessione per autorizzare in modo esplicito l'accesso in uscita agli endpoint attendibili per un determinato connectionType. Questo è applicabile solo ai tipi di connessione che supportano il filtro basato su endpoint ,ad esempio SQL, MySQL, Web e così via.
ConnectionRuleWorkspaceMetadata	Rappresenta una regola di eccezione a livello di area di lavoro che consente la comunicazione in uscita a un'area di lavoro specifica per un determinato connectionType. Questo oggetto viene usato all'interno della matrice allowedWorkspaces di una regola di connessione per autorizzare in modo esplicito l'accesso tra aree di lavoro. Questo è applicabile solo ai tipi di connessione che supportano il filtro basato sull'area di lavoro, ad esempio Lakehouse, Warehouse, FabricSql e PowerPlatformDataflows.
ErrorRelatedResource	Oggetto dettagli risorsa correlato all'errore.
ErrorResponse	Risposta di errore.
ErrorResponseDetails	Dettagli della risposta di errore.
OutboundConnectionRule	Definisce una regola di accesso in uscita per una connessione cloud specifica.
WorkspaceOutboundConnections	Rappresenta il set completo di regole di connessione cloud per la protezione dell'accesso in uscita configurate per un'area di lavoro come parte dei criteri di comunicazione di rete. Questo oggetto definisce le regole di connessione che regolano quali endpoint esterni e aree di lavoro sono consentiti o negati per la comunicazione in uscita

ConnectionAccessActionType

Enumerazione

Definisce il comportamento di controllo di accesso per le connessioni in uscita. Questa enumerazione viene utilizzata per il campo defaultAction per specificare se la comunicazione in uscita deve essere consentita o negata per impostazione predefinita. Questo tipo consente sia il controllo globale che specifico della connessione sull'accesso in uscita, consentendo di applicare criteri di comunicazione di rete sicuri e prevedibili. È possibile aggiungere altri tipi di azione di accesso alla connessione nel tempo.

Valore	Descrizione
Allow	Consente le connessioni in uscita. Se usato come azione predefinita, tutte le connessioni cloud sono consentite.
Deny	Blocca le connessioni in uscita. Se usato come azione predefinita, tutte le connessioni cloud vengono negate a meno che non siano consentite in modo esplicito.

ConnectionRuleEndpointMetadata

Oggetto

Rappresenta una singola regola di eccezione a livello di endpoint che consente la comunicazione in uscita a un dominio o a un host esterno specifico. Questo oggetto viene usato all'interno della matrice allowedEndpoints di una regola di connessione per autorizzare in modo esplicito l'accesso in uscita agli endpoint attendibili per un determinato connectionType. Questo è applicabile solo ai tipi di connessione che supportano il filtro basato su endpoint ,ad esempio SQL, MySQL, Web e così via.

Nome	Tipo	Descrizione
hostnamePattern	string	Modello supportato da caratteri jolly che definisce l'endpoint esterno consentito. Gli esempi includono *.microsoft.com, api.contoso.com o data.partner.org.

ConnectionRuleWorkspaceMetadata

Oggetto

Rappresenta una regola di eccezione a livello di area di lavoro che consente la comunicazione in uscita a un'area di lavoro specifica per un determinato connectionType. Questo oggetto viene usato all'interno della matrice allowedWorkspaces di una regola di connessione per autorizzare in modo esplicito l'accesso tra aree di lavoro. Questo è applicabile solo ai tipi di connessione che supportano il filtro basato sull'area di lavoro, ad esempio Lakehouse, Warehouse, FabricSql e PowerPlatformDataflows.

Nome	Tipo	Descrizione
workspaceId	string (uuid)	Identificatore univoco (GUID) dell'area di lavoro di destinazione che può essere connessa dall'area di lavoro corrente.

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.

OutboundConnectionRule

Oggetto

Definisce una regola di accesso in uscita per una connessione cloud specifica.

Nome	Tipo	Descrizione
allowedEndpoints	ConnectionRuleEndpointMetadata[]	Definisce un elenco di endpoint esterni consentiti in modo esplicito per connectionType. Ogni voce nella matrice rappresenta un modello hostname consentito per la comunicazione in uscita dall'area di lavoro. Questo campo è applicabile solo ai tipi di connessione che supportano il filtro basato su endpoint ,ad esempio SQL, MySQL, Web e così via. Se defaultAction è impostato su "Nega" per il tipo di connessione, saranno consentiti solo gli endpoint elencati qui; tutti gli altri saranno bloccati.
allowedWorkspaces	ConnectionRuleWorkspaceMetadata[]	Specifica un elenco di ID dell'area di lavoro consentiti in modo esplicito per la comunicazione in uscita per il connectionType dell'infrastruttura specificato. Questo campo è applicabile solo ai tipi di connessione dell'infrastruttura che supportano il filtro basato sull'area di lavoro, limitato a Lakehouse, Warehouse, FabricSql e PowerPlatformDataflows. Quando defaultAction è impostato su "Nega" per un tipo di connessione, solo le aree di lavoro elencate in allowedWorkspaces saranno consentite per l'accesso in uscita; tutti gli altri saranno bloccati.
connectionType	string	Specifica il tipo di connessione cloud a cui si applica la regola. Il comportamento e l'applicabilità di altre proprietà della regola , ad esempio allowedEndpoints o allowedWorkspaces, possono variare a seconda delle funzionalità del tipo di connessione.
defaultAction	ConnectionAccessActionType	Definisce il comportamento di accesso in uscita predefinito per connectionType. Questo campo determina se le connessioni di questo tipo sono consentite o bloccate per impostazione predefinita, a meno che non vengano ulteriormente perfezionate da allowedEndpoints o allowedWorkspaces. Se impostato su "Consenti": tutte le connessioni di questo tipo sono consentite a meno che non venga negato esplicitamente da una regola più specifica. Questo campo fornisce un controllo granulare su ogni tipo di connessione e integra il comportamento di fallback globale definito da defaultAction.

WorkspaceOutboundConnections

Oggetto

Rappresenta il set completo di regole di connessione cloud per la protezione dell'accesso in uscita configurate per un'area di lavoro come parte dei criteri di comunicazione di rete. Questo oggetto definisce le regole di connessione che regolano quali endpoint esterni e aree di lavoro sono consentiti o negati per la comunicazione in uscita

Nome	Tipo	Descrizione
defaultAction	ConnectionAccessActionType	Definisce il comportamento predefinito per tutti i tipi di connessione cloud non elencati in modo esplicito nella matrice di regole. Se è impostato su "Consenti", tutti i tipi di connessione non specificati sono consentiti per impostazione predefinita. Se impostato su "Deny", tutti i tipi di connessione non specificati vengono bloccati per impostazione predefinita, a meno che non siano consentiti in modo esplicito. Questa impostazione funge da criterio di fallback globale ed è fondamentale per applicare un comportamento predefinito sicuro negli ambienti in cui devono essere consentite solo connessioni note e attendibili. Se omesso da un corpo della richiesta PUT, per impostazione predefinita questo campo è , che potrebbe consentire involontariamente `Allow`tutte le connessioni in uscita. Specificare sempre in modo esplicito questo campo in ogni corpo della richiesta PUT.
rules	OutboundConnectionRule[]	Elenco di regole che definiscono il comportamento di accesso in uscita per tipi di connessione cloud specifici. Ogni regola può includere restrizioni basate su endpoint o basate sull'area di lavoro a seconda dei tipi di connessione supportati.