Workspaces - Update Workspace

Palvelu:

Core

Ohjelmointirajapinnan versio:

v1

Päivittää määritetyt työtilan ominaisuudet.

Oikeudet

Soittajalla on oltava järjestelmänvalvojan työtilan rooli.

Vaaditut delegoidut vaikutusalueet

Workspace.ReadWrite.All

Microsoft Entran tukemat käyttäjätiedot

Tämä ohjelmointirajapinta tukee tässä osiossa lueteltuja Microsoft -käyttäjätietoja.

Identiteetti	Tuki
Käyttäjä	Kyllä
palvelun päänimen ja Hallittujen käyttäjätietojen	Kyllä

Rajapinta

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

URI-parametrit

Nimi	Kohteessa	Pakollinen	Tyyppi	Description
workspaceId	path	True	string (uuid)	Työtilan tunnus.

Pyynnön leipäteksti

Nimi	Tyyppi	Description
description	string	Työtilan kuvaus. Kuvauksessa voi olla enintään 4 000 merkkiä.
displayName	string	Työtilan näyttönimi. Näyttönimi voi sisältää enintään 256 merkkiä. Työtilojen nimien on oltava yksilöllisiä vuokraajassa. Järjestelmänvalvojan valvonta on varattu työtilan nimi.

Vastaukset

Nimi	Tyyppi	Description
200 OK	Workspace	Pyynnön valmistuttua.
429 Too Many Requests	ErrorResponse	Palveluhinnan raja ylitettiin. Palvelin palauttaa otsikon, joka Retry-After ilmaisee sekunteina, kuinka kauan asiakkaan on odotettava, ennen kuin lisäpyynnöt lähetetään. Otsikot Retry-After: integer
Other Status Codes	ErrorResponse	Yleiset virhekoodit: UnknownError – Ilmeni virhe.

Esimerkit

Update a workspace example

Mallipyyntö

HTTP

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

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

Mallivastaus

Tilakoodi:

200

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

Määritelmät

Nimi	Description
ErrorRelatedResource	Virheeseen liittyvä resurssitieto-objekti.
ErrorResponse	Virhevastaus.
ErrorResponseDetails	Virheen vastauksen tiedot.
UpdateWorkspaceRequest	Päivitä työtilapyynnön tiedot.
Workspace	Työtilan objekti.
WorkspaceAppliedTag	Edustaa käytössä olevaa tunnistetta.
WorkspaceType	Työtilatyyppi. Lisää työtilatyyppejä voidaan lisätä ajan kuluessa.

ErrorRelatedResource

Kohde

Virheeseen liittyvä resurssitieto-objekti.

Nimi	Tyyppi	Description
resourceId	string	Virheestä liittyvä resurssitunnus.
resourceType	string	Virheestä liittyvän resurssin tyyppi.

ErrorResponse

Kohde

Virhevastaus.

Nimi	Tyyppi	Description
errorCode	string	Tietty tunniste, joka antaa tietoja virheehdosta ja mahdollistaa standardoidun tietoliikenteen palvelumme ja sen käyttäjien välillä.
message	string	Ihmisen luettavissa oleva esitys virheestä.
moreDetails	ErrorResponseDetails[]	Luettelo virheiden lisätiedoista.
relatedResource	ErrorRelatedResource	Virheisiin liittyvät resurssitiedot.
requestId	string (uuid)	Virheeseen liittyvän pyynnön tunnus.

ErrorResponseDetails

Kohde

Virheen vastauksen tiedot.

Nimi	Tyyppi	Description
errorCode	string	Tietty tunniste, joka antaa tietoja virheehdosta ja mahdollistaa standardoidun tietoliikenteen palvelumme ja sen käyttäjien välillä.
message	string	Ihmisen luettavissa oleva esitys virheestä.
relatedResource	ErrorRelatedResource	Virheisiin liittyvät resurssitiedot.

UpdateWorkspaceRequest

Kohde

Päivitä työtilapyynnön tiedot.

Nimi	Tyyppi	Description
description	string	Työtilan kuvaus. Kuvauksessa voi olla enintään 4 000 merkkiä.
displayName	string	Työtilan näyttönimi. Näyttönimi voi sisältää enintään 256 merkkiä. Työtilojen nimien on oltava yksilöllisiä vuokraajassa. Järjestelmänvalvojan valvonta on varattu työtilan nimi.

Workspace

Kohde

Työtilan objekti.

Nimi	Tyyppi	Description
apiEndpoint	string (uri)	HTTP-URL-osoite, joka edustaa työtilalle määritettyä ohjelmointirajapinnan päätepistettä. Tämä päätepistearvo palautetaan, kun käyttäjä ottaa käyttöön preferWorkspaceSpecificEndpoints-asetuksen. Se mahdollistaa ohjelmointirajapinnan käytön yksityisten linkkien kautta.
capacityId	string (uuid)	Sen kapasiteetin tunnus, jolle työtila on määritetty.
description	string	Työtilan kuvaus.
displayName	string	Työtilan näyttönimi.
domainId	string (uuid)	Sen toimialueen tunnus, jolle työtila on määritetty.
id	string (uuid)	Työtilan tunnus.
tags	WorkspaceAppliedTag[]	Luettelo käytössä olevista tunnisteista.
type	WorkspaceType	Työtilan tyyppi.

WorkspaceAppliedTag

Kohde

Edustaa käytössä olevaa tunnistetta.

Nimi	Tyyppi	Description
displayName	string	Tunnisteen nimi.
id	string (uuid)	Tunnisteen tunnus.

WorkspaceType

Luettelointi

Työtilatyyppi. Lisää työtilatyyppejä voidaan lisätä ajan kuluessa.

Arvo	Description
Personal	Oma kansio tai Oma työtila, jota käytetään käyttäjäkohteiden hallintaan.
Workspace	Fabric-kohteiden hallintaan käytetty työtila.
AdminWorkspace	Järjestelmänvalvojan valvontatyötila. Sisältää järjestelmänvalvojan raportit, kuten valvontaraportin sekä käyttö- ja käyttöönottoraportin.