Items - Get Notebook Definition

Palvelu:

Notebook

Ohjelmointirajapinnan versio:

v1

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

Kun saat muistikirjan julkisen määrityksen, luottamuksellisuustunniste ei ole osa määritelmää.

Oikeudet

Soittajalla on oltava muistikirjaan luku- ja kirjoitusoikeudet .

Vaaditut delegoidut vaikutusalueet

Notebook.ReadWrite.All tai Item.ReadWrite.All

Rajoitukset

Tämä ohjelmointirajapinta on estetty muistikirjalle, jossa on salattu luottamuksellisuustunniste.

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}/getDefinition

Valinnaisilla parametreilla:

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

URI-parametrit

Nimi	Kohteessa	Pakollinen	Tyyppi	Description
notebookId	path	True	string (uuid)	Muistikirjatunnus.
workspaceId	path	True	string (uuid)	Työtilan tunnus.
format	query		string	Muistikirjan julkisen määritelmän muoto. Tuettu muoto: ipynb ja fabricGitSource. Jos muotoa ei ole annettu, fabricGitSource käytetään kohdetta .

Vastaukset

Nimi	Tyyppi	Description
200 OK	NotebookDefinitionResponse	Pyynnön valmistuttua.
202 Accepted		Pyyntö hyväksytty. Määrityksen noutaminen on kesken. 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.

Esimerkit

Get a notebook definition in fabricGitSource format example

Get a notebook definition in ipynb format example

Get a notebook definition in fabricGitSource format example

Mallipyyntö

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/6e335e92-a2a2-4b5a-970a-bd6a89fbb765/notebooks/cfafbeb1-8037-4d0c-896e-a46fb27ff229/getDefinition

Mallivastaus

Tilakoodi:

200

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

Tilakoodi:

202

Location: https://api.fabric.microsoft.com/v1/operations/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
x-ms-operation-id: 431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
Retry-After: 30

Get a notebook definition in ipynb format example

Mallipyyntö

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/6e335e92-a2a2-4b5a-970a-bd6a89fbb765/notebooks/cfafbeb1-8037-4d0c-896e-a46fb27ff229/getDefinition?format=ipynb

Mallivastaus

Tilakoodi:

200

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

Tilakoodi:

202

Location: https://api.fabric.microsoft.com/v1/operations/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
x-ms-operation-id: 431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
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.
NotebookDefinitionResponse	Muistikirjan julkinen määritelmävastaus.
PayloadType	Määritelmäosan hyötykuorman tyyppi. Lisää hyötykuormitustyyppejä 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.

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.

NotebookDefinitionResponse

Kohde

Muistikirjan julkinen määritelmävastaus.

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

PayloadType

Luettelointi

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

Arvo	Description
InlineBase64	Inline Base 64.