Del via

Administrer miljøet via offentlige API'er

  • Artikel

Microsoft Fabric REST API indeholder et tjenesteslutpunkt for oprettelse, læsning, opdatering og sletning (CRUD) af et Fabric-element. I denne artikel beskrives de tilgængelige REST API'er for miljøet og deres brug.

Vigtigt

Denne funktion er en prøveversion.

Oversigt over tilgængelige miljø-API'er

API Beskrivelse Kategori
Opret miljø Opret et nyt miljø i arbejdsområdet. Generelt
Hent miljø Hent metadataene for et miljø. Svaret indeholder status for miljøet. Generelt
Opdater miljø Opdater metadataene for et miljø, f.eks. navn og beskrivelse. Generelt
Slette miljø Slet et eksisterende miljø. Generelt
Listemiljø i arbejdsområde Hent listen over miljøer i et arbejdsområde. Generelt
Publicer miljø Udløs publiceringen af miljøet med aktuelle ventende ændringer. Generelt
Publicer annullering Annuller en igangværende publicering af miljøet Generelt
Hent publiceret Spark-beregning Hent de Spark-beregningskonfigurationer, der er effektive. Spark-beregning
Hent midlertidig Spark-beregning Hent de fulde konfigurationer af midlertidige beregninger. De midlertidige konfigurationer omfatter de publicerede og ventende beregningskonfigurationer. Spark-beregning
Hent publicerede biblioteker Hent den biblioteksliste, der er gældende. Biblioteker
Hent midlertidige biblioteker Hent den fulde liste over midlertidige biblioteker. Denne liste indeholder de publicerede og ventende biblioteker. Biblioteker
Overfør midlertidige biblioteker Tilføjelse af et brugerdefineret bibliotek eller et/flere offentlige biblioteker i miljøet. Biblioteker
Slet midlertidige biblioteker Slet ét brugerdefineret midlertidigt bibliotek eller hele det offentlige bibliotek. Biblioteker

Få mere at vide om de offentlige API'er for miljøet i Element-API'er – Miljø

Anvendelsessager for den offentlige API i miljøet

I dette afsnit gennemgås flere almindelige scenarier, når du arbejder med miljøet. Du kan erstatte {WORKSPACE_ID} og {ARTIFACT_ID} i følgende eksempler med relevante værdier.

Opret et nyt miljø

Du kan oprette et nyt tomt miljø ved hjælp af følgende API.

  • Eksempelanmodning

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

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

Administrer midlertidige biblioteker

Du kan bruge API'erne til overførsel/sletning af midlertidige biblioteker til at administrere biblioteksafsnittet i miljøet

Kontrollér de publicerede biblioteker for miljøet

Før du tilføjer/sletter bibliotek, kan du bruge API'en hent publicerede biblioteker til at kontrollere, hvilke biblioteker der er gældende i øjeblikket.

  • Eksempelanmodning

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

  • Eksempelsvar

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

Upload af bibliotekerne

API'en til overførsel af det midlertidige bibliotek accepterer én fil ad gangen. De understøttede filtyper er .whl, .jar, .tar.gz, .py og environment.yml for offentligt bibliotek. Du kan angive filen via indholdstypen med flere dele/formulardata.

Bemærk

  • For at manipulere det offentlige bibliotek mere effektivt anbefales det på det kraftigste at oprette alle forventede biblioteker fra PyPI og conda i en environment.yml fil.
  • Overførsels-API'en tillader op til 200 MB fil i én anmodning. Bibliotek, der overskrider denne størrelsesgrænse, understøttes i øjeblikket ikke i den offentlige API.

  • Eksempelanmodninger

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

Sletter bibliotekerne

Ved at angive det fulde biblioteksfilnavn med typesuffikset kan du slette ét bibliotek ad gangen.

Bemærk

  • Hvis du angiver environment.yml som den fil, der skal slettes, fjerner du alle offentlige biblioteker.
  • Hvis du vil fjerne et undersæt af et eksisterende offentligt bibliotek, skal du i stedet bruge overførselsbiblioteket og overføre en environment.yml , der kun indeholder de forventede biblioteker. Den uploadede environment.yml erstatter det eksisterende offentlige biblioteksafsnit helt.

  • Eksempelanmodninger

    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

Administrer midlertidig Spark-beregning

Du kan bruge opdateringen af den midlertidige Spark-beregning til at administrere Spark-beregningen.

Kontrollér den publicerede Spark-beregning for miljøet

Før du ændrer konfigurationerne for miljøet, kan du bruge spark-beregnings-API'en, der udgives, til at kontrollere, hvilke Spark-beregningskonfigurationer der er gældende i øjeblikket.

  • Eksempelanmodning

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

  • Eksempelsvar

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

Opdater beregningskonfigurationerne

Du kan opdatere Spark-kørslen, skifte til en anden gruppe, tilpasse beregningskonfigurationen og tilføje/fjerne Spark-egenskaber ved at redigere anmodningsteksten i denne API.

Du kan skifte den vedhæftede pulje ved at angive gruppens navn og pulje. Angiv gruppenavnet Starter Pool for at skifte gruppen til standardindstillingerne. Hvis du vil have vist en komplet liste over de tilgængelige brugerdefinerede puljer i arbejdsområdet efter REST API, skal du se Brugerdefinerede puljer - Liste over brugerdefinerede grupper i arbejdsområdet

Hvis du vil fjerne en eksisterende Spark-egenskab, skal du angive værdien som null med den nøgle, du vil fjerne, som vist i følgende eksempel.

  • Eksempelanmodning

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

Gør ændringerne gældende

Brug af følgende sæt API'er til at publicere ændringerne.

Forbered en publicering

Miljøet kan acceptere en publicering ad gangen. Før du publicerer dit miljø, kan du validere status for miljøet og få en endelig gennemgang af ændringerne i den midlertidige tilstand. Når miljøet er publiceret, træder alle konfigurationer i den midlertidige tilstand i kraft.

  • Trin 1: Hent miljøets metadata

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

    I svarteksten kan du tydeligt se tilstanden af miljøet. Sørg for, at der ikke er nogen igangværende publicering, før du går videre til næste trin.

  • Trin 2: Hent de midlertidige biblioteker/Spark-beregning for at få en endelig gennemgang

    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

Udløs publiceringen af miljøet

De ændringer, du har foretaget i for de midlertidige biblioteker og Spark-beregning, cachelagres, men det kræver publicering for at træde i kraft. Følg følgende eksempel for at udløse publiceringen.

  • Eksempelanmodning

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

  • Eksempelsvar

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

Under publiceringen kan du også kalde følgende API for at annullere den.

  • Eksempelanmodning

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

Relateret indhold