Partager via

Workspaces - Update Workspace

Service:
Core
Version d'API:
v1

Met à jour les propriétés d’espace de travail spécifiées.

Autorisations

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é Soutien
Utilisateur Oui
Service principal et identités gérées Oui

Interface

PATCH https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}

Paramètres URI

Nom Dans Obligatoire Type Description
workspaceId
 path True

string (uuid)

Identifiant de l’espace de travail.

Corps de la demande

Nom Type Description
description

string

Description de l’espace de travail.
La description ne peut pas contenir plus de 4 000 caractères.
displayName

string

Nom complet de l’espace de travail.
Le nom complet ne peut pas contenir plus de 256 caractères.
Les noms d’espace de travail doivent être uniques au sein du locataire.
« Surveillance de l’administrateur » est un nom d’espace de travail réservé.

Réponses

Nom Type Description
200 OK

Workspace

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

ErrorResponse

Codes d’erreur courants :

  • UnknownError : une erreur s’est produite.

Exemples

Update a workspace example

Exemple de requête

PATCH https://api.fabric.microsoft.com/v1/workspaces/33bae707-5fe7-4352-89bd-061a1318b60a

{
  "displayName": "Workspace New displayName",
  "description": "Workspace New description"
}

Exemple de réponse

Code d’état:
200 
{
  "id": "33bae707-5fe7-4352-89bd-061a1318b60a",
  "displayName": "Workspace New displayName",
  "description": "Workspace New description",
  "type": "Workspace"
}

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.
UpdateWorkspaceRequest

Mettre à jour la charge utile de la demande d’espace de travail.
Workspace

Objet d’espace de travail.
WorkspaceType

Type d’espace de travail. Des types d’espace de travail supplémentaires peuvent être ajoutés au fil du temps.

ErrorRelatedResource

Object

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

Object

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.
moreDetails

ErrorResponseDetails[]

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

ErrorRelatedResource

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

string

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

ErrorResponseDetails

Object

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.

UpdateWorkspaceRequest

Object

Mettre à jour la charge utile de la demande d’espace de travail.

Nom Type Description
description

string

Description de l’espace de travail.
La description ne peut pas contenir plus de 4 000 caractères.
displayName

string

Nom complet de l’espace de travail.
Le nom complet ne peut pas contenir plus de 256 caractères.
Les noms d’espace de travail doivent être uniques au sein du locataire.
« Surveillance de l’administrateur » est un nom d’espace de travail réservé.

Workspace

Object

Objet d’espace de travail.

Nom Type Description
apiEndpoint

string (uri)

URL HTTP qui représente le point de terminaison d’API spécifique à l’espace de travail. Cette valeur de point de terminaison est retournée lorsque l’utilisateur active preferWorkspaceSpecificEndpoints. Il permet l’accès aux API via des liaisons privées.
capacityId

string (uuid)

ID de la capacité à laquelle l’espace de travail est affecté.
description

string

Description de l’espace de travail.
displayName

string

Nom complet de l’espace de travail.
id

string (uuid)

Identifiant de l’espace de travail.
type

WorkspaceType

Type d’espace de travail.

WorkspaceType

Énumération

Type d’espace de travail. Des types d’espace de travail supplémentaires peuvent être ajoutés au fil du temps.

Valeur Description
Personal

Mon dossier ou mon espace de travail utilisé pour gérer les éléments utilisateur.
Workspace

Espace de travail utilisé pour gérer les éléments Fabric.
AdminWorkspace

Espace de travail de surveillance administrateur. Contient des rapports d’administration tels que le rapport d’audit et le rapport d’utilisation et d’adoption.