Workspaces - Provision Identity

ワークスペースのワークスペース ID をプロビジョニングします。
この API は、実行時間の長い操作 (LRO)をサポートします。

権限

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

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

Workspace.ReadWrite.All

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

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

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

インターフェイス

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

URI パラメーター

Name / 必須 型 説明
workspaceId
path True

string (uuid)

ワークスペースの ID。

応答

Name 型 説明
200 OK

WorkspaceIdentity

正常にプロビジョニングされました

202 Accepted

承認された要求、ID プロビジョニングの進行中

ヘッダー

  • Location: string
  • x-ms-operation-id: string
  • Retry-After: integer
429 Too Many Requests

ErrorResponse

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

ヘッダー

Retry-After: integer

Other Status Codes

ErrorResponse

一般的なエラー コード:

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

例

Provision workspace identity example

要求のサンプル

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff227/provisionIdentity

応答のサンプル

{
  "applicationId": "00a4a8f9-78d3-41b3-b87a-6ae5271c8d0d",
  "servicePrincipalId": "5ba4ae58-d402-45c6-a848-0253e834fd78",
  "identityReference": {
    "referenceType": "ById",
    "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff227",
    "itemId": "4a1d86e3-d740-4610-b32d-7bae87d33e9d"
  }
}
Location: https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6
x-ms-operation-id: 0acd697c-1550-43cd-b998-91bfbfbd47c6
Retry-After: 5

定義

Name 説明
ErrorParameter

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

ErrorRelatedResource

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

ErrorResponse

エラー応答。

ErrorResponseDetails

エラー応答の詳細。

ItemReferenceById

ID オブジェクトによる項目参照。

ItemReferenceByVariable

変数による項目参照。

ItemReferenceType

項目参照型。 追加の ItemReferenceType 型は、時間の経過と同時に追加される場合があります。

WorkspaceIdentity

ワークスペース 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

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

ItemReferenceById

ID オブジェクトによる項目参照。

Name 型 説明
itemId

string (uuid)

項目の ID。

referenceType string:

ById

項目参照型。

workspaceId

string (uuid)

アイテムのワークスペース ID。

ItemReferenceByVariable

変数による項目参照。

Name 型 説明
referenceType string:

ByVariable

項目参照型。

variableReference

string

変数ライブラリとその中の変数名を指定する変数参照文字列。 形式: VarLibrary という名前の変数ライブラリと VarName という名前の変数の $(/**/_VarLibrary_/_VarName_) 。

ItemReferenceType

項目参照型。 追加の ItemReferenceType 型は、時間の経過と同時に追加される場合があります。

値 説明
ById

項目は、その ID によって参照されます。

ByVariable

項目は変数によって参照されます。

WorkspaceIdentity

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

Name 型 説明
applicationId

string (uuid)

アプリケーション ID。

identityReference ItemReference:

ワークスペース ID の項目参照。 ItemReferenceById のみがサポートされています。

servicePrincipalId

string (uuid)

サービス プリンシパル ID。