Workspaces - Create Workspace
新しいワークスペースを作成します。
権限
- 呼び出し元には、Fabric 管理者によって付与されたワークスペースを作成するためのアクセス許可が必要です。 詳細については、「 ワークスペースの作成」を参照してください。
- 呼び出し元は 、共同作成者 のアクセス許可を持っているか、容量の管理者である必要があります。 詳細については、「 容量ユーザーのアクセス許可」を参照してください。
- サービス プリンシパルには、Fabric 管理者によって付与されたアクセス許可が必要です。 詳細については、「 サービス プリンシパルはワークスペース、接続、デプロイ パイプラインを作成できます。」を参照してください。
必要な委任されたスコープ
Workspace.ReadWrite.All
Microsoft Entra でサポートされている ID
この API では、このセクションに記載されている Microsoft ID がサポートされています。
| アイデンティティ | 支援 |
|---|---|
| ユーザー | イエス |
| サービス プリンシパルとマネージド ID | イエス |
インターフェイス
POST https://api.fabric.microsoft.com/v1/workspaces
要求本文
| 名前 | 必須 | 型 | 説明 |
|---|---|---|---|
| displayName | True |
string |
ワークスペースの表示名。 |
| capacityId |
string (uuid) |
ワークスペースを割り当てる容量の ID。 |
|
| description |
string |
ワークスペースの説明。 |
|
| domainId |
string (uuid) |
ワークスペースを割り当てるドメインの ID。 |
応答
| 名前 | 型 | 説明 |
|---|---|---|
| 201 Created |
正常に作成されました。 ヘッダー Location: string |
|
| Other Status Codes |
一般的なエラー コード:
|
例
Create a workspace example
要求のサンプル
POST https://api.fabric.microsoft.com/v1/workspaces
{
"displayName": "New workspace"
}
応答のサンプル
Location: https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb22287ff
{
"id": "cfafbeb1-8037-4d0c-896e-a46fb22287ff",
"displayName": "New workspace",
"description": "",
"type": "Workspace"
}
定義
| 名前 | 説明 |
|---|---|
|
Create |
ワークスペース要求ペイロードを作成します。 |
|
Error |
エラー関連のリソース詳細オブジェクト。 |
|
Error |
エラー応答。 |
|
Error |
エラー応答の詳細。 |
| Workspace |
ワークスペース オブジェクト。 |
|
Workspace |
ワークスペースの種類。 追加のワークスペースの種類は、時間の経過と同時に追加される場合があります。 |
CreateWorkspaceRequest
ワークスペース要求ペイロードを作成します。
| 名前 | 型 | 説明 |
|---|---|---|
| capacityId |
string (uuid) |
ワークスペースを割り当てる容量の ID。 |
| description |
string |
ワークスペースの説明。 |
| displayName |
string |
ワークスペースの表示名。 |
| domainId |
string (uuid) |
ワークスペースを割り当てるドメインの ID。 |
ErrorRelatedResource
エラー関連のリソース詳細オブジェクト。
| 名前 | 型 | 説明 |
|---|---|---|
| resourceId |
string |
エラーに関係するリソース ID。 |
| resourceType |
string |
エラーに関係するリソースの種類。 |
ErrorResponse
エラー応答。
| 名前 | 型 | 説明 |
|---|---|---|
| errorCode |
string |
エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。 |
| message |
string |
エラーの人間が判読できる表現。 |
| moreDetails |
その他のエラーの詳細の一覧。 |
|
| relatedResource |
エラー関連のリソースの詳細。 |
|
| requestId |
string |
エラーに関連付けられている要求の ID。 |
ErrorResponseDetails
エラー応答の詳細。
| 名前 | 型 | 説明 |
|---|---|---|
| errorCode |
string |
エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。 |
| message |
string |
エラーの人間が判読できる表現。 |
| relatedResource |
エラー関連のリソースの詳細。 |
Workspace
ワークスペース オブジェクト。
| 名前 | 型 | 説明 |
|---|---|---|
| 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
ワークスペースの種類。 追加のワークスペースの種類は、時間の経過と同時に追加される場合があります。
| 値 | 説明 |
|---|---|
| Personal |
ユーザーアイテムの管理に使用するマイ フォルダーまたはマイ ワークスペース。 |
| Workspace |
Fabric アイテムの管理に使用されるワークスペース。 |
| AdminWorkspace |
管理者監視ワークスペース。 監査レポートや使用状況と導入レポートなどの管理者レポートが含まれます。 |