Workspaces - Set Network Communication Policy

Service:: Core

Version d’API:: v1

Définit la stratégie de communication réseau pour l’espace de travail spécifié.
Cette API utilise la méthode PUT et remplace tous les paramètres. Si seule une stratégie partielle est fournie dans le corps de la requête, les paramètres restants sont définis sur les valeurs par défaut. Appelez toujours l’opération Obtenir la stratégie de communication réseau 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 involontairement ouvrir l’accès réseau entrant et sortant. 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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
workspaceId	path	True	string (uuid)	ID de l’espace de travail.

En-tête de la demande

Nom	Obligatoire	Type	Description
If-Match		string	Valeur ETag. L’ETag doit être spécifié entre guillemets. Si elle est fournie, l’appel réussit uniquement si l’ETag de la ressource correspond à l’ETag fourni.

Corps de la demande

Nom	Type	Description
inbound	InboundRules	Propriétés des communications réseau entrantes d’un espace de travail.
outbound	OutboundRules	Propriétés des communications réseau sortantes pour un espace de travail.

Réponses

Nom Type Description

200 OK

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.

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 networking communication policy example

Exemple de requête

HTTP

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

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

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.
InboundRules	Stratégie pour toutes les communications entrantes vers un espace de travail.
NetworkAccessRule	Stratégie par défaut pour l’accès à l’espace de travail à partir de réseaux publics. S’il est omis `Allow`d’un corps de requête PUT, ce champ est défini par défaut sur , ce qui peut ouvrir involontairement l’accès réseau. Spécifiez toujours explicitement ce champ dans chaque corps de requête PUT.
NetworkRules	Stratégie définissant l’accès à/partir d’un espace de travail vers/depuis des réseaux publics.
OutboundRules	Stratégie pour toutes les communications sortantes à partir d’un espace de travail.
WorkspaceNetworkingCommunicationPolicy	Stratégie de communication réseau pour un espace de travail.

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.

InboundRules

Objet

Stratégie pour toutes les communications entrantes vers un espace de travail.

Nom	Type	Description
publicAccessRules	NetworkRules	Stratégie pour les communications entrantes vers un espace de travail à partir de réseaux publics.

NetworkAccessRule

Énumération

Stratégie par défaut pour l’accès à l’espace de travail à partir de réseaux publics. S’il est omis Allowd’un corps de requête PUT, ce champ est défini par défaut sur , ce qui peut ouvrir involontairement l’accès réseau. Spécifiez toujours explicitement ce champ dans chaque corps de requête PUT.

Valeur	Description
Allow	Autoriser toutes les connexions.
Deny	Refuser toutes les connexions.

NetworkRules

Objet

Stratégie définissant l’accès à/partir d’un espace de travail vers/depuis des réseaux publics.

Nom	Type	Description
defaultAction	NetworkAccessRule	Stratégie par défaut pour l’accès à l’espace de travail à partir de réseaux publics. S’il est omis `Allow`d’un corps de requête PUT, ce champ est défini par défaut sur , ce qui peut ouvrir involontairement l’accès réseau. Spécifiez toujours explicitement ce champ dans chaque corps de requête PUT.

OutboundRules

Objet

Stratégie pour toutes les communications sortantes à partir d’un espace de travail.

Nom	Type	Description
publicAccessRules	NetworkRules	Stratégie pour les communications sortantes vers des réseaux publics à partir d’un espace de travail.

WorkspaceNetworkingCommunicationPolicy

Objet

Stratégie de communication réseau pour un espace de travail.

Nom	Type	Description
inbound	InboundRules	Propriétés des communications réseau entrantes d’un espace de travail.
outbound	OutboundRules	Propriétés des communications réseau sortantes pour un espace de travail.