Items - Publish Environment (beta)

Tjeneste:: Environment

API-versjon:: v1

Utløse en publiseringsoperasjon for miljø.

Note

Denne API-en er en del av en betaversjon og leveres bare for evaluerings- og utviklingsformål. Det kan endres basert på tilbakemelding og anbefales ikke for produksjonsbruk. Denne beta-API-en vil bli avskrevet 31. mars 2027, og erstattes av en stabil versjon, tilgjengelig her. Den nye versjonen introduserer bruddendringer og er ikke bakoverkompatibel. Når du kaller opp denne API-en, må innringere angi true som verdi for spørringsparameteren beta (preview spørringsparameteren er erstattet av beta. For bakoverkompatibilitet støttes preview fortsatt og fungerer på samme måte som beta).

Avskrivingsvarsel

Det er innført en ny spørringsparameter beta for å forenkle denne overgangen:

Spørringsparameteren beta er for øyeblikket standard.true
Angi verdien for spørringsparameteren beta til å false bruke den stabile versjonsversjonen av denne API-en.
Fra og med 31. mars 2027 endres falsestandardverdien til beta .

Det anbefales å overføre integreringen til å bruke versjonsversjonen så snart som mulig ved å false angi for betaspørringsparameteren (standardverdien for spørringsparameteren beta settes til false på API-ens avskrivningsdato).

Følgende inkompatible endringer ble introdusert i versjonsversjonen:

Svaret følger et langvarig operasjonsmønster (LRO), og HTTP-svarkode 202 kan returneres.

Tillatelser

Skrivetillatelse for miljøelementet.

Nødvendige delegerte omfang

Item.ReadWrite.All eller Environment.ReadWrite.All

Microsoft Entra støttede identiteter

Denne API-en støtter Microsoft -identiteter oppført i denne delen.

Identitet	Støtte
Bruker	Ja
tjenestekontohaver og administrerte identiteter	Ja

Grensesnitt

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/environments/{environmentId}/staging/publish?beta={beta}

URI-parametere

Name	I	Obligatorisk	Type	Beskrivelse
environmentId	path	True	string (uuid)	Miljø-ID-en.
workspaceId	path	True	string (uuid)	Arbeidsområde-ID-en.
beta	query	True	boolean	Denne parameteren angir hvilken versjon av API-en som skal brukes. Sett til å `true` bruke betaversjonen som er beskrevet på denne siden, eller for å `false` bruke versjonsversjonen som er beskrevet her. Fra og med 31. mars 2027 endres `false`standardverdien til `beta` .

Svar

Name Type Beskrivelse

200 OK

Name	Type	Beskrivelse
200 OK	EnvironmentProperties	Publiseringsoperasjonsforespørselen er sendt inn.
429 Too Many Requests	ErrorResponse	Grensen for tjenestesats ble overskredet. Serveren returnerer en `Retry-After` topptekst som angir, i sekunder, hvor lenge klienten må vente før du sender flere forespørsler. Overskrifter Retry-After: integer
Other Status Codes	ErrorResponse	Vanlige feilkoder: InvalidEnvironmentPublish – miljøpubliseringsoperasjon for < for den mislykkede publiseringsoperasjonen> mislyktes på grunn av feil: Code = EnvironmentAnotherOngoingPublishProcess.

EnvironmentProperties

Publiseringsoperasjonsforespørselen er sendt inn.

429 Too Many Requests

ErrorResponse

Grensen for tjenestesats ble overskredet. Serveren returnerer en Retry-After topptekst som angir, i sekunder, hvor lenge klienten må vente før du sender flere forespørsler.

Overskrifter

Retry-After: integer

Other Status Codes

ErrorResponse

Vanlige feilkoder:

InvalidEnvironmentPublish – miljøpubliseringsoperasjon for < for den mislykkede publiseringsoperasjonen> mislyktes på grunn av feil: Code = EnvironmentAnotherOngoingPublishProcess.

Eksempler

Publish environment example

Eksempelforespørsel

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/environments/41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87/staging/publish?beta=True

Eksempelsvar

Statuskode:: 200

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

Definisjoner

Name	Beskrivelse
ComponentPublishInfo	Publiser informasjon for hver komponent i miljøet.
EnvironmentProperties	Miljøegenskaper.
EnvironmentPublishState	Publiser tilstand. Flere tilstandstyper kan legges til over tid.
ErrorParameter	En strukturert parameter som gir ekstra maskinlesbar kontekst om en feil.
ErrorRelatedResource	Objektet for feilrelaterte ressursdetaljer.
ErrorResponse	Feilsvaret.
ErrorResponseDetails	Feilsvardetaljene.
PublishDetails	Detaljer om publiseringsoperasjon.
SparkLibraries	Spark-biblioteker.
SparkSettings	Spark-innstillinger.

ComponentPublishInfo

Objekt

Publiser informasjon for hver komponent i miljøet.

Name	Type	Beskrivelse
sparkLibraries	SparkLibraries	Spark-biblioteker publiserer informasjon.
sparkSettings	SparkSettings	Spark-innstillinger publiserer informasjon.

EnvironmentProperties

Objekt

Miljøegenskaper.

Name	Type	Beskrivelse
publishDetails	PublishDetails	Detaljer for publisering av miljø.

EnvironmentPublishState

Opplisting

Publiser tilstand. Flere tilstandstyper kan legges til over tid.

Verdi	Beskrivelse
Success	Publisering av miljø er i vellykket tilstand.
Cancelled	Publisering av miljø er i avbrutt tilstand.
Failed	Publisering av miljø er i mislykket tilstand.
Cancelling	Publisering av miljø er i avbrytertilstand.
Running	Publisering av miljø er i kjørende tilstand.
Waiting	Publisering av miljø er i ventetilstand.

ErrorParameter

Objekt

En strukturert parameter som gir ekstra maskinlesbar kontekst om en feil.

Name	Type	Beskrivelse
message	string	En lesbar beskrivelse av parameterens betydning.
name	string	Parameteridentifikatoren.
value	string	Parameterverdien.

ErrorRelatedResource

Objekt

Objektet for feilrelaterte ressursdetaljer.

Name	Type	Beskrivelse
resourceId	string	Ressurs-ID-en som er involvert i feilen.
resourceType	string	Typen ressurs som er involvert i feilen.

ErrorResponse

Objekt

Feilsvaret.

Name	Type	Beskrivelse
errorCode	string	En bestemt identifikator som gir informasjon om en feilbetingelse, noe som gir standardisert kommunikasjon mellom tjenesten og brukerne.
isRetriable	boolean	Når sann, kan forespørselen prøves på nytt. `Retry-After` Bruk svarhodet til å fastslå forsinkelsen, hvis tilgjengelig.
message	string	En menneskelig lesbar representasjon av feilen.
moreDetails	ErrorResponseDetails[]	Liste over flere feildetaljer.
parameters	ErrorParameter[]	Strukturerte parametere som gir ekstra maskinlesbar kontekst om feilen.
relatedResource	ErrorRelatedResource	Feilrelaterte ressursdetaljer.
requestId	string (uuid)	ID for forespørselen som er knyttet til feilen.

ErrorResponseDetails

Objekt

Feilsvardetaljene.

Name	Type	Beskrivelse
errorCode	string	En bestemt identifikator som gir informasjon om en feilbetingelse, noe som gir standardisert kommunikasjon mellom tjenesten og brukerne.
message	string	En menneskelig lesbar representasjon av feilen.
parameters	ErrorParameter[]	Strukturerte parametere som gir ekstra maskinlesbar kontekst om feilen.
relatedResource	ErrorRelatedResource	Feilrelaterte ressursdetaljer.

PublishDetails

Objekt

Detaljer om publiseringsoperasjon.

Name	Type	Beskrivelse
componentPublishInfo	ComponentPublishInfo	Informasjon om miljøkomponenten publiserer.
endTime	string (date-time)	Sluttidspunktet for publiseringsoperasjonen i UTC ved hjelp av formatet ÅÅÅÅÅ-MM-DDTHH:mm:ss.sssssssZ.
startTime	string (date-time)	Starttidspunktet for publiseringsoperasjonen i UTC ved hjelp av YYYY-MM-DDTHH:mm:ss.ssssssssZ-formatet.
state	EnvironmentPublishState	Publiser tilstand. Flere tilstandstyper kan legges til over tid.
targetVersion	string (uuid)	Mål-verion som skal publiseres.

SparkLibraries

Objekt

Spark-biblioteker.

Name	Type	Beskrivelse
state	EnvironmentPublishState	Publiser tilstand. Flere tilstandstyper kan legges til over tid.

SparkSettings

Objekt

Spark-innstillinger.

Name	Type	Beskrivelse
state	EnvironmentPublishState	Publiser tilstand. Flere tilstandstyper kan legges til over tid.