Workspaces - Set Firewall Rules

Service:: Core

Version d’API:: v1

Définit les règles de pare-feu IP pour l’espace de travail. Cette API permet aux administrateurs d’espace de travail de définir des règles de pare-feu IP qui contrôlent les adresses IP à autoriser à se connecter à l’espace de travail. Actuellement, cette fonctionnalité est uniquement disponible en tant que version préliminaire.

Note

Cette API fait partie d’une préversion et est fournie uniquement à des fins d’évaluation et de développement. Il peut changer en fonction des commentaires et n’est pas recommandé pour une utilisation en production.

Note

Les règles de pare-feu sont appliquées uniquement si la stratégie de communication réseau de l’espace de travail a défini sur Deny.publicAccessRules.defaultAction. Si l’accès public n’est pas bloqué sur l’espace de travail, les appels d’API à cet espace de travail ne seront pas restreints.

Note

Cette API utilise la méthode PUT et remplace toutes les règles de pare-feu IP de l’espace de travail. Exécutez toujours Get en premier et fournissez toutes les règles de pare-feu IP dans le corps de la requête.

Permissions

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

Étendues déléguées requises

Workspace.ReadWrite.All

Identités prises en charge par Microsoft Entra

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/inbound/firewall

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
rules	FirewallRule[]	Liste des règles qui définissent les adresses IP autorisées pour l’accès entrant. Chaque règle peut inclure un nom et une adresse IP unique, une plage d’adresses IP ou une adresse IP CIDR. Un maximum de 256 règles peut être spécifié par espace de travail.

Réponses

Nom Type Description

200 OK

Nom	Type	Description
200 OK		La demande s’est terminée correctement et n’a pas de contenu dans le corps de la réponse. En-têtes : Etag`string` - Nouvelle balise ETag de la configuration du pare-feu après la mise à jour. Utilisez cette valeur dans l’en-tête d’un `If-Match` appel PUT ultérieur pour appliquer le contrôle d’accès concurrentiel optimiste.
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.

La demande s’est terminée correctement et n’a pas de contenu dans le corps de la réponse.

En-têtes :

Etagstring - Nouvelle balise ETag de la configuration du pare-feu après la mise à jour. Utilisez cette valeur dans l’en-tête d’un If-Match appel PUT ultérieur pour appliquer le contrôle d’accès concurrentiel optimiste.

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

Example for setting workspace firewall rules

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:: 204

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.
FirewallRule	Définit une règle de pare-feu, identifiée par son nom et contenant une seule adresse IP, une plage d’adresses IP ou une adresse IP CIDR comme valeur.
InboundFirewallConfiguration	Cet objet définit l’ensemble complet de règles de pare-feu pour gérer la protection d’accès entrant dans le cadre de la stratégie de communication réseau d’un espace de travail. Elle garantit que seules les adresses IP explicitement autorisées sont autorisées pour la communication entrante. Lorsqu’il est envoyé via l’API PUT, cet objet crée ou remplace entièrement la configuration de pare-feu IP existante pour l’espace de travail. Ces règles sont appliquées uniquement lorsque la stratégie de communication réseau de l’espace de travail a inbound.publicAccessRules.defaultAction définie sur Deny.

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.

FirewallRule

Objet

Définit une règle de pare-feu, identifiée par son nom et contenant une seule adresse IP, une plage d’adresses IP ou une adresse IP CIDR comme valeur.

Nom	Type	Description
displayName	string	Spécifie le nom de la règle. Les noms d’affichage peuvent comporter jusqu’à 128 caractères et doivent être uniques par espace de travail.
value	string	Spécifie la valeur de la règle, spécifiée sous la forme d’une adresse IP unique, d’une plage d’adresses IP ou d’une adresse IP CIDR.

InboundFirewallConfiguration

Objet

Cet objet définit l’ensemble complet de règles de pare-feu pour gérer la protection d’accès entrant dans le cadre de la stratégie de communication réseau d’un espace de travail. Elle garantit que seules les adresses IP explicitement autorisées sont autorisées pour la communication entrante. Lorsqu’il est envoyé via l’API PUT, cet objet crée ou remplace entièrement la configuration de pare-feu IP existante pour l’espace de travail. Ces règles sont appliquées uniquement lorsque la stratégie de communication réseau de l’espace de travail a inbound.publicAccessRules.defaultAction définie sur Deny.

Nom	Type	Description
rules	FirewallRule[]	Liste des règles qui définissent les adresses IP autorisées pour l’accès entrant. Chaque règle peut inclure un nom et une adresse IP unique, une plage d’adresses IP ou une adresse IP CIDR. Un maximum de 256 règles peut être spécifié par espace de travail.