Workspaces - Assign To Domain

指定したワークスペースを指定したドメインに割り当てます。

Permissions

  • 呼び出し元は、共同作成者のアクセス許可を持っているか、ドメイン管理者である必要があります。
  • 呼び出し元にはワークスペース管理者ロールが必要です。

必要なスコープ

Workspace.ReadWrite.All

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

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

アイデンティティ Support
User イエス
サービス プリンシパルとマネージド ID イエス

インターフェイス

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

URI パラメーター

Name / 必須 型 説明
workspaceId
path True

string (uuid)

ワークスペース ID。

要求本文

Name 必須 型 説明
domainId True

string (uuid)

ワークスペースを割り当てるドメインの ID。

応答

Name 型 説明
200 OK

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

429 Too Many Requests

ErrorResponse

サービス レートの制限を超えました。 サーバーは、クライアントが追加の要求を送信するまでに待機する必要がある時間を秒単位で示す Retry-After ヘッダーを返します。

ヘッダー

Retry-After: integer

Other Status Codes

ErrorResponse

一般的なエラー コード:

  • DomainNotFound - 指定されたドメインが見つかりませんでした

  • WorkspaceNotFound - 指定されたワークスペースが見つかりませんでした

  • InsufficientPermissionsToDomain - 呼び出し元に、操作を実行するためのドメインに対する十分なアクセス許可がありません

  • InsufficientWorkspaceRole - 呼び出し元に、操作を実行するためのワークスペースに対する十分なアクセス許可がありません

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

例

Assign a workspace to a domain example

要求のサンプル

POST https://api.fabric.microsoft.com/v1/workspaces/f97451ca-d6a0-482f-a46a-cc4b2c48ba56/assignToDomain

{
  "domainId": "9d04ca81-bb30-4009-bd1a-a9213a4c8d75"
}

応答のサンプル

定義

Name 説明
AssignWorkspaceToDomainRequest

ドメイン割り当て要求。

ErrorParameter

エラーに関する追加のコンピューター読み取り可能なコンテキストを提供する構造化パラメーター。

ErrorRelatedResource

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

ErrorResponse

エラー応答。

ErrorResponseDetails

エラー応答の詳細。

AssignWorkspaceToDomainRequest

ドメイン割り当て要求。

Name 型 説明
domainId

string (uuid)

ワークスペースを割り当てるドメインの ID。

ErrorParameter

エラーに関する追加のコンピューター読み取り可能なコンテキストを提供する構造化パラメーター。

Name 型 説明
message

string

パラメーターの意味を人間が判読できる説明。

name

string

パラメータ識別子です。

value

string

パラメーターの値を指定します。

ErrorRelatedResource

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

Name 型 説明
resourceId

string

エラーに関係するリソース ID。

resourceType

string

エラーに関係するリソースの種類。

ErrorResponse

エラー応答。

Name 型 説明
errorCode

string

エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。

isRetriable

boolean

true の場合、要求を再試行できます。 Retry-After応答ヘッダーを使用して、遅延 (使用可能な場合) を決定します。

message

string

エラーの人間が判読できる表現。

moreDetails

ErrorResponseDetails[]

その他のエラーの詳細の一覧。

parameters

ErrorParameter[]

エラーに関する追加のコンピューター読み取り可能なコンテキストを提供する構造化パラメーター。

relatedResource

ErrorRelatedResource

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

requestId

string (uuid)

エラーに関連付けられている要求の ID。

ErrorResponseDetails

エラー応答の詳細。

Name 型 説明
errorCode

string

エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。

message

string

エラーの人間が判読できる表現。

parameters

ErrorParameter[]

エラーに関する追加のコンピューター読み取り可能なコンテキストを提供する構造化パラメーター。

relatedResource

ErrorRelatedResource

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