Items - Cancel Publish Environment

Tjänst:: Environment

API-version:: v1

Utlös en miljö publicera annullering.

Permissions

Skrivbehörighet för miljöobjektet.

Obligatoriska delegerade omfång

Item.ReadWrite.All eller Environment.ReadWrite.All

Identiteter som stöds av Microsoft Entra

Det här API:et stöder Microsoft identiteter som anges i det här avsnittet.

Identitet	Support
User	Yes
Tjänsthuvudnamn och hanterade identiteter	Yes

Gränssnitt

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
environmentId	path	True	string (uuid)	Miljö-ID:t.
workspaceId	path	True	string (uuid)	Arbetsyte-ID.

Svar

Name Typ Description

200 OK

Name	Typ	Description
200 OK	EnvironmentProperties	Begäran har slutförts.
429 Too Many Requests	ErrorResponse	Gränsen för tjänstfrekvens överskreds. Servern returnerar ett `Retry-After` huvud som anger i sekunder hur länge klienten måste vänta innan ytterligare begäranden skickas. Sidhuvuden Retry-After: integer
Other Status Codes	ErrorResponse	Vanliga felkoder: InvalidEnvironmentCancel – Miljöavbrottsåtgärden för version <GUID för den misslyckade publiceringsavbrottet> misslyckades på grund av felet: Code = EnvironmentUpsupportedStateForCancel.

EnvironmentProperties

Begäran har slutförts.

429 Too Many Requests

ErrorResponse

Gränsen för tjänstfrekvens överskreds. Servern returnerar ett Retry-After huvud som anger i sekunder hur länge klienten måste vänta innan ytterligare begäranden skickas.

Sidhuvuden

Retry-After: integer

Other Status Codes

ErrorResponse

Vanliga felkoder:

InvalidEnvironmentCancel – Miljöavbrottsåtgärden för version <GUID för den misslyckade publiceringsavbrottet> misslyckades på grund av felet: Code = EnvironmentUpsupportedStateForCancel.

Exempel

Publish environment cancellation example

Exempelbegäran

HTTP

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

Exempelsvar

Statuskod:: 200

{
  "publishDetails": {
    "state": "Cancelled",
    "targetVersion": "d9d95b01-248f-4ef4-bd7e-9d3f1f6447be",
    "startTime": "2024-03-29T14:17:09.0697022Z",
    "endTime": "2024-03-29T14:48:18.0697022Z",
    "componentPublishInfo": {
      "sparkLibraries": {
        "state": "Cancelled"
      },
      "sparkSettings": {
        "state": "Cancelled"
      }
    }
  }
}

Definitioner

Name	Description
ComponentPublishInfo	Publicera information för varje komponenter i miljön.
EnvironmentProperties	Miljöegenskaper.
EnvironmentPublishState	Publiceringstillstånd. Ytterligare tillståndstyper kan läggas till över tid.
ErrorRelatedResource	Det felrelaterade resursinformationsobjektet.
ErrorResponse	Felsvaret.
ErrorResponseDetails	Information om felsvar.
PublishDetails	Information om publiceringsåtgärden.
SparkLibraries	Spark-bibliotek.
SparkSettings	Spark-inställningar.

ComponentPublishInfo

Objekt

Publicera information för varje komponenter i miljön.

Name	Typ	Description
sparkLibraries	SparkLibraries	Spark-bibliotek publicerar information.
sparkSettings	SparkSettings	Spark-inställningar publicerar information.

EnvironmentProperties

Objekt

Miljöegenskaper.

Name	Typ	Description
publishDetails	PublishDetails	Information om miljöpubliceringsåtgärder.

EnvironmentPublishState

Uppräkning

Publiceringstillstånd. Ytterligare tillståndstyper kan läggas till över tid.

Värde	Description
Success	Miljöpublicering har slutförts.
Cancelled	Publiceringen av miljön är i avbrutet tillstånd.
Failed	Miljöpublicering är i fel tillstånd.
Cancelling	Miljöpublicering är i avbrutet tillstånd.
Running	Miljöpublicer är i körningstillstånd.
Waiting	Publiceringen av miljön är i vänteläge.

ErrorRelatedResource

Objekt

Det felrelaterade resursinformationsobjektet.

Name	Typ	Description
resourceId	string	Det resurs-ID som ingår i felet.
resourceType	string	Typen av resurs som är inblandad i felet.

ErrorResponse

Objekt

Felsvaret.

Name	Typ	Description
errorCode	string	En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare.
isRetriable	boolean	När det är sant kan begäran göras på nytt. Använd svarshuvudet `Retry-After` för att fastställa fördröjningen, om den är tillgänglig.
message	string	En mänsklig läsbar representation av felet.
moreDetails	ErrorResponseDetails[]	Lista över ytterligare felinformation.
relatedResource	ErrorRelatedResource	Felrelaterad resursinformation.
requestId	string (uuid)	ID för den begäran som är associerad med felet.

ErrorResponseDetails

Objekt

Information om felsvar.

Name	Typ	Description
errorCode	string	En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare.
message	string	En mänsklig läsbar representation av felet.
relatedResource	ErrorRelatedResource	Felrelaterad resursinformation.

PublishDetails

Objekt

Information om publiceringsåtgärden.

Name	Typ	Description
componentPublishInfo	ComponentPublishInfo	Publicera information om miljökomponenten.
endTime	string (date-time)	Sluttid för publiceringsåtgärden i UTC med formatet YYYY-MM-DDTHH:mm:ss.sssSZ.
startTime	string (date-time)	Starttid för publiceringsåtgärden i UTC med formatet YYYY-MM-DDTHH:mm:ss.ssssSZ.
state	EnvironmentPublishState	Publiceringstillstånd. Ytterligare tillståndstyper kan läggas till över tid.
targetVersion	string (uuid)	Målverion som ska publiceras.

SparkLibraries

Objekt

Spark-bibliotek.

Name	Typ	Description
state	EnvironmentPublishState	Publiceringstillstånd. Ytterligare tillståndstyper kan läggas till över tid.

SparkSettings

Objekt

Spark-inställningar.

Name	Typ	Description
state	EnvironmentPublishState	Publiceringstillstånd. Ytterligare tillståndstyper kan läggas till över tid.