Del via

Administrere miljøet gjennom offentlige API-er

  • Artikkel

Rest-API-en for Microsoft Fabric tilbyr et tjenesteendepunkt for opprettings-, lese-, oppdaterings- og sletteoperasjoner (CRUD) for et stoffelement. Denne artikkelen beskriver de tilgjengelige REST-API-ene for miljøet og bruken deres.

Viktig

Denne funksjonen er i forhåndsvisning.

Sammendrag av tilgjengelige miljø-API-er

API Bekrivelse Kategori
Opprett miljø Opprett et nytt miljø i arbeidsområdet. Generelt
Få miljø Få metadataene for et miljø. Svaret inkluderer statusen for miljøet. Generelt
Oppdater miljø Oppdater metadataene for et miljø, for eksempel navn og beskrivelse. Generelt
Slett miljø Slett et eksisterende miljø. Generelt
Listemiljø i arbeidsområde Få listen over miljøer i et arbeidsområde. Generelt
Publiser miljø Utløse publisering av miljøet med gjeldende ventende endringer. Generelt
Publiser avlysning Avbryte en pågående publisering av miljøet Generelt
Få publisert Spark-databehandling Få spark-databehandlingskonfigurasjonene som er effektive. Spark-databehandling
Få klargjøring av Spark-databehandling Få fullstendige konfigurasjoner for oppsamlingsdatabehandling. Konfigurasjonene for oppsamling inkluderer de publiserte og ventende beregningskonfigurasjonene. Spark-databehandling
Få publiserte biblioteker Få biblioteklisten som er effektiv. Biblioteker
Få oppsamlingsbiblioteker Få den fullstendige listen over oppsamlingsbiblioteker. Denne listen inneholder de publiserte og ventende bibliotekene. Biblioteker
Last opp oppsamlingsbiblioteker Legge til ett egendefinert bibliotek eller ett/flere offentlige bibliotek i miljøet. Biblioteker
Slette oppsamlingsbiblioteker Slett ett egendefinert bibliotek eller alle offentlige biblioteker. Biblioteker

Mer informasjon om de offentlige API-ene for miljøet i Element-API-er – miljø

Offentlige API-brukstilfeller for miljø

Denne delen veileder deg gjennom flere vanlige scenarioer når du arbeider med miljøet. Du kan erstatte {WORKSPACE_ID} eksemplene nedenfor {ARTIFACT_ID} med riktige verdier.

Opprett et nytt miljø

Du kan opprette et nytt tomt miljø ved hjelp av følgende API.

  • Eksempelforespørsel

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

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

Behandle oppsamlingsbiblioteker

Du kan bruke API-ene for opplasting/sletting av oppsamlingsbiblioteker til å administrere bibliotekdelen i miljøet

Kontroller de publiserte bibliotekene for miljøet

Før du legger til/sletter biblioteket, kan du bruke API-en for hent publiserte biblioteker til å kontrollere hvilke biblioteker som er effektive for øyeblikket.

  • Eksempelforespørsel

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

Laste opp bibliotekene

API-en for opplasting av oppsamlingsbiblioteket godtar én fil om gangen. Filtypene som støttes, er .whl, .jar, .tar.gz, .py og environment.yml for offentlig bibliotek. Du kan angi filen via innholdstypen multipart/form-data.

Merk

  • For å manipulere det offentlige biblioteket mer effektivt, anbefales det på det sterkeste å skrive alle forventede biblioteker fra PyPI og conda i en environment.yml fil.
  • Opplastings-API-en tillater opptil 200 MB fil i én forespørsel, bibliotek som overskrider denne størrelsesgrensen, støttes for øyeblikket ikke i offentlig API.

  • Eksempelforespørsler

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

Slette bibliotekene

Ved å angi det fullstendige bibliotekfilnavnet med typesuffikset, kan du slette ett bibliotek om gangen.

Merk

  • Hvis du angir environment.yml at filen skal slettes, fjerner du alle folkebibliotekene.
  • Hvis du vil fjerne et delsett av eksisterende fellesbibliotek, kan du bruke opplastingsbiblioteket i stedet og laste opp en environment.yml som bare inneholder de forventede bibliotekene. Den opplastede environment.yml erstatter den eksisterende offentlige bibliotekdelen helt.

  • Eksempelforespørsler

    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

Administrere oppsamling av Spark-databehandling

Du kan bruke spark-databehandlingen for å administrere Spark-databehandlingen.

Kontroller den publiserte Spark-databehandlingen for miljøet

Før du endrer konfigurasjonene for miljøet, kan du bruke den publiserte Spark-databehandlings-API-en til å kontrollere hvilke Spark-databehandlingskonfigurasjoner som er effektive for øyeblikket.

  • Eksempelforespørsel

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

Oppdater beregningskonfigurasjonene

Du kan oppdatere Spark runtime, bytte til et annet utvalg, finjustere beregningskonfigurasjon og legge til / fjerne Spark-egenskaper ved å redigere forespørselsteksten for denne API-en.

Du kan bytte det vedlagte utvalget ved å angi utvalgsnavnet og utvalget. Angi navnet på utvalget for Starter Pool å bytte utvalget til standardinnstillinger. Hvis du vil ha en fullstendig liste over tilgjengelige egendefinerte utvalg av arbeidsområdet etter REST-API, kan du se Egendefinerte utvalg – egendefinerte utvalg for listearbeidsområde

Hvis du vil fjerne en eksisterende Spark-egenskap, må du angi verdien som null med nøkkelen du vil fjerne, som vist i eksemplet nedenfor.

  • Eksempelforespørsel

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

Gjør endringene effektive

Bruk følgende sett med API-er til å publisere endringene.

Klargjøre for publisering

Miljøet kan godta én publisering om gangen. Før du publiserer miljøet, kan du validere statusen for miljøet og få en endelig gjennomgang av oppsamlingsendringene. Når miljøet er publisert, trer alle konfigurasjoner i oppsamlingstilstanden i kraft.

  • Trinn 1: få metadataene for miljøet

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

    I svarteksten kan du tydelig se tilstanden til miljøet. Kontroller at det ikke er noen pågående publisering før du går videre til neste trinn.

  • Trinn 2: få oppsamlingsbibliotekene/Spark-databehandlingen til å få en endelig gjennomgang

    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

Utløse publisering av miljøet

Endringene du har gjort i for oppsamlingsbibliotekene og Spark-databehandlingen, bufres, men krever at publisering trer i kraft. Følg følgende eksempel for å utløse publiseringen.

  • Eksempelforespørsel

    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 publiseringen kan du også kalle opp følgende API for å avbryte den.

  • Eksempelforespørsel

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

Relatert innhold