Items - Publish Environment

Service:: Environment

API-versie:: v1

Activeer een bewerking voor het publiceren van een omgeving.

Opmerking

Deze API is een releaseversie van een bètaversie die is afgeschaft op 31 maart 2027. Bij het aanroepen van deze API moeten aanroepers de queryparameter beta instellen op de waarde false

Deze API ondersteunt langlopende bewerkingen (LRO).

Permissions

Schrijfmachtiging voor het omgevingsitem.

Vereiste gedelegeerde bereiken

Item.ReadWrite.All of Environment.ReadWrite.All

Microsoft Entra ondersteunde identiteiten

Deze API ondersteunt de Microsoft-identiteiten die in deze sectie worden vermeld.

Identiteit	Support
User	Yes
serviceprincipal en beheerde identiteiten	Yes

gebruikersinterface

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

URI-parameters

Naam	In	Vereist	Type	Description
environmentId	path	True	string (uuid)	De omgevings-id.
workspaceId	path	True	string (uuid)	De werkruimte-ID.
beta	query	True	boolean	Met deze parameter geeft u op welke versie van de API moet worden gebruikt. Ingesteld op `false` het gebruik van de releaseversie.

Antwoorden

Naam	Type	Description
200 OK	EnvironmentProperties	De bewerkingsaanvraag voor publiceren is verzonden.
202 Accepted		Aanvraag geaccepteerd, publicatiebewerking wordt uitgevoerd. Retourneert het GA-contract wanneer `beta=false` (standaard na 31 maart 2027). Kopteksten Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	De servicesnelheidslimiet is overschreden. De server retourneert een `Retry-After` header die in seconden aangeeft hoe lang de client moet wachten voordat extra aanvragen worden verzonden. Kopteksten Retry-After: integer
Other Status Codes	ErrorResponse	Veelvoorkomende foutcodes: InvalidEnvironmentPublish - Omgevingspublicatiebewerking voor < van de mislukte publicatiebewerking> is mislukt vanwege de fout: Code = EnvironmentAnotherOngoingPublishProcess.

Voorbeelden

Publish environment example

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

Statuscode:: 200

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

Statuscode:: 202

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

Definities

Naam	Description
ComponentPublishInfo	Publiceer informatie voor elke onderdelen in de omgeving.
EnvironmentProperties	Omgevingseigenschappen.
EnvironmentPublishState	Publicatiestatus. Er kunnen in de loop van de tijd extra statustypen worden toegevoegd.
ErrorParameter	Een gestructureerde parameter die extra machineleesbare context biedt over een fout.
ErrorRelatedResource	Het foutgerelateerde resourcedetailsobject.
ErrorResponse	Het foutbericht.
ErrorResponseDetails	De details van het foutbericht.
PublishDetails	Details van de publicatiebewerking.
SparkLibraries	Spark-bibliotheken.
SparkSettings	Spark-instellingen.

ComponentPublishInfo

Object

Publiceer informatie voor elke onderdelen in de omgeving.

Naam	Type	Description
sparkLibraries	SparkLibraries	Spark-bibliotheken publiceren informatie.
sparkSettings	SparkSettings	Spark-instellingen publiceren informatie.

EnvironmentProperties

Object

Omgevingseigenschappen.

Naam	Type	Description
publishDetails	PublishDetails	Details van de publicatiebewerking in de omgeving.

EnvironmentPublishState

Opsomming

Publicatiestatus. Er kunnen in de loop van de tijd extra statustypen worden toegevoegd.

Waarde	Description
Success	Het publiceren van de omgeving heeft de status Geslaagd.
Cancelled	Het publiceren van de omgeving heeft de status Geannuleerd.
Failed	Het publiceren van de omgeving heeft de status Mislukt.
Cancelling	Het publiceren van de omgeving heeft de status Annuleren.
Running	Het publiceren van de omgeving heeft de status Actief.
Waiting	Het publiceren van de omgeving heeft een wachtstatus.

ErrorParameter

Object

Een gestructureerde parameter die extra machineleesbare context biedt over een fout.

Naam	Type	Description
message	string	Een door mensen leesbare beschrijving van de betekenis van de parameter.
name	string	De parameter-id.
value	string	De waarde van de parameter.

ErrorRelatedResource

Object

Het foutgerelateerde resourcedetailsobject.

Naam	Type	Description
resourceId	string	De resource-id die betrokken is bij de fout.
resourceType	string	Het type resource dat betrokken is bij de fout.

ErrorResponse

Object

Het foutbericht.

Naam	Type	Description
errorCode	string	Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
isRetriable	boolean	Wanneer waar, kan de aanvraag opnieuw worden geprobeerd. Gebruik de `Retry-After` antwoordheader om de vertraging te bepalen, indien beschikbaar.
message	string	Een leesbare weergave van de fout.
moreDetails	ErrorResponseDetails[]	Lijst met aanvullende foutdetails.
parameters	ErrorParameter[]	Gestructureerde parameters die extra machineleesbare context bieden over de fout.
relatedResource	ErrorRelatedResource	De foutgerelateerde resourcedetails.
requestId	string (uuid)	Id van de aanvraag die is gekoppeld aan de fout.

ErrorResponseDetails

Object

De details van het foutbericht.

Naam	Type	Description
errorCode	string	Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
message	string	Een leesbare weergave van de fout.
parameters	ErrorParameter[]	Gestructureerde parameters die extra machineleesbare context bieden over de fout.
relatedResource	ErrorRelatedResource	De foutgerelateerde resourcedetails.

PublishDetails

Object

Details van de publicatiebewerking.

Naam	Type	Description
componentPublishInfo	ComponentPublishInfo	Informatie over het publiceren van omgevingsonderdelen.
endTime	string (date-time)	Eindtijd van de publicatiebewerking in UTC, met behulp van de JJJJ-MM-DDTHH:mm:ss.ssZ-indeling.
startTime	string (date-time)	Begintijd van publicatiebewerking in UTC, met de indeling JJJJ-MM-DDTHH:mm:ss.ssZ.
state	EnvironmentPublishState	Publicatiestatus. Er kunnen in de loop van de tijd extra statustypen worden toegevoegd.
targetVersion	string (uuid)	Doelversie die moet worden gepubliceerd.

SparkLibraries

Object

Spark-bibliotheken.

Naam	Type	Description
state	EnvironmentPublishState	Publicatiestatus. Er kunnen in de loop van de tijd extra statustypen worden toegevoegd.

SparkSettings

Object

Spark-instellingen.

Naam	Type	Description
state	EnvironmentPublishState	Publicatiestatus. Er kunnen in de loop van de tijd extra statustypen worden toegevoegd.