Items - Update Notebook Definition

Palvelu:

Notebook

Ohjelmointirajapinnan versio:

v1

Ohittaa määritetyn muistikirjan määrityksen.
Tämä ohjelmointirajapinta tukee pitkäkestoisia toimintoja.

Muistikirjan määritelmän päivittäminen ei vaikuta sen luottamuksellisuustunnisteisiin.

Oikeudet

Soittajalla on oltava muistikirjaan luku- ja kirjoitusoikeudet .

Vaaditut delegoidut vaikutusalueet

Notebook.ReadWrite.All tai Item.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ä

Käyttöliittymä

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/notebooks/{notebookId}/updateDefinition

Valinnaisilla parametreilla:

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/notebooks/{notebookId}/updateDefinition?updateMetadata={updateMetadata}

URI-parametrit

Nimi	Kohteessa	Pakollinen	Tyyppi	Description
notebookId	path	True	string (uuid)	Muistikirjatunnus.
workspaceId	path	True	string (uuid)	Työtilan tunnus.
updateMetadata	query		boolean	Kun asetuksena on tosi ja .platform-tiedosto annetaan osana määritystä, kohteen metatiedot päivitetään käyttämällä .platform-tiedoston metatietoja.

Pyynnön leipäteksti

Nimi	Pakollinen	Tyyppi	Description
definition	True	NotebookDefinition	Muistikirjan julkinen määritelmäobjekti. Katso tästä artikkelista lisätietoja muistikirjan määritelmän rakenteesta.

Vastaukset

Nimi	Tyyppi	Description
200 OK		Pyynnön valmistuttua.
202 Accepted		Pyyntö hyväksytty. Päivitysmääritys on meneillään. Otsikot Location: string x-ms-operation-id: string Retry-After: integer
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: OperationNotSupportedForItem – Toimintoa ei tueta pyydetylle kohteelle. VioittunutPayload – Annetut tiedot ovat vioittuneet.

Esimerkit

Update a notebook definition in fabricGitSource format example

Update a notebook definition in ipynb format example

Update a notebook definition in fabricGitSource format example

Mallipyyntö

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/notebooks/5b218778-e7a5-4d73-8187-f10824047715/updateDefinition?updateMetadata=True

{
  "definition": {
    "parts": [
      {
        "path": "notebook-content.py",
        "payload": "IyBGYWJyaWMgbm90ZWJv...",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

Mallivastaus

Tilakoodi:

200

Tilakoodi:

202

Location: https://api.fabric.microsoft.com/v1/operations/427f6c34-b64e-4ee4-8ea5-b533c0e203ef
x-ms-operation-id: 427f6c34-b64e-4ee4-8ea5-b533c0e203ef
Retry-After: 30

Update a notebook definition in ipynb format example

Mallipyyntö

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/notebooks/5b218778-e7a5-4d73-8187-f10824047715/updateDefinition?updateMetadata=True

{
  "definition": {
    "format": "ipynb",
    "parts": [
      {
        "path": "notebook-content.ipynb",
        "payload": "IyBGYWJyaWMgbm90ZWJv...",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

Mallivastaus

Tilakoodi:

200

Tilakoodi:

202

Location: https://api.fabric.microsoft.com/v1/operations/427f6c34-b64e-4ee4-8ea5-b533c0e203ef
x-ms-operation-id: 427f6c34-b64e-4ee4-8ea5-b533c0e203ef
Retry-After: 30

Määritelmät

Nimi	Description
ErrorRelatedResource	Virheeseen liittyvä resurssitieto-objekti.
ErrorResponse	Virhevastaus.
ErrorResponseDetails	Virheen vastauksen tiedot.
NotebookDefinition	Muistikirjan julkinen määritelmäobjekti. Katso tästä artikkelista lisätietoja muistikirjan määritelmän rakenteesta.
NotebookDefinitionPart	Muistikirjan määritelmäosan objekti.
PayloadType	Määritelmäosan hyötykuorman tyyppi. Lisää hyötykuormitustyyppejä voidaan lisätä ajan kuluessa.
UpdateNotebookDefinitionRequest	Päivitä muistikirjan julkisen määritelmän pyynnön tiedot.

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.

NotebookDefinition

Kohde

Muistikirjan julkinen määritelmäobjekti. Katso tästä artikkelista lisätietoja muistikirjan määritelmän rakenteesta.

Nimi	Tyyppi	Description
format	string	Muistikirja-määritelmän muoto. Tuettu muoto: ipynb ja fabricGitSource. Jos muotoa ei ole annettu, fabricGitSource käytetään kohdetta .
parts	NotebookDefinitionPart[]	Luettelo määritysosista.

NotebookDefinitionPart

Kohde

Muistikirjan määritelmäosan objekti.

Nimi	Tyyppi	Description
path	string	Muistikirjan osan polku. Tuetut muistikirjan sisältölaajennukset: .ipynbipynb for format; .py, .scala, .r.sql for fabricGitSource format.
payload	string	Muistikirjan osan hyötykuorma.
payloadType	PayloadType	Hyötykuorman tyyppi.

PayloadType

Luettelointi

Määritelmäosan hyötykuorman tyyppi. Lisää hyötykuormitustyyppejä voidaan lisätä ajan kuluessa.

Arvo	Description
InlineBase64	Inline Base 64.

UpdateNotebookDefinitionRequest

Kohde

Päivitä muistikirjan julkisen määritelmän pyynnön tiedot.

Nimi	Tyyppi	Description
definition	NotebookDefinition	Muistikirjan julkinen määritelmäobjekti. Katso tästä artikkelista lisätietoja muistikirjan määritelmän rakenteesta.