Workspaces - Update Workspace

Servizio:

Core

Versione API:

v1

Aggiorna le proprietà dell'area di lavoro specificate.

Autorizzazioni

Il chiamante deve avere ruolo amministratore'area di lavoro.

Ambiti delegati obbligatori

SpazioDiLavoro.LetturaScrittura.Tutti

Identità supportate da Microsoft Entra

Questa API supporta le identità di Microsoft elencate in questa sezione.

Identità	Assistenza
Utente	Sì
Principale del servizio e Identità gestite	Sì

Interfaccia

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
workspaceId	path	True	string (uuid)	L’ID dell’area di lavoro.

Corpo della richiesta

Nome	Tipo	Descrizione
description	string	Descrizione dell'area di lavoro. La descrizione non può contenere più di 4000 caratteri.
displayName	string	Nome visualizzato dell'area di lavoro. Il nome visualizzato non può contenere più di 256 caratteri. I nomi delle aree di lavoro devono essere univoci all'interno del tenant. "Monitoraggio amministratore" è un nome di area di lavoro riservata.

Risposte

Nome	Tipo	Descrizione
200 OK	Workspace	Richiesta completata correttamente.
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

Update a workspace example

Esempio di richiesta

HTTP

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

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

Risposta di esempio

Codice di stato:

200

{
  "id": "33bae707-5fe7-4352-89bd-061a1318b60a",
  "displayName": "Workspace New displayName",
  "description": "Workspace New description",
  "type": "Workspace",
  "domainId": "686177b9-ef29-45e4-a5db-1786ca6dbb9f"
}

Definizioni

Nome	Descrizione
ErrorRelatedResource	Oggetto dettagli risorsa correlato all'errore.
ErrorResponse	Risposta di errore.
ErrorResponseDetails	Dettagli della risposta di errore.
UpdateWorkspaceRequest	Aggiornare il payload della richiesta dell'area di lavoro.
Workspace	Oggetto dell'area di lavoro.
WorkspaceType	Tipo di area di lavoro. È possibile aggiungere altri tipi di area di lavoro nel tempo.

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

UpdateWorkspaceRequest

Oggetto

Aggiornare il payload della richiesta dell'area di lavoro.

Nome	Tipo	Descrizione
description	string	Descrizione dell'area di lavoro. La descrizione non può contenere più di 4000 caratteri.
displayName	string	Nome visualizzato dell'area di lavoro. Il nome visualizzato non può contenere più di 256 caratteri. I nomi delle aree di lavoro devono essere univoci all'interno del tenant. "Monitoraggio amministratore" è un nome di area di lavoro riservata.

Workspace

Oggetto

Oggetto dell'area di lavoro.

Nome	Tipo	Descrizione
apiEndpoint	string (uri)	URL HTTP che rappresenta l'endpoint API specifico dell'area di lavoro. Questo valore dell'endpoint viene restituito quando l'utente abilita preferWorkspaceSpecificEndpoints. Consente l'accesso all'API tramite collegamenti privati.
capacityId	string (uuid)	ID della capacità a cui è assegnata l'area di lavoro.
description	string	Descrizione dell'area di lavoro.
displayName	string	Nome visualizzato dell'area di lavoro.
domainId	string (uuid)	ID del dominio a cui è assegnata l'area di lavoro.
id	string (uuid)	L’ID dell’area di lavoro.
type	WorkspaceType	Tipo di area di lavoro.

WorkspaceType

Enumerazione

Tipo di area di lavoro. È possibile aggiungere altri tipi di area di lavoro nel tempo.

Valore	Descrizione
Personal	La cartella o l'area di lavoro personale usata per gestire gli elementi utente.
Workspace	Area di lavoro usata per gestire gli elementi dell'infrastruttura.
AdminWorkspace	Area di lavoro monitoraggio amministratore. Contiene report di amministratore, ad esempio il report di controllo e il report sull'utilizzo e l'adozione.