Freigeben über

Verwalten der Umgebung über öffentliche APIs

  • Artikel

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 des Notebooks und deren Verwendung beschrieben.

Wichtig

Dieses Feature befindet sich in der Vorschauphase.

Zusammenfassung der verfügbaren Umgebungs-APIs

API Beschreibung Kategorie
Erstellen der Umgebung Erstellen Sie eine neue Umgebung im Arbeitsbereich. Allgemein
Abrufen von Umgebungen Rufen Sie die Metadaten einer Umgebung ab. Die Antwort enthält den Status der Umgebung. Allgemein
Umgebung aktualisieren Aktualisieren Sie die Metadaten einer Umgebung, z. B. Name und Beschreibung. Allgemein
Umgebung löschen Löschen Sie eine vorhandene Umgebung. Allgemein
Auflisten der Umgebungen im Arbeitsbereich. Auflisten der Umgebungen im Arbeitsbereich. Allgemein
Veröffentlichen von Umgebungen Lösen Sie die Veröffentlichung der Umgebung mit aktuellen ausstehenden Änderungen aus. Allgemein
Veröffentlichungsabbruch Abbrechen einer fortlaufenden Veröffentlichung der Umgebung Allgemein
Abrufen veröffentlichter Spark-Compute Rufen Sie die Spark-Computekonfigurationen ab, die effektiv sind. Spark-Compute
Abrufen der Staging-Spark-Compute Rufen Sie die vollständigen Staging-Computekonfigurationen ab. Die Stagingkonfigurationen umfassen die veröffentlichten und ausstehenden Computekonfigurationen. Spark-Compute
Abrufen veröffentlichter Bibliotheken Ruft die effektive Bibliotheksliste ab. Bibliotheken
Abrufen von Stagingbibliotheken Rufen Sie die vollständige Stagingbibliotheksliste ab. Diese Liste enthält die veröffentlichten und ausstehenden Bibliotheken. Libraries
Hochladen von Stagingbbibliotheken Hinzufügen einer benutzerdefinierten Bibliothek oder einer/mehrerer öffentlicher Bibliothek in der Umgebung. Libraries
Stagingbibliotheken löschen Löschen Sie eine benutzerdefinierte Stagingbibliothek oder alle öffentlichen Bibliotheken. Libraries

Weitere Informationen zu den öffentlichen APIs der Umgebung in Element-APIs – Umgebung

Anwendungsfälle für öffentliche API-Umgebungen

Dieser Abschnitt führt Sie durch mehrere häufige Szenarien beim Umgang mit der Umgebung. Ersetzen Sie in den folgenden Beispielen {WORKSPACE_ID} und {ARTIFACT_ID} durch die entsprechenden Werte.

Eine neue Umgebung erstellen

Sie können eine neue leere Umgebung mit der folgenden API 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 Stagingbibliothek-APIs zum Hochladen/Löschen verwenden, um den Bibliotheksbereich in der Umgebung zu verwalten.

Überprüfen der veröffentlichten Bibliotheken für die Umgebung

Vor dem Hinzufügen/Löschen der Bibliothek können Sie die API zum Abrufen veröffentlichter Bibliotheken verwenden, um zu überprüfen, welche Bibliotheken derzeit wirksam sind.

  • Beispielanforderung

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

  • Beispiel für eine Antwort

    {
    "customLibraries": {
        "wheelFiles": [
            "samplewheel-0.18.0-py2.py3-none-any.whl"
        ],
        "pyFiles": [
            "samplepython.py"
        ],
        "jarFiles": [
            "samplejar.jar"
        ],
        "rTarFiles": [
            "sampleR.tar.gz"
        ]
    },
    "environmentYml": "dependencies:\r\n- pip:\r\n  - matplotlib==3.4.3"
}

Hochladen der Bibliotheken

Die API zum Hochladen der Stagingbibliothek akzeptiert jeweils eine Datei. Die unterstützten Dateitypen sind WHL, .jar, .tar.gz, .py und environment.yml für öffentliche Bibliothek. Sie können die Datei über den Inhaltstyp "multipart/form-data" angeben.

Hinweis

  • Um die öffentliche Bibliothek effizienter zu bearbeiten, empfiehlt es sich dringend, alle erwarteten Bibliotheken aus PyPI und Conda in einer environment.yml Datei zu verfassen.
  • Die Upload-API ermöglicht bis zu 200 MB Datei in einer Anforderung, Bibliothek, die diesen Größengrenzwert überschreitet, wird derzeit in der öffentlichen API nicht unterstützt.

  • Beispielanforderungen

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

Löschen der Bibliotheken

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

Hinweis

  • Wenn Sie environment.yml als die zu löschende Datei angeben, entfernen Sie alle öffentlichen Bibliotheken.
  • Wenn Sie eine Teilmenge der vorhandenen öffentlichen Bibliothek entfernen möchten, verwenden Sie stattdessen die Upload-Bbibliothek, und laden Sie eine environment.yml hoch, die nur die erwarteten Bibliotheken enthält. Der hochgeladene environment.yml ersetzt den vorhandenen Abschnitt der öffentlichen Bibliothek vollständig.

  • Beispielanforderungen

    DELETE https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/staging/libraries?libraryToDelete=fuzzywuzzy-0.18.0-py2.py3-none-any.whl

Verwalten des Staging-Spark-Compute

Sie können die Spark-Compute für das Updatestaging verwenden, um die Sparkberechnung zu verwalten.

Überprüfen der veröffentlichten Sparkberechnung für die Umgebung

Bevor Sie die Konfigurationen für die Umgebung ändern, können Sie die veröffentlichte Spark-Compute-API verwenden, um zu überprüfen, welche Spark-Computekonfigurationen derzeit effektiv sind.

  • Beispielanforderung

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

  • Beispiel für eine Antwort

    {
    "instancePool": {
        "name": "Starter Pool",
        "type": "Workspace"
    },
    "driverCores": 4,
    "driverMemory": "56g",
    "executorCores": 4,
    "executorMemory": "56g",
    "dynamicExecutorAllocation": {
        "enabled": false,
        "minExecutors": 1,
        "maxExecutors": 1
    },
    "sparkProperties": {
        "spark.acls.enable": "false"
    },
    "runtimeVersion": "1.2"
}

Aktualisieren der Konfiguration von ws1

Sie können die Spark-Laufzeit aktualisieren, zu einem anderen Pool wechseln, die Computekonfiguration verfeinern und Spark-Eigenschaften hinzufügen/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. Die vollständige Liste der verfügbaren benutzerdefinierten Pools im Arbeitsbereich nach REST-API finden Sie unter Benutzerdefinierte Pools – Liste der benutzerdefinierten Pools im Arbeitsbereich.

Wenn Sie eine vorhandene Spark-Eigenschaft entfernen möchten, müssen Sie den Wert mit null mit dem Schlüssel angeben, den Sie entfernen möchten, wie im folgenden Beispiel gezeigt.

  • Beispielanforderung

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

{
    "instancePool": {
        "name": "Starter Pool",
        "type": "Workspace"
    },
    "driverCores": 4,
    "driverMemory": "56g",
    "executorCores": 4,
    "executorMemory": "56g",
    "dynamicExecutorAllocation": {
        "enabled": false,
        "minExecutors": 1,
        "maxExecutors": 1
    },
    "sparkProperties": {
        "spark.acls.enable": null
    },
    "runtimeVersion": "1.2"
}

Effektive Änderungen vornehmen

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

Vorbereiten einer Veröffentlichung

Die Umgebung kann jeweils eine Veröffentlichung akzeptieren. Bevor Sie Ihre Umgebung veröffentlichen, können Sie den Status der Umgebung überprüfen und eine endgültige Überprüfung der Stagingänderungen vornehmen. Sobald die Umgebung erfolgreich veröffentlicht wurde, werden alle Konfigurationen im Stagingstatus wirksam.

  • Schritt 1: Abrufen der Metadaten der Umgebung

    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 keine fortlaufende Veröffentlichung vorhanden ist, bevor Sie mit dem nächsten Schritt fortfahren.

  • Schritt 2: Abrufen der Stagingbibliotheken/Spark-Compute, um eine endgültige Überprüfung zu erhalten

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

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

Auslösen der Veröffentlichung der Umgebung

Die Änderungen, die Sie für die Stagingbibliotheken und Spark Compute vorgenommen haben, werden zwischengespeichert, erfordern jedoch, dass die Veröffentlichung wirksam wird. Folgen Sie dem folgenden Beispiel, um die Veröffentlichung auszulösen.

  • Beispielanforderung

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

  • Beispiel für eine Antwort

    {
    "publishDetails":
    {
        "state": "Running",
        "targetVersion": "46838a80-5450-4414-bea0-40fb6f3e0c0d",
        "startTime": "2024-03-29T14:17:09.0697022Z",
        "componentPublishInfo": {
            "sparkLibraries": {
                "state": "Running"
            },
            "sparkSettings": {
                "state": "Running"
            }
        }
    }
}

Während der Veröffentlichung 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

Zugehöriger Inhalt