次の方法で共有

Workspaces - Update Workspace

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

指定したワークスペースのプロパティを更新します。

権限

呼び出し元には、管理者 ワークスペース ロール 必要があります。

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

Workspace.ReadWrite.All

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

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

アイデンティティ 支援
ユーザー イエス
サービス プリンシパルとマネージド ID イエス

インターフェイス

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

URI パラメーター

名前 / 必須 型 説明
workspaceId
 path True

string (uuid)

ワークスペース ID。

要求本文

名前 型 説明
description

string

ワークスペースの説明。
説明には 4,000 文字を超えることはできません。
displayName

string

ワークスペースの表示名。
表示名には 256 文字を超えることはできません。
ワークスペース名は、テナント内で一意である必要があります。
"管理者監視" は予約済みのワークスペース名です。

応答

名前 型 説明
200 OK

Workspace

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

ErrorResponse

一般的なエラー コード:

  • UnknownError - エラーが発生しました。

例

Update a workspace example

要求のサンプル

PATCH https://api.fabric.microsoft.com/v1/workspaces/33bae707-5fe7-4352-89bd-061a1318b60a

{
  "displayName": "Workspace New displayName",
  "description": "Workspace New description"
}

応答のサンプル

状態コード:
200 
{
  "id": "33bae707-5fe7-4352-89bd-061a1318b60a",
  "displayName": "Workspace New displayName",
  "description": "Workspace New description",
  "type": "Workspace",
  "domainId": "686177b9-ef29-45e4-a5db-1786ca6dbb9f"
}

定義

名前 説明
ErrorRelatedResource

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

エラー応答。
ErrorResponseDetails

エラー応答の詳細。
UpdateWorkspaceRequest

ワークスペース要求ペイロードを更新します。
Workspace

ワークスペース オブジェクト。
WorkspaceType

ワークスペースの種類。 追加のワークスペースの種類は、時間の経過と同時に追加される場合があります。

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

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

UpdateWorkspaceRequest

Object

ワークスペース要求ペイロードを更新します。

名前 型 説明
description

string

ワークスペースの説明。
説明には 4,000 文字を超えることはできません。
displayName

string

ワークスペースの表示名。
表示名には 256 文字を超えることはできません。
ワークスペース名は、テナント内で一意である必要があります。
"管理者監視" は予約済みのワークスペース名です。

Workspace

Object

ワークスペース オブジェクト。

名前 型 説明
apiEndpoint

string (uri)

ワークスペースに固有の API エンドポイントを表す HTTP URL。 このエンドポイント値は、ユーザーが preferWorkspaceSpecificEndpoints を有効にすると返されます。 これにより、プライベート リンク経由で API にアクセスできます。
capacityId

string (uuid)

ワークスペースが割り当てられている容量の ID。
description

string

ワークスペースの説明。
displayName

string

ワークスペースの表示名。
domainId

string (uuid)

ワークスペースが割り当てられているドメインの ID。
id

string (uuid)

ワークスペース ID。
type

WorkspaceType

ワークスペースの種類。

WorkspaceType

列挙

ワークスペースの種類。 追加のワークスペースの種類は、時間の経過と同時に追加される場合があります。

値 説明
Personal

ユーザーアイテムの管理に使用するマイ フォルダーまたはマイ ワークスペース。
Workspace

Fabric アイテムの管理に使用されるワークスペース。
AdminWorkspace

管理者監視ワークスペース。 監査レポートや使用状況と導入レポートなどの管理者レポートが含まれます。