Megosztás a következőn keresztül:

A környezet kezelése nyilvános API-k használatával

  • Cikk

A Microsoft Fabric REST API szolgáltatásvégpontot biztosít egy Fabric-elem létrehozási, olvasási, frissítési és törlési (CRUD) műveleteihez. Ez a cikk a rendelkezésre álló környezeti REST API-kat és azok használatát ismerteti.

Fontos

Ez a funkció előzetes verzióban érhető el.

Az elérhető környezeti API-k összegzése

API Leírás Kategória
Környezet létrehozása Hozzon létre egy új környezetet a munkaterületen. Általános
Környezet lekérése Egy környezet metaadatainak lekérése. A válasz tartalmazza a környezet állapotát. Általános
Környezet frissítése Frissítse a környezet metaadatait, például a nevet és a leírást. Általános
Környezet törlése Meglévő környezet törlése. Általános
Környezet listázása a munkaterületen A munkaterület környezetének listájának lekérése. Általános
Közzétételi környezet Az aktuális függőben lévő módosításokkal aktiválja a környezet közzétételét. Általános
Lemondás közzététele A környezet folyamatos közzétételének megszakítása Általános
Közzétett Spark-számítás lekérése Szerezze be a sparkos számítási konfigurációkat, amelyek hatékonyak. Spark-számítás
Átmeneti Spark-számítás lekérése Szerezze be a teljes előkészítési számítási konfigurációt. Az előkészítési konfigurációk közé tartoznak a közzétett és függőben lévő számítási konfigurációk. Spark-számítás
Közzétett kódtárak lekérése Szerezze be a hatályos kódtárlistát. Kódtárak
Előkészítési kódtárak lekérése Szerezze be az előkészítési tár teljes listáját. Ez a lista tartalmazza a közzétett és függőben lévő kódtárakat. Kódtárak
Átmeneti kódtárak feltöltése Egy egyéni vagy egy/több nyilvános tár hozzáadása a környezetben. Kódtárak
Átmeneti kódtárak törlése Töröljön egy átmeneti egyéni tárat vagy az összes nyilvános tárat. Kódtárak

További információ a környezeti nyilvános API-król az Item API-kban – Környezet

Környezeti nyilvános API-használati esetek

Ez a szakasz a környezettel kapcsolatos gyakori forgatókönyveket ismerteti. Az alábbi példákban a megfelelő értékeket helyettesítheti {WORKSPACE_ID}{ARTIFACT_ID} .

Új környezet létrehozása

Új üres környezetet az alábbi API-val hozhat létre.

  • Mintakérelem

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

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

Átmeneti kódtárak kezelése

Az átmeneti kódtárak API-k feltöltésével/törlésével kezelheti a társzakaszt a környezetben

A közzétett kódtárak ellenőrzése a környezethez

A kódtár hozzáadása/törlése előtt a közzétett kódtárak lekérése API-val ellenőrizheti, hogy mely kódtárak jelenleg hatékonyak.

  • Mintakérelem

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

  • Mintaválasz

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

A kódtárak feltöltése

Az előkészítési kódtár feltöltésére szolgáló API egyszerre egy fájlt fogad el. A támogatott fájltípusok: .whl, .jar, .tar.gz, .py és environment.yml a nyilvános tárhoz. A fájlt a többrészes/űrlap-adat típusú tartalomtípussal adhatja meg.

Feljegyzés

  • A nyilvános kódtár hatékonyabb kezelése érdekében javasoljuk, hogy az összes várt kódtárat a PyPI-ból és a Conda-ból egy environment.yml fájlba írja.
  • A feltöltési API egy kérelemben legfeljebb 200 MB-os fájlt tesz lehetővé. A nyilvános API jelenleg nem támogatja azt a tárat, amely túllépi ezt a méretkorlátot.

  • Mintakérések

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

A kódtárak törlése

Ha megadja a teljes kódtárfájlnevet a típus utótaggal, egyszerre egy tárat törölhet.

Feljegyzés

  • Ha a törölni kívánt fájlt adja meg environment.yml , akkor az összes nyilvános tárat eltávolítja.
  • Ha el szeretné távolítani a meglévő nyilvános kódtár egy részét, használja inkább a feltöltési tárat , és töltsön fel egy environment.yml , amely csak a várt kódtárakat tartalmazza. A feltöltött environment.yml teljes egészében lecseréli a meglévő nyilvános könyvtárszakaszt.

  • Mintakérések

    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

Átmeneti Spark-számítás kezelése

A Spark-számítás kezeléséhez használhatja a Spark-számítás átmeneti frissítését.

A közzétett Spark-számítás ellenőrzése a környezethez

A környezet konfigurációinak módosítása előtt a közzétett Spark számítási API-val ellenőrizheti, hogy a Spark számítási konfigurációi jelenleg milyenek.

  • Mintakérelem

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

  • Mintaválasz

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

A számítási konfigurációk frissítése

Az API kérelemtörzsének szerkesztésével frissítheti a Spark-futtatókörnyezetet, átválthat egy másik készletre, pontosíthatja a számítási konfigurációt, és hozzáadhat/eltávolíthat Spark-tulajdonságokat.

A csatolt készletet a készlet nevének és készletének megadásával válthatja át. Adja meg a készlet nevét, ha Starter Pool a készletet alapértelmezett beállításokra szeretné váltani. A munkaterület elérhető egyéni készleteinek rest API-val történő lekéréséhez tekintse meg az Egyéni készletek – Munkaterület egyéni készleteinek listázása című témakört.

Ha el szeretne távolítani egy meglévő Spark-tulajdonságot, az alábbi példában látható módon meg kell adnia az eltávolítani kívánt kulccsal megegyező értéket null .

  • Mintakérelem

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

A módosítások hatékonyabbá tétele

A módosítások közzétételéhez használja az alábbi API-kat.

Felkészülés a közzétételre

A környezet egyszerre csak egy közzétételt fogad el. A környezet közzététele előtt ellenőrizheti a környezet állapotát, és végső áttekintést kaphat az előkészítési változásokról. A környezet sikeres közzététele után az átmeneti állapotban lévő összes konfiguráció érvénybe lép.

  • 1. lépés: a környezet metaadatainak lekérése

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

    A válasz törzsében egyértelműen megadhatja a környezet állapotát. Mielőtt továbblép a következő lépésre, győződjön meg arról, hogy nincs folyamatos közzététel.

  • 2. lépés: az előkészítési kódtárak/Spark-számítás lekérése a végső felülvizsgálathoz

    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

A környezet közzétételének aktiválása

Az előkészítési kódtárakban és a Spark-számításban végrehajtott módosítások gyorsítótárazva vannak, de közzétételt igényelnek a hatékony használathoz. A közzététel aktiválásához kövesse az alábbi példát.

  • Mintakérelem

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

  • Mintaválasz

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

A közzététel során a következő API-t is meghívhatja a lemondáshoz.

  • Mintakérelem

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

Kapcsolódó tartalom