Items - Get Notebook Definition

Tjeneste:

Notebook

API-versjon:

v1

Returnerer den angitte offentlige definisjonen for notatblokken.
Denne API-en støtter langvarige operasjoner (LRO).

Når du får en offentlig definisjon av en notatblokk, er ikke følsomhetsetiketten en del av definisjonen.

Tillatelser

Innringeren må ha lese- og skrivetillatelser for notatblokken.

Nødvendige delegerte omfang

Notebook.ReadWrite.All eller Item.ReadWrite.All

Begrensninger

Denne API-en er blokkert for en notatblokk med en kryptert følsomhetsetikett.

Microsoft Entra-støttede identiteter

Denne API-en støtter Microsoft -identiteter oppført i denne delen.

Identitet	Kundestøtte
Bruker	Ja
tjenestekontohaver og administrerte identiteter	Ja

Grensesnitt

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

Med valgfrie parametere:

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

URI-parametere

Navn	I	Obligatorisk	Type	Beskrivelse
notebookId	path	True	string (uuid)	Notatblokk-ID-en.
workspaceId	path	True	string (uuid)	Arbeidsområde-ID-en.
format	query		string	Formatet for den offentlige definisjonen for notatblokken. Støttet format: ipynb og fabricGitSource. Hvis det ikke er angitt noe format, fabricGitSource brukes.

Svar

Navn	Type	Beskrivelse
200 OK	NotebookDefinitionResponse	Forespørselen er fullført.
202 Accepted		Forespørselen er godtatt. Henting av definisjonen pågår. Overskrifter Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	Grensen for tjenestesats ble overskredet. Serveren returnerer en Retry-After topptekst som angir, i sekunder, hvor lenge klienten må vente før du sender flere forespørsler. Overskrifter Retry-After: integer
Other Status Codes	ErrorResponse	Vanlige feilkoder: OperationNotSupportedForItem – operasjonen støttes ikke for forespurt element.

Eksempler

Get a notebook definition in fabricGitSource format example

Get a notebook definition in ipynb format example

Get a notebook definition in fabricGitSource format example

Eksempelforespørsel

HTTP

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

Eksempelsvar

Statuskode:

200

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

Statuskode:

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

Eksempelforespørsel

HTTP

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

Eksempelsvar

Statuskode:

200

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

Statuskode:

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

Definisjoner

Navn	Beskrivelse
ErrorRelatedResource	Objektet for feilrelaterte ressursdetaljer.
ErrorResponse	Feilsvaret.
ErrorResponseDetails	Feilsvardetaljene.
NotebookDefinition	Offentlig definisjonsobjekt for notatblokk. Se denne artikkelen for mer informasjon om strukturen i notatblokkdefinisjonen.
NotebookDefinitionPart	Notatblokkdefinisjonsdelobjekt.
NotebookDefinitionResponse	Svar på offentlig definisjon for notatblokken.
PayloadType	Typen nyttelast for definisjonsdelen. Flere nyttelasttyper kan legges til over tid.

ErrorRelatedResource

Objekt

Objektet for feilrelaterte ressursdetaljer.

Navn	Type	Beskrivelse
resourceId	string	Ressurs-ID-en som er involvert i feilen.
resourceType	string	Typen ressurs som er involvert i feilen.

ErrorResponse

Objekt

Feilsvaret.

Navn	Type	Beskrivelse
errorCode	string	En bestemt identifikator som gir informasjon om en feilbetingelse, noe som gir standardisert kommunikasjon mellom tjenesten og brukerne.
message	string	En menneskelig lesbar representasjon av feilen.
moreDetails	ErrorResponseDetails[]	Liste over flere feildetaljer.
relatedResource	ErrorRelatedResource	Feilrelaterte ressursdetaljer.
requestId	string (uuid)	ID for forespørselen som er knyttet til feilen.

ErrorResponseDetails

Objekt

Feilsvardetaljene.

Navn	Type	Beskrivelse
errorCode	string	En bestemt identifikator som gir informasjon om en feilbetingelse, noe som gir standardisert kommunikasjon mellom tjenesten og brukerne.
message	string	En menneskelig lesbar representasjon av feilen.
relatedResource	ErrorRelatedResource	Feilrelaterte ressursdetaljer.

NotebookDefinition

Objekt

Offentlig definisjonsobjekt for notatblokk. Se denne artikkelen for mer informasjon om strukturen i notatblokkdefinisjonen.

Navn	Type	Beskrivelse
format	string	Formatet for notatblokkdefinisjonen. Støttet format: ipynb og fabricGitSource. Hvis det ikke er angitt noe format, fabricGitSource brukes.
parts	NotebookDefinitionPart[]	En liste over definisjonsdeler.

NotebookDefinitionPart

Objekt

Notatblokkdefinisjonsdelobjekt.

Navn	Type	Beskrivelse
path	string	Notatblokkdelbanen. Støttede notatblokkinnholdsutvidelser: .ipynb for ipynb format; .py, .scala, .r, .sql for fabricGitSource format.
payload	string	Nyttelasten for notatblokkdelen.
payloadType	PayloadType	Nyttelasttypen.

NotebookDefinitionResponse

Objekt

Svar på offentlig definisjon for notatblokken.

Navn	Type	Beskrivelse
definition	NotebookDefinition	Offentlig definisjonsobjekt for notatblokk. Se denne artikkelen for mer informasjon om strukturen i notatblokkdefinisjonen.

PayloadType

Opplisting

Typen nyttelast for definisjonsdelen. Flere nyttelasttyper kan legges til over tid.

Verdi	Beskrivelse
InlineBase64	Innebygd grunntall 64.