Workspaces - Update Workspace

Service:: 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

Limiti della limitazione delle richieste

Tipo di limite	Value
Quota unificata per le API della piattaforma	500 chiamate/min
Limite API	200 chiamate/min

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

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.

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",
  "capacityRegion": "East US"
}

Definizioni

Nome	Descrizione
CapacityRegion	Area della capacità associata a questa area di lavoro. È possibile aggiungere altri valori dell'area di capacità nel tempo.
ErrorParameter	Parametro strutturato che fornisce un contesto aggiuntivo leggibile dal computer relativo a un errore.
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.
WorkspaceAppliedTag	Rappresenta un tag applicato.
WorkspaceType	Tipo di area di lavoro. È possibile aggiungere altri tipi di area di lavoro nel tempo.

CapacityRegion

Enumerazione

Area della capacità associata a questa area di lavoro. È possibile aggiungere altri valori dell'area di capacità nel tempo.

Valore	Descrizione
Australia East	Australia orientale
Australia Southeast	Australia sud-orientale
Brazil South	Regione Brasile meridionale
Brazil Southeast	Area brasile sud-orientale
Canada Central	Area centrale del Canada
Canada East	Area canada orientale
Central India	Area india centrale
Central US	Area Stati Uniti centrali
Central US EUAP	Area UEAP stati Uniti centrali
East Asia	Area Asia orientale
East US	Area Stati Uniti orientali
East US 2	Area Stati Uniti orientali 2
France Central	Francia centrale
France South	Regione Francia meridionale
Germany Central	Area centrale germania
Germany Northeast	Germania nord-orientale
Israel Central	Israele Centrale
Italy North	Italia Nord
Japan East	Giappone orientale
Japan West	Giappone occidentale
Korea Central	Corea centrale
Korea South	Corea del Sud
Mexico Central	Area centrale del Messico
North Central US	Area Stati Uniti centro-settentrionali
North Europe	Area Europa settentrionale
Norway East	Norvegia orientale
Norway West	Norvegia occidentale
Poland Central	Polonia Centrale
South Africa North	Area del Nord Africa
South Africa West	Sud Africa occidentale
South Central US	Area Stati Uniti centro-meridionali
South India	India meridionale
Southeast Asia	Area Asia sud-orientale
Spain Central	Spagna Centrale
Sweden Central	Regione centrale della Svezia
Switzerland North	Svizzera Settentrionale
Switzerland West	Svizzera occidentale
West Europe	Area Europa occidentale
West India	Area india occidentale
West US	Area Stati Uniti occidentali
West US 2	Area Stati Uniti occidentali 2
West US 3	Area Stati Uniti occidentali 3
West Central US	Area Stati Uniti centro-occidentali
UAE Central	Emirati Arabi Uniti centrali
UAE North	Emirati Arabi Uniti settentrionali
Qatar Central	Area centrale del Qatar
Germany West Central	Germania centro-occidentale
Germany North	Area nord della Germania
UK South	Regno Unito meridionale
UK West	Area Regno Unito occidentale
China North	Cina settentrionale
China East	Area Cina orientale
China East 2	Area Cina orientale 2
China East 3	Area Cina orientale 3
China North 2	Cina settentrionale 2 area
China North 3	Cina settentrionale 3 area

ErrorParameter

Oggetto

Parametro strutturato che fornisce un contesto aggiuntivo leggibile dal computer relativo a un errore.

Nome	Tipo	Descrizione
message	string	Descrizione leggibile del significato del parametro.
name	string	L'identificatore dei parametri.
value	string	Valore del parametro.

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.
isRetriable	boolean	Se true, la richiesta può essere ritentata. Usare l'intestazione della `Retry-After` risposta per determinare il ritardo, se disponibile.
message	string	Rappresentazione leggibile dell'errore.
moreDetails	ErrorResponseDetails[]	Elenco di dettagli aggiuntivi sull'errore.
parameters	ErrorParameter[]	Parametri strutturati che forniscono un contesto aggiuntivo leggibile dal computer 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.
parameters	ErrorParameter[]	Parametri strutturati che forniscono un contesto aggiuntivo leggibile dal computer sull'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.
capacityRegion	CapacityRegion	Area della capacità associata a questa 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.
tags	WorkspaceAppliedTag[]	Elenco di tag applicati.
type	WorkspaceType	Tipo di area di lavoro.

WorkspaceAppliedTag

Oggetto

Rappresenta un tag applicato.

Nome	Tipo	Descrizione
displayName	string	Nome del tag.
id	string (uuid)	ID tag.

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.