Workspaces - Set Outbound Gateway Rules

Service:
Core
Version d’API:
v1

Définit les règles de passerelle pour l’espace de travail activé avec la protection d’accès sortant (OAP).
Cette API permet aux administrateurs d’espace de travail de définir, remplacer ou remplacer l’ensemble de stratégies de communication réseau sortantes qui contrôlent les passerelles de données /Vnet locales à autoriser à partir de l’espace de travail actuel.

Note

Les règles de protection d’accès sortant sont appliquées uniquement si la stratégie de communication réseau de l’espace de travail a outbound.publicAccessRules.defaultAction la valeur Deny. Si OAP n’est pas activé sur l’espace de travail, l’API échoue, car les connexions sortantes ne sont pas restreintes.

Note

Cette API utilise la méthode PUT et remplace toutes les passerelles d’accès sortant pour l’espace de travail. Appelez toujours l’opération Get Gateway Rules en premier et fournissez la stratégie complète dans le corps de la requête.

Note

S’il defaultAction est omis Allowdu corps de la requête, il est défini par défaut sur , ce qui peut autoriser involontairement toutes les connexions de passerelle sortante. Spécifiez defaultAction toujours explicitement dans chaque corps de requête PUT.

Permissions

L’appelant doit avoir rôle d’administrateur espace de travail.

Étendues déléguées requises

Workspace.ReadWrite.All

Microsoft Entra identités prises en charge

Cette API prend en charge les identités Microsoft répertoriées dans cette section.

Identité Support
Utilisateur Oui
Service principal et identités gérées Oui

Interface

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

Paramètres URI

Nom Dans Obligatoire Type Description
workspaceId
 path True

string (uuid)

Identificateur unique de l’espace de travail à mettre à jour.

Corps de la demande

Nom Type Description
allowedGateways

GatewayAccessRuleMetadata[]

Liste de règles qui définissent le comportement d’accès sortant pour les passerelles.
defaultAction

GatewayAccessActionType

Définit le comportement par défaut pour toutes les passerelles qui ne sont pas explicitement répertoriées dans le tableau de listes autorisées. Si la valeur est « Autoriser », toutes les passerelles non spécifiées sont autorisées par défaut. Si la valeur est « Refuser », toutes les passerelles non spécifiées sont bloquées. S’il est omis Allowd’un corps de requête PUT, ce champ est défini par défaut sur , ce qui peut autoriser involontairement toutes les connexions de passerelle sortante. Spécifiez toujours explicitement ce champ dans chaque corps de requête PUT.

Réponses

Nom Type Description
200 OK

La demande s’est terminée avec succès.

En-têtes

ETag: string
429 Too Many Requests

ErrorResponse

La limite de débit de service a été dépassée. Le serveur retourne un Retry-After en-tête indiquant, en secondes, combien de temps le client doit attendre avant d’envoyer des demandes supplémentaires.

En-têtes

Retry-After: integer
Other Status Codes

ErrorResponse

Codes d’erreur courants :

  • UnknownError : une erreur s’est produite.

Exemples

Set workspace outbound access protection gateway rule for example

Exemple de requête

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

{
  "defaultAction": "Deny",
  "allowedGateways": [
    {
      "id": "91c5ae74-e82d-4dd3-bfeb-6b1814030123"
    },
    {
      "id": "25bac802-080d-4f73-8a42-1b406eb1fceb"
    }
  ]
}

Exemple de réponse

Code d’état:
200 
ETag: 0f8fad5b-d9cb-469f-a165-70867728950e

Définitions

Nom Description
ErrorRelatedResource

Objet de détails de ressource associé à l’erreur.
ErrorResponse

Réponse d’erreur.
ErrorResponseDetails

Détails de la réponse d’erreur.
GatewayAccessActionType

Définit le comportement du contrôle d’accès pour les passerelles sortantes. Cette énumération est utilisée pour le champ defaultAction pour spécifier si la communication sortante doit être autorisée ou refusée par défaut. Ce type permet à la fois un contrôle global et spécifique à la passerelle sur l’accès sortant, ce qui permet d’appliquer des stratégies de communication réseau sécurisées et prévisibles. Des types d’actions d’accès de passerelle supplémentaires peuvent être ajoutés au fil du temps.
GatewayAccessRuleMetadata

Représente une passerelle autorisée pour la communication sortante. Cet objet est utilisé dans les allowedGateways pour autoriser explicitement l’accès sortant.
WorkspaceOutboundGateways

Représente l’ensemble complet de règles de protection d’accès sortante de passerelle configurées pour un espace de travail dans le cadre de sa stratégie de communication réseau. Cet objet définit les règles de passerelle qui régissent la communication sortante

ErrorRelatedResource

Objet

Objet de détails de ressource associé à l’erreur.

Nom Type Description
resourceId

string

ID de ressource impliqué dans l’erreur.
resourceType

string

Type de la ressource impliquée dans l’erreur.

ErrorResponse

Objet

Réponse d’erreur.

Nom Type Description
errorCode

string

Identificateur spécifique qui fournit des informations sur une condition d’erreur, ce qui permet une communication standardisée entre notre service et ses utilisateurs.
isRetriable

boolean

Lorsque la valeur est true, la requête peut être retentée. Utilisez l’en-tête Retry-After de réponse pour déterminer le délai, le cas échéant.
message

string

Représentation lisible humaine de l’erreur.
moreDetails

ErrorResponseDetails[]

Liste des détails d’erreur supplémentaires.
relatedResource

ErrorRelatedResource

Détails de la ressource associée à l’erreur.
requestId

string (uuid)

ID de la demande associée à l’erreur.

ErrorResponseDetails

Objet

Détails de la réponse d’erreur.

Nom Type Description
errorCode

string

Identificateur spécifique qui fournit des informations sur une condition d’erreur, ce qui permet une communication standardisée entre notre service et ses utilisateurs.
message

string

Représentation lisible humaine de l’erreur.
relatedResource

ErrorRelatedResource

Détails de la ressource associée à l’erreur.

GatewayAccessActionType

Énumération

Définit le comportement du contrôle d’accès pour les passerelles sortantes. Cette énumération est utilisée pour le champ defaultAction pour spécifier si la communication sortante doit être autorisée ou refusée par défaut. Ce type permet à la fois un contrôle global et spécifique à la passerelle sur l’accès sortant, ce qui permet d’appliquer des stratégies de communication réseau sécurisées et prévisibles. Des types d’actions d’accès de passerelle supplémentaires peuvent être ajoutés au fil du temps.

Valeur Description
Allow

Autorise les passerelles sortantes. Lorsqu’elles sont utilisées comme action par défaut, toutes les passerelles sont autorisées.
Deny

Bloque les passerelles sortantes. Lorsqu’elles sont utilisées comme action par défaut, toutes les passerelles sont refusées, sauf autorisation explicite.

GatewayAccessRuleMetadata

Objet

Représente une passerelle autorisée pour la communication sortante. Cet objet est utilisé dans les allowedGateways pour autoriser explicitement l’accès sortant.

Nom Type Description
id

string (uuid)

ID de passerelle à autoriser.

WorkspaceOutboundGateways

Objet

Représente l’ensemble complet de règles de protection d’accès sortante de passerelle configurées pour un espace de travail dans le cadre de sa stratégie de communication réseau. Cet objet définit les règles de passerelle qui régissent la communication sortante

Nom Type Description
allowedGateways

GatewayAccessRuleMetadata[]

Liste de règles qui définissent le comportement d’accès sortant pour les passerelles.
defaultAction

GatewayAccessActionType

Définit le comportement par défaut pour toutes les passerelles qui ne sont pas explicitement répertoriées dans le tableau de listes autorisées. Si la valeur est « Autoriser », toutes les passerelles non spécifiées sont autorisées par défaut. Si la valeur est « Refuser », toutes les passerelles non spécifiées sont bloquées. S’il est omis Allowd’un corps de requête PUT, ce champ est défini par défaut sur , ce qui peut autoriser involontairement toutes les connexions de passerelle sortante. Spécifiez toujours explicitement ce champ dans chaque corps de requête PUT.