Verwalten der Umgebung über öffentliche APIs

Die Microsoft Fabric-REST-API stellt einen Dienstendpunkt für die Erstellungs-, Lese-, Update- und Löschvorgänge (Create, Read, Update and Delete, CRUD) eines Fabric-Elements bereit. In diesem Artikel werden die verfügbaren REST-APIs der Umgebung und deren Verwendung beschrieben.

Migrieren der Umgebungs-APIs zu ihrer stabilen GA-Version

Wichtig

Die GA-Version umfasst Aktualisierungen des Anfrage-/Antwortschemas vorhandener APIs, die Außerkraftsetzung einiger APIs und neue APIs. Die Details finden Sie in den folgenden Abschnitten.
Ein neuer Abfrageparameter beta wird eingeführt, um den Übergang von Anforderungs-/Antwortvertragsänderungen zu erleichtern. Der beta Abfrageparameter ist standardmäßig bis True zum 31. März 2026 verfügbar, sodass die Vorschauverträge weiterhin verfügbar sind. Legen Sie den Wert auf False fest, um mit der stabilen Releaseversion der Verträge zu beginnen.
Preview Abfrageparameter wurde ersetzt durch beta. Die Vorschau wird aus Gründen der Abwärtskompatibilität weiterhin unterstützt und verhält sich genauso wie die Beta-Version.
Die auslaufenden APIs werden bis zum 31. März 2026 weiterhin unterstützt. Bitte verwenden Sie die neu eingeführten APIs, um sie möglichst bald zu ersetzen.

APIs mit Aktualisierung des Anfrage-/Antwort-Vertrags

Kategorie	Programmierschnittstelle (API)	Beschreibung	Hinweise	Swagger-Vorschauversion	Release Version Swagger
Elementvorgang	Veröffentlichen von Umgebungen	Auslösen des Veröffentlichungsvorgangs der Umgebung mit aktuellen ausstehenden Änderungen.	Aktualisierung im Rahmen des Antwortvertrags.	Veröffentlichungsumgebung (Vorschau)	Veröffentlichungsumgebung
Inszenierung	Auflisten von Stagingbibliotheken	Rufen Sie die vollständige Liste der Stagingbibliotheken ab. Diese Liste enthält die veröffentlichten und ausstehenden Bibliotheken.	Aktualisierung im Rahmen des Antwortvertrags.	Bibliotheken für die Staging-Phase auflisten (Vorschau)	Auflisten von Staging-Bibliotheken
Inszenierung	Auflisten von Staging-Spark-Rechendiensten	Rufen Sie die vollständige Computekonfigurationen für das Staging ab. Die Stagingkonfigurationen umfassen die veröffentlichten und noch ausstehenden Rechnerkonfigurationen.	Aktualisierung im Rahmen des Antwortvertrags.	Staging-Spark-Compute auflisten (Vorschau)	Staging-Spark-Computing-Ressourcen auflisten
Inszenierung	Aktualisieren der Spark-Compute	Aktualisieren Sie die Computekonfigurationen und Spark-Eigenschaften für eine Umgebung.	Aktualisieren Sie die Anforderungs- und Antwortverträge.	Spark compute aktualisieren (Vorschau)	Aktualisieren der Spark-Compute
Veröffentlicht	Auflisten veröffentlichter Bibliotheken	Rufen Sie die Bibliotheken ab, die veröffentlicht wurden und in Spark-Sitzungen aktiv sind.	Aktualisierung im Rahmen des Antwortvertrags.	Veröffentlichte Bibliotheken auflisten (Vorschau)	Veröffentlichte Bibliotheken auflisten
Veröffentlicht	Veröffentlichte Spark Compute auflisten	Rufen Sie die Spark-Computekonfigurationen und Spark-Eigenschaften ab, die veröffentlicht wurden und in Spark-Sitzungen aktiv sind.	Aktualisierung im Rahmen des Antwortvertrags.	Veröffentlichte Bibliotheken auflisten (Vorschau)	Veröffentlichte Bibliotheken auflisten

Der beta Parameter wird True standardmäßig bis zum 31. März 2026 verwendet, d. h., das System betrachtet den Parameter als True, wenn die Anforderung ohne Angabe dieses Parameters bis zur Deaktivierung gesendet wird. Es wird dringend empfohlen, Ihre Implementierungen zur stabilen Version zu migrieren, indem Sie den beta Parameter explizit auf False setzen, sobald wie möglich.

Verwenden der List staging libraries API als Beispiel, das über ein Update in der API-Antwort verfügt.

Beim Senden der Anforderung, wenn der Parameter beta als True gesetzt ist.

Beispiel für eine Anforderung:

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/environments/{environmentId}/libraries?beta=True

Beispielantwort:

{
  "customLibraries": {
    "wheelFiles": [
      "samplewheel-0.18.0-py2.py3-none-any.whl"
    ],
    "pyFiles": [
      "samplepython.py"
    ],
    "jarFiles": [
      "samplejar.jar"
    ],
    "rTarFiles": [
      "sampleR.tar.gz"
    ]
  },
  "environmentYml": "name: sample-environment\ndependencies:\n  - fuzzywuzzy==0.0.1\n  - matplotlib==0.0.1"
}

Beim Senden der Anforderung, wenn der Parameter preview als False gesetzt ist.

Beispiel für eine Anforderung:

  GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/environments/{environmentId}/libraries?beta=False

Beispielantwort:

{
  "libraries": [
    {
      "name": "samplewheel-0.18.0-py2.py3-none-any.whl",
      "libraryType": "Custom"
    },
    {
      "name": "fuzzywuzzy",
      "libraryType": "External",
      "version": "0.0.1"
    }
  ],
  "continuationToken": "null",
  "continuationUri": "null"
}

Zukünftige Abschaffung von APIs

Wichtig

Die abzuschaffenden APIs werden bis zum 31. März 2026 weiterhin unterstützt. Es wird dringend empfohlen, neu eingeführte APIs zu verwenden, um Ihre Implementierungen so schnell wie möglich zu ersetzen.

Kategorie	Programmierschnittstelle (API)	Beschreibung	Hinweis
Inszenierung	Staging-Bibliotheken hochladen	Fügen Sie eine benutzerdefinierte Bibliothek oder eine/mehrere öffentliche Bibliothek in der Umgebung hinzu.	Support bis zum 31. März 2026. Bitte verwenden Sie die neu eingeführten `Import external libraries`/`Upload custom library` APIs, um diese zu ersetzen.
Inszenierung	Die Stagingbibliotheken löschen	Löschen Sie eine einzelne benutzerdefinierte Stagingbibliothek oder alle öffentlichen Bibliotheken.	Support bis zum 31. März 2026. Bitte verwenden Sie die neu eingeführten `Remove external library`/`Delete custom library` APIs, um diese zu ersetzen.

Im Folgenden finden Sie einige Beispiele für szenarien beim Verwalten von Stagingbibliotheken.

Hinzufügen der öffentlichen Bibliotheken in Ihrer Umgebung

Bisher können Sie die API verwenden Upload staging libraries , um die aktualisierte YAML-Datei hochzuladen, und jetzt können Sie die API zum Importieren des aktualisierten YAML verwenden Import external libraries .
Löschen einer öffentlichen Bibliothek in Ihrer Umgebung

Zuvor können Sie die API verwenden Upload staging libraries , um die aktualisierte YAML-Datei hochzuladen, und jetzt können Sie die API verwenden Remove external library , um sie zu entfernen.
Löschen aller öffentlichen Bibliotheken in Ihrer Umgebung

Bisher können Sie die API verwenden Delete staging libraries , um alle öffentlichen Bibliotheken zu löschen, und jetzt können Sie die API verwenden Remove external library , um die öffentlichen Bibliotheken einzeln zu entfernen oder Import external libraries eine leere YAML-Datei hochzuladen, um dieselben Funktionen zu erzielen.

Neue APIs

Kategorie	Programmierschnittstelle (API)	Beschreibung	Hinweis
Elementvorgang	Erstellen einer Umgebung mit Definition	Erstellen Sie eine neue Umgebung mit Definition.	Neue API.
Elementvorgang	Umgebungsdefinition abrufen	Rufen Sie die Definition einer Umgebung ab.	Neue API.
Elementvorgang	Aktualisieren der Umgebungsdefinition	Aktualisieren Sie die Definition einer Umgebung.	Neue API.
Inszenierung	Importieren externer Bibliotheken	Laden Sie externe Bibliotheken als environment.yml Datei in die Umgebung hoch. Sie überschreibt die Liste vorhandener externer Bibliotheken in einer Umgebung.	Neue API.
Inszenierung	Exportieren externer Bibliotheken	Rufen Sie die vollständigen externen Bibliotheken als environment.yml Datei ab.	Neue API.
Inszenierung	Externe Bibliothek entfernen	Löschen einer externen Bibliothek aus einer Umgebung. Diese API akzeptiert jeweils eine Bibliothek.	Neue API.
Inszenierung	Benutzerdefinierte Bibliothek hochladen	Laden Sie ein benutzerdefiniertes Paket in eine Umgebung hoch. Diese API ermöglicht jeweils einen Dateiupload. Die unterstützten Dateiformate sind .jar, .py, WHL und .tar.gz.	Neue API.
Inszenierung	Benutzerdefinierte Bibliothek löschen	Löschen Eines benutzerdefinierten Pakets aus der Umgebung. Fügen Sie den vollständigen Namen des benutzerdefinierten Pakets mit der Erweiterung in die API-Anforderung ein, um es zu entfernen.	Neue API.
Veröffentlicht	Exportieren externer Bibliotheken	Rufen Sie die veröffentlichten externen Bibliotheken als environment.yml Datei ab.	Neue API.

APIs ohne Aktualisierung

Kategorie	Programmierschnittstelle (API)	Beschreibung
Elementvorgang	Erstellen einer Umgebung	Erstellen Sie eine neue leere Umgebung im Arbeitsbereich.
Elementvorgang	Umgebung abrufen	Rufen Sie die Metadaten einer Umgebung ab. Die Antwort enthält den Status der Umgebung.
Elementvorgang	Umgebung löschen	Löschen Sie eine vorhandene Umgebung.
Elementvorgang	Listenumgebung	Ruft die Liste der Umgebungen in einem Arbeitsbereich ab.
Elementvorgang	Aktualisieren der Umgebung	Aktualisieren Sie die Metadaten einer Umgebung, z. B. Name und Beschreibung.
Elementvorgang	Veröffentlichungsumgebung abbrechen	Abbrechen eines laufenden Veröffentlichungsvorgangs der Umgebung.

Weitere Informationen zu den öffentlichen APIs der Umgebung finden Sie unter Element-APIs – Umgebung.

Anwendungsfälle für öffentliche Umgebungs-APIs

Wichtig

Dieser Abschnitt wird mit der stabilen Release-Version der APIs veranschaulicht.

In diesem Abschnitt wird veranschaulicht, wie Sie die APIs verwenden, um bestimmte Szenarien beim Verwalten der Umgebung zu erzielen. Sie können die {WORKSPACE_ID} und {ARTIFACT_ID} Eigenschaften in den folgenden Beispielen durch geeignete Werte ersetzen.

Eine neue Umgebung erstellen

Verwenden Sie die folgende API, um eine neue leere Umgebung zu erstellen.

Beispielanforderung

POST https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments

{
    "displayName": "Environment_1",
    "description": "An environment description"
}

Verwalten von Stagingbibliotheken

Sie können die ApIs zum Hochladen und Löschen von Stagingbibliotheken verwenden, um den Bibliotheksbereich in der Umgebung zu verwalten.

Überprüfen der veröffentlichten Bibliotheken von Umgebungen

Bevor Sie eine Bibliothek hinzufügen oder löschen, verwenden Sie die API zum Abrufen veröffentlichter Bibliotheken, um zu überprüfen, welche Bibliotheken derzeit wirksam sind.

Beispielanforderung

GET https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/libraries?beta=False

Beispiel für eine Antwort

{
  "libraries": [
    {
      "name": "samplewheel-0.18.0-py2.py3-none-any.whl",
      "libraryType": "Custom"
    },
    {
      "name": "fuzzywuzzy",
      "libraryType": "External",
      "version": "0.0.1"
    }
  ],
  "continuationToken": "null",
  "continuationUri": "null"
}

Importieren öffentlicher Bibliotheken oder Hochladen benutzerdefinierter Bibliotheken

Sie können externe Bibliotheken importieren und benutzerdefinierte Bibliotheks-APIs hochladen , um Ihrer Umgebung neue öffentliche/benutzerdefinierte Bibliotheken hinzuzufügen. Die API für externe Importbibliotheken akzeptiert environment.yml Datei, während die unterstützten Dateitypen WHL, .jar, .tar.gz, .py zum Hochladen benutzerdefinierter Bibliotheks-API sind.

Hinweis

Um die öffentliche Bibliothek effizienter zu bearbeiten, empfehlen wir, alle erwarteten Bibliotheken aus PyPI und Conda in einer environment.yml Datei zu verfassen.

Die Upload-API ermöglicht bis zu einer 200 MB-Datei in einer Anforderung. Eine Bibliothek, die diese Größenbeschränkung überschreitet, wird derzeit nicht in öffentlichen APIs unterstützt.

Beispielanforderungen

POST https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/staging/libraries/importExternalLibraries

POST https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/staging/libraries/samplelibrary.jar

Löschen der benutzerdefinierten Bibliothek

Durch Angeben des vollständigen Bibliotheksdateinamens mit dem Typsuffix können Sie jeweils eine benutzerdefinierte Bibliothek löschen.

Hinweis

Wenn Sie eine Teilmenge der vorhandenen öffentlichen Bibliotheken oder alle davon entfernen möchten, importieren Sie bitte eine aktualisierte YAML-Datei über Import public libraries die API.

Beispielanforderungen

DELETE https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/staging/libraries/samplelibrary.jar

Verwalten der Spark-Computeressourcen für das Staging

Mit der API zum Aktualisieren von Spark-Computeressourcen für das Staging können Sie das Spark-Computing verwalten.

Überprüfen der veröffentlichten Spark-Computeressourcen in Umgebungen

Bevor Sie die Konfigurationen für die Umgebung ändern, verwenden Sie die Get Published Spark Compute-API, um zu überprüfen, welche Spark-Computekonfigurationen derzeit wirksam sind.

Beispielanforderung

GET https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/sparkcompute?beta=False

Beispiel für eine Antwort

{
  "instancePool": {
    "name": "MyWorkspacePool",
    "type": "Workspace",
    "id": "78942136-106c-4f3e-80fc-7ff4eae11603"
  },
  "driverCores": 4,
  "driverMemory": "56g",
  "executorCores": 4,
  "executorMemory": "56g",
  "dynamicExecutorAllocation": {
    "enabled": false,
    "minExecutors": 1,
    "maxExecutors": 1
  },
  "sparkProperties": [
    {
      "key": "spark.acls.enable",
      "value": "false"
    }
  ],
  "runtimeVersion": "1.2"
}

Aktualisierungen der Rechenkonfigurationen

Sie können die Spark-Laufzeit aktualisieren, zu einem anderen Pool wechseln, die Computekonfiguration verfeinern und Spark-Eigenschaften hinzufügen oder entfernen, indem Sie den Anforderungstext dieser API bearbeiten.

Sie können den angefügten Pool wechseln, indem Sie den Poolnamen und den Pool angeben. Geben Sie den Poolnamen als Starter Pool an, um den Pool auf die Standardeinstellungen umzustellen. Informationen zum Abrufen der vollständigen Liste der verfügbaren benutzerdefinierten Pools des Arbeitsbereichs mithilfe der REST-API finden Sie unter Custom Pools - List Workspace Custom Pools.

Wenn Sie eine vorhandene Spark-Eigenschaft entfernen möchten, geben Sie den Wert wie null bei dem Schlüssel an, den Sie entfernen möchten.

Beispielanforderung

PATCH https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/environments/707cfd07-cbf1-41da-aad7-dd157ddb8c11/staging/sparkcompute?beta=False

{
  "instancePool": {
    "name": "MyWorkspacePool",
    "type": "Workspace"
  },
  "driverCores": 4,
  "driverMemory": "56g",
  "executorCores": 4,
  "executorMemory": "56g",
  "dynamicExecutorAllocation": {
    "enabled": false,
    "minExecutors": 1,
    "maxExecutors": 1
  },
  "sparkProperties": [
    {
      "key": "spark.acls.enable",
      "value": "false"
    },
    {
      "key": "spark.admin.acls",
      "value": null
    }
  ],
  "runtimeVersion": "1.2"
}

Effektive Änderungen vornehmen

Verwenden Sie die folgenden APIs, um die Änderungen zu veröffentlichen.

Vorbereiten eines Veröffentlichungsvorgangs

Die Umgebung kann jeweils einen Veröffentlichungsvorgang akzeptieren. Bevor Sie Ihre Umgebung veröffentlichen, validieren Sie den Status der Umgebung und nehmen Sie eine abschließende Überprüfung der Änderungen im Testsystem vor. Nachdem die Umgebung erfolgreich veröffentlicht wurde, werden alle Konfigurationen im Stagingstatus wirksam.

Schritt 1: Rufen Sie die Metadaten der Umgebung ab.
```
GET https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/
```
Im Antworttext können Sie den Zustand der Umgebung deutlich erkennen. Stellen Sie sicher, dass kein Veröffentlichungsvorgang ausgeführt wird, bevor Sie zum nächsten Schritt wechseln.

Schritt 2: Rufen Sie die Stagingbibliotheken/Spark-Compute ab, um eine endgültige Überprüfung zu erhalten.

GET https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/staging/libraries?beta=False

GET https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/staging/sparkcompute?beta=False

Auslösen des Veröffentlichungsvorgangs der Umgebung

Die Änderungen, die Sie für die Stagingbibliotheken und Spark Compute vorgenommen haben, werden zwischengespeichert, erfordern jedoch, dass sie veröffentlicht werden, um wirksam zu werden. Verwenden Sie das nächste Beispiel, um den Veröffentlichungsvorgang auszulösen. Die Antwort folgt dem LRO-Muster (Long Running Operations), und der HTTP-Antwortcode 202 kann zurückgegeben werden.

Beispielanforderung

POST https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/staging/publish?beta=False

Beispiel für eine Antwort

Location: https://api.fabric.microsoft.com/v1/operations/abcdef00-9d7e-469a-abf1-fca847a0ea69
x-ms-operation-id: abcdef00-9d7e-469a-abf1-fca847a0ea69
Retry-After: 120

Während des Veröffentlichungsvorgangs können Sie auch die folgende API aufrufen, um sie abzubrechen.

Beispielanforderung

POST https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/staging/cancelPublish

Feedback

War diese Seite hilfreich?

Last updated on 2025-10-09

Teilen über

Verwalten der Umgebung über öffentliche APIs

Migrieren der Umgebungs-APIs zu ihrer stabilen GA-Version

APIs mit Aktualisierung des Anfrage-/Antwort-Vertrags

Zukünftige Abschaffung von APIs

Neue APIs

APIs ohne Aktualisierung

Anwendungsfälle für öffentliche Umgebungs-APIs

Eine neue Umgebung erstellen

Verwalten von Stagingbibliotheken

Überprüfen der veröffentlichten Bibliotheken von Umgebungen

Importieren öffentlicher Bibliotheken oder Hochladen benutzerdefinierter Bibliotheken

Löschen der benutzerdefinierten Bibliothek

Verwalten der Spark-Computeressourcen für das Staging

Überprüfen der veröffentlichten Spark-Computeressourcen in Umgebungen

Aktualisierungen der Rechenkonfigurationen

Effektive Änderungen vornehmen

Vorbereiten eines Veröffentlichungsvorgangs

Auslösen des Veröffentlichungsvorgangs der Umgebung

Zugehöriger Inhalt

Feedback

Zusätzliche Ressourcen