次の方法で共有

Items - Update Environment

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

指定した環境のプロパティを更新します。

権限

呼び出し元には、環境の 読み取りと書き込みの アクセス許可が必要です。

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

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

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

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

同一性 支える
利用者 はい
サービス プリンシパルの とマネージド ID の はい

インターフェイス

PATCH https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/environments/{environmentId}

URI パラメーター

名前 / 必須 型 説明
environmentId
 path True

string (uuid)

環境 ID。
workspaceId
 path True

string (uuid)

ワークスペース ID。

要求本文

名前 型 説明
description

string

環境の説明。 最大長は 256 文字です。
displayName

string

環境の表示名。

応答

名前 型 説明
200 OK

Environment

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

ErrorResponse

一般的なエラー コード:

  • ItemNotFound - 要求された項目が見つかりませんでした。

  • InvalidRequest - 無効な更新要求

例

Update a environment example

要求のサンプル

PATCH https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/environments/5b218778-e7a5-4d73-8187-f10824047715

{
  "displayName": "Environment_New_Name",
  "description": "A new description for environment."
}

応答のサンプル

状態コード:
200 
{
  "displayName": "Environment_New_Name",
  "description": "A new description for environment.",
  "type": "Environment",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}

定義

名前 説明
ComponentPublishInfo

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

環境項目。
EnvironmentProperties

環境のプロパティ。
EnvironmentPublishState

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

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

エラー応答。
ErrorResponseDetails

エラー応答の詳細。
ItemTag

アイテムに適用されるタグを表します。
ItemType

アイテムの種類。 追加の項目の種類は、時間の経過と同時に追加される場合があります。
PublishDetails

発行操作の詳細。
SparkLibraries

Spark ライブラリ。
SparkSettings

Spark の設定。
UpdateEnvironmentRequest

環境の更新要求。

ComponentPublishInfo

Object

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

名前 型 説明
sparkLibraries

SparkLibraries

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

SparkSettings

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

Environment

Object

環境項目。

名前 型 説明
description

string

アイテムの説明。
displayName

string

アイテムの表示名。
folderId

string (uuid)

フォルダー ID。
id

string (uuid)

アイテム ID。
properties

EnvironmentProperties

環境のプロパティ。
tags

ItemTag[]

適用されたタグの一覧。
type

ItemType

アイテムの種類。
workspaceId

string (uuid)

ワークスペース ID。

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

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

ItemTag

Object

アイテムに適用されるタグを表します。

名前 型 説明
displayName

string

タグの名前。
id

string (uuid)

タグ ID。

ItemType

列挙

アイテムの種類。 追加の項目の種類は、時間の経過と同時に追加される場合があります。

値 説明
Dashboard

PowerBI ダッシュボード。
Report

PowerBI レポート。
SemanticModel

PowerBI セマンティック モデル。
PaginatedReport

PowerBI のページ分割されたレポート。
Datamart

PowerBI データマート。
Lakehouse

レイクハウス。
Eventhouse

イベントハウス。
Environment

環境。
KQLDatabase

KQL データベース。
KQLQueryset

KQL クエリセット。
KQLDashboard

KQL ダッシュボード。
DataPipeline

データ パイプライン。
Notebook

ノートブック。
SparkJobDefinition

Spark ジョブ定義。
MLExperiment

機械学習の実験。
MLModel

機械学習モデル。
Warehouse

倉庫。
Eventstream

イベントストリーム。
SQLEndpoint

SQL エンドポイント。
MirroredWarehouse

ミラー化された倉庫。
MirroredDatabase

ミラー化されたデータベース。
Reflex

反射。
GraphQLApi

GraphQL 項目の API。
MountedDataFactory

MountedDataFactory。
SQLDatabase

SQLDatabase。
CopyJob

コピー ジョブ。
VariableLibrary

VariableLibrary。
Dataflow

データフロー。
ApacheAirflowJob

ApacheAirflowJob。
WarehouseSnapshot

Warehouse スナップショット。
DigitalTwinBuilder

DigitalTwinBuilder。
DigitalTwinBuilderFlow

デジタル ツイン ビルダー フロー。
MirroredAzureDatabricksCatalog

ミラー化された Azure databricks カタログ。
Map

マップ。
AnomalyDetector

Anomaly Detector。
UserDataFunction

ユーザー データ関数。
GraphModel

GraphModel。
GraphQuerySet

Graph QuerySet。
SnowflakeDatabase

Snowflake アカウントから作成された Iceberg テーブルを格納する Snowflake データベース。
OperationsAgent

OperationsAgent。
CosmosDBDatabase

Cosmos DB データベース。
Ontology

オントロジ。
EventSchemaSet

EventSchemaSet。

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

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

UpdateEnvironmentRequest

Object

環境の更新要求。

名前 型 説明
description

string

環境の説明。 最大長は 256 文字です。
displayName

string

環境の表示名。