次の方法で共有

Items - Publish Environment

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

環境の発行操作をトリガーします。

注

この API は、2026 年 3 月 1 日に非推奨となるベータ 版のリリース バージョンです。 この API を呼び出すとき - 呼び出し元は、クエリ パラメーター beta 値を設定する必要があります false

この API は、実行時間の長い操作 (LRO)をサポートします。

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/publish?beta={beta}

URI パラメーター

名前 / 必須 型 説明
environmentId
 path True

string (uuid)

環境 ID。
workspaceId
 path True

string (uuid)

ワークスペース ID。
beta
 query True

boolean

このパラメーターは、使用する API のバージョンを指定します。 リリース バージョンを使用するには、 false に設定します。

応答

名前 型 説明
200 OK

EnvironmentProperties

発行操作要求が正常に送信されました。
202 Accepted

承認された要求、発行操作が進行中です。 beta=false時に GA コントラクトを返します (2026 年 3 月 1 日以降の既定値)。

ヘッダー

  • Location: string
  • x-ms-operation-id: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

一般的なエラー コード:

  • InvalidEnvironmentPublish - 失敗した発行操作のバージョン <GUID の環境発行操作> エラーが原因で失敗しました: Code = EnvironmentAnotherOngoingPublishProcess。

例

Publish environment example

要求のサンプル

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

応答のサンプル

状態コード:
200 
{
  "publishDetails": {
    "state": "Running",
    "targetVersion": "46838a80-5450-4414-bea0-40fb6f3e0c0d",
    "startTime": "2024-03-29T14:17:09.0697022Z",
    "componentPublishInfo": {
      "sparkLibraries": {
        "state": "Running"
      },
      "sparkSettings": {
        "state": "Running"
      }
    }
  }
}
状態コード:
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

定義

名前 説明
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

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