다음을 통해 공유

Items - Cancel Publish Environment

서비스:
Environment
API 버전:
v1

환경 게시 취소를 트리거합니다.

Permissions

환경 항목에 대한 쓰기 권한입니다.

필요한 위임된 범위

Item.ReadWrite.All 또는 Environment.ReadWrite.All

Microsoft Entra 지원 식별자

이 API는 이 섹션에 나열된 Microsoft ID 지원합니다.

아이덴티티 Support
사용자 Yes
서비스 주체 및 관리 ID Yes

인터페이스

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

URI 매개 변수

Name In(다음 안에) 필수 형식 Description
environmentId
 path True

string (uuid)

환경 ID입니다.
workspaceId
 path True

string (uuid)

작업 영역 ID입니다.

응답

Name 형식 Description
200 OK

EnvironmentProperties

요청이 성공적으로 완료되었습니다.
Other Status Codes

ErrorResponse

일반적인 오류 코드:

  • InvalidEnvironmentCancel - 실패한 게시 취소>의 버전 <GUID에 대한 환경 취소 작업이 오류로 인해 실패했습니다. 코드 = EnvironmentUpsupportedStateForCancel.

예제

Publish environment cancellation example

샘플 요청

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

샘플 응답

상태 코드:
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"
      }
    }
  }
}

정의

Name Description
ComponentPublishInfo

환경의 각 구성 요소에 대한 정보를 게시합니다.
EnvironmentProperties

환경 속성입니다.
EnvironmentPublishState

게시 상태입니다. 시간이 지남에 따라 추가 상태 유형을 추가할 수 있습니다.
ErrorRelatedResource

오류 관련 리소스 세부 정보 개체입니다.
ErrorResponse

오류 응답입니다.
ErrorResponseDetails

오류 응답 세부 정보입니다.
PublishDetails

게시 작업의 세부 정보입니다.
SparkLibraries

Spark 라이브러리.
SparkSettings

Spark 설정.

ComponentPublishInfo

Object

환경의 각 구성 요소에 대한 정보를 게시합니다.

Name 형식 Description
sparkLibraries

SparkLibraries

Spark 라이브러리는 정보를 게시합니다.
sparkSettings

SparkSettings

Spark 설정은 정보를 게시합니다.

EnvironmentProperties

Object

환경 속성입니다.

Name 형식 Description
publishDetails

PublishDetails

환경 게시 작업 세부 정보입니다.

EnvironmentPublishState

열거형

게시 상태입니다. 시간이 지남에 따라 추가 상태 유형을 추가할 수 있습니다.

값 Description
Success

환경 게시가 성공 상태입니다.
Cancelled

환경 게시가 취소된 상태입니다.
Failed

환경 게시가 실패 상태입니다.
Cancelling

환경 게시가 취소 상태입니다.
Running

환경 게시가 실행 중입니다.
Waiting

환경 게시가 대기 중입니다.

ErrorRelatedResource

Object

오류 관련 리소스 세부 정보 개체입니다.

Name 형식 Description
resourceId

string

오류와 관련된 리소스 ID입니다.
resourceType

string

오류와 관련된 리소스의 형식입니다.

ErrorResponse

Object

오류 응답입니다.

Name 형식 Description
errorCode

string

오류 조건에 대한 정보를 제공하여 서비스와 사용자 간의 표준화된 통신을 허용하는 특정 식별자입니다.
message

string

사용자가 읽을 수 있는 오류 표현입니다.
moreDetails

ErrorResponseDetails[]

추가 오류 세부 정보 목록입니다.
relatedResource

ErrorRelatedResource

오류 관련 리소스 세부 정보입니다.
requestId

string

오류와 연결된 요청의 ID입니다.

ErrorResponseDetails

Object

오류 응답 세부 정보입니다.

Name 형식 Description
errorCode

string

오류 조건에 대한 정보를 제공하여 서비스와 사용자 간의 표준화된 통신을 허용하는 특정 식별자입니다.
message

string

사용자가 읽을 수 있는 오류 표현입니다.
relatedResource

ErrorRelatedResource

오류 관련 리소스 세부 정보입니다.

PublishDetails

Object

게시 작업의 세부 정보입니다.

Name 형식 Description
componentPublishInfo

ComponentPublishInfo

환경 구성 요소 게시 정보입니다.
endTime

string (date-time)

YYYY-MM-DDTHH:mm:ss.ssssZ 형식을 사용하여 UTC에서 게시 작업의 종료 시간입니다.
startTime

string (date-time)

YYYY-MM-DDTHH:mm:ss.ssssZ 형식을 사용하여 UTC에서 게시 작업의 시작 시간입니다.
state

EnvironmentPublishState

게시 상태입니다. 시간이 지남에 따라 추가 상태 유형을 추가할 수 있습니다.
targetVersion

string (uuid)

게시할 대상 꼭짓점입니다.

SparkLibraries

Object

Spark 라이브러리.

Name 형식 Description
state

EnvironmentPublishState

게시 상태입니다. 시간이 지남에 따라 추가 상태 유형을 추가할 수 있습니다.

SparkSettings

Object

Spark 설정.

Name 형식 Description
state

EnvironmentPublishState

게시 상태입니다. 시간이 지남에 따라 추가 상태 유형을 추가할 수 있습니다.