次の方法で共有

Items - Cancel Publish Environment

サービス:
Environment
API バージョン:
v1

環境発行の取り消しをトリガーします。

Permissions

環境項目の書き込みアクセス許可。

必要な委任されたスコープ

Item.ReadWrite.All または Environment.ReadWrite.All

Microsoft Entra でサポートされている ID

この API では、このセクションに記載されている Microsoft ID がサポートされています。

アイデンティティ Support
User イエス
サービス プリンシパルとマネージド ID イエス

インターフェイス

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

URI パラメーター

名前 / 必須 型 説明
environmentId
 path True

string (uuid)

環境 ID。
workspaceId
 path True

string (uuid)

ワークスペース ID。

応答

名前 型 説明
200 OK

EnvironmentProperties

要求は正常に完了しました。
Other Status Codes

ErrorResponse

一般的なエラー コード:

  • InvalidEnvironmentCancel - 失敗した発行取り消しのバージョン <GUID の環境取り消し操作> エラーが原因で失敗しました: Code = 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"
      }
    }
  }
}

定義

名前 説明
ComponentPublishInfo

環境内の各コンポーネントの情報を発行します。
EnvironmentProperties

環境のプロパティ。
EnvironmentPublishState

発行状態。 追加の状態の種類は、時間の経過と同時に追加される場合があります。
ErrorRelatedResource

エラー関連のリソース詳細オブジェクト。
ErrorResponse

エラー応答。
ErrorResponseDetails

エラー応答の詳細。
PublishDetails

発行操作の詳細。
SparkLibraries

Spark ライブラリ。
SparkSettings

Spark の設定。

ComponentPublishInfo

Object

環境内の各コンポーネントの情報を発行します。

名前 型 説明
sparkLibraries

SparkLibraries

Spark ライブラリは情報を発行します。
sparkSettings

SparkSettings

Spark 設定によって情報が発行されます。

EnvironmentProperties

Object

環境のプロパティ。

名前 型 説明
publishDetails

PublishDetails

環境の発行操作の詳細。

EnvironmentPublishState

列挙

発行状態。 追加の状態の種類は、時間の経過と同時に追加される場合があります。

値 説明
Success

環境の発行が成功状態です。
Cancelled

環境の発行が取り消された状態です。
Failed

環境の発行が失敗した状態です。
Cancelling

環境の発行が取り消し状態です。
Running

環境の発行が実行中の状態です。
Waiting

環境の発行が待機状態です。

ErrorRelatedResource

Object

エラー関連のリソース詳細オブジェクト。

名前 型 説明
resourceId

string

エラーに関係するリソース ID。
resourceType

string

エラーに関係するリソースの種類。

ErrorResponse

Object

エラー応答。

名前 型 説明
errorCode

string

エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。
message

string

エラーの人間が判読できる表現。
moreDetails

ErrorResponseDetails[]

その他のエラーの詳細の一覧。
relatedResource

ErrorRelatedResource

エラー関連のリソースの詳細。
requestId

string

エラーに関連付けられている要求の ID。

ErrorResponseDetails

Object

エラー応答の詳細。

名前 型 説明
errorCode

string

エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。
message

string

エラーの人間が判読できる表現。
relatedResource

ErrorRelatedResource

エラー関連のリソースの詳細。

PublishDetails

Object

発行操作の詳細。

名前 型 説明
componentPublishInfo

ComponentPublishInfo

環境コンポーネントが情報を発行します。
endTime

string (date-time)

YYYY-MM-DDTHH:mm:ss.ssssssZ 形式を使用した発行操作の終了時刻 (UTC)。
startTime

string (date-time)

YYYY-MM-DDTHH:mm:ss.ssssssZ 形式を使用した発行操作の開始時刻 (UTC)。
state

EnvironmentPublishState

発行状態。 追加の状態の種類は、時間の経過と同時に追加される場合があります。
targetVersion

string (uuid)

公開対象のバージョン。

SparkLibraries

Object

Spark ライブラリ。

名前 型 説明
state

EnvironmentPublishState

発行状態。 追加の状態の種類は、時間の経過と同時に追加される場合があります。

SparkSettings

Object

Spark の設定。

名前 型 説明
state

EnvironmentPublishState

発行状態。 追加の状態の種類は、時間の経過と同時に追加される場合があります。