De omgeving beheren via openbare API's

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.

De omgevings-API's migreren naar hun stabiele GA-versie

Belangrijk

De GA-release bevat updates in het aanvraag-/antwoordcontract van bestaande API's, API-afschaffingen en nieuwe API's. U vindt de details in de volgende secties.
Er wordt een nieuwe queryparameter beta geïntroduceerd om de overgang van wijzigingen in het aanvraag-/antwoordcontract te vergemakkelijken. De beta queryparameter wordt standaard ingesteld True op 31 maart 2026, waardoor de preview-contracten nog steeds beschikbaar zijn. Stel de waarde in op False om de stabiele releaseversie van de contracten te gebruiken.
Preview de queryparameter is vervangen door beta. Voor compatibiliteit met eerdere versies wordt preview nog steeds ondersteund en gedraagt zich hetzelfde als bèta.
De binnenkort te vervallen API's worden tot 31 maart 2026 ondersteund, gebruik de nieuw geïntroduceerde API's om ze zo snel mogelijk te vervangen.

API's met update van aanvraag-/antwoordcontract

Categorie	API (Application Programming Interface)	Beschrijving	Opmerkingen	Preview-versie swagger	Releaseversie Swagger
Itembewerking	Omgeving publiceren	Activeer de publicatiebewerking van de omgeving met de huidige wijzigingen die in behandeling zijn.	Update in reactie op het contract.	Publiceeromgeving (Preview)	Omgeving publiceren
Opstelling	Bibliotheken voor staging weergeven	Haal de volledige lijst met testbibliotheken op. Deze lijst bevat de gepubliceerde en in behandeling zijnde bibliotheken.	Update in reactie op het contract.	Faseringsbibliotheken weergeven (preview)	Staging-bibliotheken weergeven
Opstelling	Staging-Spark-berekeningen lijst weergeven	Haal de volledige faserings-rekenconfiguraties op. De faseringsconfiguraties omvatten de gepubliceerde en in behandeling zijnde rekenconfiguraties.	Update in reactie op het contract.	Fasering van Spark-rekenproces weergeven (preview)	Staging Spark-rekenprocessen weergeven
Opstelling	Spark-rekenproces bijwerken	Werk de rekenconfiguraties en Spark-eigenschappen voor een omgeving bij.	De bijwerking in de aanvraag- en antwoordcontracten.	Spark-rekenproces bijwerken (preview)	Spark-rekenproces bijwerken
Gepubliceerd	Gepubliceerde bibliotheken weergeven	Haal de bibliotheken op die zijn gepubliceerd en effectief zijn in Spark-sessies.	Update in reactie op het contract.	Gepubliceerde bibliotheken opsommen (voorbeeld)	Gepubliceerde bibliotheken weergeven
Gepubliceerd	Gepubliceerde Spark-berekening weergeven	Haal de Spark-rekenconfiguraties en Spark-eigenschappen op die zijn gepubliceerd en effectief zijn in Spark-sessies.	Update in reactie op het contract.	Gepubliceerde bibliotheken opsommen (voorbeeld)	Gepubliceerde bibliotheken weergeven

De beta parameter wordt standaard ingesteld True op tot 31 maart 2026, dat wil bijvoorbeeld dat het systeem de parameter True beschouwt alsof de aanvraag wordt verzonden zonder deze parameter op te geven tot de afschaffingsdatum. We raden u ten zeerste aan uw implementaties naar de stabiele versie te migreren door de beta parameter zo snel mogelijk expliciet in te False stellen.

Api List staging libraries gebruiken als voorbeeld, met een update in het API-antwoord.

Bij het verzenden van de aanvraag met beta parameter als True

Voorbeeldaanvraag:

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

Voorbeeldantwoord:

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

Bij het verzenden van de aanvraag met preview parameter als False

Voorbeeldaanvraag:

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

Voorbeeldantwoord:

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

Afgeschafte API's

Belangrijk

De API's die worden afgeschaft, blijven tot 31 maart 2026 ondersteund. We raden u ten zeerste aan om zo snel mogelijk nieuwe API's te gebruiken om uw implementaties te vervangen.

Categorie	API (Application Programming Interface)	Beschrijving	Notitie
Opstelling	Faseringsbibliotheken uploaden	Voeg één aangepaste bibliotheek of één/meerdere openbare bibliotheek toe in de omgeving.	Ondersteuning tot 31 maart 2026: gebruik de zojuist geïntroduceerde `Import external libraries`/`Upload custom library` API's om te vervangen.
Opstelling	Faseringsbibliotheken verwijderen	Eén aangepaste faseringsbibliotheek of alle openbare bibliotheken verwijderen.	Ondersteuning tot 31 maart 2026: gebruik de zojuist geïntroduceerde `Remove external library`/`Delete custom library` API's om te vervangen.

Hieronder ziet u enkele voorbeelden voor de scenario's bij het beheren van faseringsbibliotheken.

De openbare bibliotheken in uw omgeving toevoegen

Eerder kunt u API gebruiken Upload staging libraries om het bijgewerkte YAML-bestand te uploaden en nu kunt u API gebruiken Import external libraries om de bijgewerkte YAML te importeren.
Eén openbare bibliotheek in uw omgeving verwijderen

Eerder kunt u API gebruiken Upload staging libraries om het bijgewerkte YAML-bestand te uploaden en nu kunt u API gebruiken Remove external library om het te verwijderen.
Alle openbare bibliotheek in uw omgeving verwijderen

Eerder kunt u API gebruiken Delete staging libraries om alle openbare bibliotheken te verwijderen en nu kunt u API gebruiken Remove external library om de openbare bibliotheken één voor één te verwijderen of om Import external libraries een leeg YAML-bestand te uploaden om dezelfde functies te bereiken.

Nieuwe API's

Categorie	API (Application Programming Interface)	Beschrijving	Notitie
Itembewerking	Omgeving maken met definitie	Maak een nieuwe omgeving met definitie.	Nieuwe API.
Itembewerking	Omgevingsdefinitie ophalen	Haal de definitie van een omgeving op.	Nieuwe API.
Itembewerking	Omgevingsdefinitie bijwerken	Werk de definitie van een omgeving bij.	Nieuwe API.
Opstelling	Externe bibliotheken importeren	Upload externe bibliotheken als een environment.yml-bestand naar de omgeving. De lijst met bestaande externe bibliotheken in een omgeving wordt vervangen.	Nieuwe API.
Opstelling	Externe bibliotheken exporteren	Haal de volledige externe bibliotheken op als een environment.yml-bestand .	Nieuwe API.
Opstelling	Externe bibliotheek verwijderen	Een externe bibliotheek uit een omgeving verwijderen. Deze API accepteert één bibliotheek tegelijk.	Nieuwe API.
Opstelling	Aangepaste bibliotheek uploaden	Upload een aangepast pakket in de omgeving. Met deze API kan één bestand tegelijk worden geüpload. De ondersteunde bestandsindelingen zijn .jar, .py, .whl en .tar.gz.	Nieuwe API.
Opstelling	Aangepaste bibliotheek verwijderen	Verwijder een aangepast pakket uit de omgeving. Plaats de volledige naam van het aangepaste pakket met de extensie in de API-aanvraag om het te verwijderen.	Nieuwe API.
Gepubliceerd	Externe bibliotheken exporteren	Haal de gepubliceerde externe bibliotheken op als een environment.yml-bestand .	Nieuwe API.

APIs zonder bijwerking

Categorie	API (Application Programming Interface)	Beschrijving
Itembewerking	Omgeving maken	Maak een nieuwe lege omgeving in de werkruimte.
Itembewerking	Omgeving ophalen	Haal de metagegevens van een omgeving op. Het antwoord bevat de status van de omgeving.
Itembewerking	Omgeving verwijderen	Een bestaande omgeving verwijderen.
Itembewerking	Omgeving weergeven	Haal de lijst met omgevingen in een werkruimte op.
Itembewerking	Omgeving bijwerken	Werk de metagegevens van een omgeving bij, zoals de naam en beschrijving.
Itembewerking	Publicatieomgeving annuleren	Annuleer een lopende publicatiebewerking van de omgeving.

Zie Item-API's - Omgeving voor meer informatie over de openbare API's van de omgeving.

Use cases voor openbare API voor milieu

Belangrijk

Deze sectie wordt gedemonstreerd met de stabiele releaseversie van de API's.

In deze sectie ziet u hoe u de API's gebruikt om specifieke scenario's te bereiken bij het beheren van de omgeving. U kunt de {WORKSPACE_ID} en {ARTIFACT_ID} eigenschappen in de volgende voorbeelden vervangen door de juiste waarden.

Een nieuwe omgeving maken

Gebruik de volgende API om een nieuwe lege omgeving te maken.

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 het uploaden en verwijderen van faseringsbibliotheken gebruiken om de bibliotheeksectie in de omgeving te beheren.

De gepubliceerde bibliotheken voor de omgeving controleren

Voordat u een bibliotheek toevoegt of verwijdert, gebruikt u de API Gepubliceerde bibliotheken ophalen om te controleren welke bibliotheken momenteel effectief zijn.

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Openbare bibliotheken importeren of aangepaste bibliotheek uploaden

U kunt externe bibliotheken importeren en aangepaste bibliotheek-API's uploaden om nieuwe openbare/aangepaste bibliotheken toe te voegen aan uw omgeving. De API voor externe bibliotheken importeren accepteert environment.yml bestand terwijl de ondersteunde bestandstypen .whl, .jar, .tar.gz.py zijn voor het uploaden van aangepaste bibliotheek-API.

Notitie

Als u de openbare bibliotheek efficiënter wilt bewerken, raden we u aan om alle verwachte bibliotheken van PyPI en Conda op te stellen in een environment.yml-bestand .

Met de upload-API kan een bestand van 200 MB in één aanvraag worden uitgevoerd. Een bibliotheek die deze limiet overschrijdt, wordt momenteel niet ondersteund in openbare API's.

Voorbeeldaanvragen

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

De aangepaste bibliotheek verwijderen

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

Notitie

Als u een subset van de bestaande openbare bibliotheken of alle bibliotheken wilt verwijderen, importeert u een bijgewerkt YAML-bestand via Import public libraries de API.

Voorbeeldaanvragen

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

Spark-rekenkracht voor testomgeving 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, gebruikt u de Get Published Spark Compute-API om te controleren welke Spark-rekenconfiguraties momenteel effectief zijn.

Voorbeeldaanvraag

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

Voorbeeldrespons

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

De rekenconfiguraties bijwerken

U kunt de Spark-runtime bijwerken, overschakelen naar een andere pool, de rekenconfiguratie verfijnen en Spark-eigenschappen toevoegen of 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 Pools - Lijst Werkruimte Aangepaste Pools via REST API voor de volledige lijst van beschikbare aangepaste pools in de werkruimte.

Als u een bestaande Spark-eigenschap wilt verwijderen, geeft u de waarde op zoals null met de sleutel die u wilt verwijderen.

Voorbeeldaanvraag

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

De wijzigingen effectief maken

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

Voorbereiden op een publicatiebewerking

De omgeving kan één publicatiebewerking tegelijk accepteren. Voordat u uw omgeving publiceert, valideert u de status van de omgeving en controleert u de faseringswijzigingen. Nadat de omgeving succesvol is gepubliceerd, worden alle configuraties in de stageringsstatus effectief.

Stap 1: Haal de metagegevens van de omgeving op.
```
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 zien. Zorg ervoor dat er geen publicatiebewerking wordt uitgevoerd voordat u naar de volgende stap gaat.

Stap 2: Haal de faseringsbibliotheken/Spark-rekenkracht op om een definitieve beoordeling te krijgen.

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

De publicatiebewerking van de omgeving activeren

De wijzigingen die u hebt aangebracht voor de faseringsbibliotheken en Spark-rekenkracht, worden in de cache opgeslagen, maar ze vereisen dat publiceren effectief wordt. Gebruik het volgende voorbeeld om de publicatiebewerking te activeren. Reactie volgt het LRO-patroon (Long Running Operations) en de HTTP-antwoordcode 202 kan worden geretourneerd.

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Tijdens de publicatiebewerking 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

Feedback

Is deze pagina nuttig?

Last updated on 2025-11-21

Share via

De omgeving beheren via openbare API's

De omgevings-API's migreren naar hun stabiele GA-versie

API's met update van aanvraag-/antwoordcontract

Afgeschafte API's

Nieuwe API's

APIs zonder bijwerking

Use cases voor openbare API voor milieu

Een nieuwe omgeving maken

Faseringsbibliotheken beheren

De gepubliceerde bibliotheken voor de omgeving controleren

Openbare bibliotheken importeren of aangepaste bibliotheek uploaden

De aangepaste bibliotheek verwijderen

Spark-rekenkracht voor testomgeving beheren

Controleer de gepubliceerde Spark-berekening voor de omgeving

De rekenconfiguraties bijwerken

De wijzigingen effectief maken

Voorbereiden op een publicatiebewerking

De publicatiebewerking van de omgeving activeren

Gerelateerde inhoud

Feedback

Aanvullende resources