Items - Publish Environment (preview)
環境の発行操作をトリガーします。
注
この API はベータ リリースの一部であり、評価と開発のみを目的として提供されます。 フィードバックに基づいて変更される可能性があり、運用環境での使用はお勧めしません。 このベータ API は 、2026 年 3 月 1 日に非推奨となり、 ここで入手できる安定したバージョンに置き換えられます。 新しいバージョンでは破壊的変更が導入されており、下位互換性はありません。
この API を呼び出すとき、呼び出し元はクエリ パラメーター betaの値としてtrueを指定する必要があります (previewクエリ パラメーターはbetaに置き換えられました。下位互換性のために、previewは引き続きサポートされており、beta) と同じように動作します。
非推奨のお知らせ
この移行を容易にするために、新しいクエリ パラメーター beta が導入されました。
- 現在、
betaクエリ パラメーターの既定値はtrueです。 -
betaクエリ パラメーターの値をfalseに設定して、この API の安定したリリース バージョンを使用します。 - 2026 年 3 月 1 日以降、
betaの既定値はfalseに変更されます。
false クエリ パラメーターにbetaを指定して、できるだけ早くリリース バージョンを使用するように統合を移行することをお勧めします (beta クエリ パラメーターの既定値は、API の非推奨日にfalseに設定されます)。
リリース バージョンでは、次の互換性のない変更が導入されました。
- 応答は 実行時間の長い操作 (LRO) パターンに従っており、HTTP 応答コード 202 が返される可能性があります。
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 パラメーター
| 名前 | / | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
environment
|
path | True |
string (uuid) |
環境 ID。 |
|
workspace
|
path | True |
string (uuid) |
ワークスペース ID。 |
|
beta
|
query | True |
boolean |
このパラメーターは、使用する API のバージョンを指定します。 このページで説明されているベータ版を使用する |
応答
| 名前 | 型 | 説明 |
|---|---|---|
| 200 OK |
発行操作要求が正常に送信されました。 |
|
| Other Status Codes |
一般的なエラー コード:
|
例
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=True
応答のサンプル
{
"publishDetails": {
"state": "Running",
"targetVersion": "46838a80-5450-4414-bea0-40fb6f3e0c0d",
"startTime": "2024-03-29T14:17:09.0697022Z",
"componentPublishInfo": {
"sparkLibraries": {
"state": "Running"
},
"sparkSettings": {
"state": "Running"
}
}
}
}
定義
| 名前 | 説明 |
|---|---|
|
Component |
環境内の各コンポーネントの情報を発行します。 |
|
Environment |
環境のプロパティ。 |
|
Environment |
発行状態。 追加の状態の種類は、時間の経過と同時に追加される場合があります。 |
|
Error |
エラー関連のリソース詳細オブジェクト。 |
|
Error |
エラー応答。 |
|
Error |
エラー応答の詳細。 |
|
Publish |
発行操作の詳細。 |
|
Spark |
Spark ライブラリ。 |
|
Spark |
Spark の設定。 |
ComponentPublishInfo
環境内の各コンポーネントの情報を発行します。
| 名前 | 型 | 説明 |
|---|---|---|
| sparkLibraries |
Spark ライブラリは情報を発行します。 |
|
| sparkSettings |
Spark 設定によって情報が発行されます。 |
EnvironmentProperties
環境のプロパティ。
| 名前 | 型 | 説明 |
|---|---|---|
| publishDetails |
環境の発行操作の詳細。 |
EnvironmentPublishState
発行状態。 追加の状態の種類は、時間の経過と同時に追加される場合があります。
| 値 | 説明 |
|---|---|
| Success |
環境の発行が成功状態です。 |
| Cancelled |
環境の発行が取り消された状態です。 |
| Failed |
環境の発行が失敗した状態です。 |
| Cancelling |
環境の発行が取り消し状態です。 |
| Running |
環境の発行が実行中の状態です。 |
| Waiting |
環境の発行が待機状態です。 |
ErrorRelatedResource
エラー関連のリソース詳細オブジェクト。
| 名前 | 型 | 説明 |
|---|---|---|
| resourceId |
string |
エラーに関係するリソース ID。 |
| resourceType |
string |
エラーに関係するリソースの種類。 |
ErrorResponse
エラー応答。
| 名前 | 型 | 説明 |
|---|---|---|
| errorCode |
string |
エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。 |
| message |
string |
エラーの人間が判読できる表現。 |
| moreDetails |
その他のエラーの詳細の一覧。 |
|
| relatedResource |
エラー関連のリソースの詳細。 |
|
| requestId |
string |
エラーに関連付けられている要求の ID。 |
ErrorResponseDetails
エラー応答の詳細。
| 名前 | 型 | 説明 |
|---|---|---|
| errorCode |
string |
エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。 |
| message |
string |
エラーの人間が判読できる表現。 |
| relatedResource |
エラー関連のリソースの詳細。 |
PublishDetails
発行操作の詳細。
| 名前 | 型 | 説明 |
|---|---|---|
| componentPublishInfo |
環境コンポーネントが情報を発行します。 |
|
| endTime |
string (date-time) |
YYYY-MM-DDTHH:mm:ss.ssssssZ 形式を使用した発行操作の終了時刻 (UTC)。 |
| startTime |
string (date-time) |
YYYY-MM-DDTHH:mm:ss.ssssssZ 形式を使用した発行操作の開始時刻 (UTC)。 |
| state |
発行状態。 追加の状態の種類は、時間の経過と同時に追加される場合があります。 |
|
| targetVersion |
string (uuid) |
公開対象のバージョン。 |
SparkLibraries
Spark ライブラリ。
| 名前 | 型 | 説明 |
|---|---|---|
| state |
発行状態。 追加の状態の種類は、時間の経過と同時に追加される場合があります。 |
SparkSettings
Spark の設定。
| 名前 | 型 | 説明 |
|---|---|---|
| state |
発行状態。 追加の状態の種類は、時間の経過と同時に追加される場合があります。 |