Workspaces - Update Workspace

Tjeneste:

Core

API-version:

v1

Opdaterer de angivne egenskaber for arbejdsområdet.

Permissions

Kalderen skal have administrator arbejdsområderolle.

Påkrævede delegerede områder

Workspace.ReadWrite.All

Microsoft Entra-understøttede identiteter

Denne API understøtter de Microsoft -identiteter, der angivet i dette afsnit.

Identity	Støtte
User	Yes
tjenesteprincipal og administrerede identiteter	Yes

Interface

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

URI-parametre

Name	I	Påkrævet	Type	Beskrivelse
workspaceId	path	True	string (uuid)	Arbejdsområde-id'et.

Brødtekst for anmodning

Name	Type	Beskrivelse
description	string	Beskrivelsen af arbejdsområdet. Beskrivelsen må ikke indeholde mere end 4000 tegn.
displayName	string	Det viste navn på arbejdsområdet. Det viste navn må ikke indeholde mere end 256 tegn. Arbejdsområdenavne skal være entydige i lejeren. "Administratorovervågning" er et reserveret arbejdsområdenavn.

Svar

Name	Type	Beskrivelse
200 OK	Workspace	Anmodningen blev fuldført.
429 Too Many Requests	ErrorResponse	Grænsen for tjenestetakst blev overskredet. Serveren returnerer en Retry-After header, der angiver, i sekunder, hvor længe klienten skal vente, før der sendes yderligere anmodninger. Headere Retry-After: integer
Other Status Codes	ErrorResponse	Almindelige fejlkoder: UnknownError – Der opstod en fejl.

Eksempler

Update a workspace example

Eksempelanmodning

HTTP

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

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

Eksempelsvar

Statuskode:

200

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

Definitioner

Name	Beskrivelse
ErrorRelatedResource	Objektet med fejlrelaterede ressourceoplysninger.
ErrorResponse	Fejlsvaret.
ErrorResponseDetails	Oplysninger om fejlsvar.
UpdateWorkspaceRequest	Opdater nyttedata for anmodning om arbejdsområde.
Workspace	Et arbejdsområdeobjekt.
WorkspaceType	En arbejdsområdetype. Der kan tilføjes flere typer arbejdsområder over tid.

ErrorRelatedResource

Objekt

Objektet med fejlrelaterede ressourceoplysninger.

Name	Type	Beskrivelse
resourceId	string	Det ressource-id, der er involveret i fejlen.
resourceType	string	Typen af ressource, der er involveret i fejlen.

ErrorResponse

Objekt

Fejlsvaret.

Name	Type	Beskrivelse
errorCode	string	Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
message	string	En menneskelig læsbar gengivelse af fejlen.
moreDetails	ErrorResponseDetails[]	Liste over yderligere oplysninger om fejl.
relatedResource	ErrorRelatedResource	De fejlrelaterede ressourceoplysninger.
requestId	string (uuid)	Id'et for den anmodning, der er knyttet til fejlen.

ErrorResponseDetails

Objekt

Oplysninger om fejlsvar.

Name	Type	Beskrivelse
errorCode	string	Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
message	string	En menneskelig læsbar gengivelse af fejlen.
relatedResource	ErrorRelatedResource	De fejlrelaterede ressourceoplysninger.

UpdateWorkspaceRequest

Objekt

Opdater nyttedata for anmodning om arbejdsområde.

Name	Type	Beskrivelse
description	string	Beskrivelsen af arbejdsområdet. Beskrivelsen må ikke indeholde mere end 4000 tegn.
displayName	string	Det viste navn på arbejdsområdet. Det viste navn må ikke indeholde mere end 256 tegn. Arbejdsområdenavne skal være entydige i lejeren. "Administratorovervågning" er et reserveret arbejdsområdenavn.

Workspace

Objekt

Et arbejdsområdeobjekt.

Name	Type	Beskrivelse
apiEndpoint	string (uri)	HTTP URL-adresse, der repræsenterer det API-slutpunkt, der er specifikt for arbejdsområdet. Denne slutpunktsværdi returneres, når brugeren aktiverer preferWorkspaceSpecificEndpoints. Det giver API-adgang via private links.
capacityId	string (uuid)	Id'et for den kapacitet, arbejdsområdet er tildelt til.
description	string	Beskrivelsen af arbejdsområdet.
displayName	string	Det viste navn på arbejdsområdet.
domainId	string (uuid)	Id'et for det domæne, arbejdsområdet er tildelt til.
id	string (uuid)	Arbejdsområde-id'et.
type	WorkspaceType	Arbejdsområdetypen.

WorkspaceType

Optælling

En arbejdsområdetype. Der kan tilføjes flere typer arbejdsområder over tid.

Værdi	Beskrivelse
Personal	Min mappe eller Mit arbejdsområde, der bruges til at administrere brugerelementer.
Workspace	Arbejdsområde, der bruges til at administrere Fabric-elementerne.
AdminWorkspace	Administrationsovervågningsarbejdsområde. Indeholder administratorrapporter, f.eks. overvågningsrapporten og forbrugs- og indføringsrapporten.