Delen via

De omgeving beheren via openbare API's

  • Artikel

De MICROSOFT Fabric REST API biedt een service-eindpunt voor de CRUD-bewerkingen (Create, Read, Update en Delete) van een Fabric-item. In dit artikel worden de beschikbare REST API's van de omgeving en het bijbehorende gebruik beschreven.

Belangrijk

Deze functie is beschikbaar als preview-versie.

Samenvatting van beschikbare omgevings-API's

API Beschrijving Categorie
Omgeving maken Maak een nieuwe omgeving in de werkruimte. Algemeen
Omgeving ophalen Haal de metagegevens van een omgeving op. Het antwoord bevat de status van de omgeving. Algemeen
Omgeving bijwerken Werk de metagegevens van een omgeving bij, zoals de naam en beschrijving. Algemeen
Omgeving verwijderen Een bestaande omgeving verwijderen. Algemeen
Omgeving weergeven in werkruimte Haal de lijst met omgevingen op in een werkruimte. Algemeen
Omgeving publiceren Activeer de publicatie van de omgeving met de huidige wijzigingen die in behandeling zijn. Algemeen
Annulering publiceren Een doorlopende publicatie van de omgeving annuleren Algemeen
Gepubliceerde Spark-rekenkracht ophalen Haal de Spark-rekenconfiguraties op die effectief zijn. Spark-rekenproces
Faserings-Spark-rekenproces ophalen Haal de volledige faserings-rekenconfiguraties op. De faseringsconfiguraties omvatten de gepubliceerde en in behandeling zijnde rekenconfiguraties. Spark-rekenproces
Gepubliceerde bibliotheken ophalen Haal de bibliotheeklijst op die effectief is. Bibliotheken
Faseringsbibliotheken ophalen Haal de volledige lijst met faseringsbibliotheken op. Deze lijst bevat de gepubliceerde en in behandeling zijnde bibliotheken. Bibliotheken
Faseringsbibliotheken uploaden Eén aangepaste bibliotheek of één/meerdere openbare bibliotheek toevoegen in de omgeving. Bibliotheken
Faseringsbibliotheken verwijderen Eén aangepaste faseringsbibliotheek of alle openbare bibliotheek verwijderen. Bibliotheken

Meer informatie over de openbare API's van de omgeving in Item-API's - Omgeving

Use cases voor openbare API voor omgeving

In deze sectie wordt u begeleid bij verschillende veelvoorkomende scenario's bij het omgaan met de omgeving. U kunt de {WORKSPACE_ID} en {ARTIFACT_ID} in de volgende voorbeelden vervangen door de juiste waarden.

Een nieuwe omgeving maken

U kunt een nieuwe lege omgeving maken met behulp van de volgende API.

  • Voorbeeldaanvraag

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

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

Faseringsbibliotheken beheren

U kunt de API's voor faseringsbibliotheken uploaden/verwijderen gebruiken om de bibliotheeksectie in de omgeving te beheren

De gepubliceerde bibliotheken voor de omgeving controleren

Voordat u een bibliotheek toevoegt of verwijdert, kunt u de API voor gepubliceerde bibliotheken gebruiken om te controleren welke bibliotheken momenteel effectief zijn.

  • Voorbeeldaanvraag

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

  • Voorbeeldrespons

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

De bibliotheken uploaden

De API voor het uploaden van faseringsbibliotheek accepteert één bestand tegelijk. De ondersteunde bestandstypen zijn .whl, .jar, .tar.gz, .py en environment.yml voor openbare bibliotheek. U kunt het bestand opgeven via het inhoudstype multipart/form-data.

Notitie

  • Om de openbare bibliotheek efficiënter te bewerken, is het raadzaam om alle verwachte bibliotheken van PyPI en conda op te stellen in een environment.yml-bestand.
  • De upload-API staat maximaal 200 MB-bestand in één aanvraag toe. Bibliotheek die deze limiet overschrijdt, wordt momenteel niet ondersteund in de openbare API.

  • Voorbeeldaanvragen

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

De bibliotheken verwijderen

Door de volledige naam van het bibliotheekbestand op te geven met het achtervoegsel van het type, kunt u één bibliotheek tegelijk verwijderen.

Notitie

  • Als u opgeeft environment.yml dat het bestand moet worden verwijderd, verwijdert u alle openbare bibliotheken.
  • Als u een subset van een bestaande openbare bibliotheek wilt verwijderen, gebruikt u in plaats daarvan de uploadbibliotheek en uploadt u een environment.yml die alleen de verwachte bibliotheken bevat. De geüploade environment.yml vervangt de bestaande sectie van de openbare bibliotheek volledig.

  • Voorbeeldaanvragen

    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

Faserings-Spark-rekenproces beheren

U kunt de spark-berekening voor het faseren van updates gebruiken om de Spark-berekening te beheren.

Controleer de gepubliceerde Spark-berekening voor de omgeving

Voordat u de configuraties voor de omgeving wijzigt, kunt u de gepubliceerde Spark-reken-API gebruiken om te controleren welke Spark-rekenconfiguraties momenteel effectief zijn.

  • Voorbeeldaanvraag

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

  • Voorbeeldrespons

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

De rekenconfiguraties bijwerken

U kunt de Spark-runtime bijwerken, overschakelen naar een andere pool, de rekenconfiguratie verfijnen en Spark-eigenschappen toevoegen/verwijderen door de aanvraagbody van deze API te bewerken.

U kunt de gekoppelde pool wijzigen door de naam en de pool op te geven. Geef de naam Starter Pool van de pool op voor het overschakelen van de pool naar standaardinstellingen. Zie Aangepaste groepen - Aangepaste pools weergeven voor aangepaste pools voor werkruimten om de volledige lijst met beschikbare aangepaste pools van de werkruimte op te halen

Als u een bestaande Spark-eigenschap wilt verwijderen, moet u de waarde opgeven zoals null bij de sleutel die u wilt verwijderen, zoals wordt weergegeven in het volgende voorbeeld.

  • Voorbeeldaanvraag

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

De wijzigingen effectief maken

Gebruik de volgende sets API's om de wijzigingen te publiceren.

Voorbereiden op een publicatie

De omgeving kan één publicatie tegelijk accepteren. Voordat u uw omgeving publiceert, kunt u de status van de omgeving valideren en de faseringswijzigingen definitief controleren. Zodra de omgeving is gepubliceerd, worden alle configuraties in de faseringsstatus effectief.

  • Stap 1: de metagegevens van de omgeving ophalen

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

    In de hoofdtekst van het antwoord kunt u duidelijk de status van de omgeving vertellen. Zorg ervoor dat er geen doorlopende publicatie is voordat u naar de volgende stap gaat.

  • Stap 2: de faseringsbibliotheken/Spark-berekening ophalen om een definitieve beoordeling te krijgen

    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

De publicatie van de omgeving activeren

De wijzigingen die u hebt aangebracht voor de faseringsbibliotheken en Spark-rekenkracht, worden in de cache opgeslagen, maar publicatie moet effectief worden. Volg het volgende voorbeeld om de publicatie te activeren.

  • Voorbeeldaanvraag

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

  • Voorbeeldrespons

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

Tijdens het publiceren kunt u ook de volgende API aanroepen om deze te annuleren .

  • Voorbeeldaanvraag

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

Gerelateerde inhoud