Workspaces - Update Workspace
指定したワークスペースのプロパティを更新します。
権限
呼び出し元には、管理者 ワークスペース ロール 必要があります。
必要な委任されたスコープ
Workspace.ReadWrite.All
スロットルの制限
| 制限の種類 | Value |
|---|---|
| プラットフォーム API の統合クォータ | 200 通話/分 |
| API の制限 | 200 通話/分 |
Microsoft Entra でサポートされている ID
この API では、このセクションに記載されている Microsoft ID がサポートされています。
| アイデンティティ | 支援 |
|---|---|
| ユーザー | イエス |
| サービス プリンシパルとマネージド ID | イエス |
インターフェイス
PATCH https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}URI パラメーター
| 名前 | / | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
workspace
|
path | True |
string (uuid) |
ワークスペース ID。 |
要求本文
| 名前 | 型 | 説明 |
|---|---|---|
| description |
string |
ワークスペースの説明。 |
| displayName |
string |
ワークスペースの表示名。 |
応答
| 名前 | 型 | 説明 |
|---|---|---|
| 200 OK |
要求は正常に完了しました。 |
|
| 429 Too Many Requests |
サービス レートの制限を超えました。 サーバーは、クライアントが追加の要求を送信するまでに待機する必要がある時間を秒単位で示す ヘッダー Retry-After: integer |
|
| Other Status Codes |
一般的なエラー コード:
|
例
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"
}
応答のサンプル
{
"id": "33bae707-5fe7-4352-89bd-061a1318b60a",
"displayName": "Workspace New displayName",
"description": "Workspace New description",
"type": "Workspace",
"domainId": "686177b9-ef29-45e4-a5db-1786ca6dbb9f",
"capacityRegion": "East US"
}定義
| 名前 | 説明 |
|---|---|
|
Capacity |
このワークスペースに関連付けられている容量のリージョン。 容量リージョンの値は、時間の経過と同時に追加される場合があります。 |
|
Error |
エラー関連のリソース詳細オブジェクト。 |
|
Error |
エラー応答。 |
|
Error |
エラー応答の詳細。 |
|
Update |
ワークスペース要求ペイロードを更新します。 |
| Workspace |
ワークスペース オブジェクト。 |
|
Workspace |
適用されたタグを表します。 |
|
Workspace |
ワークスペースの種類。 追加のワークスペースの種類は、時間の経過と同時に追加される場合があります。 |
CapacityRegion
このワークスペースに関連付けられている容量のリージョン。 容量リージョンの値は、時間の経過と同時に追加される場合があります。
| 値 | 説明 |
|---|---|
| Australia East |
オーストラリア東部リージョン |
| Australia Southeast |
オーストラリア南東部リージョン |
| Brazil South |
ブラジル南部リージョン |
| Brazil Southeast |
ブラジル南東部リージョン |
| Canada Central |
カナダ中部リージョン |
| Canada East |
カナダ東部リージョン |
| Central India |
インド中部リージョン |
| Central US |
米国中部リージョン |
| Central US EUAP |
米国中部 EUAP リージョン |
| East Asia |
東アジアリージョン |
| East US |
米国東部リージョン |
| East US 2 |
米国東部 2 リージョン |
| France Central |
フランス中部リージョン |
| France South |
フランス南部リージョン |
| Germany Central |
ドイツ中部リージョン |
| Germany Northeast |
ドイツ北東部 |
| Israel Central |
イスラエル中部リージョン |
| Italy North |
イタリア北部リージョン |
| Japan East |
東日本リージョン |
| Japan West |
西日本リージョン |
| Korea Central |
韓国中部リージョン |
| Korea South |
韓国南部リージョン |
| Mexico Central |
メキシコ中部リージョン |
| North Central US |
米国中北部リージョン |
| North Europe |
北ヨーロッパリージョン |
| Norway East |
ノルウェー東部リージョン |
| Norway West |
ノルウェー西部リージョン |
| Poland Central |
ポーランド中部リージョン |
| South Africa North |
南アフリカ北部リージョン |
| South Africa West |
南アフリカ西部リージョン |
| South Central US |
米国中南部リージョン |
| South India |
インド南部リージョン |
| Southeast Asia |
東南アジアリージョン |
| Spain Central |
スペイン中部リージョン |
| Sweden Central |
スウェーデン中部リージョン |
| Switzerland North |
スイス北部リージョン |
| Switzerland West |
スイス西部リージョン |
| West Europe |
西ヨーロッパ リージョン |
| West India |
インド西部リージョン |
| West US |
米国西部リージョン |
| West US 2 |
米国西部 2 リージョン |
| West US 3 |
米国西部 3 リージョン |
| West Central US |
米国中西部リージョン |
| UAE Central |
アラブ首長国連邦中部リージョン |
| UAE North |
アラブ首長国連邦北部リージョン |
| Qatar Central |
カタール中部リージョン |
| Germany West Central |
ドイツ中西部リージョン |
| Germany North |
ドイツ北部リージョン |
| UK South |
英国南部リージョン |
| UK West |
英国西部リージョン |
| China North |
中国北部リージョン |
| China East |
中国東部リージョン |
| China East 2 |
中国東部 2 リージョン |
| China East 3 |
中国東部 3 リージョン |
| China North 2 |
中国北部 2 リージョン |
| China North 3 |
中国北部 3 地域 |
ErrorRelatedResource
エラー関連のリソース詳細オブジェクト。
| 名前 | 型 | 説明 |
|---|---|---|
| resourceId |
string |
エラーに関係するリソース ID。 |
| resourceType |
string |
エラーに関係するリソースの種類。 |
ErrorResponse
エラー応答。
| 名前 | 型 | 説明 |
|---|---|---|
| errorCode |
string |
エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。 |
| isRetriable |
boolean |
true の場合、要求を再試行できます。
|
| message |
string |
エラーの人間が判読できる表現。 |
| moreDetails |
その他のエラーの詳細の一覧。 |
|
| relatedResource |
エラー関連のリソースの詳細。 |
|
| requestId |
string (uuid) |
エラーに関連付けられている要求の ID。 |
ErrorResponseDetails
エラー応答の詳細。
| 名前 | 型 | 説明 |
|---|---|---|
| errorCode |
string |
エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。 |
| message |
string |
エラーの人間が判読できる表現。 |
| relatedResource |
エラー関連のリソースの詳細。 |
UpdateWorkspaceRequest
ワークスペース要求ペイロードを更新します。
| 名前 | 型 | 説明 |
|---|---|---|
| description |
string |
ワークスペースの説明。 |
| displayName |
string |
ワークスペースの表示名。 |
Workspace
ワークスペース オブジェクト。
| 名前 | 型 | 説明 |
|---|---|---|
| apiEndpoint |
string (uri) |
ワークスペースに固有の API エンドポイントを表す HTTP URL。 このエンドポイント値は、ユーザーが preferWorkspaceSpecificEndpoints を有効にすると返されます。 これにより、プライベート リンク経由で API にアクセスできます。 |
| capacityId |
string (uuid) |
ワークスペースが割り当てられている容量の ID。 |
| capacityRegion |
このワークスペースに関連付けられている容量のリージョン。 |
|
| description |
string |
ワークスペースの説明。 |
| displayName |
string |
ワークスペースの表示名。 |
| domainId |
string (uuid) |
ワークスペースが割り当てられているドメインの ID。 |
| id |
string (uuid) |
ワークスペース ID。 |
| tags |
適用されたタグの一覧。 |
|
| type |
ワークスペースの種類。 |
WorkspaceAppliedTag
適用されたタグを表します。
| 名前 | 型 | 説明 |
|---|---|---|
| displayName |
string |
タグの名前を指定します。 |
| id |
string (uuid) |
タグ ID。 |
WorkspaceType
ワークスペースの種類。 追加のワークスペースの種類は、時間の経過と同時に追加される場合があります。
| 値 | 説明 |
|---|---|
| Personal |
ユーザーアイテムの管理に使用するマイ フォルダーまたはマイ ワークスペース。 |
| Workspace |
Fabric アイテムの管理に使用されるワークスペース。 |
| AdminWorkspace |
管理者監視ワークスペース。 監査レポートや使用状況と導入レポートなどの管理者レポートが含まれます。 |