Udostępnij przez

Items - Update Notebook Definition

Usługa:
Notebook
Wersja interfejsu API:
v1

Zastępuje definicję określonego notesu.
Ten interfejs API obsługuje długotrwałych operacji (LRO).

Aktualizowanie definicji notesu nie ma wpływu na etykietę poufności.

Uprawnienia

Obiekt wywołujący musi mieć uprawnienia do odczytu i zapisu dla notesu.

Wymagane zakresy delegowane

Notebook.ReadWrite.All lub Item.ReadWrite.All

Tożsamości obsługiwane przez Microsoft Entra

To API obsługuje tożsamości Microsoft wymienione w tej sekcji.

Tożsamość Wsparcie
Użytkownik Tak
Główne usługi i Tożsamości zarządzane Tak

Interfejs

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
notebookId
 path True

string (uuid)

Identyfikator notesu.
workspaceId
 path True

string (uuid)

Identyfikator przestrzeni roboczej.
updateMetadata
 query

boolean

W przypadku ustawienia wartości true i pliku platformy w ramach definicji metadane elementu są aktualizowane przy użyciu metadanych w pliku platformy .

Treść żądania

Nazwa Wymagane Typ Opis
definition True

NotebookDefinition

Obiekt definicji publicznej notesu. Zapoznaj się z tym artykułem , aby uzyskać więcej informacji na temat tworzenia publicznej definicji notesu.

Odpowiedzi

Nazwa Typ Opis
200 OK

Żądanie zostało ukończone pomyślnie.
202 Accepted

Zaakceptowano żądanie. Trwa aktualizowanie definicji.

Nagłówki

  • Location: string
  • x-ms-operation-id: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

Typowe kody błędów:

  • OperationNotSupportedForItem — operacja nieobsługiwana dla żądanego elementu.

  • CorruptedPayload — podany ładunek jest uszkodzony.

Przykłady

Update a notebook definition in fabricGitSource format example
Update a notebook definition in ipynb format example

Update a notebook definition in fabricGitSource format example

Przykładowe żądanie

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"
      }
    ]
  }
}

Przykładowa odpowiedź

Kod stanu:
200
Kod stanu:
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

Przykładowe żądanie

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"
      }
    ]
  }
}

Przykładowa odpowiedź

Kod stanu:
200
Kod stanu:
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

Definicje

Nazwa Opis
ErrorRelatedResource

Obiekt szczegółów zasobu powiązanego z błędem.
ErrorResponse

Odpowiedź na błąd.
ErrorResponseDetails

Szczegóły odpowiedzi na błąd.
NotebookDefinition

Obiekt definicji publicznej notesu. Zapoznaj się z tym artykułem , aby uzyskać więcej informacji na temat tworzenia publicznej definicji notesu.
NotebookDefinitionPart

Obiekt części definicji notesu.
PayloadType

Typ ładunku części definicji. Dodatkowe typy ładunków mogą być dodawane w czasie.
UpdateNotebookDefinitionRequest

Zaktualizuj ładunek żądania definicji publicznej notesu.

ErrorRelatedResource

Objekt

Obiekt szczegółów zasobu powiązanego z błędem.

Nazwa Typ Opis
resourceId

string

Identyfikator zasobu, który jest zaangażowany w błąd.
resourceType

string

Typ zasobu, który jest zaangażowany w błąd.

ErrorResponse

Objekt

Odpowiedź na błąd.

Nazwa Typ Opis
errorCode

string

Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.
message

string

Czytelna reprezentacja błędu przez człowieka.
moreDetails

ErrorResponseDetails[]

Lista dodatkowych szczegółów błędu.
relatedResource

ErrorRelatedResource

Szczegóły zasobu powiązanego z błędem.
requestId

string

Identyfikator żądania skojarzonego z błędem.

ErrorResponseDetails

Objekt

Szczegóły odpowiedzi na błąd.

Nazwa Typ Opis
errorCode

string

Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.
message

string

Czytelna reprezentacja błędu przez człowieka.
relatedResource

ErrorRelatedResource

Szczegóły zasobu powiązanego z błędem.

NotebookDefinition

Objekt

Obiekt definicji publicznej notesu. Zapoznaj się z tym artykułem , aby uzyskać więcej informacji na temat tworzenia publicznej definicji notesu.

Nazwa Typ Opis
format

string

Format definicji notesu. Obsługiwany format: ipynb i fabricGitSource. Jeśli nie podano żadnego formatu, fabricGitSource jest używany.
parts

NotebookDefinitionPart[]

Lista części definicji.

NotebookDefinitionPart

Objekt

Obiekt części definicji notesu.

Nazwa Typ Opis
path

string

Ścieżka części notesu. Obsługiwane rozszerzenia zawartości notesu: .ipynb dla ipynb formatu; .py, .scala, .r, .sql dla fabricGitSource formatu.
payload

string

Ładunek części notesu.
payloadType

PayloadType

Typ ładunku.

PayloadType

Wyliczanie

Typ ładunku części definicji. Dodatkowe typy ładunków mogą być dodawane w czasie.

Wartość Opis
InlineBase64

Śródliniowa baza 64.

UpdateNotebookDefinitionRequest

Objekt

Zaktualizuj ładunek żądania definicji publicznej notesu.

Nazwa Typ Opis
definition

NotebookDefinition

Obiekt definicji publicznej notesu. Zapoznaj się z tym artykułem , aby uzyskać więcej informacji na temat tworzenia publicznej definicji notesu.