Zdieľať cez


Správa prostredia prostredníctvom verejných rozhraní API

Rozhranie Microsoft Fabric REST API poskytuje koncový bod služby na vytváranie, čítanie, aktualizáciu a odstraňovanie operácií položky služby Fabric. Tento článok popisuje dostupné rozhrania REST API prostredia a ich používanie.

Dôležité

  • Nové vydanie obsahuje nové rozhrania API, zastarané rozhrania API a zmeny v odpovedi na rozhranie API/zmluve na požiadavku. V tabuľke v nasledujúcej časti sa sumarizujú všetky zmeny rozhrania API.
  • Rozhrania API, ktoré sa majú zastarať, budú pokračovať v podpore do 30. júna 2025. Zmeny odpovede/žiadosti zmluvy budú účinné okamžite po uvoľnení pozemky.

Súhrn rozhraní API prostredia

Kategória Rozhranie API Description Poznámka
Operácia položky Vytvorenie prostredia Vytvorte v pracovnom priestore nové prázdne prostredie. Žiadna zmena
Operácia položky Vytvorenie prostredia pomocou definície Vytvorte nové prostredie pomocou položky Definícia. nové rozhrania API
Operácia položky Odstránenie prostredia Odstrániť existujúce prostredie. Žiadna zmena
Operácia položky Uviesť prostredie Získanie zoznamu prostredia v pracovnom priestore. Žiadna zmena
Operácia položky Získať prostredie Získajte metaúdaje prostredia. Odpoveď obsahuje stav prostredia. aktualizácie zmluvy odpoveď
Operácia položky Získať definíciu prostredia Získajte definíciu prostredia. nové rozhrania API
Operácia položky Aktualizácia prostredia Aktualizujte metaúdaje prostredia, ako sú napríklad názov a popis. Žiadna zmena
Operácia položky Aktualizácia definície prostredia Aktualizujte definíciu prostredia. nové rozhrania API
Operácia položky Publikovanie prostredia Publikovanie prostredia sa spustí s aktuálnymi čakajúcimi zmenami. aktualizácie zmluvy odpoveď
Operácia položky Zrušenie publikovania prostredia Zrušenie priebežného publikovania prostredia Žiadna zmena
Inscenácia Zoznam fázových knižníc Získajte úplný zoznam knižníc na pracovnej obrazovke. Tento zoznam obsahuje publikované a čakajúce knižnice. aktualizácie zmluvy odpoveď
Inscenácia Import externých knižníc Nahrajte externé knižnice ako environment.yml súbor do prostredia. Prepíše zoznam existujúcich externých knižníc v prostredí. nové rozhrania API
Inscenácia Export externých knižníc Získanie úplných externých knižníc ako súbor environment.yml. nové rozhrania API
Inscenácia Odstránenie externej knižnice Odstránenie externej knižnice z prostredia. Toto rozhranie API prijíma naraz jednu knižnicu. nové rozhrania API
Inscenácia Nahratie vlastnej knižnice Nahrajte vlastný balík v prostredí. Toto rozhranie API umožňuje nahrávanie jedného súboru po jednom. Podporované formáty súborov sú .jar, .py, .whl a .tar.gz. nové rozhrania API
Inscenácia Odstránenie vlastnej knižnice Odstránenie vlastného balíka z prostredia. Vložte vlastný balík s celým názvom s rozšírením do požiadavky rozhrania API, aby ste ho odstránili. nové rozhrania API
Inscenácia Nahrať fázové knižnice Pridanie jednej vlastnej alebo jednej alebo viacerých verejných knižníc v prostredí. Môže sa zastarať
Inscenácia Odstránenie fázových knižníc Odstráňte jednu fázovú vlastnú knižnicu alebo všetku verejnú knižnicu. Môže sa zastarať
Inscenácia Nastavenie spark v zozname Získajte úplné fázové výpočtové konfigurácie. Fázové konfigurácie zahŕňajú publikované a čakajúce výpočtové konfigurácie. aktualizácie zmluvy odpoveď
Inscenácia Aktualizácia nastavení Spark Aktualizácia konfigurácií výpočtov a vlastností služby Spark pre prostredie aktualizácie zmluvy so žiadosťou/odpoveďou
Publikované Zoznam publikovaných knižníc Získajte knižnice, ktoré sú publikované a účinné v reláciách Spark. aktualizácie zmluvy odpoveď
Publikované Nastavenie Zoznamu publikovaných spark Získajte konfigurácie výpočtovej služby Spark a vlastnosti Spark, ktoré sú publikované a účinné v reláciách Spark. aktualizácie zmluvy odpoveď
Publikované Export externých knižníc Získanie publikovaných externých knižníc ako environment.yml súboru. nové rozhrania API

Ďalšie informácie o existujúcich verejných rozhraniach API prostredia v rozhraniach API item – Environment

Podrobnosti o aktualizácii verejného rozhrania API prostredia

Táto časť popisuje nadchádzajúce aktualizácie pre existujúce rozhrania API.

Získať prostredie

V odpovedi rozhrania API funkcie Získať prostredie sa parameter startTime stane startDateTime a parameter endTime sa stane endDateTime. Predstavujú čas začiatku/konca operácie publikovania.

Poznámka

StartTime a endTime používajú formát Date-Time, zatiaľ čo startDateTime a endDateTime budú reťazcov , ktorý je v UTC a má formát RRRR-MM-DDTHH:mm:ssZ.

  • Rozhranie

    GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/environments/{environmentId}
    
  • Pôvodná vzorová odpoveď

    {
      "displayName": "Environment_1",
      "description": "An Environment description",
      "type": "Environment",
      "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "id": "5b218778-e7a5-4d73-8187-f10824047715",
      "properties": {
        "publishDetails": {
          "state": "Success",
          "targetVersion": "46838a80-5450-4414-bea0-40fb6f3e0c0d",
          "startTime": "2024-03-29T14:17:09.0697022Z",
          "endTime": "2024-03-29T14:48:09.0697022Z",
          "componentPublishInfo": {
            "sparkLibraries": {
              "state": "Success"
            },
            "sparkSettings": {
              "state": "Success"
            }
          }
        }
      }
    }
    
  • Nová vzorová odpoveď

    {
      "displayName": "Environment_1",
      "description": "An Environment description",
      "type": "Environment",
      "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "id": "5b218778-e7a5-4d73-8187-f10824047715",
      "properties": {
        "publishDetails": {
          "state": "Success",
          "targetVersion": "46838a80-5450-4414-bea0-40fb6f3e0c0d",
          "startDateTime": "2024-03-29T14:17:09Z",
          "endDateTime": "2024-03-29T14:48:09Z",
          "componentPublishInfo": {
            "sparkLibraries": {
              "state": "Success"
            },
            "sparkSettings": {
              "state": "Success"
            }
          }
        }
      }
    }
    

Publikovanie prostredia

Rozhranie API publikovania prostredia bude podporovať dlhotrvajúce operácie začínajúce od vydania, mení sa zmluva s odpoveďou. Koncový bod zostáva pri odosielaní žiadostí rovnaký.

  • Rozhranie

    POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/environments/{environmentId}/staging/publish
    
  • Pôvodná vzorová odpoveď

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

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

Zoznam fázových alebo publikovaných knižníc

Tieto dve rozhrania API môžu získať úplný zoznam fázových/publikovaných knižníc prostredia. Koncové body zostávajú pri odosielaní požiadaviek rovnaké, zatiaľ čo knižnice sa vrátia s inou štruktúrou.

  • Rozhrania

    Získanie fázových knižníc

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

    Získanie publikovaných knižníc

    GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/environments/{environmentId}/libraries
    
  • Pôvodná vzorová odpoveď

    
    {
      "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"
    }
    
    
  • Nová vzorová odpoveď

    {
      "libraries": [
        {
          "name": "samplewheel-0.18.0-py2.py3-none-any.whl",
          "libraryType": "Custom"
        },
        {
          "name": "samplepython.py",
          "libraryType": "Custom"
        },
        {
          "name": "samplejar.jar",
          "libraryType": "Custom"
        },
        {
          "name": "sampleR.tar.gz",
          "libraryType": "Custom"
        },
        {
          "name": "fuzzywuzzy",
          "libraryType": "External",
          "version": "0.0.1"
        },
        {
          "name": "matplotlib",
          "libraryType": "External",
          "version": "0.0.1"
        }
      ],
      "continuationToken": "null",
      "continuationUri": "null"
    }
    
    

Nastavenie pracovnej verzie/publikovanej služby Spark

Tieto dve rozhrania API môžu získať konfigurácie a vlastnosti výpočtovej služby Spark pre dané prostredie. Koncové body zostávajú pri odosielaní požiadaviek rovnaké, zatiaľ čo konfigurácie sa vrátia s inou štruktúrou. Vlastnosti Spark sa zmenia na zoznam.

  • Rozhrania

    Načítanie nastavení Spark

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

    Publikovanie nastavení Spark

    GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/environments/{environmentId}/sparkcompute
    
  • Pôvodná vzorová odpoveď

    {
      "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": {
        "spark.acls.enable": "false"
      },
      "runtimeVersion": "1.2"
    }
    
  • Nová vzorová odpoveď

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

Aktualizácia nastavení Spark

Toto rozhranie API je určené na aktualizáciu výpočtovej služby Spark a vlastností prostredia. Po uvoľnení sa aktualizuje zmluva vlastnosti Spark na požiadanie a odpoveď.

  • Pôvodná vzorová požiadavka

    PATCH https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/environments/707cfd07-cbf1-41da-aad7-dd157ddb8c11/staging/sparkcompute
    
    {
      "instancePool": {
        "name": "MyWorkspacePool",
        "type": "Workspace"
      },
      "driverCores": 4,
      "driverMemory": "56g",
      "executorCores": 4,
      "executorMemory": "56g",
      "dynamicExecutorAllocation": {
        "enabled": false,
        "minExecutors": 1,
        "maxExecutors": 1
      },
      "sparkProperties": {
        "spark.acls.enable": "false",
        "spark.admin.acls": null
      },
      "runtimeVersion": "1.2"
    }
    
  • Nová vzorová žiadosť

    PATCH https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/environments/707cfd07-cbf1-41da-aad7-dd157ddb8c11/staging/sparkcompute
    
    {
      "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"
    }
    
  • Pôvodná vzorová odpoveď

    {
      "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": {
        "spark.acls.enable": "false"
      },
      "runtimeVersion": "1.2"
    }
    
  • Nová vzorová odpoveď

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

Prípady použitia verejného rozhrania API prostredia

Dôležité

Nové rozhrania API a zmeny zmluvy nie sú súčasťou tejto časti.

V tejto časti sa dozviete, ako používať aktuálne dostupné rozhrania API na dosiahnutie konkrétnych cieľov. Hodnoty a {WORKSPACE_ID} v nasledujúcich príkladoch môžete nahradiť {ARTIFACT_ID} vhodnými hodnotami.

Vytvorenie nového prostredia

Pomocou nasledujúceho rozhrania API môžete vytvoriť nové prázdne prostredie.

  • Vzorová požiadavka

    POST https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments
    
    {
        "displayName": "Environment_1",
        "description": "An environment description"
    }
    

Spravovanie fázových knižníc

Na správu sekcie knižnice v prostredí môžete použiť rozhrania API na nahrávanie a odstraňovanie knižníc.

Kontrola publikovaných knižníc pre prostredie

Pred pridaním alebo odstránením knižnice môžete použiť rozhranie API na získanie publikovaných knižníc, aby ste skontrolovali, ktoré knižnice sú v súčasnosti účinné.

  • Vzorová požiadavka

    GET https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/libraries
    
  • Vzorová odpoveď

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

Nahrávanie knižníc

Rozhranie API na nahrávanie vnášanej knižnice prijíma naraz jeden súbor. Podporované typy súborov sú .whl, .jar, .tar.gz, .py a environment.yml pre verejnú knižnicu. Súbor môžete zadať prostredníctvom typu obsahu multipart/form-data.

Poznámka

  • Ak chcete lepšie manipulovať s verejnou knižnicou, dôrazne sa odporúča vytvoriť všetky očakávané knižnice z rozhrania PyPI a súboru conda v súbore environment.yml.
  • Rozhranie API na nahrávanie umožňuje v jednej požiadavke súbor s veľkosťou až 200 MB, knižnica, ktorá presahuje tento limit veľkosti, sa vo verejnom rozhraní API momentálne nepodporuje.
  • Vzorové požiadavky

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

Odstránenie knižníc

Zadaním úplného názvu súboru knižnice s príponou typu môžete naraz odstrániť jednu knižnicu.

Poznámka

  • Ak ako súbor, ktorý sa má odstrániť, určíte environment.yml, odstránite všetky verejné knižnice.
  • Ak chcete odstrániť podmnožinu existujúcej verejnej knižnice, použite namiesto toho knižnicunahrávania a nahrajte environment.yml, ktorá obsahuje iba očakávané knižnice. Nahratý environment.yml úplne nahradí existujúcu verejnú knižnicu.
  • Vzorové požiadavky

    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
    

Správa pracovnej verzie Spark compute

Ak chcete spravovať výpočet Spark, môžete použiť aktualizovať fázu spark compute.

Skontrolujte publikované výpočty služby Spark pre prostredie

Pred zmenou konfigurácií prostredia môžete použiť publikované rozhranie API na výpočet služby Spark a skontrolovať, ktoré konfigurácie výpočtovej služby Spark sú v súčasnosti účinné.

  • Vzorová požiadavka

    GET https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/sparkcompute
    
  • Vzorová odpoveď

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

Aktualizácia konfigurácií výpočtových

Môžete aktualizovať modul runtime služby Spark, prepnúť do iného fondu, spresniť konfiguráciu výpočtu a pridať alebo odstrániť vlastnosti služby Spark úpravou tela požiadavky tohto rozhrania API.

Pripojený fond môžete prepnúť zadaním názvu fondu a fondu. Zadajte názov fondu, ktorý Starter Pool sa má prepnúť z fondu na predvolené nastavenia. Ak chcete získať úplný zoznam dostupných vlastných bazénov pracovného priestoru pomocou rozhrania REST API, pozrite si tému Vlastné fondy – zoznam vlastných fondov pracovného priestoru.

Ak chcete odstrániť existujúcu vlastnosť Spark, musíte zadať hodnotu null ako pomocou kľúča, ktorý chcete odstrániť, ako je to znázornené v nasledujúcom príklade.

  • Vzorová požiadavka

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

Efektívnenie zmien

Na publikovanie zmien použite nasledujúce množiny rozhraní API.

Príprava na publikovanie

Prostredie môže akceptovať jedno publikovanie po jednom. Pred publikovaním prostredia môžete overiť stav prostredia a získať poslednú kontrolu prechodných zmien. Po úspešnom publikovaní prostredia budú všetky konfigurácie v stave pracovnej verzie efektívne.

  • Krok č. 1: Získanie metaúdajov prostredia

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

    V tele odpovede môžete jasne určiť stav prostredia. Skôr než prejdete na ďalší krok, uistite sa, že prebieha žiadne publikovanie.

  • Krok 2: Získanie fázových knižníc/Spark vypočítajte, aby ste mali finálnu kontrolu

    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
    

Spustenie publikovania prostredia

Zmeny, ktoré ste vykonali v rámci fázovaných knižníc a výpočtovej službe Spark, sa uložia do vyrovnávacej pamäte, ale na to, aby sa efektívni, vyžaduje publikovanie. Publikovanie spustíte podľa nasledujúceho príkladu.

  • Vzorová požiadavka

    POST https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/staging/publish
    
  • Vzorová odpoveď

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

Počas publikovania môžete zavolať aj nasledujúce rozhranie API a zrušiť ho.

  • Vzorová požiadavka

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