Správa prostředí prostřednictvím veřejných rozhraní API

Rozhraní MICROSOFT Fabric REST API poskytuje koncový bod služby pro operace vytvoření, čtení, aktualizace a odstranění (CRUD) položky Fabric. Tento článek popisuje dostupná rozhraní REST API prostředí a jejich použití.

Migrujte rozhraní API prostředí na jejich stabilní verzi GA

Důležité

Verze GA zahrnuje aktualizace protokolu žádosti a odpovědi stávajících rozhraní API, zastarání některých rozhraní API a zavedení nových rozhraní API. Podrobnosti najdete v následujících částech.
Zavádí se nový parametr beta dotazu, který usnadňuje přechod změn kontraktu požadavků a odpovědí. Parametr beta dotazu je ve výchozím nastavení až do True31. března 2026, aby byly kontrakty ve verzi Preview stále dostupné. Nastavte hodnotu na False, aby se začala používat stabilní verze kontraktů.
Preview parametr dotazu byl nahrazen beta. Kvůli zpětné kompatibilitě se verze Preview stále podporuje a chová se stejně jako beta verze.
Rozhraní API, která budou postupně vyřazena, budou nadále podporována až do 31. března 2026. Proto použijte nově zavedená rozhraní API a nahraďte je co nejdříve.

Rozhraní API s aktualizací kontraktů žádostí a odpovědí

Kategorie	API	Popis	Poznámky	Swagger verze Preview	verze vydání swagger
Operace položky	Publikační prostředí	Aktivujte operaci publikování prostředí s aktuálními čekajícími změnami.	Aktualizace ve smlouvě o odpovědi.	Publikování prostředí (Preview)	Publikační prostředí
Příprava	Seznam testovacích knihoven	Získejte úplný seznam knihoven pro inscenace. Tento seznam obsahuje publikované a připravované knihovny.	Aktualizace ve smlouvě o odpovědi.	Výpis přípravných knihoven (Preview)	Výpis testovacích knihoven
Příprava	Výpis přípravných výpočetních procesů Spark	Získejte úplné konfigurace výpočetního testovacího prostředí. Přípravné konfigurace zahrnují publikované a čekající konfigurace výpočetních prostředků.	Aktualizace ve smlouvě o odpovědi.	Seznam sestavení Spark compute (Preview)	Výpis přípravného výpočetního prostředí Spark
Příprava	Aktualizace výpočetních prostředků Sparku	Aktualizujte výpočetní konfigurace a vlastnosti Sparku pro prostředí.	Aktualizace ve smlouvách požadavků a odpovědí.	Aktualizace výpočetních prostředků Sparku (Preview)	Aktualizace výpočetních prostředků Sparku
Publikováno	Seznam publikovaných knihoven	Získejte knihovny, které jsou dostupné a efektivní v rámci relací Sparku.	Aktualizace ve smlouvě o odpovědi.	Výpis publikovaných knihoven (Preview)	Výpis publikovaných knihoven
Publikováno	Výpis publikovaných výpočtů Sparku	Získejte konfigurace pro výpočty ve Sparku a vlastnosti Sparku, které jsou uveřejněné a účinné v relacích Sparku.	Aktualizace ve smlouvě o odpovědi.	Výpis publikovaných knihoven (Preview)	Výpis publikovaných knihoven

Parametr beta má výchozí hodnotu True až do 31. března 2026, tedy systém považuje parametr za True je-li požadavek odeslán bez určení tohoto parametru až do data vyřazení. Důrazně doporučujeme migrovat implementace do stabilní verze tím, že parametr explicitně nastavíte beta na False co nejdříve.

Jako příklad použijeme List staging libraries rozhraní API, které má aktualizovanou odpověď.

Při odesílání požadavku s parametrem beta jako True

Ukázková žádost:

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

Ukázková odpověď:

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

Při odesílání požadavku s parametrem preview jako False

Ukázková žádost:

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

Ukázková odpověď:

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

Zastaralá rozhraní API

Důležité

Rozhraní API, která mají být zastaralá, budou nadále podporována až do 31. března 2026. Důrazně doporučujeme použít nově zavedená rozhraní API k co nejrychlejšímu nahrazení vašich implementací.

Kategorie	API	Popis	Poznámka:
Příprava	Nahrání testovacích knihoven	Přidejte do prostředí jednu vlastní knihovnu nebo jednu nebo více veřejných knihoven.	Pokud potřebujete podporu až do 31. března 2026, použijte nově zavedená rozhraní API `Import external libraries`/`Upload custom library` pro nahrazení.
Příprava	Odstranění přípravných knihoven	Odstraňte jednu testovací vlastní knihovnu nebo všechny veřejné knihovny.	Pokud potřebujete podporu až do 31. března 2026, použijte nově zavedená rozhraní API `Remove external library`/`Delete custom library` pro nahrazení.

Níže je několik příkladů zahrnujících scénáře při správě přípravných knihoven.

Přidání veřejných knihoven ve vašem prostředí

Dříve můžete použít Upload staging libraries rozhraní API k nahrání aktualizovaného souboru YAML a teď můžete použít Import external libraries rozhraní API k importu aktualizovaného YAML.
Odstranění jedné veřejné knihovny ve vašem prostředí

Dříve můžete pomocí Upload staging libraries rozhraní API nahrát aktualizovaný soubor YAML a teď ho můžete odebrat pomocí Remove external library rozhraní API.
Odstranění všech veřejných knihoven ve vašem prostředí

Dříve můžete pomocí Delete staging libraries rozhraní API odstranit všechny veřejné knihovny a teď můžete pomocí Remove external library rozhraní API odebrat veřejné knihovny po jednom nebo použít Import external libraries k nahrání prázdného souboru YAML pro dosažení stejných funkcí.

Nová rozhraní API

Kategorie	API	Popis	Poznámka:
Operace položky	Vytvoření prostředí s definicí	Vytvořte nové prostředí s definicí.	Nové rozhraní API
Operace položky	Získání definice prostředí	Získejte definici prostředí.	Nové rozhraní API
Operace položky	Aktualizace definice prostředí	Aktualizujte definici prostředí.	Nové rozhraní API
Příprava	Import externích knihoven	Nahrajte externí knihovny jako soubor environment.yml do prostředí. Přepíše seznam existujících externích knihoven v prostředí.	Nové rozhraní API
Příprava	Export externích knihoven	Získejte úplné externí knihovny jako soubor environment.yml .	Nové rozhraní API
Příprava	Odstraňte externí knihovnu	Odstraňte externí knihovnu z prostředí. Toto rozhraní API přijímá najednou jednu knihovnu.	Nové rozhraní API
Příprava	Nahrání vlastní knihovny	Nahrajte vlastní balíček do prostředí. Toto rozhraní API umožňuje najednou nahrát jeden soubor. Podporované formáty souborů jsou .jar, .py, .whl a .tar.gz.	Nové rozhraní API
Příprava	Odstranění vlastní knihovny	Odstraňte z prostředí vlastní balíček. Zadejte úplný název vlastního balíčku s příponou do požadavku rozhraní API, abyste ho odebrali.	Nové rozhraní API
Publikováno	Export externích knihoven	Získejte publikované externí knihovny jako soubor environment.yml .	Nové rozhraní API

Rozhraní API bez aktualizací

Kategorie	API	Popis
Operace položky	Vytvoření prostředí	Vytvořte nové prázdné prostředí v pracovním prostoru.
Operace položky	Získání prostředí	Získejte metadata prostředí. Odpověď zahrnuje stav prostředí.
Operace položky	Smazat prostředí	Odstraňte existující prostředí.
Operace položky	Seznam prostředí	Získejte seznam prostředí v pracovním prostoru.
Operace položky	Aktualizace prostředí	Aktualizujte metadata prostředí, jako je název a popis.
Operace položky	Zrušení prostředí publikování	Zrušte probíhající operaci publikování prostředí.

Další informace o veřejných rozhraních API pro prostředí naleznete v Rozhraní API položky - Prostředí.

Případy použití veřejné API rozhraní prostředí

Důležité

Tato sekce je demonstrována se stabilní vydanou verzí rozhraní API.

Tato část ukazuje, jak pomocí rozhraní API dosáhnout konkrétních scénářů při správě prostředí. Můžete nahradit vlastnosti {WORKSPACE_ID} a {ARTIFACT_ID} v následujících příkladech příslušnými hodnotami.

Vytvoření nového prostředí

Pokud chcete vytvořit nové prázdné prostředí, použijte následující rozhraní API.

Ukázkový požadavek

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

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

Správa přípravných knihoven

K správě sekce knihovny v prostředí můžete použít rozhraní API pro nahrávání a odstraňování dočasných knihoven.

Zkontrolujte publikované knihovny pro prostředí

Před přidáním nebo odstraněním knihovny pomocí rozhraní API "Get Published Libraries" zkontrolujte, které knihovny jsou aktuálně aktivní.

Ukázkový požadavek

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

Ukázková odpověď

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

Import veřejných knihoven nebo nahrání vlastní knihovny

K přidání nových veřejných/vlastních knihoven do vašeho prostředí můžete použít Importovat externí knihovny a Nahrát vlastní knihovnu rozhraní API. Rozhraní API pro import externích knihoven přijímá environment.yml soubor, zatímco podporované typy souborů jsou .whl, .jar, .tar.gz, .py pro nahrání rozhraní API vlastní knihovny.

Poznámka:

Pokud chcete pracovat s veřejnou knihovnou efektivněji, doporučujeme vytvořit všechny očekávané knihovny z PyPI a Conda v souboru environment.yml .

Rozhraní API pro nahrávání umožňuje v jednom požadavku nahrát soubor o velikosti až 200 MB. Knihovna, která překračuje tento limit velikosti, se v současné době ve veřejných rozhraních API nepodporuje.

Ukázkové požadavky

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

Odstranění vlastní knihovny

Zadáním úplného názvu souboru knihovny s příponou typu můžete současně odstranit jednu vlastní knihovnu.

Poznámka:

Pokud chcete odebrat podmnožinu existujících veřejných knihoven nebo všechny z nich, naimportujte aktualizovaný soubor YAML prostřednictvím Import public libraries rozhraní API.

Ukázkové požadavky

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

Správa přípravného výpočetního prostředí Spark

Ke správě výpočetních prostředků Sparku můžete použít aktualizační přípravné výpočetní prostředky Sparku.

Zkontrolujte publikované výpočetní kapacity Sparku pro dané prostředí.

Než změníte konfigurace prostředí, pomocí rozhraní Get Published Spark Compute API zkontrolujte, jaké výpočetní konfigurace Sparku jsou aktuálně efektivní.

Ukázkový požadavek

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

Ukázková odpověď

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

Aktualizace konfigurací výpočetních prostředků

Modul runtime Sparku můžete aktualizovat, přepnout do jiného fondu, upřesnit konfiguraci výpočetních prostředků a přidat nebo odebrat vlastnosti Sparku úpravou textu požadavku tohoto rozhraní API.

Připojený fond můžete přepnout zadáním názvu fondu a fondu. Zadejte název fondu jako Starter Pool, aby se fond přepnul na výchozí nastavení. Úplný seznam dostupných vlastních fondů pracovního prostoru pomocí rozhraní REST API získáte v tématu Vlastní fondy – Výpis vlastních fondů pracovního prostoru.

Pokud chcete odebrat existující vlastnost Sparku, zadejte hodnotu jako null spolu s klíčem, který chcete odebrat.

Ukázkový požadavek

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

Efektivní provedení změn

K publikování změn použijte následující sady rozhraní API.

Příprava na operaci publikování

Prostředí může přijmout jednu operaci publikování najednou. Před publikováním prostředí ověřte stav prostředí a proveďte konečnou kontrolu přípravných změn. Po úspěšném publikování prostředí se všechny konfigurace v přípravném stavu stanou efektivními.

Krok 1: Získejte metadata prostředí.
```
GET https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/
```
V těle odpovědi můžete jasně rozeznat stav prostředí. Než přejdete k dalšímu kroku, ujistěte se, že neproběhne žádná operace publikování.

Krok 2: Získejte přípravné knihovny a výpočetní prostředky Sparku pro závěrečné přezkoumání.

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

Spusťte operaci publikace prostředí

Změny, které jste provedli pro přípravné knihovny a výpočetní prostředky Sparku, jsou uloženy v mezipaměti, ale musí být publikovány, aby se projevily. Pomocí dalšího příkladu aktivujte operaci publikování. Odpověď sleduje dlouhotrvající operace (LRO) a může se vrátit kód odpovědi HTTP 202.

Ukázkový požadavek

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

Ukázková odpověď

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

Během operace publikování můžete také volat následující rozhraní API, abyste ji zrušili.

Ukázkový požadavek

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

Váš názor

Byla tato stránka užitečná?

Last updated on 2025-10-09

Sdílet prostřednictvím

Správa prostředí prostřednictvím veřejných rozhraní API

Migrujte rozhraní API prostředí na jejich stabilní verzi GA

Rozhraní API s aktualizací kontraktů žádostí a odpovědí

Zastaralá rozhraní API

Nová rozhraní API

Rozhraní API bez aktualizací

Případy použití veřejné API rozhraní prostředí

Vytvoření nového prostředí

Správa přípravných knihoven

Zkontrolujte publikované knihovny pro prostředí

Import veřejných knihoven nebo nahrání vlastní knihovny

Odstranění vlastní knihovny

Správa přípravného výpočetního prostředí Spark

Zkontrolujte publikované výpočetní kapacity Sparku pro dané prostředí.

Aktualizace konfigurací výpočetních prostředků

Efektivní provedení změn

Příprava na operaci publikování

Spusťte operaci publikace prostředí

Související obsah

Váš názor

Další materiály