Items - Get Notebook Definition

Tjeneste:: Notebook

API-version:: v1

Returnerer den angivne offentlige definition af notesbogen.
Denne API understøtter LRO-handlinger (Long Running Operations).

Når du får en offentlig definition af en notesbog, er følsomhedsmærkaten ikke en del af definitionen.

Tilladelser

Den, der ringer op, skal have læse- og skriverettigheder til notesbogen.

Påkrævede delegerede områder

Notebook.ReadWrite.All eller Item.ReadWrite.All

Begrænsninger

Hvis du vil hente definitionen af et notesbogelement, der er beskyttet af en krypteret følsomhedsmærkat, skal kalderen have tilstrækkelige brugsrettigheder til at fjerne mærkaten som konfigureret i Microsoft Purview.

Microsoft Entra-understøttede identiteter

Denne API understøtter de Microsoft -identiteter, der angivet i dette afsnit.

Identitet	Støtte
Bruger	Ja
tjenesteprincipal og administrerede identiteter	Ja

Brugergrænseflade

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

Med valgfrie parametre:

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

URI-parametre

Navn	I	Påkrævet	Type	Beskrivelse
notebookId	path	True	string (uuid)	Notesbog-id'et.
workspaceId	path	True	string (uuid)	Arbejdsområde-id'et.
format	query		string	Formatet af den offentlige definition af notesbogen. Understøttet format: `ipynb` og `fabricGitSource`. Hvis der ikke er angivet et format, `fabricGitSource` bruges .

Svar

Navn	Type	Beskrivelse
200 OK	NotebookDefinitionResponse	Anmodningen blev fuldført.
202 Accepted		Anmodningen blev accepteret. Hentning af definitionen er i gang. Headere Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	Grænsen for tjenestetakst blev overskredet. Serveren returnerer en `Retry-After` header, der angiver, i sekunder, hvor længe klienten skal vente, før der sendes yderligere anmodninger. Headere Retry-After: integer
Other Status Codes	ErrorResponse	Almindelige fejlkoder: OperationNotSupportedForItem – Handlingen understøttes ikke for det ønskede 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

Eksempelanmodning

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

Eksempelanmodning

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

Definitioner

Navn	Beskrivelse
ErrorParameter	En struktureret parameter, der giver yderligere kontekst, der kan læses af computeren, om en fejl.
ErrorRelatedResource	Objektet med fejlrelaterede ressourceoplysninger.
ErrorResponse	Fejlsvaret.
ErrorResponseDetails	Oplysninger om fejlsvar.
NotebookDefinition	Offentlig definition af notesbogobjekt. Se denne artikel for at få flere oplysninger om strukturen i definitionen af notesbogen.
NotebookDefinitionPart	Objekt for notesbogdefinitionsdel.
NotebookDefinitionResponse	Svar på offentlig definition af notesbog.
PayloadType	Typen af nyttedata for definitionsdelen. Der kan tilføjes flere nyttedatatyper over tid.

ErrorParameter

Objekt

En struktureret parameter, der giver yderligere kontekst, der kan læses af computeren, om en fejl.

Navn	Type	Beskrivelse
message	string	En læsevenlig beskrivelse af parameterens betydning.
name	string	Parameter-id'et.
value	string	Parameterens værdi.

ErrorRelatedResource

Objekt

Objektet med fejlrelaterede ressourceoplysninger.

Navn	Type	Beskrivelse
resourceId	string	Det ressource-id, der er involveret i fejlen.
resourceType	string	Typen af ressource, der er involveret i fejlen.

ErrorResponse

Objekt

Fejlsvaret.

Navn	Type	Beskrivelse
errorCode	string	Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
isRetriable	boolean	Når sand, kan anmodningen prøves igen. Brug svarheaderen `Retry-After` til at bestemme forsinkelsen, hvis den er tilgængelig.
message	string	En menneskelig læsbar gengivelse af fejlen.
moreDetails	ErrorResponseDetails[]	Liste over yderligere oplysninger om fejl.
parameters	ErrorParameter[]	Strukturerede parametre, der giver yderligere kontekst, der kan læses af computeren, om fejlen.
relatedResource	ErrorRelatedResource	De fejlrelaterede ressourceoplysninger.
requestId	string (uuid)	Id'et for den anmodning, der er knyttet til fejlen.

ErrorResponseDetails

Objekt

Oplysninger om fejlsvar.

Navn	Type	Beskrivelse
errorCode	string	Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
message	string	En menneskelig læsbar gengivelse af fejlen.
parameters	ErrorParameter[]	Strukturerede parametre, der giver yderligere kontekst, der kan læses af computeren, om fejlen.
relatedResource	ErrorRelatedResource	De fejlrelaterede ressourceoplysninger.

NotebookDefinition

Objekt

Offentlig definition af notesbogobjekt. Se denne artikel for at få flere oplysninger om strukturen i definitionen af notesbogen.

Navn	Type	Beskrivelse
format	string	Formatet af notesbogdefinitionen. Understøttet format: `ipynb` og `fabricGitSource`. Hvis der ikke er angivet et format, `fabricGitSource` bruges .
parts	NotebookDefinitionPart[]	En liste over definitionsdele.

NotebookDefinitionPart

Objekt

Objekt for notesbogdefinitionsdel.

Navn	Type	Beskrivelse
path	string	Stien til notesbogdelen. Understøttede udvidelser til notesbogindhold: `.ipynb` for `ipynb` format; `.py`, `.scala`, `.r`for `.sqlfabricGitSource` format.
payload	string	Nyttedata for notesbogdelen.
payloadType	PayloadType	Nyttedatatypen.

NotebookDefinitionResponse

Objekt

Svar på offentlig definition af notesbog.

Navn	Type	Beskrivelse
definition	NotebookDefinition	Offentlig definition af notesbogobjekt. Se denne artikel for at få flere oplysninger om strukturen i definitionen af notesbogen.

PayloadType

Optælling

Typen af nyttedata for definitionsdelen. Der kan tilføjes flere nyttedatatyper over tid.

Værdi	Beskrivelse
InlineBase64	Indbygget grundlinje 64.