Items - Get Notebook Definition
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
Jotta soittaja voi noutaa salatulla luottamuksellisuustunnisteellä suojatun muistikirjakohteen määrityksen, hänellä on oltava riittävät käyttöoikeudet tunnisteen poistamiseen, kuten Microsoft Purview on määritetty.
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
POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/notebooks/{notebookId}/getDefinition?format={format}
URI-parametrit
| Nimi | Kohteessa | Pakollinen | Tyyppi | Kuvaus |
|---|---|---|---|---|
|
notebook
|
path | True |
string (uuid) |
Muistikirjatunnus. |
|
workspace
|
path | True |
string (uuid) |
Työtilan tunnus. |
|
format
|
query |
string |
Muistikirjan julkisen määritelmän muoto. Tuettu muoto: |
Vastaukset
| Nimi | Tyyppi | Kuvaus |
|---|---|---|
| 200 OK |
Pyynnön valmistuttua. |
|
| 202 Accepted |
Pyyntö hyväksytty. Määrityksen noutaminen on kesken. Otsikot
|
|
| 429 Too Many Requests |
Palveluhinnan raja ylitettiin. Palvelin palauttaa otsikon, joka Otsikot Retry-After: integer |
|
| Other Status Codes |
Yleiset virhekoodit:
|
Esimerkit
|
Get a notebook definition in fabric |
| Get a notebook definition in ipynb format example |
Get a notebook definition in fabricGitSource format example
Mallipyyntö
POST https://api.fabric.microsoft.com/v1/workspaces/6e335e92-a2a2-4b5a-970a-bd6a89fbb765/notebooks/cfafbeb1-8037-4d0c-896e-a46fb27ff229/getDefinition
Mallivastaus
{
"definition": {
"parts": [
{
"path": "notebook-content.py",
"payload": "IyBGYWJyaWMgbm90ZWJv..5ndWUiOiJweXRob24ifX19",
"payloadType": "InlineBase64"
},
{
"path": ".platform",
"payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
"payloadType": "InlineBase64"
}
]
}
}
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ö
POST https://api.fabric.microsoft.com/v1/workspaces/6e335e92-a2a2-4b5a-970a-bd6a89fbb765/notebooks/cfafbeb1-8037-4d0c-896e-a46fb27ff229/getDefinition?format=ipynb
Mallivastaus
{
"definition": {
"parts": [
{
"path": "notebook-content.ipynb",
"payload": "IyBGYWJyaWMgbm90ZWJv..5ndWUiOiJweXRob24ifX19",
"payloadType": "InlineBase64"
},
{
"path": ".platform",
"payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
"payloadType": "InlineBase64"
}
]
}
}
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 | Kuvaus |
|---|---|
|
Error |
Jäsennetty parametri, joka antaa koneluettavaa lisäkontekstia virheestä. |
|
Error |
Virheeseen liittyvä resurssitieto-objekti. |
|
Error |
Virhevastaus. |
|
Error |
Virheen vastauksen tiedot. |
|
Notebook |
Muistikirjan julkinen määritelmäobjekti. Katso tästä artikkelista lisätietoja muistikirjan määritelmän rakenteesta. |
|
Notebook |
Muistikirjan määritelmäosan objekti. |
|
Notebook |
Muistikirjan julkinen määritelmävastaus. |
|
Payload |
Määritelmäosan hyötykuorman tyyppi. Lisää hyötykuormitustyyppejä voidaan lisätä ajan kuluessa. |
ErrorParameter
Jäsennetty parametri, joka antaa koneluettavaa lisäkontekstia virheestä.
| Nimi | Tyyppi | Kuvaus |
|---|---|---|
| message |
string |
Ihmisen luettavissa oleva kuvaus parametrin merkityksestä. |
| name |
string |
Parametritunniste. |
| value |
string |
Parametriarvo. |
ErrorRelatedResource
Virheeseen liittyvä resurssitieto-objekti.
| Nimi | Tyyppi | Kuvaus |
|---|---|---|
| resourceId |
string |
Virheestä liittyvä resurssitunnus. |
| resourceType |
string |
Virheestä liittyvän resurssin tyyppi. |
ErrorResponse
Virhevastaus.
| Nimi | Tyyppi | Kuvaus |
|---|---|---|
| errorCode |
string |
Tietty tunniste, joka antaa tietoja virheehdosta ja mahdollistaa standardoidun tietoliikenteen palvelumme ja sen käyttäjien välillä. |
| isRetriable |
boolean |
Kun arvo on tosi, pyyntöä voidaan yrittää uudelleen. Määritä viive vastausotsikon |
| message |
string |
Ihmisen luettavissa oleva esitys virheestä. |
| moreDetails |
Luettelo virheiden lisätiedoista. |
|
| parameters |
Jäsennettyjä parametreja, jotka antavat koneluettavaa lisäkontekstia virheestä. |
|
| relatedResource |
Virheisiin liittyvät resurssitiedot. |
|
| requestId |
string (uuid) |
Virheeseen liittyvän pyynnön tunnus. |
ErrorResponseDetails
Virheen vastauksen tiedot.
| Nimi | Tyyppi | Kuvaus |
|---|---|---|
| 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ä. |
| parameters |
Jäsennettyjä parametreja, jotka antavat koneluettavaa lisäkontekstia virheestä. |
|
| relatedResource |
Virheisiin liittyvät resurssitiedot. |
NotebookDefinition
Muistikirjan julkinen määritelmäobjekti. Katso tästä artikkelista lisätietoja muistikirjan määritelmän rakenteesta.
| Nimi | Tyyppi | Kuvaus |
|---|---|---|
| format |
string |
Muistikirja-määritelmän muoto. Tuettu muoto: |
| parts |
Luettelo määritysosista. |
NotebookDefinitionPart
Muistikirjan määritelmäosan objekti.
| Nimi | Tyyppi | Kuvaus |
|---|---|---|
| path |
string |
Muistikirjan osan polku. Tuetut muistikirjan sisältölaajennukset: |
| payload |
string |
Muistikirjan osan hyötykuorma. |
| payloadType |
Hyötykuorman tyyppi. |
NotebookDefinitionResponse
Muistikirjan julkinen määritelmävastaus.
| Nimi | Tyyppi | Kuvaus |
|---|---|---|
| definition |
Muistikirjan julkinen määritelmäobjekti. Katso tästä artikkelista lisätietoja muistikirjan määritelmän rakenteesta. |
PayloadType
Määritelmäosan hyötykuorman tyyppi. Lisää hyötykuormitustyyppejä voidaan lisätä ajan kuluessa.
| Arvo | Kuvaus |
|---|---|
| InlineBase64 |
Inline Base 64. |