Delen via

Items - Publish Environment (preview)

Service:
Environment
API-versie:
v1

Activeer een bewerking voor het publiceren van een omgeving.

Opmerking

Deze API maakt deel uit van een bètaversie en is alleen beschikbaar voor evaluatie- en ontwikkelingsdoeleinden. Het kan veranderen op basis van feedback en wordt niet aanbevolen voor productiegebruik. Deze bèta-API wordt op 1 maart 2026 afgeschaft en vervangen door een stabiele versie die hier beschikbaar is. De nieuwe versie introduceert belangrijke wijzigingen en is niet compatibel met eerdere versies. Bij het aanroepen van deze API moeten aanroepers opgeven true als de waarde voor de queryparameter beta (preview de queryparameter is vervangen door beta. Voor achterwaartse compatibiliteit preview wordt nog steeds ondersteund en gedraagt zich hetzelfde als beta).

Afschaffingsmelding

Er is een nieuwe queryparameter beta geïntroduceerd om deze overgang te vergemakkelijken:

  • De beta queryparameter is momenteel standaard ingesteld op true.
  • Stel de waarde van de beta queryparameter in om de stabiele releaseversie van deze API te false gebruiken.
  • Vanaf 1 maart 2026 wordt de standaardwaarde beta gewijzigd in false.

Het wordt aanbevolen om uw integratie zo snel mogelijk te migreren om de releaseversie te gebruiken door op te false geven voor de beta queryparameter (de standaardwaarde voor de queryparameter wordt ingesteld beta op de afschaffingsdatum van de false API).

De volgende incompatibele wijzigingen zijn geïntroduceerd in de releaseversie:

Permissions

Schrijfmachtiging voor het omgevingsitem.

Vereiste gedelegeerde bereiken

Item.ReadWrite.All of Environment.ReadWrite.All

Door 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

Name 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 true het gebruik van de bètaversie die op deze pagina wordt beschreven of om false de releaseversie te gebruiken die hier wordt beschreven. Vanaf 1 maart 2026 wordt de standaardwaarde beta gewijzigd in false.

Antwoorden

Name Type Description
200 OK

EnvironmentProperties

De bewerkingsaanvraag voor publiceren is verzonden.
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

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

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

Definities

Name 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.
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.

Name Type Description
sparkLibraries

SparkLibraries

Spark-bibliotheken publiceren informatie.
sparkSettings

SparkSettings

Spark-instellingen publiceren informatie.

EnvironmentProperties

Object

Omgevingseigenschappen.

Name 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.

ErrorRelatedResource

Object

Het foutgerelateerde resourcedetailsobject.

Name 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.

Name 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.
moreDetails

ErrorResponseDetails[]

Lijst met aanvullende foutdetails.
relatedResource

ErrorRelatedResource

De foutgerelateerde resourcedetails.
requestId

string

Id van de aanvraag die is gekoppeld aan de fout.

ErrorResponseDetails

Object

De details van het foutbericht.

Name 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.
relatedResource

ErrorRelatedResource

De foutgerelateerde resourcedetails.

PublishDetails

Object

Details van de publicatiebewerking.

Name 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.

Name Type Description
state

EnvironmentPublishState

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

SparkSettings

Object

Spark-instellingen.

Name Type Description
state

EnvironmentPublishState

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